support Contact Support | system status System Status

Brightcove Custom Cartridge for Salesforce Commerce Cloud: Installation

This topic explains the steps for installing the Brightcove Custom Cartridge for Salesforce Commerce Cloud.

Overview

This document provides technical instructions for installing Brightcove custom cartridge, as well as setting up SFCC Business Manager, for integrating Brightcove Cloud video and media files with Salesforce Commerce Cloud (SFCC).

Component Overview

Functional Overview

This custom cartridge enables Salesforce Commerce Cloud business users to upload videos files to the Brightcove Cloud server through SFCC Business Manager and publish these files on the product details page.

Compatibility

The custom cartridge is designed for Salesforce Commerce Cloud API with controllers for extended functionality. Custom cartridges are available for SFRA as well as for the Site Genesis architecture. Clients should install version matching with their Salesforce Commerce Cloud architecture.

Steps for Installation

Overview of the installation

Installation Overview
Installation Overview

Install Custom Cartridge in Business Manager

  1. Open Eclipse Studio
  2. Import Brightcove cartridges as provided
  3. Select on the Import box:
    Import Box
    Import Box

    Note: Browse the Local root Directory to the Specific Folder where cartridge library files are located. Select the Cartridges which you want to upload:

    Import Projects
    Import Projects
  4. Upload cartridge to the sandbox.
  5. Select sandbox connection followed by Properties.
  6. Select Project Reference and check in the Brightcove Cartridges as it is going to be uploaded to the SFCC Instance.

Setups in SFCC Business Manager

  1. To set up business manager go to Business Manager followed by Select site > Manage Sites
  2. Select the Site, then select Settings tab. In the cartridge path add the following line:
    Cartridge Path
    Cartridge Path
  3. Add cartridge to the cartridge path in Administration followed by Sites > Manage Sites > Business Manager Settings:
    Business Manager Settings
    Business Manager Settings
    Business Manager Cartridge Path
    Business Manager Cartridge Path
  4. Once the path is successfully set, select Administration followed by Site Development > Import & Export
    Import & Export
    Import & Export
  5. Upload brightcove-objecttype-extensions.xml from the metadata folder.
  6. Select Import box to follow steps to import brightcove-objecttype-extensions.xml:
    Import Carttridge XML
    Import Carttridge XML
  7. Once the path is imported, select Administration followed by Operations > Import & Export:
    Operations Import and Export
    Operations Import and Export
  8. Upload brightcove-objecttype-extensions.xml from the metadata folder.
  9. Click on Import and follow the steps to import brightcove_services.xml:
    Operations Import XML
    Operations Import XML
  10. To check whether your business manager is all set:
    1. Go to Administration > Organization > Roles & Permissions
    2. Select the specific user role (Administrator) followed by Business Manager Modules > Select Context
    3. Select your site and click Apply
    4. In the list of Business Manager Module > Brightcove and click to update permissions:
      Business Manager Permissions
      Business Manager Permissions

Configure Custom Cartridge via Custom site preferences

  1. To configure custom cartridge via site preferences, select Business Manager followed by Your Site > Site preferences.
  2. Select Custom Site Preferences > Brightcove.
  3. Below is an example of how to complete the fields in the administration area:
    Sample Site Preferences 1
    Sample Site Preferences 1
    Sample Site Preferences 2
    Sample Site Preferences 2

    Field descriptions

    • Brightcove Enable: turns on\off the Brightcove integration
    • Brightcove AccountID: Brightcove Account ID for Configuration
    • Brightcove ClientID:
    • Brightcove Client Secret Key: Brightcove client id for API authentication
    • Content Libraries: Brightcove client secret for API authentication
    • Site Catalogs: enter all Catalogs used by the site

Including Brightcove Video Template in SFCC app

  1. Add following line in app/cartridge/templates/default/product/productDetails.isml:

    <isinclude template="slots/html/htmlBrightcoveVideo" />

    <div class="row">
      <div class="col-lg-6 sol-sm-12">
      <!-- Product Images for Carousel -->
      <isinclude template="product/components/imageCarousel" />
      <isinclude template="slots/html/htmlBrightcoveVideo" />
    

Page last updated on 04 Mar 2020