SDL Connector for AEM · PDF file test plans Supported Versions SDL Connector for AEM 1.1.3...

Click here to load reader

  • date post

  • Category


  • view

  • download


Embed Size (px)

Transcript of SDL Connector for AEM · PDF file test plans Supported Versions SDL Connector for AEM 1.1.3...

  • 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 v1.1 Nigel Watson 1.1 13 Dec 2019 For Pre-Release Administrator Guide v1.3 Nigel Watson 1.1.3 10 Jan 2020 Final Release. Includes support for

    old connector in upgrade process.

  • CONFIDENTIAL 3 Administrator Guide v1.1.3

    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 & Functionality 12

    Configurable Functions & Features 12 Front-End Features 14 Back-End Functions 18 Custom Function & 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 Messages/Log Files 34

    About SDL 35

  • CONFIDENTIAL 4 Administrator Guide v1.1.3

    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 – general overview of the connector, its features and usability 2. Features and Functionality – detailed description of how the connector functions for the end

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

    connector requirements 4. Troubleshooting – information for support teams on known issues, how to triage issues, and

    test plans

    Supported Versions

     SDL Connector for AEM 1.1.3

     SDL Managed Translation with SDL TMS 11.2+

     AEM 6.5.2


    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 teams’ involvement to complete the integration. SDL Account team for:

     SDL Managed Translation service account

     SDL TMS organization/configuration 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 read/write access to CRX/DE 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 test/local instance first, to ensure connection and functionality is correct before moving to staging and production environments.

  • CONFIDENTIAL 5 Administrator Guide v1.1.3

    Upgrading to the new SDL Connector for AEM 6.5?

    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 http://localhost:4502/system/console/configMgr 2. Look for ACL Setup Service and click edit

    3. In the list of rules that are already there add the following ones a. allow;jcr:all;sdl-read-write-system-user;/content b. allow;jcr:all;sdl-read-write-system-user;/etc c. allow;jcr:read;sdl-read-write-system-user;/conf d. allow;jcr:read;sdl-read-write-system-user;/apps e. allow;jcr:read;sdl-read-write-system-user;/home

    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.


  • CONFIDENTIAL 6 Administrator Guide v1.1.3

    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 /system/console/bundles and search for sdl a. Check the SDL Connector Core Bundle has been deleted

    5. Go to /system/console/configMgr 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 /etc/cloudservices/sdl-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.

  • CONFIDENTIAL 7 Administrator Guide v1.1.3

    System Integration

    The SDL Connector for AEM builds on the earlier versions of SDL’s 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

    SDL Connector

    AEM SDL Translation Management

    Translation Integration Framework

    SDL MantraAPI Configuration

  • CONFIDENTIAL 8 Administrator Guide v1.1.3

    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 active/completed 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

  • CONFIDENTIAL 9 Administrator Guide v1.1.3

    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 butto