/
Framework Integration Client Installation

Framework Integration Client Installation

Owned by Matthew Garrett
Last updated: Nov 25, 2021
5 min read

The following guide is designed to install Framework Integration on client workstations.

Article Index

Pre-Requisite Checklist

  • Check the Workstation System Requirements

  • Complete the Server Installation Overview

Step 1 - 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 2 - ODBC DSN Configuration - Framework. 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 2 - ODBC DSN Configuration - Framework

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

If Framework ECM and Framework Licence databases have already been configured, please proceed to Step 3 - ODBC Configuration - Framework Integration.

 

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 10.0.

  5. Click the Finish The Create a New Data Source to SQL Server dialog will be displayed.

  6. Enter the following details:

    • Name: FworkSQLEcm

    • Description (optional): Enter a description for the database connection. For example, Framework ECM.

    • 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

  3. Click the Add The Create New Data Source dialog will be displayed.

  4. Select SQL Native Client 10.0.

  5. Click the Finish The Create a New Data Source to SQL Server dialog will be displayed.

  6. Enter the following details:o Name: FworkSQLLic

    1. Description (optional): Enter a description for the database connection. For example, Framework

  7. Licence.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

     

  8. Click the Next

  9. Click the Next

  10. Tick Change the default database to.

  11. From the drop-down list select: FworkSQLLic

  12. Click the Next

  13. Click the Finish The ODBC Microsoft SQL Server Setup dialog will be displayed.

  14. Click the Test Data Source...

  15. If successful, click the OK

  16. Click the OK The ODBC Microsoft SQL Server Setup dialog will close.

  17. Click the OK The Data Sources (ODBC) dialog will close.

Step 3 - ODBC Configuration - Framework Integration

Provides Framework Integration with the connection to read and write from the database.

ODBC DSN Configuration - Framework Integration

  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 10.0.

  5. Click the Finish The Create a New Data Source to SQL Server dialog will be displayed.

  6. Enter the following details:

    • Name: FworkSQLIntMap

    • Description (optional): Enter a description for the database connection. For example, Framework Integration Mapping.

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

      Info

      If there is an error following Step 8, change the server name above to: \[server name]\SQLEXPRESS


  1. Click the Next

  2. Click the Next

  3. Tick Change the default database to.

  4. From the drop-down list select: FworkSQLIntMap

  5. Click the Next

  6. Click the Finish The ODBC Microsoft SQL Server Setup dialog will be displayed.

  7. Click the Test Data Source...

  8. If successful, click the OK

  9. Click the OK The ODBC Microsoft SQL Server Setup dialog will close.

  10. Click the OK 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.

 

  1. Open Windows Explorer.

  2. Browse to: \[fw folder]\Setup\Insula Software Core Components\v16.X.XX\

  3. Double-click setup.exe. The Insula Software 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 Integration

  1. Open Windows Explorer.

  2. Browse to: \[fw folder]\Setup\Framework Integration\vx.x.x\Setup\ (where x.x.x refers to the latest version of Framework Integration).

  3. Double-click Framework Integration.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

  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 - Test Framework Integration

Tests the installation of Framework Integration.

Start Framework Integration

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

  2. Log on to the system.

Step 7 - User Acceptance Tests

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

Screen/View

Menu Path

Completed

Screen/View

Menu Path

Completed

Start Framework Integration





Log in as a user other than a super-user