Skip to main content

Rigi Documentation

Rigi TMS Connector for XTM

Important

Rigi TMS Connector for XTM is a Beta product.

Important

To use the TMS Connector, you must have an XTM user account with API access rights. For details, see the XTM Cloud documentation.

Rigi TMS Connector links a Rigi project with an XTM Cloud project. It allows you to update the XTM Cloud project with new or edited resource files automatically every time the content of the source text changes and the string list in Rigi is updated.

This solution is especially useful for continuous projects.

We recommend using the Rigi CLI tool to update your Rigi project with new strings. For details, see the Rigi CLI tool section.

To link a Rigi project with an XTM Cloud project using the Rigi TMS Connector, perform the following steps:

  1. In XTM Cloud, perform the following steps:

    1. Create a new project with the following settings (for details about project creation, see the XTM Cloud documentation):

      • A source language.

        The source language in an XTM Cloud project does not have to match the source language in the linked Rigi project. When the TMS Connector imports the XLIFF file from Rigi to XTM Cloud, the source language selected in the XTM Cloud project will automatically be assigned to the texts. When the file is reimported to Rigi, the original source language from the Rigi project will be reassigned to the source strings.

      • The required target languages.

        You can also add target languages later.

      • In the Filter template dropdown, select Rigi.

        Rigi filter template

        If the Rigi template is not available in the XTM Cloud, please contact XTM Support and ask to set up this template on your account.

      Important

      Do not add any files for translation to an XTM Cloud project!

    2. Copy the newly created project's ID.

  2. On your Rigi server, perform the following steps:

    1. Open the project you want to link with an XTM Cloud project.

    2. In the project menu on the right, select Settings > TMS Connection.

      Rigi1.png

    3. From the Configure Translation Management System dropdown menu, select XTM Cloud. The XTM Connection Settings section will be displayed.

      Rigi2.png

      1. In the API URL field, enter the URL of your XTM Cloud instance, e.g., https://YOURINSTANCE.xtm.cloud/.

      2. Enter your Company Name.

      3. Enter the XTM Cloud instance credentials of a user with API access rights: Username and Password.

      4. Enter the XTM Cloud project ID you have copied in step 2.b.

    4. Click the Connect to XTM button. Additional sections will be displayed below.

    5. In the Synchronization Settings section, perform the following steps:

      Synchronization_settings.png

      1. Using the Automatic updates toggle, specify whether you want to update the linked XTM Cloud project automatically or manually.

      2. Select which strings should be sent to the XTM Cloud project: all strings or only the untranslated ones.

      3. Select when the translated strings are to be imported from the XTM Cloud project: after each workflow step is completed or when the whole workflow has been finished.

    6. In the Language Mapping section, review the mapping statuses:

      Rigi3.png

      Mapping statuses

      • The source language will get the Source status. This language pair cannot be edited.

      • If the TMS Connector has mapped a target language from the Rigi project to an XTM Cloud language, it will have the Auto Mapped status. You can change the XTM Cloud language by selecting another option from the XTM Language dropdown.

      • If the TMS Connector could not map a target language, its status will be Not Mapped. You can assign the correct XTM Cloud language by selecting it from the XTM Language dropdown.

      Manual language selection

      If you have selected the XTM Language manually, you will be asked to check and confirm the language changes in a popup after you click the Establish connection button.

      Rigi4.png

    7. Click the Save button. The status of the correctly mapped languages will change to Pending. At this point, mapping statuses are saved in the TMS Connector, but no files have been sent to the XTM Cloud yet.

    8. (Optional) To manually send strings to the linked XTM Cloud project, click the Send Strings to XTM button below.

Now, if you have switched on the Automatic updates toggle, each time the source strings in Rigi change, the TMS Connector will upload Rigi XLIFF files to the linked XTM Cloud project. In it, the regular translation process can then be started.

Important

After establishing the connection, the connector will automatically create a webhook from RIGI to the connector. This webhook will be visible in the webhook user interface in RIGI (for details, see Project settings – Webhooks). Please do not delete this webhook, as it is essential for seamless file integration.

After the connector uploads the Rigi XLIFF files to the XTM Cloud project, the status of the properly mapped languages will change to Established.

If files were sent to the XTM Cloud, but the mapping is not saved for some reason, the mapping status will be Desynchronized.

If you change the established mapping of a language pair, its mapping status will be Modified.

After the workflow for a specific language combination is completed in XTM Cloud, the updated XLIFF file for this combination will be uploaded back to the Rigi project.

Delete the connection

To delete the established connection and all the related settings, click the Delete button in the Danger zone section at the bottom of the TMS Connection display. This action cannot be undone.

Rigi_delete.png

In this section: