SAP COMMERCE CLOUDINARY

EXTENSION SETUP GUIDE

TABLE OF CONTENTS

Introduction 3
Pre-requisites 3
Prerequisites for Spartacus Storefront 3

B2C Accelerator and Spartacus Setup Steps 4

Download and Extract 4
Clone Repository 4
Create Symlink 4
Deploy the JDBC JAR 5
Create database and user 5
Install Recipe 5
Install Required Addon 6
Start SAP Commerce Server 7
Start Spartacus Storefront Application 8

B2B Accelerator Setup Steps 8

Download and Extract 8
Clone Repository 9
Create Symlink 9
Deploy the JDBC JAR 9
Create database and user 9

1
 Install Recipe 10
Install Required Addon 10
Start SAP Commerce Server 11

Uninstall SAP Commerce B2C Cloudinary Extension 13

Uninstall Extension 13
Start SAP Commerce Server 14

Uninstall SAP Commerce B2B Cloudinary Extension 15

Uninstall Extension 15
Start SAP Commerce Server 16

2
Introduction

The Cloudinary SAP Commerce Integration Setup Guide is for technical users who want to
install the integration as part of their SAP Commerce system setup. The supported versions are
from 1811 and later.

Pre-requisites

● JAVA 11
● MySQL 5.7
● SAP Commerce Suite 1811 or later
● MySQL DB driver

Prerequisites for Spartacus Storefront

● Angular CLI:9.1 or later, <10.0.

● Node.js:10.14.1 or later, <13.0. The most recent 12.x version is recommended.
● yarn :1.15 or later

3
B2C Accelerator and Spartacus Setup Steps
Follow the steps below if you are installing the extensions on a new system and don't have any
existing SAP Commerce setup.

Download and Extract

To install the CX suite on your machine, follow these steps.

For CX Commerce 2005 Local Environment Setup, use the latest 2005 CX Commerce. This
suite contains both CX Commerce and CEP extensions.

1. Obtain the hybris Commerce package

2. Extract the tar package in your chosen location (e.g. /home/user/ and rename it as
cloudinary).

Clone Repository
To clone the Cloudinary repository you need to have GitHub repository access.

Clone the repository to the custom ({your sap cx base directory}/bin/custom) folder from this
GitHub link, and switch to the development branch:

https://github.com/cloudinary/cloudinary_sap_commerce.git

Ask your admin for access if required.

git clone https://github.com/cloudinary/cloudinary_sap_commerce.git custom

Create Symlink
Change directory to {your sap cx base directory}/hybris and execute this command:

ln -s {your sap cx base directory}/bin/custom/ext-config config

For windows:

mklink /D [Destination] [Original source]

4
Deploy the JDBC JAR
In order to install the connector:

1. Download mysql-connector-java-5.1.37-bin.jar
2. Open a File Explorer.
3. Copy mysql-connector-java-5.1.37-bin.jar to
/home/user/cloudinary/hybris/bin/platform/lib/dbdriver.

Create database and user

Connect to your local MySQL installation and create a database (it'll be populated during
initialize) and a user:

CREATE DATABASE cloudinary CHARACTER SET=utf8 COLLATE=utf8_bin;

CREATE USER ‘cloudinary’@'localhost' IDENTIFIED BY 'cloudinary'; GRANT ALL

PRIVILEGES ON cloudinary.* TO 'cloudinary'@'localhost' WITH GRANT OPTION; flush
privileges;

Install Recipe
A Cloudinary recipe is required for installing and initializing required Cloudinary extensions and
configuration.

Copy cloudinary_b2c.zip from {your sap cx base directory}/recipes and extract it to your local
CX commerce recipes folder.

Open a command line and go to the “installer” directory of your SAP Commerce instance.

Execute the following commands to install and initialize the recipe:

● On Windows: install.bat -r cloudinary_b2c

● On Linux or Mac: ./install.sh -r cloudinary_b2c

5
Install Required Addon

ant addoninstall -Daddonnames="cmsoccaddon"

-DaddonStorefront.ycommercewebservices="cloudinarymediawebservices"

Initialize SAP Commerce by entering the following command:

● On Windows: install.bat -r cloudinary initialize
● On Linux or Mac: ./install.sh -r cloudinary initialize

Follow the steps below if you are installing the extensions on an existing SAP Commerce
system.

1. Add the following Cloudinary extensions to your localextensions.xml file:

<extension name=cmsoccaddon />

<extension name='mediaconversion' />
<extension name='mediaconversionbackoffice' />
<extension name='cloudinarymediacore' />
<extension name='cloudinarymediabackoffice' />
<extension name='cloudinarymediasmartedit' />
<extension name='cloudinarymediawebservices' />
<extension name='cloudinarymediafacades' />
<extension name='cloudinarymediaaddon' />
<extension name='spartacussampledataaddon' />

2. Install the required addons below in your platform directory:

ant addoninstall -Daddonnames="cmsoccaddon"

-DaddonStorefront.ycommercewebservices="cloudinarymediawebservices"

ant addoninstall -Daddonnames="cloudinarymediaaddon"

-DaddonStorefront.yacceleratorstorefront="<your custom b2c storefront>"

3. In the cloudinarymediaaddon project.properties change the property from

“yacceleratorstorefront.additionalWebSpringConfigs.cloudinarymediaaddon” to

6
 <your custom b2c storefront
extension>.additionalWebSpringConfigs.cloudinarymediaaddon

4. Execute a platform build using “ant clean all”

5. Perform a SAP Commerce system update

Start SAP Commerce Server

To perform this step, we use the Hybris Server, which is a pre-configured application server
based on Apache Tomcat.

The hybris server has two modes of operation:

● Normal: Set by default for the hybris server.

● Debug: Only used with the develop configuration template (the one we chose earlier).
The debug mode is slower in performance but is useful for developing using the external
debugging tools (for example Eclipse IDE with compatible Java debugger).

To start the server, from the same terminal shell:

1. Navigate to the /bin/platform directory and run:

a. $ ./hybrisserver.sh
b. If you need it in debug mode, run $ hybrisserver.sh debug
2. The start-up is complete when the log displays a line such as Server Startup in XXXXms.
3. Open backoffice https://localhost:9002/backoffice/.
4. Navigate to Cloudinary > CloudinaryConfiguration and enable the Cloudinary connection
(for more details refer to the SAP Commerce Cloudinary Extension Integration
document, Cloudinary Configuration in the Backoffice section).
5. From Cronjobs, find and run the “cloudinaryMediaUploadSyncCronjob” cronjob in
backoffice. Set the catalogVersion before running the job.

6. After completion, find and run the “cloudinaryMediaTagUpdateCronjob” cronjob in

backoffice. Set catalogVersion for which you want to run the job.
7. Add 127.0.0.1 apparel-uk.local electronics.local in your host file entry.
8. Access apparel site using https://apparel-uk.local:9002/yacceleratorstorefront/en/.

7
Note - As a quick validation you can inspect a media from the storefront and verify that the
source URL is pointing to Cloudinary.

Start Spartacus Storefront Application

To perform this step, we use the app Server, which is pre-configured and point your browser to
https://loacalhost:4200

To start the server, from the terminal shell:

1. Navigate to the /bin/custom/spartacus/sapcloudinarystore.

2. From the same terminal window, run the command “yarn install” to install the
dependencies.
3. And after successful compilation, run the “yarn start” command.
4. Access apparel spartacus storefront using http://localhost:4200/apparel-uk-spa/en/GBP/

B2B Accelerator Setup Steps

Follow the steps below if you are installing the extensions on a new system and don't have any
existing SAP Commerce setup.

Download and Extract

To install CX suite on your machine, follow these steps:

For CX Commerce 2005 Local Environment Setup, use the latest 2005 CX Commerce.

This suite contains both CX Commerce and CEP extensions.

1. Obtain the hybris Commerce package

2. Extract the tar package in your chosen location (e.g. /home/user/ and rename it
as cloudinary).

8
Clone Repository
To clone the Cloudinary repository you need to have GitHub repository access.

Clone the repository to the custom ({your sap cx base directory}/bin/custom) folder from
https://github.com/cloudinary/cloudinary_sap_commerce.git and switch to the development
branch.

Ask your admin for access if required.

git clone https://github.com/cloudinary/cloudinary_sap_commerce.git custom

Create Symlink
Change directory to {your sap cx base directory}/hybris and execute this command:

ln -s {your sap cx base directory}/bin/custom/ext-config config

For windows:

mklink /D [Destination] [Original source]

Deploy the JDBC JAR

In order to install the connector:

1. Download the mysql-connector-java-5.1.37-bin.jar

2. Open a File Explorer.
3. Copy mysql-connector-java-5.1.37-bin.jar to
/home/user/cloudinary/hybris/bin/platform/lib/dbdriver.

Create database and user

Connect to your local MySQL installation and create a database (it'll be populated during
initialize) and a user:

CREATE DATABASE cloudinary CHARACTER SET=utf8 COLLATE=utf8_bin;

9
CREATE USER ‘cloudinary’@'localhost' IDENTIFIED BY 'cloudinary'; GRANT ALL
PRIVILEGES ON cloudinary.* TO 'cloudinary'@'localhost' WITH GRANT OPTION; flush
privileges;

Install Recipe
A Cloudinary recipe is required for installing and initializing required Cloudinary extensions and
configuration.

Copy cloudinary_b2b.zip from {your sap cx base directory}/recipes and extract it to your local
CX commerce recipes folder

Open a command line and go to the “installer” directory of your SAP Commerce instance.

Execute the following commands to install and initialize the recipe:

● On Windows: install.bat -r cloudinary_b2b

● On Linux or Mac: ./install.sh -r cloudinary_b2b

Install Required Addon

ant addoninstall -Daddonnames="cmsoccaddon"

-DaddonStorefront.ycommercewebservices="cloudinarymediawebservices"

Initialize SAP Commerce by entering the following command:

● On Windows: install.bat -r cloudinary_b2b initialize
● On Linux or Mac: ./install.sh -r cloudinary_b2b initialize

Follow the steps below if you are installing the extensions on an existing SAP Commerce
system.

1. Add the following Cloudinary extensions to your localextensions.xml file:

<extension name=cmsoccaddon />

10
 <extension name='mediaconversion' />
<extension name='mediaconversionbackoffice' />
<extension name='cloudinarymediacore' />
<extension name='cloudinarymediabackoffice' />
<extension name='cloudinarymediasmartedit' />
<extension name='cloudinarymediawebservices' />
<extension name='cloudinarymediafacades' />
<extension name='cloudinarymediab2baddon' />

2. Install the required addons below in your platform directory:

ant addoninstall -Daddonnames="cmsoccaddon"

-DaddonStorefront.ycommercewebservices="cloudinarymediawebservices"

ant addoninstall -Daddonnames="cloudinarymediab2baddon"

-DaddonStorefront.yb2bacceleratorstorefront="<your custom b2b storefront>"

3. In the cloudinarymediaaddon project.properties change the property from

“yb2bacceleratorstorefront.additionalWebSpringConfigs.cloudinarymediaaddon”
to <your custom b2b storefront
extension>.additionalWebSpringConfigs.cloudinarymediaaddon

4. Execute a platform build using “ant clean all”.

5. Perform a SAP Commerce system update.

Start SAP Commerce Server

To perform this step, we use the Hybris Server, which is a pre-configured application server
based on Apache Tomcat.

The hybris server has two modes of operation:

● Normal: Set by default for the hybris server.

● Debug: Only used with the develop configuration template (the one we chose earlier).
The debug mode is slower in performance but is useful for developing using the external
debugging tools (for example Eclipse IDE with compatible Java debugger).

11
To start the server, from the same terminal shell:

1. Navigate to the /bin/platform directory and run:

a. $ ./hybrisserver.sh
b. If you need it in debug mode, run $ hybrisserver.sh debug
2. The start-up is complete when the log displays a line such as Server Startup in XXXXms.
3. Open backoffice https://localhost:9002/backoffice/.
4. Navigate to Cloudinary > CloudinaryConfiguration and enable the Cloudinary connection
(for more details refer to the SAP Commerce Cloudinary Extension Integration
document, Cloudinary Configuration in Backoffice section).
5. Find and run the “cloudinaryMediaUploadSyncCronjob” cronjob in backoffice. Set the
catalogVersion before running job.
6. After completion, find and run the “cloudinaryMediaTagUpdateCronjob” cronjob in
backoffice. Set catalogVersion for which you want to run the job.
7. Add 127.0.0.1 powertools.local in your host file entry.
8. Access apparel site using https://powertools.local:9002/yb2bacceleratorstorefront/en/.

Note - As a quick validation you can inspect a media from the storefront and verify that the
source URL is pointing to Cloudinary.

12
Uninstall SAP Commerce B2C Cloudinary Extension
Uninstall Extension

Follow the steps below if you are uninstalling the Cloudinary extensions from the SAP
Commerce system.

1. Remove the following Cloudinary extensions from your localextensions.xml file:

<extension name=cmsoccaddon />

<extension name='mediaconversion' />
<extension name='mediaconversionbackoffice' />
<extension name='cloudinarymediacore' />
<extension name='cloudinarymediabackoffice' />
<extension name='cloudinarymediasmartedit' />
<extension name='cloudinarymediawebservices' />
<extension name='cloudinarymediafacades' />
<extension name='cloudinarymediaaddon' />
<extension name='spartacussampledataaddon' />

Note - "cmsoccaddon“, “mediaconversion” and “mediaconversionbackoffice” are the

OOB SAP Commerce extensions. We are enabling this extension as it is required to
install Cloudinary extensions. However If it is required for an existing project as well then
we should only remove Cloudinary extensions while uninstalling SAP Commerce B2C
Clouldinary Extensions.

2. Execute a platform build using “ant clean all”.

3. After successful build, execute initialization using “ant initialize” to clean up Cloudinary
data.

Note - As part of the Initialization process, the OOB data will be created in the System, but if
you still want to use Cloudinary media we should download all the originals from Cloudinary and
import them in SAP.

13
Start SAP Commerce Server
To perform this step, we use the Hybris Server, which is a pre-configured application server
based on Apache Tomcat.

The hybris server has two modes of operation:

● Normal: Set by default for the hybris server.

● Debug: Only used with the develop configuration template (the one we chose earlier).
The debug mode is slower in performance but is useful for developing using the external
debugging tools (for example Eclipse IDE with compatible Java debugger).

To start the server, from the same terminal shell:

1. Navigate to the /bin/platform directory and run:

2. The start-up is complete when the log displays a line such as Server Startup in XXXXms.
3. Add 127.0.0.1 apparel-uk.local electronics.local in your host file entry.
4. Access apparel site using https://apparel-uk.local:9002/yacceleratorstorefront/en/.

Note - As a quick validation you can inspect a media from the storefront and verify that the
source URL is pointing to your local system not to Cloudinary .

14
Uninstall SAP Commerce B2B Cloudinary Extension
Uninstall Extension

Follow the steps below if you are uninstalling the Cloudinary extensions from SAP Commerce
system.

1. Remove the following Cloudinary extensions from your localextensions.xml file:

<extension name=cmsoccaddon />

<extension name='mediaconversion' />
<extension name='mediaconversionbackoffice' />
<extension name='cloudinarymediacore' />
<extension name='cloudinarymediabackoffice' />
<extension name='cloudinarymediasmartedit' />
<extension name='cloudinarymediawebservices' />
<extension name='cloudinarymediafacades' />
<extension name='cloudinarymediab2baddon' />

Note - "cmsoccaddon“, “mediaconversion” and “mediaconversionbackoffice” are the

OOB SAP Commerce extensions. We are enabling this extension as it is required to
install Cloudinary extensions. However If it is required for an existing project as well then
we should only remove Cloudinary extensions while uninstalling SAP Commerce B2B
Clouldinary Extensions.

2. Execute a platform build using “ant clean all”.

3. After successful build, execute initialization using “ant initialize” to cleanup Cloudinary
Data.

Note - As part of Initialization process, the OOB data will be created in System, but if you still
want to use the Cloudinary media you should download all the originals from Cloudinary and
import them in SAP.

15
Start SAP Commerce Server
To perform this step, we use the Hybris Server, which is a pre-configured application server
based on Apache Tomcat.

The hybris server has two modes of operation:

● Normal: Set by default for the hybris server.

● Debug: Only used with the develop configuration template (the one we chose earlier).
The debug mode is slower in performance but is useful for developing using the external
debugging tools (for example Eclipse IDE with compatible Java debugger).

To start the server, from the same terminal shell:

1. Navigate to the /bin/platform directory and run:

2. The start-up is complete when the log displays a line such as Server Startup in XXXXms.
3. Add 127.0.0.1 powertools.local in your host file entry.
4. Access apparel site using https://powertools.local:9002/yb2bacceleratorstorefront/en/.

Note - As a quick validation you can inspect a media from the storefront and verify that the
source URL is pointing to your local system not to Cloudinary .

16