Lenel OnGuard Documentation

1.Purpose #

This document is intended to allow the user to synchronize an XPressEntry system with a Lenel OnGuard system.

2.Setting Up OnGuard to Synchronize with XPressEntry #

It is assumed OnGuard is installed with DataConduIT enabled and a user with sufficient permissions for WMI to communicate is logged in.
 
Order of Operations

  1. OnGuard Prerequisites
  2. Set up OnGuard Data
  3. Enable Synchronization from XPressEntry
  4. Set up XPressEntry Data

OnGuard Sync Prerequisites

  1. OnGuard DataConduIT License
  2. A Service Account for the XPressEntry Service with Single Sign On enabled in OnGuard
  3. WMI Configured on OnGuard machine to enable Remote WMI if needed

3.Setup OnGuard Data and Settings #

3.1.Handhelds #

For every physical XPressEntry handheld reader, you should have two logical readers in the OnGuard System. These should be distinguished with the words “Entry/Exit” or “IN/OUT” at the end of them. This will allow you to have one logical door for Entry/Exit per handheld.

3.2.XPressEntry Panel #

You should add the readers to an OnGuard Access Panel. If you are not using the Device Translator Panel, it doesn’t matter what this Panel is named or what type of panel it is. This is just a placeholder so XPressEntry can send events into OnGuard. It is suggested to use an easily distinguished name. Note that this can also be an actual panel.

 

3.3.XPressEntry Device Translator Panel #

The XPressEntry Translator Panel is used to interface the XPressEntry system as a panel and the handhelds as live readers on the OnGuard System. With the Device Translator installed OnGuard can monitor the Online/Offline status of XPressEntry handhelds and server much like any OnGuard panel.

3.3.1.Setup #

Download the XPressEntry Device Translator zip and extract the folder. Run the appropriate .msi installer for your version of OnGuard
 
Under “Other” in Access Panels you should now have an XPressEntry Panel Type.

3.3.2.Panel Setup #

In OnGuard, go to System Panels (Access Control>Access Panels>Select Any LNL Type) and add a new Panel to OnGuard in the “Other” panel type tab.

 
panel setup lenel onguard
 

Select Access panel type “XPressEntry” and set it to online. In the Connection tab, set the IP Address of the XPressEntry Service under the connection tab. If XPressEntry is running locally, use 127.0.0.1.

 
panel setup system account lenel onguard

3.4.Entry/Exit Readers #

Entry Reader:

entry reader lenel onguard
 

Exit Reader:


 

Note that these should be set up as Physical readers in the system, even though the panel may never be online. If you are not using the XPressEntry Translator Panel, It doesn’t matter what type of panel (LNL-1000/2000/etc) or reader you choose. These are just placeholders for events that come in from XPressEntry. In order for the events to show up in the Event Monitoring application the Panel should be in Online mode.

3.5.OnGuard DataConduIT Setup #

3.5.1.Single Sign-On Directory #

OnGuard needs DataConduIT set up correctly. In General this will involve setting up a Directory (Administration → Directories) to enable Single Sign-On(SSO). SSO is required for DataConduIT to function properly.

 

3.5.2.Single Sign-On User #

You will also need to set up a User account which DataConduIT can access. (Administration -> Users). This should be linked to a computer account for SSO through the Directory Accounts tab.

 

3.5.3.Software Events / Linkage Server #

You should enable Software Events in the system options page. This will allow XPressEntry to get user updates from OnGuard via Software Events instead of only during a synchronization. This is done from the Administration → System Options page.
 
The Linkage server also needs to be set for DataConduIT software events to function properly.

3.5.4.Services #

The following services should be enabled on the OnGuard machine:

  • LS Communication Server
  • LS DataconduIT Service
  • LS License Server
  • LS Linkage Server

3.5.5.Other OnGuard Applications #

License Administration- Shows the max number of Data Conduit Clients
System Administration- Main OnGuard application, used to configure Access control information
Alarm Monitoring- Used to view Activities coming from XPressEntry

4.Enable Synchronization #

XPressEntry uses a module called “Data Manager” to synchronize Cardholders/Cards with OnGuard.
 
From the main page of XPressEntry, go to XPressEntry / Settings (CTRL+S).

 
enable synchronization lenel onguard

4.1.Data Manager Tab #

From the Settings Page Select the Data Manager Tab

 
data manager lenel onguard
 

From the ‘Type’ Combo Box, select “ONGUARD”.
 
On the “General” tab, Select the Log Level desired. When setting up the system, SQL is the suggested Log Level. Once the system is up and functional as desired, CRITICAL should be the default Log Level.
Also on the General tab there is the option to “Trigger Data Manager Activities”. This will start an OnGuard Activity sync whenever an activity comes into XPressEntry from a handheld. It’s suggested you leave this checked.
 
Set the Update Frequency to as often as you want the system to update. If you set the “Trigger Data Manager Activities” checkbox the suggested value is once per minute. If you didn’t set the value then more frequent activity syncs might be better.
 
The “Activity Synchronizing” section contains two options.
Sync Data Manager Activities with XPressEntry – If you plan on tracking user occupancies for Mustering on the handhelds, you should check this option.
 
Sync XPressEntry Activities to Data Manager – If you want the activities from the XPressEntry Handhelds to show up in OnGuard, you should check this option.
 
All of these options can be changed at any time. CHANGES ONLY TAKE EFFECT ONCE YOU PRESS “SAVE AND APPLY SETTINGS”

4.2.OnGuard Setup Page #

Press the “Setup Data Manager” button to get the OnGuard specific setup screen.

 

 

If the Server running OnGuard is not the machine you have installed XPressEntry on, you need to specify the computer name for that PC under Remote Computer Name. The permissions for the user running XPressEntry are assumed to be sufficient to access DataConduIT via WMI. The configuration of the PC with these permissions is assumed to be outside the scope of this document. XPressEntry uses the System.Management.Impersonation level to access DataConduIT via WMI.
 
DataConduIT is used for all data transfers between XPressEntry and OnGuard. As a result, you must setup OnGuard to use DataConduIT appropriately. This is assumed to be outside the scope of this document.
 
Companies is a required field in XPressEntry. It is chosen from the OnGuard User-Defined Value Lists. The default is Lnl_Department. It’s possible to set this up with another field. The reference in the CardHolder field is the “Companies Custom Ref”. By default, this is DEPT.
 
You must specify the Default Role (typically Entrant) you want users imported from Lenel to have. Press OK and check the logs to see if Synchronization is working.

4.3.Cannot Connect or Pull Data from OnGuard #

These are the common error messages you may see during an OnGuard sync

 

Full Sync Runs Successfully but does not pull any data
On the OnGuard machine, run “WBEMTest”. Select Connect, add Namespace, and then query the database. This tests WMI and will determine if there is an issue within it.
 
WMI Generic Failure
Update the database as shown in the Data Conduit user guide (program files(x86)\OnGuard\doc\en-US\DataConduit.pdf). On page xxx, if you search “NT4 Domain”, it will show you the steps to take to update the database and add the correct machine name.
 
Check OnGuard Logs
If the error received is nondescript, check the OnGuard Logs located in the program data folder of OnGuard (ProgramData\Lnl\DataConduitLog.txt).
 
No Error is written in the logs
It is possible that no connection is being received by Data Conduit from XPressEntry Server. If there is no information in the logs, try restarting the XPressEntry Service. Make sure there is no firewall interfering if this is a remote installation.

5.Setup XPressEntry Data #

Once the OnGuard System is set up and synchronizing, you will see all of this data represented in XPressEntry under the Add/Edit Info tab. Data which is imported from OnGuard cannot be changed and is Grayed out.

5.1.Priority of Data Synchronization #

Any changes made in OnGuard should be shown in XPressEntry in the following order: Highest Priority: Badge/User/Zone Occupancy changes are updated immediately.
 
Lower Priority: Door/Reader/Area/XPressEntry Activities/User Permissions will be updated whenever the Data Manager Synchronizer runs. This can be run manually from the Settings page → Data Manager tab by pressing “Partial Sync Now”.

5.2.Users #

Here is a sample of a properly synchronized user:
 
lenel onguard users
 
Those users have the same AccessLevel Permissions from OnGuard:
 
lenel onguard permissions

5.3.Doors #

Entry/Exit permissions in XPressEntry are set by doors. Doors are portals between two zones and can be “Entered” or “Exited”. The permissions for a door are determined by the External Entry Reader and External Exit reader. Users will have permission to Enter or Exit a door based on their OnGuard permissions for the selected readers. These are also the readers in OnGuard an Entry or Exit will be assigned to.
 
Doors should be set by the user for each Handheld Reader in XPressEntry.

 
doors lenel onguard

5.4.Readers #

XPressEntry divides readers up into two categories: “Handhelds” and “Readers”
 
Handhelds refer to physical readers in the system. All handhelds have a GUID which identifies the hardware. There are currently three types:
 
The Server Reader – used to assign badge activities from the server. This will likely be named “Server Reader: COMPUTER NAME” and have a 20-22 character GUID
 
Physical Handheld devices. These are typically either an Android or Windows CE Embedded device. These have a long GUID.
 
Occasionally we use a Windows Emulator client for debugging purposes. These can be identified with the same GUID as the server reader but with “-EMU” at the end.
 
It can be useful to have a reader in OnGuard for the physical handheld device. In particular, if you are using XPressEntry in Muster or Verification mode you should “Merge” the OnGuard and handheld records so events are sent from the specific reader as the appropriate OnGuard reader.
 
This Merging can only be done after a reader has been identified /registered with the XPressEntry system. (The physical device must be in the handhelds section)
 
To merge the records, simply select the OnGuard reader from the “Readers” list and use the “Merge with Handheld” drop down combo to select the handheld.

 readers lenel onguard
 

After you press the “Perform Merge” and confirm with “Yes”, the reader will be removed from the bottom “Readers” list and added to the “Handhelds” list.

5.5.Zones #

If you are going to be using OnGuard zones for mustering, it’s suggested you double check the Zone settings.
 
Any outside zone should have the “Zone is Outside” checked.
In addition, it’s normal to check the “Zone is a Muster Point” checkbox for outside zones.
 
Any area where you want to track occupancies for mustering should have the “Zone is a Hazard Area” box checked.

 
zones lenel onguard

5.6.Activities #

XPressEntry will synchronize activities if that option has been set by Data Manager.
 
Entry/Exit activities will be sent to the OnGuard reader set for External Entry/Exit Reader on the Door.
 
Verification and Muster activities will be sent to the specific reader they are scanned at.

Suggest Edit