Framework v8.0 Upgrade: Pre-Requisite Checklist

Article Index

The following Framework Product Suite pre-requisite topics must be reviewed before proceeding with any upgrade.

The topics contain information for internal IT staff responsible for the deployment of the Framework Product Suite and its integration into internal systems and business processes.

Step 1 - Contact Insula

Review Insula’s updated compatibility page - Operating System / SQL Server Compatibility.

Contact Insula requesting to move to Entitlements Licensing for Framework v8.

Insula will setup Entitlements and will provide the end user licensee details.
Note: This will include the following: Portal username and password, end user licensee ID, a List of enabled entitlements and the locking code.

(Proceed to Step 4 if you are not switching to Entitlement)

Step 2 - Install the Entitlement LAN Service (Replacement of Sentinel Key)

Setup and configure the LAN service on local machine - Installing the Entitlement LAN Service

Step 3 - Sync Entitlements

Sync entitlements and ensure licenses are active - Register Entitlements

Step 4 - Determine Applications To Upgrade

Whilst all applications are included on the Framework Product Suite FTP, Insula Software's hardware and software licence settings determine which applications and modules can be used by an organisation.

The following is a list of Framework Product Suite applications.

Framework Product Suite Applications

Step 5 - Update The Sentinel Hardware Licence Key

Update Sentinel Hardware Licence Key

Your Sentinel Hardware Licence Key will require updating to Framework Product Suite before performing the upgrade.

Update Licence Database

As part of receiving your new Sentinel Hardware Licence Key code via email, you will receive an update to the licence database in the form of an attached file (FrameworkLicence.zip). This file MUST be copied to the following folder: 

• [fw folder]\Service\02 - Upgrade Data\

Step 6 - Inform Insula Software Of Upgrade

Please inform Insula Software five (5) working days prior to performing the upgrade so that support resources can be made available should you run into any difficulties that require immediate assistance.

To inform Insula Software about the upgrade, send an email to support@frameworkecm.com.au.

Step 7 - Schedule Upgrade

The upgrade MUST be performed outside of office hours to ensure there are no users connected to the servers. This will ensure there is no downtime for staff.

Step 8 - Schedule Tablet PC Collection

Tablet PCs must be made available on the day/evening prior to the upgrade to allow the synchronising of all Tablet PC data before upgrading.

Step 9 - Ensure Sufficient Privileges

On any system being upgraded (including servers, Tablet PCs, and workstations), the user performing the upgrade must have sufficient privileges to uninstall and reinstall applications (e.g., administrator privileges).

Step 10 - Managing The Upgrade For Staff

Upgrading any software can affect business processes and consequently the way that an organisation's staff performs their roles.

Insula Software recommends the following practices in upgrading the Framework Product Suite:

• Software User Guide: The User Guide is available from the Help menu (Help > Contents). 

• Review Release Notes: A full review of the release notes should be performed to determine how the changes affect your business. Disseminate the information contained in the release notes to all affected staff. The release notes are available to all staff via the Help menu in all Framework Product Suite applications (Help > Release Notes).

• Inform Staff of the New Version: If an update or upgrade is to be performed, inform staff before and after the installation.

• Consider Education and Training: Education and staff training for new features of the software is highly recommended.

Step 11 - Ensure Availability Of The Framework Product Suite Upgrade

Ensure you can access the Framework Product Suite Software Upgrade on FTP.

Step 12 - Check Current Framework Product Suite Version

Before upgrading ANY Framework Product Suite application to v8, ensure that ALL Framework Product Suite applications that your organisation is currently using have been upgraded to v7.0.0.26.

Step 13 - Test All Customised Reports

Any customised report files must be validated by you (where required) to work with this version of Framework. The review of all reports must be completed BEFORE commencing the upgrade to Framework Product Suite.

It is vital that any report, regardless of origin, be fully tested with this new version of Framework to ensure compatibility and continuity. Failure to ensure compatibility may result in the failure of the report within Framework.

To assist in confirming compatibility, a sample Framework ECM database is included with the upgrade materials. The sample database will be copied during the implementation phase of Framework ECM. After the copy, it will be located in:

• \[fw folder\Service\01- Default Data\

This database can be used in your non-production test environment to test all customised reports. Alternatively (recommended), perform the tests in a test environment before embarking on your production environment upgrade.

Connecting to your current Framework Licence Database (e.g., FworkSQLLic) and using the new version of Framework will use a Framework licence

For assistance with reports and report compatibility, contact Insula Software.

Step 14 - Upgrade Third Party Software

Framework clients often employ in-house or externally developed systems and processes that may rely on Framework data.

It is vital that any application or process, regardless of its origin, be fully tested with this new version of Framework to ensure compatibility and continuity. Failure to ensure compatibility may result in the failure of the application to process to exchange information with Framework.

To assist in confirming compatibility of non-Framework software and processes, a sample Framework ECM database is included with the upgrade materials. The sample database will be copied during the implementation phase of Framework ECM. After the copy, it will be located in: 

• [fw folder]\Service\01 - Default Data\

This database can be used in your non-production test environment to test all non-Framework processes. Alternatively (recommended), perform the full upgrade process in the test environment before embarking on the upgrade in your live production environment.

Connecting to your current Framework Licence Database (e.g., FworkSQLLic) and using the new version of Framework will use a Framework licence

For assistance with test environments and/or confirming non-Framework software, process, and reporting compatibility, contact Insula Software.

Step 15 - Proceed With Environment Setup Checklist

Proceed to the Framework Environment Setup Checklist.