XTM integration for Smart projects

XTM integration for Smart projects

Some of the described features were introduced in XTRF v. 10.4. Please upgrade to get the most from this integration.

XTM integration for Smart projects is not supported on multi-node setups.

Introduction

The XTRF – XTM Cloud integration for Smart projects works both ways:

  • XTM Cloud > XTRF: integrated projects from XTM Cloud are reflected in XTRF.

  • XTRF > XTM Cloud: integrated projects from XTRF are reflected in XTM Cloud.

Currently, there is no possibility of reconfiguring or disabling project synchronization from XTM Cloud to XTRF.

The XTM Cloud Integration for Smart projects is still being developed. We encourage you to test it and give us feedback so we can prioritize any critical needs and potentially adjust the strategic approach to further development.
To check the current limitations of the integration, see Known limitations for Smart XTM integration.


Enable the XTM Cloud integration for Smart projects

If you want to try the XTM Cloud Smart Project integration, please contact the XTRF Helpdesk. Our administrators will reach out to you with further instructions.

The Connector app does not currently have a graphical interface. All settings are hardcoded in the YAML file, so XTRF staff perform the installation and configuration.

Please prepare the following information:

  • XTRF instance URL.

  • XTRF User used for synchronization.

  • Token of the XTRF User.

  • XTM Cloud instance URL.

  • XTM Cloud Company Name.

  • XTM Cloud User ID used for synchronization.

  • Token of the XTM Cloud User.

  • (Optional) If you only want to set up the XTM Cloud > XTRF integration for a selected client, provide the ID of this XTM Cloud Client.

The XTRF user used for synchronization must belong to a group with rights to:

  • Clients – Browse.

  • System Values: Advanced.

  • Languages – Browse.

  • Projects – Display, Edit.

  • Services – Browse.

  • Notification send.


Architecture

The integration connects a single XTRF Platform with a single XTM Cloud instance through a Connector app hosted in Google Cloud. It handles all the communication between the two systems via their respective REST APIs.

Impact on XTRF visual interface

In XTM Cloud-integrated Smart projects, irrelevant elements or forbidden actions will be disabled or hidden.


Mapping and synchronizing project details

Data synchronization

When a project is created in XTRF, the following data is synchronized to XTM Cloud:

  • Project name.

  • Client name > Customer.
    If there are no customers with a matching name in XTM Cloud, the integration will automatically create a new XTM Cloud Customer.
    Customer mapping is performed each time a new project is created. If the client’s name changes in XTRF, a new XTM Cloud customer will be created automatically. The system does not take the name in the 'username in external system' field into account when mapping and synchronizing clients.

  • Client deadline > Delivery due date.

  • Specialization > Subject matter.

  • Workflow steps.

  • Language pairs.

The user whose ID was provided during the integration setup will be the PM of all XTM Cloud projects created by this integration.

After the project is created, the integration synchronizes the following data from XTM Cloud to XTRF:

When a project is created in XTM Cloud, the following data is synchronized to XTRF:

  • Project name.

  • Customer > Client name.
    The project will be created without a client if there is no matching client in XTRF.

  • Delivery due date > Client deadline.

  • Subject matter > Specialization.

  • Workflow steps.

  • Language pairs.

The project’s PM in XTRF will be assigned according to the Automatic People Assignments automation from the Configuration menu > Projects and Quotes > Automations (Smart). For details, see the https://help.xtm.cloud/xtrf/home-portal/configuration-menu/en/automatic-people-assignments.html.

After the project is created, the integration synchronizes the following data from XTRF to XTM Cloud:

Job statuses are synchronized both ways.

All the machine translation-related settings are configured solely on the XTM Cloud side per project template. For details, see the XTM Cloud documentation.


Language synchronization

  • Multiple language combinations within one XTRF project are reflected identically in XTM Cloud and vice versa.

  • Languages are mapped using the ISO 639-1 code.

  • After you select the language, it cannot be changed anymore.

  • You can add new target languages in XTRF. They will be reflected in a linked XTM Cloud project, and the appropriate bilingual documents and (optional) CAT analyses can be downloaded to XTRF.


Status synchronization

Once the project has been started in XTM, the integration will align the XTM Cloud Workflow Step statuses with the linked XTRF Jobs.

Synchronization works both ways. However, for projects created in XTM, the XTM Cloud Helpdesk must configure a global callback setting for a particular client (for details, see the XTM Cloud documentation). The integration will work without it, but actions on the XTM Cloud side will not be reflected in job statuses in XTRF.

For example, after completing a translation in XTM, a vendor must click I Finished the Job in the Vendor Portal to close it. With proper callback configuration in XTM, the job in XTRF will close automatically.

Direction

Cause and effect

XTRF-to-XTM

Integration can start the workflow in XTM Cloud.

XTRF job status Ready ⇒ XTM Cloud job moved to the next workflow step.

XTRF job reopened ⇒ No effect in XTM Cloud (going back to the previous workflow step is only possible from the XTM Cloud side).

XTM-to-XTRF

(with proper callback configuration in place)

Integration can start the process in XTRF.

XTM Cloud task started ⇒ XTRF job status Started.

XTM Cloud task finished ⇒ XTRF job status Ready.

The document returned to the previous XTM Cloud step ⇒ previous XTRF job reopened.


Vendor mapping

From XTRF to XTM Cloud

  • After you assign Vendors in XTRF, the integration looks for corresponding Linguists or LSP users in XTM Cloud using the vendor ID. If the integration can’t match a vendor by ID, it searches for a corresponding linguist by e-mail. If a matching linguist exists in XTM Cloud, the integration automatically adds their ID in XTRF for future reference.

Vendor IDs are set in the vendor profile > Main Data tab > System Accounts subtab > username in external system.

  • If no linguists can be matched to an XTRF vendor, the integration will create a new linguist user in XTM Cloud and assign them the necessary user details (required role, source and target languages, and workflow job). This new linguist will be mapped to an XTRF vendor by ID.

Every linguist created by the integration will have access to all customers in XTM Cloud.

Only regular linguist users can be created automatically. LSP users must be mapped by ID or e-mail.

  • If a matching linguist lacks the user details required for the current project, the integration will automatically assign those details to the matching linguist. Access rights to the project’s customer must be manually assigned in XTM Cloud.

To turn off the automatic linguist creation and user details assignments, perform the following steps:

  1. Go to the Configuration menu > Integration > CAT Tools.

  2. Open your XTM Cloud integration in edit mode.

  3. In the Settings section, uncheck the Update XTM vendors box.

From XTM Cloud to XTRF

For the correct vendor assignment, XTM Cloud linguists and LSPs should be mapped to XTRF vendors by ID beforehand.

You can import linguist and LSP assignments from XTM Cloud to XTRF by clicking the Synchronize now button in the Process card. The integration will then look for corresponding Vendors in XTRF using the vendor ID and assign them.

  • Vendor assignment works for both unsplit documents and bundles.

  • Linguists from XTM Cloud will only be assigned to XTRF jobs in status Open.

  • The integration cannot automatically assign vendors with multiple price profiles if none of the profiles is selected as the default one.

The integration does not create new vendors in XTRF. If an XTM Cloud linguist or LSP cannot be mapped to an XTRF vendor, no vendors will be assigned to the job.