Customize the Applications & components catalog

Tekla Structures
Tekla Structures

Customize the Applications & components catalog

You can modify the catalog definition settings of the Applications & components catalog using catalog definition files, and set up a group structure to suit the needs of your company. Always check the settings and the group structure when upgrading to a new Tekla Structures version.

Catalog definition files (ComponentCatalog.xml) can be located in folders pointed by XS_SYSTEM, XS_FIRM, XS_PROJECT, and in the model folder. If there are several catalog definition files, Tekla Structures combines the information in the files. For more information on the folder search order, see Folder search order.

When you create a group structure for the Applications & components catalog, define the highest level structure in a catalog definition file that is located in a folder pointed by XS_SYSTEM. To hide unnecessary parts of the group structure and catalog content from certain roles, edit the catalog definition files of these roles.

For general instructions on how to use the Applications & components catalog, see How to use the Applications & components catalog.

Edit the catalog

  1. Set the XS_COMPONENT_CATALOG_ALLOW_SYSTEM_EDIT advanced option to TRUE to edit the catalog definition files.
  2. In the Applications & components catalog, click Access advanced features > Catalog management > Edit mode, and select the catalog definition file that you want to edit.

    The list of files shows all the environment folders, the project and firm folders if defined, and the model folder. You can define the needed catalog definition file folder paths in XS_SYSTEM.

    If XS_COMPONENT_CATALOG_ALLOW_SYSTEM_EDIT is not set to TRUE, a small warning icon is shown next to the files in the XS_SYSTEM folder locations. The image shows warning icons next to the files that appear dimmed.

    The files that appear dimmed do not exist, but you can create the files by selecting them, and answering Yes in the Edit mode message box.

    You can remove an existing file by clicking the button next to the file.

  3. Select the file that you want to edit.

    The check mark in front of the folder name shows the file that is currently being edited.

  4. Create new groups and subgroups to organize the catalog content, right-click in the catalog and select New group....
  5. Move the content from Ungrouped items to the new groups, or to other predefined custom groups. To move an item to another group, right-click the item, select Add to group, and then select the target group.

    It is important to keep the Ungrouped items group empty, because all items downloaded from Tekla Warehouse are placed in that group. When you place an item to a predefined group, it is automatically removed from the ungrouped items.

    For instructions on how to collect content to a group and publish it as a catalog definition file, see Publish a group in the Applications & components catalog.

Maintain the catalog

To keep the Applications & components catalog structure and content clear and in order, keep the groups up to date and organized, and remove the unnecessary items from the catalog definition files.

  1. Click in the bottom-right corner in the Applications & components catalog to display the message log:

    If an item defined in a catalog definition file is removed from the Tekla Structures software, the removed item will be included in the Applications & components catalog error message log.

  2. If the log contains references to missing items, edit the relevant ComponentCatalog.xml file to remove the references manually.

    We recommend that you make a back-up copy of the file before you start editing.

  3. Test thoroughly that these changes do not create any further errors, or mess up the group structure in the Applications & components catalog. Check at least the Ungrouped items and Legacy catalog groups.
  4. Newly added items are placed in the Ungrouped items group. If there are new items in the group, move them to the appropriate predefined groups, and hide them from specific roles, if needed.
  5. Add suitable thumbnails to the items, if needed.
Was this helpful?