Manage an on-premises sharing service for Tekla Model Sharing

Tekla Structures
수정됨: 29 10월 2025
Not version-specific
Tekla Structures

Manage an on-premises sharing service for Tekla Model Sharing

Management tasks include reconfiguring or upgrading the on-premises sharing service, upgrading the database schema, backing up and restoring data, and moving the service to a new server.

Change the configuration of the on-premises sharing service for Tekla Model Sharing

If you need to change the settings for the on-premises sharing service for Tekla Model Sharing after installation, you can run the TeklaModelSharingService.exe installer again at any time.

  1. Run the TeklaModelSharingService.exe installer in one of these ways:
    • If your Windows account has administrator permissions, double-click the TeklaModelSharingService.exe installation file.
    • If your Windows account does not have administrator permissions, right-click the TeklaModelSharingService.exe installation file, then select Run as administrator.
  2. When the installer starts, select Repair.
  3. Follow the steps in the installer to change the settings.

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

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 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. See Install an on-premises sharing service for Tekla Model Sharing.

  1. Download the new version of the Tekla Model Sharing On-Premises server installer from Trimble Downloads.
  2. Run the TeklaModelSharingService.exe installer in one of these ways:
    • If your Windows account has administrator permissions, double-click the TeklaModelSharingService.exe installation file.
    • If your Windows account does not have administrator permissions, right-click the TeklaModelSharingService.exe installation file, then select Run as administrator.

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

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. See Install an on-premises sharing service for Tekla Model Sharing.

  1. To upgrade the SQL database schema, run the upgrade script.

    You can 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 stops if the current schema version is not older than the schema version in the upgrade script.

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

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

  3. 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 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 on the Microsoft website.

  1. To back up the SQL database and the related file folders:
    1. Stop the on-premises sharing service for Tekla Model Sharing 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 on-premises sharing service for Tekla Model Sharing.
  2. To restore a backup:
    1. Stop the on-premises sharing service for Tekla Model Sharing.
    2. Restore the backup of the SQL Server database.
    3. Restore the related file folders.
    4. Start the on-premises sharing service for Tekla Model Sharing.

Move the on-premises sharing service for Tekla Model Sharing to a new server

To move the on-premises sharing service for Tekla Model Sharing to a new server without data loss, you must back up both the SQL database and the model data folders, and manage the user transition.

Warning: The Tekla Model Sharing 3 Windows Service must be stopped and disabled on the old server machine while you are moving to the new server machine. Users must not make any changes to models or data on the old server during or after the server move.
  1. Back up data on the old server.
    1. Ensure that all users write out changes so that shared models in the Tekla Model Sharing service are up to date.
    2. Create a baseline for each shared model.

      Creating a baseline for shared models makes rejoining the models after the server change faster.

    3. In the Services management console services.msc, stop the Tekla Model Sharing 3 service.
    4. To disable the Tekla Model Sharing 3 Windows Service, right-click the service, select Properties, then change the Startup type setting to Disabled.
      Warning: Ensure that the Tekla Model Sharing 3 Windows Service remains stopped so that users cannot use this server during or after the server move.
    5. Back up the SQL database and the related file folders.
    6. Back up the model sharing data folder.

      The default location is C:\TeklaModelSharingData. If you use a different location, you can check the location of the model data folder in the TmsConfiguration.xml file under DsStorageFolder.

  2. Install and set up the new server.
  3. Restore the backups from the old server on the new server.
    1. In the Windows Services tool, stop the Tekla Model Sharing 3 service.
      Warning: The Tekla Model Sharing 3 Windows Service must be stopped on the new server before you restore the SQL database and model sharing data from the old server.
    2. Restore the SQL database from the backup.
    3. Copy the files from the model sharing data folder from the old server to the model sharing data folder on the new server.

      The default location is C:\TeklaModelSharingData. If you use a different location, you can check the location of the model data folder in the TmsConfiguration.xml file under DsStorageFolder.

    4. In the Windows Services tool, start the Tekla Model Sharing 3 Windows Service and check the logs for errors.
  4. In Tekla Structures, test the connection to the on-premises sharing service for Tekla Model Sharing on the new server.
  5. If the new server name is different from the old server name, users must follow these steps to connect to the on-premises sharing service for Tekla Model Sharing on the new server:
    1. In Tekla Structures, go to File > Sharing > Sharing settings.
    2. Change the server name to the new server name.
    3. In the local \ModelSharing\Key folder for each shared model, open the ModelSharingService.key file in a text editor.
    4. Change the server name between the <ServerName> and </ServerName> tags to the new server name.

      This example shows a ModelSharingService.key file with the old server name highlighted:

      This example shows a ModelSharingService.key file with the new server name highlighted: :

    5. Save the file.

    If the server name has not changed, users can continue to use the same local copies that they used before the server move.

도움이 되었습니까?
전송
이전
다음