Did you know that logged in users can see a lot more content?

Cache service for Tekla Model Sharing

Last updated March 6, 2017 by Tekla User Assistance tekla.documentation@trimble.com

Software version: 

Cache service for Tekla Model Sharing

Cache service for Tekla Model Sharing

If there are several Tekla Model Sharingcloud service for collaboration and for storing and sharing a model

Tekla Model Sharing is one of the Tekla online services.

users in the same office, we recommend you to install a separate Tekla Model Sharing Cache service. The cache service is recommended especially in regions where the download speed may be limited. The use of cache service reduces the download effort and enables faster download times.

Tekla Model Sharing Cache service downloads model data from the Tekla Model Sharing service and stores it in the file system and then caches it inside a LAN. The first user who reads in a packet from the sharing service loads it to the cache, and the next user gets the data faster from the cache inside the LAN than from the sharing service through the Internet.

Note that the cache is not used for packets that are written out.

The image below shows how the model data is stored to the sharing service and used with the Tekla Model Sharing Cache service.

Install a cache service for Tekla Model Sharing

Software and system requirements for a cache installation:

  • Windows Server 2008 R2, or later
  • .NET Framework 4.5.1
  1. Ensure you have an active Windows computer or a server with enough disk space to store the cached model data.
  2. Download the Tekla Model Sharing Cache service installation file from Tekla Downloads.
  3. Run the installation file and follow the steps in the installation wizard to complete the installation.
    • The default cache folder is ..\TeklaModelSharingCache. If needed, you can change the folder destination.

      Ensure that the destination 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 amount of Tekla Model Sharing users and the size of the models.

    • The default TCP/IP port number for the cache service is 9998.

      Use this port number when you configure Tekla Structures client workstations to use the cache. This port is the main communication and control channel to the cache service.

    • The default TCP/IP port number for internal communication is 9001.

      This port is automatically fetched from the cache service, and it is used for the actual data transfer.

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

    The TCP/IP ports for the cache service need to be open inside LAN/VPN. The cache service is never accessed from the Internet but the cache service downloads and caches the model changes on behalf of the Tekla Structures client workstations.


    If you later need to modify the installation, re-run the TeklaModelSharingCacheService.exe installation file and select Repair. You can then change the previously set cache folder or port numbers.

    Alternatively, if you are used to editing configuration files, you can use the cache service configuration file TmsConfiguration.xml in ..\ProgramData\Tekla\ModelSharingCache\ to modify the cache installation. Modify the TmsConfiguration.xml file using any standard text editor, for example, Microsoft Notepad or an XML editor. Open the text editor as administrator by right-clicking and selecting Run as administrator. This ensures that the file can be saved in the same location from where it was opened.

  4. Check that the Tekla Model Sharing Cache service has started.
    • Locate Tekla Model Sharing Cache from the Windows services by using, for example, the Computer Management console compmgmt.msc or the Services management console services.msc.

    • Use Windows Event Viewer to verify that there are no errors from the service and that there are Information messages showing that the service has started.

  5. Configure Tekla Structures client workstations to use the cache.

    In Tekla Structures , on the File menu, click Sharing > Sharing settings.

    In the Sharing settings dialog box:

    • Name is the name of the computer on which the cache is installed. To check the computer name, click Windows Control Panel > System and Security > System .

    • Port is the cache service port number that you have set when you installed the cache service. The default value is 9998.

Troubleshoot the cache service installation

If you cannot connect to the service from Tekla Structures :

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

  • Ensure sure that the firewalls do not block TCP/IP ports configured to Tekla Structures , for example 9001 or 9998 when you use the default ports.

If the service does not start:

  • Check the Windows Event Viewer's Applicationpart of Tekla Structures functionality that is developed in order to extend the capability of Tekla Structures but that is not included in the Tekla Structures installation

    Log for possible errors.

Quick feedback

The feedback you give here is not visible to other users. We use your comments to improve our content.
We use this to prevent automated spam submissions.
Content rating: 
No votes yet