We've launched a new support center at help.smartling.com. This site will continue to be maintained into January 2017. Please update your bookmarks.

Adobe AEM Classic Connector Installation and Configuration

The following article applies to CMS Connector project types. 

The Smartling Adobe AEM Classic Connector allows you to submit content for translation and automatically download the content to Adobe AEM once translations are complete.

Before you use Adobe to create and manage translation submissions to Smartling, you must install and configure the Connector


The Classic Connector is compatible with Adobe AEM Versions 5.6, 6.0 and 6.1.

Java version 1.7 or higher must be installed.


To make the content available to Adobe AEM, first upload the Connector package, then install and verify the Connector.

To make sure you have the latest version, download the Connector package from the Connectors page in the Smartling Dashboard.

To upload the Smartling adpater package:

  1. At the Adobe AEM home page, select Packages.


  2. Click Upload Package.


  3. In the Upload Package dialog box, type the file name or click Browse and select the package and then click OK.


    If a package with this name already exists select Force Upload to overwrite the existing package.

To install the Smartling Package:

  1. In the Package Manager browse to the group for the Smartling_adapter package and click Install.

    A dialog requests confirmation and lists all the changes.
  2. Click Install.


    The Activity Log displays the changes.
  3. When the installation is complete, the package displays with a Last Installed date.


Verifying Installation

After installing the package open the Web Console Bundles and verify that the Smartling Translation Service is running.

  1. Open OSGi>Bundles in the AEM Web Console (for example, <adobecqdomain>/system/console/bundles).

  2. Search for the word Smartling and verify that service is active.

  3. Open OSGI>Configuration in the Adobe AEM Web Console (for example, <adobecqdomain>/system/console/consfigMgr), verify that Smartling – Translation Download Service is defined.

Uninstalling Packages

Adobe AEM ets you uninstall packages. Uninstalling removes the contents of the package and returns Adobe AEM to the package previously installed.

  1. In the Package Manager navigate to group that contains the Smartling_adpater package you want to uninstall.
  2. Click the package name.

  3. From the More menu, select Uninstall.


    A dialog will request confirmation and list the changes.


Adobe stores metadata, scripts, and all other page components as content so you need to define a page's properties to send for translation.

To configure Adobe AEM Component Property Mapping:

  1. Browse to the Websites portal and under Smartling, double-click Property Mappings.

  2. Double-click Properties under the first Resource Type entry.

  3. In the Form Field Configurations dialog, Add or delete the Property Names that you want Adobe to submit to the Smartling Translation Server and click OK.

Note: One of the default “Property Configuration” components on this page contains a “*” for it’s Resource Type. DO NOT edit this component instance. The “*” tells the system that by default all Resource Types will automatically include the properties defined in that component.

Configuring Smartling Project for Adobe AEM

Work with Smartling to setup a project for each locale you plan to translate using Adobe AEM.

Once you have a project for each locale, obtain the Smartling API key and Project ID at Settings > API.

To configure the project ids and Smartling api key:

  1. Browse to the Websites portal and, under Smartling, double-click Project Configuration.

    The Smartling Configuration page contains information such as project id, api key, and language/locale mappings to each of your language sites.


  2. For each of your language sites that you plan to translate, click Add, and complete the required fields.
  3. On the General Settings tab, configure Name, Project Id, User Identifier, User Secret, Callback URL, and Retrieval Type. See our API documentation for help obtaining a User Identifier and User Secret.

  4. On the Adobe CQ settings tab, configure Source Path, Source Locale, Target Info (Target Path, Adobe CQ Locale, Smartling Locale).

    For example, to submit pages under /content/geometrixx/en for translation to the fr_fr and de_de site, you need to:
    a) Specify the Source Locale as English
    b) Under Target Path, create two items:
    The first item for the French site is Target Path = /content/geometrixx/fr, Adobe CQ Locale = French (France) and Smartling Locale = fr-FR (optional)
    The second item for the German site is Target Path = /content/geometrixx/de, Adobe CQ Locale = German (Germany) and Smartling Locale = de-DE (optional)
  5. To provide Context for uploaded content, configure the Content proxy settings tab as follows:
    CQ server URL - Domain name of your author server. This must be a 'http://' URL, 'https://' is not supported.
    login/password User info with access to browse the page
  6. Verify your settings by clicking Test Connection.

  7. Click OK, and Adobe adds the configuration.

To edit, delete or clone a configuration:

  • You can edit, delete or clone an existing configuration by right-clicking on the row.

Context Configuration

The Adobe AEM Classic connector can provide translation context for your content. Only one Connector (AEM instance) can provide context to each Smartling project. If you need to use context on multiple CQ instances (for example, development, quality assurance and/or staging servers), use a different Smartling ProjectId + ApiKey for each. This only applies for providing context and doesn't limit uploading content from different AEM instances into single Smartling project.

To configure context: 

  1. In Web console, open Components (/system/console/components)
  2. Find the context component: com.smartling.proxy.context.connection.ContextGateway.
  3. By default the component is disabled. Enable the component.

Managing Context Connections

  • Open /etc/smartling/admin/context-connections.html
    By default all connections are Active.

    You can now submit pages for translation and Smartling will automatically capture context.

Proxy Configuration

If you are using a proxy with your AEM instance you may need to do some additional configuration, depending on how your Proxy is set up.

Standard Java Proxy

If you start your AEM instance using a standard java https.* proxy, as documented here, Smartling will automatically pick up your proxy settings and work with them. However, we do not support authentication with this method. If you require authentication with a username/password, consider setting up your proxy inside your AEM configuration.

Proxy configured from AEM

If you have set up your proxy from the AEM Web Console, you can add your proxy details to the Smartling - Network Settings entry in the console. Specify the host and port for the proxy and, if required, authorization credentials.

Additional Smartling Configuration

The Smartling Adobe AEM Classic connector provides some additional configuration settings.

Configure custom placeholders

By default, the Connector captures and masks any placeholders used by the java MessageFormat, so translators.

If you want to mask other blocks of your content, you can use a Java Regular Expression to define content that should be captured as a placeholder. Add your Regular Expression in the Web Console in the Smartling - Translatable Content Configuration component Depending on your version, this component may be called XML File Generator instead.

Note: It's best to do this as you do your initial setup. If you change this setting once you have started translating, it may change how your strings are captured and cause you to need to redo translations.

Make dictionary strings unique

By default, Smartling treats strings captured by the connector as being 'shared'. If you capture the same string twice, only one string will be created in your Smartling project and the translation applied in both places. In some cases, you may want to apply different translations to the same source string, if it appears in different contexts. If you need to do this, check Unique strings in the Smartling - Translatable Content Configuration component.

Note: Take some time when you set up your project to work out if you need Unique Strings. If you check this box after you have begun translating, each string will be created again in your Smartling project and you may lose translations. If this happens, you can use SmartMatch to apply existing translations to your new strings.

Set up an Account for Saving Translated Content

You can choose the account that will be used for saving translated content from Smartling. This can help you identify changes made by the Smartling connector.

  1. Open Configuration in Web console (/system/console/configMgr)
  2. Find Smartling - Translation Processor
  3. Provide account details.



Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Powered by Zendesk