Install Bloomreach B2C Commerce Accelerator - Bloomreach Experience - Open Source CMS

Install Bloomreach B2C Commerce Accelerator

This Bloomreach Experience Manager feature requires a standard or premium license. Please contact Bloomreach for more information.

Introduction

Goal

Install the Bloomreach B2C Commerce Accelerator application using the Bloomreach B2C Commerce Accelerator Boot project and connect it to your commerce backend platform.

Background

The Bloomreach B2C Commerce Accelerator Boot project is designed as an out-of-the-box accelerator to integrate your commerce backend with Bloomreach Experience Manager and Bloomreach Search & Merchandising.

The Boot project can be configured with a commerce backend platform and Bloomreach Search & Merchandising. You can use any of the available commerce backend configurations.

This page explains how to set up the Bloomreach B2C Commerce Accelerator Boot project in your local development environment, connect your commerce backend platform, and deploy onto a server environment.

Set Up Local Development Environment

The Bloomreach B2C Commerce Accelerator Boot project is available in the Bloomreach Experience Manager Enterprise Maven repository.

Log in at https://maven.onehippo.com/.

Point your browser to https://maven.onehippo.com/maven2-enterprise/com/bloomreach/commercedxp/starterstore-boot/.

Pick the appropriate release (version number of the format X.Y.Z) and open the corresponding folder.

Download the starterstore-boot-X.Y.Z-project.tar.gz (or .tar.bz2 or .zip) source distribution and extract it to a folder in your local environment.

Set the connection properties for your commerce backends in the Bloomreach Accelerator Configuration File. Refer to the documentation of each commerce backend configuration for details. Example:

# Bloomreach B2C Commerce Accelerator parameters for bloomreach backend service.
bloomreach.cache.enabled = false
bloomreach.account.id = 0000
bloomreach.api.base.url = http://brm-core-0.brsrvr.com/api/v1/core/
bloomreach.domain.key = domain_key_here

# Commerce Connector Parameters for ElasticPath Commerce Connector Module.
elasticpath.cache.enabled = true
elasticpath.baseUrl = http://instance_name.epdemos.com/cortex
elasticpath.accessTokenUri = http://instance_name.epdemos.com/cortex/oauth2/tokens
elasticpath.username =
elasticpath.password = 
elasticpath.scope = ep_scope
elasticpath.role = PUBLIC

Build the application using Maven:

mvn clean verify

Run the application:

mvn -P cargo.run

Verify that the Bloomreach Experience Manager CMS application is accessible at http://localhost:8080/cms/ (login with credentials admin/admin).

To verify that your commerce backend connection is working properly, navigate to the Content application and browse to Bloomreach Accelerator: B2C Commerce Boot Project > products. Open one of the example product documents or create a new one, make sure your commerce backend is selected under Commerce Connector, then click Browse under Related External Product. You should be able to browse through the products in your commerce backend.

In the current version, it is not supported to migrate any existing project to a Bloomreach B2C Commerce Accelerator project in an automated or easy way. Therefore, it is a lot easier to start your project with the downloaded source and apply existing features to the new boot project instead.
In future versions, we will support an easier way (e.g, Essentials tools) to migrate existing projects.

Deploy in a Server Environment

The deployment process for the Bloomreach B2C Commerce Accelerator boot application is the same as for any Bloomreach Experience Manager implementation project.

Deploy in Bloomreach Cloud

If you are deploying in Bloomreach Cloud, follow the instructions in Deploy in Bloomreach Cloud.

As explained in Configure Bloomreach B2C Commerce Accelerator page, Bloomreach B2C Commerce Accelerator Boot project needs to read the Bloomreach Accelerator Configuration File, braccelerator.properties by default. Therefore, make sure to deploy the distribution with the configuration file, following the Set Environment Configuration Properties page, renaming the uploaded configuration file to braccelerator.properties, which is referred by both conf/platform.xml and conf/hst.xml.

Deploy a Project Distribution in Other Environment

In enviroments other than Bloomreach Cloud, follow the instructions in Create a Project Distribution and Deploy a Project Distribution.

Also, as Bloomreach B2C Commerce Accelerator Boot project needs to read the Bloomreach Accelerator Configuration File, braccelerator.properties by default. Therefore, make sure to deploy the distribution with the configuration file which is referred by both conf/platform.xml and conf/hst.xml.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?