Integrations

Drupal (TMS)

Available for

  • Ultimate and Enterprise plans

Get in touch with Sales for licensing questions.

Supported Versions

The Phrase Translation Plugin for Adobe Experience Manager follows the same product support periods as Adobe Experience Manager. See https://helpx.adobe.com/support/programs/eol-matrix.html for information on support periods.

Once an Adobe Experience Manager version reaches end of core support, Phrase no longer maintains the plugin. The installer will be available but no further improvements or fixes will be implemented.

  • Plugin version 2.x supports 6.5.

  • Plugin version 3.x supports AEM as a Cloud Service.

Integration Release Notes

The Phrase Translation Plugin for TMGMT (Translation Management Tool) supports both Drupal 7 and Drupal 8/9. It can be used to translate all Drupal text elements supported by the TMGMT module.

Joomla 3.7 or higher.

  • Magento CE 2.3 and 2.4

  • Adobe Commerce 2.3 and 2.4 (including on cloud version)

Sitecore - XP (Experience Platform): 8.2 and higher

  • Version: 8.7 or higher

  • PHP Version: 7.0 or higher

Content from TYPO3 is always imported as HTML files.

Custom content blocs are not supported.

  • WordPress Version: 4.9 or higher, including multi-site installations (Phrase plugin and WPML need to be installed to all sites)

  • PHP Version: 7.0 or higher

  • WPML Plugin: version 3.7 or higher

  • Multilingual Press Plugin: version 3.7.0 or higher

  • Bitbucket Server - 5.8 and higher

Note

Some HTML tags present a risk and the CAT editor removes them from this HTML when displaying the preview. This is to ensure user's data privacy and security.

Examples of removed tags include FORM, IFRAME, SCRIPT, SVG, VIDEO, EMBED, OBJECT or background-image CSS properties.

Phrase Settings

Pre-requisite: Create an Adobe Experience Manager user with minimum permissions required to view unpublished pages.

Tip

Create a new user called phrase-preview and add the user to the Authors group.

Important

If accessing from a custom domain (ex. mydomain.phrase.jp), open an incognito browser window and log in via cloud.phrase.com or us.cloud.phrase.com to apply the authentication required for the creation or saving of the connector. After saving, the connector can be accessed via the custom domain.

  1. From the Settings Setup_gear.png page, scroll down to the Integrations section.

  2. Click on Connectors.

    The Connectors page opens.

  3. Click New.

    The Create Connector page opens.

  4. Provide a name for the connection and change the Type to Adobe Experience Manager Live Preview Bitbucket Cloud Bitbucket Server Box either Contentful (Entry-Level) or Contentful (Field-Level) Contentstack Dropbox FTP Git GitHub GitLab Google Drive Help Scout HubSpot Joomla Kentico Magento Marketo Microsoft Azure Microsoft OneDrive Salesforce Knowledge SFTP Microsoft SharePoint Online TYPO3 WordPress Sitecore Zendesk Amazon S3 Kentico KontentDrupal Live Preview.

  5. Select how the connector should import linked content items.

    Remote Kontent workflow steps are respected for linked items. If the selected content item is set to Translate, yet all linked items are in Draft they will not be imported. Selected items and their linked items both require the initial Translate workflow step to be imported by APC. This is ensure that only content that is explicitly intended to be localized by the content author is imported.

    • Selected content item only

      • Content that is explicitly selected when adding from the repository is imported.

      • Changes detected by APC are imported for translation.

    • Include linked content items

      • The connector traverses the entire hierarchy of linked content and imports all translatable fields for translation.

  6. Enter Project ID (Delivery API Key) obtained from the Kontent site.

  7. Enter Management API Key obtained from the Kontent site.

  8. Optionally select Export translations as pull requests and provide a Pull request branch.

  9. Optionally select Export translations as pull requests and provide a Merge request branch.

  10. Provide Access key ID.

  11. Provide Secret access key.

  12. Provide the name of the host.

  13. Optionally define when articles are to be translated based on field status.

  14. Optionally define field status on post-translation.

  15. Select what status translations should have.

  16. Provide Translate to languages specified in (APC).

    Automated Project Creation only creates jobs for languages specified in the custom field identified by its Field Name (e.g. Target_Languages__c). The field type should be the multi-value picklist, where the values use language codes as the API Names.

  17. Enter the Host prefix.

  18. In the Translate articles with label field, specify a label that flags an article to be processed by the connector. If specified, only articles with this label will be processed.

  19. Select how jobs will be created.

  20. Select how to save translations.

  21. Define article workflow.

  22. Click Connect to Zendesk.

    Zendesk login page opens.

  23. Log in to Zendesk.

    A checkmark will appear if the connection was successful. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

  24. Enter the Sitecore URL, including the protocol.

  25. Enter the WordPress site URL.

    Example: If your WordPress admin page URL was http://blog.phrase.com/wp-admin/index.php, the site URL would be http://blog.phrase.com/.

  26. Enter the Phrase WordPress plugin token with the token from Phrase plugin configuration.

  27. If the site is secured using basic HTTP authentication, provide Username and Password as set in WP admin.

  28. Enter the host of the TYPO3 CMS, including the protocol (e.g. http://phrasedemo.com/typo3-v8), in the Host field.

  29. Enter the Phrase Connector Token in the Token field.

  30. Provide SharePoint site URL.

    Depending on setup:

    • hostname (e.g. https://james007.sharepoint.com/)

    • includes /sites/<my-site-name>/ (e.g. https://james007.sharepoint.com/sites/skyfall/)

  31. Provide the connection string.

  32. Provide the following information:

    • Marketo API key

      Enter Marketo Client ID.

    • Marketo API secret

      Enter Marketo Client Secret.

    • Marketo API identity URL

      Enter the first part of the Marketo Identity URL

    • If requested by Technical Support team, select Log debug information.

    • Create translations options:

      • If not using language-specific segmentation to store target translations, select as separate documents.

      • If using language-specific segmentation, select as segmented dynamic content, and click Test connection.

        Provide Segmentation name and mapping requirements from the dropdown lists and indicate which segment contains the source content.

    • Select Translate tokens to include tokens in translation.

  33. Enter the Magento site URL (including the protocol) and the Phrase plugin token.

  34. Enter the Kentico URL.

  35. Enter the Username and Password.

  36. Select the Source Language.

    Source language must match the default language in Sitecore.

  37. Select the Sitecore Database to connect to. If not using the default database, provide the Custom Database Name.

  38. Select the Source Language.

  39. Enter the Host including the protocol (e.g. https://example.org/).

  40. Paste the token from Joomla into the Token field.

  41. Click Connect to HubSpot.

    HubSpot login page opens.

  42. Paste the API key into the Help Scout Docs API key field.

  43. In the Help Scout Target Collection field, type the name of an existing Help Scout collection or the name of a collection to be created.

    New collections appear in the collection list of the Help Scout account.

  44. Click Connect to Google Drive.

    A Google authentication screen will appear where you can select your account.

  45. Enter GitLab site URL (e.g https://gitlab.com/) and the GitLab personal access token you have obtained from the GitLab site.

    • In order to access the repository, it must be accessible from the Internet.

  46. Click Connect to GitHub. A popup window or a new tab will appear requesting authorization.

  47. Enter the repository address into the Repository URI field.

    • The repository address is the connection string used to clone the repository (e.g. git@gitlab.com:joe.doe/my-repo.git)

    • In order for to access the repository, it has to be reachable from the Internet.

  48. Provide the following information:

    • Host name. Does not include the protocol (e.g. files.example.com).

    • Port number (Default setting is 21).

    • FTP Username.

    • FTP Password.

    • Select an encryption preference.

  49. Provide the following information:

    • Host name. Does not include the protocol (e.g. files.example.com).

    • Port number (default setting is 22).

    • SFTP Username.

    • SFTP Password.

    • SSH key.

      Only legacy PEM private key format is supported when using the SSH key for authentication. Use the -m PEM option when generating the SSH key with ssh-keygen.

    • SSH passphrase.

  50. Select an Authentication method.

    • For Password access enter the Username and Password or Personal Access Token, if basic authentication is not supported (e.g. GitHub).

      • If using password access, the Repository URI starts with https:// (e.g. https://github.com/joe.doe/my-repo.git).

      • The personal access token needs to have appropriate read/write rights.

    • For Private key access load the Private key and optionally enter the Private key passphrase.

      • If using a private key, the Repository URI starts with git@.

      • Only legacy PEM private key format is supported when using the private key for authentication. Use the -m PEM option when generating the private key.

  51. Select Authentication method.

  52. Select Contentstack Region according to the location of the data centers where the organization's data resides.

  53. If using Management token authorization, enter Stack API key and Management token obtained from the Contentstack site. If using User's Authtoken, enter the Username, Password, and the API key.

  54. Apply Translate URL and Translate tags options if required.

  55. Provide Translate to languages specified in (APC).

    Automated Project Creation will only create jobs for languages specified by codes in the given field that is specified by a unique ID (e.g. target_languages). Codes can be followed by language names as long as they are separated by a comma (e.g. de-DE German (Germany)).

    Language codes are case insensitive and can use either _ or formatting - (e.g. de_de, de-de, de-DE).

    Note

    To select target languages on the content item level, create a new Taxonomy Group (Content Model > Taxonomies) within the selected Kontent Project ID. The newly created group (e.g. Target Languages) should contain the language codes of all localization languages configured in the selected project. Add the configured taxonomy group to all or selected content models as a supporting element. Once added, the codename can be obtained.

  56. Provide Non localizable block fields if required.

    Specified block fields UIDs will not be imported. Separate multiple UIDs by comma (e.g. UID1, UID2, UID3).

  57. Select Source language.

    This setting does not impact the default language in the project. The source language for the connector itself is language agnostic and any localization languages that are configured for a particular project can be used as the source language for the connector.

    If using Kontent with multiple source languages, set up multiple instances of the connector with different source languages configured in this field.

  58. Click Connect to Dropbox.

    A popup window or a new tab will appear requesting authorization.

    • If successful, a small checkmark appears next to the Connect to Dropbox button.

    • If the connector becomes invalid, a red exclamation mark will be displayed and the Dropbox connector’s edit dialog will show a Re-authenticate button that is used to re-establish the connection.

      Reasons for invalidation:

      • The authorization token expires after a long period of inactivity.

      • Users revoke access.

      • Users change their credentials.

  59. Click Test connection.

    • If successful, a small checkmark appears next to the Test connection button.

  60. Select how to process nested content. Content can use a reference field to reference other content allowing the creating a hierarchy of entities.

    • Contentful (Entry-Level)

      The entry-level connector automatically traverses the entire hierarchy of nested content.

    • Contentful (Field-Level)

      Select how the field-level connector should import nested content.

      • Selected entry only

        • Content that is explicitly selected when adding from the repository is imported.

        • Changes detected by APC are imported for translation.

      • Import referenced entries

        • The connector traverses the entire hierarchy of nested content and imports all translatable fields for translation.

  61. Select Use fallback Language if data is missing for a particular field in the source language.

    Select a Source Language fallback from the dropdown list if required. This language locale will be used in the case of missing data.

    Note

    There is no relationship between the Contentful fallback language and this setting.

  62. If logging of debug information is requested by Technical Support team, select Log debug information.

  63. Click Connect to Contentful.

    A checkmark will appear in the connector setup if the connection was successful. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

  64. Click Connect to OneDrive.

    If successful, a small checkmark appears next to the Connect to OneDrive button. A red exclamation point appears if it isn't. Mouse over the icon to see additional details.

  65. Click Connect to SharePoint.

    A popup window or a new tab will appear requesting SharePoint authorization.

  66. Click Connect to Salesforce.

    A checkmark will appear if the connection was successful. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

  67. Contentful (Entry-Level) only:

    Set the Source language.

    Note

    This language should match the Default locale of the Contentful space that's configured in Contentful's Locales settings.

  68. Click Connect to Bitbucket.

    A popup window or a new tab will appear requesting authorization.

  69. Click Connect to Box.

    A popup window or a new tab will appear requesting authorization.

  70. Enter the server host address into the Host field and the Bitbucket personal access token obtained from the Bitbucket server site.

  71. Click Test connection.

    A checkmark will appear if the connection was successful. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

    Contentstack workflows can be selected.

  72. Provide a Commit message if required.

  73. Click Test connection.

    A checkmark will appear if the connection was successful. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

  74. Select Contentstack workflows.

    • Translate articles from:

      The connector monitors articles in the selected stage (e.g. Translate). The author can apply this label to articles when ready for translation.

    Upon import from Contentstack:

    • Set source articles to

      The connector advances the workflow to the selected stage (e.g. Translation in Progress) when the source articles are downloaded.

    Upon export to Contentstack:

    • Set source articles to

      The connector sets the workflow stage of the source articles to the selected stage (e.g. Translations Completed) when the translation is exported.

    • Set translated articles to

      The connector sets the workflow stage of the article translations to the selected stage (e.g. Translation ready for Review) when the translation is exported.

  75. If not verified in the previous step, click Test connection.

    A checkmark will appear if the connection was successful. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

  76. Click Test connection.

    A list of configured languages will appear if the connection was successful. A red exclamation point will appear with an error message if it wasn't. Mouse over the icon to see additional details.

    If the source or target is changed, clicking Test connection will refresh the selection of configured languages.

  77. Enter the source language. TYPO3 will not store this information.

  78. Select the Website, Store, and Source store view.

  79. Log in to HubSpot and select an account.

    A checkmark will appear in the connector setup if the connection was successful. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

  80. Choose how the target files are to be organized in HubSpot:

    • As multi-language groups - the translated pages are linked to the master page and form a language group. This option is supported for only Landing and Website pages. For more information, see HubSpot documentation.

    • As separate documents - the translated pages are stored as siblings. Language code appended to their internal page name differentiates the individual translations (e.g., Homepage vs. Homepage [de]).

  81. Select publication status of translations.

  82. Click Test connection.

    • For a Basic or Standard Help Scout account, a message will appear to confirm the connection to the single site on Help Scout.

    • For a Plus Help Scout account, a list of multilingual sites will be displayed. Select the language of each site from the drop-down lists and which site will be the source for the translation.

  83. Click on Allow.

    A checkmark will appear in the connector setup if the connection was successful. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

  84. Click the Next button.

    If successful, the window/tab will disappear and a small checkmark appears next to the Connect to Sharepoint button. A red exclamation point will appear if it wasn't. Mouse over the icon to see additional details.

  85. Set the Source Language.

    • This language must match the Source language of the project and should match the Primary language of the HubSpot site that's configured in HubSpot Domains & URLs settings.

  86. Click the Authorize Phrase button.

    If successful, the window/tab will disappear and a small checkmark appears next to the Connect to Bitbucket Connect to GitHub button.

  87. Click on Grant access to Box.

    If successful, the window/tab will disappear and a small checkmark appears next to the Connect to Box button.

  88. Enter the Host.

    Use the host address of the Adobe Experience Manager installation (e.g., https://aem-author.example.org/ or https://author-X-Y.adobeaemcloud.com/).

    The domain name must be resolvable externally (not an intranet domain).

  89. Enter the Host.

    Use the host address of the Drupal installation (e.g., http://drupal-9.kos.phrase.com/).

    The domain name must be resolvable externally (not an intranet domain).

  90. Enter the Username and Password.

  91. To modify links contained in page HTML, provide URL rewrite rule in regexp.

    Example:

    To replace a full locale code with just the language code in https://example.org/en-us/images/sample.jpg, find /([a-z]{2})-[a-z]{2}/ and replace it with /$1/.

    Links in the tags <img src="" data-lazy-src="", <link href="", <script src="", <iframe src="" and links in CSS styles and referenced CSS files (url: ('')) will be rewritten.

  92. Select Kontent workflows.

    By configuring workflows for a Kontent Project, the workflow can be tuned to provide localization when needed. Kontent workflows are configured for each project individually. By setting the Delivery API Key (Project ID) in the connector configuration, only the remote workflow steps for the specified project ID are displayed.

    • Translate articles from:

      The connector monitors articles in the selected stage (e.g. Translate). The author can apply this label to articles when ready for translation.

    Upon import from Kontent:

    • Set source articles to

      The connector advances the workflow to the selected stage (e.g. Translation in Progress) when the source articles are downloaded.

    Upon export to Kontent:

    • Set source articles to

      The connector sets the workflow stage of the source articles to the selected stage (e.g. Translations Completed) when the translation is exported.

    • Set translated articles to

      The connector sets the workflow step of the article translations to the selected stage (e.g. Translation ready for Review) when the translation is exported.

  93. Click Save.

    The connector is added to the list on the Connectors page.

  94. Edit the connector to select Contentful workflows.

    • Translate articles from:

      The connector monitors articles in the selected stage (e.g. Translate). The author can apply this label to articles when ready for translation.

    Upon import from Contentful:

    • Set source articles to

      The connector advances the workflow to the selected stage (e.g. Translation in Progress) when the source articles are downloaded.

    Upon export to Contentful:

    • Set source articles to

      The connector sets the workflow stage of the source articles to the selected stage (e.g. Translations Completed) when the translation is exported.

Configure In-Context Preview

The In-context Preview feature offers a real-time preview of original or translated text in both the CAT web editor and CAT desktop editor.

In order to offer the real-time preview, Phrase it must have access to unpublished pages in an on-premise author node.

Phrase Requirements:

  • Pass through the enterprise firewall to access the on-premise installation.

  • Authenticate into the authoring environment.

Firewall Configuration for On-premise installation:

  • Installation must be accessible from the following IP addresses:

    34.243.87.13, 34.248.197.209, 108.129.22.31, 3.248.158.93

  • Domain name must be able to be resolved externally.

Note

Some HTML tags present a risk and the CAT editor removes them from this HTML when displaying the preview. This is to ensure user's data privacy and security.

Examples of removed tags include FORM, IFRAME, SCRIPT, SVG, VIDEO, EMBED, OBJECT or background-image CSS properties.

Using Phrase with TMGMT

To use Phrase with TMGMT, follow these steps:

  1. Install the TMGMT module on the Drupal site.

  2. Install the Phrase Translation Plugin for TMGMT available here.

Once installed, the Phrase Plugin will be available in the list of providers.

Use Drupal/WordPress XLIFF as the File Type in the Project Template used with Drupal plugin.

Add Phrase as a Translation Provider to Drupal 7

  1. Log into the Drupal 7 account with the TMGMT plugin installed.

  2. Navigate to Configuration and click Translation Management Translators under the Regional and language section.

    The Translation Management Translators screen opens.

  3. Click on Add Translator.

  4. Add a label name and description.

  5. Under the Translator plugin, select Phrase Connector for Drupal.

    Phrase specific settings are displayed and the Phrasee Home URL field is pre-populated with https://cloud.memsource.com/web.

  6. Enter Phrase username and password.

  7. Optional: Specify Remote Languages Mappings.

    This allows the mapping of languages with ones available on the site (as configured in Languages under the Regional and language section).

  8. Click Save translator.

    Translator configuration is created.

Translate Content in Phrase - Drupal 7

  1. In the Drupal account, click the Translation menu item and select the Sources tab.

  2. Check the checkbox next to the content to be translated.

    Note

    If document not visible, verify document language is set to source language.

  3. Click Request translation button.

  4. Choose the target language.

  5. In the dropdown list, under Translator, select the Phrase configuration.

  6. Wait for the Checkout settings to load and choose your Project template.

    Note

    Only project templates that match your source language and include all target languages are listed.

  7. Click Submit to translator.

    Translation project is created in Phrase based on the chosen project template.

  8. Wait for the translation to complete in Phrase.

  9. Click the Translation menu item and on the Jobs tab select the document that has been completed.

  10. Click the manage link for the given document.

  11. Click the Pull translations button.

    Translations are received back from the Phrase project.

  12. Review if necessary.

  13. After review, publish the translations.

Add Phrase as a Translation Provider to Drupal 8/9

  1. Log into Drupal 8/9 account with the TMGMT plugin installed.

  2. Navigate to Translation and click Providers.

    Providers screen opens.

  3. Click on Add provider.

  4. Add a label name and description.

  5. Under Provider plugin, select Phrase.

    Phrase specific settings are displayed and the Phrase Home URL field is pre-populated with https://cloud.memsource.com/web.

  6. Enter Phrase username and password.

  7. Click Connect.

    Connection is established

  8. Optional: Specify Remote Languages Mappings. This allows the mapping of languages with ones available on the site (as configured in Languages under the Regional and language section).

  9. Click Save.

    Provider is created

Translate Content in Phrase - Drupal 8/9

  1. In the Drupal account, click the Translation menu item and then Sources.

  2. Check the checkbox next to the content to be translated.

    Note

    If document not visible, verify document language is set to source language.

  3. Choose the source and target languages and click Request translation.

    The Job overview page opens.

  4. Select the Phrase configuration as the Provider.

  5. In the Checkout Settings, specify the Project template to be used (if any) and the Due Date.

    • Only project templates that match the source language and include all target languages are listed.

    • The Due Date represents EOD and is converted to the Phrase user's timezone.

    • Select both Group all translation jobs in a single Phrase project and Submit all # translation jobs with the same settings to group all target languages into a single project.

  6. To order the translation, click Submit to provider.

    Translation project is created based on the chosen project template.

  7. Wait for the translation to complete.

  8. Click the Translation menu item and on the Jobs tab select the completed document.

  9. Click the Manage button for the given document.

  10. Click the Pull translations button.

    Translations are received back from the project and the job status is changed to Delivered.

  11. Review if necessary.

  12. After review, publish the translations.

Was this article helpful?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.