TMX attributes that are applicable during TM import & export

Owned by Damian Rozmiarkowski (Unlicensed)
Last updated: Jan 24, 2024 by Damian Rozmiarkowski
3 min read

Introduction

The TM import feature comes with a wide range of attributes that you can import from or export a TMX file, if required. In the next section, you will find attributes that can play a role in their individual processes.

Before reading the article below, we recommend that you read the step-by-step guideline to importing and exporting your TM:

Before reading the article below, we recommend that you read the step-by-step guideline to importing and exporting your TM:

Attributes imported from TMX

See the list of attributes related to the importing of the TMX file

  • creationdate → translation creation date,

  • creationid → userID or username of the linguist who translated the segment.

  • changedate → date of last change in the segment.

  • changeid → userID or username of the person who last changed the segment.

Attributes changedate and changeid only store the last change.

All dates are given in UTC ISO 8601.

EXAMPLE:

<tu creationdate="20190902T081510Z" creationid="20" changedate="20190902T083044Z" changeid="13388">

  • x-Project → project name,

<prop type="x-Project">project name</prop>

  • x-project-reference-id → project reference ID,

<prop type="x-project-reference-id">{"ids":["Project Reference ID"]}</prop>

  • x-previous-source-text and x-next-source-text → contains context information,

<prop type="x-previous-source-text">previous source text</prop>

<prop type="x-next-source-text">after source text</prop>

  • x-previous-crc and x-next-crc → contains the “crc” information,

Those fields are required to get ICE matches.

x-previous-target-crc and x-next-target-crc → contains the target “crc” information if the source is translated,

Those not required to get ICE matches.

<prop type="x-previous-crc">3287226240</prop>

<prop type="x-next-crc">0</prop>

<prop type="x-previous-target-crc">3062353205</prop>

<prop type="x-next-target-crc">0</prop>

  • idiom-prev-hashcode and x-idiom-next-hashcode → contains World Server hashes,

<prop type="x-idiom-prev-hashcode">1277803120</prop>

<prop type="x-idiom-next-hashcode">1521489988</prop>

  • x-idiom-source-ipath and x-idiom-target-ipath → path to source and target files,

<prop type="x-idiom-source-ipath">/Clients/xtm/file.xml</prop>

<prop type="x-idiom-target-ipath">/Clients/xtm/file.xml</prop>

  • x-segment-id → segment ID,

<prop type="x-segment-id">xml_id_preffix/ChoicePopupPaySpinButton/xml_id_suffix</prop>

  • x-xtm-status → segment status. This can be one of two: Approved and Not approved:

a) In UI:

Import or set approved/not approved status → Import statuses and set as approved where missing;

OR

Import or set approved/not approved status → Import statuses and set as not approved where missing.

b) API – the importTM method:

<segmentImportStatus>FROM_FILE_OR_APPROVE </segmentImportStatus>

OR

<segmentImportStatus>FROM_FILE_OR_NOT_APPROVE </segmentImportStatus>

c) Bridge

Not approved status is the default value. The status can only be changed in the Bridge configuration.

<prop type="x-xtm-status">notapproved</prop>

  • prop type="Status" → XLIFF:doc status. There are 5 possible values:

  1. New (1) → "new";

  2. Translated (2) → "translated";

  3. Proofed (3) → "final";

  4. Validated (4) → "signed-off";

  5. Rejected (-1) → "needs-review-translation".

<prop type="Status">translated</prop>

  • prop type="YOUR_GROUP_TAG" → tags. If the tags do not exist in the XTM Cloud UI, they will not be imported,

<prop type="group">tag1</prop><prop type="group">tag2</prop>

where: "group" → tag group name; "tag1" and "tag2" → tags.

Attributes added to TMX after exporting TM

See the list of attributes that are added to the TMX file during the TM export process.

  • tuid → segment database ID,

EXAMPLE:

<tu creationdate="20220711T084509Z" creationid="6391" changedate="20220711T084959Z" changeid="6391" tuid="59499">

  • prop type="user-defined" → Client name and customer ID.

<prop type="user-defined">CUSTOMER: am_76082</prop>

where: "am" → client name; “76082” → customer ID.

If a segment exists, but some data in TMX is being updated…

Sometimes the same segment might exist both in the XTM Cloud UI and in an TMX file. If this is the case, then

  1. A new segment (duplicate) is created for:

  • x-segment-id,

  • x-previous-crc, x-next-crc, x-previous-target-crc and x-next-target-crc.

  1. Old data is replaced with a new one in an existing segment for:

  • prop type="Status".

  1. Segments are ignored during import for:

  • creationdate,

  • creationid,

  • changedate,

  • changeid,

  • x-Project,

  • x-previous-source-text and x-next-source-text,

  • prop type="Tag",

  • x-idiom-prev-hashcode and x-idiom-next-hashcode,

  • x-idiom-source-ipath and x-idiom-target-ipath.

Modification of segments during the saving process

In addition, a user can choose which segment is to be modified. All options are available in global settings (administrative privileges required!): Configuration → Settings → Translation → TM → Matches - general → Modify the existing TM record if the project segment has the same.