Getting started with the Blue Billywig Drupal module

The Blue Billywig Drupal module allows you to upload videos to your Blue Billywig publication and easily insert them into your Drupal pages. Before you can start using the module, you will need to install the module, prepare your Blue Billywig publication and configure the module.

This article will guide you through these steps to ensure that you can start using your videos within Drupal in a matter of minutes.  

1.0 | Installing the module

You can find the Blue Billywig Drupal module in the Modules section: https://www.drupal.org/project/blue_billywig.

More information about installing Drupal modules can be found here: https://www.drupal.org/docs/extending-drupal/installing-modules. 

2.0 | Configuring the module

After installing the module, there are a few settings that need to be configured in order for it to work properly. For this, you need both access to the Drupal module’s settings and have administrator access to your Blue Billywig publication. For the second, please talk to your Customer Success Manager if you need assistance with that.

2.1 | Preparing your Blue Billywig publication

2.1.1 | Create an API key

You will need to create an API key that will be used to facilitate the communication between the Drupal module and the Blue Billywig in a secure manner. Follow these steps:

1. Log into your Blue Billywig publication
2. Navigate to the Publication Settings 
3. Navigate to the Secrets page
4. Click on the Create new API key button
5. In the screen that opens, add the following information:
   1. A descriptive name for the API key, for example “Drupal module”
   2. A description of the API key (optional)
   3. Select the publisher role
6. Click on the Save & Activate button

After saving, a Secret will be generated, you will need to add this to the Drupal module’s setting, so follow these steps:

1. Click on the Show secret button
2. Click on the Copy button
3. Either directly enter your Secret in the Drupal module’s configuration page, or temporarily paste it somewhere where you can retrieve it at a later time.

2.1.2 | Create a custom field (optional)

If you are planning to upload videos from different clients or websites in a single Blue Billywig publication, you will need to create a custom field, in which you will add the identifier for that specific client or website. 

If this is the case, follow these steps:

1. Navigate to the Publication Settings
2. Navigate to the Custom fields page
3. Click on the Add button
4. Select the Custom field option from the dropdown
5. In the screen that opens, add the following information
   1. Add the value Klantnaam to the Label field
   2. Select the List option in the Type section
6. Navigate to the Configuration tab
   1. Check the Extendable checkbox
7. Click on the Save button

2.2 | Configuring the Drupal module

After preparing your Blue Billywig publication, you can configure the Drupal module and set up the connection between both. 

How this looks depends on the configuration of your Drupal environment, but these steps should apply to most instances. If this is not the case, please talk to your Customer Success Manager.

1. Click on the Configuration option
2. Select the Media section of the dropdown menu and/or page that opens
3. Select the Blue Billywig settings option

You will be redirected to the settings page for the Blue Billywig module, where you will need to enter the following information:

1. In the Publication (sub)domain field, add the domain for your Blue Billywig publication.
   For example, if your Blue Billywig domain is https://customer-x.bbvms.com, enter customer-x as the value here. 
2. In the Client identifier field, you can add the client and/or website identifier as configured in Create a custom field (optional).
   If you enter a value here, it will be added to the Custom field that you have created within your publication. This allows you to filter on videos for a specific client and/or website.
3. In the API Key field, add the ID for the API key as configured in Create an API key.
   You can find the ID of the API key in the details sidebar for your API key.
4. In the API Secret field, add the Secret you copied in Create an API key.

These settings configure the connection between both platforms. Now you can optionally configure the behavior of the module when embedding videos in your Drupal website in the Display options section:

1. Select the Playout to use when embedding your videos within Drupal. If you don’t select anything, we will use the default Playout.
2. Select the desired Embed type. By default, Javascript should be the desired type, but if this is not possible, you can also select the Iframe embed type.

Before closing this page, click on the Save configuration button.