Manifest File - Crestron 3 Series Reference Manual

Manifest File

The manifest file, which is JSON encoded, contains all the information required
for scheduling and performing automatic updates on a 3-Series control system.
The control system parses the manifest file, locates any required updates, and
performs them in the order listed in the file. The manifest is always downloaded
and parsed either at a scheduled time or from a forced action, which can be set
from console commands.
The following shows an example of a manifest file JSON format:
[
{
"ControllerHostName": "ControllerHostname",
"deviceHostname": "DeviceToUpdateHostname",
"deviceModel": "Prompt",
"deviceId": "XX",
"indirectCresnetId": "XX",
"controlSystemHostname"": "ControlSystemHostName",
"logFolder": "URL",
"fileToUpdate": [
]
}
]
Overview of Manifest Parameters
The control system uses the following top-level parameters to determine which
associated actions apply to it in order to initiate the auto update mechanism. At
least one of these parameters must be defined, and they may contain wildcards
for partial matching. A control system matches all specific values before taking
the associated action.
NOTE:
•
•
•
Reference Guide – DOC. 7150B
{
"fileUrl": "URL",
"fileHashUrl": "URL",
"fileType": "ACTION",
"whenToDownload": "TIME",
"whenToApplyUpdate": "TIME",
}
All keywords are case insensitive.
ControllerHostName: The hostname of the control system. Indicates
that the following schema is meant for a control system. All non-control
systems continue to parse the schema and act upon it if the details
match.
deviceHostname: The hostname or IP address of an Ethernet device. This
field will have different meanings depending on the operation to be
performed (refer to "Description of Manifest Parameters" on page 49). If
this parameter is omitted, the value will default to any.
deviceModel: The device type of the target client and the physical
transport (refer to "Description of Manifest Parameters" on page 49). If
this parameter is omitted, the value will default to any.
3-Series Control Systems • 47