CTSX Google Translator

Content management Incubator Version 4.1.1 Magnolia 6.3 compatible

The CTSX Google module performs translation via the Google Cloud Translation API. The Google Translation API supports more than one hundred different languages, from Afrikaans to Zulu. Used in combination, this enables translation between thousands of language pairs.

Installing with Maven

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

In order to start the Google 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-google</artifactId>
  <version>4.1.1</version>
</dependency>
<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-translate</artifactId>
  <version>2.22.0</version>
</dependency>

Configuration

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

modules
└── content-translation-support-ext-google
    └── config
        ├── translationProviders
        │ └── googleTranslationProviderConfigFile.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.

Use JCR for module configuration. When using .yaml, the translation provider definition is not be loaded and connector is unusable.

This provider can be configured with the following properties.

Property Description

Property	Description
`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.GoogleProviderDefinition`.
`clientId`	required Identifies the client application with Google.
`clientToken`	required Client secret for the client ID.
`configName`	required Identifies the configuration within Magnolia.
`defaultFlag`	optional The default configuration used by the system in the case of multiple translation services being used.
`implementationClass`	required Implementation class for interfacing with Google. See `info.magnolia.translation.ext.provider.google.translator.GoogleTranslator`.

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

clientId

required

Identifies the client application with Google.

clientToken

required

Client secret for the client ID.

configName

required

Identifies the configuration within Magnolia.

defaultFlag

optional

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

implementationClass

required

Implementation class for interfacing with Google.

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

Sample configuration

'config':
  'jcr:primaryType': 'mgnl:content'
  'translationProviders':
    'Google':
      'autoTranslationAllowed': 'false'
      'class': 'info.magnolia.translation.ext.provider.google.definition.GoogleProviderDefinition'
      'clientId': 'xxx'
      'clientToken': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
      'configName': 'Google.com'
      'defaultFlag': 'true'
      'enabledFlag': 'true'
      'implementationClass': 'info.magnolia.translation.ext.provider.google.translator.GoogleTranslator'

Usage

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

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

Choose Pages

Choose the pages that contain the i18n items before starting the process.
Click to 'Add to translation batch' action on action bar.
In the 'Add to translation batch' dialog:
1. Input the batch name or select a existing batch.
2. Check to include Dependencies and include Sub-nodes if necessary.
3. Select Google.com in the Configuration.
4. Optionally, add instructions and notes.
5. Click Save Changes.

Submit Batch

Open the Translation Extend app (under the Tools menu).
From the 'Batches' tab:
1. Select your batch.
2. Edit the batch information if you want.
3. Click to 'Submit batch' action on action bar.
  
  After The executeGetTranslationCommand has run, you will get the Pulse notification for the translation result.
  
  You can bypass this step (auto import translated content) if you set "autoTranslationAllowed=true".
In the 'Translation Review' dialog:
1. Click to 'Assign to me' on action bar.
2. Can be 'Approve & Import' or Reject the task.
3. Click to 'Review' action for comparing the different.

It can also be 'Import' or "Reject" in the 'Comparison' tab.

Check the result

After importing the translated content, you can open the selected page again for checking the result.

Known issues

Too many text segments

In case of submitting many contents (such as the whole /travel page includes dependences), an error will be thrown as below. This is known issue as number of submitted segments is over google’s threshold.

ERROR info.magnolia.commands.MgnlCommand: Execution is error, update to translation task item {}
com.google.cloud.translate.TranslateException: Too many text segments
Caused by: com.google.api.client.googleapis.json.GoogleJsonResponseException: 400 Bad Request {"code": 400, "errors" : [ { "domain" : "global", "message" : "Too many text segments", "reason" : "invalid" } ], "message" : "Too many text segments"}

Jira

3.x EXCONTRANS-333
2.9 EXCONTRANS-334

CTSX Google Translator

Installing with Maven

Configuration

Sample configuration

Usage

Choose Pages

Submit Batch

Check the result

Known issues

Too many text segments

Jira

Location

Main doc sections