CTSX Translations.com

Content management Incubator

Issues

Git

Git

Latest

3.4.14

Compatible with Magnolia 6.2.

The CTSX Translations.com module performs translations using the Translations.com 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 Translations.com translation process, please make sure that the core and apps modules in the Content Translation Extended have already been installed.
<dependency>
  <groupId>info.magnolia.translation</groupId>
  <artifactId>magnolia-content-translation-support-ext-translations-com</artifactId>
  <version>3.4.14</version>
</dependency>
<dependency>
  <groupId>com.translations.globallink</groupId>
  <artifactId>globallink-connect-api</artifactId> (1)
  <version>4.18.4</version>
</dependency>
1 This is only needed if using version up to 3.4.9.

Configuration

Configuration of the Translations.com service provider is handled in the module config. This provider can be configured with the following properties.

Please use JCR for module configuration. When using yaml, translation provider definitions are not loaded and the connector is unusable.
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 for version up to 3.4.9

Identifies the client application with Translations.com.

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 TranslationsCom.

See info.magnolia.translation.ext.provider.google.translator.TranslationsComTranslator.

For version 3.4.10+, see info.magnolia.translation.ext.provider.google.translator.TranslationsComRestTranslator.

projectCode

required for version up to 3.4.9

Name of the project setup with Translation.com.

projectId

only required in 3.4.10+

Id of the project setup with Translation.com.

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-

Sample configuration

  • 3.4.10+

  • Up to 3.4.9

'config':
  'jcr:primaryType': 'mgnl:content'
  'translationsComConfig':
    'agentName': 'xxx'
    'autoTranslationAllowed': 'false'
    'class': 'info.magnolia.translation.ext.provider.translationscom.definition.TranslationsComProviderDefinition'
    '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'
'config':
  'jcr:primaryType': 'mgnl:content'
  '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.TranslationsComTranslator'
    'projectCode': 'xxx'
    'submissionPrefix': 'xxx'
    'url': 'xxx'

Usage

After registration and starting, The Content Translation Support Extended (CTSX) module will bind the Translations.com 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 Translations.com 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 Translations.com’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.
  • 5.x

  • 4.x

pd version5x
pd version4x
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the Content Translation Extended module docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules