Language Weaver extension configuration properties

Implementing the Tridion extension for Language Weaver requires a JSON configuration file, which defines your specific integration of Tridion with Language Weaver.

In the JSON configuration file, use the following properties to configure the Language Weaver extension:

hostUrl
The URL of the Language Weaver host.
clientId
API username to be used to authenticate over OAuth.
Use the consumer secret of the connector application you defined when setting up OAuth.
clientSecret
API password to be used to authenticate over OAuth.
Use the consumer secret of the connector application you defined when setting up OAuth.
useTranslationManagerConfiguration
A Boolean value (true/false) that indicates whether to enable the reading of Translation Manager configuration.
  • Optional
  • Default is false
  • When set to true, Translation Manager configuration will be used.
excludedSchemas
A string array of TCM URIs of specific Schemas that you want to be explicitly exclude from translation.
When used, all Components based on these Schemas (or embedded schemas matching TCM URIs) will not be translated.
  • Optional
  • Ignored when useTranslationManagerConfiguration:true
  • Cannot be used simultaneously with includedSchemas
includedSchemas
A string array of TCM URIs of specific Schemas that you want to be explicitly include for translation.
When used, only Components based on these Schemas (or embedded schemas matching TCM URIs) will be translated.
  • Optional
  • Ignored when useTranslationManagerConfiguration:true
  • Cannot be used simultaneously with excludedSchemas
translateMetadata
A Boolean value (true/false) that indicates whether to translate Component metadata in addition to Component content.
  • Optional
  • Default is false
translationSettings
An array of settings that can be used to apply additional settings to one or more specific Publications. Properties for each Publication include the following:
  • publicationId – ID of the Publication
  • sourceLanguageId – Three-letter code for the publication source language (according to ISO-639)
  • targetLanguageId – Three-letter code for the publication target language (according to ISO-639)
  • translateComponentNames – A Boolean value (true/false) that indicates whether to translate Component names.
    • Optional
    • Default is false
    • Ignored when useTranslationManagerConfiguration:true
  • model – A string representing a unique identifier for the language pair combination.
    • Optional
    • Default is "generic"
  • dictionaries – A string array containing dictionary IDs. This property is optional.
  • mode – A string representing a translation mode.
    • Optional
    • The possible values are:
      • speed
      • quality (default)

The following sample code illustrates the configuration file of a Language Weaver extension:

{
  "configuration": {
    "MachineTranslationEventHandler": {
      "configuration": {
        "hostUrl": "https://translate-api.sdlbeglobal.com",
        "clientId": "<clientId>",
        "clientSecret": "<clientSecret>",
 
        "useTranslationManagerConfiguration": true,
 
        "excludedSchemas": [ "tcm:3-111-8" ],
        "includedSchemas": [ "tcm:3-111-8" ],
 
        "translateMetadata": true,
 
        "translationSettings": [
          {
            "publicationId": "10",
            "sourceLanguageId": "eng",
            "targetLanguageId": "fra",
 
            "translateComponentNames": true,
            "model": "generic",
            "dictionaries": [ "0d967785-2857-46d7-9e10-4f6d1346db06" ],
            "mode": "speed"
          }
        ]
      }
    }
  }
}