Install Bloomreach B2C Commerce Accelerator Using Boot Project

Info: This feature requires a standard or premium Bloomreach Content license. Contact Bloomreach for details.

Introduction

Warning: Starting with version 14.2, use the Bloomreach B2C Commerce Accelerator Maven plugin to install the B2C Commerce Accelerator application. Do not use the Boot project method described here. For current installation instructions, see Install B2C Commerce.

Goal

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

Background

The Bloomreach B2C Commerce Accelerator Boot project provides an out-of-the-box integration between your commerce backend, Bloomreach Content, and Bloomreach Discovery.

You can configure the Boot project to connect to a supported commerce backend platform and Bloomreach Discovery. Select from the available commerce backend configurations.

This guide explains how to set up the Boot project in a local development environment, connect it to your commerce backend, and deploy it to a server environment.

Set Up Local Development Environment

The Boot project is available from the Bloomreach Content Enterprise Maven repository.

Log in to https://maven.bloomreach.com/.
Navigate to https://maven.bloomreach.com/#browse/browse:maven2-enterprise:com%2Fbloomreach%2Fcommercedxp%2Fstarterstore-boot.
Select the required release version (format: X.Y.Z) and open the corresponding folder.
Download the starterstore-boot-X.Y.Z-project.tar.gz, .tar.bz2, or .zip source distribution.
Extract the archive to a directory in your local environment.

Configure the connection properties for your commerce backends in the Bloomreach Accelerator Configuration File. For details, refer to the documentation for each commerce backend configuration. Example configuration:

# 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 with Maven:

mvn clean verify

Start the application:

mvn -P cargo.run

Verify that the CMS is running at http://localhost:8080/cms/. Log in with the credentials admin/admin.

To confirm the commerce backend connection:

Open the Content application.
Navigate to Bloomreach Accelerator: B2C Commerce Boot Project > products.
Open an example product document or create a new one.
Ensure your commerce backend is selected under Commerce Connector.
Click Browse under Related External Product.
You should be able to browse products from your commerce backend.

Warning: Automated migration from an existing project to a Bloomreach B2C Commerce Accelerator project is not supported in the current version. Start your project using the downloaded Boot project source and manually apply any existing features. Future releases may provide migration tools (e.g., Essentials tools).

Deploy in a Server Environment

The deployment process for the Boot application matches standard Bloomreach Content project deployment.

Deploy in Bloomreach Cloud

To deploy in Bloomreach Cloud, follow the instructions in Deploy in Bloomreach Cloud.

The Boot project requires access to the Bloomreach Accelerator Configuration File, named braccelerator.properties by default. Deploy the distribution with this configuration file. Follow the steps in Set Environment Configuration Properties and rename the uploaded configuration file to braccelerator.properties. Both conf/platform.xml and conf/hst.xml reference this file.

Deploy a Project Distribution in Other Environments

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

Ensure the deployment includes the braccelerator.properties configuration file, which is referenced by both conf/platform.xml and conf/hst.xml.