SAP Commerce Cloud

The first step to use the plugin is the installation process. Before you proceed, make sure your infrastructure meets these system requirements:

On top of these prerequisites, make sure to respect the extension structure:

Once done, follow these steps:

1. Install SAP Commerce using ‘cx’ Recipe

SAP provides instructions for using the installation recipes in the SAP Help Portal. If you are unfamiliar with the general installation process, make sure to read through this before the installation.

• Download SAP Commerce in .Zip format. Unzip the platform and navigate to the ‘installer’ directory.
• Run the following command: Replace ‘your_password’ with your desired administrator password for the system.

./install.sh -r cx -A local_property:initialpassword.admin=your_password

• Run the following to build and initialise the system:

./install.sh -r cx initialize -A local_property:initialpassword.admin=your_password

• Add Extensions to Codebase
  Download and unzip the file
  Confirm you have received the following directory structure

hybris/
           config/
           bin/
                       custom/
                                     worldline/

• The config directory contains a sample set of configurations in the local.properties file. Copy these configurations into the local.properties file generated after the SAP Commerce installation.
• The config directory also contains a localextensions.xml file. Add the following from this file to your own localextensions.xml file that was generated after the SAP Commerce installation:

<!-- WORLDLINE -->
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectcore"/>
You will require an existing installation of SAP Commerce in order to be able to use the Worldline Direct
plugin. If you already have an installation of SAP Commerce with the B2C Accelerator and its
corresponding extensions included, you can skip this step.
Worldline – SAP Commerce Cloud Documentation
Technical Documentation – 9
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/
worldlinedirectb2ccheckoutaddon"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectbackoffice"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectocc"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectwebhook"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/
worldlinedirectcustomersupportbackoffice"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/
worldlinedirectfulfilmentprocess"/>

• The bin/custom/worldline directory contains all required extensions. Copy them into your own hybris/bin/custom/worldline directory. If you wish to put these extensions in a different directory, update your localextensions.xml accordingly.

2. Install Extension to Storefront

• You may need to run the following command to ensure the correct addons are available in your storefront:

  
   ant addoninstall
   
-Daddonnames=
   
"adaptivesearchsamplesaddon,assistedservicecustomerinterestsaddon,assistedserviceprom
   
otionaddon,assistedservicestorefront,assistedserviceyprofileaddon,captchaaddon,config
   
urablebundleaddon,consignmenttrackingaddon,customercouponaddon,customercouponsamplesa
   
ddon,customerinterestsaddon,customerticketingaddon,eventtrackingwsaddon,merchandising
   
addon,merchandisingstorefrontsampledataaddon,multicountrysampledataaddon,notification
   
addon,ordermanagementaddon,orderselfserviceaddon,pcmbackofficesamplesaddon,personaliz
   
ationaddon,personalizationsampledataaddon,personalizationyprofilesampledataaddon,prof
   
iletagaddon,selectivecartsplitlistaddon,smarteditaddon,stocknotificationaddon,textfie
   
ldconfiguratortemplateaddon,timedaccesspromotionengineaddon,timedaccesspromotionengin
   
esamplesaddon,xyformssamples,xyformsstorefrontcommons,ysapproductconfigaddon"
   
-DaddonStorefront.yacceleratorstorefront="<YOUR-STOREFRONT>"

  

Replace <YOUR-STOREFRONT> with your storefront extension’s name, e.g. yacceleratorstorefront or <project>storefront

• Install the Addon to your Storefront, use the following command:

ant addoninstall -Daddonnames="worldlinedirectb2ccheckoutaddon"
-DaddonStorefront.yacceleratorstorefront="<YOUR-STOREFRONT>"

• Now rebuild your system:

ant clean all

• Perform either an initialisation or system update. You can do both via the Hybris Administration Console (HAC) at https://<your-server>:9002/hac or you can initialize this via the ant target:

ant initialize

After the installation, you need to configure the plugin to link your store to our platform.

This section of the documentation will cover technical configuration elements only. For business configuration within the SAP Backoffice, check this section.

Configure properties

• From worldlinedirectcore/project.properties :

worldline.direct.api.authorizationType=V1HMAC
worldline.direct.api.connectTimeout=10000
worldline.direct.api.socketTimeout=10000
worldline.direct.api.maxConnections=10
worldline.direct.api.integrator=Worldline

The Java SDK passes these configurations and controls the connectivity. Have a look at our dedicated Java SDK documentation for more information.

• From worldlinedirectbackoffice/project.properties:

worldline.contact.support.default.cc=
worldline.contact.support.default.bcc=
worldline.contact.support.default.subject=default subject

These configurations control the button within the SAP Back Office which is used to contact us for support via email.

• From worldlinedirectocc/project.properties:

worldline.occ.hostedCheckout.returnUrl=https://localhost:9002/occ/v2/%s/users/%s/orders/%s/hostedcheckout
worldline.occ.hostedTokenization.returnUrl=https://localhost:9002/occ/v2/%s/users/%s/orders/%s/hostedtokenization/return3ds

These configurations set the value for the Server API’s property HostedCheckoutSpecificInput.ReturnUrl to ensure your customers correct redirection to your webshop environment. It is important to update these values to reflect your system’s URL.

Configure Webhooks

The plugin uses webhooks to get the current status of your transactions from our platform. SAP Commerce uses the endpoint /worldline/webhook to receive these status updates.

Configure a WebhooksKey, WebhooksKeySecret and Endpoint URLs in your PSPID as described in our dedicated guide. Make sure the URL:

• Contains your site’s hostname '(i.e. https://<your-domain>:9002/worldline/webhook)'
• Has a valid SSL certificate

Configure SAP

The following steps cover the configuration process of the SAP Commerce Backoffice tool. For general information about the SAP Commerce Backoffice, refer to the Business User guides in the SAP Help Portal.

After the successful installation, the SAP Backoffice contains a new item type “Worldline Configuration”. Follow these steps to link your Base Store in SAP Commerce to our platform:

• Login to the SAP Commerce Backoffice via the default URL https://<hostname>:9002/backoffice. Default administrator credentials will have been defined during installation or provided to you separately.

Go to Worldline > Worldline Configuration. Click on the “+” – symbol in the taskbar.

• Enter the following from the table in the appearing pop-window:

Click on "DONE" to confirm your configuration

• Click on the configuration profile in the table you have just confirmed. Enter the following from the table overview:

Click on “SAVE” to confirm your configuration.

Configure Base store

Before you start processing (test) transactions, you need to

• Link your Base stores with the plugin configuration.
• Select an integration method.

To do so, follow these steps and confirm by clicking "SAVE" in each tab:

• Go to Base Commerce > Base Store. Select the store from the table with headers "ID" / "Name".

Select "Worldline" from the available tabs and scroll down to "WORLDLINE CONFIGURATION".

• Enter the following from the table overview:

• Select "ADMINISTRATION" from the available tabs and scroll down to "UNBOUND". Enter "worldlineB2CResponsiveCheckoutGroup" in field "Checkout Flow Group"
  
• Select "PROPERTIES" from the available tabs and scroll down to "PAYMENT PROVIDER". Enter "Worldline" in field "Payment Provider"

Test connection

Once you have completed all the steps, verify the configuration by establishing a test connection between the plugin and our platform:

• Go to Worldline > Worldline Configuration. Select the configuration profile from the table with headers "Merchant ID" / "API Key".
• Click on "Test connection" in the configuration profile overview. Check that the appearing pop-up window states "OK (success)". If the pop-up window indicates a failed test, contact your system administrator for troubleshooting.

Configure Payment Modes

To configure the list of payment modes, go to Price settings > Payment Modes. 

This list shows all available payment methods in your system. (De)activate any payment method by setting the "Is Active" flag accordingly. Once a new payment method has been added to your PAYONE account, you may have to add in manually. To do so, click on the "+" button on top of the list. 

Configure Card On File

To configure Card On File, go to Worldline > Worldline Recurring Token. 

This list shows all available tokens for Card On File in your system. Click in the respective line in the table to get a comprehensive overview about the individual token and possible actions: 

We have designed the plugin to follow-up on your orders automatically and autonomously, freeing you from the administration involved. Learn here how to use our plugin effectively which could help your business to thrive!

Perform maintenance operations

Captures, refunds and cancellations of authorisations are standard processes (also known as maintenance operations) in your everyday business logic. Learn here how to perform these operations in the SAP Backoffice.

Perform test transactions

Use our platform's test environment to make sure your plugin works as intended. We offer test data sets on our dedicated Test cases page. Target our test environment as described in the "Configure Plugin" section.