Trados Studio integration overview

Introduction

XTRF offers integration with client versions of Trados Studio, using a dedicated XTRF Agent for Trados Studio (Agen) application.


Pre-installation requirements

Before the integration can be enabled, you need to provide a server (it may be a dedicated server, VPS, or a cloud VM) with Windows, where the Trados Professional license is installed. 

The integration requires the connector agent (provided by XTRF) to be installed on the server where Trados Studio is installed. Your IT team or our support can do this. 

If you prefer that we set it up, we will need the following:

  1. Access to the server where the Trados Studio you would like to link XTRF to is installed. We can connect via Teamviewer or RDP - let us know which would be more convenient.

  2. The Agent uses port 8081 by default, so opening this port on any firewall is mandatory. The server where Trados is installed must also accept incoming connections from the server where XTRF is installed.

  3. To install the Agent, we will need an account with admin-level rights. Trados Studio must already be installed, and your team must provide a standalone desktop (not floating) license.

  4. The integration creates default folders for Trados projects and resources. Typically, these are located in C:\Projects and C:\Resources.
    Mapped network drives are supported in some cases (may depend on a particular setup) but are not recommended. Dropbox and other cloud locations are not supported.

  5. It is recommended that you have at least one dedicated license for the integration and a separate one to work with; this will prevent you from having performance issues.

If you want to perform the installation yourself, you can find a general description of the necessary setup in the Trados Studio integration setup article.

Once the Agent is installed, we will connect XTRF to it and create the necessary workflows.

Compatibility

XTRF Platform version

XTRF Agent version

Trados Studio version

XTRF Platform version

XTRF Agent version

Trados Studio version

10.1+

7.4.1.1

 

2022

XTRF Software

Both XTRF SaaS and on-premises installation may be used.

The Trados Studio integration works as all the other CAT-tool integrations. There is no need to manually manage file-based resources in XTRF (TMs, dictionaries) as this functionality is completely moved to the server where Trados Studio is installed.

Legal Notice

XTRF will oblige its clients to possess the number of licenses of any software integrated with XTRF in the amount and versions conforming to the technology partner licensing rules.


Integration architecture

The current XTRF Platform - Trados Studio integration simplifies the overall integration architecture.

Trados Studio

An instance of Trados Studio is installed on a client's dedicated machine. The machine may be installed at the client's location or hosted virtually everywhere as long as it is accessible via HTTPS. The client must provide all the required licenses, including MS Windows and (multiple) Trados Studio licenses. Only one Trados Studio copy is installed on the machine, requiring only one Trados Studio license to run. To benefit from concurrent processing, clients are obligated to buy multiple licenses. The number of concurrent Trados processes is limited by the number of licenses owned by the client.

Trados provides API for:

  • project creation

  • translation package creation

  • translation package import

  • project finalization (TM updates, file conversion back to original formats)

According to the API documentation, running multiple concurrent processes using API is possible.

Please note that it is not recommended to work on different threads with multiple projects simultaneously. Suppose you want to create an application that, for example, creates projects simultaneously. In that case, we recommend doing this in separate processes rather than in separate threads within the same process.

See also: Trados API documentation.

XTRF Agent for Trados Studio

XTRF Agent for Trados Studio is a proxy exposing functionality for remote users via WebServices. The exposed functionality includes:

  • TM management - create/update/delete/list TMs stored on a local file system.

  • Dictionary management- create/update/delete/list Dictionaries stored on a local file system.

  • Project source/target files upload and download.

  • Trados project creation: the Agent creates a Studio project (including source files, TMs, Dictionaries, etc.) using Trados API.

  • Trados project details access: the Agent enables access to some Studio project data (e.g., cat analysis) using Trados API.

  • Trados translator package preparation: the Agent prepares packages for translators using Trados API.

  • Trados translator package import: the Agent imports translated packages to the original project using Trados API.

  • Trados project finalization: The Agent generates translated documents in the original formats and updates resources (TMs, dictionaries) using the Trados API.

Internal Agent implementation uses a request queue. All Trados API calls are enqueued and executed as a separate process that uses Trados API. The number of concurrent processes is limited by the number of licenses declared as owned by the Client. The number of licenses allocated by the Client is set up in XTRF Agent configuration – XTRF has no technical means to validate this declaration.

All Agent functionality is exposed via an encrypted HTTPS connection and secured with a login and a password.

Backup policy

All TMs and dictionaries are stored on the machine hosting XTRF Agent and Trados Studio. A backup/archiving policy must be set up and implemented for this host and its extremely valuable resources.


Supported Trados Studio versions

The integration works with the Trados Studio 2022 version. Your Trados version needs to include access to SDK.

The Trados Studio 2019 and 2021 versions are no longer supported by RWS.

Smart projects cannot currently be synchronized with Trados.


Quote creation and management

New projects in Trados Studio can be created based on a Classic quote in XTRF or directly from a Classic project in XTRF.

Trados can be useful for quotes created in XTRF, as it can provide the CAT Receivables for the quoted work. Also, while the quote is created in XTRF, a related project is prepared in Trados Studio. The integration works the following way:

  1. First, you need to create a new quote in the XTRF Platform. While creating a quote, remember to create CAT Receivables using Trados Studio by clicking Add CAT Receivable Using External System. For the benefits of a future project, select your Trados workflow as the quote's workflow.

    1. Once the quote is created, a related project will be created in Trados Studio by XTRF.

    2. Trados will assign the project a new ID, which will be transferred to XTRF as a quote number.

    3. Source, Translation Memory, and Dictionary will be assigned to the project.

    4. XTRF will send the files to Trados Studio requesting the CAT Analysis.

    5. Trados will convert the files to their default format (.sdlxliff), perform the file analysis, and export the results to XTRF.

    6. The results of the CAT analysis will be displayed in XTRF.

  2. If the Client accepts the quote, click Convert into Project - a new project will appear on the project list. Follow the instructions below.

  3. If the Client rejects the quote, the project in Trados Studio will be closed.


Project Creation and Management

Whether you have created the project in XTRF from scratch or based on an existing quote, XTRF can be used to manage the whole project, even the parts processed in Trados Studio. The integration works the following way:

  1. If a new project is created from scratch, the Trados workflow must be selected, and CAT Receivables should be created using Trados Studio by clicking Add CAT Receivable Using External System - see the Create a Classic project guide for instructions.

  2. Once the project is created, a related project will be created in Trados Studio by XTRF.

  3. Trados Studio will assign the project a new ID, which will be transferred to XTRF.

  4. Source, Translation Memory, and Dictionary will be assigned to the project.

  5. XTRF will send the files to Trados Studio requesting the CAT Analysis.

  6. Trados Studio will convert the files to their default format (.sdlxliff), perform the file analysis, and export the results to XTRF.

  7. The results of the CAT analysis will be displayed in XTRF.

  8. Once the project is updated with the CAT analysis results and the vendors are chosen, XTRF will request from Trados Studio the packages with files that will be delivered to vendor(s).

  9. Once the packages (with the files converted to sdlxliff format) are created on the Trados Server, XTRF will download them.

  10. XTRF will request CAT analysis of the packages to create payables for the vendor(s).

  11. Trados will perform the analysis and pass the results to XTRF.

  12. XTRF will create payables for the vendor(s) and notify them about the availability of the files.

  13. Vendors will work on the files, and once they finish, they will upload the translated packages back to XTRF.

  14. XTRF will upload the translated packages to Trados Studio.

  15. Trados will integrate the packages, convert the sdlxliff files back to the client's format, and update the Trados Studio Translation Memory.

  16. XTRF will download the converted files.

  17. When the translated files are available for the client in XTRF, the project will be finished and closed in both Trados Studio and XTRF.

If you create a project based on a quote created using Trados Studio integration, the project in Trados Studio is already available, and the files are initially analyzed – no duplicate action will be made.

If your project includes not only translation but also other tasks, these tasks will be performed normally before the project is closed in both systems.


CAT Analyses

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

When there are different payables, there will be more than one CAT analysis file (vendors will work on different sets of files).

The analysis will be created in XML format with the filename trados_metrics.xml. If more files are created, they will be named trados_metrics (1).xml, trados_metrics (2).xml, etc.


Supported Files

For the list of supported file types, see the Trados documentation.


Workflow File Management specific settings

To make reference files and log files available for the vendors, place them in a separate bundle, and do NOT assign that bundle to the External Project Preparation, Prepare Packages, and External Project Finalization actions. The bundle should only be assigned (as read-only) to the jobs performed by the vendors. 

For more information, see the Reference Files assignment in Trados Studio integration article.


Supported Languages

For the list of supported languages, see the Trados documentation.


Trados Studio documentation

To learn more about Trados Studio, see the Trados Studio 2022 documentation.