Implementation guide for administrators
Tekla Structures administrator is the person responsible for ensuring that the company standards are used and set up in Tekla Structures. The following sections explain how you can customize Tekla Structures.
Customizing Tekla Structures
Each new version of Tekla Structures introduces new features and functionalities to improve the overall process used for completing a project. Tekla Structures has multiple environments to suit the needs and requirements of specific markets. Many features are localized in each Tekla Structures version. Most of the changes in versions are focused on making the default saved attributes more consistent, organized, simplified, and practical.
Your local technical team is dedicated to improving your knowledge and experience of each new version. The team aims at enhancing your user experience of Tekla Structures by performing tasks that have been identified as essential by the existing users, new users, and potential users.
Before you start customizing Tekla Structures to suit the needs of your company and your projects, collect the needed information, such as drawing standards, used profiles, grades and materials, company logos, and naming conventions.
The overall localization of Tekla Structures can be divided into four different layers:
- Tekla Structures environment
- Company-level settings
- Project-level settings
- Multi-user settings
The three last ones are mainly managed by company administrators.
Setting up the standard that a company uses, and the standards that a specific project needs will make the designing process much more efficient because the end user can concentrate on the design process.
Tekla Warehouse has a lot of additional content, such as application tools and environment content. You can download Tekla Warehouse offline content that includes the catalog content of environments, such as profiles, bolts, materials, and reinforcement.
The offline catalog content is under Tekla Structures collections in Tekla Warehouse. The content is in .tsep packages that are installed when opening Tekla Structures.
You can also create a local collection for your company, and share it for your organization in your internal network. You can manage the access rights on the folder and collection level in the collections.json file on each user's computer. Copy the file to the same location on each user's computer. The file is located in C:\Users\Public\Public Documents\Trimble\Tekla Warehouse\collections.json.
The image below shows an example of the collection paths with four Tekla Structures collections:
In Tekla Warehouse the collections are found after mapping under .
Overview of environments, roles and licenses
Tekla Structures is one product that has many different configurations. The licenses you have determine which configurations you can use.
A Tekla Structures environment is set up for the materials, grades, profiles, drawing settings, component settings, .ini file settings that are used in a specific market. There are over 30 different environments in Tekla Structures. By choosing a specific environment when starting Tekla Structures you will get the settings for that market. You can install several environments, and add missing environments later.
The blank project listed in the environments is an empty platform for your own environment or project settings. It includes standard parametric profiles, undefined bolt, material and rebar grades, basic drawing layouts and so on, which you can complement from your own firm or project folders and Tekla Warehouse.
Some environments give you the opportunity to select a role when logging in. The role is independent from the licenses that are used. The purpose of the roles is to make the user interface and settings clearer, easier and faster for the user's tasks.
In practice, this means that settings, filters, reports and the user interface is set up for the role the user has. For example, preloaded settings in object properties that are not relevant for the role are not shown, making the list of options shorter and clearer.
Role selection is primarily meant to be configured by Trimble and reseller localization personnel, and be part of the Tekla Structures installation package. However, advanced users and Tekla Structures system administrators can also create their own roles inside their company organization. Additional content is available in the Tekla Warehouse offline and online collections. Note that you need to have a Trimble Identity for downloading or installing from the online collections. For more information, see Trimble Identity for Tekla Online services.
Using roles for ribbon selection with the subscription license configurations
Note that the ribbon selection with the subscription license configurations is primarily meant to be configured by Trimble and reseller localization personnel.
With the subscription licenses, roles can be
used for controlling which ribbon is shown for a certain role. The role-specific
.ini files in the environments, for example, role_Steel_Detailer.ini or role_Rebar_Detailer.ini, contain advanced options
XS_RIBBON_CONFIGURATION_CARBON. The advanced options define the
ribbons for the specific role.
The advanced options need to point the configuration identifiers of the ribbon files, either to the configuration identifiers of the legacy on-premises license configurations, or to the configuration identifiers of the online license configurations. It is not possible to make up new configuration identifiers.
If the advanced options are not set, Tekla Structures uses the default ribbons for each subscription license configuration.
For the users who select the Precast Concrete Detailing role, you could have the following settings in the role_Precast_Detailer.ini file:
For more examples, see your role_<role>.ini files used in your environment.
Administrators who have own environment and roles in use: for the own role, such as, for timber detailer, you can create a folder for the ribbon files in ..\<environment>\Timber\Detailing\Ribbons, for example. Place the customized ribbon files in the folder, and include the folder in the XS_SYSTEM path definition for that specific role.
Tekla Structures software and environments are separated into different locations due to the requirements for Windows certification. By default, the files are installed in the following folders:
Software is installed under the \Program Files\Tekla Structures folder.
Environments and extensions are installed under the \ProgramData\Trimble\Tekla Structures folder.
User settings are installed under the \Users\<username>\AppData\Local\Trimble\Tekla Structures folder.
Project and firm folders
Project and firm folders are meant for storing the customized files. For any company, we strongly recommend setting up firm and/or project folders on a shared file server accessible to all users. If multiple teams on different sites are working on the same project, you can set up a project or firm folder in a folder in a Trimble Connect project.
Having the hierarchy of project and firm folders will make it much easier to update company settings, ensure that everyone uses the same settings in a project, and upgrade to a newer version of Tekla Structures.
All the settings that are used on the company level (for example, company logo and drawing standards) should be stored in a firm folder, and all the settings used on a specific project should be stored in the corresponding project folder. Property files are always saved in the \attributes folder under the current model folder, like, \TeklaStructuresModels\<my_building>\attributes. These files should then be copied to the project or firm folder, or to user-defined sub-folders under the project or firm folder.
To use the saved settings in a firm
and a project folder, set the path to the folder by using the
XS_FIRM advanced options. These advanced options should be put in the
initialization, .ini, files. You can have
several different .ini files. You can define in
the Tekla Structures shortcut which .ini files to run and which
settings to apply.
One of the most important advantages of using firm and project folders is that Tekla Structures does not replace files in the project and firm folders when you install a new version. This means that you retain your customized files without having to cut and paste, or export and import from previous versions. This makes upgrading to a newer version of Tekla Structures easier. When you store files in one place, it is also easier to update the settings and ensure that everyone in a project uses the same settings.
In the current project,
123_project_ABC, you have set up the properties for the concrete column, and
saved them as column_ABC. To make these saved settings available for everyone
working in the 123_project_ABC project, copy
column_ABC.ccl from the \attributes folder under the model folder to the
\123_project_ABC project folder or on your file server, or to a
user-defined sub-folder under the \123_project_ABC project
folder. Ensure that everyone in the project has the correct path for the
advanced option in the .ini file.
Folder search order
When you open a model, Tekla Structures searches for the associated files in specific folders in a set order. It is important that you place the files in the correct folders. Once Tekla Structures finds the associated files, it stops searching. This means that the files that have the same name but are located lower down the search order are ignored.
The basic folder search order is the following:
Currently open model
You can specify more than one system folder,
and this way define specific settings for each role. Use the role options defined in
the env_<environment>.ini to point to the roles when
specifying the system folders in the XS_SYSTEM
advanced option. Enter the options pointing to the roles and separate them by
semicolons, for example:
There are some exceptions to this search order. The exceptions are listed in Folder search order.
Do not store customized files in the system folder. Tekla Structures replaces these files when you install a new version.
Initialization files (.ini) are used for launching Tekla Structures. They can contain many advanced options that you can use to configure Tekla Structures for different standards and your own style of working. Tekla Structures automatically creates the necessary .ini files during installation. The number of .ini files it creates depends on how many country-specific environments you choose to install.
Why are .ini files needed?
There are numerous settings to be made when Tekla Structures starts. Advanced options are used to determine the appearance and the behavior of Tekla Structures, for example, the language used, behavior of part marks on drawings, and the location of your model folder. Advanced options are set through the .ini files. The different .ini files and what they do, and how they are related to each other are described below.
Different types of .ini files
The default reading order of the .ini files is as shown in the image below:
Initializes the settings needed for Tekla Structures to run.
The teklastructures.ini file in the \bin folder starts Tekla Structures. We recommend that you do not make any changes to this file.
Sets the global default settings.
The env_<your_environment>.ini file is located in the \Environments subfolder and it contains all the environment-specific settings. These files are set by your area office or reseller.
Sets the environment-specific settings.
You can define specific settings for roles in your environment and store these settings in role-specific folders. Organizing the folder structure based on roles is useful for keeping the role content up to date. Note that the folder structure and content may vary depending on the environment.
In the env_<environment>.ini file, each role has an option where you can add the paths that point to the folders in which you have stored the role settings. For example,
XS_PRECAST(\Precast) each point to the folders that contain settings specific to that role. An example for steel role could be as follows:
XS_GENERALpoints to the \General folder that has content common for all roles and settings that are specific to modeling and drawings, for example.
When defining role settings in XS_SYSTEM, you use the role options defined in the env_<environment>.ini to point to the role-specific settings. Note that you do not need to add the folder paths in
XS_SYSTEMas they are defined in the env_<environment>.ini.
Sets the settings defined for a role.
The role_<role>.ini file is located in the \Environments subfolder and it contains the settings specific for a chosen role. For example, the role_Engineer.ini file in the \Environments\uk folder contains all the settings for the Engineering role in the UK environment.
Sets the settings specified by the user.
The user.ini file contains your personal settings. The advanced options in user.ini override those in other .ini files. For example, if you have set the same advanced option in an .ini file, in a file in the environments subfolder and the user.ini file, Tekla Structures uses the value in the user.ini file. The user.ini is located in the C:\Users\<user_name>\AppData\Local\Trimble\Tekla Structures\<version>\UserSettings folder.
Sets the settings specified for the company/project/model.
If there are several settings for the same advanced option, the later setting in the reading order overrules the previous one. This means that the settings in user.ini overrule the settings in env_global_default.ini, and the settings in user.in can be overruled by the settings in options.ini.
The lang_enu.ini is the initialization file for the English language settings. The file is located with the other installed languages in the \Tekla Structures\<version>\nt\bin folder.
We recommend that you make all your customizations in the options.ini file under the model folder, or in the user.ini file. This way the customizations are kept when you install the next version of Tekla Structures.
Setting advanced options in .ini files
Tekla Structures contains three kinds of advanced options: user-specific advanced options, system-specific advanced options, and model-specific advanced options.
Changing an advanced option value in .ini files located outside the model folder does
not affect the existing models. You can only update the advanced options in the
Advanced options dialog box or in the options.ini file located in the model folder, not
from an options.ini file located in folders
defined for the
XS_PROJECT advanced option. The .ini files are also read when you open an existing model, but
only new advanced options that do not exist in options_model.db or options_drawings.db are inserted, for example, such options that
are not yet in the Advanced Options dialog box, but have
been added in the software.
User-specific advanced options set your personal preferences, for example the appearance of the Tekla Structures window. Tekla Structures saves user-specific advanced option settings in the options_<your_username>.ini file, located in the C:\Users\<user_name>\AppData\Local\Trimble\Tekla Structures\<version>\UserSettings folder.
The options.ini file contains the settings for model-specific advanced options. It is located in the current model folder. To share your settings with other people, copy the options.ini file to the system, project or firm folder.
The system-specific advanced options are stored in all other .ini files.
Setting advanced options
There are two methods for setting advanced options:
- The advanced options are grouped in different categories according to their usage in the Advanced Options dialog box. To access the dialog box, click . See more in Advanced options reference.
- The .ini files are plain text files that can be edited with a text editor, for example Notepad. The settings will then be saved in the options.ini file under the model folder for the model that you have open. The settings can then easily be copy-pasted into another .ini file. See more in File storing options and advanced options.
We recommend that you only use one of these methods to set advanced options. The settings in the Advanced Options dialog box override those in the .ini files. Some advanced options need a Tekla Structures restart to activate the new setting.
To set an advanced option in the user.ini file:
- Locate the user.ini file in the C:\Users\<user_name>\AppData\Local\Trimble\Tekla Structures\<version>\UserSettings folder.
- Select and right-click the user.ini file in Windows Explorer and click Open with. You can open the file in any standard text editor.
- Check that the advanced option is set to the value you want. If it is, you can stop here.
- To change or add the advanced option, on a new
line, type set, add a space and the
name of the advanced option followed by its value in a single line.
Tekla Structures only reads lines in the initialization file that start with set, for example,
- Save the user.ini file.
To use the correct .ini files for a specific project, the easiest way is to create a shortcut for the project on the desktop. Shortcuts are used to start teklastructures.exe with the defined initializations.
- Make a copy of the default shortcut: In the Windows Start menu or Start screen, find Tekla Structures <version>, then right-click the Tekla Structures <version>.
- Select Copy from the pop-up menu.
- Paste the shortcut to your desktop.
- Select the shortcut and right-click.
- Select Properties from the pop-up menu.
- Modify the Target of the shortcut by adding the required project initializations to it.
For example, you can use the following parameters in shortcuts:
InitializationFile: Initialization file to be read during startup, for example: -i \\MyServer\MyProject\Project1.ini. You can repeat this parameter as many times as you need.
ModelToBeOpened: Full path to the model to be opened automatically.
/create:ModelToBeCreated: Full path to model to be created automatically.
.ini files tell where things can be found and in which order, depending on the folder structure that the company has set up. See more in Create start-up shortcuts with customized initializations.
Bypass the sign in dialog box
You can bypass the sign in dialog box by using creating a start-up shortcut that uses a customized Bypass.ini file.
For more information about creating shortcuts with customized initializations, see Create start-up shortcuts with customized initializations.
In a text editor, open an
existing Bypass.ini file.
You can find the Bypass.ini file for each environment in the %XSDATADIR%\Environments\<your environment> folder.
Set the following advanced options in the customized Bypass.ini file:
- XS_LICENSE_SERVER_HOST: the on-premises license server address. To use online licensing, set the value to https.
- XS_DEFAULT_LICENSE: the default license for a user role.
- XS_DEFAULT_ENVIRONMENT: the environment-specific .ini file, for example %XSDATADIR%\Environments\uk\env_UK.ini
- XS_DEFAULT_ROLE: the role-specific .ini file, for example %XSDATADIR%\Environments\uk\role_Engineer.ini
set XS_LICENSE_SERVER_HOST=https set XS_DEFAULT_LICENSE=DIAMOND set XS_DEFAULT_ENVIRONMENT=%XSDATADIR%\Environments\uk\env_UK.ini set XS_DEFAULT_ROLE=%XSDATADIR%\Environments\uk\role_Engineer.ini
- Save the modified Bypass.ini file.
- Right-click Tekla Structures <version> shortcut on your desktop, then select Copy.
- Paste the shortcut to your desktop.
- Right-click the new shortcut, then select Properties.
In the Target field, enter the path to teklastructures.exe, followed by the parameter
-I(capital i) , then the path to the Bypass.ini file.
If you have installed Tekla Structures in a path that contains spaces, use quotation marks (") around each path.
An example of the modified target:
"C:\Program Files\Tekla Structures\2022\bin\TeklaStructures.exe" -I "C:\ProgramData\Tekla Structures\2022\Environments\uk\Bypass.ini"
User-defined attributes are attributes set to an object in a model or a drawing. These user-defined attributes can be used for many purposes, such as in filters, drawings, reports, export, import, fabrication, erection, and revision handling.
You can create your own user-defined attributes that you need in your company, or for a specific project. The user-defined attributes can be numbers, text, lists, or dates. They can be set to be unique for an object or allowed to be copied; they can also be ignored by numbering or affect numbering.
The user-defined attributes are defined in objects.inp files. These files are located in different folders following the Tekla Structures folder setup, and they are merged together during startup. The objects.inp file reads the user-defined attributes in order from the folders listed below, starting from the model folder:
|Folder defined by advanced option
|Current model folder
XS_PROJECT (your defined project folder)
XS_FIRM (your defined firm folder)
XS_SYSTEM (your defined system folder)
XS_INP (your defined inp folder)
The files are merged so that if there are user-defined attributes in any of the files, they are displayed in the user interface. Tekla Structures merges the files so that duplicate attributes are removed. If Tekla Structures encounters the same attribute name in different objects.inp files, the attribute from the first read objects.inp file will be used.
If you need to have several objects.inp files in the same folder, you can use a suffix in the file name to use all the files. This enables having several objects_<suffix>.inp files in the same folder. The file name could be objects_precast.inp, for example.