PDK DW Spectrum NVR Integration Tool - Available Actions

PDK & DW Spectrum Integration Documentation

The reaction to an Event is an Action. Each Action has its own parameters. The common parameters Interval of action / Instant and Fixed duration are described in Interval of action in the next paragraph.

Interval of action – Check this box to limit the frequency with which an action will occur in response to an event. Enter an integer value (1 - 999) in the No more than once per field, and select a corresponding time increment (sec, min, hrs, days). This feature is useful, for example, with an action like show notification where the triggering event may be continuous but it is only necessary to be notified periodically.

Bookmark

Creates a Bookmark in the archive of one or more cameras when an event occurs.

NOTE: Recording must be enabled on the selected cameras for Bookmarks to be saved. A Bookmark is automatically named with this syntax: <Event> on <Device>

Basic Parameters

at – Camera(s) for which Bookmarks will be recorded. To specify cameras see Selection Lists in Event Rules. At least one device must be selected.

Advanced Parameters

Fixed duration – The duration of the Bookmark. Applies to continuous events only (those with Starts and Stops attributes). It can be unchecked for continuous events such as motion on camera, an input signal on device, etc. If not checked, the Bookmark will continue until the event ends.

Pre-Recording – If checked, used to specify an amount of time to include in the Bookmark before the event occurs.

Post-Recording – If checked, used to specify an amount of time to include in the Bookmark after the event occurs.

Tags – Optional descriptors that can be added to help identify and search for Bookmarks.

May be caused by

All Events
Notifications with Force Acknowledgment enabled will create the Bookmark when an acknowledgment is complete.

Why Action may work incorrectly

Recording is not enabled on a selected camera.
The event is not configured properly.

Device Output

Generates output on a device when an event occurs, starts, or stops.

IMPORTANT: Output must be supported on the selected devices.

Basic Parameters

at – Device(s) on which output will be triggered. To specify devices see Selection Lists in Event Rules. At least one device must be selected.

NOTE: A warning notification will open if one or more of the selected devices does not have an output relay. These devices will be highlighted in red.

Advanced Parameters

Output ID – The I/O Module port ID to route signal to.

May be caused by

Any Event
Generic Event
Soft Trigger
Input Signal on Device - Synchronous output. Output stops when motion or input stops.

Why Action may work incorrectly

Output is not supported on some devices.
The event is not configured properly.

Device Recording

Starts recording on selected cameras when the event occurs.

Basic Parameters

at – Devices to record. To specify cameras see Selection Lists in Event Rules. At least one device must be selected.

Click on the at field to open the Select Devices dialog.
Optionally, use the filter field to locate cameras.
Check specific cameras to record, or select all cameras on a server by checking the corresponding box. (It is also possible to drag-and-drop the selected cameras from the Resource Tree into this field.
Click OK.

IMPORTANT: At least one camera must be selected, and recording must be enabled on the selected cameras for this rule to be functional.

Interval of action – Check this option to aggregate the number of times the action will be triggered. For No more than once per a given amount of time, or instance, enter an integer value (1 - 999) and select a time interval from the menu (seconds, minutes, hours, or days). If unchecked, the action is instant and will occur whenever the event is triggered.

Advanced Parameters

Quality – Select the desired recording parameter for these options: Lowest, Low, Medium, High, Best.

FPS – Enter a value for frames per second (up to 30). The camera's maximum FPS will be used if the FPS value entered exceeds the camera's capability.

Select one of the following:

Post-recording – For continuous events (those with Starts and Stops attributes), you can enter the number of seconds that recording will continue after the triggering event.

Fixed duration – Records for a specified amount of time in seconds when the event occurs.

May be caused by:

Generic Event
Soft Trigger

Why Action may work incorrectly

The recording is not enabled on camera.
Event is not configured properly

Do HTTP Request

A Do HTTP Request is an Action that would be done when creating a rule event in DW Spectrum in order to send a command to PDK io. The Do HTTP Request sends an HTTP request to a targeted external device or system (a floodlight switch, access control trigger, or an alarm system, for example) which can then be used in those devices or systems to trigger additional actions. The request must follow the proper format in order to be read by the receiving device.

This action generates an HTTP GET, POST, PUT, or DELETE request in response to any event triggered in DW Spectrum. Together with the Generic Event, which can receive an HTTP request as an event, a bi-directional API communication can be created between DW Spectrum and PDK io.

For example, a manufacturer has a restricted area with an ACS card reader at the entry point and cameras that monitor the area surrounding the entry point. DW Spectrum has a standard rule to send a notification when abnormal duration motion is detected in the entry area. If someone tampers with the card reader in an unauthorized attempt to enter the restricted area, DW Spectrum triggers one action to notify the surveillance center that motion is detected in the area, and a second HTTP request action to the manufacturer's call center server, which in turn runs a security procedure to activate an alarm and generate a phone call to the factory floor security personnel.

Example

http://123.12.8.1:7001/api.clickandcall.com/http/sendmsg?user=dwspectrumadmin&password=123456&api_id=3612726$MO=1&from15554567890&to=15551234567$text=Visitor+is+outside+front+door.

This example sends an API request to the clickandcall system to send an SMS message to the specified phone number. It could be coupled, for example, with a Generic Event that can trigger a third-party device to unlock the front door. Refer to the example above for use of each of the following parameters.

sendmsg – Sends data to a server at IP Address 123.12.8.1 port 7001

user and password – Credentials required by the receiver to allow the request access to their system

api_id – Required account number with receiving entity

from – Phone number from which the message will be sent

to – Phone number to which the message is sent

text – The message text, in this case, "Visitor is outside front door"

Basic Parameters

HTTP URL – The HTTP link to the external system that will receive the request. It can also contain the request itself.

HTTP content – The body of the HTTP request, if needed

Login and Password – If required by the external system, enter credentials for authentication

Content type – Enter the body of the request. Select from Auto, text/plain, text/html, application/html, application/json, or application/xml format according to the requirements of the receiving system. Auto selects the best format based on your entry.

Authentication type – Level of authentication required (Auto or Basic)

Request type – Type of request (Auto, GET, POST, PUT or DELETE)

Why the Action may work incorrectly

The event is not configured properly.
HTTP request syntax is incorrect or does not meet receiver requirements.
The external system requires authorization; no credentials or incorrect credentials were specified.

Execute PTZ Preset

Activates a PTZ (Pan, Tilt, Zoom) Preset on a specific camera (see Saving and Restoring PTZ Positions). PTZ Tours cannot be activated by an event.

IMPORTANT: At least one PTZ position must be defined on the selected camera for this action to be valid.

Basic Parameters

at – Select one camera on which to activate preset.

Advanced Parameters

PTZ Preset – Choose from the PTZ presets defined for the selected camera. If no presets are configured, the menu will be empty.

May be caused by

All events.

Why Action may work incorrectly

The event is not configured properly.
Interval of action is too long, try "instant".

Panic Recording

Triggers Panic Recording mode when the event occurs. Panic Recording switches recording settings for all cameras to maximum FPS and highest possible quality.

NOTE: If the recording is not enabled for a camera, Panic Recording cannot be activated.

Basic Parameters

Advanced Parameters

None

Why Action may work incorrectly

The event is not configured properly. See the event description for details.

Play Sound

It plays a sound when the event occurs.

Basic Parameters

at – Device to play the sound on. (The device should support 2-way audio.)

Play to users – If checked, the sound will be played in the client application of the selected users. From the drop-down menu, select a sound from the available options.

IMPORTANT: Either Play to user or a camera for 2-way audio (at) must be enabled for this rule to be valid.

Advanced Parameters

Volume

Test

Manage – Click to open the Notification Sounds dialog where the library of available sounds can be customized by adding, renaming, or deleting sounds.

To add a sound:

Click Add... and select the desired audio file. WAV, MP3, OGG, and WMA formats are supported.
Use Clip sound up to to set the duration of the audio file, in seconds.
Choose Custom Title to name the selected sound. If not specified, the file name will be used by default.

To rename the selected sound, click Rename and enter a new title.
To test the sample, click Play.
To delete the sample, click Delete.

Click OK.

May be caused by

All events

Why Action may work incorrectly

Event is not configured properly.
Sound is muted. Open any item in layout and check if the sound is muted. Volume settings are applied globally.
Too long interval of action is set. Try "instant".
Neither Play to user or a camera for two-way audio is checked.

Repeat Sound

It plays a sound repeatedly when an event occurs.

Basic Parameters

at – Device on which to play the sound. (The device should support 2-way audio.)

Play to users – If checked, the sound will be played in the client application of the selected users. Those users are sent a special notification in the Notification Panel. Note that if the user closes the notification, the sound will stop playing even if the event continues.

From the Sounds drop-down menu, select a sound from the available options.

IMPORTANT: Either Play to user or a camera for two-way audio ("at") must be enabled for this rule to be valid.

Advanced Parameters

Volume

Test

Manage – Click to open the Notification Sounds dialog where you can customize the library of available sounds by adding, renaming, or deleting sounds.

To add a sound:

Click Add... and select the desired audio file. (WAV, MP3, OGG, and WMA formats are supported.)
Use Clip sound up to to set the duration the audio file will be played, in seconds.
Choose Custom Title to name the selected sound. If not specified, the file name will be used by default.

To rename the selected sound, click Rename and enter a new title.
To test the sample, click Play.
To delete the sample, click Delete.

Click OK.

May be caused by

Generic Event
Soft Trigger

Why Action may work incorrectly

The event is not configured properly.
Sound is muted. Open any item in the layout and check if the sound is muted. Volume settings are applied globally.
Too long interval of action is set. Try "instant".
Neither Play to user or camera for 2-way audio is checked.

Send Email

Sends email to one or more users, or to additional email addresses, when an event occurs. An email server must be configured for DW Spectrum to send emails (see Configuring Mail Server for Email Notifications) and the users must have a valid email address in the DW Spectrum System.

Basic Parameters

Users the email should be sent to:

Use the Search field to filter names.

Advanced Parameters

Additional Recipients – Additional email addresses to send notifications. Use a semicolon ( ; ) to separate multiple addresses (no spaces).

Global Email Settings... – Click to configure email server parameters.

Why Action may work incorrectly

Email Server is not Configured - A notification is generated in this case. See Configuring Mail Server for Email Notifications for more details.
Email is not Set for Users - A notification is generated in this case.
The event is not configured properly.
Too long an interval of action is set.

Configuring Mail Server for Email Notifications

An email server must be configured for the System to be able to send emails. DW Spectrum can automatically provide server settings for certain email carriers, in which case you can enter just basic information using the simple entry form. If your email carrier is not recognized (warning message: "No preset found. Use 'Advanced' option"), you will need to enter the required settings manually using the Advanced entry form.

Simple Outgoing Email Settings

Open Main Menu > System Administration (shortcut Ctrl+Alt+A) > Email tab.
If advanced settings (see Advanced Outgoing Email Settings) are properly configured you can simply enter the following:

Email – Email address to use for outgoing mail

Password – Password for the outgoing email account

System Signature – User-defined System description that will identify the System in outbound emails

Support Signature – Support website for the DW Spectrum installation

Click the Test button to confirm all settings are valid. If the test fails, use the Advanced form to configure the server manually. Possible failure results:

Cannot test such parameters – The domain name is not supported
No preset found – Email and/or password is invalid

If the test is successful, click Apply to accept or OK to save and close.

Advanced Outgoing Email Settings

Check Advanced settings in Main Menu > System Administration (shortcut Ctrl+Alt+A) > Email tab.
Enter the following:

Email – Email address to use for outgoing mail

SMTP Server – Email server address

User – Email of person entering the information

Password – Password for user email account

System Signature – User-defined System description that will identify the System in outbound emails

Support Signature – Support website for the DW Spectrum installation

Port – SMTP port. Select Auto, 25, 465, or 587

Connection type – Select Secure connection using TLS, Secure connection using SSL, or Unsecure connection

Click Test to confirm all settings are valid. If the test fails:

Try a different connection type
Try a different SMTP port

If the test is successful, click Apply to accept or OK to save and close.

NOTE: Even when Advanced settings are properly configured and emails are working as desired, the simple entry form may display an error.

Show Notification

Sends a notification to the selected user(s).

Basic Parameters

Users – Select users who will see the notification.

Advanced Parameters

Force Acknowledgment – Prompts the recipient to acknowledge the notification. When checked, a notification will remain in the Notification Panel until the recipient responds by clicking the Acknowledge button. Hovering over the Acknowledge button opens a thumbnail that shows the device name and timestamp of the event. Clicking the Acknowledge button opens a Bookmark form.

The Name field is pre-populated with an event description but may be edited. A Description is required, Tags are optional.

Click OK.

Why Action may work incorrectly

Some notifications are disabled.
The event is not configured properly.
Interval of action is too long. Reduce length or try "instant".
Global notification for this event is disabled.

Show on Alarm Layout

DW Spectrum provides the ability to dynamically create Alarm Layouts. An Alarm Layout opens certain cameras when a specific event occurs, with a special Alarm title and icon.

For example, a rule can be configured as follows:

If motion occurs on cameras 1 or 2, open cameras 2, 3, and 4 in an Alarm Layout.

Basic Parameters

Camera(s) to show on Alarm Layout. To specify:

Click on Select at least one camera in the at field on the Alarm/Event Rules form.

Check the cameras to display. Click OK.

To select all cameras on a specific server, check the corresponding box. To filter search, use the Filter field. Filter criteria are the same as the search criteria. It is possible to drag-and-drop the selected cameras from Resource Tree onto the action's advanced settings form.

Advanced Parameters

Users to show alarm to – It is possible to show the Alarm Layout only to certain users. If several events are configured to show different cameras on Alarm Layout for the same user, the corresponding cameras will be added upon the Event occurrence. If several Events are configured to show different cameras on Alarm Layout for different users, each user will see the separate Alarm Layout.

Force Alarm Layout opening – If checked, when Event occurs, Alarm Layout will show up immediately. If not, the Alarm Layout will be created, but the user will still be watching the current layout and will be able to switch to Alarm Layout.

Also show source camera – Available only if Event is bound to cameras. If checked, when Event occurs Alarm Layout will contain the camera that created the Event.

For example, if a rule is set up to show cameras 2 and 3 and motion occurs on Camera 1, Alarm Layout will contain cameras 1, 2 and 3. If unchecked, it will contain only cameras 2 and 3.

Why Action may work incorrectly

Alarm Layout is not showing to a certain user
The event is not configured properly. See the Event description for details
Too long interval of action is set. Try "instant".

Show Text Overlay

Displays text overlay on specific cameras when an event occurs.

Basic Parameters

Camera(s) to display text overlay on. To specify:

Click on Select at least one camera in the desired row on the Alarm/Event Rules form.
Check the cameras to display. Click OK.

To select all cameras on a specific server, check the corresponding box. To filter search, use the Filter field. Filter criteria is the same as search criteria. It is possible to drag-and-drop the selected cameras from Resource Tree onto the Action’s advanced settings form.

Advanced Parameters

Also show on source camera – Available only if the event is bound to cameras. If checked, when event occurs, text will be displayed on the source camera too.

For example, if a rule is set up to show cameras 2 and 3 and an event occurs on camera 1, text will display on all 3 cameras. If unchecked, it will display only on cameras 2 and 3.

Display text for ... Seconds – If checked, the text will be visible for the specified amount of time. Can be unchecked for the following continuous events: Motion on Camera, Input Signal on Device, or Generic Event. If unchecked, text will be displayed until the event stops.

For example, text will be displayed on a specific camera while the motion is going on.

Use custom text – If not specified, the event description will be used.

Why Action may work incorrectly

The event is not configured properly. See the Event description for details.

Speak

Pronounces specific text when an event occurs.

Basic Parameters

Speak the following – Enter the text to pronounce.

at – Camera to pronounce the text on. Camera should support 2-Way Audio.

Speak to users – If checked, the text will be pronounced to the selected users in the Client application.

IMPORTANT: Either Speak to users should be checked, or at least one camera should be selected for two-way audio, otherwise the rule will be invalid.

Advanced Parameters

Interval of action - Check this option to aggregate the number of times the action will be triggered. For No more than once per a given amount of time, or instance, enter an integer value (1 - 999) and select a time interval from the menu (seconds, minutes, hours, or days). If unchecked, the action is instant and will occur whenever the event is triggered.

May be caused by

All Events

Why Action may work incorrectly

The event is not configured properly. See the Event description for details.
Sound is muted. Open any item in layout and check if the sound is muted. Volume settings are applied globally.
Too long interval of action is set. Try "instant".
Either Play to user should be checked or camera for two-way audio should be selected.

Write to Log

Writes a record to the event log when an event occurs. By default, all events mentioned in rules are written to the log; however, if all notifications are turned off, you can use the Write to Log action for a specific event.

Advanced Parameters

May be caused by

All Events

Why Action may work incorrectly

Event is not configured properly
Interval of action is too long, try "instant" instead.