Professional Documents
Culture Documents
Lenel - AL - Integration - GuideRevF V3
Lenel - AL - Integration - GuideRevF V3
REVISION: G
NOTE
This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of
the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the
equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency
energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to ra-
dio communications. Operation of this equipment in a residential area is likely to cause harmful interference in which
the user will be required to correct the interference at his own expense.
Shielded cables must be used with this unit to ensure compliance with the Class A FCC limits.
"This digital apparatus does not exceed the Class A limits for radio noise emissions from digital apparatus set out in the
Radio Interference Regulations of the Canadian Department of Communications.”
Le present appareil numerique n’ émet pas de bruits radioélectriques dépassant les limites applicables aux appareils
numeriques de la class A prescrites dans le Réglement sur le brouillage radioélectriques edicté par le ministere des
Communications du Canada.
DISCLAIMER
Alarm Lock makes no representations or warranties with respect to the contents hereof and specifically disclaims any
implied warranties of merchantability or fitness for any particular purpose. Further, Alarm Lock reserves the right to
revise this publication and to make changes from time to time in the content hereof without obligation of Alarm Lock to
notify any person of such revision or changes. If possible, always refer to the Alarm Lock website (www.alarmlock.com;
click Support) for the latest documentation, as the released CD may not contain the latest documentation.
Copyright © 2014 by Alarm Lock. All rights reserved. No part of this publication may be reproduced, transmitted,
transcribed, or stored in a retrieval system, without the prior written permission of Alarm Lock, 355 Bayview Avenue,
Amityville, NY 11701. Telephone: 631-842-9400 • FAX: 631-842-9135 • GSA# GS-07F-0039H.
ProxCard® and ProxKey® are trademarks of the HID© Corporation. Microsoft® and Windows® are trademarks of their
the Microsoft Corporation. Trilogy® is a registered trademark of Alarm Lock. All other trademarks, service marks, and
product or service names described in this manual are for identification purposes only and may be trademarks or regis-
tered trademarks of their respective owners.
The absence of a name or logo in this document does not constitute a waiver of any and all intellectual property rights
that NAPCO Security Technologies, Inc. or Alarm Lock has established in any of its product, feature, or service names
or logos.
This document contains proprietary information of NAPCO Security Technologies. Unauthorized reproduction of any
portion of this manual without the written authorization of NAPCO Security Technologies is prohibited. The information
in this manual is for informational purposes only. It is subject to change without notice. Companies, names and data
used in examples herein are fictitious unless otherwise noted. NAPCO Security Technologies assumes no responsibil-
ity for incorrect information this manual may contain.
Overview ................................................................................................................................................................................................... 5
Capacity.................................................................................................................................................................................................... 5
Terminology ........................................................................................................................................................................................... 10
OVERVIEW CAPACITY
Used with the Trilogy Networx™ series locks and key- In addition, each installed system can contain 255 Gate-
pads, the OnGuard software allows user to upload ways and each Gateway can control up to 64 locks. Fur-
and download programming features wirelessly using a thermore, each Alarm Lock Networx lock can contain
computer network. Use your computer to retrieve 3000-4000 badges (depending on configuration).
events, download cardholders/ time schedules / badge
format definitions and program features into each wire-
less lock in the system. NETWORK SECURITY
OnGuard software is installed on a computer that is con- The system uses AES (Advanced Encryption Standard)
nected to a network (either a small Ethernet network or to protect the integrity of the data flow between the wire-
large corporate LAN). Connected to this network is an less router/network and the Gateways.
intermediate device called a Gateway that communicates
via a private wireless signal to a radio located inside
each door lock. In this way, the software allows full pro- HOW TO USE THIS MANUAL
gramming and control of each lock in the system. Note:
In this manual, the word "lock" refers to all Networx ™ se-
ries door locks. OnGuard software is the basis for wireless
lock programming. For those unfamiliar with using On-
To ensure each physical lock is identified correctly by the Guard software, stop here and review the On-
OnGuard software, the factory assigns each lock a Guard User Manual. It may be helpful to create a "test
unique Serial Number; after locks are installed on the Account" in OnGuard while walking through the exam-
doors and the Gateways are mounted, the Gateways ples presented in this User Guide.
search for new locks, allowing them to be enrolled into
the system.
If you are already familiar with OnGuard, the transition to
Note: Although you can set up the wireless network first working with wireless locks will be straightforward with
and add locks to the doors later, for the sake of conven- slight additions in terminology. This manual can be read
ience it is recommended that you have at least one Net- from beginning to end, or can be used with the table of
worx™ lock installed on a door before setting up your contents as a reference manual.
wireless system. Note that stand-alone individual lock
programming at the lock keypad is not supported; in oth- ● To install locks on the doors first, use the Installa-
er words, the door lock may only be placed into operation tion Instructions for the lock model you wish to install.
by the use of the OnGuard software.
● To set up the wireless Alarm Lock Networx sys-
tem and connect the network to the OnGuard,
go to the "Network Considerations" section on
page 7.
Model AL-IME2
Network Interface
Interface: Ethernet 10Base-T or 100Base-TX (using
RJ-45 jack)
Protocols: TCP/IP, UDP/IP, DHCP
Encryption
128-bit AES Rijndael encryption
As shown in the image above, if the computer running OnGuard 1) Estimate the number of Gateways needed in the instal-
is connected to the first subnet (173.16.100.xxx), and several lation.
Gateways are connected to the second subnet
(173.16.200.xxx), OnGuard will ONLY be able to communicate 2) Install OnGuard on a PC connected to the first sub-
net (for example, plug the PC into a wall network out-
Gen1 GW - Generation 1 gateways. Real - Same as "Physical". Tangible, not virtual. See Vir-
tual.
(Model#: AL-IME-POEP, AL-IME)
Subnet (SUBNET) - To improve security and processing
Gen2 GW - Generation 2 gateways. performance, network administrators often divide their
corporate Intranets into interconnected but separate seg-
(Model#: AL-IME2-POE, AL-IME2)
ments called "subnets". Subnets also allow multiple us-
Expander/Repeater - Wireless expander designed to ex- ers to access the Intranet with the same subnet address.
pand the coverage area of version 2 gateways. A router is typically used to allow network traffic to pass
between subnets.
(Model#: AL-IME2-EXP)
Subnet Mask - The IP protocol makes use of a Subnet
Assign - Add to hardware or specify a relationship. Can be
Mask to more efficiently route packets to their correct
used with badges and locks ("to assign badges to specif-
network destinations. When a Gateway receives a data
ic locks"), or with hardware identification ("the factory
packet, the Subnet Mask indicates how many bits of the
assigns each lock a unique Serial Number"), or a fixed
packet's destination address are to be used for routing
wireless communication channel between locks and a
and which bits are to be "masked" (ignored). The Subnet
Gateway ("locks assigned to a Gateway").
Mask can be thought of as a "filter" that allows the sys-
Communicate - To send or receive a transmission. To tem to ignore unnecessary information, thus increasing
avoid the directionally confusing terms of "download" and efficiency. This information must be obtained from your
"upload", the word "communicate" is used in this guide. network administrator.
Configure- To "assign" (add) discovered physical locks to a Upload - See Communicate.
Gateway (by sending the "Lock Config Table" to the se-
Virtual - Simulated on a computer.
lected Gateway). Configuring ensures a fixed wireless
communication channel exists between selected physical
locks and a selected Gateway.
In short, the Gateway tries to "configure" the selected
physical locks by assigning the selected physical locks to
the Gateway.
DHCP (Dynamic Host Configuration Protocol) - Software
that automatically assigns IP addresses to devices that
are connected to a network. It eliminates having to man-
ually assign fixed IP addresses.
Discover - To "discover" Gateways, the system searches
for Gateways not yet assigned to an Account; to
"discover" locks, the selected Gateway searches for
locks not yet assigned to Gateways.
Download - See Communicate.
IP Address - The IP (Internet Protocol) address is a unique
address of a device (such as a computer or a Gateway)
connected to a TCP/IP corporate Intranet. IP addresses
are written as four groups of numbers separated by peri-
ods; these groups are called "octets". IP addresses can
be permanent ("static") or dynamically assigned (by
DHCP) when a device, such as a Gateway, is powered.
Locate - With physical lock(s), the Locate command caus-
es the physical lock to "beep" and flash its LED (helpful
when you wish to find the physical lock or confirm the
lock's wireless connection is operational). When used
with a Gateway, refers to re-discovering a "lost" Gate-
way device on the network. Used when an operational
Gateway has lost its network connection, and appears
Device Tree: Shows list of gateways and its children (Repeaters and locks).
Operation Pane: Allows user to perform activities on gateways and locks.
Log Pane: Commands being sent to gateway can be seen in this pane.
If OnGuard Communication service and Napco manager are running at the same time and trying to communicate with the
same gateway then operation at one end will fail. Same precautionary information will be displayed in the message box.
* So, it is always a good practice to stop OnGuard Communication service while launching Napco Manager application.
Operations menu is located at the top left corner of Napco Manager. It allows the user to perform following actions:
Existing customers of “Napco Add-on” must backup old NapcoConfig.xml file (usually located in “C:\Program Files (x86)
\OnGuard” folder) so that it can be imported into new file “NapcoConfiguration.xml” in OnGuard installation folder.
Once Import Configuration button is pressed it takes some time, based on existing gateway count. User will see a mes-
sage in the status bar once the import operation is complete.
When user selects “Discover Gateways” menu option, following screen is displayed:
Note: Adding gateways using this screen does not mean that it will be available in OnGuard system. User must add the
discovered gateways using System Administration.
Discover Gateways
1. Add Gateway/s By Discovery: Following screenshot shows the gateway discovered using this option.
Once the gateways are discovered, user can select multiple gateways and add them to the system using
“Add Gateway(s)” button at the bottom of the screen. Only gateways that are in ready status should be selected. If the
gateway shows status of security code mismatch, then it means that the gateway is already assigned some where in the
system. User can sort the columns of the grid as per their convenience. Once the gateway is added, it will be shown in the
device tree.
Note: If the customer has lot of gateways (more than 30) in the system then it takes time to get the status from each gate-
way.
Discover Gateways
2. Add Gateway By MAC Address: This is the fastest option to use when the user knows the MAC Address of the gate-
way and wants to add only one gateway (same subnet). Following screenshot shows the gateway discovery using this
option.
3. Add Gateway By IP Address: This option is best suited in scenarios where gateways are located in different subnet.
Following screenshot shows the gateway discovery using this option.
Note: While using this option, make sure that IP address of the router (where OnGuard Communication service resides)
must be sent to the gateway.
1. Discover Repeaters: Range of gateway can be extended using repeaters. User can add up to 7 repeaters on a single
gateway. Gateway will find repeaters automatically based on the distance. For best performance, while discovering re-
peaters, make sure that they are placed at locations where user wants to install them. This way, gateway will get the best
combination in which repeaters are added to the gateway. Once the repeaters are discovered they will be added to the
device tree as shown below:
3. Discover Locks: With this option, user has the ability to discover and add multiple locks to the selected gateway. Fol-
lowing image shows the lock discovery screen.
User can select maximum number of locks to be found and click on “Discover Locks” button. Once the locks are discov-
ered, user can select multiple locks and click on “Add Selected Lock(s)” button.
Note: Adding locks using this screen does not mean that it will be available in OnGuard system. User must add the dis-
covered locks using System Administration.
3. Remove Gateway: Once selected, commands will be sent to delete the gateway and its children (repeaters/Locks)
from the system. Note: Removing gateway using Napco Manager will only reset gateway, repeaters and locks. It will not
remove the information from OnGuard GUI. So, you may see that gateway is marked with red cross on Alarm monitoring
application. Best sequence while removing a gateway or lock is to first delete the gateway and lock from OnGuard GUI and
then remove them using NAPCO manager.
4. Download Firmware to gateway: If for some reason, firmware was not sent to the gateway during discovery or if new
firmware is released by NAPCO, then user can explicitly download firmware to gateways using this option.
5. Download Firmware to Repeaters: If for some reason, firmware was not sent to the repeaters during discovery or if
new firmware is released by NAPCO, then user can explicitly download firmware to repeaters using this option.
6. Send current configuration to GW and Locks: This option should be used rarely and by advanced users only. If for
some reason, lock is not responding or user hard resets the lock/s without using Napco Manager, then this option can be
used to assign locks back to the gateway.
User can enter the IP address of the server manually as well in the text box.
When to use this screen:
A) First time the gateway is discovered.
B) Events from the locks on particular gateway are not getting reported in Alarm Monitoring application.
Note: While adding gateway from different subnet, provide IP address of the router on which OnGuard Communication
service is running.
8. Refresh: This option is used to send full status refresh command to the gateway. This will refresh the status of gateway
and its associated repeaters and locks.
9. Copy Gateway Name: This command makes it easier for users to add the gateway name in correct format to System
administration. The text copied using this command can directly be placed in the “Name” field of Panel screen. Name is
provided in following format:
10. Run Test Mode: While installing gateway, user can test the signal strength of gateway using this option. User will
need to purchase a product “Networx Signal Meter” to use this feature. More information can be found at following loca-
tion:
http://alarmlock.typepad.com/my_weblog/2014/11/new-networx-signal-meter-and-signal-generator.html
User can select the option that he/she prefers. Once “Replace Gateway” button is clicked, all the children of the gateway
to be replaced will be added to the new gateway. After replacing gateway, make sure that you change the name of gate-
way in System administration.
1. Remove Repeater: Repeater and locks associated with the repeater will be reset and removed from the configuration.
Although, repeaters are not visible in the OnGuard system Administration, locks associated with repeater are visible. So,
always remove locks associated with the repeater from the System Administration first then remove the repeater using
Napco Manager.
2. Run Test Mode: While installing repeater, user can test the signal strength of repeater using this option. User will need
to purchase a product “Networx Signal Meter” to use this feature. More information can be found at following location:
http://alarmlock.typepad.com/my_weblog/2014/11/new-networx-signal-meter-and-signal-generator.html
3. Replace Repeater: When this option is selected, user can replace existing repeater with new repeater. All the locks
associated with original repeater will be assigned to the new repeater. Following image show “Replace Repeater” screen.
Expanders can only be deleted in descending order.
1) Locate Lock: On selecting this option, the lock will start beeping until user presses “A” key on the lock. This feature is
useful for locating the lock in the building. It can also be used to test whether the lock was added to the gateway or not.
2) Remove Lock: On selecting this option, application will try to reset the lock first. Whether the lock gets reset or not, it
will be removed from the gateway. Gateway will no longer consider this lock as its predecessor.
3) Replace Lock: On selecting this option, user will be presented with “Discover Lock” screen. User can discover the lock
in the system and click on “Replace Lock” button.
4) Update Firmware: If firmware does not get downloaded to the lock at the time of discovery or if new firmware is availa-
ble then user can manually replace lock firmware using this option.
5) Remote Bypass: User can enroll bypass devices (key FOB) with the lock using this option. Key Fob is used to unlock
the door without using badge or keypad.
6) Re-assign Lock: If the user reset the lock then he can re-assign the lock back to the gateway using this option.
7) Copy Lock Name: This command makes it easier for users to add the lock name in correct format to System admin-
istration. The text copied using this command can directly be placed in the “Name” field of “Readers and Doors” screen.
Name is provided in following format:
8. Click OK.
9. Select
Default
Zone. A
red
Add/Configure Gateway
2. Click Access Control>Access Panel. Click the Oth-
er tab.
3.Click Add.
As a first step, user must discover and add lock using Example : Rear Door [DE450023]
Napco Manager. Note: User can copy the name using Napco Manager to
avoid typing mistakes.
1. Launch the OnGuard System Administration
program. Click Start>All Programs>OnGuard 2012>
System Administration application. The Log On to 4. Select a Panel available from the list (it is a gateway).
System Administration screen will display. Enter the
User name and Password. 5. Select Port and Address. Values don’t matter, but
must be different for all locks on the same gateway.
18.To enable APB checks in the Settings area, check 27. Enter any text into Input 1 Name field to configure
Paired Master for an Entrance Door (IN reader). lock input as a Door Contact (make sure field Input 2
Name is empty). Example Door Contact.
WARNING: All APB Enabled readers MUST have same
Card Formats. 28. Enter any text into Input 2 Name field to configure
lock input as a Request To Exit (make sure field Input 1
19. To enable APB checks in the Settings area, check Name is empty). Example REX
Paired Slave for an Exit Door (OUT Reader).
Note 1: Only Input 1 Name or Input 2 Name can be as-
20. Check Two Card Control to enable this feature for a signed in steps 27 and 28 (not both).
lock.
Note 2: NetPanel has 2 Inputs—Door Contact and By-
21. In the Settings area, check Assume Door Used to pass. For NetPanel, Door Contact is configured automati-
generate Access Granted event when a valid card was cally , so no changes required for Input 1. In order to con-
provided without checking was the door was really figure Bypass, users need to configure Input 2 on Auxiliary
opened or not. Inputs screen.
Note: For this setting to take effect, lock input must be
configured as a door contact. Note 3: ArchiTech locks does not have programmable
Inputs, Outputs or Relays.
22. In the Denied Attempts... area, set Count field to
specify the number of incorrect PIN retries that causes 29.Disregard all other fields on the AUX INPUTS tab.
[Lock ID]
Example: [DE450023]
3. Enter Start time, End Time (24 hour clock), mark 13. Select Timezone/Reader Mode tab.
with a checkbox days of week and holidays.
5. Click OK.
7. Press Add.
2) For Alarm Lock Networx locks only, following 19. Ignore End Reader Mode.
modes are supported: “Card Only”, “Pin and Card”,
“Facility Code Only”, “Unlocked”. 20. Ignore Verify Mode setting.
3) The Rule to setup Timezone based modes is: 21. Click “Assign->“ button to write Mode/Timezone set-
ting to selected lock.
Base Mode (it means mode set on “Readers and
Doors” screen in System Administrator) can be Pin 22. If you need to erase any Mode/Timezone setting
& Card or Card only. If any timezone based mode is from the lock, select lock in “Reader Assignments” col-
umn (red checkmark will appear) and press “<-
Pin & Card, base mode must be Pin & Card. Mode
Remove” button.
Timezones can overlap, the following priority ap-
plies: Unlocked, Pin & Card, Facility Code Only, 23. Another way to configure lock modes for specific
Card only. time is by using Scheduler (menu “Admistration-
>Scheduler”).
Example : to setup Pin & Card mode based on 24. Click OK.
Timezone1 all other time mode Card Only, you need
to set Base mode as Pin & Card, create timezone
Always1 (00:00 – 23:59) and set Card Only mode
for this timezone, then set Pin & Card mode for
Timezone1.
2. Click Add.
12. Enter Pin field (for card and pin access mode).
3. Click Modify.
13. Check Use Extended Strike/Held time check
4. Select Manual Entry from the Generate Badge ID box if cardholder is disabled or handicapped per
field. son and requires a longer time pass through the door.
8. Enter available Cardholder information on Cardholder 16. Set a checkmark on the calendar control on Deactiva-
tab. tion Date.
Note: you can double click on the access level text out-
side the door icon to see additional information about this
access level in a small pop-up window.
ria.
Door Close
Request to Exit
Forced Door
Duress
Communications Lost
Communications Restored
Configuration settings of Alarm Lock gateways are stored in XML file NapcoConfiguration.xml located in default OnGuard
folder. It is recommended to backup NapcoConfiguration.xml after all Alarm Lock gateways were successfully configured and
store a copy in the safe place. This copy of configuration info would be very helpful in cases of software or hardware failures.
The following setting parameters for Device Translator plugin are loaded on every restart of Communication Server (can be
manually added to NapcoConfiguration.xml):
I had a lock that was working perfectly but now I just replaced the lock batteries but I acci-
the "Lock Status" i s y e l l o w i n A l a r m M o n i - dentally lost the lock programming! What do I
t o r i n g . What do I do? do?
In this case, the Gateway is unable to communicate It is actually very difficult to lose the lock program-
with the lock. First verify a few basic details: ming when replacing batteries. To erase the pro-
1. Has something changed to affect communica- gramming, you need to disconnect the batteries, then
tions? Is the lock still on the door? Did some- reconnect the batteries and press and hold the "AL"
one remove the door for some kind of mainte- keypad button for several seconds (something that
nance? Has furniture been moved around and would not normally happen when replacing the batter-
now there is something that is blocking the radio ies).
signal to the Gateway?
2. Ensure the physical lock is powered (as per
the instructions provided with the lock packag- RESET GATEWAY ISSUES
ing) Check that "Lock ID" specified in OnGuard
reader configuration is typed correctly.
How do I reset the Gateway and what effect will
3. Is the lock still functioning? Find the physical lock
it have on my system?
and attempt to unlock by entering a working
badge. Are the lock key-presses causing beep- Follow the "Resetting the Gateway" instructions
ing sounds? Check the battery voltage and bat- for a "Partial Reset" or "Full Reset".
tery connections. After the Gateway is reset you need to put it Of-
4. Determine if the distance between the lock fline and then back Online using System Admin-
and the Gateway is greater than 75 to 100 feet. istrator. All locks will be removed from that gate-
A new Gate- way module may need to be in- way and it will take a while to add it back.
stalled, discovered and added.
5. Take the lock off the door, bring the lock
physically closer to a Gateway and check if it re- GATEWAY "OFFLINE"
ports events.
6. If the signal strength to that lock has always
How do I reestablish communication with a
been strong and suddenly it is non-existent,
"lost" Gateway?
the lock may have an internal failure and has
lost its configuration data. In this case, On- If the Gateway is "Offline" (has red cross on icon
Guard still has the correct lock configuration in Alarm Monitoring) you might need to check
data, therefore simply try re-add this lock the network connection to it. Try to set it Offline and
lock according to "Replacing Lock" instructions. back Online in the System Administrator.
COMPUTER CRASH!
My computer running OnGuard just crashed! I
had a working system, complete with wireless
locks, Gateways and a computer running On-
Guard but that computer no longer works! What
do I do?
Changes and Modifications not expressly approved by Napco can void your authority
to operate this equipment under Federal Communications Commissions rules.