Install the Cache service for Tekla Model Sharing

Tekla Structures
Tekla Structures

Install the Cache service for Tekla Model Sharing

Tekla Model Sharing Cache service downloads model data from the Tekla Model Sharing service and caches the data in the file system inside a LAN. Using the cache service reduces the use of the Internet, resulting in faster download times when the same data is requested more than once. Note that the cache is not used for packets that are written out.

The cache service needs an Internet connection to download model data from the sharing service. The first time a user fetches a packet it will be loaded to the cache service. Any following requests to the same packet will then be served fast from the cache service inside the LAN.

The cache service is useful even if there is only one Tekla Model Sharing user in the same office. For example, rejoining a model is faster as the model data is available in the cache service. In addition, the model data is always loaded as small data blocks. This is useful if the downloading is interrupted for some reason, because the cache service can just download the missing blocks later.

Note that data is not automatically cleared from the Cache service. To clear unnecessary data, you can simply delete old files from the Cache service.

If there are several Tekla Model Sharing users in the same office, we highly recommend you to install the Tekla Model Sharing Cache service. The Cache service is recommended especially in regions where the download speed may be limited.

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


If the Cache service cannot be reached for any reason, Tekla Structures will use the cloud storage for model changes directly. This can also happen when a download operation is on-going, if the connection to Cache service times out.

You can see whether the Cache service is in use by checking the ClientLog_cat.txtClientLog_dog.txt log files in the \Users\<user>\AppData\Local\Tekla DataSharing folder.

Software and system requirements for a cache installation:

  • Windows Server 2008 R2, or later
  • .NET Framework 4.5.1

Install a cache service in the following way:

  1. Ensure that 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 C:\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.

    Network access

    You need to allow inbound traffic for TCP/IP ports (defaults 9001 and 9998) for the cache service host.

    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 cache service needs an Internet connection to download model changes from the sharing service.


    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. To use content from the previous cache folder, copy or move the needed content to the new folder.

  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.

Troubleshooting the Cache service installation

Problem Possible solutions

Cannot connect to the Cache 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.

Canche service does not start

Check the Windows Event Viewer's Application Log for errors.

Setting the Log On account for the Cache Windows service

In case the Cache service needs to access some special resources, such as shared network drives, you need to ensure that the Log On account for the Cache Windows service has permissions to access those resources. Note that the Log On account also needs to have reading and writing permissions to the C:\ProgramData\Tekla\ModelSharingCache folder. We recommend that you use the same account both for installing the Cache service and, if needed, as the Log On account for the Cache Windows service.

By default, the Log On account for the Cache Windows service is Local System Account, so you may need to change the account:
  1. Right-click the Cache Windows Service in the Services dialog box.

  2. Select Properties.

  3. On the Log On tab, select This Account and type the account name and password.

  4. Click OK.

Bylo to užitečné?