XTM integration for classic projects

Overview

The XTM integration eases the management of classic XTRF projects that are meant to be handled in XTM. The quotes and projects you start in XTRF are automatically created in XTM, and the ready files are sent back to XTRF.

Compatibility

The latest version of XTRF supports the integration with the XTM International - XTM Cloud 13.1 version.

Languages supported by XTM

Abkhazian

ab

Afar

aa_ET

Afrikaans (South Africa)

af_ZA

Albanian

sq_AL

Amharic

am_ET

Arabic

ar_AA

Arabic (Egypt)

ar_EG

Arabic (Oman)

ar_OM

Arabic (United Arab Emirates)

ar_AE

Arabic (Bahrain)

ar_BH

Arabic (Algeria)

ar_DZ

Arabic (Western Sahara)

ar_EH

Arabic (Iraq) 

ar_IQ

Arabic (Jordan)

ar_JO

Arabic (Kuwait)

ar_KW

Arabic (Lebanon)

ar_LB

Arabic (Libya)

ar_LY

Arabic (Morocco) 

ar_MA

Arabic (Mauritania)

ar_MR

Arabic (Palestinian Territory)

ar_PS

Arabic (Qatar)

ar_QA

Arabic (Saudi Arabia)

ar_SA

Arabic (Sudan)

ar_SD

Arabic (Syria) 

ar_SY

Arabic (Chad) 

ar_TD

Arabic (Tunisia)

ar_TN

Arabic (Yemen)

ar_Ye

Armenian

hy_AM

Eastern Armenian

hy_AM_arevela

Western Armenian

hy_AM_arevmda

Assamese

as_IN

Asturian (Spain)

ast_ES

Aymara

ay_BO

Azeri (Cyrillic)

az_AZ_Cyrl

Azeri Latin

az_AZ_Latn

Bashkir

ba_RU

Basque

eu_ES

Bengali

bn_IN

Bengali (Bangladesh)

bn_BD  

Bhutani

bal_IR

Bihari

bh_IN

Bislama

bi_VU

Bosnian (Cyrillic)

bs_BA_Cyrl

Bosnian (Latin)

bs_BA_Latn

Breton

br_FR

Bulgarian

bg_BG

Burmese

my_MM

Byelorussian

be_BY

Carolinian

cal

Catalan

ca_AD

Catalan (Spain)

ca_ES

Cebuano (Philippines)

ceb

Chamorro

cha

Chichewa

ny_MW

Chinese, Simplified

zh_CN

Chinese, Singapore

zh_SG

Chinese, Traditional

zh_TW

Chinese, Hong Kong

zh_HK

Chuukese

chk

Corsican

co_FR

Croatian

hr_HR

Czech

cs_CZ

Danish

da_DK

Dari

prs_AF

Divehi

dv_IN

Dothraki

mis

Dutch

nl_NL

Dutch (Belgium) 

nl_BE  

English, US

en_US

English, UK

en_GB

English (Canada)

en_CA

English (Australia)

en_AU

English (South Africa)

en_ZA

English (Switzerland)

en_CH

English (Hong Kong)

en_HK

English (India)

en_IN

English (Singapore)

en_SG

English (United Arab Emirates)

en_AE

English (Asia) 

en_142

English (Germany)

en_DE

English (Holland)

en_NL

English (Ireland)

en_IE

English (New Zealand)

en_NZ

English (Austria)

en_AT

English (Neutral)

en_NT  

English (Cyprus)

en_CY

Esperanto

eo

Estonian

et_EE

Ewe (Ghana)

ee_GH  

Faroese (Faroe Islands)

fo_FO

Fijian

fj_FJ

Filipino

fil_PH

Finnish

fi_FI

Flemish

nl_BE

French

fr_FR

French, Canada

fr_CA

French, Switzerland

fr_CH

French, Belgium

fr_BE

French, Luxembourg

fr_LU

French, Morocco

fr_MA

Frisian

fy

Fula

fu

Galician (Spain)

gl_ES

Georgian

ka_GE

German

de_DE

German, Austria

de_AT

German, Belgium

de_BE  

German, Holland

de_NL  

German, Luxembourg

de_LU 

German, Switzerland

de_CH

Greenlandic

kl_GL

Greek

el_GR

Ancient Greek

grc_GR

Guarani

grn

Gujarati

gu_IN

Haitian Creole

ht_HT

Hausa

ha_NG

Hawaiian

haw

Hebrew

he_IL

Hiligaynon

hil

Hindi

hi_IN

Hmong

hmn

Hmong (USA)

hmn_US

Hungarian

hu_HU

Icelandic

is_IS

Igbo

ig

Ilocano

ilo

Indonesian

id_ID

Interlingua

ia

Interlingue

ie

Inuktitut

iu

Inupiak

ik

Irish (Ireland)

ga_IE

Italian

it_IT

Italian (Switzerland)

it_CH

Iu Mien 

ium

Japanese

ja_JP

Javanese

jv_ID

Kannada (India)

kn_IN

Karen

kar

Kashmiri

ks

Kazakh

kk_KZ

Khmer

km_KH

Kikongo (Congo)

kg_CG

Kinyarwanda

rw_RW

Kirghiz

ky

Kirundi

rn

Kiswahili (Africa)

sw_KE

Klingon

tlh

Konkani (India)

kok_IN

Korean

ko_KR

Kosraean

kos

Kurdish (Turkey)

ku_TR

Kurdish (Kurmanji) 

kmr  

Kurdish (Sorani)

ckb  

Kurdish (Iraq) 

ku_IQ  

Laothian

lo_LA

Latin

la

Latvian

lv_LV

Lingala

ln_CG

Lithuanian

lt_LT

Luxembourgish 

lb_LU  

Macedonian

mk_MK

Malagasy (Madagascar)

mg_MG

Malay (Malysia)

ms_MY

Malayalam (India)

ml_IN

Maltese

mt_MT

Maori

mi_NZ

Marathi

mr_IN

Marshallese

mah

Mongolian

mn_MN

Montenegrin

sla_ME

Moldavian

mo_MD

Morisyen (Mauritian Créole)

mfe_MU

Nauru

na_NR

Navajo

nv

Ndebele

nd_ZW

Nepali

ne_NP

Norwegian

no_NO

Norwegian Bokmaal (Norway)

nb_NO

Norwegian Nynorsk (Norway)

nn_NO

Northern Sotho (South Africa)

nso_ZA

Occitan

oc_FR

Oriya

or_IN

Oromo

om_ET

Ottoman Turkish

ota

Palauan

pau

Pashto

ps

Persian

fa_IR

Pohnpeian

pon

Polish

pl_PL

Portuguese

pt_PT

Portuguese (Angola)

pa_AO

Portuguese (Mozambique)

pt_MZ

Portuguese, Brazil

pt_BR

Punjabi

pa_PA

Punjabi (India)   

pa_IN

Punjabi (Pakistan)

pa_PK

Quechua

qu_PE

Quenya

qya

Rhaeto-Romance

rm_CH

Romanian

ro_RO

Russian

ru_RU

Samoan

sm_WS

Sangro

sg

Sanskrit

sa_IN

Sardinian

sc_IT

Scottish Gaelic (Scotland)

gd_GB

Sesotho

st

Setswana (Africa)

tn_ZA

Serbian

sr_YU

Serbian (Cyrillic)   

sr_RS_Cyrl

Serbian (Latin)

sr_SR_Latn

Serbian ‐ Montenegro (Cyrillic) 

sr_ME_Cyrl

Serbian ‐ Montenegro (Latin)

sr_ME_Latn

Shona

sn

Sindarin

sjn  

Sindhi

sd_PK

Singhalese

si_LK

Siswati

ss

Slovak

sk_SK

Slovenian

sl_SI

Somali

so_SO

Sorbian (Lower)

dsb_DE

Sorbian (Upper)

hsb_DE

Spanish

es_ES

Spanish (Argentina)

es_AR

Spanish (Bolivia)

es_BO

Spanish (Chile)

es_CL

Spanish (Colombia)

es_CO

Spanish (Costa Rica)

es_CR

Spanish (Cuba)

es_CU

Spanish (Dominican Republic)

es_DO

Spanish (Ecuador)

es_EC

Spanish (El Salvador)

es_SV

Spanish (Guatemala)

es_GT

Spanish (Honduras)

es_HN

Spanish (International) 

es_001

Spanish (Latin America)

es_419

Spanish (Mexico)

es_MX

Spanish (Neutral) 

es_NT 

Spanish (Nicaragua)

es_NI

Spanish (Panama)

es_PA

Spanish (Paraguay)

es_PY

Spanish (Peru)

es_PE

Spanish (Puerto Rico)

es_PR

Spanish (Uruguay)

es_UY

Spanish (USA)

es_US

Spanish (Venezuela)

es_VE

Swahili (Uganda) 

sw_UG

Swahili (Somalia)

sw_SO

Swahili (Tanzania)

sw_TZ

Swedish

sv_SE

Sudanese Arabic

apd_SD

Sudanese Arabic (Latin)

apd_SD_Latn

Sundanese 

sun

Syriac

syr_TR

Tagalog

tl_PH

Tajik

tg_TJ

Tamil

ta_IN

Tatar

tt_RU

Telugu

te_IN

Tetum (Indonesia)

tet_ID

Tetum (Timor‐Leste)  

tet_TL

Thai

th_TH

Tibetan

bo

Tigrinya

ti

Tonga

to_TO

Tsonga

ts_ZA

Tswana

tn_BW

Turkish

tr_TR

Turkmen

tk_TM

Twi

tw

Ukrainian

uk_UA

Urdu

ur_IN

Urdu (Pakistan)

ur_PK

Uyghur (China)

ug_CN

Uzbek

uz

Uzbek (Afganistan)

uz_AF

Uzbek (Cyrillic)

uz_UZ_Cyrl

Uzbek (Latin)

uz_UZ_Latn

Welsh

cy_GB

Vietnamese

vi_VN

Volapk

vo

Wolof

wo

Xhosa (South Africa)

xh_ZA

Yapese

yap

Yiddish

yi

Yiddish (Israel)

yi_IL

Yiddish (USA) 

yi_US

Yoruba

yo_NG

Zulu (South Africa)

zu_ZA


How does the integration work? 

All the machine translation-related settings are configured solely on the XTM side per project template. To learn more about those settings, see the XTM documentation.

Matching

People

To create an XTRF project in XTM, the integration tries to match the client, vendor(s), and project manager with the corresponding entities in XTM.

  • For clients, the integration checks the data in the Partner Aliases (Client profile > Main data > System Accounts > username in external system). If there is no such data, the integration matches the XTRF Client ID or Name to the XTM Customer (name). If no match is found, a new customer is created in XTM.

  • For vendors, the integration checks the data in the Partner Aliases (Vendor profile > Main data > System Accounts > username in external system). If there is no such data, the integration matches the XTRF Vendor Name to the XTM User Name. If no match is found, a new user is created in XTM.

If the matched vendor has no required language pair assigned in XTM, they won’t be automatically assigned to the project in XTM.

If the integration can’t find a matching vendor in XTM, it creates a user with a Linguist role and the language pair required for the XTRF project. Any further changes to this user profile should be managed in XTM.

  • For project managers, the integration matches XTRF User Username to the XTM User Name. If no match is found, a new user is created in XTM.

Workflow

The name of the vendor's job in the XTRF workflow must match the workflow step name defined in XTM. We strongly advise using the default system names for steps in XTM.

  • If the work files for translation are compressed, the Unzip box must be checked in the Upload file pop-up window in XTRF.

Quote creation

With XTRF, you can start managing an XTM project while the work is just being agreed upon in a quote. 

  • Once the quote is created in XTRF, a related project is created in XTM.

  • XTM assigns an ID to the new project. This ID is transferred to XTRF as a quote name.

  • CAT receivables in XTRF are created based on XTM analyses.

  • The results of the analysis are exported to XTRF.

  • If the customer accepts the quote, it is converted to a project in XTRF.

Project creation and management

Once a project is created:

  1. XTM assigns the ID to the project, which is then transferred to XTRF as the project name.

  2. XTRF notifies the vendors via email about the availability of the files on the XTM server.

  3. The vendors work in XTM. 

  4. After the vendors have finished their work, the translated files are uploaded to XTRF by XTM.

  5. The project is finished once the translated files are delivered to the client. 

Job statuses

The change of the job’s status to Ready  in XTRF will close the corresponding step in XTM if one of the following conditions is met:

  • It is the last job before project finalization.

  • The following job has a fully blocking or partially blocking parameter.

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

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

Canceling or deleting a job in XTRF doesn't affect the corresponding step in XTM.

XTM project templates

It is possible to attach an XTM project template to an XTRF workflow (see the XTM integration setup - CAT Tools tab article).  Some settings of an 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

In 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. If the customer does not have any TM or terminology files in XTM, XTRF can create those resources in XTM.

LQA

The integration supports XTM's LQA (Linguistic Quality Check) workflow step. The integration allows for generating LQA scorecard (report) files.

CAT analyses

If Create CAT Receivable and/or Create CAT Payables options are turned on (see the XTM integration setup - Advanced settings subtab article), a CAT analysis file will be downloaded from XTM during the project creation. It will be 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.

To learn more about the supported formats of CAT analyses generated by XTM that can be imported into XTRF regardless of the integration, see the CAT tools | CAT tool analysis files article.


How to use the integration

To start the automatic synchronization of your XTRF project with XTM, you need to:

  1. Create a classic project in XTRF.

  2. Choose one of the workflows created for integration purposes or set up a new workflow with steps and settings required for the integration (see the XTM integration setup - Configure the workflow article).

  3. Set the dates, assign the vendors, and provide other essential details. To learn more about projects, see the Create a Classic project guide. 

  4. Start the workflow. That will trigger the synchronization, and the new project will appear on your XTM instance. 

  5. When the project is finished in XTM, the ready files will appear in the Output Files directory in your XTRF project.

Subcontracting

If your vendor is an LSP with their own XTM instance, you can profit from the subcontracting through integration. It will allow you to keep all the records in XTRF while the work is conducted in XTM.

To use the subcontracting scenario, an LSP user has to be created in your XTM instance and connected with the subcontractor’s instance. To learn more about those settings, see the XTM’s Enable Subcontracting guide. 

Next, create a project in XTRF, as described in the previous section. Assign your subcontracting vendor to one or more jobs. 

When you start the workflow, a new project appears not only on your XTM instance but also on the XTM instance of your subcontractor. 

After your subcontractor finishes the work on their side, the ready files will appear on your XTM and XTRF instances. 

Access files in XTM from the workflow

You can access files in XTM directly from the workflow to preview and download the ready files before sending them to the client.

  1. Open an XTM-integrated project.

  2. In the Project menu on the left, select a task in question.

  3. Go to the CAT Tools tab.

     

  4. In the External Project ID section, click the Preview Files button. A Preview Files pop-up window will appear.

     

    1. From the Workflow Job File drop-down list, select the desired file.

    2. From the Preview Type drop-down list, select the desired preview format.

    3. Click the Export button. The selected files will be accessible in the Workflow Graph tab > Workflow Directories section > Preview folder.


Field mapping

Client

XTRF

XTM

Name

Customer

If the integration can’t match an XTRF client to an XTM customer, it creates a new customer in XTM. No details except the client’s name are transferred to XTM. 

Vendors

XTRF vendors are mapped to XTM users with the Linguist role.

XTRF

XTM

Name

Username

Name

First name

Legal Name

Last name

E-mail Address

Email

Project Managers

XTRF users are mapped to XTM users with the Project Manager role.

XTRF

XTM

Name (= Username)

Username

First Name

First name

Last Name

Last name

E-mail Address

Email

If the integration can’t match an XTRF user to an XTM user, it creates a new Project Manager user in XTM. 

Workflow jobs

XTRF

XTM

Workflow Job, Name

Workflow Step, Step name

CAT analyses

XML/XLF Format

Only words are matched.

XTM Type

XTM Category

XTRF

TotalWordCount

 

Total

AlphanumericOnlyTextUnitWordCount

 

No match

MeasurementOnlyTextUnitWordCount

 

No match

NumericOnlyTextUnitWordCount

 

No match

PunctuationOnlyTextUnitWordCount

 

No match

ExactMatchedWordCount

 

X translated

LeveragedMatchedWordCount

 

100%

RepetitionMatchedWordCount

 

Repetitions

RepetitionMatchedWordCount

95-99

95-99%

RepetitionMatchedWordCount

85-94

85-94%

RepetitionMatchedWordCount

75-84

75-84%

FuzzyMatchedWordCount

95-99

95-99%

FuzzyMatchedWordCount

85-94

85-94%

FuzzyMatchedWordCount

75-84

75-84%

x-RealWordCount

 

No match

XLS Format

Words and characters are matched.

XTM

XTRF

Leveraged match

100%

95-99 Fuzzy match

95-99%

85-94 Fuzzy match

85-94%

75-84 Fuzzy match

75-84%

Repeat

Repetitions

95-99 Fuzzy repeat

95-99%

85-94 Fuzzy repeat

85-94%

75-84 Fuzzy repeat

75-84%

No matching

No match

To learn more about managing projects in XTM, see the XTM Documentation