Pre-Requisite Checklist

• Check the Server System Requirements.
• Complete the Pre-Requisite Checklist.
• Complete the Environment Setup Checklist.

Installation Checklist

The following steps are required to install Framework ECM on the server.

Minimum Server Installation Requirements

Insula Software recommends following ALL of the steps in the Server Installation Overview topic to get the most from Framework and timely product support when required.

Step 1 - Install Sentinel Protection Installer

Installs the Sentinel Hardware Licence Key security software.

Install - Sentinel Protection Installer

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

1. Open Windows Explorer.
2. Browse to: \[fw folder]\Setup\Sentinel Protection Installer\v7.6.6\
3. Double-click setup.exe. The Sentinel Protection Installer installation will begin.
4. Click the Next button. The Licence Agreement step will be displayed.
5. Select I accept the terms in the licence agreement.
6. Click the Next button. The Setup Type step will be displayed.
7. Select Complete.
8. Click the Next button. The Ready To Install the Program step will be displayed.

9. Click the Install button to begin the installation.
   
   

   If Windows Firewall is detected, click the Yes button.

10. Click the Finish button.

Step 2 - Install Microsoft SQL Server

Installs Microsoft SQL Server (MSSQL) on the server. Refer to the Microsoft SQL Server home page for more information about this product.

Due to the range of versions and platforms available for Microsoft SQL Server, the following instructions are based on the 32-bit Express Edition (with Advanced Services) of MSSQL. Your IT Support team can use this as a guide to installing other editions and platforms.

For a list of compatible SQL Server Versions, /wiki/spaces/FWKB/pages/211714546.

Pre-Requisite Software For Microsoft SQL Server

The following software are required to be installed on the system prior to installing MSSQL.

• Microsoft DotNet
• Microsoft Windows Installer
• Microsoft Powershell

Install - Microsoft SQL Server (Express Edition With Advanced Services)

1. Open Windows Explorer.
2. Browse to: \[fw folder]\Setup\Database - MSSQL\Microsoft - SQL Server (Compatible Version) Express\
3. Double click the relevant setup file. The Microsoft SQL Server installation will begin.
4. From the sidebar, select Installation.
5. Click New SQL Server stand-alone installation or add features to an existing installation. The Setup Support Rules step will be displayed.
6. Click the OK button. The Product Key step will be displayed.
7. Click the Next button. The License Terms step will be displayed.
8. Tick I accept the license terms.
9. Click the Next button. The Setup Support Files step will be displayed.
10. Click the Install button.
11. Once the process is complete click the Next button. The Feature Selections step will be displayed.
12. Click the Select All button. All of the features will be selected.
13. Click the Next button. The Instance Configuration step will be displayed.

14. Select Default instance.
    
    

    If including an instance name, the full name (including the server name) cannot be longer than 16 characters. At 24 characters, the example servername/instance_name exceeds the maximum characters allowed.

15.  Click the Next button. The Disk Space Requirement step will be displayed.
16. Click the Next button. The Server Configuration step will be displayed.
17. Select or enter an account name for each service, if required.
18. Click the Next button. The Database Engine Configuration dialog will be displayed.
19. Click the Add button to select users or groups.
    OR
    Click the Add Current User button to add the current user only.
20. Click the Next button. The Reporting Services Configuration step will be displayed.
21. Click the Next button. The Error and Usage Reporting step will be displayed.
22. Click the Next button. The Installation Rules step will be displayed.
23. Click the Next button. The Ready to Install step will be displayed.
24. Click the Install button. The installation progress will begin.
25. Once the installation is complete click Next. The Complete step will be displayed
26. Click the Close button to complete the installation.
27. Close SQL Server Installation Center.

Configure - Microsoft SQL Server To Allow Remote Connections

This only applies to organisations that:

1. Have installed the Express or Developer Edition of Microsoft SQL Server.
   AND
   Who wish to allow remote connections to the server from a client workstation.
2. Open SQL Server Configuration Manager (Start > All Programs > Microsoft SQL Server > Configuration Tools > SQL Server Configuration Manager).
3. Expand: SQL Server Network Configuration > Protocols for [SQL]
4. Enable TCP/IP.

5. Enable Named Pipes.
   
   

   A warning prompt will inform that these changes will not apply until the service is shut down and restarted. All SQL services, including server browser, need to be restarted.
6. Close SQL Server Configuration Manager.
7. Restart the SQL Server Service.

Install - Service Packs And Windows Update

Service Packs may be available for Microsoft SQL Server. Please check the Microsoft site (www.microsoft.com.au) for more information.

After installing any service packs, perform a Windows Update.

Step 3 - Restore Databases

Restores the Framework ECM, Licence, and Service Microsoft SQL Server databases.

Restore Database - FworkSQLECM

1. Open Microsoft SQL Server Management Studio (Start > All Programs > Microsoft SQL Server > SQL Server Management Studio).
2. Connect to the required server.
3. Right-click on Databases and click Restore Database.... The Restore Database dialog will be displayed.

4. In the To Database field, enter the Framework Database Name.
   
   

   Example

   FworkSQLEcm
5. In the From Device field, click the Browse button. The Specify Backup dialog will be displayed.
6. Click the Add button. The Locate Backup File dialog will be displayed.

7. Select the folder and file location of the backed up Framework database.
   
   

   Example

   A typical example of the backed up Framework database location is: \[fw folder]\Service\fwBackup_[Date]
8. Click the OK button. The Locate Backup File dialog will close.
9. Click the OK button. The Specify Backup dialog will close.
10. In the Restore column, tick the backup to be restored.
11. Select the Options tab.
12. In the Restore the database file as list, click the Framework Database Name (i.e., FworkSQLECM) Browse button. The Locate Database Files dialog will be displayed.
    OR
    Use the default file location.

13. Select the folder location where the database will be restored to.
    
    

    Example

     \[fw folder]\Data\DataMSSQL\In the File Name field, enter the file name: FworkSQLECM.mdf

    
    

14. Click the OK button.
15. In the Restore the database file as list, click the Framework Database Name Log (i.e., FworkSQLECM_log) Browse button. The Locate Database Filesdialog will be displayed.
    OR
    Use the default file location.

16. Select the folder location where the database will be restored to.
    
    

    Example

    \[fw folder]\Data\DataMSSQL\
17. In the File Name field, enter the file name: FworkSQLECM_log.ldf
18. Click the OK button.
19. Click the OK button. The database restoration will be performed.
20. Close Microsoft SQL Server Management Studio.

Restore Database - Framework Licence

1. Open Microsoft SQL Server Management Studio (Start > All Programs > Microsoft SQL Server > SQL Server Management Studio).
2. Connect to the required server.
3. Right-click on Databases and click Restore Database.... The Restore Database dialog will be displayed.

4. In the To Database field, enter the Framework Licence Database Name.
    

   Example

   FworkSQLLic
5. In the From Device field, click the Browse button. The Specify Backup dialog will be displayed.
6. Click the Add button. The Locate Backup File dialog will be displayed.
7. Select the folder and file location of the Microsoft SQL Server backup file.
   1. Typical Folder: \[fw folder]\Service\01 - Default Data\
   2. Typical File: bak
8. Click the OK button. The Locate Backup File dialog will close.
9. Click the OK button. The Specify Backup dialog will close.
10. In the Restore column, tick the backup to be restored.
11. Select the Options tab.
12. In the Restore the database file as list, click the Browse button for the Framework Licence database (i.e.,FworkSQLLic). The Locate Database Files dialog will be displayed.
    OR
    Use the default file location.

13. Select the folder location where the database will be restored to.
    
    

    Example

    \[fw folder]\Data\DataMSSQL\
14. In the File Name field, enter the file name: FworkSQLLic.mdf
15. Click the OK button.
16. In the Restore the database file as list, click the Browse button for the Framework Licence database log (i.e., FworkSQLLic_log). The Locate Database Files dialog will be displayed.
    OR
    Use the default file location.

17. Select the folder location where the database will be restored to.
    
    

    Example

    \[fw folder]\Data\DataMSSQL\
18. In the File Name field, enter the file name: FworkSQLLic_log.ldf
19. Click the OK button.
20. Click the OK button. The database restoration will be performed.
21. Close Microsoft SQL Server Management Studio.

Restore Database - Framework Service

1. Open Microsoft SQL Server Management Studio (Start > All Programs > Microsoft SQL Server > SQL Server Management Studio).
2. Connect to the required server.
3. Right-click on Databases and click Restore Database.... The Restore Database dialog will be displayed.

4. In the To Database field, enter the Framework Service Database Name.
   
   

   Example

   FworkSQLService
5. In the From Device field, click the Browse button. The Specify Backup dialog will be displayed.
6. Click the Add button. The Locate Backup File dialog will be displayed.
7. Select the folder location of the Microsoft SQL Server backup file.
8. Typical Folder: \[fw folder]\Service\01 - Default Data\
9. Typical File: FworkSQLService62.bak
10. Click the OK button. The Locate Backup File dialog will close.
11. Click the OK button. The Specify Backup dialog will close.
12. In the Restore column, tick the backup to be restored.
13. Select the Options tab.
14. In the Restore the database file as list, click the Browse button for the Framework Service database (i.e., FworkSQLService). The Locate Database Files dialog will be displayed.
    OR
    Use the default file location.

15. Select the folder location where the database will be restored to.
    
    

    Example

    \[fw folder]\Data\DataMSSQL\
16. In the File Name field, enter the file name: FworkSQLService.mdf
17. Click the OK button.
18. In the Restore the database file as list, click the Browse button for the Framework Service database log (i.e.,FworkSQLService_log). The Locate Database Files dialog will be displayed.
    OR
    Use the default file location.

19. Select the folder location where the database will be restored to.
    
    

    Example

    \[fw folder]\Data\DataMSSQL\
20. In the File Name field, enter the file name: FworkSQLService_log.ldf
21. Click the OK button.
22. Click the OK button. The database restoration will be performed.
23. Close Microsoft SQL Server Management Studio.

Step 4 - Configure Microsoft SQL Server Security

Configures Microsoft SQL Server security for the Framework ECM database.

1. Open Microsoft SQL Server Management Studio (Start > All Programs > Microsoft SQL Server > SQL Server Management Studio).
2. Connect to the required server.
3. Expand: [Server Name] > Security > Logins
4. Right-click the Logins folder and select New Login. The Login - New dialog will be displayed.
5. Select the General

6. Enter a Login Name.
   OR
   Click the Search button to search for a login.
   
   

   Example

   Domain\Domain Users
7. Ensure the selection for the Default Database is: master
8. Select the User Mapping
9. From the Users Mapped to This Login list, tick the required Framework database(s). The Database Role Membership For [Selected Database] list will be updated.
10. For ALL Framework databases, ensure that the following two items are ticked:
    1. db_owner
    2. public
11. Click the OK
12. Close Microsoft SQL Server Management Studio.

Step 5 - ODBC DSN Configuration

Provide Framework with the connection to read and write from the database.

ODBC DSN Configuration - Framework ECM

1. Open Data Sources (ODBC).
2. Select the System DSN
3. Click the Add The Create New Data Source dialog will be displayed.
4. Select SQL Native Client for the SQL Server version being used.
5. Click the Finish The Create a New Data Source to SQL Server dialog will be displayed.
6. Enter the following details:
   1. Name: FworkSQLECM
   2. Description (optional): Enter a description for the database connection. For example, Framework ECM.

   3. Server: Select the SQL Server from the Server drop-down list.
      OR
      Enter the SQL Server name.
      
      

      If there is an error following Step 8, change the server name above to: \[server name]\SQLEXPRESS
7. Click the Next
8. Click the Next
9. Tick Change the default database to.
10. From the drop-down list select: FworkSQLEcm
11. Click the Next
12. Click the Finish The ODBC Microsoft SQL Server Setup dialog will be displayed.
13. Click the Test Data Source...
14. If successful, click the OK
15. Click the OK The ODBC Microsoft SQL Server Setup dialog will close.
16. Click the OK The Data Sources (ODBC) dialog will close.

ODBC DSN Configuration - Framework Licence

1. Open Data Sources (ODBC).
2. Select the System DSN tab.
3. Click the Add button. The Create New Data Source dialog will be displayed.
4. Select SQL Native Client.
5. Click the Finish button. The Create a New Data Source to SQL Server dialog will be displayed.
6. Enter the following details:
   1. Name: FworkSQLLic
   2. Description (optional): Enter a description for the database connection. For example, Framework Licence.

   3. Server: Select the SQL Server from the Server drop-down list.
      OR
      Enter the SQL Server name.
      
      

      If there is an error following Step 8, change the server name above to: \[server name]\SQLEXPRESS
7. Click the Next button.
8. Click the Next button.
9. Tick Change the default database to.
10. From the drop-down list select: FworkSQLLic
11. Click the Next button.
12. Click the Finish button. The ODBC Microsoft SQL Server Setup dialog will be displayed.
13. Click the Test Data Source... button.
14. If successful, click the OK button.
15. Click the OK button. The ODBC Microsoft SQL Server Setup dialog will close.
16. Click the OK button. The Data Sources (ODBC) dialog will close.

ODBC DSN Configuration - Framework Service

1. Open Data Sources (ODBC).
2. Select the System DSN
3. Click the Add The Create New Data Source dialog will be displayed.
4. Select SQL Native Client.
5. Click the Finish The Create a New Data Source to SQL Server dialog will be displayed.
6. Enter the following details:
   1. Name: FworkSQLService
   2. Description (optional): Enter a description for the database connection. For example, FrameworkService.

   3. Server: Select the SQL Server from the Server drop-down list.
      OR
      Enter the SQL Server name.
      
      

      If there is an error following Step 8, change the server name above to: \[server name]\SQLEXPRESS
7. Click the Next
8. Click the Next
9. Tick Change the default database to.
10. From the drop-down list select: FworkSQLService
11. Click the Next
12. Click the Finish The ODBC Microsoft SQL Server Setup dialog will be displayed.
13. Click the Test Data Source...
14. If successful, click the OK
15. Click the OK The ODBC Microsoft SQL Server Setup dialog will close.
16. Click the OK The Data Sources (ODBC) dialog will close.

Step 6 - Install Sentinel Hardware Licence Key

Insert the USB Sentinel Hardware Licence Key into a free USB port on the back of the server.

Step 7 - Install Core Components

Installs a set of common software tools used by the Framework Product Suite.

1. Open Windows Explorer.
2. Browse to: \[fw folder]\Setup\\Insula Software Core Components\v16.x\
3. Double-click setup.exe. The Insula Software Core Components installation will begin.
4. Click the Next The Licence Agreement step will be displayed.
5. Select I accept the terms in the licence agreement.
6. Click the Next The Customer Information step will be displayed.
7. Enter User Name and Organisation
8. Select Anyone who uses this computer (all users).
9. Click the Next The Setup Type step will be displayed.
10. Select Complete.
11. Click the Next The Ready To Install the Program step will be displayed.
12. Click the Install button to begin the installation.
13. Click the Finish button to complete the installation.

Step 8 - Install Framework ECM

Install - Framework ECM

1. Open Windows Explorer.
2. Browse to: \[fw folder]\Setup\Framework ECM\vx.x.x\Setup\ (where x.x.x refers to the latest version of Framework ECM).
3. Double-click Framework ECM.msi. The Welcome step will be displayed.
4. Click Next . The Licence Agreement step will be displayed.
5. Select I accept the terms in the licence agreement.
6. Click Next. The Customer Information step will be displayed.
7. Enter User Name and Organisation details.
8. Select Anyone who uses this computer (all users).
9. Click Next. The Setup Type step will be displayed.
10. Select Complete.
11. Click Next. The Ready To Install the Program step will be displayed.
12. Click Install to begin the installation.
13. Click Finish to complete the installation.

Step 9 - Framework Configuration Utility

Configure the Sentinel Hardware Licence Key using Framework Configuration Utility.

Configure - Framework Configuration Utility

1. Open the Framework Configuration Utility (Start > All Programs > Insula Software > Framework Configuration Utility). The Security Log On dialog will be displayed.
2. Log on to the system using the Username and Password supplied on the Software Licence Certificate.
3. Select the Key
4. Enter the following information:
   • Licence Server Name: The licence server name stored in the licence database.
   • Licence DSN Name: The licence database name stored in the licence database.
   • Key Server Name: The IP address or host name of the machine on the network, where the Sentinel Hardware Licence Key is located.
   • Key Code (decimal): The security code of the Sentinel Hardware Licence Key.
5. Click Save. The yellow coloured fields will populate.
6. Select the Folders
7. Enter the relevant drive letters or UNC path, as required, for the following fields:
   • Drive Letter
   • Client Files
   • Land Files
   • Job Files
   • Purchase Order Files
   • ECM (inc. drive & path)
   • Product/Design (inc. drive & path)
   • OH&S (inc. drive & path)
   • Quality (inc. drive & path)
     Tip: This is typically based on the drive letter or UNC path mapped in Step 3 - Implement Framework Product Suite Files
8. Click Save.
9. Click OK. The Framework Configuration Utility will close.

Step 10 - Test Framework ECM

Tests the installation of Framework ECM.

Start Framework ECM

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

   Double-click the Framework ECM desktop icon.

2. 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 Log in.
3. Click the Yes button to validate the Framework installation. The Update Licence dialog will be displayed.
   OR
   Click the No button to cancel the process.
   OR
   Click the Cancel button to cancel the process.
   
   

4. Browse to the location of the Framework Licence Zip
   
   

   The file is typically located in the \\[fw folder]\Service\02 - Upgrade Data\ folder with the filename FrameworkLicence.zip.

5. Select the file and click the Open The validation will be performed.
6. Log on to the system.

Step 11 - User Acceptance Tests

The following is a list of view only tests that should be performed after installing the application.

Framework ECM - Production Management

Framework ECM - Land Management

Framework ECM - Administration

Framework ECM - Security

Framework ECM - Report Management

Framework ECM - Variation Price Book

Framework ECM - Client And Contact Management