How can a source file be processed and what are configuration levels?

Owned by Damian Rozmiarkowski (Unlicensed)
Last updated: Jul 12, 2024 by Damian Rozmiarkowski
3 min read

Introduction

This article explains how XTM Cloud processes files and common configuration requests. If you did not find the required solution for the case you have in mind, contact the XTM International Support team, and we will answer your questions and explain the reason for such behavior if the required result cannot be achieved.

What configuration can be defined for application to a source file?

A configuration is a set of rules that apply for the analysis of a project. Those rules can affect translation content (ITS rules), segmentation (SRX rules) and extraction of metadata from files.

See the elements of the source file for which configuration settings can be made::

  • Definition of which parts of the source file are to be translated, or not,

  • Change of segmentation,

  • Segment IDs,

  • Segment comments,

  • Custom columns,

  • Multilingual Excel based on language codes,

  • Multilingual Excel based on predefined columns.

IMPORTANT!

Note that segmentation/exclusion can be affected (and changed) by whether a particular type of formatting has been applied to the text:

link; bold; italic; underlined; strike-through; change of style used in text; subscript/superscript; color; background used for text …

… and other different modifications available for a specific file extension.

If you would like to change or in any way modify the way your source files are processed, you would need to create a suitable ticket for the XTM International Support team and provide all the necessary details for your request, as described in this article: How to request a new configuration or change to an existing one.

Configuration levels

In XTM there are four main levels of configuration:

Default configuration

This is a set of all rules for all configured file types. These rules apply for the entire server and all client accounts. If no configuration settings have been made at other levels, XTM Cloud will always go to look for analysis rules here.

Global level configuration

If set, those rules override the default configuration. They apply for all projects for all customers created for the selected client. Unless a separate configuration has been created for a specific customer or filter template, this kind of global level configuration takes effect.

Customer level configuration

These configurations are creates per customer, on the client’s server. They apply for projects created for this selected customer. Unless a separate configuration has been created for a filter template, this kind of customer level configuration takes effect. It also takes precedence over the global level configuration.

Filter template level configuration

Filter templates (also called "analysis templates") are used with projects and only modify the analysis rules for selected projects. Each filter template has a unique ID, assigned on the back-end, which among other things is used as the directory name for a template. It is the strongest level and takes precedence over the global-level configuration and customer-level configuration.

Keep in mind that access to a particular filter template can be restricted make it only available for a specific customer.

IMPORTANT!

Filter templates can sometimes be confused with project templates but they are completely different. The filter template has rules for the analysis of files and the project template stores predefined settings for creating a project and allocating linguists.

You can create and set up your own simple filter templates in the XTM Cloud UI! See How to create a filter template in the XTM UI and apply it to a project to see how to create and use filter templates in a project.

Good to know!

Every configuration requested can be set up at one of the three levels above. Setting configuration at a particular level means that it will override any corresponding configuration (e.g. for Excel files) with a lower number next to it.

Every configuration requested can be set up at one of the three levels above. Setting configuration at a particular level means that it will override any corresponding configuration (e.g. for Excel files) with a lower number next to it.

EXAMPLE

There is a configuration at a global level which excludes bold text from translation, but at filter template level it is defined to ensure the translation of bold text.

Now, if we were to use the filter template during project creation, or apply it in a project editor after it has been created (and reanalyze the project), this bold text would be extracted for translation.