/
ECM Client Installation

ECM Client Installation

Pre-Requisite Checklist

Installation Checklist

The following steps are required to install Framework ECM on client workstations.

Step 1 - Map Network Drive

Allow access to the server's mapped Framework drive.

Important:

  • It is recommended that a mapped drive be added to the network login script.
  • If a mapped network drive is already available to the shared Framework drive, proceed to Step 2.

Map A Network Drive

  1. Open Windows Explorer.
  2. From the Tools menu, select Map Network Drive.... The Map Network Drive dialog appears.

    In Windows Vista or Windows 7, if the Tools menu is not visible, press the Alt


  3. Using the drop-down menu, select a suitable drive letter (i.e., W:\ drive).

    This is the drive letter created in the Environment Setup Checklist (see Step 3 - Implement Framework)

  4. Product Suite Files.
  5. Click the .. button. The Browse For Folder dialog is displayed.
  6. Browse to the [server name] and select the shared folder Framework.
  7. Click OK
  8. Tick: Reconnect at logon
  9. Click the Finish

Step 2 - Install Microsoft SQL Server Native Client

Installs the native client for Microsoft SQL Server. This driver allows the client workstation to connect to the Microsoft SQL Server.

If Microsoft SQL Native Client is already installed, proceed to Step 3 - ODBC DSN Configuration. If unsure, re-install the software.

Install - Microsoft SQL Native Client

  1. Open Windows Explorer.
  2. Browse to: \[fw folder]\Setup\Database - MSSQL\Microsoft - SQL Server Native Client Driver\

    Install the correct Microsoft SQL Server Native Client Driver based on the version of Microsoft SQL Server installed on the server.
  3. Double-click the relevant setup file. The Microsoft SQL Server Native Client 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 Registration Information step will be displayed.
  7. Enter the registration details.
  8. Click the Next The Feature Selection step will be displayed.
  9. Click the Next The Ready To Install the Program step will be displayed.
  10. Click the Install button to begin the installation.
  11. Click the Finish button to complete the installation.

Step 3 - ODBC DSN Configuration

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

Microsoft 64-Bit Operating Systems include two ODBC Data Source Administrator executable files.

Depending on the operating system, use the following to open the correct ODBC Data Source:

On 32-Bit Operating Systems: Use either:

Start Menu > Control Panel > Administrative Tools > Data Sources (ODBC)
OR
\\%SystemRoot%\system32\odbcad32.exe (e.g., C:\Windows\system32\odbcad32.exe).

On 64-Bit Operating System: Use:

\\%SystemRoot%\SysWOW64\odbcad32.exe (e.g., C:\Windows\SysWOW64\odbcad32.exe).

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.

Step 4 - Install Core Components

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

If installing on Microsoft Windows Vista or above, the User Account Control (UAC) Consent prompt may be displayed during the installation.
  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 5 - Install Framework ECM

If Microsoft SQL Native Client is already installed, proceed to Step 3 - ODBC DSN Configuration. If unsure, re-install the software.

Install - Framework ECM

If installing on Microsoft Windows Vista or above, the User Account Control (UAC) Consent prompt may be displayed during the installation.
  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 6 - Framework Configuration Utility

Configure the Sentinel Hardware Licence Key using Framework Configuration Utility.

This step is ONLY required if Framework ECM is being installed on the server.

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 paths, 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.
After saving the changes, the Framework Configuration Utility automatically copies the relevant fields from the Framework Licence Database group to the Sentinel Hardware Licence Key group.

Step 7 - 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 8 - User Acceptance Tests

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

This step is ONLY required if Framework ECM is being installed on the server.

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