AEM Classic Connector

AEM Classic Connector Installation and Configuration

The following 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.

Requirements

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.

Installation

To make the content available to Adobe AEM:

  • Upload the connector package
  • Install and verify the connector

To make sure you have the latest version, download the connector package.

Upload the Smartling Adapter Package

  1. Select Packages from the Adobe AEM home page.
    packagess.png
  2. Click Upload Package.
  3. In the Upload Package dialog box, type the file name or click Browse, and select the package. Click OK.
    upload_package.png

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

Install the Smartling Package

  1. In the Package Manager browse to the group for the Smartling_adapter package and click Install.
    install.png
    A dialog requests confirmation and lists all of the changes.
  2. Click Install. The Activity Log displays the changes.
    install_pack.png
  3. When the installation is complete, the package displays with a Last Installed date.
    last_installed.png

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.
    aem_web_config.png
  2. Search for the word "Smartling" and verify that the service is active.
    aem_bundles.png
  3. Open OSGI > Configuration in the Adobe AEM Web Console. For example, <adobecqdomain>/system/console/consfigMgr, verify that "Smartling – Translation Download Service" is defined.
    smartling.png

Uninstalling Packages

Adobe AEM lets 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 the group that contains the Smartling_adpater package you wish to uninstall.
  2. Click the package name.
    smartling_ui.png
  3. From the More menu, select "Uninstall".
    smartlingUI2.png

A dialog will request confirmation and list the changes.

Configuration

Adobe stores metadata, scripts, and all other page components as content, therefore you will need to define page properties and parser types to send content for translation.

We don't describe what Parser means. Add somewhere what's the difference between HTML vs Plain text. Probably we can add link to our parsers documentation. Or at leas mention that HTML parser may additionally escape invalid html entities (like &, <, >, ")

Configure Adobe AEM Component Property Mapping

  1. Go to the Websites portal > Smartling > Property Mappings.
    aem.png
    • Select Open in Classic UI if the AEM Classic Connector was installed with AEM 6.1+.
      open_classic.png

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

  3. In the Form Field Configurations dialog box, add or delete the Property that you want Adobe to submit to Smartling. It’s possible to select Parser Type for each Property (HTML by default). Then click OK.
    prop_filter.png

    One of the default Property Configuration components on this page contains a “” for its 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.

  4. To create the component for your Custom Resource Type, drag and drop the Property Filter component from the sidekick to the Property Mapping page.
    resource_type2.png
    • To successfully create the Property Filter component, fill out the Sling Resource Type field with the resource type of content you want to translate. Select Properties are for asset for Digital Asset content. Add Property Parser for each resource property you want to translate: Enter the text field with the property name and select parser type to process it for translation.
      prop_filter2.png
  5. The Path-Based Filter component is used to translate content trough "Advanced Node Translator". Drag and drop the Path-Based Filter from the sidekick to the Property Mapping page to create it.
    path_based.png
    • Path field configures the path to translatable content. Property names are an array of node properties which are excluded from translation.
      path_field_config.png

Configuring a Smartling Project for Adobe AEM

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

Once you have created a project for each locale, make note of the Smartling API key and Project ID from within the Smartling Dashboard > Settings > API.

Configure the Project IDs and Smartling API Key

  1. Browse to the Websites portal. Under Smartling, double-click Project Configuration.
    project_config.png

    The Smartling Configuration page contains information such as project ID, API key, and language/locale mappings to each of your language sites.
    smartling_config.png

  2. For each of your language sites that you plan to translate, click Add, and complete the required fields. Configurations have different types according the types of site content.

  3. In 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.
    general_settings.png

  4. In the Adobe CQ settings tab, configure: Source Path, Source Locale, Target Info (Target Path, Adobe CQ Locale, and Smartling Locale).
    adobe_cq.png

    For example, to submit pages under /content/geometrixx/en for translation to the fr_fr and de_de site, you need to:
    • Specify the Source Locale as English.
    • 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://' or 'https://' URL.
    • login/password: User info with access to browse the page.
      edit_config.png

  6. Verify your settings by clicking Test Connection.
    test_connection.png

  7. Click OK on the Edit Configuration dialog box. Adobe will add the configuration.

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 project ID + API key for each. This only applies for providing context and doesn't limit uploading content from different AEM instances into a single Smartling project.

Configure Context

  1. In the web console, open Components (/system/console/configMgr).
    context_preview_settings.png
  2. Find the context component: Smartling - Context Preview Settings. No defaults are provided. An AEM Administrator must explicitly configure the Context Preview Settings.

Managing Context Connections

Open /etc/smartling/admin/context-connections.html. By default, all connections are active.

context_connections2.png


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.

network_settings.png

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, to 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.

translatable_content_config.png

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.

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

translatable_content_config2.png

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 the web console (/system/console/configMgr).
  2. Find Smartling - Translation Processor.
  3. Provide account details.

setup.png

Was this article helpful?