sap-samples / cloud-commerce-sample-setup

Find the sample manifest.json and configuration files that you can use to build out your commerce repository in SAP Commerce Cloud.

SAP Commerce Cloud Sample Repository

This sample repository contains the files and folders that are required to set up SAP Commerce Cloud.

This branch covers a Commerce Cloud 2211 sample scenario that is based on the CX recipe with Spartacus 6.x.

Note

There are different branches covering the various versions and configurations of an SAP Commerce Cloud solution, so make sure to choose the right one. You can clone/download this repository, checkout the branch of interest and then follow the instructions in the README to update the example files with your specific details.

Caution

Do not use the deprecated yacceleratorstorefront template extension and the related addons for any new development. The deprecated yacceleratorstorefront and a few addons are included in this repo purely for showcase purposes.

Details: Deprecation of Accelerator UIs and Older OCC template Extensions

Requirements

• You have a public-facing code repository.
• You have an active SAP Commerce Cloud subscription.
• You have a license for a supported SAP Commerce release
• You have not set up SAP Commerce Cloud yet.

Supported Versions

You can find the supported SAP Commerce versions listed in the Compatibility help topic.

Download and Installation

Not applicable.

Configuration

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

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

Root level

• core-customize folder: The folder that contains all of the folders and files that support Commerce Cloud.
• js-storefront folder: A project Spartacus JS Storefront configured with Server Side Rendering (SSR). For more on project Spartacus see project Spartacus documentation

core-customize folder

• manifest.json: The Commerce Cloud manifest.json file, which defines how your code will be built and deployed in the Public Cloud environments. The manifest is set up to leverage configuration reuse to better allow for consistency between local and cloud builds.
• hybris folder: contains a sample custom folder for storing any custom extensions as well as the config folder for storing local and cloud properties, localextensions.xml and any local solr/tomcat configurations
• other sample manifests: A collection of tested and verified manifest files that you can use as starting points for your Commerce Cloud environments.

Clone Repository

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

Update the Custom Extensions

1. If you don’t have custom extensions, you can delete the kiwi & tiger sample folders. If you wish to use these extensions you'll have to uncomment them in your core-customize/hybris/config/localextensions.xml folder
2. List any extensions you're using (custom and any from Commerce runtime) in the core-customize/hybris/config/localextensions.xml file
3. If you have custom extensions with dependencies, configure the dependencies in extesioninfo.xml accordingly. Extensions are built in the order in which they appear in your localextension.xml and manifest.json files

Update the Commerce Cloud manifest.json

1. Open the manifest.json file inside the core-customize folder.
2. Update the version with the version of SAP Commerce that you plan to use. Refer to the Supported Versions section of this readme for more information.
3. Save the changes.

Prepare to Push the Sample Repository

In the sample repository, verify that you have the following files in the core-customize folder.

• manifest.json: This is the manifest.json for Commerce Cloud.

In the sample repository, verify that you have the following files in the js-storefront folder.

• manifest.json: This is the file that tells Cloud Automation the name and path of the JavaScript storefronts you want to build and deploy

Push the Commerce Cloud Configuration to Code Repository

Push all the contents from your local machine to the root level of your Commerce Cloud repository.

Access the Cloud Portal

Log in to the Cloud Portal and verify that your code repository is connected.

1. From a supported browser, log in to https://portal.commerce.ondemand.com. For more information, see Accessing the Cloud Portal.
2. Select Repository and verify that you are connected to the correct code repository.
3. Find the environments that were provisioned for your subscription.
4. Create a new build.
5. Deploy the build to the environment using the Initialze Database option.

You may also wish to see this video which provides a walkthrough of how to connect your repository, as well as this video which outlines how to build and deploy.

Final Steps - Validating an example Spartacus Electronics Storefront

Use the Cloud Portal to create a build and then deploy the build to an environment.

See Build and Deploy your First SAP Commerce Cloud Project for all the steps to build and deploy.

After the build is deployed, you can find the 'JS Storefront' endpoint in the Environments page of the Cloud Portal listed under Public Endpoints.

1. Click on the JS Storefront hyperlink to access the details page for endpoint.
2. Either add an IP Filter Set for your IP address OR change the Base Rule from 'Deny All' to 'Allow All' in order to receive traffic to this example storefront.
3. Save the changes.
4. Click on the URL listed next to the JS Storefront public endpoint.
5. Verify that you see a basic electronics storefront.

Limitations

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

Known Issues

There are no known issues at this time.

How to Obtain Support

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

Find more information about SAP Commerce Cloud Setup on our help site.

License

Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.