Adding Players to your Korbyt Tenant - Provisioning
Provisioning Players one at a time, in bulk, and removing them from your tenant
Written By Ed Kinne
Last updated 4 months ago
Provisioning players is a simple process to attach your player to your Korbyt environment. Claiming them as your device.
Once the device has power and is connected to a stable internet connection, it will try to establish a connection with the Korbyt Provisioning Server. The media player also has to be allowed to reach Korbyt.com Port 443 so that it can freely communicate with the Korbyt.com Cloud. This may be different for fully on-premises installations.
In the CMS, you provide information about your player(s) so that your Tenant knows which players to connect to from the provisioning server. This can be done one at a time with a provisioning token or in bulk using a spreadsheet.
Provisioning a Single Player
After the player is turned on for the first time, a provisioning screen will be shown that displays your player’s provisioning token. similar to this example.
In your Korbyt CMS
Open the Mega Menu, then in the Device Management column, click Players.
Click the Provision Player button in the upper right
In the Provision Player dialog, enter the provisioning token and click Provision.
A confirmation message appears; click OK.
The new player will appear on the Players screen.
The player will have a “Pending” status until the player is done provisioning and has their first successful connection to Korbyt
Once provisioning is completed and the player is able to reach Korbyt, the status will change to “Active” and the player will begin playing Default Content Setting Default Content Playlist
If a player remains in Pending status for more than 5 minutes (time might take longer if a slow network connection), or the player does not begin showing default content and remains on the Provisioning Token Screen, you will want to
Check the Korbyt Player Network Connections as well as the player’s physical connection as well
Does the player reach your network, and does the network allow the player to reach Korbyt
Check for any typos when entering the player provisioning token
If an incorrect token was entered, you can use the trashcan to remove the incorrect entry and start again.
Provisioning Players in Bulk
Bulk Provision allows you to upload a CSV file that contains information for multiple players and provision them simultaneously.
To Bulk Provision Players
Open the Mega Menu, then in the Device Management column, click Players.
Click the Bulk Provision button in the upper right
If you already have players and need to update their information as well you may want to click Provision Export instead to get a file with your existing player information instead of the blank template
This will open the bulk player interface
Click Download the Sample CSV file
Open the file on your computer and fill in your player information for the devices you are adding
While it is recommended to fill in all fields, only the MAC Address, Number of Outputs, and Name are required.
If you are using BrightSign devices, you must use the BrightSign Serial Number instead of the MAC Address
You enter “sn:” and then the device’s serial number
example - sn:1234567899
If you are using PWA for the player, you will use the Provisioning Token instead of a MAC address
You enter “pt:” and then the provisioning token
example - pt:CDR7-N12345-00
If you are using Zoom Rooms as Players, you will need to retrieve the Zoom Room ID and use that instead of the Mac address
More details can be found in the Configuring Zoom Rooms article
You enter”zid:” and then the Zoom room ID
example - zid:qULKNcsdnvw0938
Currently, the “Country” column will accept specific values
Accepted County Values for Bulk Provision
Custom Code Column for BrightSign, Samsung, and LG
Some player brands (BrightSign, Samsung, LG) can use a Custom Column at the far right to set values unique to those devices, if needed
Save the CSV file on your computer
In the Bulk Player Provision Window in Korbyt, click Choose CSV File in the Player Provision Pop-up to upload your updated CSV File
Click Validate and Preview to display a preview and alert you of each player’s information.
After verifying that the information is correct, click Import.
If all players are accepted, then you will see a “Player has been successfully provisioned” notification. If any are filled out improperly, you will see a failed notification and the reason why the players failed to provision. If any of the players fail to provision, then you must make the necessary corrections in the CSV file, save the file, and re-upload it.
The new players will appear on the Players screen.
The player will have a “Pending” status until the player is done provisioning and has its first successful connection to Korbyt
If you have bulk provisioned players to Korbyt before deploying them on your network, the player will remain listed as Pending in the CMS until it has its first connection
Once provisioning is completed and the player is able to reach Korbyt, the status will change to “Active” and the player will begin playing Default Content Setting Default Content Playlist
If a player remains in Pending status for more than 5 minutes after it is powered on and connected to your network(time might take longer if a slow network connection), or the player does not begin showing default content and remains on the Provisioning Token Screen, you will want to
Check the Korbyt Player Network Connections as well as the player’s physical connection as well
Does the player reach your network, and does the network allow the player to reach Korbyt?
Check for any typos on the provisioning sheet
If an incorrect token was entered, you can use the trashcan to remove the incorrect entry and start again.
Using Bulk Provisioning to Change Player Details
This can be used to add new players to the tenant or edit the information about players that already exist on the tenant.
If you already have players provisioned to your tenant, the Provision Export allows you to download a CSV file already populated with your unique devices’ information, rather than the blank template
You can also use this process to add new player devices while updating already provisioned ones.
To Use the Bulk Provision to Change Player Details
Open the Mega Menu, then in the Device Management column, click Players.
Click the Provision Export button
This will download a CSV file to your computer that has your player details
Change the player details you want to update in the CSV file
For fields you do not want to change, leave them as they were
Accepted County Values for Bulk Provision
Custom Code Column for BrightSign, Samsung, and LG
Some player brands (BrightSign, Samsung, LG) can use a Custom Column at the far right to set values unique to those devices, if needed
Save the CSV file on your computer
In the CMS, click the Bulk Provision button in the upper right
This will open the bulk player interface
In the Bulk Player Provision Window in Korbyt, click Choose CSV File in the Player Provision Pop-up to upload your updated CSV File
Click Validate and Preview to display a preview and alert you of each player’s information.
After verifying that the information is correct, click Import.
If all players are accepted, then you will see a “Player has been successfully provisioned” notification. If any are filled out improperly, you will see a failed notification and the reason why the players failed to provision. If any of the players fail to provision, then you must make the necessary corrections in the CSV file, save the file, and re-upload it.
Your Player’s information will now be updated
Players that are Inactive may not fully update their information until they are Active again
Deprovisioning / Removing Players from Your Tenant
Deprovisioning a Player removes it from your Korbyt Anywhere service. It is best to have the player powered on and connected to the internet through the deprovisioning process.
To deprovision a player:
Click the Mega Menu icon, and in the Device Management column, click on Players.
Click the Trash icon for the corresponding player.
On the Confirmation Screen, click Yes
If the player is connected to the internet, it will receive the command from the system, reboot, and deprovision itself.
If the player is not connected to the internet, it will continue to play cached content until it is reconnected to an internet connection. Once re-connected, it will de-provision fully.