Use XS_FIRM and XS_PROJECT folders with Tekla Model Sharing

Added May 4, 2021 by Tekla User Assistance tekla.documentation@trimble.com

Software version: 
2021

Use XS_FIRM and XS_PROJECT folders with Tekla Model Sharing

Use XS_FIRM and XS_PROJECT folders with Tekla Model Sharing

Using project folders and firm folders in shared models is the easiest when you use a sub-folder in a Trimble Connect(1) application for information sharing and collaboration for construction projects that is based on the Trimble Connect platform

(1) Reference models are used in Trimble Connect application instead of using import and export.

(1) Trimble Connect application includes web, desktop and mobile clients, and the Sync tool, for example.

(2) Trimble’s platform for microservices in the cloud

(2) Trimble Connect platform’s microservices include services for uploading, storing, processing, and managing or consuming data. These services are meant to provide common solutions required by multiple applications.

project as the project or firm folderfolder that is used for storing Tekla Structures-related files customized for a particular organization

A Tekla Structures user can, for example, customize a company’s cloning templates and save them in a sub-folder located under the firm folder. After this, the customized cloning templates can be used in all projects carried out for the company.

.

The project and firm folder information is only updated from the Trimble Connect project to local versions of the shared models, not vice versa. In practice, this means that Tekla Structures downloads new files from the project or film folder to the local model and updates any changed files. If a local file is not stored in the Trimble Connect project sub-folder, the file is removed from the local model.

When Tekla Structures detects a change between the local model data and the data in the Trimble Connect project or firm folder, you get the following notification:

If you click Yes, the model is saved and closed. Then, the local model data is updated and re-opened.

To set a folder in a Trimble Connect project as the XS_FIRM or the XS_PROJECT folder:

  1. On the File menu, go to Settings > Advanced options.
  2. Depending on the option, do one of the following:
    To set a Trimble Connect project sub-folder as Do this

    The XS_PROJECT folder

    1. In the Advanced Options dialog box, find the XS_PROJECT option.

    2. Set the value of XS_PROJECT to %CONNECT_FOLDER_SYNC%.

      %CONNECT_FOLDER_SYNC% points to :\Users\<user>\AppData\Local\Trimble\Tekla folder sync\<folder>

      Note:

      If you use the same Trimble Connect project as the XS_PROJECT folder and for collaboration, you need to use a sub-folder that is separated from the Trimble Connect collaboration information as the XS_PROJECT folder. In this case, the sub-folder is set to %CONNECT_FOLDER_SYNC%\<folder>\<sub-folder of the folder>.

      For example, you could save the project folder under the Project settings folder with the name Project. In this case, the value should be set to %CONNECT_FOLDER_SYNC%\Project Settings\Project. You can also user lower level sub-folders.

    The XS_FIRM folder

    1. In the Advanced Options dialog box, find the XS_FIRM option.

    2. Set the value of XS_FIRM to %CONNECT_FOLDER_SYNC%\<ProjectID><region>.

      Note that no separator is needed between the project ID and the region.

      You can see the project ID in Trimble Connect for Browser:

      The region is the same as the project server location setting. The options are:
      • asia

      • europe

      • northAmerica

      So, for example, the value could be %CONNECT_FOLDER_SYNC%\m1G-M21Ca_onorthAmerica.

      Note:

      If you use the same Trimble Connect project as the XS_FIRM folder and for collaboration, you need to use a sub-folder that is separated from the Trimble Connect collaboration information as the XS_FIRM folder. In this case, the sub-folder is set to %CONNECT_FOLDER_SYNC%\<ProjectID><region>\<folder>\<sub-folder of the folder>.

      For example, you could save the project folder under the Project settings folder with the name Project. In this case, the value should be set to %CONNECT_FOLDER_SYNC%\m1G-M21Ca_onorthAmerica\Project Settings\Project. You can also user lower level sub-folders.

  3. Click OK to save the project or firm folder.
  4. Close and re-open the model to take the new firm or project folderfolder that is used for storing Tekla Structures-related files customized for a particular project

    into use.

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