Home Portal

Skip to end of metadata
Go to start of metadata

Target audience: XTRF Platform's users









XTRF offers integration with XTM, a popular web-based CAT tool developed by XTM International.

Read Before You Start

  1. XTRF Vendors are matched to XTM Users (Linguists) by name.
    1. When user of given name does not exist in XTM, it is created at workflow start.
    2. Once vendor is found (or just created), in order to be automatically assigned to step in XTM, a couple of things must match:
      1. Name of vendor's workflow step in XTRF must match workflow step name defined in XTM.
        • We strongly advise for the use of the default system names for steps in XTM.
        • Note that automatic assignment for custom step names will only happen if a step was already manually assigned to a vendor in XTM.
      2. XTM user must be assigned a proper role (Linguist) and must be configured as assignable for the step.
      3. Language combination needed for given task must be assigned to XTM user.
    3. Problems will occur when user existed in XTM but was assignable for a different task.
    4. As XTRF adds users with language combinations needed for given task only, when new task has a different language combination, an existing user will not match it and, as a consequence, will not be assigned automatically. Unfortunately, it is not possible to add new language combinations (or roles) to existing users on-the-fly via the API--it can be done however in XTM's interface.
  2. All vendors need to be assigned for steps in XTRF before the integrated workflow is started.
  3. Work files for translation must either not be zipped, or if  zipped, the checkbox for unzipping on the XTRF side has to be checked.

Quote Creation

With XTRF, you can start managing an XTM project while the work is just being agreed upon in a quote. The integration works in the following way:

  1. Once the quote is created in XTRF, a related project is created in XTM.
  2. XTM assigns the ID to the project, which is then transferred to XTRF as a quote name.
  3. When the CAT receivables for the project are created in XTRF, XTM analyses them using its own terminology and TM files.
  4. The results of analysis are exported to XTRF.
  5. If the customer accepts the quote, it is converted to a project in XTRF.

Project Creation and Management

Once a project is created, the integration works the following way:

  1. XTM assigns the ID to the project, which is then transferred to XTRF as project name.
  2. XTRF notifies the vendors via email about the availability of the files on the XTM server.
  3. The vendors work on their files in XTM, and once they have finished, they upload their files back to the XTM server. 
  4. The translated files are uploaded to XTRF by XTM.
  5. The project is finished once the translated files are delivered to the customer. 

New projects can be created in XTM based on a quote in XTRF or directly from a project in XTRF. The quote name and project name in XTRF are always the same as the project ID in XTM.

Job Statuses

This is applicable for XTRF v2015 Winter (3.5) and newer and XTM 8.7 and newer.

When in XTRF a job's status is changed to "Ready", in XTM it will be closed, too, but only is one of the following conditions is met:

  • the following job is set as "fully blocking" or "partially blocking" or
  • it's the last job before project finalization.

In either case, all preceding jobs will also closed if they haven't been closed earlier.

Reverting a job's status in XTRF reopens it also in XTM.

Cancelling or deleting a job in XTRF doesn't affect the job in XTM.

XTM Project Templates

It is possible to attach an XTM project template to an XTRF workflow.

Some settings of the XTM project template (e.g. language combinations) will be overridden by XTRF task and workflow settings.

Management of Translation Memory and Terminology Files Assigned to a Client

With XTRF, you can only access and manage the translation memory (TM) and terminology files related to a specific client. Any other types of TM and terminology files are not available. 

XTRF imports the information about TM and terminology files from XTM, but if the customer does not have any TM or terminology files in XTM, you can create such files in XTRF and they will be transferred to XTM.

 The management and assignment of TM and terminology files to a specific type is only possible in XTM.


This is applicable for XTRF v2014 Autumn (3.4) and newer.

The integration supports XTM's LQA (Linguistic Quality Check) workflow step. (Note that LQA as a parameter of another workflow step is not supported.)

LQA Scorecard

This is applicable for XTRF v2014 Autumn (build 3.4.13) and newer.

The integration allows for generating LQA scorecard (report) files.

CAT Analyses

This is applicable for XTRF v2014 Autumn (3.4) and newer.

If "Create CAT Receivable" and/or "Create CAT Payables" options are turned on, during the project creation a CAT analysis file will be downloaded from XTM and stored in the Log File folder.

The analysis will be created in XLS format and the filename will be: YYYY-MM-DD_projectXXXXX_Metrics.xls where YYYY-MM-DD is the date and XXXXX is the project ID.

For the list of supported formats of CAT analyses generated by XTM that can be imported into XTRF regardless of the integration, see CAT Analysis Import.

Supported Document Formats

For the complete list of supported document formats, please see XTM's website.

Supported Languages

For the complete list of supported languages, please see Languages Supported by XTM.

XTM Documentation

See: http://xtm-intl.com/resources/documentation



  • No labels