This sample repository contains the files and folders that are required to set up Data Hub in SAP Commerce Cloud. You can clone this repository and then follow the instructions in the readme to update the example files with your specific Data Hub details.

When your files are ready, push them to your SAP Commerce Cloud repository. Data Hub is automatically deployed when SAP Commerce Cloud is set up.

• You have a public-facing code repository.
• You have an active SAP Commerce Cloud subscription that includes Data Hub version 6.7.0.0 or higher.
• You have a license for SAP Commerce version 1808 or higher.
• You have not set up SAP Commerce Cloud yet. Once Commerce Cloud is installed, you cannot go back and add Data Hub. If you already installed Commerce Cloud, contact the Support team for assistance.

Data Hub is supported with all versions of SAP Commerce that are supported by SAP Commerce Cloud.

You can find the supported SAP Commerce versions listed in the Compatibility help topic at https://help.hybris.com/scc/pcd/31ac209eb08f41bc92e9bbe5772fb949.html.

The version of Data Hub does not have to match the version of SAP Commerce.  Use the most recent version of Data Hub.

Not applicable

These instructions walk you through the process of cloning the repository and then updating the sample files with your specific Data Hub requirements.

The following folders and files are included in the sample repository.

Root level

• manifest.json: The SAP Commerce Cloud manifest.json that includes required Data Hub properties.
• datahub folder: The folder that contains all of the folders and files that support Data Hub.

datahub folder

• manifest.json: The Data Hub manifest.json file that defines the Data Hub application and extensions.
• ccv2 example folder: A generic folder that you can build out for custom extensions.
• config folder: The folder that contains the Data Hub configuration files and folders.

config folder

• lib folder: An optional folder where you can add pre-compiled extensions. The JAR files and Java libraries that support the pre-compiled extensions should reside in this folder. If you have extensions with dependencies, put the source extension in this folder. The dependent extension goes in the corresponding custom extension folder.
• logback.xml: The file that defines logging details.
• datahub-environment.conf: The file that contains the properties shared by all environments in a basic Data Hub configuration.
• datahub-environment-[environment_code].conf: The file that contains unique properties that are assigned to specific environments.

Clone the sample repository (instructions can be found here). The files are copied to your local machine.

1. Update the ccv2 example folder that is used for custom extensions.

• Change the generic folder name to the name of your custom extension. The folder name and extension name must match.
• Add the extension configuration information to the folder.

2. Repeat these steps for each custom extension.
3. If you don’t have custom extensions, you can delete the folder.
4. If you plan to use pre-compiled extensions, such as Marketplace extensions or java source libraries, add them to the repository.

• Open the datahub/config/lib folder.
• Add the JAR files and Java libraries that support the pre-compiled extension.
• Open the pom.xml file of the custom extension and add a line in the dependency section for systemPath with the path to the lib folder.

5. List the extensions in the Data Hub manifest.json file. If you have custom extensions with dependencies, list the source extension first, then the dependent extension. Extensions are built in the order in which they appear in the manifest.

1. Open the manifest.json file inside the datahub folder. This is the Data Hub manifest.json.
2. Update the “datahub_version” with the version of Data Hub that you plan to use. Refer to the Supported Versions section of this readme for more information.
3. Save the changes.

1. Open the config folder.
2. Find the datahub-environment.conf file.
3. Open the configuration file and replace the default user names and passwords with the values that support your environment.
4. Save the changes.

1. Open the config folder.
2. Open the datahub-environment-[environment_code].conf file.
3. Add environment properties for each unique property that you want to apply to the environment.
4. Name the file datahub-environment[environment_code].conf.

• To find the environment code for an environment, see the instructions in the SAP Commerce Cloud help at https://help.hybris.com/scc/pcd/1f6dfab4981347db8ab221acaf37960f.html.

5. Create a separate datahub-environment-[environment_code].conf file for each environment that requires unique properties.
6. If you do not need unique environment variables, delete the datahub-environment[environment_code].conf file.

1. Open the config folder.
2. Verify that the logback.xml file is inside the config folder.
3. DO NOT overwrite the "appender name=STDOUT" section of the logback.xml file. This section is required if you want to access Data Hub logs in Kibana.

Pre-compiled extensions are extensions such as Marketplace extensions. If needed, these extensions are added to the lib folder.

1. Open the config folder.
2. Open the lib folder.
3. Add the JAR files and Java libraries that support the pre-compiled extensions.
4. If you are not using pre-compiled extensions, delete the lib folder.

1. Make sure that you have openSSL installed on your local machine.
2. Open a terminal window and run the following command to generate a 128-bit AES key.

$ openssl enc -aes-128-ecb -k secret -P -md sha1

3. Verify that you see a result that includes values for “salt” and “key”.
4. Copy the string that displays after “key=“. Do not include “key=“.
5. Paste the string into a new text file.
6. Save the file with the name “encryption-key.txt”.
7. Move the file to the config folder.

1. Open the config folder.
2. Create a folder named “trusted-certificates”.
3. Copy your x509 certificate to the trusted-certificates folder.
4. Verify that the file has a .cer extension and is in ASCII pem encoded format.

1. Find the manifest.json file at the root level of the sample repository. This is the Commerce Cloud manifest that includes required Data Hub properties.
2. In the Commerce Cloud repository root directory, replace the existing manifest.json file with this manifest.json.
3. Make sure that the version of Commerce Cloud identified in the first line of the manifest file is the version that you plan to use.

In the sample repository, verify that you have the following files in the datahub folder.

• manifest.json: This is the manifest.json for Data Hub.
• folder (optional)
• config folder
• lib folder (optional)
• logback.xml
• datahub-environment.conf
• datahub-environment-[environment_code].conf (optional)
• encryption-key.txt
• trusted-certificate folder
• .cer file with x509 certificate

Push the data hub folder from your local machine to the root level of your Commerce Cloud repository.

Use the Cloud Portal to create a build and then deploy the build to an environment. The configuration you added to the Commerce Cloud repository is used to create Data Hub.

After the build is deployed, you can find the Data Hub endpoint in the Environments page of the Cloud Portal.

The repository must be a public-facing repository. You cannot use a private repository to host SAP Commerce Cloud and Data Hub configurations.

There are no known issues at this time.

This repository is provided "as-is"; no support is available.

Find more information on SAP Commerce Cloud and Data Hub in the SAP Commerce Cloud from the help at https://help.hybris.com/scc/pcd/ab9cf3c375a8407f8a5f548b8a379311.html.

Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the “SAP Sample Code License” except as noted otherwise in the LICENSE file at https://github.com/SAP/cloud-commerce-datahub-sample-setup/blob/master/LICENSE.md.