PDK & DW Spectrum Integration Documentation

 

Generic Event

This occurs when the server receives an HTTP request from an external system such as an alarm system, access control device, or monitoring system. This is a default Event.

DW Spectrum allows third-party systems and devices to send an HTTP string known as a CreateEvent API call. The CreateEvent request must follow the proper format in order to be read by the server, and the Event fields in the rule must match the corresponding fields in the HTTP request to be acted upon. Full server API documentation is accessed on any installed server from 

http:// <serveripaddress>:<servernetworkport>/static/api.xml. 

NOTE: Values in the Event field are case-sensitive; an empty string functions as a wildcard, where any value is considered a match. 

When a Generic Event is created in the DW Spectrum System, there are three basic parameters associated with each event; each HTTP request contains these three parameter data pieces: the source, caption, and description. 

These three data events are searched and filtered by the DW System. This can be leveraged in the Bookmark Log (Ctrl-B) when bookmarks are created from Events, and when creating Event Rules (Ctrl-E).

Source

The source parameter of the Generic Event is the name of the device in the pdk.io system that generated the PDK io event.

Caption

The caption parameter of the Generic Event is determined by the corresponding pdk.io event type that was generated. This can be any of the following values:

PDK.io Event Type	DW Spectrum IPVMS Generic Event Caption	Description
Open (DPS)	door.input.dps.opened	The door position sensor detected the door open.
Close (DPS)	door.input.dps.closed	The door position sensor detected the door closed.
AutoOpen Enabled	door.autoopen.on	Auto open became active on the device.
AutoOpen Disabled	door.autoopen.off	Auto open became deactivated on the device.
Door Propped Alarm	door.alarm.propped.on	The door propped alarm has triggered for the device.
Door Propped Alarm Clear	door.alarm.propped.off	The door propped alarm has been cleared for the device.
All Prop Clear	door.alarm.propped.alloff	All door propped alarms have been cleared.
Door Forced Alarm	door.alarm.forced	The door forced alarm has triggered for the device.
Communication Loss	endpoint.alarm.commloss.on	Communication to the connection has been lost.
Communication Loss Clear	endpoint.alarm.commloss.off	Communication to the connection has been re-established.
No Person Associated with Credentials	door.request.unknown	An unknown credential was scanned and access was implicitly denied.
Access Allowed	door.request.allowed	A known credential was scanned and access was allowed.
Access Denied	door.request.denied	A known credential was scanned and access was denied.
Duress PIN Entered	door.request.duress	A duress PIN was used to authenticate at the reader.
Request to Exit Open	door.input.rex.on	The request to exit was triggered on the door.
Request to Exit Closed	door.input.rex.off	The request to exit was cleared on the door.
Card Scan Error	error.card.parse	Bad data was received from the card reader connected to the door.

 

Description

The description parameter of the Generic Event is the same text that is generated for the info text of the Live Events in pdk.io. 

Generic Events created by pdk.io do not have the following parameters defined (Metadata and Occurs). These are parameters which are defined in DW Spectrum. 

Metadata

Metadata, a DW Spectrum parameter, is used to pass a device identifier that will specify devices the event is limited to.

IMPORTANT: PDK does not define the Metadata parameter; the Force Acknowledgement option cannot be used when using the Show Notification Action as part of a rule Event.

Occurs

Occurs is a DW Spectrum parameter and is not defined in PDK.io. This is an optional field in DW Spectrum for the State. If there is no State field in the HTTP request, the Event is considered instant. All Generic Events created by pdk.io are considered instant Generic Events.

IMPORTANT: 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.(Verify w/ DW)

 

 

Soft Trigger 

 

 

The Soft Trigger Event type adds a button to one or more devices in layout. When a user clicks on a Soft Trigger button, the associated action is triggered. The Event can be instant (when the button is clicked), or continuous (triggers as long as the button is held). Soft Trigger buttons appear as a circular overlay in the lower-right region of an item and will display the contents of the Name field when the mouse cursor hovers over it. 

For example, a Soft Trigger button can be created to start and stop a Bookmark recording when an operator sees suspicious activity. It can also be a panic button that starts a siren when an emergency situation is detected. 

In addition to making it possible for a user to initiate an action from layout, a Soft Trigger that has a Perform HTTP Request action makes it possible to integrate third-party systems and devices, and to bundle multiple actions within an event. 

For example, a Soft Trigger can be created with an HTTP request to a third-party device that initiates one or more of the actions the device is capable of, such as "if temperature that exceeds 110°F is detected, close door." 

Basic Parameters 

at – Click in this field to select the device(s) that will have the Soft Trigger button. Note that if you choose to, the button will be placed on offline devices as well. 

Available to – Click in this field to select the users or user roles that are allowed to use the Trigger. 

IMPORTANT: To be able to trigger an event on a device, the user or user role must have input permission on the device. If they do not, the following warning appears.

Name – Enter a brief description of the event that will be triggered. Contents of this field are displayed on the layout when the mouse cursor hovers over the button. 

Icon – Select from the menu of available icons.