What is a player?
A “player” is a digital signage media device that can display videos, images, audio, and custom content created through the Korbyt platform. Players can be connected to many different displays such as televisions, screens, kiosks, and various other types of display devices. Players come in many different shapes, sizes, and brands, and some may provide additional features. Some of the many types of players that Korbyt supports are select models of Windows, Bright Sign, Chrome, and Android media players. Using Korbyt, you can easily group players and perform actions like updates, restarts, and screenshots with a single click. Reference this article to see what players are supported with Korbyt.
What is provisioning a player? How Can I Do It?
provisioning is the process where you attach your player with your Korbyt environment. Provisioning a player is seamless and simple. Once the device has power and is connected to a stable internet connection, (some models provide Wi-Fi capability, and some require an ethernet connection) simply connect it to the display device of your choosing. Once the player is turned on for the first time a provisioning screen will be shown which will look like the image below. There will be a few areas of importance when provisioning your player labeled below. First is the Provisioning Token, this is a unique key given to the player in order for the Korbyt Platform to identify the player. The second area of importance is the Player Name, this is a name given to the player by default (the name can be changed after the payer has been provisioned or can be set through bulk) this will be what your player is identified by in the platform after provisioning.
Please see this article for requirements to get the Korbyt Player connected in the cloud.
To provision the player, you will need to go to korbyt.com Once logged in you will be brought to a dashboard.
- Once on the dashboard, you will see an icon in the top right corner. Click on the icon and you should be redirected to the player’s page. You can also go directly to the player page using the standard menu path.
- Once redirected to the player page, click the “Provision Player” Button
- After Clicking this button, a modal will be displayed requesting the previously mentioned provisioning token. Simply enter the provisioning token and click “Provision”
- After submitting the Provisioning Token, you will notice that a new player is displayed on the player page. It will have a status of “Pending” until the player is done provisioning. Once provisioning is completed and the player is able to reach Korbyt, you will see that the status is switched to “Active”
How do I Deprovision a Player?
Deprovisioning a player is simple. Simply just delete the player from the Korbyt Platform and the player will reboot and deprovision itself. It is important to note that if the player is no longer connected to the internet it will continue to appear connected and play cached content until it is reconnected with an internet connection. Once re-connected it will de-provision properly.
Can I Provision More Than One Player At Once?
Yes! With the bulk provisioning feature in the Korbyt Platform, a user can upload a CSV file containing information for multiple players and use that information to provision all the players at once, instead of using the provisioning token, bulk import uses the mac address of each player for provisioning. To learn how to use bulk provision follow the steps below.
- Navigate to the player page and select the “Bulk Provision” button.
- A modal should appear with an option to download a sample CSV file.
- Download the sample CSV file and fill in player information. (While it is recommended to fill in all fields, only “MAC Address” and “Name” are required) The sample CSV file will look similar to the one below.
- After uploading the CSV file, select “Validate and Preview” button. Modal will now display a preview and alert you of each player’s information.
- After verifying information is correct, select the option to import. If all players are accepted than you will see a “Player has been successfully provisioned” alert. If any are filled out improperly, you will see a failed notification and the reason the player(s) failed to provision. If player(s) fail to provision you must fix the areas of question in the CSV file, and save the file with your updated changes, and restart the import process.
What Is the Player Details Page?
The Player Details Page is used to edit/view player information, view content assigned to a player, and control the player in various ways. This page is accessible by clicking the edit button on the player.
Payer Details Page Actions:
Sending this action will cause the player to check in on the next heartbeat (within 60 seconds).
Sending this action will cause the player to reboot at a specified date and time or within the next check in.
Sending this action will cause the player to send a log file back to the Korbyt platform within the next check in. The log file will be available in the player logs section in this page.
Sending this action will take a screen shot of what is being currently displayed on the player at the time. This screen shot will be used for a preview thumbnail of the player. Make sure to refresh the screenshot of the player after this action is completed.
Sending either of these actions will Display/Hide an information panel on the player. This panel displays various information about the player itself.
Enabling this action will display a list of upgrades (if any are available) for you to select which version to upgrade your player to.
The player details will show various information about the player as well as allow the user to change the name of the payer. A few areas of importance are the model, provisioning code, IP address, last check-in, last heartbeat, agent version and the recent player events. These will all be useful for trouble shooting your player if any issues arise.
A location can be set for each player to help identify where these devices are located. Location information can be manually entered or entered during bulk import. This is used for many reasons such as:
- Dashboard Map – View your players activity from a map view. Pins are painted on the map based off this location data.
- Dynamic Content assignment – Using a clever playlist, display or hide content based off player location information.
- OnTarget weather/news/traffic – Using the ontarget element within layout builder, this element dynamically pulls weather/news/traffic based off the players location.
- Data filtering – Use player location to filter your data subscription. For instance, only show data for that player’s city. This is a dynamic ruleset, not statically set to a physical city.
- Reporting Analytics – Make the player status report more useful by including location information.
What Is Screen Control?
Screen Control allows the user to control settings of the display device the player is connected to (Brightness, volume, turn on, turn off, etc.). It is also important to note that screen control will only work with KDA model players. To start setting up your screen control, follow the steps below.
- Navigate to the players page and scroll down to the screen control section.
- After selecting this option a drop down will appear. Simply fill in the fields and select the action you wish to perform on the screen.
What are sleep and blackout Schedules and what’s the difference?
Sleep and blackout schedules while very similar, perform different actions. A sleep schedule will cause the player to sleep which will cause the player to turn off and “sleep” during scheduled days/time, whereas black out schedules will allow the player to continue displaying cached content, but the player will not receive new content or check-in during the scheduled days/times. To add a sleep or blackout schedule, follow the instructions below.
- Navigate to the player details page and click on the sleep/blackout schedule option.
- After selecting the Sleep/Blackout schedule, simply select which days you want to schedule this action for, and the times when you want the schedule to occur. Once you have made your selections, make sure to save the schedule.
What are player Groups, and Why Should I Use Them?
Player groups allow the user to assign players to a group to use actions, control Sleep/Blackout schedules, configure status notifications, and assign content to multiple players at the same time. Groups are useful for many reasons, such as controlling content on all of the players in a certain location, upgrading multiple players, and setting up blackout/sleep schedules on a large number of players.
What is a Static Group and How Can I Create One?
Static groups are a way for the user to manually select players to be grouped together. To Create a static player group follow the instructions below.
- Select Player Groups from the mega menu.
- After Navigating to the Player Groups page, click the “Add Player Group” Button.
- Now that you are on the Player Group edit page, fill in all required fields and click the “Add Static Players” Button.
- After selecting to add players, a menu will appear. This Menu will allow you to manually select any players to add to the group.
- After selecting the desired players, simply save the group, and the group will then be usable all around the platform.
What Is A Dynamic Group?
Dynamic groups, unlike static groups, do not allow the user to manually select players, but rather allows the user to create “Dynamic Rules” where the user can define the conditions for what players are added to the group. Once the group is saved, all players meeting the criteria of the Dynamic Rule will be added into the player group. In order to create a dynamic group, repeat steps one and two from the above section and follow the steps below.
- Select To Add a Dynamic Rule
- Once you’ve Selected to Add Dynamic Rule A menu will appear to allow you to build a rule. You can see in the example below I have selected to add all players whose Status Is Active. This is a simple example but rules can get much more complex.
- If you would like to add more stipulations to your rule simply click the Plus button to the left of the current role. In the example below I have selected the “Next Operation” column of our rule to be And This means both our original statement and the new statement being added must be valid in order for a player to be added to this group. If the “Next Operation” column is set to Or then only one of the statements must be valid for a player to be added to the group. IN the example below you will see I have selected the statement to be if the City IS San Francisco.
- After creating a rule simply Save the Player group and the group is now usable all around the platform
How to view Content assigned to Groups
If you are not familiar with assigning content to players and player groups please visit the Playlist section.
- In order to view content simply go to the player group/player details page and click the content assigned section.
- After Clicking the content assigned Section a container will drop down showing all content assigned to the player group.
How to configure player notifications
Player notifications can only be used in player groups and can be found in the player groups details page under the “Player Notifications Recipients”. Notifications can be set to deliver to users already in your Korbyt platform. When a player’s status within this group goes active/inactive, a notification is sent to the group of selected users to let them know there could possibly be an issue with this specific player. IMPORTANT NOTE: If a player is offline, that does not mean content is not displaying. The Korbyt player caches content so that if a device falls offline, the latest content downloaded will continue to display.