Articles in this section

Configuration of automated network player exports

Avatar
Ian Maison
  • Updated
Follow

Before you begin:

  • Please note that this is a Paid Service from Signagelive

The configuration of automated network player exports is a manual process which needs to be done by the Signagelive Development Team. As there is no user interface for configuring automated player exports for networks, these need to be configured directly in the database.

The options for configuration, essentially what developers need to get this set up, are:

  1. When the first export should be completed. Please note that using a date in the past will not get data from the past, just will make the export run on the current data.
  2. How frequently the export is run in days.
  3. The actual configuration of the export, which must be a valid JSON file as below.

3a. Example for a single network, single user, default config:

{
  "networks": [
     {
       "networkid": 12345,
       "playerExportRequest": {
       "tagMatchRule": "All",
       "start": 0,
       "limit": 20,
       "expiresFrom": null,
       "expiresTo": null,
       "status": "All"
     }
   },
 ],
 "notificationAccounts": [
   {
      "email": "user@domain.com",
   }
 ]
}
  • Note the "networkid". You can see your network ID on the top Network: menu in Signagelive as it reads Network: network name (network ID).
  • The “playerExportRequest” object is the same as the object which is sent when manually clicking the “Export” button in the Network manager, therefore a search with no filters has the values provided in the sample JSON 3a. above. However if you would like to setup different filters in your export, in order to get the custom configuration for the "playerExportRequest" object you can easily get its values by following these steps:
    • Please open the developer tools on the browser and go to the Network tab.
    • With the developer tools open, configure a standard export in the UI, setting the filtering options as required, and then click the Export button. 
    • Click the “Export” Network API call with 204 status, xhr type, then click the Payload tab on the right. The filters set will be available there, see screenshot below as an example with active Status, a search by hardware ID, Tag: Any condition, a tag, Expires From and Expires Before filters:

export_filters.png

3b. Example for a single network, single user, config from screenshot:

{
"networks": [
{

"networkid": 12345,
"playerExportRequest": {
"tagMatchRule": "Any",
"tags": "test",
"start": 0,
"limit": 20,
"search": “22a6d”,
"expiresFrom": "2022-11-01T00:00:00",
"expiresTo": "2024-01-01T00:00:00",
"status": "Active"
}
},
],
"notificationAccounts": [
{
"email": "user@domain.com",
}
]
}

An export can contain multiple networks. If using multiples then the filtering performed for each network can be different, as this is specified per network. You can include multiple networks within the “networks” array, each network will need the entire “networkid” JSON object, which is:

{
"networkid": 12345,
"playerExportRequest": {
"tagMatchRule": "All",
"start": 0,
"limit": 20,
"expiresFrom": null,
"expiresTo": null,
"status": "All"
}
}

3c. Example for multiple networks, single user:

{
"networks": [
{
"networkid": 12345,
"playerExportRequest": {
"tagMatchRule": "All",
"start": 0,
"limit": 20,
"expiresFrom": null,
"expiresTo": null,
"status": "All"
}
},
{
"networkid": 12346,
"playerExportRequest": {
"tagMatchRule": "Any",
"tags": "test",
"start": 0,
"limit": 20,
"search": “22a6d”,
"expiresFrom": "2022-11-01T00:00:00",
"expiresTo": "2024-01-01T00:00:00",
"status": "Active"
}
},
],
"notificationAccounts": [
{
"email": "user@domain.com",
}
]
}

The email accounts used for notifying must be set up as users on each of the networks in the export config, and they must have the player export permission for that network, based on the network User Group Role or overridden permissions, network User Role or overridden permissions. If a user does not have access to all the Networks or have the correct permission, then they will not receive the email notification that the export has been completed for any of the networks.

 

3d. Example for multiple networks, multiple users:

{
"networks": [
{
"networkid": 12345,
"playerExportRequest": {
"tagMatchRule": "All",
"start": 0,
"limit": 20,
"expiresFrom": null,
"expiresTo": null,
"status": "All"
}
},
{
"networkid": 12346,
"playerExportRequest": {
"tagMatchRule": "All",
"start": 0,
"limit": 20,
"expiresFrom": null,
"expiresTo": null,
"status": "All"
}
},
],
"notificationAccounts": [
{
"email": "user1@domain1.com",
"email": "user2@domain1.com",
"email": "user3@domain2.com",
}
]
}

The completed automated export CSV will contain all of the same data as per the standard player export, but with the addition of the Network ID and Name as the first two columns of data.

Please Note

Note you can use a JSON validator tool online such as here or Notepad++ on your laptops to make sure a valid JSON config is provided.

All the configuration (points 1, 2 and 3 above) can be provided to the Signagelive Support Team so it can be escalated to get Automated Network Player Exports configured for you.

Related articles

Comments

0 comments

Article is closed for comments.