DW Spectrum - Lenel OnGuard Integration Guide

DW Spectrum – Lenel OnGuard Integration Guide

-----------------------------------

Affected Roles: Owner, Administrator

Related Digital Watchdog VMS Apps: DW Spectrum IPVMS

Software Version: DW Spectrum 5.0.0.36871

Last Edit: June 23, 2023

-----------------------------------

Lenel OnGuard Integration

The Lenel OnGuard application provides access control that can be integrated with DW Spectrum IPVMS. With the Digital Watchdog OnGuard Integration Service, users can export OnGuard event information to the DW Spectrum System and enable simple reader commands within the DW Spectrum Client.

Exported event information can be used in DW Spectrum to:

Bookmark Video
Trigger Device Output
Initiate Device Recording
Perform an HTTP Request
Execute a PTZ Preset
Play Sound
Repeat Sound
Send Email
Show Notification
Show Text Overlay
Write to Log

This article will outline the integration prerequisites and the setup process for the integration as provided by Lenel. The Lenel guide is available for download and is attached to this article.

Integration Prerequisites

To integrate DW Spectrum IPVMS and Lenel OnGuard, specific software licenses and setup are required prior to installation.

Pre-Installation Checklist

It is recommended to ensure that the following items are complete prior to scheduling installation of the access control system.

Installation of Open Access License
Configuration of Open Access (see your OnGuard Open Access User Guide)
- This includes the creation of an OnGuard user account that is designated for the integration setup only.
Configuration of OnGuard Logical Source (see your OnGuard System Administration User Guide)
Confirm personnel availability for the installation by Detrios

Required Licenses

DW Spectrum Pro/Enterprise License – required to record and playback camera video and events through the DW Spectrum Server program.
OnGuard OpenAccess License – required to
Detrios License – required to run the OnGuard application.
- Before installing the service, install and run the Detrios License Request Tool and provide the UID and customer name to your DW Inside Sales representative.
- If the license has not been installed or the error below is received, please contact Detrios at [email protected].

Example error in log file for a missing Detrios license file:

System.IO.FileNotFoundException: License file 'detrios.lic' not found.

If a new license is needed please send this UID [1Q83SDS-1V75X9O-31YF3F-IIOG3W] to [email protected].

OnGuard Installation Steps

The Digital Watchdog OnGuard Integration Service is installed through an installation package provided by Detrios. The installer will create a Windwos Service on the installed server that will communicate with the OnGuard server.

**NOTE: The OnGuard integration service should be installed on the primary hosting server only.

Application and Service Installation Steps

To install the OnGuard Integration Service:

Copy the installation and setup files to the local server.
1. DWSpectrum.EventExport.Installer.msi
2. Setup.exe
Right-click on the “setup.exe” file then select “Run as administrator”.

The Setup Wizard will display.

Proceed through the Setup Wizard to confirm the installation directory location and users for the installations.

Confirm the installation and then close the installation Wizard once the installation process has been completed.

Service Configuration Elements

After installing the OnGuard application, the service configuration file will be in the application installation directory with the name “DWSpectrum.EventExport.Service.exe.config”. This will be in the form of an XML file for configuration.

EventExportConfig Section

This configuration section includes:

WebApiUrl – the web address for the self-hosted service to receive reader command requests.
WebApiUser – the username that will be used to validate requests to the web service for reader commands.
WebApiPassword – the password that will be used to validate requests to the web service for reader commands.
AlarmSource – the OnGuard Logical Source that will be used to Send Events into OnGuard.
DwAPiUrl – the web address for the DW Spectrum API.
DWApiUser – the username that will be sent as part of the request of the DW Spectrum API.
DWApiPassword – the password that will be sent as part of the request to the DW Spectrum API.
DwEventExportSource – text that can be used to uniquely identify the site for the event information.
SubscriptionId – the OnGuard Open Access Event Subscription ID that is used to reconnect to the Event Bridge.

PacsApiConfig Section

This configuration section includes details for connecting to OnGuard Open Access:

ApiServer – the web address for Open Access.
ApiUsername – the username for Open Access.
ApiPassword – the password for Open Access.

EmailConfig Section

This configuration section is used for the email settings that enable outgoing emails:

ServerName – host name or IP Address of the email server that should be used.
Username – username that will enable the service to send emails.
Password – user password that will enable the service to send emails.
Port – the port to use when connecting to the SMTP server. The default is 25 and 587 is also a common port used.
UseSSL – determines if SSL should be used in the connection to the SMTP server. The use of SSL may require the use of different ports.
FromAddress – the outgoing email address that should be used when sending emails.
Subject – the subject text for the emails.

Configuring HTTP Requests in DW Spectrum

The Digital Watchdog OnGuard Integration uses an HTTP request to a self-hosted web service to support the Reader Commands functionality. The web service requires user authentication, which is configured in the service configuration file.

To configure the HTTP request:

Open the DW Spectrum Client desktop application and log in as the Owner or as an Administrator.
Right-click on a camera and select “Camera Rules”.

The Event Rules menu will display.

Click the +Add button and configure the following settings.

Event Settings:

When – set to “Soft Trigger”.
At – select the target cameras that will trigger the HTTP request.
Available to – set to “All Users”.
Name – enter a name for the event trigger.
Icon – select the preferred symbol for the soft-trigger. This icon will display for the selected cameras.

Action Settings

Do – set to “Do HTTP request”
HTTP URL – enter the HTTP URL for the server
- Ex: http://<serveripaddress>:8800/api/v1.0/readerCommand
HTTP Content – enter the HTTP Body as defined in the HTTP Body article section below.
- Ex:

{

"ReaderName":"Meliora 101",

"Command":"1",

"Comment":"Notes"

}

Content Type – set to “application/json”.
Login – enter the username to the target server (if applicable).
Password – enter the password to the target server (if applicable).
Authentication Type – set to “Basic”.
Request Type – set to “POST”.

Click the Apply button to save the settings.

The select Icon will appear in the bottom-right corner of the camera viewing window once applied.

HTTP Body

The HTTP Body for the Reader Command is as follows:

The HTTP body for the Reader Command is as follows: Property	Type	Description
ReaderName	String	Name of the Reader in OnGuard
ReaderCommand	Int	Integer representing the desired reader mode
		• 0 – Locked
		• 1 – Card Only
		• 2 – Card Or Pin
		• 3 – Card And Pin
		• 4 – Unlocked
		• 5 – Facility Code
		• 9 – Pulse
		• 100 – Default

Comment	String	Event Text that will be included in the Generic Event sent to OnGuard

For More Information or Technical Support

DW Technical Support: 866.446.3595 (option 4)

https://www.digital-watchdog.com/contact-tech-support/

______________________________________________________________________________

DW Sales: 866.446.3595 [email protected] www.digital-watchdog.com