Configure the Translation Integration configure-integration

Learn how to connect AEM to a translation service.

The Story So Far story-so-far

In the previous document of the AEM headless translation journey, Get started with AEM headless translation you learned how to organize your headless content and how AEM’s translation tools work and you should now:

  • Understand the importance of content structure to translation.
  • Understand how AEM stores headless content.
  • Be familiar with AEM’s translation tools.

This article builds on those fundamentals so you can take the first configuration step and set up a translation service, which you will use later in the journey to translate your content.

Objective objective

This document helps you understand how to set up an AEM integration to your chosen translation service. After reading you should:

  • Understand the important parameters of the Translation Integration Framework in AEM.
  • Be able to set up your own connection to your translation service.

The Translation Integration Framework tif

AEM’s Translation Integration Framework (TIF) integrates with third-party translation services to orchestrate the translation of AEM content. It involves three basic steps.

  1. Connect to your translation service provider.
  2. Create a Translation Integration Framework configuration.
  3. Associate the configuration with your content.

The following sections describe these steps in more detail.

Connecting to a Translation Service Provider connect-translation-provider

The first step is to choose which translation service you want to use. There are many choices for human and machine translation services available to AEM. Most providers offer a translator package to be installed. See the Additional Resources section for a selection of options available.

The translation specialist is generally responsible for choosing which translation service to use, but the administrator typically is responsible for installing the required translation connector package.

For the purposes of this journey, we use the Microsoft Translator which AEM provides with a trial license out-of-the-box. See the Additional Resources section for more information about this provider.

If you choose another provider your administrator must install the connector package as per the instructions provided by the translation service.

Using the out-of-the-box Microsoft Translator in AEM does not require additional setup and works as-is without additional connector configuration.
If you choose to use the Microsoft Translator connector for testing purposes, you do not need to carry out the steps in the next two sections: Creating a Translation Integration Configuration and Associate the Configuration with Your Content. However you are advised to read them so that you are familiar with the steps for when you need to configure your preferred connector.
The trial license of the Microsoft Translator connector is not intended for production purposes and if you decide to license it, the system administrator must follow the steps detailed in the Additional Resources section at the end of this document so you can configure that license.

Creating a Translation Integration Configuration create-config

After the connector package for your preferred translation service is installed, you must create a Translation Integration Framework configuration for that service. The configuration includes the following information:

  • Which translation service provider to use
  • Whether human or machine translation is to be performed
  • Whether to translate other content that is associated with the Content Fragment such as tags

To create a translation configuration:

  1. In the global navigation menu, select Tools > Cloud Services > Translation Cloud Services.

  2. Navigate to where you want to create the configuration in your content structure. This is often based on a particular project or can be global.

    • For example, in this case, a configuration could be made globally to apply to all content, or just for the WKND project.

    Translation configuration location

  3. Provide the following information in the fields and then select Create.

    1. Select Configuration Type in the drop-down. Select Translation Integration from the list.
    2. Enter a Title for your configuration. The Title identifies the configuration in the Cloud Services console and in page property drop-down lists.
    3. Optionally, type a Name to use for the repository node that stores the configuration.

    Create translation configuration

  4. Select Create and the Edit Configuration window appears where you can configure the configuration properties.

  5. Remember that Content Fragments are stored as assets in AEM. Select the Assets tab.

Translation configuration properties

  1. Provide the following information.

    1. Translation Method - Select Machine Translation or Human Translation depending on your translation provider. For the purposes of this journey we assume machine translation.
    2. Translation Providers - Select the connector you installed for your translation service from the list.
    3. Content Category - Select the most appropriate category to better target the translation (only for machine translation).
    4. Translate Content Fragment Assets - Check this to translate assets associated with Content Fragments.
    5. Translate Assets - Check this to translate the assets.
    6. Translate Metadata - Check this to translate asset metadata.
    7. Translate Tags - Check this to translate tags that are associated with the asset.
    8. Auto-Execute Translation - Check this property if you want translations to be automatically sent to your translation service.
    9. Disable Update-Only Translation - When this option is checked, updating the translation project will submit all translatable fields for translation, not just the ones changed since last translation. Updating your translation project is discussed later in the journey.
    10. Enable Content Model Fields for Translation - Check this option so the translation configuration automatically recognizes fields in the Content Models based on the Translatable flag.
  2. Select Save & Close.

You have now configured the connector to your translation service.

Associate the Configuration with Your Content associate

AEM is a flexible and powerful tool and supports multiple, simultaneous translation services via multiple connectors and multiple configurations. Setting up such a configuration is beyond the scope of this journey. However this flexibility means that you must specify which connectors and configuration should be used to translate your content by associating ths configuration with your content.

To do this, navigate to the language root of your content. For our example purposes this is

  1. Go to the global navigation and go to Navigation > Assets > Files.
  2. In the assets console, select the language root to configure and select Properties.
  3. Select the Cloud Services tab.
  4. Under Cloud Service Configurations in the Add Configuration drop-down list, select your connector. It should appear in the drop-down list when you have installed its package as described previously.
  5. Under Cloud Service Configurations in the Add Configuration drop-down list, also select your configuration.
  6. Select Save & Close.

Select cloud service configurations

What’s Next what-is-next

Now that you have completed this part of the headless translation journey you should:

  • Understand the important parameters of the Translation Integration Framework in AEM.
  • Be able to set up your own connection to your translation service.

Build on this knowledge and continue your AEM headless translation journey by next reviewing the document Translate content, where you learn how to use your configuration so far to actually translate your content.

Additional Resources additional-resources

While it is recommended that you move on to the next part of the headless translation journey by reviewing the document Configure translation rules the following are some additional, optional resources that do a deeper dive on some concepts mentioned in this document, but they are not required to continue on the headless journey.