Skip to main content

XTM Cloud 25.2

Custom preview in XTM Workbench

If you want to use an in-context preview of a file, but its extension is not supported by XTM Workbench Visual mode (for details, see Visual mode in XTM Workbench), you can use the Custom preview feature. With it, Project Managers and Linguists can generate a preview for any file type supported by XTM Cloud (for details, see File formats supported in XTM Cloud). However, certain prerequisites must be met. For details, see below.

If all prerequisites have been met and the Custom preview feature has been activated in your XTM Cloud instance, Project Managers and Linguists can:

Prerequisites

As an XTM Cloud Administrator, you must ensure that these conditions are met so that Project Managers and Linguists can use the Custom preview feature, in your XTM Cloud instance:

  • You must have access to an external service that will generate an HTML preview of source and target files and return them to the relevant endpoint.

  • Activate REST API connection in your XTM Cloud instance.

  • Contact XTM Support and provide the details for the endpoint you want to use in this case. XTM Cloud will use it to send two requests to the external service mentioned above. In response, XTM Cloud expects to obtain the generated source and target HTML preview files from the external service. Both requests contain REST API parameters that are required to download the source and target files, which will be used to generate HTML previews.

    To request support

    Visit our Support Portal.

    Example of an endpoint: http://address.com.

    • To obtain an HTML preview for the source file, XTM Cloud sends a REST API request containing these parameters:

      • xtmProjectId (String): the XTM Cloud project ID.

      • jobId (String): the job ID.

      • sourceLanguageName (String): the source language code.

      • filename (String): the name of the file.

    • To obtain an HTML preview for the target file, XTM Cloud sends a REST API request containing these parameters:

      • xtmProjectId (String): the XTM Cloud project ID.

      • jobId (String): the job ID.

      • targetLanguageName (String): the target language code.

      • filename (String): the name of the file.

      • fileId (String): the target file ID.

        Note

        XTM Cloud generates a target file that reflects the current translation progress. It also assigns a fileId which an external system can use to download that file, using the XTM API.

In this section: