Gretyl's Portal

Heretto Help

Show Page Sections

XTM Integration

XTM is a third-party cloud Translation Management System (TMS) that Heretto is integrated with. An XTM package can contain only textual content and cannot include any media files, like screenshots. It is useful especially to those teams that do not want to manually send ZIP files for localization. Once you create an XTM package, you send it for localization directly from Heretto with a click of a button.
Supported Content Types
XTM packages support only textual content and cannot include any media files, like screenshots.
Tip: If you want to localize media files, you can use the Media Package. Reach out to your XTM representative for recommendations on how to manage media files in XTM. For more information, see Media Package.
Visual Editor
XTM provides a visual editor, which enables you to preview and view localized content in a similar layout to the final publication.

To set up the visual editor, XTM may ask you to provide an XSLT file to use for your preferred rendering of the content in the visual editor.

Send Content to XTM for Localization

Create an XTM package in Heretto CCMS and send it to XTM for localization directly from Heretto.

To localize content using XTM packages, you must have an XTM International account. Also, initial configuration is required. For more information, contact a Heretto Customer Success Manager.
Remember:

You must use DITA maps and not standalone DITA topics to localize content.

  1. In the Content Library, click the map you want to localize.
    On the right side of the screen, the Resource Drawer opens.
  2. Create a localization package by doing one of the following:
    OptionDescription

    Recommended: Create a localization package for a released map

    1. In the Resource Drawer, select Releases.

    2. In the Releases tab, go to the release you want to localize and click Localize.

    Create a localization package for a branched map

    1. In the Resource Drawer, select Branches. You will see a list of branches related to your map.

    2. In the Branches tab, switch to the branch that contains the map you want to localize.

    3. The Branches tab closes and you can see the Content Library in the branch you switched to.

    4. Click the map you want to localize and, in the Resource Drawer, select the Jobs tab.

    Create a localization package for a standard map

    In the Resource Drawer, select the Jobs tab.

  3. Click Create Localization Job.

Configure and create an XTM package

  1. In the Job Type drop-down menu, select XTM Package.
  2. In the Manager drop-down menu, choose the person you want this project to be assigned to.
  3. Click the Locales field and select applicable target languages.
  4. Click the Due Date field and set a deadline for this project.
  5. Optional: In the Notes field, add preferred localization details.
    Tip:

    Notes added to an XTM localization job in Heretto CCMS become the project name in the XTM software.

  6. In the Include drop-down menu, select an option:
    • If you send the files for localization for the first time, select All Resources.

    • If the files were already translated and you only need to send the changed files for localization, select Only Changed Resources. As a result, only the files that were modified since the last upload are included in the package.

  7. In the Customer drop-down menu , select the customer you want to assign the localization job to.
    Customer refers to the Localization Services Provider (LSP) who will be performing the localization work in XTM, or other Customer association you've set it up in XTM.
  8. In the Template drop-down menu, select the project template you want to use for the localization job.
    Template refers to the XTM project template for the localization job to follow, which may include things such as the workflow steps and assigned linguists.
  9. Click Create.
    Figure 1. An XTM Localization Job
    XTM start project menu

Send the project to XTM and start it at XTM

  1. Click Send Project to XTM.
    A notification confirms that the project was successfully created at XTM. The Open Project in XTM button is shown. It enables you to open the project in XTM, where you can make final changes before starting the project.
  2. Click Start Project at XTM.
    A notification confirms that the project was successfully started at XTM.
Starting the project in Heretto CCMS triggers an XTM workflow. Your project is now in progress.

Retrieve Localized Content from XTM

Once the localization process is completed using XTM software, you must retrieve the localized content into Heretto CCMS so you can view, manage, and publish the content.

All workflow steps for your localization job must be completed in XTM. You'll receive an email when the job is completed in XTM and ready to fetch. Then, you can retrieve the localized content from XTM.

Remember:

You must use DITA maps and not standalone DITA topics to localize content.

  1. You need to select a map for which you want to retrieve localized content from XTM. You can do it by doing one of the following:
    OptionDescription

    Recommended: Retrieve localized content from XTM for a released map

    1. In the Content Library, click the map for which you want to retrieve the localized content. The Resource Drawer appears on the right side of the screen.

    2. In the Resource Drawer, select Releases.

    3. In the Releases tab, go to the related release for which you want to retrieve the localized content and click Localize.

    Retrieve localized content from XTM for a branched map

    1. In the Content Library, click the map for which you want to retrieve the localized content. The Resource Drawer appears on the right side of the screen.

    2. In the Resource Drawer, select Branches. You will see the list of branches related to your map.

    3. In the Branches tab, switch to the branch that contains the map for which you want to retrieve the localized content.

    4. The Branches tab closes and you are back in the Content Library. Click the map for which you want to retrieve the localized content.

    5. In the Resource Drawer on the right of the screen, select the Jobs tab.

    Retrieve localized content from XTM for a standard map

    1. In the Content Library, click the map for which you want to retrieve the localized content. The Resource Drawer appears on the right side of the screen.

    2. In the Resource Drawer, select the Jobs tab.

    Retrieve localized content from XTM for any map

    In the Content Library, go to Localization Jobs in the left pane.

  2. From the Localization Jobs list, select a job you want to retrieve localized content for. The value in the Job Type column will show XTM Package for this localization job.
  3. Click Fetch Translated Documents.

    The Download complete dialog will show when the file transfer is complete.

  4. Click OK to show the resources in the localization manager.
  5. Optional: Click Mark Job Complete to mark this localization job complete.
    Remember: Once you mark a localization job complete, you cannot undo the action.
    Tip: We recommend publishing the localized content and performing a quality verification before marking the job as complete.
    When you mark a job complete, it shows up under Completed Jobs in the Localization Jobs, which can help you organize your localization process. You cannot modify completed localization jobs.