Install an on-premises sharing service for Tekla Model Sharing

Tekla Structures
Not version-specific
Tekla Structures

Install an on-premises sharing service for Tekla Model Sharing

Note:

To install the on-premises sharing service for Tekla Model Sharing you must be familiar with SQL server installation process and database management.

The on-premises sharing service for Tekla Model Sharing requires a Windows Server operating system and Microsoft SQL server with SQL Server Management studio.

  • Use the default compatibility settings for the required SQL Server.
  • In most cases, a computer runs the Windows system locale that matches the language requirements of the user. For more information, see Using SQL Server Collations.

Installation workflow

The main steps for installing an on-premises sharing service for Tekla Model Sharing are:

  1. Download and run the on-premises sharing service installer.

  2. Create the SQL database and schema using the SQL script delivered by the installer.

  3. Set up the SQL Server database for mixed mode authentication .

  4. Set up SQL Server authentication and access rights to the created database.

  5. Start the service.

  6. Run the Enable Tekla Model Sharing On-Premises client setup on the Tekla Structures client workstations that will use the Tekla Model Sharing service.

Step 1: Download and run the on-premises sharing service installer

To be able to download the on-premises sharing service installer, you must have:

  • Ordered a license from Trimble.
  • Received a confirmation that Trimble has enabled the installer download for the named person that has a valid Tekla Identity.
  1. To download the on-premises sharing service installer, go to Tekla Model Sharing On-Premises.
  2. Start the installer using a Windows account with administrator permissions.
  3. On the SQL Configuration: SQL Server database parameters page, fill in the following information:
    • The default value for the SQL Server host machine is a single dot (.).

      Use the default value when the SQL Server is running on the same server as the on-premises sharing service.

      If the SQL Server is located on another server, or is a named instance, change the dot (.) to the correct value. For example, DBSERVER (the default instance on another server called DBSERVER), or .\SQLSERVER (for a local named instance), or DBSERVER\SQLSERVER (for a named instance on a server called DBSERVER).

      If you use a non-standard TCP port to connect the SQL Server, enter the port number separated by a comma after the SQL Server host machine, for example SQLSERVER,61435.

    • The default database name is DataSharing9.

    • The default SQL Server login name is datasharing.

    • In the SQL Server login password box, enter the password that you created for the SQL Server login in Microsoft SQL Server Management Studio.

    • Depending on the SQL Server authentication mode, choose either Windows Authentication or SQL Server Authentication.
  4. On the SQL Configuration: Ports, data storage folder and SMTP mail server address page, fill in the following information:
    • The default TCP/IP port number for clients to connect to is 9997.

    • The default model data folder is ..\TeklaModelSharingData\. If needed, you can change the folder.

      Make sure that the folder has enough disk space for the estimated usage of the service. The required disk space can vary from a few gigabytes to terabytes, depending on the number of Tekla Model Sharing users and the size of the models.

    • The default internal TCP/IP port for data transfer is 9000.

      If the ports cause conflicts or other problems because of other services or a firewall, you can change the ports.

    • Configure the SMTP mail server address for sending email.

If you need to change the Tekla Model Sharing service installation parameters after installation, run the TeklaModelSharingService.exe installer again, then select Repair.

If you change the location of the model data folder, move the previous model data to the new location.

You can also use the service configuration file TmsConfiguration.xml in ..\ProgramData\Tekla\ModelSharing\v3\ to modify the Tekla Model Sharing service installation. Edit the TmsConfiguration.xml file using any standard text editor, such as Microsoft Notepad. To ensure that you can save the file in the same location from which it was opened, open the text editor as an administrator by right-clicking and selecting Run as administrator.

Step 2: Create the SQL database and schema using the SQL script delivered by the installer

  1. In Microsoft SQL Server Management Studio, open the CreateSchema-DataSharing92.sql file, located in .. \ProgramData\Tekla\ModelSharing\v3\.
    If ..\ProgramData\ is located on a network drive, it is a hidden folder. Enter the folder path in the Open file dialog box or in the Windows Explorer address bar.
  2. Click Execute to run the script.

    The database schema is created and the database content is initialized as part of the script. The execution of the script is interrupted if the database already exists.

  3. Select the database list, then click Refresh to make sure that a database called DataSharing9 was created.

Step 3: Set up the SQL Server database for mixed mode authentication

  1. Using Microsoft SQL Server Management Studio, connect to the database server.
  2. Right-click the database server, then select Properties.
  3. In the Server Properties, go to the Security page, then select SQL Server and Windows Authentication mode under Server authentication.
  4. Click OK.
  5. Right-click the database server, then select Restart to restart the SQL Server service.

Step 4: Set up SQL Server authentication and access rights for the created database

  1. In Microsoft SQL Server Management Studio, under the selected database engine, right-click the Security folder, select New > Login.
  2. On the General page, set the following options:
    • Enter a name for the login, such as datasharing.

    • Select SQL Server authentication and enter the password for the login in the Password and Confirm password boxes.

    • Clear the Enforce password expiration check box.

    • Optional: Select DataSharing9 as the Default database.

    • If you use Windows Authentication for SQL Server, set the Windows account and password for the Tekla Model Sharing 3 service after the installation.

      Open the Services application in Windows. Locate the Tekla Model Sharing 3 service, right-click it, then select Properties. On the Log On tab, set the right Windows account and password.

  3. On the User Mapping page, grant rights to the database for the new login.
    1. From the Users mapped to this login list, select DataSharing9.
    2. From the Database role membership for list, select db_owner.
    3. Click OK to create the login and the user.

Step 5: Start the service

  1. Using the Computer Management console compmgmt.msc or the Services management console services.msc, locate the Tekla Model Sharing 3service from the Windows Services.
  2. Start the service.
  3. Using the Windows Event Viewer, verify that there are no errors from the service and that there are Information messages showing that the service has started.

Step 6: Run the Enable Tekla Model Sharing On-Premises client setup on the Tekla Structures client workstations

  1. To enable On-Premises Server selection, download the installer and start the service.
  2. Run the Enable Tekla Model Sharing On-Premises client setup on the Tekla Structures client workstations.

When the client setup is installed, it checks the Tekla Model Sharing On-Premises registry values and enables the use of the Tekla Model Sharing service on the workstations where the client setup has been installed.

Optional: Upgrade the server version

If you need to upgrade the server version, run the installer for the new version. If the database schema has changed, you must also upgrade the database schema.

Optional: Upgrade the database schema

Note:

If you are doing a first-time installation, do not follow these steps.

  1. Double-click the TeklaModelSharingService.exe installation file to run the Tekla Model Sharing service installation.

    The Tekla Model Sharing 3 Windows Service stops automatically and attempts to start automatically.

  2. If the SQL database schema needs to be updated, run the upgrade script.
    Tip:

    Check the current database schema version using the GetSchemaVersion.sql script located in ..\ProgramData\Tekla\ModelSharing\v3\.

    Run all the needed upgrade scripts in the right order. The order depends on your current database schema version.

    The upgrade script checks the current database schema version when you start to run the script. The script is interrupted if the current schema version is not the older than the schema version in the upgrade script.

    1. In Microsoft SQL Server Management Studio, open the UpgradeSchema-DataSharing<version>.sql file located in ..\ProgramData\Tekla\ModelSharing\v3\.

      If ..\ProgramData\ is located on a network drive, it is a hidden folder. Enter the folder path to the Open dialog box or to the Windows Explorer address bar.

    2. Click Execute to run the script.

Back up and restore data

We recommend that you back up the data regularly, for example, daily. Ensure that your data is backed up before any software or hardware upgrade process, such as upgrading the Tekla Model Sharing service version or the SQL database.

The on-premises sharing service for Tekla Model Sharing uses the SQL database for the bookkeeping of shared models. The model data is stored in the file folders in Windows.

The database name and the path for model data settings are in the service configuration file TmsConfiguration.xml in ..\ProgramData\Tekla\ModelSharing\v3\:

  • DsConnectionString is the name of the database

  • DsStorageFolder is the storage for the model data

For best practices of the SQL Server database backup, see Back Up and Restore of SQL Server Databases.

  1. To backup the SQL database and the related file folders:
    1. Stop the Tekla Model Sharing service to get a consistent snapshot of the SQL database and the related file folders.

      Optionally, you can first create a backup on the SQL database, and then take a backup of the file folders. If you do this, the references in the SQL database will find the related files with a successful backup or a restore.

    2. Take a backup of the SQL Server database.
    3. Take a backup of the file folders.
    4. Start the Tekla Model Sharing service.
  2. To restore a backup:
    1. Stop the Tekla Model Sharing service.
    2. Restore the backup of the SQL Server database.
    3. Restore the related file folders.
    4. Start the Tekla Model Sharing service.

Troubleshooting

If you cannot connect to the Tekla Model Sharing service from Tekla Structures:

  • Ensure that the Tekla Model Sharing 3 Windows Service is running.

  • Ensure sure that your firewalls do not block the TCP/IP ports that Tekla Structures uses. The default ports are 9000 and 9997.

  • Ensure that the SQL Server is running correctly.

If the service does not start:

  • Check the Application Log in Windows Event Viewer for possible errors.

Compatibility

The on-premises Tekla Model Sharing service is backward compatible, but not forward compatible.

See also

Oliko tästä apua?