Install an on-premises sharing service for Tekla Model Sharing
The on-premises sharing service for Tekla Model Sharing is an alternative to the cloud-based sharing service. Follow these instructions only if you do not use the cloud-based sharing service for Tekla Model Sharing.
For information about the cloud-based sharing service for Tekla Model Sharing, see Tekla Model Sharing.
Starting from version 2024, each version of the Tekla Model Sharing On-Premises expires on June 1 of the year after release. For example, the 2024 Tekla Model Sharing On-Premises server expires on June 1, 2025. When the current version of the Tekla Model Sharing On-Premises server expires, it stops working. Customers who renew their on-premises subscription must download and install the new version of the server to continue using the on-premises sharing service for Tekla Model Sharing.
Prerequisites for installation
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.
- Usually, each user's computer runs the Windows system locale that matches the language requirements of the user. For more information, see Server collation in SQL Server.
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 from the on-premises sharing service for Tekla Model Sharing installer.
-
Set up the SQL Server database for mixed mode authentication.
-
Set up SQL Server authentication and access rights to the database.
-
Start the on-premises sharing service for Tekla Model Sharing.
-
Run the Enable Tekla Model Sharing On-Premises client setup on the computers where Tekla Structures users will use the on-premises sharing service for Tekla Model Sharing.
Step 1: Download and run the on-premises sharing service for Tekla Model Sharing installer
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 Trimble Identity.
If you need to change the configuration of the on-premises sharing service for Tekla Model Sharing 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 you opened it, run the text editor as an administrator.
Step 2: Create the SQL database and schema
Create the SQL database and schema using the SQL script from the on-premises sharing service for Tekla Model Sharing installer.
Step 3: Set up the SQL Server database for mixed mode authentication
- In 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.
- Under Server authentication, select SQL Server and Windows Authentication mode.
- Click OK.
- To restart the SQL Server service, right-click the database server, then select Restart.
Step 4: Set up SQL Server authentication and access rights for the database
- In Microsoft SQL Server Management Studio, under the selected database engine, right-click the Security folder, then select .
- 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.
- Locate the Tekla Model Sharing 3 service, right-click it, then select Properties.
- On the Log On tab, set the Windows account and password.
- On the User Mapping page, grant rights to the database for the new login.
- From the Users mapped to this login list, select DataSharing9.
- From the Database role membership for list, select db_owner.
- Click OK to create the login and the user.
Step 5: Start the on-premises sharing service for Tekla Model Sharing
- Using the Computer Management console
compmgmt.msc
, or the Services management consoleservices.msc
, locate the Tekla Model Sharing 3 service. - Start the service.
- Using the Windows Event Viewer, verify that there are Information messages showing that the service has started, and that there are no errors from the service.
Step 6: Run the Enable Tekla Model Sharing On-Premises client setup on users' computers
- 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 computers where Tekla Structures users will use the on-premises sharing service for Tekla Model Sharing.
The client setup checks the Tekla Model Sharing On-Premises registry values and enables Tekla Model Sharing On-Premises.
Upgrade the Tekla Model Sharing On-Premises server to a new version
Once a year, a new version of the Tekla Model Sharing On-Premises server is released and the previous version expires. To continue using the on-premises sharing service with your ongoing Tekla Model Sharing projects, and to use the on-premises sharing service with the latest version of Tekla Structures, you must upgrade the server.
Six months before the current version of the Tekla Model Sharing On-Premises server expires, the server writes the following warning in the Windows Event Log:
This on-premises server version stops working {DATE}. Download and install the new version when it becomes available.
After the version expires, the on-premises server will not start and it writes the following error message in the Windows Event Log:
This on-premises server version is no more working after {DATE}. Download and install the new version.
If you are installing Tekla Model Sharing On-Premises server for the first time, do not follow these steps.
If the database schema has changed, you must also upgrade the database schema.
Upgrade the database schema for Tekla Model Sharing On-Premises server
Upgrade the database schema when the database schema changes.
If you are installing Tekla Model Sharing On-Premises server for the first time, 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 you begin any software or hardware upgrade process, such as upgrading the on-premises sharing service for Tekla Model Sharing 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 for SQL Server database backups, see Back Up and Restore of SQL Server Databases.
- To back up the SQL database and the related file folders:
- To restore a backup:
- Stop the on-premises sharing service for Tekla Model Sharing.
- Restore the backup of the SQL Server database.
- Restore the related file folders.
- Start the on-premises sharing service for Tekla Model Sharing.
Troubleshooting
If you cannot connect to the on-premises sharing service for Tekla Model Sharing from Tekla Structures:
-
Ensure that the Tekla Model Sharing 3 Windows Service is running.
-
Ensure 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 sharing service for Tekla Model Sharing is backward compatible, but not forward compatible.
To use the on-premises sharing service for Tekla Model Sharing with the latest version of Tekla Structures, you must upgrade the Tekla Model Sharing On-Premises server to the latest version.