support Contact Support | system status System Status

Creating an Electronic Program Guide (EPG)

In this topic, you will learn how to create an Electronic Program Guide (EPG) for Brightcove Beacon.

Overview

An Electronic Program Guide (EPG) displays scheduling information for past, current and upcoming broadcast programming available on each of your Brightcove Beacon channels.

This document will teach you how to structure your XML file and upload it as an EPG to Brightcove Beacon.

A high-level view of the process is:

  1. Create an XML file with your channel information which meets the EPG schema.
  2. Drop the XML file in the S3 bucket supplied by Brightcove.
  3. After the steps above are completed, the file will automatically be ingested into Brightcove Beacon. The information will be displayed in the Channels section of Brightcove Beacon.

The rest of this document will provide details for each of the steps above.

Required information for EPG

  • An XML file with the channel information: This file can be created manually or automatically.
  • Customer generated RSA public key, then supplied to Brightcove: This will act as the "password" to the S3 bucket in which you will place your EPG file.
  • An S3 account (bucket name and URL path) provided by Brightcove: The actual location for the EPG file.

Generating the RSA public key

The RSA public key is an authentication credential just like a password and is widely used for secure data transmission.

For the EPG to be used, the first step is to generate an RSA public key and send it to your Brightcove representative. Generating an RSA public key can be done in different ways. Please contact your technical staff for more information on the best way to perform this task.

Once you've created and sent the RSA public key to your Brightcove representative, Brightcove will be able to provide you with the S3 bucket name and URL in which to drop your XML files.

XML File Structure

To generate an EPG for Brightcove Beacon, you will need to create and upload an XML file to the S3 bucket with all the metadata information of your channels such as video titles, descriptions, and duration.

Here is an example of the XML Structure:

 
            
            <RiGHTvEPG xmlns="http://www.orca.tv/RiGHTv/7.0/EPG" 
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            version="1.0" language="en" xsi:schemaLocation="http://www.orca.tv/RiGHTv/7.0/EPG 
            RiGHTvEPG.xsd">    
              <ChannelsList>
                <channel id=“your-channel-id”>
                  <program id=“3394 " time=“2020-04-22T01:25:00Z” duration=“PT01H45M”
                  delete=“false” pvrEnabled=“false” stovEnabled=“false” catchUpEnabled=“false”>
                    <title>Video Title</title>
                    <description>
                    <![CDATA[
                    Description of your video asset.
                    ]]>
                    </description>
                  </program>
                </channel>
              </ChannelsList>
        
        

For the head of the XML file you can use the following code:

 
          
            <RiGHTvEPG xmlns="http://www.orca.tv/RiGHTv/7.0/EPG" 
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            version="1.0" language="en" xsi:schemaLocation="http://www.orca.tv/RiGHTv/7.0/EPG 
            RiGHTvEPG.xsd">
            
            

The RiGHTvEPG.xsd file contains an XML Schema that describes the structure of the XML document, and the file is hosted by Brightcove. You can validate your XML using the XSD file schema in an XML validator.

The following are important XML tags and metadata:

Name Description Example
channel id Unique identifier for your channel id=“channel2”
program id Unique identifier for your program video asset id=“3344”
time The scheduled transmission time for your video; the times should be in UTC format, and all will be converted to the local time of each location that displays your content time=“2020-04-22T01:25:00Z”
delete Required for EPG format, please always set to false delete="false"
pvrEnabled Required for EPG format, please always set to false pvrEnabled="false"
stovEnabled Required for EPG format, please always set to false stovEnabled="false"
catchUpEnabled Required for EPG format, please always set to false catchUpEnabled="false"
duration The duration of your video event; the duration format is defined following the ISO 8601 standard duration=“PT01H45M” In this format the (PT) represents the Period Time of 1 hour (H) and 45 minutes (M)
title The title of your video event <title>Your video title</title>
description The description of your video event <description> <![CDATA[ The video description goes here ]]> </description>

Once your XML is ready, you can upload it to the S3 bucket that Brightcove provided you.

Fetching the XML File in Brightcove Beacon

After uploading the XML to the S3 bucket, you will need to fetch the file if you want to immediately get the new schedules reflected into your Brightcove Beacon app. To do this perform the following steps:

  1. Log in to Brightcove Beacon.
  2. Click on the Tools (wrench) button in the upper right of the screen.
  3. Select the Ingestion tab.
  4. Click on the Fetch XML from Folder button.
  5. Select the Cache tab from the left menu.
  6. Click in the Cache Purge button to clear the cache.

Reviewing the Schedule in Brightcove Beacon

In this section, you will be able to review if your EPG was set correctly on the Brightcove Beacon channel’s schedule.

  1. In Brightcove Beacon, click the Channels tab.
  2. In the left menu, click in the EPG section.
  3. In the Schedule section, you will see all your available channels.
  4. Click the blue button with the arrow to display all the schedules that were submitted by the XML file for the selected channel.
  5. Note the Start Time and End Time dates are in UTC time.
  6. To see the channel information in a Brightcove Beacon app, in the menu click in the Program Guide tab.
  7. Here you will be able to review the EPG of your channels.
  8. If there are any empty spaces in your XML programming schedule, the Brightcove Beacon system will fill those empty spaces with a label in the channel schedule.
  9. To choose the EPG schedule for another day, select the day of your preference on the menu.

Page last updated on 11 May 2020