This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Installation Guide

1 - Welcome to the Connector

Welcome to the Lionbridge Connector for SAP Commerce (“Connector”) version 3.0. This is Lionbridge’s connector between SAP Commerce (formerly Hybris) and the Lionbridge Content API Platform.

1.1 - Terminology
Asset A content item that you manage using SAP Commerce, for example, supported business objects.
Freeway The name of the Lionbridge translation portal for submitting content to and retrieving content from the Lionbridge translation provider.
FTP Server File Transfer Protocol (FTP) is a standard network protocol used to transfer files from one host to another host over a TCP-based network, such as the Internet. Translation providers may receive and send files for translation using an FTP server.
Keys The Connector uses keys to establish a secure, discrete connection between the Connector instance and the Platform.

Very important: Do not copy the CMS address keys to multiple instances, because this is a violation of the License Agreement. Using the same CMS address keys on multiple instances will cause the Lionbridge App or Connector to behave unexpectedly, which can result in lost translation content, orphaned projects, and inaccurate translation status reports. The Lionbridge Connector team will support technical issues caused by duplicating or incorrectly installing CMS address keys only on a time and materials basis.
Lionbridge The publisher of the Freeway translation portal and a translation provider. Users connect to the Freeway translation portal to submit content to and retrieve content from the Lionbridge translation provider.
Lionbridge Connector for SAP Commerce (“Connector”) The connector software that a Lionbridge company, has developed and provides, which plugs into your SAP Commerce installation to provide connectivity to our hosted Platform. In this document it is referred to as the Connector. This is the software you are installing and configuring as you work through this document.
MT Machine translation. The translation provider can be a machine translation service, such as Google Translate.
Producer CMS or another system that sends content or documents out for translation. In this case, this is SAP Commerce.
Provider A provider of translation services. The delivery of assets to the provider may be via an FTP server or a TMS connector.
Support Asset Supporting documents and their metadata.  Support assets are not translated by the translation provider, but they provide helpful context for the translator.
TMS Translation management system that the translation provider uses.

1.2 - How the Connector Works with SAP Commerce

The Lionbridge Connector (“Connector”) is an important part of the Lionbridge Content API translation solution.

The Connector is installed on your system as an add-in to SAP Commerce. Its functionality is displayed to the users as part of SAP Commerce.

Your translation systems architecture might look like the configuration above. It may have additional content producers or translation providers, but the core concepts remain the same.

During implementation, the Lionbridge Connector team works with you and your translation providers to ensure your connector sends and receives content properly to and from your translation provider via Lionbridge Content API.

1.3 - Using this Guide

Purpose of this guide

This guide describes everything you need to know to install and configure the Lionbridge Connector (“Connector”) for SAP Commerce. It describes the delivery package contents, system requirements, installation instructions, and configuration procedures.

Recommendation: Review the user guide to fully understand the powerful features of the Connector.

Who should use this guide

This guide is intended for SAP Commerce administrators and system integrators.

What you should already know

This document assumes that your company already has an installed instance of SAP Commerce. It assumes that you have a strong working knowledge of SAP Commerce and its features.

How to find out more about the Lionbridge Connector for SAP Commerce

For information on using the Lionbridge Connector to send and receive content for translation from SAP Commerce, read the Lionbridge Connector for SAP Commerce User Guide.

Documentation conventions

This guide uses the following conventions:

Convention Description
Bold Highlights screen elements such as buttons, menu items, and fields.
Courier Highlights input, file names, and paths.
Italics Highlights terms for emphasis, variables, or document titles.
> Indicates a menu choice. For example, “Select Translation > Translate Asset.”

1.4 - How to Contact Lionbridge Connector Support

How to Contact Lionbridge Connector Support



You can submit a support ticket either:

See also:



2 - Before You Install

Before you begin to install the Lionbridge Connector (“Connector”) for SAP Commerce, please review the system requirements, described in System Requirements, and perform the following pre-installation procedures:

  1. Setting Your System Date, Time, and Time Zone Correctly.

  2. Ensure that in your SAP Commerce environment, the SAP Commerce suite user has sufficient access rights to control job execution in SAP Commerce via CronJobs. For detailed instructions, refer to the appropriate version of the SAP Commerce documentation at https://wiki.hybris.com.

  3. Optional step. If you have a firewall, you must configure your ports so that the Connector can communicate with the Lionbridge Content API Platform. For details, see Configuring Network Settings for a Firewall.

2.1 - System Requirements

The Lionbridge Connector for SAP Commerce (“Connector”) supports:

  • Hybris versions 6.1 and higher
  • SAP Commerce versions 18xx, 19xx, and higher
  • SAP Commerce Cloud versions 18xx, 19xx, and higher

The Connector has several pre-installation requirements, described in Before You Install.

  • On Hybris or SAP Commerce, the Connector requires Java 8.
  • On SAP Commerce Cloud 19xx or higher, the Connector requires sapmachine-jdk-11 or oracle-jdk-11.

The Connector has no additional hardware or software requirements beyond those of SAP Commerce. For detailed requirements, refer to the appropriate version of the SAP Commerce documentation at https://help.sap.com/viewer/product/SAP_COMMERCE_CLOUD/SHIP/en-US.
Memory 16 GB minimum is recommended by SAP Commerce. This is recommended for the Connector to function as expected.
Disk Space * 5 GB is recommended by SAP Commerce.
* The Connector installation requires an additional 170 MB of disk space.
* Space for storing log files.

2.2 - Setting Your System Date, Time, and Time Zone Correctly

The Lionbridge Connector sends content to and receives content from the Lionbridge Connector API Platform, which is hosted in the Amazon Web Services (AWS) environment. AWS requires any machines that connect to its applications to have the correct system time and date settings.

Important: Before proceeding, ensure that the system date, time, and time zone are set correctly on any systems that will run the Lionbridge Connector. If these settings are incorrect, the following error message is displayed: Error. The difference between the request time and the current time is too large.

2.3 - Configuring Network Settings for a Firewall

Optional step. If you have a firewall, you must configure your ports so that the Connector can communicate with the Lionbridge Content API Platform. The Connector must be able to communicate with the Lionbridge Content API Platform by initiating the following outbound network connections:

Protocol Port Number Description Locations to Configure
HTTPS Port 443 For secure access to the Content API Platform Services https://contentapi.lionbridge.com/*
https://content-api.staging.lionbridge.com/*
https://login.lionbridge.com/*
https://fms.lionbridge.com/*
https://fms-staging.lionbridge.com/*
To send content for translation to Lionbridge Freeway, also configure:
Protocol Port Number Description Location to Configure
HTTPS Port 443 For secure access to Lionbridge Freeway https://fwapi.lionbridge.com/obvibundles/freewayauth.asmx
HTTPS Port 443 For secure access to Lionbridge Freeway https://fwapi.lionbridge.com/obvibundles/service.asmx

3 - Installing the Lionbridge Connector onto SAP Commerce Cloud

This section describes how to install the Connector package onto SAP Commerce Cloud.

Note: If you are installing the Connector package into Hybris or SAP Commerce, follow the detailed instructions in Installing the Lionbridge Connector into Hybris or SAP Commerce.

To install the Connector onto SAP Commerce Cloud:
  1. At the root level of the Commerce Cloud code repository, create the custom folder.
  2. Add the following Connector package files to the custom folder you just created.
  • /custom/ctcore
  • /custom/ctbackoffice
  1. In your manifest.json file, add the Connector packages to the extensions list, for example:

“extensions”: [

…,

“ctcore”

“ctbackoffice”

],

  1. Save, commit, and push the changes.
  2. Create a build in the Commerce Cloud Dashboard.
  3. Deploy the build to the desired environment, using one of the following options, depending on your requirements and capabilities:
  • Update database and deploy with downtime
  • Update database and deploy with rolling update

4 - Installing the Lionbridge Connector into Hybris or SAP Commerce

This section describes how to install the Connector package into your Hybris or SAP Commerce system.

Note: If you are installing the Connector package onto SAP Commerce Cloud, follow the detailed instructions in Installing the Lionbridge Connector onto SAP Commerce Cloud.

Before you install the Connector, verify that you have reviewed the system requirements and performed the pre-installation tasks described in Before You Install.

To install the Connector into Hybris or SAP Commerce:
  1. Download the Lionbridge Connector (“Connector”) delivery package, from the link that Lionbridge sends you.
  2. Unzip the delivery package into any working folder on your server.
  3. If the ${HYBRIS_BINDIR}/custom folder does not already exist, then create it, for example:
  • In Windows: C:\hybris\bin\custom.
  • In Unix: $HYBRIS_HOME/bin/custom.
  1. Copy all the Connector packages in the delivery package to the custom folder, for example:
  • In Windows:
C:\hybris\bin\custom\ctbackoffice all Hybris and SAP Commerce versions
C:\hybris\bin\custom\ctbasecockpit Hybris versions 6.1 to 6.6 only
C:\hybris\bin\custom\ctcockpit Hybris versions 6.1 to 6.6 only
C:\hybris\bin\custom\ctcore all Hybris and SAP Commerce versions
C:\hybris\bin\custom\ctwcms Hybris versions 6.1 to 6.6 only
  • In Unix:
$HYBRIS_HOME/bin/custom/ctbackoffice all Hybris and SAP Commerce versions
$HYBRIS_HOME/bin/custom/ctbasecockpit Hybris versions 6.1 to 6.6 only
$HYBRIS_HOME/bin/custom/ctcockpit Hybris versions 6.1 to 6.6 only
$HYBRIS_HOME/bin/custom/ctcore all Hybris and SAP Commerce versions
$HYBRIS_HOME/bin/custom/ctwcms Hybris versions 6.1 to 6.6 only

Note: The ctbasecockpit, ctcockpit, and ctwcms folders support the corresponding Hybris cockpits, which are not included in Hybris versions 6.7 and higher. Version 6.7 includes only the Backoffice Cockpit.

  1. If the Hybris server is running, then stop it.
  • In Windows: 
  1. Open the Command Prompt window in which the server is running.
  2. Press Ctrl and C.
  • In Unix: In the Terminal, press Ctrl and C.
  1. In the ${HYBRIS_CONFIGDIR}/localextensions.xml file, add the following entries for the new extensions:
  • In Hybris versions 6.1 to 6.6:

<extension name=“ctbackoffice”/>

<extension name=“ctbasecockpit”/>

<extension name=“ctcockpit”/>

<extension name=“ctcore”/>

<extension name=“ctwcms”/>

  • In Hybris versions 6.7 and higher:

<extension name=“ctbackoffice”/>

<extension name=“ctcore”/>

For example, add this entry to the following file:

  • In Windows: C:\hybris\config\localextensions.xml.
  • In Unix: $HYBRIS_HOME/config/localextensions.xml.
  1. If you are installing the Connector in Hybris version 6.1 or 6.2, complete the following sub-steps: a. Edit hybris/bin/custom/ctbackoffice/resources/ctbackoffice-backoffice-config.xml. b. Locate the section that starts with the following XML comment:

!-- Enable-multi-select Attribute (6.3+)​. ​

c. Comment out or remove the configuration enabling the Connector to send content for translation from the Backoffice. This section is on lines 55-154. d. Comment out both sub-sections that start with <context component=“collection-browser”/> . These sub-sections are on lines 159-177.

Note: This feature is enabled by default in Hybris versions 6.3 and higher.

  1. In Hybris versions 6.6 and higher, in ctbackoffice\resources\ctbackoffice-backoffice-config.xml, at line 55, note the configuration file for your supported version of Hybris.

Note: This step is not required in Hybris versions 6.1 to 6.5.

  1. In Hybris versions 6.6 and higher, edit the configuration file you identified in the previous step as follows:

Note: This step is not required in Hybris versions 6.1 to 6.5.

  • Uncomment the following:

<context type=“Item” component=“listviewactions”>

<y:actions>

<y:group qualifier=“common”>

<y:label>actiongroup.common</y:label>

<y:action action-id=“com.lionbridge.hybris.connector.ctbackoffice.actions.sendtotranslation” property=“selectedObjects” />

</y:group>

</y:actions>

</context>

  • Comment out the following:

<context component=“listviewactions”>

<y:actions>

<y:group qualifier=“common”>

<y:label>actiongroup.common</y:label>

<y:action action-id=“com.lionbridge.hybris.connector.ctbackoffice.actions.sendtotranslation” property=“selectedObjects” />

</y:group>

</y:actions>

</context>

  1. Navigate to the ${HYBRIS_BINDIR}/platform directory, for example:
  • In Windows: C:\hybris\bin\platform.
  • In Unix: $HYBRIS_HOME/bin/platform.
  1. Do one of the following:
  • In Windows: 

  1. Press the Shift button and right-click, and select Open command window here from the context menu.

    The Command Prompt window opens.

  2. Type setantenv.bat and press Enter.

  • In Unix: In the Terminal, type . ./setantenv.sh and press Enter.
  1. After setting ant home, type ant clean all and press Enter.

This takes a few minutes to run. When it is finished, BUILD SUCCESSFUL is displayed in the Terminal, along with the build time.

  1. Do one of the following to start the Hybris server, so that you can deploy the Connector:
  • In Windows: In the Command Prompt window, type hybrisserver.bat and press Enter.
  • In Unix: In the Terminal, type hybrisserver.sh and press Enter.

This takes a few minutes to run.

  1. Update the Hybris suite.
    1. Open the Hybris Administration Console in a browser, at http://localhost:9001.
    2. Mouseover the Platform tab.
    3. Click the Update menu item.
The **Update** page opens.

Note: If you are updating from a previous version of the Connector, scroll down, and clear the Create essential data and Localize types check boxes.

d. Click the Update button to start updating Hybris with the Connector.

This takes a few minutes to run.

e. When it is done, scroll down to the bottom of the page.

The console displays FINISHED, along with the updating time.

  1. In Backoffice, open Orchestrator mode:
  • In Microsoft Windows, press the F4 key.
  • In UNIX, press the fn and F4 keys.
  1. Click the Orchestrator hamburger menu in the top-right corner, and select Reset Everything from the menu.

This clears cached UI configurations and loads new added widgets, including their styles,

  1. Close Orchestrator mode.
  • In Microsoft Windows, press the F4 key.
  • In UNIX, press the fn and F4 keys.

For more information about updating the Hybris suite, see: https://wiki.hybris.com/display/release5/Initializing+and+Updating+the+hybris+Commerce+Suite.

4.1 - Upgrading the Connector Database

This section describes how to upgrade the Connector database.

Important: This step is required when updating your Connector installation from version 2.1.x-2.4.0 to the current version. It is required to support changes to how classification content mapping is saved in the Connector database.

To upgrade the Connector database:

  1. Open the Hybris Administration Console in a browser. For detailed instructions, refer to the SAP Commerce documenation at: https://help.sap.com/viewer/5c9ea0c629214e42b727bf08800d8dfa/1905/en-US/7d4ea11ee6da48b5b3b49304ab52b9f0.html.

  2. Mouseover the Platform tab.

  3. Click the Update menu item.

The Update page opens.

  1. Ensure that in the General settings section, all the check boxes are selected.

  2. Ensure that in the Project data settings section, the check box for the ctcore extension item (not shown) is selected.

  1. At the bottom of the page, click the Update button to start updating the Connector database.

  2. In the the Hybris Administration Console, click the Console tab and then click ImpEx Import.

  3. Run the following ImpEx:

$targetType=CtConfigContentMapping

REMOVE $targetType[batchmode=true];itemtype(code)[unique=true]

;$targetType

5 - Configuring the Lionbridge Connector

After you install the Connector, you configure your Connector installation in Backoffice.

To View System Information:
  1. Do one of the following:
  • In Hybris:
  1. In your Web browser, navigate to /backoffice/ on your Hybris instance.
  2. Log in to the Hybris Backoffice.
  3. In the Administration menu, select ConnectorConfig.

In the System Information section User can see below Information:

  • SAP CC Version

  • Connector Version

  • Build

To configure the Connector:
  1. Do one of the following:
  • In Hybris:
  1. In your Web browser, navigate to /backoffice/ on your Hybris instance.
  2. Log in to the Hybris Backoffice.
  3. In the Administration menu, select ConnectorConfig.
  4. In the secondary ConnectorConfig menu that opens, select System Configuration.
  • In SAP Commerce or SAP Commerce Cloud:

  1. In your Web browser, navigate to /backoffice/ on your SAP Commerce instance or on SAP Commerce Cloud.

  2. Log in to SAP Commerce or SAP Commerce Cloud.

  3. In the Administration Cockpit menu, select ConnectorConfig.

  4. In the secondary ConnectorConfig menu that opens, select System Configuration.

  5. Configure the settings in the following sections:

Section Detailed Configuration Instructions
Add LSP LSP Configuration
Connector Configurations–Translation Settings Configuring Translation Settings
Connector Configurations–Language Mapping Mapping Language Codes
Connector Configurations–Network Settings Configuring Proxy Server Implementations
Connector Configurations–Email Settings Configuring Email Settings
Connector Configurations–Translation URL Conversion Settings Configuring Translation URL Conversion Settings
  1. In the ConnectorConfig menu, select Content Mapping to open the Content Mapping page.

  • In the Item Type Attributes tab, you configure the localized Item Type attributes of business objects and sub-types to send out for translation. For detailed instructions, see Configuring Business Objects, Sub-Types, and Localized Attributes.

  • Optional. In the Classification Attributes tab, you can configure the product classification attributes of business objects that are Products for the Connector to send for translation. All classification attributes belong to a category. When you add a product to a category, Hybris or SAP Commerce attaches those attributes to it. For detailed configuration instructions, see Configuring Product Classification Attributes for Translation.

  1. Optional. In Hybris versions 6.1 or 6.2, you can configure the multi-select feature to support sending multiple products and pages for translation concurrently from the Hybris Backoffice. For detailed instructions, see Configuring the Multi-Select Feature in Hybris.

Note: This step is not relevant for Hybris versions 6.3 or higher, SAP Commerce, or SAP Commerce Cloud.

  1. Optional. You can configure how frequently the Connector sends jobs to the Lionbridge Content API Platform. For detailed instructions, see Configuring the Frequency of Sending Jobs to the Lionbridge Content API Platform.

Important: You must configure your browser to allow pop-up windows on the Hybris, SAP Commerce, or SAP Commerce Cloud server.

5.1 - LSP Configuration

Setting Up Your Connector License

You set up your Connector license in the License Configuration section of the System Configuration page.

To set up your License Configuration:

  1. Open the System Configuration page. For detailed instructions, see Configuring the Lionbridge Connector.

  2. In the License Configuration](#) section of the System Configuration page, in the Client ID and Client Secret field, enter your Client ID and Client Secret key, which you obtain from Lionbridge.

  1. Click Save License.

A message box opens, stating Save License Sucessfully.

Configuring your LSP:

Once you setup your connector license in the previous step and click Save License, you should see your Providers(#) list automatically refreshes to show you providers available with your license.

  • ID: Provider.
  • Name: Name for the language service provider (LSP). This is what your users will select when sending out content for translation to this provider.
  • Type: Select your translation provider. The type of translation provider determines whether additional configuration is required.
  • Operation: You can enable or disable the provider. Disabled providers would not be available as an option when you send out content to translation.

If you need more providers configured, please contact Lionbridge support team.

Click REFRESH PROVIDERS to see latest updates.

5.2 - Legacy LSPs Configuration

If you have upgraded your Lionbridge connector from an earlier (2.x) version, your previous LSP configuration will show up in the Legacy LSPs Configuration section. They are maintained so that you can still receive back any pending jobs sent to those legacy LSPs. You won’t be able to send any new jobs out to legacy LSPs though. If you have done a brand-new installation of the connector, this section won’t appear on your System Configuration screen.

You cannot make any changes to legacy license settings and legacy LSPs. The only operations you can perform in this section are:

  • Disable/Enable Legacy LSPs: You can disable all legacy LSPs. By doing so, the connector will stop checking for any jobs returning from those legacy LSPs. You can also re-enable all legacy LSPs after you disable them. After re-enabled them, the connector will restart checking for jobs returning from legacy LSPs.

  • Remove Legacy LSPs: You can remove all legacy LSPs. After that, the Legacy LSPs Configuration section will disappear from your System Configuration screen.

Important: You cannot reverse the operation once, you remove legacy LSPs, you cannot get them back, and if there are any outstanding jobs sent to any of those legacy LSPs, the connector won’t be able to receive the translation back for those jobs. So please make sure you have completed all outstanding jobs. Removing legacy LSPs does not affect completed jobs sent to legacy LSPs in the past. You can still see them in the Translation Jobs view and check their job details on the Job Details page.

5.3 - Configuring Translation Settings

In the Translation Settings section of the System Configuration page, you configure the following settings:

  • the maximum number of items in a translation file
  • how frequently to download and import translations
  • whether you can receive revisions of translated content, which determines whether approval is required for a job
To configure translation settings:

  1. Open the System Configuration page. For detailed instructions, see Configuring the Lionbridge Connector.

  2. Locate the Translation Settings section of the System Configuration page.

Tip: Depending on your screen size and resolution, you may need to scroll down to view this section.

  1. Configure any of the following settings:
Setting Description
Maximum number of items per translation file This setting enables you to configure the maximum number of items in a translation file generated by the Connector. An item is an asset that is being translated into a specific target language.

For example, suppose you are translating 150 assets from one source language into three target languages. If you use the default value of 100, then for each language pair, there are 2 translation files, and there are a total of 6 generated files.

By default, the maximum number of items that the Connector sends out for translation in a single translation file is 100. You can change this number by selecting one of the following numbers instead: 150, 200, or 250.
Cron Job Interval (Minutes) This setting enables you to configure how frequently to download and import translations.

The ctPerformable CronJob automatically downloads and imports translations from the Lionbridge Content API Platform into Hybris. By default, this CronJob runs once every minute.

This CronJob consumes resources such as memory space, network bandwidth, and database connections. Therefore, by design, the CronJob is active only when required, which is when the Connector submits a translation job and expects translated content to return from the Lionbridge Content API Platform. When the CronJob is active, it polls the Lionbridge Content API Platform to update the job status and retrieve any translated content.

At the start of each interval, the CronJob checks whether it is required to remain active. If it is not required, it de-activates internally. It automatically re-activates when there is a job to retrieve.

You can change this interval so that the CronJob runs every 5 or 10 minutes.

Note: If the Lionbridge Content API Platform is waiting for a message about translated content for a submitted job, and a network outage prevents this message from being delivered, the CronJob keeps polling the Lionbridge Content API Platform until the job is manually stopped.

Tip: You can temporarily prevent this job from running and consuming resources, for example, if you are not currently sending out content items for translation. For detailed instructions, refer to the appropriate version of the Hybris documentation at https://wiki.hybris.com.
Enable multiple deliveries This optional setting enables receiving revisions of translated content and requires approval for received translations.

* If this check box is selected:
* In the **Translation Status** column of the **Translation Jobs** page:
* The status of delivered projects is Reviewing Translation.
* The **Approve** button is displayed.
* You can click the **Approve** button to mark the job as complete, which prevents any re-deliveries.
* Multiple re-deliveries are allowed and processed into SAP Commerce until clicking the **Approve** button in the **Translation Jobs** page, which marks the job as complete.
* If this check box is cleared (the default setting):
* In the **Translation Status** column of the **Translation Jobs** page, the status of delivered projects is Completed.
* There is no approval step.
* Multiple re-deliveries are not supported.
  1. Click Save Translation Settings.

Note: Saving these settings creates and registers the ctPerformable CronJob with the interval you specified.

5.4 - Mapping Language Codes

You map Hybris language codes to Lionbridge language codes in the Language Mapping section of the System Configuration page.

You must map the Hybris language codes to the Lionbridge language code for the source and target languages that you will use for translation. Otherwise, then Connector will not send out content for translation.

For a list of Lionbridge language code, see Appendix: Language Codes.

To map language codes:

  1. Open the System Configuration page. For detailed instructions, see Configuring the Lionbridge Connector.

  2. Locate the Language Mapping section of the System Configuration page.

Tip: Depending on your screen size and resolution, you may need to scroll down to view this section.

  1. Perform the following steps for each language to map:

  2. In the Hybris Language Code list, select the Hybris language code to map.

Tip: Languages that are already mapped are displayed in gray with a gray background. Languages that are not currently mapped are displayed in black with a white background.

  1. In the Lionbridge language code list, select the corresponding Lionbridge language code to map.

  2. Click Add Language.

The list at the bottom of the section now displays the mapping you just added.

Tip: To delete a language mapping, click the corresponding Delete button .

5.5 - Configuring Proxy Server Implementations

You can configure proxy server implementations of the Connector in the Network Settings section of the System Configuration page.

To configure a proxy server:

  1. Open the System Configuration page. For detailed instructions, see Configuring the Lionbridge Connector.

  2. Locate the Network Settings section of the System Configuration page.

Tip: Depending on your screen size and resolution, you may need to scroll down to view this section.

  1. In the Use Proxy Server dropdown list, select Yes.

The section expands.

  1. Edit the following information:
Field Description
Host Required. The IP address or domain name for the proxy server.
Port Required. The port number for the proxy server.
User Optional. The username for authentication to the proxy server.
Password Optional. The password for authentication to the proxy server.
NTLM Domain Optional. The domain for authentication to the proxy server.

  1. Click Test Proxy Settings.

  2. If the test is successful, click Save Network Settings.

5.6 - Configuring Attributes for Translation

There are two ways to configure business objects, sub-types, and localized attributes, including keywords, for translation:

5.6.1 - Configuring Business Objects, Localized Attributes, and Sub-Types

In the Content Mapping page, you can configure which business objects and localized attributes and sub-types in those objects the Connector will send for translation. The Mapped Content section, on the right side of that page, displays all configured objects, localized attributes, and sub-types, including localized attributes of sub-types.

Important: You can configure only localized attributes for the Connector. If there are attributes you want to send out for translation that are not localized by default, you must configure them to be localized. For detailed instructions, refer to “Localized Attributes” in the Internationalization and Localization Overview in the SAP Commerce documentation, available at: https://help.sap.com/viewer/d0224eca81e249cb821f2cdf45a82ace/6.3.0.0/en-US/8bfc204086691014a345f64b08505839.html.

Note: In exceptional cases, configuring certain business objects and localized attributes, as described below, may not be sufficient to support the Connector sending them out for translation, and custom code may be required.

Tip: To translate content slot components, such as CMSParagraphComponent, you must map them.

To configure a localized attribute of a business object or sub-type so that the Connector can send it out for translation:
  1. Do one of the following:
  • In Hybris:
  1. In your Web browser, navigate to /backoffice/ on your Hybris instance.
  2. Log in to the Hybris Backoffice.
  3. In the Administration menu, select ConnectorConfig.
  • In SAP Commerce or SAP Commerce Cloud:
  1. In your Web browser, navigate to /backoffice/ on your SAP Commerce instance or on SAP Commerce Cloud.
  2. Log in to SAP Commerce or SAP Commerce Cloud.
  3. In the Administration Cockpit menu, select ConnectorConfig.

The Item Type Attributes tab of the Content Mapping page opens.

  • The Type Content Mapping section, on the left side of the tab, displays all the available business objects and sub-types.
  • The Mapped Content section, on the right side of the tab, displays all business objects and sub-types, and their corresponding attributes, that have already been mapped.

The section footers display the total number of items in each list, and the total number of items displayed on this sub-page of the list.

  • If there are more than seven items in the Type Content Mapping section, they are displayed in multiple sub-pages.
  • If there are more than twelve items in the Mapped Content section, they are displayed in multiple sub-pages.

Tip: Use the sub-page nagivation arrows to navigate between sub-pages. To navigate among sub-pages, at the bottom of the list, click an arrow or enter the number of the sub-page to display.

  1. In the Type Content Mapping section of the page, use the Name and/or Identifier fields at the top of the section to search for the business object or sub-type you want to be available for translation. By default, the Include relations check box is selected, so that Relation type attributes and types that contain only Relation type attributes to one level of recursion are also displayed. If you want to exclude these attributes and types from the search results, clear this check box. Then click Search.

Note: You can configure the number of recursion levels for the Relation type attributes and types that contain only Relation type attributes that are displayed in search results. For detailed instructions, see Configuring the Number of Recursion Levels for Relation Type Attributes.

The list below the Search button updates with the search results. For example, if you searched for business objects with the name Product, the list displays all matching results, which are objects or sub-types with Product in their name.

  1. In the search results, click the row for the business object or sub-type to map.

A dialog box opens, displaying the object’s or sub-type’s localized attributes. The title of the dialog box is the object or sub-type.

  1. Configure the localized attributes for translation. a. Select the check boxes for the localized attributes to configure for translation.

Tip: To select all check boxes, click the check box in the Name column header.

b. Click Save Content.

A message box states that the selected localized attributes were successfully saved.

c. Click OK to close the message box.

Note: Use the above steps to add additional localized attributes to a previously configured business object or sub-type.

To edit or delete configured business objects or sub-types:
  1. Do one of the following:
  • In Hybris:
  1. In your Web browser, navigate to /backoffice/ on your Hybris instance.
  2. Log in to the Hybris Backoffice.
  3. In the Administration menu, select ConnectorConfig.
  • In SAP Commerce or SAP Commerce Cloud:
  1. In your Web browser, navigate to /backoffice/ on your SAP Commerce instance or on SAP Commerce Cloud.
  2. Log in to SAP Commerce or SAP Commerce Cloud.
  3. In the Administration Cockpit menu, select ConnectorConfig.

The Content Mapping page opens. The Mapped Content section on the right side of the page displays all the previously configured business objects and sub-types.

  1. Locate the configured business object to edit or delete, and click the corresponding row.

Tip: Use the sub-page nagivation arrows to navigate between sub-pages. To navigate among sub-pages, at the bottom of the list, click an arrow or enter the number of the sub-page to display.

A dialog box opens. The title of the dialog box is the object or sub-type.

Tip: Use the sub-page nagivation arrows to navigate between sub-pages. To navigate among sub-pages, at the bottom of the list, click an arrow or enter the number of the sub-page to display.

  1. Do one of the following:
  • To edit the localized attributes to configure for translation, select or clear the appropriate check boxes, and then click Save Content.

A message box states that the configuration was saved.

  • To remove the object or sub-type from configuration for translation, cllick Remove Content.

A message box states that the item was deleted.

5.6.1.1 - Configuring the Number of Recursion Levels for Relation Type Attributes

You can configure the number of recursion levels for the Relation type attributes and types that contain only Relation type attributes that are displayed in search results in the Item Type Attributes tab of the Content Mapping page. For more information about this tab, see Configuring Business Objects, Sub-Types, and Localized Attributes.

By default, when the Include relations check box is selected, one level of recursion of the Relation type attributes is displayed in search results. However, you can change the number of levels of recursion of the Relation type attributes that is displayed in the search results.

Warning: Changing the default value of 1 to a larger number may produce large process-consuming tasks that can affect system performance.

To change the number of levels of recursion of the Relation type attributes:

  1. Open {HYBRIS_HOME}/hybris/bin/custom/ctcore/project.properties for editing.

  2. Locate the contentextraction.requestsSourcesExtractionRecursivenessMaxDepth parameter.

  3. Change the value of this parameter to any integer.

Note: The default value of this parameter is 1.

  1. Save your change.

5.6.2 - Configuring Product Classification Attributes for Translation

For business objects that are Products, you can configure the product classification attributes that the Connector will send for translation. All classification attributes belong to a category. When you add a product to a category, Hybris or SAP Commerce attaches those attributes to it. For more information about this feature, refer to the classification documentation at: https://help.sap.com/viewer/eb9d43275268474aa75793d699de709b/6.4.0.0/en-US/8b7aa49c86691014ae51c3b0d38cd87b.html.

To configure product classification attributes for translation:
  1. Do one of the following:
  • In Hybris:
  1. In your Web browser, navigate to /backoffice/ on your Hybris instance.
  2. Log in to the Hybris Backoffice.
  3. In the Administration menu, select ConnectorConfig.
  • In SAP Commerce or SAP Commerce Cloud:
  1. In your Web browser, navigate to /backoffice/ on your SAP Commerce instance or on SAP Commerce Cloud.
  2. Log in to SAP Commerce or SAP Commerce Cloud.
  3. In the Administration Cockpit menu, select ConnectorConfig.

The Item Type Attributes tab of the Content Mapping page opens.

  1. Click the Classification Attributes link in the top of the page to open the corresponding tab.

  1. In the Filter Tree in the left pane, navigate in the catalogs and classification to select a classifying category. For example, navigate to: Powertools Classification classification system > Powertools Classification: 1.0 classification system version > Weight & Dimensions classifying category.

Note: In Backoffice, you can choose which classification to enable. For details, refer to the documentation, available at: https://help.sap.com/viewer/eb9d43275268474aa75793d699de709b/6.4.0.0/en-US/8b7aa49c86691014ae51c3b0d38cd87b.html.

The Mapped Content pane on the right displays a list of all classification entries with attributes mapped.

  1. To map the classification attributes, so that the Connector can send them out for translation, navigate in the catalogs and classification to select the corresponding classifying category ,select the corresponding check box, or to select all classification attributes of the classifying category, select the check box in the Namecolumn header.

  2. Click Map Attributes.

A message box confirms that the configuration was saved.

  1. Click OK to close the message box.

  2. Repeat steps 3 through 6 for all the classification attributes to configure for translation.

5.7 - Configuring the Multi-Select Feature in Hybris

In Hybris versions 6.1 and 6.2, if you want to select multiple products and website pages (“pages”) for translation concurrently in the Hybris Backoffice, you must enable the multi-select feature by configuring the multiSelect setting, as described below:

Note: This feature is enabled by default in Hybris versions 6.3 and higher.

To enable the multi-select feature in Hybris versions 6.1 and 6.2:

  1. Log into the Hybris Backoffice Administration Cockpit (“Backoffice”).

  2. Press the F4 key.

The Application Orchestrator opens.

  1. In the toolbar at the top, select the Symbolic Widgets](#) check box.

The page updates.

  1. Scroll down to locate the Collection Browser.

  2. Click the Widget Settings](#) icon of the Collection Browser.

The Settings dialog box opens.

  1. Scroll down to the multiSelect](#) option, and in the corresponding dropdown list, select true.

  1. In the bottom-right corner, click Close the dialog box.

  2. Press the F4 key to close the Application Orchestrator.

5.8 - Configuring the Frequency of Sending Jobs to the Lionbridge Content API Platform

You can configure how frequently the Connector sends jobs to the Lionbridge Content API Platform.

The Connector uses the ctTranslationJobProcessorPerformable cron job to send translation jobs to the Lionbridge Content API Platform. This cron job runs by default every minute.

You may want to modify the interval that this job runs, depending on your priorities or requirements for system resources.

To modify the interval of the ctTranslationJobProcessorPerformable cron job:
  • Navigate to the Administration Cockpit > Background Processes > Cronjobs section.

5.9 - Configuring Email Settings

Starting from the Connector version 2.4.3, support for sending e-mail notifications is added. With this, an email notification is sent whenever a file passes through the translation events such as Job Submission, Job Received, and Job Errors. To receive these email notifications, users must configure the email notification settings.

To configure the email notifications in the application:

  1. Go to Administration > Connector Configuration > Content Mapping > System Configuration > Email Setting.

  2. Configure the following SMTP settings for the email address:

    • SMTP Host

    • SMTP Port

    • Need Authentication

    • [SMTP Auth] User

    • [SMTP Auth] Password

    • Transfer Protocol

    • Notification Email From

    • Notification Email To

      The Connector sends notifications to the email addresses specified in the Notification Email To field.

  3. Click EDIT MAIL SETTING.

  4. Click SAVE MAIL SETTING.

After saving email settings, two new buttons (CLEAR EMAIL SETTING, TESTING MAIL SETTING) appear at the bottom of the Email Settings screen.

You can also configure a new email setting by clicking CLEAR EMAIL SETTING, which removes existing settings.

Testing an Email Setting

After the email setting is configured, test it to verify the configuration is successful and you are receiving a test email notification.

  1. To test an email setting, click TESTING MAIL SETTING in the Email Setting screen. A dialogue box appears with a success message as follows:

  2. A test email notification will be sent to the email address specified in Notification Email To field. The following is an test email notification:

Similarly, the email notifications are sent when a translation is submitted, received, and has errors.

5.10 - Configuring Translation URL Conversion Settings

When there are links in content for translation, and if you automatically want to update the links in the translated content, use Translation URL Conversion functionality.

To configure settings for Translation URL Conversion in translated content:

  1. Go to Administration > Connector Configuration > Content Mapping > System Configuration > Translation URL Conversion> click Add URL Conversion.

  2. Specify the following URL conversion settings for a target language:

  • URL—Enter the base URL of the links in the source content. For example, http://example.com

  • To—Enter the desired base URL for the links in the target (translated) content, for example, http://ja-jp.example.com

  • For —Select the target language code for applying this URL conversion rule.

  • Rule —Select any of the following options:

    • Full —Select this to convert the URL only if it is identical to the base URL specified.

      For example:

      URL: www.google.com and To: www.google.it

    • Partial— Select this to convert the URL that includes the base URL specified.

      For example:

      URL: www.google.com and To: http://www.google.com/content/us/en

    • IsConvertLinkText— Select any of the following options:

      • Yes—Select this for converting the link text along with the URL.

      • No—Select this for not converting the link text.

      The following are the examples for Full and Partial URL conversion.

      Full URL conversion example:

      Settings:

      Source:

      Target:

      Partial URL conversion example:

      Settings:

      Source:

      Target:

6 - Pre-Production Testing

After you complete the configuration, your Lionbridge Connector for Hybris installation is ready for testing. We recommend sending only a few pages for translation in one language as an initial test. For detailed instructions, refer to the Lionbridge Connector for Hybris User Guide. Once successful, you can send as many languages as required.

Please coordinate with your translation provider for this test process.

If you have any concerns or questions, please contact Lionbridge Connector Support. For details, see How to Contact Lionbridge Connector Support.

7 - Appendix Language Codes

For detailed instructions on mapping Hybris languages to Lionbridge languages, see Mapping Language Codes.

The Lionbridge Connector has the following language codes:

Type Language Identifier Language Code
String Afrikaans “af-ZA”
String Albanian “sq-AL”
String Amharic “am-ET”
String Arabic_Algeria “ar-DZ”
String Arabic_Bahrain “ar-BH”
String Arabic_Egypt “ar-EG”
String Arabic_Iraq “ar-IQ”
String Arabic_Jordan “ar-JO”
String Arabic_Kuwait “ar-KW”
String Arabic_Lebanon “ar-LB”
String Arabic_Libya “ar-LY”
String Arabic_MiddleEast “ar-XR”
String Arabic_Morocco “ar-MA”
String Arabic_Oman “ar-OM”
String Arabic_Qatar “ar-QA”
String Arabic_Saudi_Arabia “ar-SA”
String Arabic_Syria “ar-SY”
String Arabic_Tunisia “ar-TM”
String Arabic_UAE “ar-AE”
String Arabic_Yemen “ar-YE”
String Armenian “hy-AM”
String Assamese “as-IN”
String Basque “eu-ES”
String Belarusian “be-BY”
String Bengali_Bangladesh “bn-BD”
String Bengali_India “bn-IN”
String Bosnian_Bosnia_Herzegovina “bs-BA”
String Bulgarian “bg-BG”
String Burmese “my-MM”
String Catalan “ca-ES”
String Chinese_Hong_Kong “zh-HK”
String Chinese_Macao “zh-MO”
String Chinese_PRC “zh-CN”
String Chinese_Singapore “zh-SG”
String Chinese_Taiwan “zh-TW”
String Croatian “hr-HR”
String Croatian_Bosnia_Herzegovina “hr-BA”
String Czech “cs-CZ”
String Danish “da-DK”
String Divehi “dv-MV”
String Dutch “nl-NL”
String Dutch_Belgium “nl-BE”
String English_Australia “en-AU”
String English_Belize “en-BZ”
String English_Canada “en-CA”
String English_HongKong “en-HK”
String English_India “en-IN”
String English_Indonesia “en-ID”
String English_Ireland “en-IE”
String English_Jamaica “en-JM”
String English_Malaysia “en-MY”
String English_New_Zealand “en-NZ”
String English_Philippines “en-PH”
String English_Singapore “en-SG”
String English_South_Africa “en-ZA”
String English_Trinidad “en-TT”
String English_UK “en-GB”
String English_US “en-US”
String English_Zimbabwe “en-ZW”
String Estonian “et-EE”
String Faroese “fo-FO”
String Farsi “fa-IR”
String Filipino “fil-PH”
String Finnish “fi-FI”
String French “fr-FR”
String French_Belgium “fr-BE”
String French_Cameroon “fr-CM”
String French_Canada “fr-CA”
String French_Cote_d_Ivoire “fr-CI”
String French_Democratic_Rep_Congo “fr-CD”
String French_Haiti “fr-HT”
String French_Luxembourg “fr-LU”
String French_Mali “fr-ML”
String French_Monaco “fr-MC”
String French_Morocco “fr-MA”
String French_Reunion “fr-RE”
String French_Senegal “fr-SN”
String French_Switzerland “fr-CH”
String Frisian_Netherlands “fy-NK”
String Fulfulde_Nigeria “ff-NG”
String FYRO_Macedonian “mk-MK”
String Gaelic_Ireland “gd-IE”
String Gaelic_Scotland “gd-GB”
String Gallegan “gl-ES”
String Georgian “ka-GE”
String German “de-DE”
String German_Austria “de-AT”
String German_Liechtenstein “de-LI”
String German_Luxembourg “de-LU”
String German_Switzerland “de-CH”
String Greek “el-GR”
String Guarani “gn-PY”
String Gujarati “gu-IN”
String Hausa “ha-NE”
String Hawaiian “haw-US”
String Hebrew “he-IL”
String Hindi “hi-IN”
String Hungarian “hu-HU”
String Icelandic “is-IS”
String Igbo “ig-NG”
String Indonesian “id-ID”
String Inuktitut “iu-CA”
String Italian “it-IT”
String Italian_Switzerland “it-CH”
String Japanese “ja-JP”
String Kannada “kn-IN”
String Kanuri “kr-TD”
String Kashmiri “ks-IN”
String Kazakh “kk-KZ”
String Khmer “km-KH”
String Konkani “kok-IN”
String Korean “ko-KR”
String Kyrgyz “ky-KZ”
String Lao “lo-LA”
String Latin “la-XL”
String Latvian “lv-LV”
String Lithuanian “lt-LT”
String Malay “ms-MY”
String Malay_Brunei_Darussalam “ms-BN”
String Malayalam “ml-IN”
String Maltese “mt-MT”
String Maori “mi-NZ”
String Marathi “mr-IN”
String Mongolian “mn-MN”
String Nepali “ne-NP”
String Nepali_India “ne-IN”
String Norwegian “nb-NO”
String Norwegian_Nynorsk “nn-NO”
String Oriya “or-IN”
String Oromo “om-ET”
String Panjabi “pa-PK”
String Polish “pl-PL”
String Portuguese “pt-PT”
String Portuguese_Brazil “pt-BR”
String Punjabi_Pakistan “pa-PK”
String Pushto “ps-AF”
String Quechua_Ecuador “qu-EC”
String Quechua_Peru “qu-PE”
String Rhaeto_Romance “rm-IT”
String Romanian “ro-RO”
String Romanian_Moldova “ro-MD”
String Russian “ru-RU”
String Russian_Moldava “ru-MD”
String Sami “se-NO”
String Sanskrit “sa-IN”
String Serbian_Cyrillic “sr-RS”
String Serbian_Latin “sr-SP”
String Sindhi_India “sd-IN”
String Sindhi_Pakistan “sd-PK”
String Sinhala “si-LK”
String Slovak “sk-SK”
String Slovenian “sl-SI”
String Somali “so-ET”
String Sorbian “wen-DE”
String Spanish “es-ES”
String Spanish_Argentina “es-AR”
String Spanish_Bolivia “es-BO”
String Spanish_Chile “es-CL”
String Spanish_Colombia “es-CO”
String Spanish_Costa_Rica “es-CR”
String Spanish_Dominican_Republic “es-DO”
String Spanish_Ecuador “es-EC”
String Spanish_El_Salvador “es-SV”
String Spanish_Honduras “es-HN”
String Spanish_LatinAmerica “es-XL”
String Spanish_Mexico “es-MX”
String Spanish_Nicaragua “es-NI”
String Spanish_Panama “es-PA”
String Spanish_Paraguay “es-PY”
String Spanish_Peru “es-PE”
String Spanish_Puerto_Rico “es-PR”
String Spanish_Uruguay “es-UY”
String Spanish_US “es-US”
String Spanish_Venezuela “es-VE”
String Swahili “sw-TZ”
String Swedish “sv-SE”
String Swedish_Finland “sv-FI”
String Syriac “syr-SY”
String Tajik “tg-TJ”
String Tamil “ta-IN”
String Tatar “tt-RU”
String Telugu “te-IN”
String Thai “th-TH”
String Tibetan “bo-CN”
String Tigrinya_Eritrea “ti-ER”
String Tigrinya_Ethiopia “ti-ET”
String Tsonga “ts-ZA”
String Tswana “tn-BW”
String Turkish “tr-TR”
String Turkmen “tk-TM”
String Uighur “ug-CN”
String Ukrainian “uk-UA”
String Urdu “ur-PK”
String Urdu_India “ur-IN”
String Uzbek “uz-UZ”
String Venda “ve-ZA”
String Vietnamese “vi-VN”
String Welsh “cy-GB”
String Xhosa “xh-ZA”
String Yi “ii-CN”
String Yiddish “yi-MD”
String Yoruba “yo-NG”
String Zulu “zu-ZA”

8 - Appendix API for Automatic Translation Jobs Creation

Lionbridge Connector for SAP Commerce supports an API to create translation job programmatically using the defaultCtProducerClient bean:

/**

* The bean creates a Translation Job that will be sent by the connector’s cron job. Example usage in psuedo-code:

* ctproducerclient = spring.getBean(“defaultCtProducerClient”);

* modelService = spring.getBean(“modelService”);

* for (…) {

* //… gather a list of items

* long examplePK = 8796093251585L;

* item = modelService.get(PK.fromLong(examplePK));

* items.add(item)

* }

* provider = ctproducerclient.getProviderByName(“WorldServer Test”);

* ctproducerclient.createJobFromItemModels(“test job”, “this is a test”, null, “123456”, null, provider.getId(), “en”, {“fr”, “es”}, items);

* @param jobName Name of translation job

* @param jobDescription Description of the job

* @param dueDate Due date. Optional.

* @param poReference Purchase Order reference. Optional.

* @param sourceLanguage Source language code (Hybris)

* @param targetLanguages List of target language codes (Hybris)

* @param lspId ID of TranslationProvider. See getProviderByName(String providerName)

* @param itemsToTranslate List of Hybris ItemModels to translate. Can be retrieved using

* ModelService or FlexibleSearchService, for example.

*/

void createJobFromItemModels(

final String jobName, final String jobDescription,

final Date dueDate, final String poReference,

final String sourceLanguage, final String[] targetLanguages,

final String lspId, List<ItemModel> itemsToTranslate);