SDL TMS Connector Versions

Report 156 Downloads 145 Views
Integration for Adobe Experience Manager Installation& Setup Guide AEM v6.3 July 2017

Introduction How it works SDL TMS Connector Versions

AEM 6.3 Setup Installing the SDL TMS Connector Installing from Adobe PackageShare Installing Manually from a Connector Package

Configuring the SDL TMS Connector Configuring AEM Translation Integration

3 3 3

4 6 6 7

8 10

Configuration Instructions Polling Frequency

10 12

Configuring SDL TMS

13

Adding a File Type for AEM Content Create the Configuration Language Mappings

Prerequisites

13 15 15

17

Permissions Smoke Test

17 17

About SDL

19

How it works SDL is part of the Adobe Exchange Technology Partner Program. As such we have been approved by Adobe to use their APIs to build apps for publication on the Adobe Marketing Cloud Exchange. With AEM 6.1, Adobe created the Translation Integration Framework (TIF) to automate the translation of page content, assets, and user-generated content to create and maintain multilingual websites. To automate translation workflows, you integrate SDL’s language technology with AEM and create projects for translating content into multiple languages. SDL's connectors are closely tied to the Adobe TIF and its functionality - the features and functionality of the connector is therefore defined by this framework and Adobe. The connector provides capability to transfer files in a translation project from AEM to SDL and back. There’s a host of documentation on Adobe docs site about how to setup AEM for translation purposes, and customers should refer to those pages for support.

This guide is will help you get the connector installed and AEM configured. The Adobe docs’ pages have lots of useful information on how to setup and configure AEM for localization, and it is important to read this before using the connector. https://docs.adobe.com/docs/en/aem/6-3/deploy.html

SDL TMS Connector Versions This guide is designed to be used for AEM 6.3 and TMS 11. Where applicable additional notes have been added to explain specific changes or functionality that occur in later versions. There are also lots of pages and support to guide users on the use of the AEM Translation Framework and submitting translation projects to the SDL TMS Connector. https://docs.adobe.com/docs/en/aem/6-2/administer/sites/translation/tc-manage.html

CONFIDENTIAL

3

SDL TMS Connector for AEM 6.3 – Installation Guide

Before configuring the SDL Connector, an AEM admin user must configure Apache Sling Service User Mapper Service inside the AEM instance. 1. Goto http:///system/console/configMgr 2. Find (Ctrl+F) for the "Apache Sling Service User Mapper Service Amendment" section 3. Add two service mappings exactly as below: com.adobe.granite.translation.:translation-config=translation-config-service com.adobe.granite.translation.connector.sdltms:translation-config=translation-configservice

4. Click Save 5. Find (Ctrl+F) the "Apache Sling Service User Mapper Service" section and edit 6. Add four service mappings exactly as below: com.adobe.granite.translation.connector.sdltms:writeService=translation-config-service com.adobe.granite.translation:writeService=translation-config-service com.adobe.granite.translation.connector.sdltms:readService=translation-config-service com.adobe.granite.translation:readService=translation-config-service

7. Click Save

CONFIDENTIAL

4

SDL TMS Connector for AEM 6.3 – Installation Guide

The next step is to provide the necessary read/write permissions for the translation-config-service user. 1. Goto http:///useradmin

2. Search for “translation-config-service” 3. Open the entry by double-click 4. Add a Last Name called “Translation”

5. Click Save 6. Select Permissions from the navigation tabs 7. Select all the permissions for the Content node

8. Click Save

CONFIDENTIAL

5

SDL TMS Connector for AEM 6.3 – Installation Guide

There are two ways to install the SDL Connector for AEM. For production environments we would always recommend installing directly from the AEM PackageShare location. However there is also an option to manually upload the install package, if provided to you by SDL, from the CRX Package Manager in AEM.

Installing from Adobe PackageShare Navigate to: https://www.adobeaemcloud.com/content/packageshare.html 1. Login with your Adobe credentials, and search for SDL. Note: There are several versions available depending on the version of AEM you are using and if you are using SDL TMS or SDL Worldserver. 2. Select the appropriate version and click install.

3. Follow the Adobe on-screen instructions to complete installation in your cloud environment.

CONFIDENTIAL

6

SDL TMS Connector for AEM 6.3 – Installation Guide

Installing Manually from a Connector Package 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 AEM TMS connector that you acquired from SDL (e.g. com.adobe.granite.translation.connector.sdltms.core.pkg-1.0.0.zip), select “Force Upload”, and then click OK:

4. Click the Install button for the package, then again in the resulting dialog:

5. The installation only takes a few minutes. Once complete, the connector will appear in AEM in the Cloud Services area.

CONFIDENTIAL

7

SDL TMS Connector for AEM 6.3 – Installation Guide

Navigate to Cloud Services and scroll down to SDL TMS. 1. Click Configure now under the SDL TMS service.

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

CONFIDENTIAL

8

SDL TMS Connector for AEM 6.3 – Installation Guide

4. This opens up the newly created Configuration. 5. Click Edit.

6. Enter the TMS server URL, and the Configuration ID. If you do not have these, contact your TMS Administrator or SDL Account Team. 7. Select the option to disable or enable Preview in SDL TMS. Note: ensure this is set to disable to start with.

8. Click the Test Connection button. If successful you will see the following message:

If unsuccessful you will see the following message:

If this happens you need to check your login credentials, and troubleshoot any firewall issues between the two servers.

CONFIDENTIAL

9

SDL TMS Connector for AEM 6.3 – Installation Guide

Detailed instructions on how to configure the AEM Translation Integration Framework can be found on the Adobe docs’ website: AEM 6.1: https://docs.adobe.com/docs/en/aem/6-1/administer/sites/translation/tc-tic.html AEM 6.2: https://docs.adobe.com/docs/en/aem/6-2/administer/sites/translation/tc-tic.html Use these instructions to complete the next few steps, relevant to your translation requirements and language setup.

Configuration Instructions Navigate to Cloud services and scroll to Translation Integration. 1. Click Show Configurations, then “+”.

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

CONFIDENTIAL

10

SDL TMS Connector for AEM 6.3 – Installation Guide

3. Configure Sites and Assets to use the SDL TMS connector 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 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. Translation Do Not Translate: Content is not sent for translation. This is to skip certain content branches Workflow which would not be translated but could be updated with latest content. Translation Select the translation provider to perform the translation. A provider appears in the list Provider when their corresponding connector is installed. (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 Category content. Translate Tags Select to translate tags that are associated with the page. 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. Translate Page Using Assets translation workflow: Assets are handled according to the configuration of the Assets properties on the Assets tab. Auto-Execute Select to execute translation jobs automatically after translation projects are created. You do Translation not have an opportunity to review and scope the translation job when you select this option.

Sites Configuration Properties The Sites properties control how the translation of page content is performed.

CONFIDENTIAL

11

SDL TMS Connector for AEM 6.3 – Installation Guide

Property

Translation Workflow Translation Provider Content Category Translate Tags

Translate Page Assets Auto-Execute Translation

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. Select the translation provider to perform the translation. A provider appears in the list when their corresponding connector is installed. (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 to translate tags that are associated with the page. 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. 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.

Polling Frequency To change the schedule at which the AEM Translation Integration Framework polls SDL TMS to check when translations are ready, you require access to the server location where AEM is installed. This can be done here: http://AEM_SERVER_URL/system/console/configMgr/com.adobe.cq.wcm.translation.impl.scheduler .SyncTranslationState

CONFIDENTIAL

12

SDL TMS Connector for AEM 6.3 – Installation Guide

The configuration of TMS should be performed by the SDL TMS Administrator or SDL Account team who are assigned to your account. The instructions below specify an out-of-the-box configuration in TMS to support the SDL TMS Connector and are designed to get you started and run a test project. SDL TMS has many options, configurations, and customizations available as part of the setup, and these should be discussed with your TMS Administrator and business leads during the discovery sessions. AEM also have many options and features to deliver xml, images and assets for translation. Work closely with the SDL TMS Administrator to ensure the requirements for files being passed from AEM to TMS are understood and the necessary file types, configurations and workflows are setup to support.

Adding a File Type for AEM Content An Options XML File will be provided by SDL to support the XML standard received from AEM. However this has been built to the best of our ability 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.

CONFIDENTIAL

13

SDL TMS Connector for AEM 6.3 – Installation Guide

3. Then create a Content type with these settings and include the Options XML File.

Managing TAGSMETADATA.xml and ASSETSMETADATA.xml 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 TAGSMETADATA.xml and ASSETSMETADATA.xml. 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 don’t 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 – they are correct and should be returned to AEM as part of the connector integration.

To Support AEM JSON in AEM 6.2 AEM 6.2 supports an additional feature to translate Content Dictionaries. These files are delivered to SDL TMS as .json format. A file type should be created to support this content in the same way as you have done above for the AEM XML.

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.

CONFIDENTIAL

14

SDL TMS Connector for AEM 6.3 – Installation Guide

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 “utf-8” for the AEM XML file type.

Take the TMS URL and TMS Configuration GUID and provide this to the AEM Administrator to configure the connector in TMS. The below are examples only:  SDL TMS URL (https://testserver.sdlproducts.com)  Configuration GUID (444444BEBD-55D5-4444-999F-A33FGH5C9999)

Language Mappings It is important to ensure that the language mappings are accurate between AEM and TMS. For example if TMS is expecting en_us > fr, then the user in AEM must select the correct language codes during translation project creation.

CONFIDENTIAL

15

SDL TMS Connector for AEM 6.3 – Installation Guide

Language mapping nodes are installed as part of the connector, and can be found in AEM under CRDX Lite

CONFIDENTIAL

16

SDL TMS Connector for AEM 6.3 – Installation Guide

After installing the SDL TMS Connector and following the necessary configuration work, we would recommend these prerequisites be confirmed and the smoke test performed to ensure the basic setup has been completed and the connector is working correctly.

Permissions   

System Admin rights to the AEM Instance to which you want to install the SDL Connector. Ensure you can access the TMS server through any firewalls or proxy servers o Go directly to the TMS URL in a browser – can you see the login screen? o Do a test Ping on the TMS URL – do you get a response? You have the configuration details of the SDL TMS, provided by your TMS Administrator or SDL Account team (TMS URL and TMS Config GUID).

Smoke Test It’s a good idea to run a test through the system to ensure all of the settings have been made correctly and fully. Using pages from the Geometrixx Demo Site, Product pages is always a good test – use Triangle or Circle pages. Here are some steps to walk through and end-to-end process. 1) Install the connector from the adobe packageshare, or manual upload 2) Go to the SDL TMS Cloud service and create a new configuration a. Enter the TMS URL and TMS Config GUID (Ensure you enter this accurately, there should be no trailing backslash on the URL). 3) Go to the Translation Integration Cloud service and edit the “Default configuration Translation Integration” a. Select Human Translation b. Select SDL WorldServer (or the name you gave when creating the Config in step 2) c. Set Translation Page Assets to “Using sites translation workflow” d. Deselect all other options 4) Go to Sites, We.Retail a. Go to Language Masters > English > Products > Men b. Select Coats c. Open the References tab d. Select Language Copies 5) Select Create and Translate a. Select Language as French b. Tick Select all sub pages c. Enter a Project Title d. Select Create 6) Go To Projects a. Open the project you have just created 7) Go to Translation Summary a. Select the Epsilon (…) in the bottom right of the tile b. Select Edit, and go to the Translation tab

CONFIDENTIAL

17

SDL TMS Connector for AEM 6.3 – Installation Guide

8)

9)

10)

11)

12)

c. Ensure the source language is set as English (en_us) d. Ensure the target language is set as French (fr) e. Ensure the Translation Method, Translation Provider and Cloud Config match what you setup earlier. f. Select Save Go to Translation Job a. Select the Epsilon (…) in the bottom right of the tile b. Delete any images, tags files, or other assets. Leave only the two Triangle and Overview xml files. c. Select Save Send to Translation a. In the drop down at the top of the Translation Job tile select Start b. The Status should show the following states in order i. Committed for Translation ii. Submitted iii. Translation in progress c. To ensure the process is working it is often necessary to refresh the browser window When Translation in progress is displayed, login to TMS to see your project created. a. The project should create, pre-process the files and move to a stage such as authorization. b. Move the project through the TMS workflow to Translated Content Retrieval In AEM, open your Project a. The Status in the Translation Job tile should show “Ready for Review” b. If not, open the Epsilon in the tile and check the individual files c. To ensure the process is working it is often necessary to refresh the browser window Once all files are in Ready for Review status a. In the Translation Job tile, click the dropdown and select Complete b. The status on the Translation Job tile shows Complete c. Go back into TMS and the translation job should also show as Complete

This has completed a basic round-trip test of the connector.

CONFIDENTIAL

18

SDL TMS Connector for AEM 6.3 – Installation Guide

SDL (LSE: SDL) is the global innovator in language translation technology, services and content management. For more than 20 years, SDL has transformed business results by enabling nuanced digital experiences with customers across the globe so they can create personalized connections anywhere and on any device. Are you in the know? Find out more at SDL.com.

Copyright © 2017 SDL plc. All Rights Reserved. All company product or service names referenced herein are properties of their respective owners.

CONFIDENTIAL

19

SDL TMS Connector for AEM 6.3 – Installation Guide

Recommend Documents