Dolby Voice Hub Service Provider Provisioning Guide

Table of Contents

  1. Introduction
  2. Provisioning flow
    2.1. Discovery
           2.1.1. Scenario 1 - Dolby Voice Hub serial number pre-entered into Dolby Voice Console
           2.1.2. Scenario 2 - Dolby Voice Hub serial number not pre-entered into Dolby Voice Console
    2.2. Manual provisioning
    2.3. Provisioning sequence
  3. Master configuration file structure
    3.1. Mixed device type configuration
    3.2. Dedicated device type configuration
  4. Essential configurations
  5. Security
  6. File Uploads

1. Introduction

This document is intended for service providers who wish to provision the Dolby Voice Room using plain configuration files. Like the Dolby Conference Phone, the Dolby Voice Room supports HTTP/HTTPS-based provisioning protocols. It can download a set of configuration files in JSON format, parse through them to receive configuration, as well as software update instructions. For enterprise customers who wish to manage the Dolby Voice Room, the Dolby Conferencing Console (DCC) can be deployed on-premises and provide an easy-to-use device management solution for both the Dolby Conference Phone and Dolby Voice Room.

2. Provisioning flow

2.1. Discovery

Like the Dolby Conference Phone, Dolby Voice Hub, the main processing unit in the Dolby Voice Room solution, discovers its provisioning service by connecting to a Dolby Voice Console (DVCon). The Dolby Voice Console is a Dolby-managed service that can, based on the Dolby Voice Hub's serial number, provide a provisioning URL for the Dolby Voice Hub to connect to. There are two scenarios:

  • If the Dolby Voice Hub serial number is pre-entered into the DVCon by a channel partner, the Dolby Voice Hub can directly access the designated provisioning service and load the intended Out-of-Box setup experience that is defined by the conferencing service provider.
  • If the Dolby Voice Hub serial number is not pre-entered into the DVCon, then the Dolby Voice Hub will load a default Out-of-Box setup experience defined by Dolby. In this case, the user can select the service provider, which then directs the Dolby Voice Hub to the intended provisioning server.

The following diagram illustrates the discovery process.

image

In addition to Dolby Voice Console based discovery, the Dolby Voice Hub also supports local DNS SRV record discovery for on-premises provisioning with a DCC. The details for DNS SRV discovery will be provided at a later time in this document.

2.1.1. Scenario 1 - Dolby Voice Hub serial number pre-entered into Dolby Voice Console

Index Description
1 In factory default state, the Dolby Voice Hub boots up and contacts the Dolby Voice Console to discover its intended provisioning service. The Dolby Voice Hub uses HTTPS to contact the Dolby Voice Console.
2 If the Dolby Voice Hub serial number is pre-entered into the Dolby Voice Console, the Dolby Voice Console can direct the Dolby Voice Hub to the intended provisioning service.
3 The intended provisioning service supplies configuration files to the Dolby Voice Hub. The sample configuration information includes, but is not limited to: Dolby Voice Hub app URL, Dolby Conference Phone URL, etc.
4 The Dolby Conference Phone, when plugged into the Dolby Voice Hub directly, receives configuration information from the Dolby Voice Hub. In this configuration, the Dolby Conference Phone does not directly contact the provisioning service. The Dolby Voice Hub contains matching Dolby Conference Phone software , so the service provider does not need to manage compatibility between the Dolby Voice Hub and Dolby Conference Phone.

2.1.2. Scenario 2 - Dolby Voice Hub serial number not pre-entered into Dolby Voice Console

Index Description
1 In factory default state, the Dolby Voice Hub boots up and contacts Dolby Voice Console to discover its intended provisioning service. The Dolby Voice Hub uses HTTPS to contact the Dolby Voice Console
2 Because the Dolby Voice Hub serial number is not pre-entered into the Dolby Voice Console, the Dolby Voice Console directs the Dolby Voice Hub to the default provisioning service.
3 The default provisioning service supplies configuration files to the Dolby Voice Hub. Sample configuration information includes, but is not limited to: Dolby Voice Hub app URL, Dolby Conference Phone URL, etc. Dolby hosts the default out-of-box setup app which prompts the user to choose a service provider.
4 The Dolby Conference Phone, when plugged directly into the Dolby Voice Hub, receives configuration information from the Dolby Voice Hub. In this configuration, the Dolby Conference Phone does not directly contact the provisioning service. The Dolby Voice Hub contains matching Dolby Conference Phone software, so the service provider does not need to manage compatibility between the Dolby Voice Hub and Dolby Conference Phone. The Dolby Conference Phone loads a CSAF (Conferencing Service App Framework) app based on the instructions from the default provisioning service, which then collects user input for the preferred service provider. After the user selects the service provider, the Dolby Voice Hub then contacts the intended provisioning service to update its configuration.
5 Based on the user's selection, the Dolby Voice Hub connects to the service provider's provisioning service. The app on Dolby Voice Hub and Dolby Conference Phone will be updated based on the service provider's configuration.

2.2. Manual provisioning

If the Dolby Voice Console based provisioning discovery fails, and the user has not implemented DNS SRV for DCC discovery, then the Dolby Conference Phone's out-of-box setup will guide the user through a set-up wizard. At the end of the set-up workflow, the user can manually specify the provisioning server address.

A typical scenario for provisioning discovery failure involves network policies. Some customer networks may enforce strict security policy rules that prevent the Dolby Voice Hub or Dolby Conference Phone from contacting the Dolby Voice Console.

2.3. Provisioning sequence

The Dolby Voice Hub provisioning workflow is similar to the one used by the Dolby Conference Phone when the phone is not paired with a Dolby Voice Hub. It consists of the following steps:

  1. Download of the default master configuration file. (It tries to download dvcp-MAC.cfg first; if not found, then dvcp-default.cfg).
  2. Parse the default master configuration file to obtain the individual configuration files, software image URL, and CA certificates.
  3. Import the downloaded individual configuration files into the Dolby Voice Hub's configuration database.
  4. Download the .meta file from the software image URL, and check against the current software version on the Dolby Voice Hub to determine whether a software update is needed.
  5. If the software update is needed, then the Dolby Voice Hub will download the .tar.gz file and store it on the Dolby Voice Hub's internal storage device.
  6. If the Dolby Voice Hub software contains a different Dolby Conference Phone software version, then after the Dolby Voice Hub is updated, the connected Dolby Conference Phone will be automatically updated.

3. Master configuration file structure

The master configuration file is the first file that the Dolby Voice Hub downloads from the provisioning server.

The service provider may choose to have separate master configuration files for the Dolby Voice Hub and Dolby Conference Phone, or use a mixed device type configuration. This section illustrates the master configuration file structure in both scenarios. For ease-of-management purposes, Dolby recommends the mixed device type configuration approach.

As aforementioned, the master configuration file is either dvcp-MAC.cfg, or dvcp-default.cfg. The Dolby Voice Hub will always attempt to download a device-specific master configuration file first. If it is not found, then it will download the default master configuration file dvcp-default.cfg.

3.1. Mixed device type configuration

DOLBY RECOMMENDED

In this scenario, the master configuration file contains instructions for both the Dolby Conference Phone and Dolby Voice Hub. An example of the file format:

{
    "directory_file": "directory.json",
    "certificates": [
        "certs.pem"
    ],
    "img_file": "dvcp-1.0.0.3682.tar.gz",
    "cfg_files": [
        "dcp-config.json"
    ],
    "vpu9000": {
        "img_file": "dvhh-1.0.0.700.tar.gz",
        "cfg_files": [
            "voicehub-config.json"
        ]

    }
}

This master configuration example defines the following configuration:

  • Both the Dolby Conference Phone and Dolby Voice Hub will get the same certs.pem (CA certificate bundle) and directory.json files.
  • A standalone Dolby Conference Phone will get dvcp-1.0.0.3682.tar.gz for software, and dcp-config.json for its configuration files.
  • The Dolby Voice Hub (model number VPU9000) will get dvhh-1.0.0.700.tar.gz for software, and voicehub-config.json for its configuration files. Note that the dvhh-1.0.0.700.tar.gz file also contains the matching Dolby Conference Phone software package. The Dolby Conference Phone that is plugged into the Dolby Voice Hub will receive that software version and will not contact the service provider's provisioning service.

3.2. Dedicated device type configuration

In this scenario, the master configuration file format is identical to the one used by a standalone Dolby Conference Phone. The service provider has the responsibility to ensure that the Dolby Voice Hub connects to a different provisioning endpoint (URL) so that it does not accidentally download a Dolby Conference Phone configuration file. Because this approach can be error prone, Dolby does not recommend this approach.

{
    "directory_file": "directory.json",
    "certificates": [
        "certs.pem"
    ],
    "img_file": "dvhh-1.0.0.700.tar.gz",
    "cfg_files": [
        "voicehub-config.json"
    ]
}

4. Essential configurations

A configuration file such as voicehub-config.json contains a list of key-value pairs in JSON format. The file name can be anything that makes sense to the service provider.

Following sample content shows some key configurations:

{    
"Features.OperationMode": "DUALMODE",
"Dvms.HubApp.Url": "https://meet.test.com",
"Dvms.HubApp.OobUrl": "https://meet.test.com",
"Phone.App.Url": "http://poc.test.trydcc.com/main/",
"Phone.App.OobUrl" : "http://poc.test.trydcc.com/main/",
"Dvms.Audio.DVCodecType": "96;dvc-2;8000"
}
  • Features.OperationMode defines the operational mode of the Dolby Voice Hub system. DUALMODE means the system will be able to connect to the service provider's experience, as well as initiate SIP audio calls using the customer's SIP infrastructure.
  • Dvms.HubApp.Url defines where the Dolby Voice Hub will download the TVUI Web App from.
  • Dvms.HubApp.OobUrl defines where the Dolby Voice Hub will download the TVUI Web App from when it is in the factory default state.
  • Phone.App.Url defines where the phone will download its main CSAF app from.
  • Phone.App.OobUrl defines where the Dolby Conference Phone will download the CSAF app from when it is in the factory default state.
  • *Dvms.Audio.DVCodecType defines the Dolby Voice codec type used in the service provider's environment. If this is not provisioned, then the default value will be used. The default value is 60;DVC;8000.