/
Framework Logistics Tablet Database Setup

Framework Logistics Tablet Database Setup

Owned by Julie Doyle-Whitelock (Deactivated)
Last updated: Feb 05, 2019

The following guide is designed to configure and install Framework Logistics Tablet and the associated Framework Logistics Tablet database on a database server.

This can be the same server that hosts the Framework ECM database.

Pre-Requisite Checklist

The following pre-requisite items are required:

  • A workstation with Framework ECM installed and working correctly.
  • A workstation with Framework Logistics Desktop installed and working correctly
  • A server for the installation of Microsoft SQL Server.
This can be the same server that hosts the Framework ECM and Framework Licence databases.
  • A server for the restoration of the Framework Logistics Tablet database.
This can be the same server that hosts the Framework ECM and Framework Licence databases.
  • A hosted environment solution (e.g., Citrix or Remote Desktop Protocol (RDP)).


Step 1 - Install Microsoft SQL Server 2008

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

If Microsoft SQL Server 2008 is already installed, you must still configure Microsoft SQL Server 2008 to allow remote connections. 

Due to the range of versions and platforms available for Microsoft SQL Server 2008, 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.

Pre-Requisite Software For Microsoft SQL Server 2008

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

The following list of software may have been installed on your system using Microsoft Windows Updates.
  • Microsoft DotNet
  • Microsoft Windows Installer
  • Microsoft Powershell

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

Prior to installing Microsoft SQL Server 2008, run Microsoft Windows Update to get the latest hotfixes for the previous Microsoft installations.

  1. Open Windows Explorer.
  2. Browse to: \[fw folder]\Setup\Database - MSSQL\Microsoft - SQL Server 2008 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 2008 To Allow Remote Connections

This only applies to organisations that:

  1. Have installed the Express or Developer Edition of Microsoft SQL Server 2008.
    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 2008 > 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 2 - Configure Microsoft SQL Server Security

Allows users to connect to the Framework databases.

The following server security changes are the minimum requirements to access the Framework databases. Read the Microsoft SQL Server documentation for more information on Microsoft SQL Server security.
  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. In the Login Name field, enter 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 FworkSQLCstLTablet. The Database Role Membership For [Selected Database] list will be updated.
  10. Ensure that the following two items are ticked:
    • db_owner
    • public
  11. Click the OK

Step 3 - Restore Database 

The following database restoration is based on Insula Software's recommended settings.

Restore Database - Framework Construction Logistics Tablet

  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 Databases field, enter the Framework Database Name.

    Example

    FworkSQLCstLTablet
  5. In the From Device field, click the Browse The Specify Backup dialog will be displayed.
  6. Click the Add The Locate Backup File dialog will be displayed.
  7. Select the folder location of the Microsoft SQL Server backup file.
    • Typical Folder: C:\Framework\Service\01 - Default Data\
    • Typical File: bak
  8. Click the OK The Locate Backup File dialog will close.
  9. Click the OK The Specify Backup dialog will close.
  10. In the Restore column, tick the backup to be restored.
  11. Select the Options
  12. In the Restore the database file as list, click the Browse button for the Framework Logistics Tablet database (i.e., FworkSQLCstLTablet). 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.
    Default Location: C:\Framework\Data\DataMSSQL\
  14. In the File Name field, enter the file name: mdf
  15. Click the OK
  16. In the Restore the database file as list, click the Browse button for the Framework Logistics Tablet database log (i.e., FworkSQLCstLTablet_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.
    Default Location: C:\Framework\Data\DataMSSQL\
  18. In the File Name field, enter the file name: ldf
  19. Click the OK
  20. Click the OK The database restoration will be performed.
  21. Close Microsoft SQL Server Management Studio.

Step 4 - Framework User Configuration

This step is performed Framework ECM's Administration and Security modules.

To use Framework Logistics Tablet, a user must be established as a Framework ECM user with a role of staff member and construction manager. This user can be a previously established user or a new user.

This user should have a descriptive name (i.e., Hosted Logistics) and NOT be a named staff member (i.e., John Smith). The following procedure uses the user name Hosted Logistics with the password 0000.

Check Entity Status

Check the entity status of the proposed Framework Logistics Tablet user.

  1. Open Framework ECM.
  2. Open the Administration module.
  3. Open the Entity screen (Administration > Entity > Entity).
  4. From the Entity Roles list, select Construction Manager and Staff Member.
  5. Check if the Tablet PC User is in the list. If the user is on the list, continue with creating a new Framework user (see below).
If the user is not on the list, consult the Framework ECM User Guide for steps in adding a new entity.

Create New Framework User

To create a new Framework ECM user for Framework Logistics Tablet:

  1. Open the Security
  2. Open the User screen (Security > User).




  3. From the Security Group drop-down list, select Guest Users. The User list will be refreshed.

    Repeat steps 9-14 to add more region/divisions. The following is an example of a completed Region/Division list.

  4. Click the New The User (General tab) dialog will be displayed.



  5. Enter the required General information
    • Staff: Click the Staff popup button to select or enter a new staff member.
      Example: Hosted Logistics
    • User Group: Ensure the group is the security group the hosted logistics user belongs to.

  6. Enter the required Password Example: 0000

    The Password and Confirm Password fields should be a numerical value to reflect the numerical login screen of Framework Logistics Tablet. This password will be given to those staff that are to have access to Framework Logistics Tablet in a hosted environment.

  7. Enter the Notes information, if required.
  8. Select the Region/Division



  9. Click the New toolbar icon. The User Region/Division dialog will be displayed.



  10. Enter the required General information, if required.
  11. Enter the required Log In information, if required.
  12. Enter the required CRM Tools information, if required.
  13. Enter the required Work Flow Analysis information, if required.
  14. Click the OK The User Region/Division dialog will close.
  15. Click the OK The User dialog will close.

Repeat steps 9-14 to add more region/divisions. The following is an example of a completed Region/Division list.


Allocate Logistics Security Permissions

If any security permissions are allocated to Framework Logistics Tablet users:

  1. Open the Security module.
  2. Open the Security Permission screen (Security > Permission).



  3. From the Permission Level list, select Permission Defaults, Groups, or Users. This will populate the Permission Groups Typically permissions would be granted at the Groups level.
  4. Expand Framework Applications > Construction Logistics.
  5. Click the Edit The screen changes to edit mode.
  6. Allocate relevant construction logistics permissions for the user.
  7. Click the OK

Step 5 - Framework Logistics Desktop Configuration

This step is performed using Framework Logistics Desktop.

The Logistics Site screen displays the number of sites (or logistics licences) that are available to an organisation. New sites only become available if the number of licences are increased.

To purchase more licences, Contact Insula Software.

To Edit A Logistics Site

  1. Open the Logistics Site screen (Site > Logistics Site)



  2. Select a logistics site.
  3. Click the (Right) Edit The Logistics Site (General tab) dialog will be displayed.



  4. Enter the required Framework Site
    • Name: The descriptive name of the hosted environment.
      Example: Hosted Logistics Environment
    • Reference: Enter a reference name or click the Copy button to copy the Name
  5. Enter the required Configuration
    • Staff Member: Click the Staff Member popup button to select the staff member who will have access to Framework Logistics Tablet via the hosted environment.
      Example: Hosted Logistics
    • Role: Click the Role popup button to select the role of the staff member. This is typically a Construction Manager.
  6. Enter the required Host Computer
    • Name/IP Address: The computer name or IP address of the server hosting the Framework Logistics Tablet database.
  7. Enter the required Client Allocation
    • Criteria Method: Click the drop-down button to select the criteria that the tablet will receive.
      Example: Major Work Flow Stage
    • Criteria Value: Based on the selected Criteria Method, select the criteria value.
      Example: Construction
  8. Select the Connection tab



  9. Enter the required Internet Connection
    • Required?: Toggle: Yes/No. Will Framework launch the Internet connection?
    • Confirmation Host: Server IP Address.
    • DUN Connection: Dial Up Networking (DUN) Connection for Internet access.
    • Timeout (seconds): Length of time before the software registers a failure for Internet timeout. Typically 10 seconds.
  10. Enter the VPN Connection information, if required.
    • Required?: Toggle: Yes/No. Will Framework launch the VPN connection?
    • Confirmation Host: Server IP Address.
    • DUN Connection: Dial Up Networking (DUN) Connection for VPN access.
    • Timeout (seconds): Length of time before the software registers a failure for Internet timeout. Typically 10 seconds.
  11. Enter the required Server Connection
    • Host Server: The IP Address of the Framework server.

  12. Select the Synchronise tab.



    The information contained on the Synchronise tab is automatically populated and is for viewing purposes only.
  13. Click the OK The Logistics Site dialog will close.

To Allocate Users To The Logistics Site

  1. Open the User Allocation screen (Site > User Allocation)



  2. From the Site drop-down list, select a site. The Users (Unallocated) list will update.
  3. Select the unallocated user that is to be allocated to the selected logistics site.

  4. Click the Allocate Users The user will become allocated to the logistics site and moved to the Users (Allocated) list.

    Only one user should be allocated to a site at any one time.

  5. Click the Close

To Allocate Jobs To The Logistics Site

  1. Open the Job Allocation screen (Site > Job Allocation)



  2. From the Site drop-down list, select a site.
  3. Click the Allocate The Allocate Client(s) prompt will appear.
  4. Click the No button to allocate a number of jobs based on the site's allocation criteria. The Jobs list will update.
    OR
    Click the Yes button to allocate a single known job.
  5. Click the Close

Step 6 - 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.
  1. Open Windows Explorer.
  2. Browse to: \[fw folder]\Setup\Insula Software Core Components\v16.2\
  3. Double-click 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 7 - Install Framework Logistics Tablet

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\Framework Logistics Tablet\vx.x.x\Setup\ (where x.x.x refers to the latest version of Framework Logistics Tablet).
  3. Double-click Framework Logistics Tablet.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 8 - ODBC DSN Configurations

Provides the system with connections to the Framework databases.

CRITICAL

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 Server Native Client 10.0 (for SQL 2008, or SQL 2008R2) or SQL Server Native Client 11.0 (for SQL 2012)
  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) Administrator dialog will close.

ODBC DSN Configuration - Framework Construction Logistics Tablet

  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 Server 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: FworkSQLCstLTablet
    • Description (optional): Enter a description for the database connection. For example, Framework Construction Logistics Tablet.

    • Server:Select the SQL Server Database on which Framework ECM is installed on your Network.
      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: FworkSQLCstLTablet
  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) Administrator dialog will close.

Step 9 - Prepare Initialisation File For Scheduled Task

On the server that hosts the Framework Logistics Tablet database, copy the following contents into a new .ini file.

Example

FworkCstLSync.ini

The initialisation file should be stored in a standard location.

Example

\\[fw folder]\Data\IntProfiles\

If unfamiliar with the environment or creating .ini files, please consult your Network Administrator or Contact Insula Software.

CRITICAL

After creating the .ini file, review the items marked bold.


;Framework Construction Logistics Synchronise

;Copyright 1998 - 2012 Insula Group Pty Ltd

;This file is a standard .ini file

;It's purpose is to be used for controlling the sync app for special use

[Settings]

ODBCDSN_Framework=FworkSQLECM

ODBCDSN_FworkCstLTablet=FworkCstlTablet

SMTP_Server=SMTPSERVER

;SMTP_UseSecurity: 1=Yes, 0=No

SMTP_UseSecurity=0

SMTP_UserName=enterUserName

SMTP_PWD=enterPassword

Mail_From=FrameworkLogisticsSync@yoursite.com.au

Mail_Recipient=Integration@yoursite.com.au;IntegrationSupport@insulagroup.com.au

Mail_Subject="Framework Logistics Sync : FworkCstLMgrSync"

[Sync Options]

;SyncFlow: 0=Full, 1=UploadOnly

SyncFlow=0

;Packet1 (Construction Progress): 0=No, 1=Yes

Packet1=1

;Packet2 (Messages, Notifications): 0=No, 1=Yes

Packet2=1

;Packet3 (Jobs, Orders, VOs, Tenders, Colours): 0=No, 1=Yes

Packet3=1

;Packet4 (Tablet, Static Data, Entity, Prefs): 0=No, 1=Yes

Packet4=1

;Packet5 (Keys, Templates, Standard Notes): 0=No, 1=Yes

Packet5=1

;Packet6 (Company, Product, Land, Diary): 0=No, 1=Yes

Packet6=1

;Packet7 (Calendar, RMS, Security): 0=No, 1=Yes

Packet7=1

;UpdateAllocatedClients: 0=No, 1=Yes

UpdateAllocatedClients=1

;DeleteUnAllocatedData: 0=No, 1=Yes

DeleteUnAllocatedData=1

;PerformLogging: 0=No, 1=Yes

PerformLogging=0

;DisplayMsg: 0=No, 1=Yes

DisplayMsg=0

;ShowForm: 0=No, 1=Yes

ShowForm=1

;SendEmail: 0=No, 1=Yes

SendEmail=1

Step 10 - Create A Scheduled Task

Create a new scheduled task on the Microsoft Windows Server that hosts the Framework Logistics Tablet database.

If unfamiliar in setting up scheduled tasks please consult your Network Administrator.

The command line should look similar to the following:

"C:\Program Files\Insula Group Pty Ltd\Framework CstLTablet\Bin\FworkCstLSynchronise.exe" {Path}\FworkCstlSync.ini

  • Set the desired time to run the synchronisation.

    Example

    Every night at 1 a.m.
  • An email will be sent to the mail recipient once the manager synchronisation is complete.

Step 11 - Test Framework Logistics Tablet

Tests the installation of Framework Logistics Tablet.

  1. Start Framework Logistics Tablet (Start > All Programs > Insula Software > Framework Logistics Tablet).

    Double-click the Logistics Tablet desktop icon.

    A dialog prompt asking to connect to the server will be displayed.
  2. Click the Yes button to connect to the Framework server and configure the site. The Framework Logistics Synchronise dialog will be displayed and the software will attempt to connect to the server.
  3. After successful connection, run the scheduled task that was created in Step 10 - Create a Scheduled Task.

Step 13 - User Acceptance Tests

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

Screen / ViewMenu PathCompleted
Start Framework Construction Logistics Tablet

Log in as the assigned user for the Tablet PC

View all screens using the Home page

View all screens using the Toolbar