Documentation Center

Translation Organizer TMS parameters

TMS parameters for Translation Organizer are located in the TMS section of Translation Organizer's appsettings.json file.

Alias

A unique display name for the TMS installation (such as demo, prod, dev, and so on).

Uri

The base URI for TMS (such as http://tms.example.com/). A value is mandatory.

AuthenticationMode

The type of authentication used for signing in TMS from Content Manager.

Possible values:

  • UserCredentials — the current SSO authentication mode, applicable to TMS 12.1 and later.
    • UserName: the username of the user who is signing in.
    • Password: the password of the user who is signing in.
  • ApiSecret — the legacy authentication mode, applicable to TMS 12 and earlier).
    • apiKey: the API key that is associated with a user (is used only by REST API). It can be obtained from TMS (Setup > Users & Groups > Users > "<user name>" > TMS API key). A value is mandatory.
    • secret: API key encrypted using the user password (is used only by REST API). You can obtain the secret by contacting your TMS contacts or contact RWS Support and providing them the API key as well as the username and password of the user performing the integration. A value is mandatory.

ExternalJobMaxTotalUncompressedSizeBytes

Maximum total size of the single translation job. Default value is 5242880 bytes.

RetriesOnTimeout

Number of times the single external call can fail and be retried before the job is moved to failed status. Default value is 3.

HttpTimeout

The timeout used when doing the TMS call using REST API. Default value is 00:02:00.

DestinationPortNumber

Gets or sets a value indicating the TCP Port number over which communications should be conducted.

IsapiFilterLocation

Gets or sets a value indicating the path of the CTAISAPI component in TMS that will receive communication requests.

UseCompression

Gets or sets a value indicating whether communications should be compressed (is used only by CTAISAPI).

UseSsl

Gets or sets a value indicating whether communications should be conducted over a secure channel (is used only by CTAISAPI). If the URI is https, this parameter must be set to true.

UseDefaultProxyCredentials

Gets or sets a value indicating whether to use default credentials when communicating with a Proxy server.

ProxyServer

Gets or sets a value indicating the URI of the Proxy server to use.

ProxyPort

Gets or sets a value indicating the TCP port to use when communicating with the proxy.

Mappings

The Mappings section includes required mappings of languages in Content Manager to languages in TMS. For example, the mappings below define mappings from the TMS languages "EN" (English), "FR" (French) and "NL" (Dutch) to the Tridion Docs languages "en" (English), "fr" (French) and "nl" (Dutch), respectively:
"Mappings": [
   {
     "TmsLanguage": "EN",
     "TrisoftLanguage": "en"
   },
   {
     "TmsLanguage": "FR",
     "TrisoftLanguage": "fr"
   },
   {
     "TmsLanguage": "NL",
     "TrisoftLanguage": "nl"
   }
 ]

Templates

The TMS configurations that specify the workflow and the language pairs. Each configuration that you want to use within Content Manager must be configured within a <template> element. For example, the configuration below configures two templates, specifying the ID and name for each template:
"Templates": [
  {
    "TemplateId": "99358CC5-EAEE-4EFD-8ABE-6D2FCB19E57D",
    "TemplateName": "My Template"
  },
  {
    "TemplateId": "DBE64A36-A70D-4B24-9E93-C58CC10A1BDB",
    "TemplateName": "My Template Review"
  }
 ]

Metadata settings

The configuration can contain metadata that gets extracted and passed to TMS, which looks as follows:
"RequestedMetadata": [
  {
    "Name": "NAME",
    "Level": "LEVEL",
    "ValueType": "VALUETYPE"
  }
]
where:
  • NAME is the name of the metadata property, for example, FAUTHOR or DOC-LANGUAGE
  • LEVEL is the level of the metadata property, one of lng, logical or version
  • VALUETYPE is the type of value of the metadata property, one of element, value, id or label.
The configuration can also contain metadata that is used for grouping items in TMS, which looks as follows:
"GroupingMetadata": [
  {
    "Name": "GROUPINGNAME",
    "Level": "GROUPINGLEVEL",
    "ValueType": "GROUPINGVALUETYPE"
  }
]

where GROUPINGNAME, GROUPINGLEVELand GROUPINGVALUETYPE are like in RequestedMetadata

This metadata will be passed to TMS, together with the metadata specified in the RequestedMetadata section.