1. Home
  2. Tekla Structures
  3. Manage Tekla Structures
  4. Start new projects as a Tekla Structures administrator
  5. Set up a project for collaboration and interoperability
  6. Collaborative modeling for administrators
  7. Install the cache service for Tekla Model Sharing

Install the cache service for Tekla Model Sharing

Tekla Structures
Modified: 14 Aug 2023
2023
Tekla Structures

Install the cache service for Tekla Model Sharing

Using the cache service for Tekla Model Sharing makes downloading model data faster when the same data is requested more than once, such as when several users in the same office are working in a shared model. The cache service is especially helpful in locations where download speed might be limited.

The cache service downloads model data from the Tekla Model Sharing service and caches the data in the file system in a local area network (LAN). The first time that a user fetches a packet, it is stored in the cache service. Any later requests for the same packet are served from the cache service in the LAN. The cache is not used for packets that are written out.

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 because the model data is available locally in the cache service. Also, because the model data is always loaded in small data blocks, the cache service can download any missing blocks later if the download is interrupted.

This image shows how the model data is stored in the sharing service and used with the cache service for Tekla Model Sharing.

Note:

If the cache service cannot be reached, Tekla Structures uses the cloud storage for model changes directly. Tekla Structures also uses the cloud storage if the connection to the cache service times out while a download operation is in progress.

You can see whether Tekla Structures is using the cache service by checking the ClientLog_cat.txt and ClientLog_dog.txt log files in the \Users\<user>\AppData\Local\Tekla DataSharing folder.

Data is not automatically cleared from the cache service. To clear unnecessary data, you can delete old files from the cache service.

Software and system requirements for cache service installation

The computer or server where you install the cache service must have:

  • One of these Windows operating systems:

    • Windows Server 2019 or later

    • Windows 10 or later

  • Microsoft .NET Framework 4.8 or newer. This software is not included in the Tekla Model Sharing Cache server installation package.

  • An internet connection to download model data from the sharing service

  • Enough disk space to store the cached model data.

    The required disk space can vary from a few gigabytes to terabytes, depending on the number of Tekla Model Sharing users and the size of the models.

Make sure that your firewall allows inbound traffic on TCP/IP ports 9001 and 9998 for the cache service host. If the ports cause conflicts with other services, you can change the ports in the Tekla Model Sharing cache server installer.

Install the cache service for Tekla Model Sharing

Before you begin, download the Tekla Model Sharing cache server installation file from Tekla Downloads.
  1. Run the TeklaModelSharingCacheService.exe 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.

    • 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 data transfer.

  2. 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.

Modify settings for the cache service after installation

If needed, you can modify the settings for the cache service after installation, such as to change the previously set cache folder or port numbers.

To modify the settings, run the TeklaModelSharingCacheService.exe installation file again and select Repair.

  • If you change the previously set cache folder, copy any content that you want to continue using from the previous cache folder to the new folder.

  • If you change the port numbers, make sure that your firewall allows inbound traffic on the new ports.

Configure Tekla Structures client workstations to use the cache service

  1. In Tekla Structures, on the File menu, click Sharing > Sharing settings.
  2. Configure the Tekla Model Sharing cache settings in the Sharing settings dialog box:
    1. In the Name box, enter the name of the computer on which the cache is installed.

      To check the computer name in Windows, select Windows Control Panel > System and Security > System.

      If the computer on which the cache is installed has a static IP address, you can enter the IP address in the Name box instead of the computer name.

    2. In the Port box, enter the cache service port number that you set when you installed the cache service.

      The default value is 9998.

  3. Click Set.

Troubleshoot the cache service

Problem Possible solutions

Cannot connect to the cache service from Tekla Structures

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

  • Ensure that your firewalls allow inbound traffic on the TCP/IP ports configured for the cache service for Tekla Model Sharing. The default ports are 9001 and 9998.

Cache service does not start

Check the Application Log in the Windows Event Viewer for errors.

Set the Log On account for the Tekla Model Sharing cache Windows service

If the Tekla Model Sharing cache service needs to access some special resources, such as shared network drives, ensure that the Log On account for the cache Windows service has permissions to access those resources. The Log On account also needs to have reading and writing permissions for the C:\ProgramData\Tekla\ModelSharingCache folder.

By default, the Log On account for the cache Windows service is Local System Account. You might need to change the account if the Local System Account does not have access to these folders and resources.

We recommend that you use the same account for installing the cache service and as the Log On account for the cache Windows service.

  1. Right-click the cache Tekla Model Sharing cache Windows Service in the Services dialog box, then select Properties.
  2. On the Log On tab, select This Account, then enter the account name and password.
  3. Click OK.
Was this helpful?
Previous
Next