SDL Connector for AEM · test plans Supported Versions SDL Connector for AEM 1.1.3 SDL Managed Translation with SDL TMS 11.2+ AEM 6.5.2 Checklist To complete the SDL Connector setup,

SDL Connector for AEM

Administrators Guide January 2020

Version History

Document Name Approver Version Date Notes Administrator Guide Nigel Watson Draft 01 Nov 2019 Initial draft Administrator Guide Dept Draft 10 Dec 2019 Development Review Administrator Guide v11 Nigel Watson 11 13 Dec 2019 For Pre-Release Administrator Guide v13 Nigel Watson 113 10 Jan 2020 Final Release Includes support for

old connector in upgrade process

CONFIDENTIAL 3 Administrator Guide v113

Document Control 2

Version History 2

Before you Begin 4

Supported Versions 4 Checklist 4 Installation Prerequisites 4

Solution Overview 7

System Integration 7 AEM User Experience 8

Features amp Functionality 12

Configurable Functions amp Features 12 Front-End Features 14 Back-End Functions 18 Custom Function amp Features 20 End to End Workflow 21

Configure SDL Translation Management 22

SDL TMS Preparation 22 SDL Connector Service Account 22 Setup Components 23 Adding a File Type for AEM Content 24 Create the Configuration 25 Translation Preview 25

Configure AEM 27

Install in AEM Package Manager 27 Setting Cloud Configurations 27 Language Mappings 30 Configure AEM Translation Integration 31

Troubleshooting 34

Known Limitations 34 Error MessagesLog Files 34

About SDL 35


This admin guide will guide you through the new SDL connector solution for AEM its features functionality and how to install and setup

1 Solution Overview ndash general overview of the connector its features and usability 2 Features and Functionality ndash detailed description of how the connector functions for the end

user and within the systems it is connecting 3 Configure SDL and AEM ndash detailed instructions on installation and setup of AEM SDL and the

connector requirements 4 Troubleshooting ndash information for support teams on known issues how to triage issues and

test plans

Supported Versions

SDL Connector for AEM 113

SDL Managed Translation with SDL TMS 112+

AEM 652

Checklist

To complete the SDL Connector setup the following items will need to be configured and setup This is a high level checklist to help identify the various teamsrsquo involvement to complete the integration SDL Account team for

SDL Managed Translation service account

SDL TMS organizationconfiguration setup AEM Admin Team

Service account for connector

Connector install and setup

Cloud Configuration setup

Installation Prerequisites

The connector requires certain instructions and processes to be followed during installation and setup failing to follow these will result in an incomplete installation Installing the connector requires an AEM admin with readwrite access to CRXDE and the Web Console OSGi

Clean install of the SDL Connector

If this is a new clean install of the SDL connector follow the instructions in this guide We recommend installing the connector into a testlocal instance first to ensure connection and functionality is correct before moving to staging and production environments


Upgrading to the new SDL Connector for AEM 65

Upgrading from previous versions of the SDL Connector is supported The old connector continues to function processing in-progress translation projects to completion and supporting a clean transition from one version to another without the need for a translation freeze When performing this upgrade the AEM admin must make the following changes to the ACL rules to allow compatibility of both connectors

1 Go to AEM console httplocalhost4502systemconsoleconfigMgr 2 Look for ACL Setup Service and click edit

3 In the list of rules that are already there add the following ones a allowjcrallsdl-read-write-system-usercontent b allowjcrallsdl-read-write-system-useretc c allowjcrreadsdl-read-write-system-userconf d allowjcrreadsdl-read-write-system-userapps e allowjcrreadsdl-read-write-system-userhome

Note Functionality for old projects is limited in the new Connector UI and these projects should be completed using the original AEM Projects flow For example the new connector uses more statuses than the previous one If a user in the new connector UI visualizes a project created using the old connector the project status will be unknown This is because the previous connector uses AEM statuses and is not compatible with the new status methods used in the new connector


Uninstalling old versions of SDL Connector

If you wish to uninstall the old connector before performing the upgrade you must fully uninstall the old connector before proceeding

1 Go to AEM Package Manager select the connector click Uninstall 2 Click delete

Check the connector has uninstalled correctly

3 Go to CRX|DE and open the apps folder a Check sdlmantra folder has been deleted

4 Go to systemconsolebundles and search for sdl a Check the SDL Connector Core Bundle has been deleted

5 Go to systemconsoleconfigMgr and search for user mapper a Check the service mappings in Apache Sling Service User Mapper Service and

Service Amendment for the translation-job-service have been deleted 6 Go to etccloudservicessdl-translation

a Check all Configurations are deleted

Future Upgrades of the SDL Connector

Once the new connector has been installed any future updates to new versions can be installed on top of the current version There is no requirement to perform uninstalls

AEM Projects Flow

The original AEM projects flow will still be functional with SDL Connector installed SDL do not recommend that users use both projects flows and should only use the SDL Connector once installed However users can go to the Projects area of AEM create a translation project and then manage it within the AEM Projects flow


System Integration

The SDL Connector for AEM builds on the earlier versions of SDLrsquos connector leverages some of the core components of the AEM Translating Integration Framework but extends the user experience in AEM providing a richer solution for translation project creation and management The connector benefits from a new scheduler and synchronization process for project status and retrieving translated items from SDL Error management and logging is improved for easier notification to users and triage for admin and support teams

System Functions

AEM Translation Integration Framework

Manages AEM language copies and launches

Manages AEM workflow

Cloud configurations

SDL Connector

Project overview screen for managing translation projects

Project wizard for creating translation projects

Polling scheduler to manage project status

Export and Import of files to and from translation

Language mapping between AEM and SDL

Validation for project creation and management

Error logging

Custom features

SDL MantraAPI

Authentication and communication with SDL Translation Management

SDL Translation Management

Management and Processing of translation projects data and documents

SDLConnector

AEM SDL Translation Management

Translation Integration Framework

SDL MantraAPI Configuration


AEM User Experience

The following user interfaces deliver the translation experience for the AEM user to create and manage their translation projects

Translation Project Overview

The Translation Overview page shows a list of all translation projects The table displays the project title description project status who created the project (AEM user account) project due date source and target languages translation project cost and total source word count Actions that can be performed on the project are shown dynamically depending on its status in the translation workflow

From this page the user can

View all translation projects with a toggle to show activecompleted projects

Sort the table columns

Filter projects by status Then search on that filter

Search for projects using free text search on Title Description and Created by fields

Action project for delete start approve reject a translation project

Create a new translation project

Open a translation project for more details (see next section)

Refresh the page to get the latest status updates


Translation Project Detail

The translation project detail page shows the details of each project including the created date and the cloud configuration There is an icon to show if the project has started the translation workflow Depending on the status of the project action buttons may appear at the top right of the page to action the entire project or inline with the languagefiles to action individual items


View all the details of the translation project

Action project for Start Delete when the project is in Draft status

Action the project for approve cancel when the project is in For approval status

Action the languages files for accept reject translation when the project or individual languages are at Ready for Review status


Export the project files


Create Project Wizard

The Create Translation Project wizard has three steps select content configure translation options and confirm request with the option to save the project or start the translation workflow

Page Selection


Select pages for translation and choose to include child pages

Select assets for translation

Add multiple pagesassets

Configure Translation



Add a name for the project limited to 50 characters

Add a description for the project limited to 255 characters

Options to auto approve translations promote translation launches and delete launches after promotion

Choose cloud configuration

Set a project due date

Choose single source and multiple target languages

Define where the translated content is located

Set custom attributes when configured

Confirmation Screen


View the details and options set for the project

View the pagesassets added to the project

Choose to Save or Start the translation project


Configurable Functions amp Features

There are several functions and features that are configurable during the setup of the SDL Connector Many of these are required on a one-time setup basis but some could be updated depending on changed to business processes such as adding new languages or new translation workflows

AEM Web Console Configuration

In the AEM Web Console there are functions that require configuration for the connector to communicate between AEM and SDL Once these settings have been configured use the below URL to check the configurations and get a confirmation message binv2mantraconfigurationcheck The response should show [HTTP_CODE200MESSAGECredentials tested

successfullyHTTP_CODE200MESSAGEThreads configuration tested

successfully]

Configuration Service This service requires an AEM user account to manage the connection and polling schedulers between AEM and SDL Create this account in your AEM instance and enter the credentials as requested in the fields below

The Threads available is a configurable option to set multi-threading in the connector - how many concurrent project processes you wish the connector to process If you have large or multiple projects on a regular basis increasing this number will provide a better user experience when creating projects Note The default setting is 4 but if you have a slow performing AEM server (ie using a localhost instance) you should set the threading to 1 to prevent erroneous status messaging from the connector

Pull Status Scheduler The pull status scheduler is a configurable expression to set the frequency at which the connector polls SDL for project status The default setting is every 5 minutes The user has a refresh button in the UI if they wish to poll instantly for an update


Update Configs scheduler The update configs scheduler checks for new configurations created in AEM in order to update the create project wizard picklists and custom functionality for auto cloud config detection The default is set to 3 days

Project Title Prefix Note the Project Title Prefix Service is described in the custom features section below

Group and Permission Setup

The following AEM paths allow an admin to setup user access to the SDL connector and if required restrict access to both see and use the connector

appscqcorecontentnavsdl-translator appssdl-connector etcsdlconnectoroverview contentprojectssdl

Language Mapping

The SDL Connector has two functions related to language mapping The first is a language title mapping taking the language code in AEM and a friendly name for the user in the SDL Connector interface This is set in appssdl-connectorconfigcontentxml Language title will be presented using the following structure ltlanguageTitlegt (ltlanguageMappinggt) For example the language code ru-uk would display Ukrainian (ru-uk) to the user nl-be would display Dutch (nl-be) Language codes used in the connection between AEM and SDL can be set and configured if required By default language codes are deployed as part of the connector installation and can be found in appssdl-connectorconfiglanguagemapping


To change a code used in AEM edit the node in the left-hand menu under languagemapping node To change the code used in AEM edit the language mapping property on the right-hand side A typical example would be changing the SDL used code from FR to fr-FR if using the language culture codes instead of the default language code in the SDL system

Context Preview Package The SDL Connector supports the sending of preview packages as created by the AEM Translation Integration Framework These packages are created on-the-fly by AEM during the project creation process and delivered via the connector to SDL for preview in the translation environment Setup instructions are included in the Configure SDL Translation Management section

Front-End Features

There are several features available to the user during the project creation and management process These are documented below some of which are available by default and some will be dependent on how AEM and SDL systems have been setup and configured Not all features may be available for example the ability to approvecancel a translation project is only available if you have an Authorization stage in your SDL workflow


The create project wizard allows a user to create translation projects from sites or assets are of AEM and set translation project options

Select items The first page of the wizard allows a user to select the pages for translation User can select multiple nodes and click Add button to add them to their list for translation ndash an icon appears at the bottom of the page Only pagesassets from one source language node can be selected ie only choose English pages not English and French in one project There is check box on the left of the page to include child pages which means selecting a node will then include all of its sub-pages This check box initiates all selections so if you already selected a single node then select a new node with child pages the original page selection will be updated to include child pages This process is highlighted to the user by the selection boxes flashing redgreen as they update When the user selects include child pages a warning message is shown to indicate they could be creating projects with large numbers of files and to consider creating smaller file batches This is a warning message only large file projects can be created but will cause performance issues on the AEM server and thus are not recommended Content can be selected from anywhere in the AEM repository including sites and assets The connector adheres to the requirements of the Translation Integration configuration in terms of including Tags Asset Metadata and assets when sending sites pages for translation It is important to check with the SDL team that file formats are supported in the configurations during setup to avoid project failures For example if a user chooses a SubRip (srt) file from the assets area and this is not supported for pre-processing in SDL TMS the project will fail on the SDL side


Translation Configuration The second page of the wizard allows a user to set the translation project details In the basic column the first step is to add a name (required) and description (optional) for the translation project These values are passed to the SDL Translation Management System Name field is restricted to 50 characters and Description field is restricted to 255 characters Both fields have a validation check highlighting to the user how many characters are available and if you try to go to the next page the connector will show an error related to length restrictions in these fields and stop the user from progressing The Name field also requires the user to exclude non-Windows characters shown by clicking the info symbol Next the user can choose options for how AEM manages the translated files Automatically approve translations will skip the AcceptReject stage when translated files are returned to AEM putting the files back into AEM and automatically approving and completing the translation project Automatically promote translation launches and delete launches after promotion are core features of the AEM Translation Integration Framework for managing language launches automatically following upload of the translated files Note via custom setting described in the custom features below the user may also have access to set other field labels or picklists In the advanced column the user first chooses their Cloud Configuration These are created during the connector setup and map AEM Cloud Configurations to SDL Project OptionsConfiguration Some customers may only have one cloud configuration others may have many depending on their business processes and translation management The choice here will define which project optionconfiguration the project is sent to in the SDL Translation Management System A due date can be set for the translation project and this date is sent across to the SDL Translation Management System with the project details There is validation in the connector to restrict a user from choosing a due date in the past Next the user selects their source and target languages Only one source language can be set and should be matched to the content languages chosen when the files and assets were selected in the first screen of the wizard Target languages are determined by the Cloud Configuration chosen earlier and these are validated against the languages supported on the SDL Project OptionConfiguration The user can select multiple target languages from the picklist Finally the user can select how the language copies are managed updatingcreating a language copy or over writing the language master


Confirmation The final page of the Create Project wizard a user can view all of the pagesassets and settings for the project If necessary they can navigate back to the previous pages to change or update the project details At the bottom of the page the user has the option to Save the project which will create the project in AEM but leave it in a Draft state for later action or Start the project which will begin the AEM workflow and submission of the project to SDL

Project Overview Page

The project overview screen is accessed from the main AEM navigation menu by selecting the SDL Translation icon The table shows a list of all projects in the system with some information about each project The table uses AEM lazy load feature so as the user scrolls down the list more projects will be loaded to the table

1 Title ndash The name of the translation project given in the Create Project wizard 2 Description - The description of the translation project given in the Create Project wizard 3 Status ndash the status of the project in the translation workflow These are described in the next

section and are a mix of AEM and SDL statuses 4 Created by ndash the AEM username who created the project 5 Due Date - The due date set for the translation project in the Create Project wizard 6 Source language ndash the source language chosen in the Create Project wizard 7 Target languages ndash the target languages chosen in the Create Project wizard An epsilon will

show if many languages are set Open the project to display the full list 8 Costs ndash the total cost of the project taken from the SDL Translation Management 9 Word Count ndash the total word count of the project taken from the SDL Translation

Management

Sort Search and Filter Each table heading is sortable by clicking the name In the top Left of the overview screen there are three options to filter projects in the table

1 Search ndash a free text search that checks for content in the Title Description and Created By columns

2 Choose Status ndash a picklist of project status to filter by 3 A toggle switch to show activecompleted projects

Note The search will also adhere to any status filter set meaning you can set the status to In Progress and then search for project title and vise-versa


Project Actions When a project is created andor in progress there are several action buttons for a user depending on the status of the project Each action button is dynamic and will display only when available for that project at that state in time The actions are Start Edit Delete Approve Cancel for translation projects and Accept Reject for translated files

When a project is first created and the user chooses to Save instead of Start on the create project wizard there are 3 options for the user in two areas On the Project Overview page there are two icons to the right of the project row allowing a user to Start or Delete the project directly from this screen If the user opens the project these actions can be performed via the buttons to the top right of the project page When a project has been started and pre-processed by the SDL Translation Management system there is an optional workflow stage in SDL called Authorisation If this stage exists in the workflow the status in the connector will show For approval and two action button will appear On the project Overview page a tick and cross icon will appear for the user to choose to Approve or Cancel the translation project If the user opens the project these two actions can be performed via the buttons to the top right of the project page If the user chooses to Approve the project it moves forwards in the workflow in SDL and the status of the project in AEM changes to In Progress If the users Cancels the project the project is terminated at SDL side and cancelled at AEM side Cancelling in AEM removes the language copies set during project creation Once translations have been completed in SDL they are returned to AEM and the project status changes to Ready for Review Note during project creation if the user chooses ldquoAutomatically Approve Translationsrdquo this status is skipped by the AEM workflow When at this status two action buttons will appear On the project Overview page a thumbs up and thumbs down icon will appear for the user to choose to Accept or Reject the translated files If the user opens the project these two actions can be performed via the buttons to the top right of the project page If the user chooses to Accept the project it moves to the completed status in AEM and the project is completed in SDL If the users Reject the project is rejected the status changes back to In Progress and in SDL the project is moved back in the workflow to the defined rejected state (normally the previous human stage) The are two additional actions that the user can see on the target language table - the option to export the translation project files by clicking the file icon to the right of the target language row and an icon to highlight if the project has been created in the AEM Project Flow or that the AEM Smart Translation process is enabled due to files already being translated


Back-End Functions

There are various functions that work in the background as part of the connector interacting between AEM and SDL

Project Status mapping

The SDL Connector uses a set of statuses to display the progress of the translation project to the user in AEM The mapping table below uses a mix of AEM workflow statuses and SDL MantraAPI statuses to show the progress of an end to end project

Stage UserSystem Action Status Displayed Notes

1 Save gt Project created in AEM

Draft User stage where the project is created and saved in AEM

2 Start gt Project submitted to SDL

Submitted This is a systemprocessing stage showing the projects has started the AEM workflow

3 System gt AEM workflow processing files

Committed for Translation

This is a systemprocessing showing the AEM workflow is complete and the project is in progress sending to SDL

4 System gt Project received in SDL

Preparing This is a systemprocessing stage project is received at SDL side and is being processed by the SDL system

5 ApproveCancel gt Project actioned in SDL

For approval User stage where the project is created statistics are available and can be approved or cancelled for translation If the SDL workflow does not have this stage the projects moves automatically to In Progress

6 System gt Project is In Progress in SDL

In Progress The project is in progress at SDL There is no user action in AEM any interaction is done in the SDL system

7 System gt Project in Reviewsignoff in SDL

In Review (SDL) Reviewed In Sign Off Signed Off

The project is in progress at SDL These stages are dependent on the workflow in SDL and are optional any interaction is done in the SDL system

8 System gt Project is ready to be retrieved from SDL

For Download The project has completed all translation and review stages where applicable and the files are ready to be downloaded back to AEM Files are picked up by the connectors based on the polling frequency set in the configuration

9 AcceptReject gt Translated files are ready for review in AEM

Ready for Review The translated files have returned to AEM and are available to accept or reject If the user chose Automatically Approve Translations during project creation this stage is skipped

10 System gt Translations are Accepted in AEM

Accepted The user in AEM accepts the translations

11 System gt project is completed in AEM and SDL

Completed If the user Accepts translations (or translation are automatically accepted) the project is completed in AEM and in SDL

12 System gt Translations are Rejected in AEM

Rejected The user in AEM rejects the translations This action moves the project back to an In Progress state in SDL (workflow stage depends on SDL configuration) The project will return to an In Progress status in AEM

13 System gt Project is Cancelled

Cancelled User can Cancel a project at Step 5 putting the project in a Cancelled state


14 System gt An error has occurred

Error If something errors during one of the processes from one stage to another the connector will show an error status

Validation

The connector has built-in validation for a number of features to ensure projects are created and managed effectively and without error

1 Limit to amount of translatable files per project 2 Translation project name field is restricted to 50 characters Users see a counter to validate

characters used during project creation If a user tries to create the project with more than 50 characters an error message is shown

3 Translation project description field is restricted to 255 characters Users see a counter to validate characters used during project creation If a user tries to create the project with more than 255 characters an error message is shown

4 When a user selects the Include Child Pages option in the create project wizard the connector validates all selected components and includes child if required If a previous selection did not include child it is updated

5 When the user selects the Cloud Configuration option in the create project wizard the source and target languages are updated to display only those languages supported by the SDL Project Option

Handling of Projects

There are several methods in the connector for handling projects and their content during project creation and project completion or cancellation

1 Batching of translation jobs is performed during high load or with large projects This can be configured in the OSGi as described above When the user creates the project it will move into the Submitted status and run in the background until ready to move to the next stage

2 When a project is created and one of the language job fails the connector will handle the job workflow error and proceed with project creation The errored job will be highlighted in an error status while the remaining languages proceed

3 When a project is cancelled at the approval stage the connector sets the project as inactive The Project Overview screen will briefly show the project highlighted with a strikethrough before being put into the Cancelled status and displayed via the activeinactive toggle switch A cancelled project then has the files and assets removed from the language copies it created at the start

4 When a project is accepted at the Ready for Review stage the connector sets the project as Completed The project is then displayed via the activeinactive toggle switch The project is also completed on the SDL side The same process happens if the Automatically Approve Translations option is set during create project process


Custom Function amp Features

There are several custom features built into the SDL Connector to handle project functionality These custom features can be turned on or off using the settings option from the Project Overview page and then configured accordingly

1 Project Title Prefix Service Where certain properties are defined on a site page the project name is automatically prefixed on page 2 of the create project wizard The configuration is set in systemconsoleconfigMgr and supports properties called Brands Business areas and Divisions

When creating a project the project Name is pre-populated with the defined value pairs ie AB-CDE-FG and the user can add their renaming project name information

2 Custom parameters in step 2 of create project wizard If the SDL project option is configured to support additional attributes turning this setting on will display those attributes in step 2 of the create project wizard The feature supports attributes of type Input (limited to 50 characters) picklist and selection

3 Preselect cloud configuration based on the page properties Where cloud configuration properties are defined on a site page the cloud configuration will be pre-selected on page two of the create project wizard This saves time for the user as well as ensuring the correct cloud configuration is set based on specific customer business rules

4 Preselect target languages based on configuration page property Where option 3 above is enabled the user has the option to auto-select all the target languages that the cloud config supports

5 Preselect target languages based on previous selection This feature will remember the source and target languages set by the user from the previous project created based on their profile Its saves time for the user by remembering previous selections if they always require the same language set Note Option 4 takes priority over this option


End to End Workflow

The workflow diagram below shows the basic process of a project being created in AEM sent to SDL processed by the translation management system and returned to AEM Actual workflow would be defined by the business requirements of a customer and would have more human stages on the SDL translation workflow side

SDL Connector to Adobe Experience Manager


Ph

ase

Create Translation Project

Translation Project created

Translation in Progress

Ready for DownloadReady for Review

Accept Reject Translation

Translation updated

Start

Files uploaded to AEM

Reject translation

Translation Completed


AcceptTranslation

AEM User Action

Project ApprovalProject Approval Approval in AEM or SDL

Option toskip Accept

stage

Option toskip Approval

stage

SDL User ActionSystem Action


The configuration of SDL Managed Translation is performed by the SDL Account team assigned to the customer account The instructions below define a standard configuration supporting the basic requirements of the SDL Connector SDL Managed Translation has many options configurations and customizations to be discussed with your SDL Account team and customer business leads during discovery sessions

SDL TMS Preparation

The SDL Connector uses the SDL MantraAPI and requires customizations enabled on the TMS The SDL Account team will add these customizations to the customerrsquos TMS customizations package and request deployment by SDL Cloud Operations There are two URLs for the SDL Connector to use depending on where your server is hosted

US Server httpslanguagecloudsdlcom

UK Server httpsuk-languagecloudsdlcom

SDL Connector Service Account

A service account should be created in SDL Managed Translation for use in authenticating the Connector This account should only be used by the Connector and not by an end-user to protect against password resets Create the User with settings

Username aem-Integration-ltCUSTOMER-NAMEgt

Password ltltltuse a strong 16 digit passwordgtgtgt Create a Group with permissions

Language Cloud - Login via SDL Language Cloud View Cost Information View API Documentation

Portal - Create job Submit job on View all portal created jobs Test the credentials httpslanguagecloudsdlcomenmanaged-translationlogin Create SDL Managed Translation App

1 Login to SDL Managed Translation using the Service Account 2 From the user Avatar menu select My Applications 3 Create an AEM Connector App 4 Save the Client ID and Secret

Note Only access SDL Managed Translation with the above Service Account to test User credentials and create the Connector App


Setup Components

For information the SDL Connector supports 1 Multiple Project OptionsConfigurations 2 Single source to multiple target language projects 3 Multiple items per project 4 Language codes in AEM by default are mapped to SDL TMS codes 5 AEM Sites files ndash xml (with embedded HTML) json jpg png 6 AEM Assets ndash any file type supported by AEM 7 Approve and Cancel when project at client authorisation stage 8 Accept and Reject translation when at Translated Content Retrieval stage 9 Custom attributes on the configuration

Organizations Project OptionsConfigurations

The recommendation is to separate all integrations into their own organisation as the connector exposes available project options (TMS Configurations) to the admin user during setup and access to non-integration supported options can cause confusion and project creation errors Note the name used for the TMS Configuration is exposed to the AEM admin user so ensure the name is relevant and understandable to how that configuration functions AEM supports many file types for translation and these should be defined with the customer AEM team and SDL Account team to ensure files sent from AEM to SDL are known and file type filters configurations and workflows are setup correctly

Workflows

The workflow can be setup to support the business requirements of the customer and translation teams but must have the following stages

Rebuild Translation ndash creates the target document to be delivered by the connector

Translated Content Retrieval ndash the connector retrieves target document

AuthorizationApproval of project in AEM The AEM connector displays the cost of the translation project to the user in the SDL Translation project screen If you want the user to be able to manually approve or cancel a translation project add an Authorization stage to the workflow This provides the AEM user two options to Approve or Cancel a project from AEM

AcceptReject Translation in AEM The AEM user has the option to Approve or Reject translated files when returned to AEM

If the user approves the translated file the TMS project is set to Completed

If the user rejects the translated file the TMS file is set rejected and moved back to its specified human stage as defined in the TMS


Attributes

The SDL Connector exposes attributes set on the Project OptionConfiguration for use when creating a project The feature supports the following attribute types

Input box ndash this should be set to 50 characters

Picklist

Checkbox

Adding a File Type for AEM Content

An Options XML File will be provided by SDL to support the XML standard received from AEM This has been built using standard files available in the AEM installation There will be occurrences where customers have custom xml content that requires the options file to be modified

To support AEM XML

1 Create a new Options XML File in the Resources area 2 Upload the sdlftsettings file provided by SDL or that you created yourself 3 Then create a Content type with these settings and include the Options XML File

Managing TAGSMETADATAxml and ASSETSMETADATAxml

In the AEM Translation Integration configuration there were two option to translate Tags and Metadata If these options where chosen then AEM creates two additional xml files for translation called TAGSMETADATAxml and ASSETSMETADATAxml These xml files will contain the associated tags and metadata such as SEO Terms page titles image Alt tags from the pages sent for translation In most cases the AEM XML file type you have created above will support the extraction of the associated translation content Important Note If these options are chosen but the AEM pages donrsquot contain any tags or metadata AEM still creates the XML and sends to SDL TMS for translation TMS will process the files but they will contain zero words for translation These files should not be deleted or modified in any way ndash they are correct and should be returned to AEM as part of the connector integration

To Support AEM JSON

AEM supports an additional feature to translate I18N Content Dictionaries These files are delivered to SDL TMS as json format A custom file type should be created to support this content in the same way as you have done above for the AEM XML Contact your SDL Account team for details and a sample package to get started

To Support Images and other Assets in AEM

AEM supports sending image files and assets for translation From the Sites area users can choose to include images (jpg and png) when they send pages for translation In TMS ensure these file types are catered for and added to the workflows to be sent to the translators or new workflows created to pass the images directly to Translated Content Retrieval if no editing is required


Within the AEM Assets area users can use AEM to store and manage many types of file including PDFs InDesign Dita and others For each file type to be sent to TMS ensure the appropriate file type is supported and the associated pre-processing method and workflow applied in the TMS configuration

Create the Configuration

Create your configuration in TMS and assign the content type(s) The rest of the TMS setup should be performed as you would normally for any setup Ensure that the Source and Target Encoding settings on the Encoding tab of the Configuration are set to ldquoutf-8rdquo for the AEM XML file type

Translation Preview

Translation Preview in AEM allows the translator and reviewer in SDL TMS or SDL Managed Translation to see a preview of the webpage in-context to the content they are translatingreviewing To enable this feature in AEM set the Enable Preview option in the SDL Connector Cloud Services Configuration to Enable Go to the Site properties Advanced tab and delete the Design property field The preview solution will be creating its own designs for the preview package on the fly thus having any entries in here will override this


To enable this feature in SDL TMSSDL Managed Translation contact your SDL Account team who will perform the following steps andor provide the necessary packages

1 Install PS customizations to the SDL TMS server 2 Add the Preview XSL stylesheet to the TMS resource library

3 Assign the preview stylesheet to the relevant file type and configure the Task Identity parameter to be passed to it


Install in AEM Package Manager

Log in to AEM with your administrator credentials 1 Locate CRX Package Manager from the AEM menu 2 Click Upload Package 3 Browse to the connector package that you acquired from SDL (eg sdl-connectoruiapps-

113zip) select Force Upload and then click OK 4 Click the Install button for the package then again in the resulting dialog 5 Once installed and the services start return to the AEM home screen and refresh the page 6 The SDL Translation icon will be visible on the main navigation screen

AEM Connector Credentials

The SDL connector uses a set of AEM credentials to manage its access for the pollingscheduler mechanism to update project status and retrieve translated items To set these credentials follow the below links

1 Goto https[server_name]systemconsoleconfigMgr 2 Click on [SDL-CONNECTOR] Configuration Service and complete the username password and

server name details Note 99 of the time you can leave localhost as the server name

3 Goto https[server_name]binv2mantraconfigurationcheck You will receive a Connection tested successfully message

4 The remaining services can be left as default but are described in the Features and Functionality settings if you wish to configure them differently

Setting Cloud Configurations

Before proceeding ensure you have the SDL Translation Management access credentials If you do not have these contact your SDL Account Team


Default Cloud Configuration

The SDL Connector installation process installed a default cloud configuration under confglobal This is the default location for AEM Translation Cloud Configurations

1 Navigate to Cloud Services gt Translation Cloud Services gt conf gt global 2 Click Create

1 Select SDL Translation from the first dropdown 2 Complete the dialog with a Title and Name of your configuration

It is recommended to use a Title and Name that will be understandable for the AEM user creating translation projects This is displayed to the user when they create a translation project as an option to choose configuration they want to use for their project

3 Select Create 4 This opens the created Configuration

5 Enter the details for the configuration

a Enter the URL for your instance including the path to the API httpslanguagecloudsdlcom

b Enter Username and Password c Enter the Client Id and Client Secret d Select the Project Options and this will dynamically display all of the Project Options

available for the user Select the correct one to be used for the AEM integration


e Select option to Enable or Disable Preview Enabling preview passes a preview package from AEM to SDL for displaying in-context preview during translation and review stages

6 Click the Test Connection button

You will see either a success or failure message

If unsuccessful check your login credentials and troubleshoot any firewall issues between the two servers

Custom Cloud Configuration

If you plan to use more than one Cloud Configuration you must set these up at context level within AEM You cannot have more than one cloud config on a single context level

1 Open configuration browser - AEM start screen gt Hammer icon gt General gt Configuration browser

a Click on the blue CREATE button b Check the Cloud Configurations checkbox c Enter a name d Click Create inside the dialog

2 Open Translation Cloud Services - AEM start screen gt Hammer icon gt Cloud Services gt Translation Cloud Services

a Select conf b You will see a global folder - this is where the Default configuration is located c In the same level you will see the newly created cloud config root folder

3 Select that folder and click on the blue CREATE button a Select SDL Translation b Enter title and name c Click Create inside the dialog


4 Setup the cloud config as described in the Default Cloud Config section above 5 In step2 of the SDL Create Project Wizard you will see a select box with all the cloud configs

Default is selected by default

Language Mappings

It is important to ensure that the language mappings are accurate between AEM and SDL For example if SDL is expecting en_us gt es then the user in AEM must select the correct language codes during translation project creation

Language mapping nodes are installed as part of the connector and can be found in AEM under CRXDE Lite - appssdl-connectorconfiglanguageMapping The de node on the left is the AEM language code the languageMapping value in the Properties DE is the language code that should exist in SDL


Configure AEM Translation Integration

Detailed instructions on how to configure the AEM Translation Integration Framework can be found on the Adobe docsrsquo website AEM 65 httpshelpxadobecomexperience-manager6-5sitesadministeringusingtc-tichtml

Configuration Instructions

Navigate to Cloud Services gt Translation Cloud Services gt Conf gt ltYOUR-Cloud-Configgt 1 Select Translation Integration from the dropdown

2 Complete the dialog with a Title and Name for your Translation Configuration


3 Configure Sites and Assets to use the SDL Connector Configuration and choose the options

as required referring to the tables below taken from the Adobe docs instructions Adobe lock down the Communities section to Microsoft Machine Translator and SDL have no control to be able to change this section

Sites Configuration Properties

The Sites properties control how the translation of page content is performed Property Description

Translation Workflow

Select the translation method that the framework performs for site content Machine Translation The translation provider performs the translation using machine translation in real time Human Translation Content is sent to the translation provider to be translated by translators Do Not Translate Content is not sent for translation This is to skip certain content branches which would not be translated but could be updated with latest content

Translation Provider

Select the translation provider to perform the translation A provider appears in the list when their corresponding connector is installed

Content Category (Machine Translation Only) A category that describes the content that you are translating The category can affect the choice of terminology and phrasing when translating content

Translate Tags Select to translate tags that are associated with the page

Translate Page Assets

Select how to translate assets that are added to components from the file system or referenced from Assets Do not translate Page assets are not translated Using Sites translation workflow Assets are handled according to the configuration properties on the Sites tab Using Assets translation workflow Assets are handled according to the configuration of the properties on the Assets tab

Auto-Execute Translation

Select to execute translation jobs automatically after translation projects are created You do not have an opportunity to review and scope the translation job when you select this option


Assets Configuration Properties

The Assets properties control how the translation of page content is performed Property Description


Select the translation method that the framework performs for site content

Machine Translation The translation provider performs the translation using machine translation in real time

Human Translation Content is sent to the translation provider to be translated by translators

Do Not Translate Content is not sent for translation This is to skip certain content branches which would not be translated but could be updated with latest content



Content Category

(Machine Translation Only) A category that describes the content that you are translating The category can affect the choice of terminology and phrasing when translating content



Select how to translate assets that are added to components from the file system or referenced from Assets

Do not translate Page assets are not translated

Using Sites translation workflow Assets are handled according to the configuration properties on the Sites tab

Using Assets translation workflow Assets are handled according to the configuration of the properties on the Assets tab




Known Limitations

The following limitations exist for this solution in AEM SDL or the Connector

In AEM translation projects are created as nodes under projectssdl AEM has a limit of 1000 sub-nodes so ensure projects are archived periodically 1 project equals 1 node

Due date in the create project wizard ndash if same day due date is chosen TMS defaults to 5 days

If the AEM server is running slow or using a local instance the multi-threading setting should be set to 1 otherwise when creating large projects the threading in AEM can cause erroneous errors on the project status page The page and status will resolve itself eventually once AEM has processed the files

Error MessagesLog Files

The SDL Connector generates two logs when errors occur during usage

Core bundle

systemconsoleslinglogslinglogtailertxttail=10000ampgrep=ampname=2Flogs2Fsdl-corelog

API bundle

systemconsoleslinglogslinglogtailertxttail=10000ampgrep=ampname=2Flogs2Fsdl-apilog


SDL (LSESDL) is the global innovator in language translation technology services and

content management With more than 25 years of experience SDL delivers transformative

business results by enabling powerfully nuanced digital experiences with customers around

the world Find out more at sdlcom

Copyright copy 2018 SDL plc All Rights Reserved The SDL name and logo and SDL product and service names are trademarks

of SDL plc andor its subsidiaries some of which may be registered Other company product or service names are the property

of their respective holders

Version History

Document Name Approver Version Date Notes Administrator Guide Nigel Watson Draft 01 Nov 2019 Initial draft Administrator Guide Dept Draft 10 Dec 2019 Development Review Administrator Guide v11 Nigel Watson 11 13 Dec 2019 For Pre-Release Administrator Guide v13 Nigel Watson 113 10 Jan 2020 Final Release Includes support for

old connector in upgrade process


Document Control 2

Version History 2

Before you Begin 4


Solution Overview 7






Configure AEM 27


Troubleshooting 34


About SDL 35






test plans

Supported Versions



AEM 652

Checklist





























AEM Projects Flow



System Integration


System Functions





SDL Connector







Error logging

Custom features

SDL MantraAPI




SDLConnector





AEM User Experience


























Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle











Document Control 2

Version History 2

Before you Begin 4


Solution Overview 7






Configure AEM 27


Troubleshooting 34


About SDL 35






test plans

Supported Versions



AEM 652

Checklist





























AEM Projects Flow



System Integration


System Functions





SDL Connector







Error logging

Custom features

SDL MantraAPI




SDLConnector





AEM User Experience


























Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle















test plans

Supported Versions



AEM 652

Checklist





























AEM Projects Flow



System Integration


System Functions





SDL Connector







Error logging

Custom features

SDL MantraAPI




SDLConnector





AEM User Experience


























Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle




























AEM Projects Flow



System Integration


System Functions





SDL Connector







Error logging

Custom features

SDL MantraAPI




SDLConnector





AEM User Experience


























Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle






















AEM Projects Flow



System Integration


System Functions





SDL Connector







Error logging

Custom features

SDL MantraAPI




SDLConnector





AEM User Experience


























Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle











System Integration


System Functions





SDL Connector







Error logging

Custom features

SDL MantraAPI




SDLConnector





AEM User Experience


























Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle











AEM User Experience


























Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle























Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle













Page Selection
















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle




















Confirmation Screen











successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle
















successfully]










Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle
















Language Mapping





Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle













Front-End Features














Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle



















Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle

















Management









Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle














Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle











Back-End Functions




































Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle













Validation























End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle




















End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle











End to End Workflow




Ph

ase






Translation updated

Start


Reject translation



AcceptTranslation

AEM User Action



stage


stage




SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle












SDL TMS Preparation













Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle











Setup Components




Workflows









Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle











Attributes



Picklist

Checkbox



To support AEM XML




To Support AEM JSON








Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle














Translation Preview












































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle




















































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle
















































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle




































Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle

























Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle













Language Mappings


































Content Category











Known Limitations







Core bundle


API bundle









































Content Category











Known Limitations







Core bundle


API bundle



































Content Category











Known Limitations







Core bundle


API bundle




















Content Category











Known Limitations







Core bundle


API bundle











Known Limitations







Core bundle


API bundle


















Documents

SDL Connector for AEM · test plans Supported Versions SDL Connector for AEM 1.1.3 SDL Managed Translation with SDL TMS 11.2+ AEM 6.5.2 Checklist To complete the SDL Connector setup,