Install an on-premises sharing service for Tekla Model Sharing
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:
-
Download and run the on-premises sharing service installer.
-
Create the SQL database and schema using the SQL script delivered by the installer.
-
Set up the SQL Server database for mixed mode authentication .
-
Set up SQL Server authentication and access rights to the created database.
-
Start the service.
-
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.
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
Step 3: Set up the SQL Server database for mixed mode authentication
- Using Microsoft SQL Server Management Studio, connect to the database server.
- Right-click the database server, then select Properties.
- In the Server Properties, go to the Security page, then select SQL Server and Windows Authentication mode under Server authentication.
- Click OK.
- 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
Step 5: Start the service
- Using the Computer Management console
compmgmt.msc
or the Services management consoleservices.msc
, locate the Tekla Model Sharing 3service from the Windows Services. - Start the service.
- 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
- To enable On-Premises Server selection, download the installer and start the service.
- 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
If you are doing a first-time installation, do not follow these steps.
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.
- To backup the SQL database and the related file folders:
- To restore a backup:
- Stop the Tekla Model Sharing service.
- Restore the backup of the SQL Server database.
- Restore the related file folders.
- 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
and9997
. -
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.