Skip to main content

XTM Connect – Jira User Guide for Administrators

Jira custom fields for configuring XTM Connect – Jira projects

The values in these custom fields, in Jira, are read by the XTM Cloud API and passed to custom tables in XTM Connect – Jira, when a translation project is created in Jira, and project data is synchronized. (Each project has its own configuration in which details such as the source and target languages, assigned Linguists and so on vary.):

Field to configure in Jira

Description

Customer custom field (optional)

This customer is the organization for which translations are to be produced. The Customer ID you enter in this Jira custom field will be used in XTM Cloud to:

  • select the relevant customer for a translation project, if they exist in XTM Cloud or

  • create a new customer if that customer does not yet exist in XTM Cloud.

The Customer custom field is optional: if it is not used, or no Customer ID has been set in that field, XTM Cloud will create a project using the default customer ID specified in the relevant Jira bucket configuration.

Source language (fixed or selectable)

There can only be one source language for a translation project in XTM Cloud. There are two ways to set it:

  • fixed setting: a source language can be set as the default source language for all projects created by XTM Connect – Jira, in the XTM Connect – Jira database

  • select it from a Source language custom field in Jira, which is mapped to XTM Cloud

Caution

We advise that you only select one value for this Source language field, to prevent more than one source language being selected for a single translation project. If you specify more than one source language value, the project will NOT be created in XTM Cloud.

If a source language can be selected from a custom field in Jira, that custom field MUST NOT permit more than one source language to be selected for a single project.

This is because if XTM Cloud receives a request to create a new project, from XTM Connect – Jira, and this request contains more than one source language value, the project WILL NOT be created in XTM Cloud.

Note

Source language codes

XTM International Support needs to know the values for the source language available for selection in Jira, and the appropriate XTM Cloud language codes to map them with. You will find details of the language variant codes used in XTM Cloud in the XTM Cloud documentation. There, select the XTM Cloud manual for the required product version and then go to the Additional Information > Language codes section.

Target languages

Set the Target languages field as a custom field in Jira. This field can contain any language codes that are useful for users, who might want to select them for translation projects.

Note

We advise that you keep the target language codes as easy to understand as possible because some target languages can have multiple variants.

Example, for the English language: en-GB, en-US.

Mapping target languages

Just like the Source language, all target language values that can be selected in Jira must be mapped to XTM Cloud languages.

Jira custom field target languages, with their specific equivalent XTM Cloud language variant codes, are listed in the XTM Cloud documentation. There, select the XTM Cloud manual for the required product version and then go to the Additional Information > Language codes section.

Other necessary custom fields

XTM Cloud can import data from any Jira custom field that is mapped to an XTM Cloud custom field. In Jira, enter values in any other custom fields that need to be imported into XTM Cloud. These custom fields will vary according to your organization's requirements, so they are not listed here. The field types of these custom fields in Jira must match certain XTM Cloud project custom field types. These include:

  • checkbox

  • date

  • dropdown

  • multiple selection

  • number

  • text field