Custom Field Report Action

Your dynamic content can invoke the field_report action at any point in the playback cycle.

Broadsign Control Player will record custom-field content which will appear in the Field Report tab of the Service panel for the player. See The Field Report Tab.

Call the field_report action by using one of the following:

WebSocket Server:

• JSON – You can pass parameters from within your HTML5 file using JSON.

  Note: Ensure that you select Enable Remote Control in the Remote Control tab of the configuration profile. See The Remote Control Tab.

  Note: If using JSON via the WebSocket server, any firewall present on Broadsign Control Player should be configured to access port 2326 directly for use.

Port 2324:

• remote_action – An application that ships with Broadsign Control Player, using command line.
• XML – If you want to develop your own applications, you can communicate directly with Broadsign Control Player API using XML.

Note: Ensure that you select Enable Remote Control in the Remote Control tab of the configuration profile. See The Remote Control Tab.

Note: Any firewall present on Broadsign Control Player should be configured to either allow bsp.exe to open ports, or configure port 2324 or port 2326 directly for use.

Note: The Triggers Action is the only exception to this rule. It uses port 2325. See Triggers Action.

You can call this action on Windows and Ubuntu Linux, and find it along the following paths:

• Windows (64-bit):

C:\Program Files\BroadSign\bsp\bin

• Ubuntu Linux:

  /opt/broadsign/suite/bsp/bin/

Your dynamic content can invoke the field_report action at any point in the playback cycle.

For example, to invoke field_report, type:

remote_action field_report --custom-field '<custom_json>'

Where:

• field_report is the action type
• custom-field is the name of the custom field
• <custom_json> contains custom key-value pairs written in the JSON format, for example, {"key1":"value1", "key2":value2"}. The <> brackets are not required.

Broadsign Control Player will record custom-field content which will appear in the Field Report tab of the Service panel for the player. See The Field Report Tab.

An application can inject custom fields in the Field Report by sending an XML message to the monitor_remote port (2324).

<rc version="1" id="1" action="field_report" custom_field="<custom_json>"/>\r\n\r\n

Note: You must terminate the request with \r\n\r\n.

The player will respond with the following document:

<rc version="1" status="1" action="field_report" id="1" />

Note: Each command sent requires a unique identifier (id). The application can use a simple incrementing value here.

Custom Field Report Action - XML Parameters

Note: Any firewall present on Broadsign Control Player should be configured to either allow bsp.exe to open ports, or configure port 2324 or port 2326 directly for use.

An application can inject custom fields in the Field Report by sending a JSON message to port 2326. You will need to enable the WebSocket server. For more information, see The Remote Control Tab.

{
    "rc": {
        "version": "1",
        "id": "1",
        "action": "field_report",
        "custom_field":" "<custom_json>",
    }
}

The player will respond with the following document:

{
    "rc": {
        "id": "1",
        "version": "1",
        "action": "field_report",
        "status": "1"
    }
}

Custom Field Report Action - JSON Parameters

Note: If using JSON via the WebSocket server, any firewall present on Broadsign Control Player should be configured to access port 2326 directly for use.