Out-of-Box App Development

The Dolby Conference Phone version 3.2 release introduced a new feature that allows service providers to create a downloadable application that customizes the phone's Out-of-Box experience.

This article discusses how to develop and deploy a Dolby Conference Phone Out-of-Box (OOB) app.

Refer to the Getting started guide for information on setting up the SDK IDE.

What is an OOB App?

An Out-of-Box (OOB) App allows the service provider to optimize the Dolby Conference Phone setup experience. Using the Dolby Voice Console, the service provider can work with their channel partners to preconfigure the Dolby Conference Phone and guide the user through their Out-of-Box workflow.

Deploying the OOB app

The OOB app is deployed by a process that uses the Dolby Voice Console and the Device.OOBApp.Address configuration parameter. The following diagram illustrates how this feature works.

"OOB Architecture"

  1. The first time the Dolby Conference Phone boots up, it connects to the Dolby Voice Console. Based on the Dolby Conference Phone's serial number, the service returns a provisioning URL to the Dolby Conference Phone that references the service provider's provisioning service.
  2. The Dolby Conference Phone contacts the service provider's provisioning service and downloads the configuration profile which contains the OOB app deployment location that is stored in the Device.OOBApp.Address configuration parameter.
  3. The Dolby Conference Phone downloads the OOB app and presents the workflow on the phone's LCD touch screen.
  4. The user goes through the OOB set-up workflow. At the end of this workflow, the app marks the OOB as completed. The Dolby Conference Phone reboots to complete the Out-of-Box setup.

What does the service provider need to do?

In order to implement a customized OOB workflow, the service provider needs to do the following:

  • Design the OOB workflow and create the app.
  • Deploy the OOB App.
  • Update the Dolby Conference Phone provisioning profiles in the provisioning service to include the Device.OOBApp.Address.
  • Register with Dolby and have its provisioning service added to the Dolby Voice Console.
  • Establish a distribution process: direct the channel partner to enter the Dolby Conference Phone serial numbers into the Dolby Voice Console. The Dolby Voice Console provides a method to link the S/Ns with the service provider.

App life cycle and APIs

The following diagram shows the OOB app life cycle during the OOB process. When the Dolby Conference Phone successfully discovered provisioning service and is configured with OOB app, it will load the app.

In some customer networks, access to the Internet may be restricted. In this case, the Dolby Conference Phone will not be able to discover the provisioning service and download the OOB app. In this case, a built-in OOB setup wizard will allow the user to change the network configuration or manually connect to an on-premises provisioning server.

"OOB App life cycle"

When the OOB app finishes running, it needs to hand over the control to the Dolby Conference Phone by calling the exitOobApp method. The app signals to the Dolby Conference Phone whether the setup was successful. If successful, the phone will complete setup and reboot itself to reload the configuration.

If the service provider develops one conferencing app that incorporates both the OOB code and the main conferencing code, the app can detect whether the Dolby Conference Phone is in OOB mode or not by examining the Device.SetupCompleted configuration parameter. When false, it indicates the Dolby Conference Phone is in OOB mode.

See also Configuration::getParameter.