support Contact Support | system status System Status
Page Contents

    Salesforce Commerce Cloud Installation Guide

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

    Upload Cartridges

    1. Extract the zipfile.
    2. Upload cartridges (bm_brightcove, int_brightcoveandapp_brightcove) to the Salesforce Commerce Cloud instance.
    3. Activate the code version with the uploaded cartridges.

    Configure Business Manager

    1. Login to Business Manager.
    2. Navigate to Administration -> Manage Sites
    3. Select the site from the list.
    4. Select Settings tab.
    5. Add app_brightcove in the cartridge path for the SFRA site as shown below:
      Add app_brightcove in Path
      Add app_brightcove in Path
    6. Apply the changes.
    7. Add int_brightcove in the cartridge path for the SiteGenesis architecture site as shown below:
      Add int_brightcove in Path
      Add int_brightcove in Path
    8. Apply the changes.
    9. Navigate to Administration -> Manage Sites
    10. Select Business Manager:
      Select Business Manager
      Select Business Manager
    11. Add bm_brightcove in the cartridge path for the Business Manager:
      Add bm_brightcove in Path
      Add bm_brightcove in Path
    12. Apply the changes.

    Import System Object Extensions Files

    1. Navigate to Administration -> Site Development -> Import & Export.
    2. Select Upload under Import & Export Files:
      Select Upload
      Select Upload
    3. Upload brightcove-objecttype-extensions.xml from the meta directory of the zip file.
    4. Navigate to Administration -> Site Development -> Import & Export.
    5. Select the Import option under Meta Data:
      Select Import
      Select Import
    6. Import the brightcove-objecttype-extensions.xml file.

    Import Service Files

    1. Navigate to Administration -> Operations -> Import & Export
    2. Select Upload under Import & Export Files:
      Select Upload
      Select Upload
    3. Upload brightcove-services.xml from the meta directory of the zip file.
    4. Navigate to Administration -> Operations -> Import & Export.
    5. Select the Import option under Services:
      Select Import
      Select Import
    6. Import the brightcove-services.xml file.

    Import Job Files

    1. Navigate to Administration -> Operations -> Import & Export
    2. Select Upload under Import & Export Files:
      Select Upload
      Select Upload
    3. Upload brightcove-jobs.xml from the meta directory of the zip file.
    4. Navigate to Administration -> Operations -> Import & Export.
    5. Select the Import option under Jobs:
      Select Import
      Select Import
    6. Import the brightcove-jobs.xml file.
    7. Select site context for the jobs listed below:
      • Brightcove-BulkAssign
      • Brightcove-BulkUpload
    8. Create three jobs manually:
      • Bulk Assign
      • Bulk Upload
      • Clean Brightcove Folder

      Information you will need to create the jobs is in the table below. Here are the steps for creating each job:

      1. Navigate to Administration -> Jobs.
      2. Create a New Job.
      3. End the Step ID.
      4. Select the scope.
    Jobs Details
    Job Name Step ID Scope
    Bulk Assign custom.bulkAssign Specific-site
    Bulk Upload custom.bulkUpload Specific-site
    Clean Brightcove Folder custom.CleanFolderBrightcove Organization

    Add Brightcove Features Under Roles & Permissions

    1. Navigate to Administration -> Organization -> Roles & Permissions.
    2. Select role from the list to grant access to Brightcove features.
    3. Select Business Manager Module.
    4. Select Site Context:
      Select Site Context
      Select Site Context
    5. Apply context.
    6. Scroll down to the Brightcove section.
    7. Select all the features and click Update:
      Update Roles and Permissions
      Update Roles and Permissions

    Configure Custom Site Preferences

    1. Select a Site from the dropdown menu:
      Site Menu
      Site Menu
    2. Navigate to Merchant Tools -> Site Preferences -> Custom Preferences.
    3. Select Brightcove.
    4. Add the following values:
      • Brightcove Account ID
      • Brightcove Client ID
      • Brightcove Client Secret
      • Site Catalog
      Custom Preference Values - 1
      Custom Preference Values - 1
      Custom Preference Values - 2
      Custom Preference Values - 2
    5. Add the Brightcove Slot Limit (1 - 11). The default is 11.
      • Slots for Master Products (master and m1-m10)
      • Slots for Variant Products (v1 - v11)
      • Slots for Categories (c1 - c11)

      A Slot limit of 5 will provide these slots for configuration:

      • Master Products (master and m1-m4)
      • Variant Products (v1 - v5)
      • Categories (c1 - c5)

    Include Brightcove Video Rendering in ISML Files

    SFRA Cartridge – app_brightcove

    1. Video rendering is supported for the below ISML files:
      • productDetails.isml
      • catLanding.isml
      • searchResultsNoDecorator.isml
    2. Include modules.isml:
      <isinclude template="modules">
    3. Include the tags from modules.isml to render video:
      • Master Product Video <isM1> - this will render the video assigned to the m1 slot
      • Variant Product Video <isV1> - this will render the video assigned to the v1 slot
      • Category Video <isC1> - this will render the video assigned to the C1 slot

    SiteGenesis Cartridge – int_brightcove

    1. Video rendering is supported for the below ISML files:
      • productcontents.isml
      • producttopcontent.isml
      • categoryproducthits.isml
      • catlanding.isml
    2. Include modules.isml:
      <isinclude template="modules">
    3. Include the tags from modules.isml to render video:
      • Master Product Video <isM1> - this will render the video assigned to the m1 slot
      • Variant Product Video <isV1> - this will render the video assigned to the v1 slot
      • Category Video <isC1> - this will render the video assigned to the C1 slot

    Page last updated on 28 Sep 2020