XLIFF:doc status
Introduction
What is XLIFF:doc status?
XLIFF:doc status can be defined as a one-word description of a segment’s translation status. It is comparable to the XTM Cloud TM entry status (Approved or Not approved) but has more detailed status categories. These statuses are used in offline translation when uploading TIPP packages back to XTM Cloud from external CAT tools which support that format. Such statuses are then displayed in their corresponding segments in XTM Workbench.
The XLIFF:doc status also serves as a criterion with which we can browse the TM database in the XTM Cloud UI and penalize TM matches in TM penalty profiles.
IMPORTANT! To ensure that the TIPP package always has a unique response ID, it must always originate from XTM Cloud. In other words, the package must first be generated in XTM Cloud. It can only undergo further modification in another CAT tool and then be reuploaded to XTM Cloud. Otherwise the upload process is unsuccessful and the message shown below is displayed.  |
The XLIFF:doc status does not influence TM matching prioritization in any way. However, such status can be used in TM penalty profiles, as one of the criteria by which TM matches can be penalized.
How to enable it
To use XLIFF:doc statuses in XTM Cloud, we first need to enable the feature in Configuration → Settings → System → Enable TIPP (administrative privileges required!).
Naming convention
A segment can take one of five XLIFF:doc statuses. Its name might be different between XTM Cloud and a TIPP package:
NAME IN XTM | NAME IN TIPP |
|---|---|
1:New | new |
2:Translated | translated |
3:Proofed | final |
4:Validated | signed-off |
-1:Rejected | needs-review-translation |
Update of XLIFF:doc statuses and its implications
How to change the XLIFF:doc status in segments
There are several ways of updating the XLIFF:doc status for particular segments.
One way is to change it manually in XTM Workbench for each segment, on the right-hand side of the page.
Another way is to perform a batch change by using the Change segment status option for the XLIFF:doc status. To do so, select File → Change status.
The XLIFF:doc status for a particular segment can also be changed directly in the TM database in the XTM Cloud UI in TM → Manage (TM Expert role required!).
In Configuration → Settings → Translation → TM → Matches - general, there is an option called Do not store in TM segments with XLIFF:doc status set to Rejected, which, as the name suggests, causes all the TM records with the -1:Rejected status not to be displayed in TM database in the XTM Cloud UI. |
|---|
Last but not least, the XLIFF:doc status can be changed in batch, during the workflow, by performing the Automatic step. We can specify the type of status to which we want to change the current statuses. To configure this step, go to Configuration → Settings → Workflow → Workflow steps (administrative privileges required!).
What effect does the updating of the XLIFF:doc status have?
Under certain circumstances, updating the XLIFF:doc statuses of segments can cause those statuses to change in TM records and, consequently, other related XTM Cloud projects.
When we create a new project, the default XLIFF:doc status value for every segment is 1:New. Even if we enter a translation and confirm it, the translation is not changed immediately: we need to update the XLIFF:doc status manually, on the right-hand side of a particular segment.
If we create a second project that uses translation memory from the first project, its TM matches reflect the XLIFF:doc status from the original project, and:
when auto-population of a specific TM match is enabled: XLIFF:doc status in the segment is also changed accordingly;
when auto-population of a specific TM match is disabled: XLIFF:doc status in the segment is not changed accordingly, even though we insert the TM match directly in the segment.
If we change the XLIFF:doc status (and translation) in the segment in the original project, the status will be changed accordingly in TM matches in XTM Workbench in the second project, but it will not be changed in the segments in that second project. Also, the appropriate TM record will be overridden with a new XLIFF:doc status (and translation) in the database or a new TM entry will be created with that status, depending on the TM modification settings.
If we change the XLIFF:doc status in a segment in XTM Workbench in the second project, this change will be reflected in a TM record in the database, but it will not change the XLIFF:doc status in a TM match in XTM Workbench. The status will only be changed in the TM match as well if we reanalyze the project (which will cause the newest TM entries from this project to be matched against the segments).
In the case of TIPP packages (or, to be more precisely, in XLF files that are contained within packages of this kind), the XLIFF:doc status of a particular segment is indicated in the following element: <target state=></target>; for example:
<target state="translated">Tłumaczenie</target>. Once the package has been uploaded to XTM Cloud, that status will be displayed in XTM Workbench.If we move the workflow back or forth between steps in either project, the XLIFF:doc statuses will not be changed in any way. The segments maintain the same status across all the workflow steps.
If we parse the segments through the Automatic step in the first project, the XLIFF:doc status is changed to whatever status was set up in that Automatic step, both in TM records in the database and TM matches in XTM Workbench in the second project, but the status in the segments in that project will remain unchanged. Once the TM match has been inserted in the segment and we reanalyze the project, the XLIFF:doc status is also changed in that segment.
If we change an XLIFF:doc status by modifying a TM record directly in the database, it will be changed in a TM match in XTM Workbench in the second project, once we reopen the editor, but not in the segments. Once the TM match has been inserted in the segment and we reanalyze the project, the XLIFF:doc status is also changed in that segment.