Installing Required Extensions and Add-Ons

Objectives

After completing this lesson, you will be able to:
  • Add required extensions and add-ons
  • Configure required extensions and Add-Ons

Add Required Extensions and Add-ons

To set up SAP S/4HANA Cloud and SAP Commerce Cloud integration through Cloud Integration for the B2B order fulfillment integration scenario, you need the following extension sets, which include both extensions and add-ons.

Required Extensions and Add-Ons

Extension SetsExtensions and Add-OnsNotes and References
SCI Extensions
  • ysapcpiomsfulfillment
  • sapcpiadapter
  • sapcpicustomerexchange
  • sapcpicustomerexchangeb2b
  • sapcpiorderexchangeb2b
  • sapcpiorderexchangeoms
  • sapcpiorderexchangeomsb2b
  • saporderexchangebackoffice
  • sapcpiproductexchange

These extensions allow customer, order, and product information to pass between SAP Commerce Cloud and S/4HANA Cloud.

SAP Cloud Integration Architecture
SAP Core
  • sapcore
  • sapcoreconfiguration
  • sapcoreconfigurationbackoffice
  • sapcoreaddon
SAP Framework Core Architecture
Master Data
  • sapcustomerb2b
  • sapcustomerb2bbackoffice
  • sapmodel
  • sapmodelbackoffice

Do not include any extensions containing crm, for example, sapcrmmodel.

Asynchronous Order Management
  • ysapomsfulfillment
  • saporderexchangeoms
  • saporderexchangeomsb2b
  • saporderexchangebackoffice

The Asynchronous OMS extensions are required when using Order Management Services with Asynchronous OM.

Extensions for Asynchronous Order Management System

Note

  • As some of the extensions or add-ons are dependent on other extensions or add-ons, you don’t have to add all these extensions or add-ons, as some of them will be added automatically. For example, adding sapmodelbackoffice automatically adds sapmodel.
  • During implementation, you need to verify that the required extensions and add-ons are activated in either the manifest.json file or the localextensions.xml file.

Please only include ysapcpiomsfulfillment and NOT ysapomsfulfillment or ysaporderfulfillment. These extensions are mutually exclusive.

To check that all the required extensions and add-ons are successfully built in the SAP Commerce Cloud automation engine, you can access the Cloud Portal at https://portal.commerce.ondemand.com/, navigate to the Builds screen, find your specific build, and download the build log file.

In the cloud build log file, you’ll see the list of extensions/add-ons enabled or built in the SAP Commerce Cloud automation engine.

To check if the required extensions and add-ons are deployed and loaded in your SAP Commerce Cloud application, log on as an administrator to the SAP Commerce Cloud Administration Console (HAC) at https://backoffice.XXXXXXXXXX-XXXXXXXXX-XX-public.model-t.cc.commerce.ondemand.com/hac, then navigate to path: PlatformExtensions.

You can page through at the bottom right to see all the loaded extensions/add-ons, or you can type keywords like sap in the search box on the top right to quickly find the target extensions/add-ons.

Configure Required Extensions and Add-Ons

In SAP Commerce Cloud, the required extensions and add-ons can be configured in the manifest.json file or in the localexteions.xml file.

The manifest.json file is the only mandatory file in your SAP Commerce Cloud project code repository. It’s the SAP Commerce Cloud build instructions file on the cloud, which specifies the SAP Commerce Cloud version, extension packs, extensions, add-ons, aspects, properties and tests, and so on.

If you have a local SAP Commerce Cloud development, or test environment, your extensions and add-ons are configured in the localexteions.xml file. In this case, SAP Commerce Cloud allows you to reuse the local environment configurations file like the Solr, Tomcat configuration files, the local properties files, and the localextensions.xml file. In this way, you don’t have to start from scratch and can align your local environments with the cloud environments to streamline your development process.

You can configure everything in the manifest.json file for the sake of simplicity and consistency.

In your SAP Commerce Cloud project code repository, go to the core-customize folder, and open the manifest.json file. The extensions component is where you can add the required extensions and add-ons. Some of these extensions are bundled and distributed as part of a module. An extension can contain business logic, type definitions, a web application, or a Backoffice Administration Cockpit configuration.

The manifest contains a list of required extensions. The final list of enabled extensions can differ from the set defined in the manifest. To view all enabled extensions, refer either to the SAP Commerce Cloud Administration Console (HAC), or to the SAP Commerce Cloud logs at start up.

Add-ons are a type of extension that allow you to add front-end files, such as JSP, HTML, CSS, JavaScript files, or images, from within your own add-on. When you use add-ons, you do not need to modify the storefront front-end file directly.

Each add-on in a manifest has three attributes:

  • Add-on: The name of the add-on
  • storefront: The name of the storefront you're installing the add-on for
  • template: The name of the template that generates the storefront extension

The extensionPacks component allows you to identify more versioned software artifacts to combine with SAP Commerce Cloud during installation. During the build process, extension packs download extra software artifacts. For our purposes, we'll need the 2211.0 version of the hybris-commerce-integrations extension pack.

The following screenshot shows the extensionPacks component in the manifest.

Log in to track your progress & complete quizzes