support Contact Support | system status System Status
Page Contents

    Using a Subscription Package

    In this topic, you will learn how to use a video subscription package that was created using the Commerce tab of Brightcove Beacon. The subscription package implements SVOD (subscription video on demand) monetization. For details on creating the subscription see the Creating a Subscription Package document.

    Overview

    A subscription package defines how a particular set of videos can be purchased by your apps' customers. The subscription package must be created in Brightcove Beacon, and is detailed in the Creating a Subscription Package document. Also crucial in the use of the subscription package are the Video Cloud custom fields created for videos in a Video Cloud account, as detailed in the Creating Video Cloud Custom Fields document. Specifically, the Rights Management fields will be used.

    Understanding the rights management custom fields

    The rights management custom fields consist of:

    • beacon.rights.<counter>.type
    • beacon.rights.<counter>.startDate
    • beacon.rights.<counter>.endDate
    • beacon.rights.<counter>.devices
    • beacon.rights.<counter>.locationsPermit
    • beacon.rights.<counter>.locationsDeny
    • beacon.rights.<counter>.packageName
    • beacon.rights.<counter>.adConfiguration

    First consider the <counter> part of each name. This is included as you may wish to create multiple sets of rights management fields, and the <counter> is utilized so you can use array type syntax to group associated fields.

    For instance, say you wanted to create subscription packages around the holidays and have packages for:

    • Earth Day
    • Arbor Day
    • New Years

    You must go into Video Cloud and create three sets of rights management fields, using counter values of 0-2 (or 1-3 if you prefer) that would appear as shown here:

    index of rights fields

    To summarize, for each package you wish to use you will need to create a "counter" set of rights management fields.

    Package and custom field similar rights

    Some custom fields to which you can assign data, and have applied to a video when ingested, can seem the same as form fields when creating your package in Brightcove Beacon. For example, the custom field beacon.rights.<counter>.locationsDeny and the package's Denied locations form field may seem like they could be in conflict. Remember, when considering these "conflicts" there are two different questions being asked, those being:

    • Do the rights on the video allow it to play?
    • Is a user allowed to subscribe to the package?

    Consider these scenarios:

    • An end date in the beacon.rights.<counter>.endDate custom field is later than the end date of the package itself. This means the video's rights would allow it to be viewed until the custom field end date, but the user could not subscribe to the package that may have, for example, lowered the cost of viewing the video.
    • A package is created that has permitted locations of US, Canada and Mexico, and that package is assigned to the video in the custom field beacon.rights.<counter>.packageName. Also in the video's custom fields, UK is placed in the beacon.rights.<counter>.locationsPermit custom field. The package is assigned to the video, but the package cannot be purchased in the UK. The video would be able to play in the UK, but it would could not be part of the package for a UK customer.
    • A package is created that has permitted locations of US, Canada and Mexico. In the custom fields US and Canada are added in the video's beacon.rights.<counter>.locationsDeny custom field. Here the customers in US, Canada and Mexico could subscribe to the package, but the specific video where US and Canada are denied locations means the video could not be viewed by customers in those locations even though the video is in the package.

    Assigning a single video to a package

    To assign a single video to a package you must use Video Cloud Studio. Perform the following steps:

    1. In Studio, navigate to the Media module.
    2. Click on the video's title you are adding to the package to see that video's properties.
    3. Scroll down until you see the Custom Fields section on the right hand side and click the Edit button.
      index of rights fields
    4. Place the name of the subscription package created in Brightcove Beacon in the beacon.rights.<counter>.packageName field.
    5. Since you are using a package, you MUST set the beacon.rights.<counter>.type to SVOD.
      index of rights fields
    6. Scroll to the bottom of the list of custom fields and click the Save button.

    Assigning multiple videos to a package

    To assign multiple videos to a package you must use Video Cloud Studio. The following screenshot is helpful when performing the steps:

    index of rights fields

    1. In Studio, navigate to the Media module and check the checkbox in front of each video you wish to add to the package.
    2. Click the Quick Edit button.
    3. The Quick Edit section appears on the right side of the screen, and there you can place the name of the subscription package created in Brightcove Beacon in the beacon.rights.<counter>.packageName field.
    4. Since you are using a package, you MUST set the beacon.rights.<counter>.type to SVOD.
    5. At the bottom of the Quick Edit section, click the Save button.

    Ingesting the videos into Brightcove Beacon

    You now have associated one or videos with your subscription package. You now have to ingest those associations into Brightcove Beacon. To do this, follow these steps:

    1. Log in to Brightcove Beacon.
    2. Click on the wrench icon (Tools).
    3. From the left side navigation click Ingestion.
    4. Click the Update Brightcove Videos button.
    5. If any errors are reported, check those to be sure none are related to your subscription package.
    6. If you wish to have the new associations immediately active in Brightcove Beacon, you must clear the current cache. To do this, from the left side navigation click Cache, then click Cache Purge.

    For more details on the actions taken in this section, see the Using the Tools document.


    Page last updated on 28 Sep 2020