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"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectb2ccheckoutaddon"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectb2bcheckoutaddon"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectbackoffice"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectocc"/>
<extension dir="${HYBRIS_BIN_DIR}/custom/worldline/worldlinedirectwebhook"/>

• 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

• To run the ant commands below, you will need to run . ./setantenv.sh or its Windows equivalent within the hybris/bin/platform directory.
• You may need to run the following command to ensure the correct addons are available in your storefront:

ant addoninstall
-Daddonnames="adaptivesearchsamplesaddon,assistedservicecustomerinterestsaddon,assist
edservicepromotionaddon,assistedservicestorefront,assistedserviceyprofileaddon,captch
aaddon,configurablebundleaddon,consignmenttrackingaddon,customercouponaddon,customerc
ouponsamplesaddon,customerinterestsaddon,customerticketingaddon,eventtrackingwsaddon,
merchandisingaddon,merchandisingstorefrontsampledataaddon,multicountrysampledataaddon
,notificationaddon,ordermanagementaddon,orderselfserviceaddon,pcmbackofficesamplesadd
on,personalizationaddon,personalizationsampledataaddon,personalizationyprofilesampled
ataaddon,profiletagaddon,selectivecartsplitlistaddon,smarteditaddon,stocknotification
addon,textfieldconfiguratortemplateaddon,timedaccesspromotionengineaddon,timedaccessp
romotionenginesamplesaddon,xyformssamples,xyformsstorefrontcommons,ysapproductconfiga
ddon" -DaddonStorefront.yacceleratorstorefront=""

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>"

• Use the following command to install the B2B addon to your storefront:

ant addoninstall -Daddonnames="worldlinedirectb2bcheckoutaddon" 
-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.

Also, please note that the Worldline API has a 50-character limit for the customer email address field, while the SAP Commerce Cloud platform and the plugin do not. So do not forget to validate this field to conform to this limit.

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.

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 Backoffice

The following steps cover the configuration process of the SAP Commerce Backoffice. 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 "Finish" to confirm your configuration.

Select a config from the list of existing configurations to modify it. Open it, and the editor will appear at the bottom of the screen. Please remember to save the updated configurations.

Test Connection

Once you complete these steps, verify the configuration by establishing a test connection between the plugin and our platform:

Merchants can now share feedback or request additional features via the “Request a new feature” button inside the plugin.

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

Worldline Tab

3D Secure Configuration (3DS tab)

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 the field "Checkout Flow Group"
  
• Select "PROPERTIES" from the available tabs and scroll down to "PAYMENT PROVIDER". Enter "Worldline" in the field "Payment Provider"

Configure Payment Modes

To configure this list of Payment Modes in SAP Commerce, navigate to the following menu in Backoffice:

Once you click on Payment Modes, you will see a list of Payment Modes currently loaded in the system. After selecting a Payment Mode, you can enable or disable it by changing the isActive flag.

If you add a new Payment Mode to your account in the ANZ Worldline Payment Solutions Backoffice, you may need to manually add it to the system by clicking the '+' button at the top of the Payment Modes 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: 

Replenishment Orders

Both B2B and B2C storefronts have access to the replenishment order feature. There are several configurations you need to set to customise it, which we have explained in the previous sections.

Replenishment orders are created using a cronjob. You need the following properties for replenishment order processes:

• Cart – This is the blueprint of the replenishment order.
• Orders – List of orders placed using the Cart data. The first placed order is the one that the customer places manually during the checkout process. All subsequent orders are created from the cronjob.
• CronJobHistoryEntries – Keeps information about cronjob executions.
• Payment Info – The payment info used for server-to-server calls to ANZ Worldline Payment Solutions used to process payments for subsequent orders.
• Submitted – This property is used to indicate there were no issues during cronjob creation. If it is set to false, no future orders will be created.

You can find all detailed configurations and processes in the README guide shipped with the plugin package.

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. You can perform these operations on a transaction using the Customer Support Backoffice.

Once you log in to the Customer Support Backoffice, all orders will be listed in the Orders section. You can select the order you want to perform maintenance operations on.

You can perform actions like capturing or cancelling payments from the options available at the top of the order details section. Cancelling an order will trigger a refund request or authorisation cancellation where applicable.

Managing recurring tokens

Maintenance operations also allow you to manage recurring tokens. You may Block, Unblock, or Revoke them.

Managing mandates

You can manage the status of mandates through the following actions: Block, Unblock or Revoke.

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.