Page Contents

    Integrating Campaign with Single Sign-On

    This topic explains how to configure the Campaign module for use with single sign-on.

    The Campaign module provides the ability to track viewing activity when the viewer has logged into a system using single sign-on (SSO) such as a Gallery experience that has been set up for SSO and Access Control Profiles. In this scenario, viewing data is not sent to a marketing automation platform. With a Campaign SSO configuration, SAML attribute(s) are passed to Campaign to identify the viewer. One common use case for this would be internal training videos. Employees might be required to login to watch videos and then their viewing activity can be tracked and then viewed inside the Campaign module. The Campaign Module will store up to 500K event views per connection. Once the limit has been reached, it will start purging old events.

    To enable Campaign for use with SSO, the following steps are required:

    1. Configure single sign-on software
    2. Configure your application to access SSO attributes
    3. Setup the Campaign SSO connection
    4. Configure the integration
    5. Create a Campaign-enabled player
    6. View video data

    Configuring SSO software

    The steps to install and configure SSO software is outside the scope of this topic. The SSO software should be configured so users have to authenticate themselves before they can view Video Cloud videos. The SSO software should be configured to expose some user attributes so they can be accessed from an external application. For example, this Okta SSO configuration exposes three attributes, FirstName, LastName and Email.

    okta setup

    In this topic, the Email attribute will be used to identify viewers to the Campaign module.

    Configuring an application to access SSO attributes

    The application or website that will be used to view Video Cloud videos should be configured so that the SSO attributes are made available to Campaign using JavaScript. This configuration will vary based upon the application or website being used. In the following example, an SSO access control profile was created in Gallery. As part of the configuration, the Email SSO attribute is being exposed and will be available inside the Gallery site. This is the value that will be used to identify viewers to the Campaign module.

    okta setup

    Setting up the connection

    Follow these steps to setup the connection between Video Cloud and your SSO provider.

    Establishing the connection between Video Cloud and SSO

    1. Open the Campaign module.
    2. In the left navigation, click Data Connections.
    3. Click Add New Connection.
    4. Select SSO as the integration.
    5. (Optional) Enter a Connection Name.
      Campaign setup
    6. Click Connect.

    The SSO connection is now set up and ready to use.

    Configuring the integration

    Once the SSO connection has been made, you can configure the integration.

    connected options
    1. Click the empty link in the SSO Property section. Enter the name of the JavaScript value to look for in the page. In this example, Gallery was configured to expose the Email SSO attribute so that is what is being used here.
      email attribute

      In this topic, the Campaign SSO integration will be used to track viewing activity. Click Save.

    2. By default, the Connection Status will be Enabled. The Connection Status determines if Video Cloud video engagement data is saved.
      • Enabled - Data is collected
      • Disabled - No data is collected (integration is disabled)
    3. Select a data retention policy. The data retention policy determines how long the viewing data will be retained in your Video Cloud account. You should adjust the retention settings according to your privacy policy.
      data retention options

    To remove the integration, click Disconnect. The bottom of the page will list all Campaign-enabled players, the connections they are associated with and the associated lead forms.

    The Campaign module supports multiple connections to marketing platforms. Click Add New Connection to configure additional integrations.

    Additional options for identifying viewers

    If you don't specify a value for the SSO Property when the integration is configured, you are responsible for identifying viewers. The Campaign module needs the following information:

    Description URL Parameter Embed Parameter Value
    What’s the GUID (needed for view event tracking) bcssoguid data-bc-sso-guid string

    This parameter can be passed in via a URL parameter or through the player embed code. For viewer tracking to occur, this parameter should be passed as a URL parameter on the page that is displaying the video.

    It’s also possible to pass the GUID to the Campaign player using a JavaScript value that’s available in the page. Using the player config, it’s possible to tell Campaign what the name of the JavaScript variable is and Campaign will then attempt to read that variable using it as the custom GUID. To do this, edit the Campaign player and configure the plugin options for the Campaign plugin.

    plugin params

    In the above example, the player config is telling Campaign that there’s a JavaScript object in the page called samlAttributes and it has a property called nameID. Campaign will attempt to read that and use its value for the custom GUID.

    Creating a Campaign-enabled player

    Video engagement data will only be tracked when you are using a Campaign-enabled video player. For information on creating a Campaign-enabled Brightcove Player, see Creating a Campaign-enabled Player.

    Viewing video data

    There are several options available for viewing video data when using an SSO integration:

    • Viewer Activities (Events) - Provided as part of the Campaign module, this option can be used to view video data inside the Campaign module. For information, see Viewing Player Events in the Campaign Module.
    • Viewer Profiles - Provided as part of the Campaign module, this option can be used to view video data based upon a user profile value inside the Campaign module. For information, see Viewing Viewer Profile Information.
    • Export Data - Provided as part of the Campaign module, this option can be used to export video view and lead data. For information, see Exporting Campaign Data from the Campaign Module.
    • Audience API - The Audience API can be used to programmatically retrieve video view and lead data. For information, see Overview: Audience API.

    Frequently asked questions

    How do I set up my Data Connection in Campaign?
    Publishers need to configure their Campaign SSO Data Connection’s SSO property field to look for a SAML attribute that gets exposed by their SSO provider upon user sign-in.
    How do I know if an SSO Data Connection is right for my Gallery experience?
    If you are using an SSO Setup with Access Control Profiles (users have to signin to access the experience) then an SSO Data Connection would be a good fit for tracking leads on your Gallery experience.
    How do I know what to populate this field with when using Gallery?
    When a Gallery template is enabled for SSO, it uses an Access Control Profile. When setting up this profile, you have an option to Expose SAML Attributes for use in external JavaScript.

    SAML attributes can either be listed one at a time or a checkbox can be selected to expose all SAML Attributes.

    Checking the Expose SAML Attributes checkbox will expose any tags from the SAML that your SSO provider sends upon user signin. You can verify these attributes by taking the following steps:

    1. Open your Gallery experience.
    2. Signin via SSO.
    3. Open a browser console via its developer tools.
    4. Use the browser console to log out window.samlAttributes.
    Can I use an SSO connection with a Gallery experience that does not use SSO?
    No. In that case, you should use a Campaign player with Campaign Tracking or 3rd party MAP tracking.

    Page last updated on 07 Jun 2022