Brightcove Video Cloud Connect 6.x Cookbook - SDN · Brightcove Video Cloud Connect 6.x Cookbook Sitecore® is a registered trademark. All other brand and product names are the property

Brightcove Video Cloud Connect 6.x Cookbook Rev: 2013-05-21

Sitecore® is a registered trademark. All other brand and product names are the property of their respective holders. The contents of this document are the property of Sitecore. Copyright © 2001-2013 Sitecore. All rights reserved.

Brightcove Video Cloud Connect 6.x

Cookbook A Practical Guide for Sitecore CMS 6.x

Brightcove Video Cloud Connect 6.x Cookbook


Page 2 of 30

Table of Contents

Chapter 1 Introduction ................................................................................................................................ 3 Chapter 2 Brightcove Media Management ................................................................................................ 4

2.1 Brightcove Accounts ..................................................................................................................... 5 2.1.1 Create Account Folders ............................................................................................................ 5 2.1.2 Import Brightcove Video Cloud Media....................................................................................... 6 2.1.3 Media Search ............................................................................................................................ 7

2.2 Videos ........................................................................................................................................... 8 2.2.1 Video Library Updates ............................................................................................................... 8 2.2.2 Video Metadata ......................................................................................................................... 9

2.3 Playlists ....................................................................................................................................... 12 2.3.1 Playlist Library Updates .......................................................................................................... 12 2.3.2 Playlist Metadata ..................................................................................................................... 12

2.4 Brightcove Players ...................................................................................................................... 14 2.4.1 Brightcove Player Creation ..................................................................................................... 14 2.4.2 Brightcove Player Metadata .................................................................................................... 15 2.4.3 Default Players for Preview ..................................................................................................... 15

Chapter 3 Brightcove Content Integration ................................................................................................ 17 3.1 Rich Text Editor ........................................................................................................................... 18

3.1.1 Insert a Brightcove Media Link ................................................................................................ 18 3.1.2 Insert an Embedded Brightcove Player................................................................................... 20

3.2 Migrating Content from Version 1.x............................................................................................. 22 3.2.1 Enable Migration Interface ...................................................................................................... 22 3.2.2 Migrate Tree ............................................................................................................................ 22 3.2.3 Migrate Item ............................................................................................................................ 22

3.3 Sublayout .................................................................................................................................... 23 3.3.1 Brightcove Video Player Sublayout ......................................................................................... 23 3.3.2 Brightcove Player Data Source ............................................................................................... 25

Chapter 4 Sitecore Analytics Configuration ............................................................................................. 28 4.1 Sitecore Analytics Events ............................................................................................................ 29 4.2 Sitecore Analytics Reporting ....................................................................................................... 30



Page 3 of 30

Chapter 1

Introduction

The Brightcove Video Cloud Connect Cookbook contains instructions for marketers and content editors managing Brightcove Video Cloud services inside Sitecore with the Brightcove Video Cloud Connect module. This guide contains step-by-step instructions for managing Brightcove media in Sitecore, inserting Brightcove media into a website and tracking Brightcove media events with Sitecore Analytics.

All examples in this cookbook utilize the Brightcove Video Cloud Connect module for Sitecore. The module is compatible with Brightcove Video Cloud Pro and Brightcove Video Cloud Enterprise. Sitecore customers using Brightcove Video Cloud Express can also use the module, but may need to contact Brightcove in order to have API-access enabled.

This cookbook contains the following chapters:

Chapter 2 — Brightcove Media Management This section contains step-by-step instructions for linking a Brightcove Video Cloud account, creating video player items and importing videos and playlist items to the Sitecore Media Library.

Chapter 3 — Brightcove Content Integration This section contains step-by-step instructions for embedding video players in website content.

Chapter 4 — Sitecore Analytics Configuration This section contains step-by-step instructions for reporting on Brightcove Video Cloud media events in Sitecore Analytics.

NOTE: This document applies to the Brightcove Video Cloud Connect 6.x.



Page 4 of 30

Chapter 2

Brightcove Media Management

This section contains step-by-step instructions for linking a Brightcove Video Cloud account, creating video player items and importing videos and playlist items to the Sitecore Media Library.



Page 5 of 30

2.1 Brightcove Accounts

All media from the Brightcove Video Cloud Connect is populated to Sitecore through connected Brightcove Video Cloud Pro and Enterprise accounts. For ultimate flexibility, the Brightcove Video Cloud Connect supports integration for multiple Brightcove Video Cloud accounts within a single instance of Sitecore. Media from individual Brightcove Video Cloud accounts is stored inside Account Folders in the Sitecore Media Library.

Note: It is not possible to manage Brightcove media with the Brightcove Video Cloud Connect without a Brightcove Video Cloud Pro or Enterprise account.

2.1.1 Create Account Folders

To create a new account folder:

1. In the Content Editor, expand the content tree and navigate to the Media Library.

2. Expand Modules and then click Brightcove Media.

3. Right-click Brightcove Media > Insert > Account Folder.

Figure 1: Adding an Account Folder

4. Enter a name for the new Account Folder. In the screenshot above, the Publisher ID is used as the account name for clarity. The Publisher ID can be found inside Brightcove Video Cloud Studio.

5. Repeat as necessary for each connected Brightcove Video Cloud account.



Page 6 of 30

2.1.2 Import Brightcove Video Cloud Media

To connect and populate a new Account Folder with Brightcove Video Cloud media, use the following instructions:

1. Click a newly created Account Folder and navigate to the Publisher ID field in the Content editor tab.

2. Enter the Publisher ID of the connected Brightcove Video Cloud account.

Figure 2: Setting the Publisher ID

3. Navigate to the Brightcove Account editor tab.

4. Click the Download from Brightcove button and then click the Process Queue button. This will force an import of all Brightcove media from the selected account into Sitecore.

Figure 3: Download and Process Queue buttons

Note: A background process is scheduled to update the Account Folders automatically, but clicking both buttons sequentially forces an update of all connected media.



Page 7 of 30

2.1.3 Media Search

There are number of media types stored within an Account Folder for each Brightcove Video Cloud account. Utilize search to find a particular asset stored for an account:

1. Click an Account Folder and navigate to the Brightcove Account tab.

2. Use the Search dropdown selector to choose a media type.

3. Enter a query into the Search field and click (the Search button).

Figure 4: Brightcove media search results

Note: Standard Boolean search operators are supported for media search.



Page 8 of 30

2.2 Videos

Sitecore videos are ‘container’ items that represent videos stored in the Brightcove Video Cloud Studio. The content items managed in Sitecore allow for a managed video publishing workflow with roles, permissions and access restrictions enforced by Sitecore, while the Brightcove Video Cloud serves the actual videos to the end-user.

2.2.1 Video Library Updates

Videos are automatically synced to the Media Library in Sitecore through an Account Folder connected with a valid Brightcove Video Cloud Publisher ID. On initial configuration with a valid Brightcove account, the folder structure for existing videos is created at Account Folder > Brightcove Library Management > Video Library. During future updates, new video items are created and deprecated items are deleted automatically from this folder structure.

Manual upload of a single video to Brightcove Video Cloud from Sitecore is also possible as described:

1. Navigate to Account Folder > Brightcove Library Management > Video Library.

2. In the Video Library editor tab, scroll down to Add Video.

3. Fill in the mandatory fields for the new video.

4. Click the Choose File button to select a video from the local file system.

Figure 5: Add Video form

5. Click the Add Video button to upload the video to the Brightcove Video Cloud.



Page 9 of 30

6. A message will appear under the form to indicate that the video was added.

Figure 6: New video confirmation message

2.2.2 Video Metadata

Video metadata is stored in the Brightcove Video Cloud. Most video metadata is synced with Sitecore in a non-editable state and is marked as Brightcove Video – Non Editable Fields on the video item. Some fields, however, are editable directly on a video item in Sitecore.

Follow the process below to edit metadata for a video in Sitecore:

1. Click an Account Folder and navigate to the Brightcove Account editor tab.

2. Use the dropdown to select Video as the media type to filter and then search for any video.



Page 10 of 30

3. Click the video name, which is a link. This will open the video item from the Video Library folder.

Figure 7: Video search results

4. Click the Content editor tab.

5. All fields listed under the Brightcove Video – Editable Fields section are editable in Sitecore.

Figure 8: Brightcove video editable fields

6. Multiple video fields are available for editing:

Field Value

Name An appropriate name for the video item. For example: Sample Video.

Short Description

Brief summary of the content displayed in the video item.

Long Description

Full description of the content displayed in the video item.



Page 11 of 30

Field Value

Reference ID Matches the video item referenced from Brightcove Video Cloud.

Economics Assigned advertising designation for the video item.

Tags Assigned tags for the video item.

7. Update any necessary field data and save changes.



Page 12 of 30

2.3 Playlists

Sitecore playlists are ‘container’ items that represent playlists stored in the Brightcove Video Cloud Studio. The content items managed in Sitecore allow for a managed playlist publishing workflow with roles, permissions and access restrictions enforced by Sitecore, while the Brightcove Video Cloud serves the actual playlist of videos to the end-user.

2.3.1 Playlist Library Updates

Playlists are automatically synced to the Media Library in Sitecore through an Account Folder connected with a valid Brightcove Video Cloud Publisher ID. On initial configuration with a valid Brightcove account, the folder structure for existing playlists is created at Account Folder > Brightcove Library Management > Playlist Library. During future updates, new playlist items are created and deprecated items are deleted automatically from this folder structure.

2.3.2 Playlist Metadata

Playlist metadata is stored in the Brightcove Video Cloud. Most playlist metadata is synced with Sitecore in a non-editable state and is marked as Brightcove Playlist – Non Editable Fields on the playlist item. Some fields, however, are editable directly on a playlist item in Sitecore.

Follow the process below to edit metadata for a playlist in Sitecore:

1. Click an Account Folder and navigate to the Brightcove Account editor tab.

2. Use the dropdown to select Playlists as the media type to filter and then search for any playlist.

Figure 9: Playlist search results

3. Click the link that appears for a single playlist. This will open the playlist item from the Playlist Library folder.

4. The selected playlist will open to the Playlist editor tab. The information displayed on this tab is a truncated listing of the metadata available for the item.

5. Click the Content editor tab.



Page 13 of 30

6. All fields listed under the Brightcove Playlist – Editable Fields section are editable in Sitecore.

Figure 10: Brightcove playlist editable fields

7. Multiple playlist fields are available for editing:

Field Value

Name An appropriate name for the playlist item. For example: Sample Playlist.

Reference ID Matches the playlist item referenced from Brightcove Video Cloud.

Filter Tags Assigned tags for the playlist item.

Short Description

Brief summary of the content displayed in the playlist item.

Playlist Type Assigned playlist designation for the playlist item.

Thumbnail Override

Image designated to override the default playlist thumbnail.




Page 14 of 30

2.4 Brightcove Players

Brightcove players are ‘container’ items that represent player types defined in the Brightcove Video Cloud Studio. The content items managed in Sitecore allow for player template management workflow with roles, permissions and access restrictions enforced by Sitecore, while the Brightcove Video Cloud serves the actual player media to the end-user.

2.4.1 Brightcove Player Creation

Unlike videos and playlists, Brightcove Players are not automatically synced to Sitecore. For each Brightcove player type created for a Brightcove Video Cloud account within the Brightcove Video Cloud Studio, a new Brightcove player item is manually created in Sitecore at Account Folder > Sitecore Video Management.

New Brightcove players are created by following the steps listed below:

1. Navigate to Account Folder > Video Player Library.

2. Add a new Brightcove Player item.

Figure 11: Video Player Library item

3. Click the new Brightcove player and enter a valid Player ID that matches a video player stored in Brightcove Video Cloud Studio. You must also specify the Playlist Type value that matches the player.



Page 15 of 30

2.4.2 Brightcove Player Metadata

Brightcove player metadata is editable directly on a Brightcove player item in Sitecore. While Brightcove player metadata is not automatically synced to a Brightcove player in Sitecore, metadata changes on the item in Sitecore are automatically synced back to Brightcove Video Cloud Studio.

Follow the process below to edit metadata for a video player in Sitecore:

1. Navigate to an Account Folder > Video Player Library and click a video player to edit.

2. Multiple video player fields are available for editing:

Field Value

Player ID Matches the video player item referenced from Brightcove Video Cloud.

Playlist Type Required field that matches the playlist type assigned to the connected video player item in Brightcove Video Cloud Studio. This is only required for Playlist Players.

Auto Start Is checked for the video player to play videos on page load and is unchecked for player to start videos with manual interaction.

Background Color

Default background color, in hex value, of the video player.

WMode Designated window display type for the video player.

Width Default width, in pixels, of the video player. Must be a number that does not include the px unit.

Height Default height, in pixels, of the video player. Must be a number that does not include the px unit.


2.4.3 Default Players for Preview

Videos and playlists can only be previewed through a player.

Follow the process below to specify the default players:

1. Navigate to an Account Folder > Video Player Library. 2. Click the Content tab. 3. Select a Brightcove Player item for the field Default Video Player for Preview. 4. Select a Brightcove Player item for the field Default Playlist Player for Preview.



Page 16 of 30

Figure 12: Video preview without a default player specified

Figure 13: Video preview with a default player specified



Page 17 of 30

Chapter 3

Brightcove Content Integration

This section contains step-by-step instructions for embedding video players in website content.



Page 18 of 30

3.1 Rich Text Editor

The simplest way to embed videos or playlists in website content is through a Rich Text Editor. Within the rich text editor are two buttons that enable insertion of Brightcove media stored in the Sitecore Media Library:

3.1.1 Insert a Brightcove Media Link

The silver button inserts a link to Brightcove media stored in the Sitecore Media Library, which opens in a modal window.

Follow the instructions below to insert a Brightcove media link:

1. Navigate to a Sitecore content item that contains a rich text field. Open the rich text editor for that field and click the silver Brightcove link button.



Page 19 of 30

2. A variety of options are available to insert a Brightcove media link:

Option Definition


Background Color



Player Selected player determines if videos or playlists are shown in the Brightcove media modal.

Video Designated video for the Brightcove media modal. Assign a single video if supported by the selected Player type.

Playlists Designated playlist(s) for the Brightcove media modal. Assign playlists if supported by the selected Player type.

3. Once an appropriate Player type and the corresponding video or playlists are assigned, click the Link button. A new link will appear in the rich text editor.



Page 20 of 30

4. Right-click and select Properties of the link to change the Link Text.

5. When all changes are complete, click Accept to save all changes in the rich text field.

3.1.2 Insert an Embedded Brightcove Player

The red button inserts an embedded Brightcove player that displays Brightcove media stored in the Sitecore Media Library.

Follow the instructions below to embed Brightcove media:



Page 21 of 30

1. Navigate to a Sitecore content item that contains a rich text field. Open the rich text editor for that field and click the silver Brightcove link button.

2. A variety of options are available to embed Brightcove media:

Option Definition


Background Color



Player Selected player determines if videos or playlists are shown in the embedded Brightcove player.

Video Designated video for the embedded Brightcove player. Assign a single video if supported by the selected Player type.

Playlists Designated playlist(s) for the embedded Brightcove player. Assign playlists if supported by the selected Player type.

3. Once an appropriate Player type and the corresponding video or playlists are assigned, click the Link button. An embedded player will appear in the rich text editor.

4. When all changes are complete, click Accept to save all changes in the rich text field.



Page 22 of 30

3.2 Migrating Content from Version 1.x

Brightcove Video Cloud Connector version 6.x introduced a new format for storing embedded video in rich text fields. The old format must be changed to the new format. This can be for an entire tree segment or for an individual item.

3.2.1 Enable Migration Interface

In Sitecore.Video.Brightcove.config, change the setting Brightcove.Migration to "true".

When you are finished migrating content, change the setting to "false".

3.2.2 Migrate Tree

This is the most efficient way to migrate content.

1. In Content Editor, select the root of your site. 2. Right-click the ribbon and select the Brightcove strip so it is displayed. 3. Click the Brightcove strip. 4. Click Migrate Item > Migrate Tree. 5. Republish the site.

3.2.3 Migrate Item

1. In Content Editor, select the root of your site. 2. Right-click the ribbon and select the Brightcove strip so it is displayed. 3. Click the Brightcove strip. 4. Click Migrate Item > Migrate Tree. 5. Republish the site.



Page 23 of 30

3.3 Sublayout

In addition to the Rich Text Editor capabilities, it is possible to insert a sublayout that accepts Brightcove Video Cloud media as a data source.

3.3.1 Brightcove Video Player Sublayout

1. Navigate to an item in Sitecore. Click Presentation > Details in the Ribbon.

2. Choose the Device to edit. Click Edit for that Device.

3. Click Controls. Click Add in the right-hand column.

4. Navigate to Sublayouts > Modules > Brightcove Video Player in the treelist.

5. Enter the placeholder name in the field Add to Placeholder and click Select.



Page 24 of 30

6. Select the new sublayout. Click Edit.

7. Navigate to the Data Source field.

8. Click Insert Link and select an applicable Brightcove Player Data Source from the treelist.

9. Click Open.



Page 25 of 30

10. Click OK for all open windows.

3.3.2 Brightcove Player Data Source

Brightcove players act as a template for Brightcove Video Players items that are assigned video and playlists items for playback.

To set Brightcove Video Players and video data sources to a specific Brightcove player type, follow the instructions below:

1. Navigate to Account Folder > Sitecore Video Management and select a Brightcove player type that supports single videos.

2. Right-click the selected video player and Insert > Brightcove Video Player. Provide the name of the new Brightcove Video Player.

3. Click the new Brightcove Video Player. In the Video field, search for and click a video in the left column, and click the ‘right’ arrow to send the video to the right column. Only one video can be added to this type of data source.



Page 26 of 30

Note: A video can be displayed by more than one Brightcove player type on the website by repeating steps 1-4 for another Brightcove player type that supports single videos. Please also note that multiple video data sources can be inserted under the same Brightcove type.

To assign Brightcove Playlist Players and playlist data sources to a specific Brightcove player type, follow the instructions below:

1. Navigate to Account Folder > Video Player Library and select a Brightcove player type that supports playlists.

2. Right-click the selected video player and Insert > Brightcove Playlist Player. Provide the name of the new Brightcove Playlist Player.

3. Click the new Brightcove Playlist Player. In the Playlist field, search for and click a playlist in the left column, and click the ‘right’ arrow to send the playlist to the right column. Multiple playlists can be added to this type of data source.



Page 27 of 30

. Note: A playlist or set of playlists can be displayed by more than one Brightcove player type on the website by repeating steps 1-4 for another Brightcove player type that supports playlists. Please also note that multiple playlist data sources can be inserted under the same Brightcove player type.



Page 28 of 30

Chapter 4

Sitecore Analytics Configuration

This chapter contains step-by-step instructions for reporting on Brightcove Video Cloud media events in Sitecore Analytics.



Page 29 of 30

4.1 Sitecore Analytics Events

When Brightcove Video Cloud media is accessed by a website user, three separate event types are tracked in Sitecore Analytics:

Event Definition

Video Started User initiated video playback.

Video Paused User paused video playback.

Video Finished User allowed video playback to reach completion.

Each event type is registered for all videos implemented from the Brightcove Video Cloud Connect.

Note: Videos previewed inside the Sitecore Content Editor are explicitly excluded from registering Sitecore Analytics events as to avoid invalidating reporting efforts.



Page 30 of 30

4.2 Sitecore Analytics Reporting

Reports aggregating all Brightcove Video Cloud media events are accessed through the Sitecore Analytics module, as described below:

1. From the Sitecore Desktop user-interface, navigate to the Sitecore Menu > Sitecore Analytics.

2. Navigate to Reports > Marketing > Brightcove. Expand this node.

3. A report for each Brightcove event registered on the website is available for export. The following export options are available:

Option Definition

Print Print the report in the layout specified.

Video Paused Save the report to a format specified.

Mail Report Email the report to a specified email address.

Note: Analytics will only be reported in Sitecore if the Brightcove player being used supports the ActionScript/JavaScript APIs. To enable these APIs, open the settings for a player in the Brightcove Video Cloud and click the Enable ActionScript/JavaScript APIs checkbox:

Documents

Brightcove Video Cloud Connect 6.x Cookbook - SDN · Brightcove Video Cloud Connect 6.x Cookbook Sitecore® is a registered trademark. All other brand and product names are the property