Getting Started
Getting Started with the Lionbridge Connector for Drupal TMGMT
The Lionbridge Connector for Drupal TMGMT is a plug-in to Drupal’s Translation Management Tool (TMGMT) module. Its functionality is displayed to the users as part of Drupal TMGMT. The Lionbridge Connector supports all browsers that Drupal TMGMT supports.
The Connector supports Drupal 7 and 8. The version of the Connector described in this document supports Drupal 7. For information about Drupal 8 support, please contact Lionbridge Connector Support. For details, see How to Contact Lionbridge Connector Support.
Upgrading from version 1.x of the Connector
When upgrading from version 1.x of the Connector to the current version:
- You can use the older Connector version to finish processing jobs submitted with that version.
Recommendation: When all jobs submitted with the older Connector version are complete, uninstall the older version.
- You must use the newer Connector version to submit and process all new jobs.
Upgrading from version 2.0 of the Connector
When upgrading from version 2.0 of the Connector to the current version:
- Complete the processing of all jobs sent with the older version of the Connector.
Warning: If you proceed to the next step without completing all jobs, any jobs that are in progress will be aborted.
-
From the Drupal user interface, uninstall the older version of the Connector.
-
On the server, delete the connector folder.
-
From the Drupal user interface, install the newer Connector version.
To get started with the Lionbridge Connector:
Note: By default, enabling multilingual support for content types automatically enables multilingual support for all the fields of that content type.
1 - Adding Lionbridge as a Translator
Adding Lionbridge as a Translator in Drupal TMGMT
Before you can send content directly from Drupal TMGMT to Lionbridge, you must add the Lionbridge Connector for Drupal TMGMT as a translator in Drupal TMGMT.
You may want to add Lionbridge as multiple translators in Drupal TMGMT, for example, if you want to use multiple Content API credentials or different translator configurations.
Adding Lionbridge as a translator in Drupal TMGMT requires the following three general steps:
- You create a Zendesk account and ticket on the Lionbridge Connectors site.
- The Lionbridge Connector Support team creates a Clay Tablet account for you.
- In Drupal TMGMT, you configure the connection to your Clay Tablet account.
Detailed instructions follow below.
Note: The default configuration settings are appropriate for most users.
To add Lionbridge as a translator in Drupal TMGMT:
The Lionbridge Connector Support team will notify you when your Content API account has been created. This account uses your Zendesk credentials.
- After you receive a notification from the Lionbridge Connector Support team that your Content API account has been created, log in to Drupal to complete the process.
- In Drupal, select Configuration > Regional and language > Translation Management Translators > Add Translator from the menu.
The
Add Translator page opens.

- Enter the following information:
Note: An asterisk (*) indicates a required field.
Field |
Description |
Label |
Your name for the Lionbridge Connector in Drupal TMGMT. This is what is displayed to users who select a translator when sending out content for translation. |
Description |
Your description of the translator. |
Translator Settings - Auto accept finished translations |
|
Indicates whether to automatically accept all completed translations.
-
To automatically accept all translations without reviewing them first, select this check box.
-
To review translations before accepting them, clear this check box.
-
In the Translator plugin dropdown list, select Clay Tablet Connector. This is the Drupal TMGMT plug-in for Lionbridge translation services.
- In the
Clay Tablet Connector Plugin Settings section, enter the following information:

Field |
Description |
Export to |
Your content is always exported in XLIFF format, which is the standard XML-based format for exchanging localizable data between applications. |
XLIFF CDATA |
|
Select this check box to wrap the content in CData tags. This prevents the Connector from escaping special characters, and avoids the scenario of double-escaped characters.
Note: If you select this check box, the Connector ignores the Extended XLIFF processing setting, described next.
Extended XLIFF processing |
|
Select this check box to further process content semantics and mask HTML tags instead of escaping them:
- The Connector wraps the text in CDATA tags.
- The Connector converts entity references for special characters, such as <, >, &, ‘, and “.
- The Connector wraps other HTML elements, such as <img> tags, in <bpt> xliff tags, outside CDATA).
Note: The Connector ignores this setting if the XLIFF CDATA check box, described above, is selected.
Allow export-format overrides |
Select this check box to enable users to override the export-format settings when sending out content items for translation. |
Use one export file for all items in job |
Select this check box to export all content items to one file. Clear this check box to export content items to multiple files. |
Download method |
|
You can choose where to store exported files. Depending on your Drupal configuration, additional download methods and locations may be displayed in addition to Public local files served by the webserver.
Recommendation: Use a secure location to prevent unauthorized access.
|
Clay Tablet Settings
To obtain credentials for the Clay Tablet, create a Zendesk account at https://connectors.zendesk.com and create a support ticket. The Lionbridge Connector Support team will provision an account for you. For detailed instructions, see How to Contact Lionbridge Connector Support.
PO number |
|
Optional. Enter a valid purchase order number that you set up in Lionbridge Freeway.
Username |
The Lionbridge Zendesk username for accessing the Clay Tablet, which enables you to use the Connector to send Drupal content items to Lionbridge for translation. |
Password |
The Lionbridge Zendesk password for accessing the Clay Tablet, which enables you to use the Connector to send Drupal content items to Lionbridge for translation. |
- Click Connect. The Connector sends the credentials (username and password) to the Clay Tablet. The Connector stores the returned token for future sessions.
Notes: The Connector does not save your username or password. You must click Connect, at least once, to generate the access token required to use the Connector.
- Enter the following information in the
bottom part of the page.

Field |
Description |
Provider configuration |
The default translation provider configuration. This translation provider will be displayed by default when users send content out for translation. |
Allow provider overrides |
|
Optional. This option determines whether users can change the translation provider when submitting jobs.
- Select this check box to enable users to change the translation provider when submitting jobs.
- Clear this check box to prevent users from changing the translation provider when submitting jobs. This is the default value.
Transfer all files as zip |
Optional. Select this check box to instruct the Connector to deliver all files for translation in a single .zip file. |
Scheduled Tasks |
Receive translated jobs automatically |
Optional. In the sub-section, select the check box. This instructs the Connector to deliver all translated content automatically, as soon as it is ready. |
- Optional. Click
Remote Languages Mappings to expand this section. You can update the default mapping between each language in Drupal TMGMT and the corresponding Lionbridge Freeway language code.

Each text box in this section has a label with the language name and code of each language set up in the Drupal TMGMT Languages page. (To open this page, select Configuration > Regional and language > Languages from the menu.)
The
Translation Management Translators page opens, displaying the translator you just created.

If you want to add another translator to support different Content API credentials or different translator configurations, repeat the steps above.
2 - Enabling Multilingual Support for Content Types
Enabling Multilingual Support for Content Types on your Site
Before you can send content directly from Drupal TMGMT to Lionbridge, you must enable multilingual support on your Drupal website for each content type that you want to be able to send to Lionbridge for translation.
To enable multilingual support on your site:
- In the Structure menu, select content types.
- Either click Add content type to add a new content type or click edit to edit an existing content type.
- In the menu on the left, click Publishing options.
The
page updates.

- In the Multilingual support section, select the Enabled, with translation radio button.
- Click Save content type.
Important: Repeat steps 2-5 for each content type that you want to be able to send out for translation.
3 - Enabling Multilingual Support for Individual Fields
Enabling Multilingual Support for Individual Fields
Before you can send content directly from Drupal TMGMT to Lionbridge, you must enable multilingual support for each field in each content type that you want to be able to send to Lionbridge for translation.
Note: By default, enabling multilingual support for content types automatically enables multilingual support for all the fields of that content type.
By default, the Connector supports sending out all the fields in the following default content types for translation:
- article
- basic page
- translatable node
You can configure other, custom fields for translation.
Note: Lionbridge does not guarantee that other, custom fields are supported.
To enable multilingual support for a field:
- In Drupal, select Structure > Content types from the menu.
The Content types page opens.
- In the Operations column, click Manage fields for a content type, for example for Translatable Content.
The
Manage fields page opens, listing all the fields in that content type.

- In the Operations column, click Edit for the field to configure, for example for New Field.
The
page for the field settings opens.

- Select the Users may translate all occurrences of this field check box.
- Click Save settings.
Important: Repeat the previous steps for each field in each content type that you want to be able to send out for translation.
4 - The Lionbridge Connector at a Glance
The Lionbridge Connector for Drupal TMGMT at a Glance
The Connector uses the Drupal TMGMT module’s user interface for managing your translations with Lionbridge. You use the following pages to view manage your translations:
Page |
How to Open |
What It Displays |
What You Can Do Here |
Content page |
Click the Content menu. |
all content items, including those without an assigned language |
view a list of items |
Content overview page / Sources tab |
Select Translation > Sources from the menu. |
all items with an assigned language, both submitted and non submitted |
view a list of items that have languages assigned |
Job overview page / Jobs tab |
Click the Translation menu. |
all submitted jobs, including jobs that have finished |
abort jobs, delete jobs, accept translations, open the Job page |
Translation page / Cart tab |
Select Translation > Cart from the menu. |
all items that were added to the cart |
select the target languages for a job and request translation, which opens the Checkout page |
Checkout page (no displayed page name) |
|
Click Request translation or Request translations in the following pages:
- Translations of page for an item
- Content overview page / Sources tab
a list of all items in a job, including word count, and fields for specifying the job settings |
specify the job settings for the translation job for the specified target language |
Review Translation page (no displayed page name) |
In the Job page, when the job is in Finished state, click review. |
source and target (translated) content |
compare and update source content and its translation |
View Translation page (no displayed page name) |
In the Job page, when the job is in Finished state, click view. |
source and target (translated) content |
compare source content and its translation |
Screen captures of pages
Content page

Content overview page / Sources tab

Job overview page / Jobs tab

Translation page / Cart tab

Checkout page (no displayed page name)

Job page (no displayed page name)

Review Translation page (no displayed page name)

View Translation page (no displayed page name)

Important concepts in Drupal TMGMT
Request translation |
Opens the Checkout page, where you group items into a translation job and add job parameters. |
Submit to translator |
Drupal TMGMT creates a job to translate specified items into specified target language and sends it to a translator (the Connector). |
Add to cart |
Adds selected items to the Cart. |
5 - Pre-Production Testing
Pre-Production Testing
After you complete the configuration, your Lionbridge Connector for Drupal TMGMT installation is ready for testing.
Once you have installed TMGMT and configured the Connector, we recommend contacting Lionbridge Connector Support to obtain the endpoint and credentials for testing. For details, see How to Contact Lionbridge Connector Support.
The testing environment enables you to test translations either using machine translation (MT) or by automatically replacing every character in submitted content with the letter x (pseudo-translation). This enables you to test that the Connector is communicating correctly between Drupal TMGMT and Lionbridge, and it ensures that all the content you want translated is correctly extracted and handled by Lionbridge services. You set up this environment as a separate provider.
To add the testing environment as a provider in Drupal TMGMT:
- In Drupal, select Configuration > Regional and language > Translation Management Translators > Add Translator from the menu.
The
Add Translator page opens.

- Enter the following information:
Note: An asterisk (*) indicates a required field.
Field |
Description |
Label |
Your name for the Lionbridge Connector in Drupal TMGMT. This is what is displayed to users who select a translator when sending out content for translation. |
Description |
A description of the translator. |
Translator Settings - Auto accept finished translations |
|
Indicates whether to automatically accept all completed translations.
-
To automatically accept all translations without reviewing them first, select this check box.
-
To review translations before accepting them, clear this check box.
-
In the Translator plugin dropdown list, select Clay Tablet Connector. This is the Drupal TMGMT plug-in for Lionbridge translation services.
- In the
Clay Tablet Connector Plugin Settings section, enter the following information:

Field |
Description |
Export to |
Your content is always exported in XLIFF format, which is the standard XML-based format for exchanging localizable data between applications. |
XLIFF CDATA |
|
Select this check box to wrap the content in CData tags. This prevents the Connector from escaping special characters, and avoids the scenario of double-escaped characters.
Note: If you select this check box, the Connector ignores the Extended XLIFF processing setting, described next.
Extended XLIFF processing |
|
Select this check box to further process content semantics and mask HTML tags instead of escaping them:
- The Connector wraps the text in CDATA tags.
- The Connector converts entity references for special characters, such as <, >, &, ‘, and “.
- The Connector wraps other HTML elements, such as <img> tags, in <bpt> xliff tags, outside CDATA).
Note: The Connector ignores this setting if the XLIFF CDATA check box, described above, is selected.
Allow export-format overrides |
Select this check box to enable users to override the export-format settings when sending out content items for translation. |
Use one export file for all items in job |
Select this check box to export all content items to one file. Clear this check box to export content items to multiple files. |
Download method |
|
You can choose where to store exported files. Depending on your Drupal configuration, additional download methods and locations may be displayed in addition to Public local files served by the webserver.
Recommendation: Use a secure location to prevent unauthorized access.
|
Clay Tablet Settings
To obtain credentials for the Clay Tablet, create a Zendesk account at https://connectors.zendesk.com and create a support ticket. The Lionbridge Connector Support team will provision an account for you. For detailed instructions, see How to Contact Lionbridge Connector Support.
PO number |
|
Optional. Enter a valid purchase order number that you set up in Lionbridge Freeway.
Username |
The username for accessing the Clay Tablet, which enables you to use the Connector to send Drupal content items to Lionbridge for translation. |
Password |
The password for accessing the Clay Tablet, which enables you to use the Connector to send Drupal content items to Lionbridge for translation. |
- Click Connect. The Connector sends the credentials (username and password) to the Clay Tablet. The Connector stores the returned token for future sessions.
Notes: The Connector does not save your username or password. You must click Connect, at least once, to generate the access token required to use the Connector.
- Optional. In the
next part of the page, you can specify the Transfer all files as zip setting. Select this check box to instruct the Connector to deliver all files for translation in a single .zip file.

- Optional. Click
Scheduled Tasks to expand this section. You can select the Receive translated jobs automatically check box to instruct the Connector to deliver all translated content automatically, as soon as it is ready.

- Click
Remote Languages Mappings to expand this section. You can update the default mapping between each language in Drupal TMGMT and the corresponding Lionbridge Freeway language code.

Each text box in this section has a label with the language name and code of each language set up in the Drupal TMGMT Languages page. (To open this page, select Configuration > Regional and language > Languages from the menu.)
-
For each language, select the Lionbridge Freeway language code corresponding to the Drupal language.
-
If you want to add another translator to support different Content API credentials or different translator configurations, repeat the steps above.
-
Click Save translator.
The
Translation Management Translators page opens, displaying the translator you just created.

- If you want to add another provider to test different Content API credentials or different provider configurations, repeat the steps above.
We recommend sending only a few pages for translation in one language as an initial test. For detailed instructions, see Sending Content to Lionbridge. Once successful, you can send as many languages as required.
If you have any concerns or questions, please contact Lionbridge Connector Support. For details, see How to Contact Lionbridge Connector Support.