Installing the Lionbridge Connector into Hybris or SAP Commerce

  4 minute read  

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.