CTSX Transperfect

Content management Incubator Version 4.1.3 Magnolia 6.3 compatible

The CTSX Transperfect module performs translations using the Transperfect APIs. Translations are handled asynchronously.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

In order to start the translation process, please make sure that the core and apps modules in the CTSX Framework have already been installed.

<dependency>
  <groupId>info.magnolia.translation</groupId>
  <artifactId>magnolia-content-translation-support-ext-translations-com</artifactId>
  <version>4.1.3</version>
</dependency>

<dependency>
  <groupId>com.translations.globallink</groupId>
  <artifactId>globallink-connect-api</artifactId>
  <version>4.18.4</version>
</dependency>

Configuration

The configuration can be done using JCR or YAML.

Refer to the JCR Configuration for the JCR configuration.
Refer to the YAML configuration for instructions on how to define settings using YAML.

JCR Configuration

Configuration of the Transperfect service provider is handled in the module config. This provider should be configured with the following path:

modules
└── content-translation-support-ext-translations-com
    └── config
        └── translationProviders
            └── transComProviderConfigFile.yaml

For users upgrading from version 4.0.0 to version 4.1.0, ensure you move your existing translation provider configuration to the correct path.

YAML configuration

Transperfect service provider configuration is defined within its provider module (magnolia-content-translation-support-ext-microsoft) under the following directory structure:

/src/main/resources/magnolia-content-translation-support-ext-translations-com/translationProviders

Required decorations

This configuration can also be decorated to override or extend the default configuration. Decoration file should be placed under the following path:

<light-module-name>/decorations/magnolia-content-translation-support-ext-translations-com/translationProviders

Below is an example of how to decorate Transperfect service provider configuration within a light module:

light-modules/
└── my-module/
    └── decorations/
        └── magnolia-content-translation-support-ext-translations-com/
            └── translationProviders/
                └── Transperfect.yaml

Configuration properties

This provider can be configured with the following properties.

Property Description

Property	Description
`agentName`	optional Translation agent name.
`autoTranslationAllowed`	optional , default is `false` When true the content review process (workflow) is bypassed.
`class`	required Definition class for the translator to be used. See `info.magnolia.translation.ext.provider.google.definition.TranslationsComProviderDefinition`.
`clientId`	required Identifies the client application.
`clientPassword`	required Identifies the client password.
`configName`	required Identifies the configuration within Magnolia.
`daysListen`	required Number of days system continue to listen to GlobalLink PD (calculated from last modified date of a submission).
`defaultFlag`	optional The default configuration used by the system in the case of multiple translation services being used.
`enabledFlag`	required Enable or disable the configuration using this flag.
`fileFormat`	required Depends on the version of GlobalLink PD you use. For version 5 use "Magnolia". For version 4 use "xliff".
`implementationClass`	required Implementation class for interfacing with Transperfect. See `info.magnolia.translation.ext.provider.translationscom.translator.TranslationsComRestTranslator`.
`projectId`	only required in 3.4.10+ Id of the project setup with Transperfect.
`basicKey`	only required in 3.4.10+ This basic auth token is only used to get PD credential. You can get these credentials from a PD administrator.
`submissionPrefix`	optional Prefix added to submitted documents. Example: `magnolia-`
`downloadExpiration`	optional, default is 840000 Download expiration time in milliseconds. Default to 14 minutes (840,000 ms).
`headerParams`	required Additional request headers to be sent on submission creation, configured as a content node of properties where the property key is the header name, and the property value is the header value. The `User-Agent` header is required and is set in the following format: `<connectorName> <connectorVersion>_<buildtype> (<clientVersion>)` `buildtype` is only required if release is not final: Alpha, Milestone, RC, etc. (These cannot be deployed to production) `clientVersion` is optional and refers to the name/version of the system the connector is built for. This information is useful for troubleshooting. Example: `Magnolia 4.1.1 PROD`
`techTracking`	required Tech tracking is a set of four key/value pairs that allow an integration to specify the following information: adaptorName - Name of the adaptor that created the submission adaptorVersion - Version of the adaptor clientVersion - Name and version of the client system technologyProduct - Code of the technology product that created the submission; please check with the GL Support team for the code of your specific technology product

agentName

optional

Translation agent name.

autoTranslationAllowed

optional , default is false

When true the content review process (workflow) is bypassed.

class

required

Definition class for the translator to be used.

See info.magnolia.translation.ext.provider.google.definition.TranslationsComProviderDefinition.

clientId

required

Identifies the client application.

clientPassword

required

Identifies the client password.

configName

required

Identifies the configuration within Magnolia.

daysListen

required

Number of days system continue to listen to GlobalLink PD (calculated from last modified date of a submission).

defaultFlag

optional

The default configuration used by the system in the case of multiple translation services being used.

enabledFlag

required

Enable or disable the configuration using this flag.

fileFormat

required

Depends on the version of GlobalLink PD you use. For version 5 use "Magnolia". For version 4 use "xliff".

implementationClass

required

Implementation class for interfacing with Transperfect.

See info.magnolia.translation.ext.provider.translationscom.translator.TranslationsComRestTranslator.

projectId

only required in 3.4.10+

Id of the project setup with Transperfect.

basicKey

only required in 3.4.10+

This basic auth token is only used to get PD credential. You can get these credentials from a PD administrator.

submissionPrefix

optional

Prefix added to submitted documents.

Example: magnolia-

downloadExpiration

optional, default is 840000

Download expiration time in milliseconds. Default to 14 minutes (840,000 ms).

headerParams

required

Additional request headers to be sent on submission creation, configured as a content node of properties where the property key is the header name, and the property value is the header value.

The User-Agent header is required and is set in the following format:

<connectorName> <connectorVersion>_<buildtype> (<clientVersion>)

buildtype is only required if release is not final: Alpha, Milestone, RC, etc. (These cannot be deployed to production)

clientVersion is optional and refers to the name/version of the system the connector is built for. This information is useful for troubleshooting.

Example: Magnolia 4.1.1 PROD

techTracking

required

Tech tracking is a set of four key/value pairs that allow an integration to specify the following information:

adaptorName - Name of the adaptor that created the submission

adaptorVersion - Version of the adaptor

clientVersion - Name and version of the client system

technologyProduct - Code of the technology product that created the submission; please check with the GL Support team for the code of your specific technology product

Sample JCR configuration

4.1.0+

'config':
  'jcr:primaryType': 'mgnl:content'
  'translationProviders':
    'translationsComConfig':
      'agentName': 'xxx'
      'autoTranslationAllowed': 'false'
      'class': 'info.magnolia.translation.ext.provider.translationscom.definition.TranslationsComProviderDefinition'
      'clientId': 'xxx'
      'clientPassword': 'xxx'
      'configName': 'translations.com'
      'daysListen': '1'
      'defaultFlag': 'false'
      'enabledFlag': 'true'
      'fileFormat': 'xxx'
      'implementationClass': 'info.magnolia.translation.ext.provider.translationscom.translator.TranslationsComRestTranslator'
      'projectId': 'xxx'
      'basicKey': 'xxx'
      'submissionPrefix': 'xxx'
      'url': 'xxx'
      'headerParams':
        'User-Agent': 'Magnolia 4.1.1 PROD'
      'techTracking':
        'adaptorName': 'xxx'
        'adaptorVersion': 'xxx'
        'clientVersion': 'xxx'
        'technologyProduct': 'xxx'

Sample YAML decorated configuration

agentName: xxx
fileFormat: xxx
projectId: xxx
basicKey: xxx
submissionPrefix: xxx
url: xxx
clientId: xxx
clientPassword: xxx
autoTranslationAllowed: true
enabledFlag: true
headerParams:
  User-Agent: xxx
techTracking:
  adaptorName: xxx
  adaptorVersion: xxx
  clientVersion: xxx
  technologyProduct: xxx

Usage

After registration and starting, the Content Translation Support Extended (CTSX) module will bind the Transperfect translator to Configuration field.

You can test the connection to the translator api before using.

translations dot com

How it works

Use the same steps outlined with CTSX Google Translator but you will choose Transperfect instead of Google.com in the Configuration.

In additional, at the Step 2 after submitting the batch you must to wait for the response from Transperfect’s GlobalLink Project Director app (PD).

You would be able to see the Pulse notification for translation result as soon as the submission has been delivered on PD.

CTSX Transperfect

Installing with Maven

Configuration

JCR Configuration

YAML configuration

Required decorations

Configuration properties

Sample JCR configuration

Sample YAML decorated configuration

Usage

How it works

Location

Main doc sections