DW Spectrum User Manual

Key Concepts:

•This is a default event.

•Occurs when the Server receives an HTTP request from an external device, service, or environment.

•Users can choose to hide this notification.

•Enables third-party products and services to send an HTTP string to a server, and thus the device, using a rest/v4/event/generic API call.

•Pair with the "Site HTTP(s) Request" action to create bidirectional API communications between DW Spectrum and external software environments.

•A Generic Event request must follow the proper format in order to be read by the server.

•The fields in the HTTP request must match the corresponding event rule fields to be acted upon.

•Keywords and the contents of all Lookup Lists are case sensitive.

•Empty fields are always processed as a match.

Basic Parameters:

Each request contains the following fields:

•Source.

•Caption.

•Description.

•Metadata – Used to pass a device identifier that will specify devices the event is limited to (cameras, I/O modules, etc). To obtain the device identifier:

Open the device context menu and click Device Settings. In the General tab, the device identifier will be displayed as Camera ID or Device ID.

NOTE: It is necessary to specify a device if the generic event is linked to a notification, and the "Force Acknowledgment" option is required. In this case once the notification is acknowledged, a Bookmark will be created and linked to the specified device. See "Show Notifications" for details.

•State – This is an optional field for the `state`.

oIf there is no state field in the HTTP request, the event is considered instant.

oIf specified, the event is considered continuous and the rule requires a state=started or state=stopped attribute.

oIf a Generic Event containing state=started is received, the resulting action will continue until the server receives a Generic Event with the same parameters that contains state=stopped.

NOTE: If a continuous action such as "device recording" or "repeat sound" is bound to an instant Generic Event (one without a state field), the rule will not work. See "Configuring Event Rules" for more information about continuous and instant events.

Advanced Parameters:

For detailed information on the advanced parameters available for generic events, which are not covered in this Desktop Client User Manual, users and developers should refer to the API documentation hosted on an available mediaserver using the following syntax:

https://<serverIp>:7001/#/api-tool/main

Omit Logging:

When selected, the Omit Logging option will not add this specific generic event rule from being added to the Event log. This option allows an action that is triggered in rapid succession or with a very high frequency to be performed without a database call or storage action that would cause undesirable "spamming" of the Event Log.

NOTE: Even if the "Omit logging" checkbox is selected, a generic event with a "Write to log" action will still appear in the event log.

Troubleshooting Suggestions:

•The user has disabled this type of notification.

•HTTP request is not correctly written. Refer to the Server API.

•Request is filtered out. Try clearing all fields (Source, Caption, Description) and trigger the HTTP request again.

•HTTP request is bound to a continuous type of action but does not contain the "State" field.

•A device is not specified yet the event is linked to a notification and the "Force Acknowledgment" option is set.