DW Spectrum User Manual
Key Concepts:
•The actions Do HTTP(s), Send Mobile Notification, Site HTTP(S) Request, and Speak can use field parameters to insert Site metadata.
•Field parameters must be contained within curly brackets { } and adhere to applicable syntax rules where they are used.
•The resolved content and syntax of the populated parameters can vary per originating device or Site configuration.
•Action field parameters for populated when the the action begins and may be subject to minor lag for time based values.
•When event field parameters are used with the speak action, label will be spoken during tests and the value of the filed will be spoken when the event rule is true is and valid under normal operating conditions.
Available Parameters:
The following examples are provided for reference only, available parameters and contents are subject to device and Site settings.
Parameter Label |
Description |
Example |
|---|---|---|
{device.name} |
•The name of the resource (device) that generated the event. •For Site events this will be {site.name}. |
•Hallway camera •Basement server |
{device.type} |
•The type of the resource (device) that generated the event. •For the Site events, this will be {site.name}. |
•Camera •ACME-Site |
{event.caption} |
•The user-provided caption is used when available (Generic Event, Analytics Event, Integration Diagnostic Event). •For an Analytics Event, if caption is not provided, then the caption is substituted with the event type (Line Crossing, People Detection). •Otherwise, the name of the event that is used in Event rules and Event logs is used. |
•Camera Disconnected •Generic Event •Custom User Caption •Line Crossing |
{event.description} |
•Generic event or analytics event description. •Will return empty string for all other events. |
Description text |
{event.name} |
Name of the event used in the event rule and the event log. |
Camera disconnected |
{event.source} |
•Generic event source. •The value of {device.name} for all other events. |
•Keyword •Custom text |
{event.time} |
Date and time of the event in ISO8601 format |
2024-01-13T09:11:23+00:00 |
{event.timestamp} |
The Current Epoch Unix Timestamp |
1644422205 |
{event.timestampMs} |
The Current Epoch Unix Timestamp in milliseconds |
1644422205 |
{event.timestampUs} |
The Current Epoch Unix Timestamp in microseconds |
1644422205 |
{event.type} |
Same as {event.name} |
Camera disconnected |
{server.name} |
•The name of the server that generated the event. •Or the name of the server connected to the resource that generated event. |
•Garage Server |
{site.name} |
The name of the Site where {server.name} is connected. |
Warehouse |
