The following guide is designed to upgrade the Framework ECM database and software.

Pre-Requisite Checklist

Complete the Pre-Requisite Checklist.
Complete the Environment Setup Checklist.

Step 1 - Shutdown Framework ECM

Before proceeding with the upgrade, Framework ECM needs to be shutdown so that no user can access the system during the upgrade period.

Shutting down Framework ECM logs users out of the system in an orderly fashion.

Open Framework Configuration Utility (Start > All Programs > Insula Software > Framework Configuration Utility)
Logon to the system.
Select the Shutdown tab.
In the Framework Shutdown group, change the Shutdown? field from No to Yes.
Enter the shutdown details.
Click the Shutdown Framework button.
Click the OK button.

Step 2 - Close Framework Connections

It is a requirement for the Framework Product Suite Upgrade to be successful that all connections to the Framework database be cleared. Please refer to your Microsoft SQL Server documentation for more information on this process.

Step 3 - Implement Framework Product Suite Files

It is a requirement that all Framework Product Suite files are implemented on your server to the [fw folder].

On the system that contains the [fw folder]:

Connect to ftp://ftp.insulagroup.com.au/
Select the relevant application folders until the required application and version are located.
Select the Framework APP X.X.XXXX.zip to download.
Place the files locally created \[fw folder]\Setup\Framework [APP]\v7.2\Setup\ folders.
For each app, access the local Setup folder and double click the Framework APP X.X.XXXX.msi file to launch the install process.
Follow the Install Wizard prompts.

During the file copy the following dialogs may be displayed: Confirm File Replace, Confirm Folder Replace, Confirm File Replace (Read Only). When displayed, click the Yes To All button to replace all files and folders.

It is important to review the Framework folder permissions after the file copy to ensure they meet your company's security standards.

Step 4 - Configure Folder And File Permissions

The Framework Folders require different access permissions depending on the folder. The following table displays the list of Framework folders and the network permissions required for each. Network permissions are rules associated with a shared resource on a network, such as a file, folder, or printer. These permissions can be assigned to groups, global groups, or individual users.

The available Microsoft Windows folder security permissions include:

Full Control
Modify
Read & Execute
List Folder Contents
Read
Write
Special Permissions

See the Microsoft Windows Help and Support documentation for more information on folder security permissions.

Framework Folder Structure	Non-Administrative User Network Permissions
Bin	None
Data\	Read
Data\Spellcheck	Read/Write
Documentation	Read
Image	Read
jobFiles	Read/Write
Log	Read/Write
MailMerge	Read/Write
Report	Read
ReportServer	Read/Write
Service	Read/Write
Setup	Read
Specification	Read
Temp	Read/Write
Tools	Read
Triggers	Read
Upgrade	Read/Write

Important for 2020 onwards...

From Framework 2020 (v7.2) the Configuration Path details are managed through Framework ECM Security Preferences.

These will need to be set at Default level prior to upgrade of subsequent versions.

Step 5 - Backup Framework ECM Database

The following topic will backup your Framework ECM Database. This procedure is based on Microsoft SQL Server 2008 (or above).

Backup Framework ECM Database

Open SQL Server Management Studio (Start > All Programs > Microsoft SQL Server 2008 (or above) > SQL Server Management Studio).
Connect to the required server.
In the Object Explorer pane, expand: [server name] > Databases
Right-click on the Framework ECM database (e.g., FworkSQLECM) and select Tasks > Back Up. The Back Up Database (General Page) dialog will be displayed.
Specify a Name and Destination for the backup file, if different from the default name and destination details.

Write down the name and destination details.
Select the Options page.
Tick: Overwrite all existing backup sets
Tick: Verify backup when finished
Click the OK button. The backup will be performed to the selected destination.
Click the OK button to close the message prompt.
Close SQL Server Management Studio.
Browse to the backup location (as detailed in Point 5 above).
Copy the backup file to a secure location.

Example

A typical example is to backup the database file (.bak file) to the following folder location: \[fw folder]\Service\fwBackup_[todaysDate].

Step 6 - Upgrade Framework ECM Database

Running the Upgrade:

- This MUST be performed on either a workstation or server with ODBC DSN connections to the FworkECM database.
- This MUST be performed on either a workstation or a server with Insula Core Components installed e.g 16.0.x.

The easiest/safest check for the above is running Framework ECM from where you intend to run the upgrade file from; if Framework ECM launches successfully, you can proceed.

- The system where the data is being upgraded MUST be set with Australian regional settings.

The following procedure upgrades the Framework ECM database.

If during the upgrade process 'Not Responding' appears in the title bar of the Framework Upgrade software, this is due to the system performing very long and CPU-intensive calculations. This message will disappear once the upgrade has been completed.

Framework ECM 7.2 Database Upgrade

Framework ECM 7.2.0.26 Upgrade

Open Windows Explorer.
Browse to: \[fw folder]\Upgrade\Upgrade_v7_2_0_26\ECM\
Double-click the FworkECMUpgrade.exe file. A Database Backup confirmation prompt will be displayed.
Click Yes to confirm that a manual backup of the Framework ECM database has been performed (if a manual backup has not been performed, see Step 5 - Backup Framework ECM Database). The Start Upgrade confirmation prompt will be displayed.
Click Yes to perform the upgrade.
If the upgrade was successful, a successfully completed message prompt will be displayed.
Click OK.
Click Close.

Backup Framework ECM Database

Following the instructions in Step 5, create a separate backup of the database at this point.

Database Administration Command Line

By default there are database administration functions that will be performed during the ECM Upgrade to improve database performance.

This includes shrinking the database log files and updating database statistics.

To disable these functions, a command line switch can be used.

Open Windows Explorer.
Browse to: \[fw folder]\Upgrade\Upgrade_v7[_X_X_xx]\ECM\
Right-click on FworkECMUpgrade.exe and select Create Shortcut. A shortcut to the executable will be created.
Right-click on the new shortcut and select Properties. The Properties dialog will be displayed.
On the Shortcut tab, edit the Target field and include the command line switch -skipDBAdmin at the end of the line. The target should look similar to the following:
"C:\Framework\Upgrade\Upgrade_v7[_X_X_xx]\ECM\FworkECMUpgrade.exe" -skipDBAdmin
Click the OK button. The Properties dialog will close.

After creating a new shortcut with the command line switch, run the Database Upgrade using the new shortcut.

Unsuccessful Database Upgrade

If the database was unsuccessful, restore the backup database file. Refer to your Microsoft SQL Server documentation for more information.

Step 7 - Upgrade Sentinel Protection Installer

Upgrades the Sentinel Hardware Licence Key security software.

This step can be skipped if Sentinel Protection Installer is already installed.

Upgrade - Sentinel Protection Installer

Note: If installing on Windows Vista or Windows 7, the User Account Control (UAC) Consent prompt may be displayed.

Open Windows Explorer.
Browse to: \[fw folder]\Setup\Sentinel Protection Installer\v7.6.5\
Double-click setup.exe. The Sentinel Protection Installer Upgrade will begin and the Confirm Upgrade dialog will be displayed.
Click the Upgrade button. The Welcome dialog will be displayed.
Click the Next. The Licence Agreement will be displayed.
Select I accept the terms in the licence agreement.
Click the Next button. The Setup Type dialog will be displayed.
Select Complete.
Click the Next button. The Ready To Install the Program dialog will be displayed.
Click the Install button to begin the installation.

If Windows Firewall is detected, click the Yes button.
Click the Finish button.

Note

Your system may require a reboot after the installation.

Step 8 - Update Core Components

Installs a set of common software tools used by Framework ECM.

This step can be skipped if Core Components v16.0.2 or greater is already installed.

For this process, see Install Insula Core Components.

Step 9 - Update Framework ECM

On ALL systems running Framework ECM:

Uninstall The Existing Version Of Framework ECM

In Microsoft Windows XP

Open Add or Remove Programs (Start > Control Panel > Add or Remove Programs). The Add or Remove Programs dialog will be displayed.
From the Currently Installed Programs list, select the previous version of Framework ECM.
Click the Remove button. The application will be removed.

In Microsoft Windows Vista/Windows 7

Open Uninstall a Program (Start > Control Panel > Uninstall a Program). The Uninstall or Change a Program list will be displayed.
Select the previous version of Framework ECM.
Click the Uninstall button. The application will be removed.

Install The Latest Version Of Framework ECM

Open Windows Explorer.
Browse to: \[fw folder]\Setup\Framework ECM\v7.0\Setup\
Double-click Framework ECM.msi and follow the on-screen prompts.

Step 10 - Restart Framework ECM

After finishing the database and system upgrade, Framework ECM needs to be restarted so that users can access the system.

Open Framework Configuration Utility (Start > All Programs > Insula Software > Framework Configuration Utility)
Logon to the system.
Select the Shutdown tab.
Under the Framework Availability group, click the Restart Now button.
Click the OK button.

Step 11 - Test Framework ECM

On all systems running Framework ECM:

Start Framework ECM

Start Framework ECM (Start > All Programs > Insula Software > Framework).

Double-click the Framework ECM desktop icon.
If this is the first installation of Framework ECM or a manual update of the Framework Licence database has not been performed, the Framework Licence Database Validation prompt will be displayed.

If the Framework Licence Database Validation prompt is not displayed, skip to Point 6.
Click the Yes button to validate the Framework installation. The Update Licence dialog will be displayed.
Browse to the location of the Framework Licence Zip file.

The file is typically located in the \\[fw folder]\Service\02 - Upgrade Data\ folder with the filename FrameworkLicence.zip.
Select the file and click the Open button. The validation will be performed.
Log on to the system.

Step 12 - User Acceptance Tests

The following is a list of view only User Acceptance Tests (UATs) that must be performed after upgrading the application.

These tests must be performed after the first workstation/client system has been upgraded.

Framework ECM - Production Management

Screen / View	Menu Path	Completed
Start Framework
Log in as a user other than a super-user
Search for a job number	File > Select
Search for an address	File > Search
View Client Overview	Client > Overview
View File Screen	Client > File
View Job Overview	Client > Overview
View Workflow Overview	Production > Workflow > Overview
View Pre-Administration Overview	Production > Pre-Administration > Overview
View Administration Overview - Pop up view entity - Pop up for diary appointment - Use a jump to	Production > Administration > Overview
View Permit Overview	Production > Administration > Permit > Overview
View Construction Overview - Pop up view entity - Pop up for diary appointment - Use a jump to	Production > Construction > Overview
View Claims Screen	Production > Construction > Progress Claims
View Maintenance Overview	Production > Maintenance > Maintenance Overview
View Maintenance Request Screen	Production > Maintenance > Requests
View Document Overview	Document > Document Overview
View Tender screen - View Tender	Document > Tender
View VPB Browser	Document > Browse Variation Price Book
View Job Diary	Diary > Client / Job Diary
Search for a free time	Diary > Search for a free time
View Day Diary - Select different day	Diary > Day View
View Comments	CRM > Comments
Run Workflow Analysis	Tools > Workflow Tools > Personal Work Flow Analysis
Run a workflow report	File > Reports

Framework ECM - Land Management

Screen / View	Menu Path	Completed
Start Framework
Log in as a user other than a super-user
Select the Framework Explorer
Select Land Management
Search for an address	File > Search
View all screens via sidebar
Use keyboard shortcuts for some screens	Ctrl S, Ctrl L, F4, F7

Framework ECM - Administration

Screen / View	Menu Path	Completed
Start Framework
Log in as a user other than a super-user
Select the Framework Explorer
Select Administration
View all screens via sidebar

Framework ECM - Security

Screen / View	Menu Path	Completed
Start Framework
Log in as a user other than a super-user
Select the Framework Explorer
Select Security
View all screens via sidebar
View a User dialog	Security > User

Framework ECM - Report Management

Screen / View	Menu Path	Completed
Start Framework
Log in as a user other than a super-user
Select the Framework Explorer
Select Report Management
View all screens via sidebar

Framework ECM - Variation Price Book

Screen / View	Menu Path	Completed
Start Framework
Log in as a user other than a super-user
Select the Framework Explorer
Select Variation Price Book
View all screens via sidebar
Select a Version	VPB > Versions

Framework ECM - Client And Contact Management

Screen / View	Menu Path	Completed
Start Framework
Log in as a user other than a super-user
Select the Framework Explorer
Select Client and Contact Management
Search for a client	File > Search / F4
View all screens via sidebar

Additional Support Software

If upgrading the Framework Product Suite on the server, consider installing Microsoft Office as this assists with:

Remote Support (for Insula Software and your own IT support team).
Testing of all system components including mail merge and email integration.

Browser not supported