Allegion NDE and LE Lock Integration - Full Reference Guide

Allegion NDE and LE Lock Integration - Full Reference Guide

1.0 Introduction

Keri can integrate with the Allegion LE and NDE wireless locks using Schlage Control™ technology. Installation and lock configuration is extremely simple and easy using the Allegion ENGAGE app and the setup in the Doors.NET software is extremely intuitive.

 

When integrating the Allegion NDE and LE Series locks with the Doors.NET software you can take advantage of immediate updates (cardholders and hardware changes are sent out to the locks immediately) so there is no need to go out to any of the locks to update them individually or schedule an update for later in the day.

 

Doors.NET will generate system transactions as and when they occur. These events can be used for running reports, creating system alerts or to trigger an action on other parts of the access control system (via the Global Linkage module). You can also use the Doors.NET software to lock or unlock the doors or to configure the doors to use a different operating mode.


Every facility can benefit from adding wireless locks to a few doors for added convenience, or for improved visibility and control. Schlage wireless locks can be used in a variety of applications, including; interior, perimeter and high security.

 

This document outlines the steps that need to be taken to setup and configure the ENGAGE Gateway and how to add NDE and LE locks in the Doors.NET software. Finally, the document explains how to link the locks with the Allegion gateway.

 

Notes:

  • Doors.NET v5.2.0 includes NDE and LE wireless support with Mercury EP and LP series controllers. The Allegion wireless lock devices will be displayed when the TB2 or TB3 port has been configured for Schlage RSI protocol.
  • Effective from Doors.NET v5.2.0, when using NXT-MSC controllers you will need to delete the Keri NXT reader which is added to the bus by default and then configure the protocol to support the Schlage RSI protocol before adding the gateway node (this is covered in more detail in section 7.0).
  • The Allegion Control locks are NOT supported with the Doors.NET integration and neither is the MT-20W USB enrollment reader.
  • Effective from Doors.NET v5.2.0 you can mix and match ENGAGE Gateways, PIM-400s and AD-300s on the same bus. You can add up to 8 x ENGAGE Gateways, 8 x PIM-400s or 32 AD-300s (to each controller bus). Adding one of these supported devices will reduce the number of other devices that can be added. For example, if 4 x ENGAGE gateways are added you will then be limited to adding 4 x PIM-400s or 28 AD-300s.

 

2.0 System Capacities

  • The maximum number of locks per gateway is 10.
  • The maximum number of gateways per controller is 8.
  • The maximum number of LE/NDE locks per controller is 64.


3.0 Setup Summary

The following is a summary of the steps for connecting to the LE/NDE locks
using Doors.NET:

  1. Download the ENGAGE App
  2. Register for a new Allegion account (third-party account)
  3. Wire the ENGAGE Gateway to the NXT Mercury-Powered controller
  4. Add the gateway to the ENGAGE app
  5. Add the Locks to the ENGAGE app
  6. Verify correct license settings
  7. Add the ENGAGE Gateway to Doors.NET
  8. Add the LE/NDE locks to Doors.NET
  9. Link the LE/NDE locks to the gateway using Doors.NET


4.0 Download and Install the Allegion Engage App

The Allegion Engage™ app is required to initially add the Allegion hardware to a unique user account. It is available as a mobile app and it is free to setup an account and use it.

 

Note: Steps may vary depending on the device and OS version you are running.

  1. Go to the iOS App Store (or PlayStore if you are using an Android device).
  2. Search for: 'Allegion ENGAGE'.

    ENGAGE App Download Page

  3. Tap the green INSTALL button.
  4. The app will download and installed on your device.


5.0 Register an ENGAGE Account

You will need to register a new ENGAGE™ account before you can use the ENGAGE™ app.

 

IMPORTANT NOTE: It is very important to retain your username and password as it is required for adding and removing the LE/NDE hardware. Once the locks have been added to an account they cannot be used on another ENGAGE account.

Note: Due to regular, minor app updates the screen images may not appear exactly as displayed in these steps.

  1. Open the app via the new ENGAGE™ icon on your device home screen.

    App homescreen

  2. Tap 'Create New' located at the bottom of the screen.
  3. Accept the Allegion User Agreement.
  4. Select 'Third Party Software' as the account type.

    Third Party Account Type

  5. Press Next (in the upper right corner).
  6. Enter your first name, last name and e-mail address. Press Next again.
  7. Enter a password and then re-enter to confirm the password. You will see there are various password complexity requirements that must be met. Press Next.
  8. Enter your company name, site name, select a site type, then select the world time zone (based on the site's physical location and enable Daylight Savings changes. Press Register.
  9. The new account will be registered and a verification e-mail will be sent to the registered e-mail address. Press Continue.

    Verification Reqd

  10. Click on the verification link that will appear in your e-mail inbox within a few minutes.
  11. Your account is now setup and you are ready to start using the ENGAGE app.

Note: For further details and documentation on the Allegion ENGAGE app, use the following link:

 

ENGAGE Cloud-Based Web Applications Data Sheet

 

6.0 ENGAGE Password Reset

IMPORTANT NOTE: If you need to reset your ENGAGE password this can ONLY be done using the ENGAGE app.

  1. On your phone or smart device, open the ENGAGE app.
  2. Click on the Forgot Password link (located beneath the LOG IN button).
  3. Enter your registered ENGAGE e-mail address.
  4. You will see a message notifying you that a password reset e-mail has been sent.
  5. Go to the inbox of your registered ENGAGE e-mail.
  6. Click the link to reset your ENGAGE password.

 

7.0 Wire the ENGAGE Gateway to the Controller

7.1 Allegion Gateway to NXT-MSC Controller Wiring

The ENGAGE Gateway connects to the NXT-MSC controller via RS-485 to one of the controllers buses. For example; bus 1 (TB1 connector on the controller).

 

Allegion GWE Wiring

 

Note: You should not connect the 12VDC power (Pin 1) at the controller because the ENGAGE Gateway has its own separate 12VDC power supply.

 

7.2 Allegion Gateway to LP-4502 Controller Wiring

The Allegion Gateway is shown as connected to TB2 of the LP-4502. TB3 can also be used.

LP-4502 Wiring

 

8.0 Add the Allegion ENGAGE Gateway to the APP

As you have registered using a third-party account, you will be able to add an ENGAGE gateway.

 

Note: After powering-on the Allegion Gateway, during the boot process the device will be displaying an amber LED. Once the device is fully booted-up, the LED will be solid red (indicating that the device is then ready for setup and use).

  1. Open the ENGAGE app via the ENGAGE icon on your homescreen.
  2. Login using your registered user name and password.
  3. The name of your site will appear at the top of the screen.
  4. Press the '+' located in the top right corner.
  5. You will see a list of supported devices that can be added.
  6. Select Gateway (located at the bottom of the list).

    Select the Gateway

  7. The app will search for a gateway that is within Bluetooth range.
  8. The gateway should appear, so tap the screen to select the gateway.

    Select Gateway

  9. The app will connect to the gateway and you will be prompted to confirm that the gateway LED is flashing blue. Check the LED then confirm.
  10. A few seconds later, the gateway will be added to the app and you will see the device information screen.

Note: For further details about the ENGAGE Gateway (such as performing a factory default reset (FDR) on the device, updating the device firmware or further configuration), refer to the product's supporting documentation).

 

9.0 Configure the Allegion Gateway

When integrating Doors.NET with the Allegion locks, the ENGAGE Gateway must be configured for RSI and you also have to set the address on the gateway to match which MSC controller bus the gateway is wired into. You will not be able to add the locks until you have added and configured the Allegion Gateway (for RSI/RS-485 communication method).

 

Note: You will also not be able to connect to the locks using Doors.NET until the ENGAGE Gateway and the locks have been added to the ENGAGE app.

  1. On the device information screen, enter a new name for the gateway. Press Next.
  2. On the communication setup screen, leave the default communication option at RSI.
  3. Set the RS-485 Address - (to match the controller bus ). For example; enter '1' if the gateway is wired into bus 1. The 'Low Door Address' and 'High Door Address' values should be left at their defaults. Press Save.

    Gateway Comms Settings

  4. The gateway settings will be saved and you will see the gateway connection screen.
  5. Press Disconnect in the top left corner to disconnect from the gateway.
  6. The new ENGAGE gateway will be displayed on the app's device list.

Note: If you cannot connect to the Gateway you should consider performing a Factory Default Reset (FDR). Another reason, if the unit is not new, the Gateway may be registered to a different ENGAGE account - in which case it will need to be removed from that previous account to free it up to be re-commissioned.

 

10.0 Add Allegion NDE or LE Locks to the App

You must now add the Allegion NDE/LE locks to the ENGAGE app (which will lock them to your ENGAGE account). The wireless NDE or LE locks can be added to ENGAGE in any order as they will be linked to the gateway from the Doors.NET software (and not using the ENGAGE app).

 

Note: If you are unable to add any locks, you may need to perform a factory reset of the lock. Factory default reset (FDR) instructions can be found with the product's supporting documentation.

  1. On the device list screen, press the '+' in the upper-right corner.
  2. Select the lock type to add, from the list of available devices. For example; an LE lock.

    Add LE locks

  3. You will see a notification prompting you to turn and release the interior lever of the lock (the reader should beep once)
  4. Press OK to the on-screen notification.

    Note: If the reader does not beep when you turn and release the interior lever, this indicates that either the batteries are flat or the lock requires a factory reset. (You will also see a 'No devices detected' message).

  5. The lock should appear, so select the lock you see listed.

    Select a Lock

  6. Another notification will appear, prompting you to check the reader LED is flashing RED. You should check and confirm this within 30 seconds, otherwise communication to the lock will time-out. Press Yes to the prompt and the lock will then be added to the app.
  7. You will now see the lock's device information screen.
  8. Enter a name for the lock, then press Next.
  9. Disable the Wi-Fi option, then press Finish.
  10. The lock will now be added to the app and you will be connected to it.
  11. Press Disconnect.
  12. Repeat steps 1 - 10 for any additional Allegion NE/LDE locks you need to add.

 

11.0 Further Lock Configuration

For further configuration information about the Allegion locks, please refer to the lock supporting documentation.

 

12.0 Check Allegion is Enabled on your License

The Allegion Lock Integration is a licensed feature, so it must be enabled on your Doors.NET license.

The following steps explain how to check your license is configured correctly.

  1. From the Windows Start menu: Go to Doors.NET >> License Manager.

    DoorsNET License Manager

  2. When the License Manager is open, click on the License tab located on the right side of the window.

    License Tab

  3. Scroll through the list of supported capacities and locate the Readers - Allegion option.
  4. Ensure both 'Allegion' AND 'Allegion per Controller' have positive values set to them. If either of these are set to zero you will not be able to add the Allegion hardware to the Doors.NET software.
  5. Close down License Manager if your license is correct.

 

13.0 Add the ENGAGE Gateway to Doors.NET

13.1 Add the ENGAGE Gateway to an NXT-MSC Controller

Next is to add the gateway to Doors.NET. It assumes that Doors.NET has been successfully installed, licensed and the MSC gateway is added and online.

 

Note: When using NXT-MSC controllers, to add the Allegion Gateway you must first delete the default (NXT) reader from the bus and then configure the bus for the correct protocol.

  1. Log into Doors.NET (default user name and password are both admin).
  2. Go to Setup >> Hardware Setup >> All.

    Hardware Setup - All

  3. You will see the MSC gateway listed at the top of the hardware tree and NXT-MSC controllers will be listed beneath it.
  4. Double-click the controller, then locate the bus which the gateway is wired into (for example, bus 1).
  5. Select the default reader that is displayed for bus 1.
  6. Click the Hardware Browser tab near the top of the screen.
  7. Click the REMOVE button.

    Hardware Browser Button

  8. The reader on that bus will be removed from the hardware tree.
  9. Select the bus again.
  10. You will see the bus properties located on the right.
  11. Locate the Protocol (Serial) setting and set it to Schlage RSI.
  12. Save the bus settings.

    Set Schlage RSI

  13. With the bus still selected, click the Add ENGAGE Gateway icon.

    Add ENGAGE Gateway Icon

  14. Click ACCEPT on the dialog box that appears.
  15. The ENGAGE Gateway will be added to the bus on the hardware tree.
  16. Select the ENGAGE Gateway on the hardware tree and the gateway properties will be on the right.
  17. Enable Advanced View for the gateway properties.

    Advanced View Enabled

  18. Set the comm address to match the address that was configure on the Gateway using the ENGAGE app.

    Set Comm Address

  19. Save the Gateway settings and a few seconds later the gateway should come online.

    Engage GW Online

  20. Now that the gateway is added and online you are ready to add the locks to
    Doors.NET.

 

14.0 Add the ENGAGE Gateway to a Mercury LP-4502 Controller

The following steps explain how to add a gateway that has been connected to the TB2 port of the controller. It assumes you already have an LP-4502 controller added and online in Doors.NET.

 

Note: Allegion integration is supported with the Mercury EP and LP controller types. 

  1. From Doors.NET, go to Setup >> Hardware Setup >> All.
  2. The hardware tree will display.
  3. Select the LP4502 controller and the properties will be on the right.
  4. Ensure the controller is online.

    LP controller online

  5. Double-click to expand the controller in the hardware tree.
  6. Select the TB2 node and the TB2 properties will be on the right.
  7. Change the Protocol (Serial) value from Mercury Security to Schlage RSI protocol.
  8. Then save the TB2 settings.

    TB2 - RSI

  9. You will be prompted to reset the controller so click YES to go ahead with this.
  10. After approximately 30 seconds the controller will come back online.
  11. With the TB2 node still highlighted in the hardware tree, click on the ADD ENGAGE GATEWAY icon on the ribbon bar.

    ADD Engage GW

  12. Click ACCEPT on the dialog box that appears.
  13. The ENGAGE Gateway will be added to the TB2 node on the hardware tree.
  14. Expand the TB2 node to view and select the gateway node.

    Gateway Node

  15. The gateway properties will be on the right.
  16. Ensure Advanced View is enabled for the gateway properties.
  17. Set the comm address to match the address that was configure on the Gateway using the ENGAGE app.
  18. Save the gateway settings and a few seconds later the gateway should be online.

    Save GW Settings

  19. A few seconds later the gateway should be online.

    ENGAGE GW Online

 

15.0 Add the Allegion NDE and LE Locks to Doors.NET

  1. Select the ENGAGE Gateway on the hardware tree.
  2. Click on the lock type you wish to add from the hardware selection ribbon bar.

    Allegion Lock Icons

  3. Click the tree-expander icon to the left of the gateway , then expand Readers - you will see the new lock listed beneath the gateway.

    New Lock Added

  4. Repeat steps 1 - 3 for all additional locks you need to add.

    Additional Locks Added

  5. You should now rename the locks (based on their location) so that the system can be easily maintained and configured in the future.

 

16.0 Linking the NDE and LE Locks to the Gateway

The final step in Doors.NET is to link the locks to the ENGAGE Gateway. The gateway will then be permanently connected to the lock(s) via Bluetooth.

  1. Right-click the first Allegion lock, select Mode >> Link.
  2. The LED on the gateway will now be alternating between blue and red.
  3. Hold down the interior lever of the lock then present and hold a credential to the reader.
  4. Hold the credential at the reader for approx. 10 seconds.
  5. The reader LED will then alternate between green and red and will then continually flash green.
  6. Wait until you hear 4 beeps from the reader.
  7. You can now release the interior lever and take the card away from the reader.
  8. The lock will now be linked to the gateway.
  9. If you present an inactive card to the lock you should now be seeing an event in the Doors.NET Live Events grid.

    Live Events Message

  10. The lock is now ready for use.


17.0 Credential Types

The Allegion LE and NDE locks support several different card technologies:

  • Schlage (HID)
  • GE/CASI
  • GE4001
  • GE4002
  • AWID
  • 14443 UID (Mifare CSN)
  • 14443 Secure Mifare
  • 14443 Secure Mifare Plus
  • 14443 EV1 (NOC)
  • 15693 UID (CSN)
  • iClass 40 Bit UID (CSN)

 

Setting the required credential type requires configuration of lock using the ENGAGE app and then adding the credential type to the Doors.NET software.

 

Note: Certain combinations of supported credential types are not allowed. For example; Standard Mifare (CSN) cannot be combined with Secure Mifare.

 

17.1 Enable the Credential Type in ENGAGE

If the lock has been added to the app (but not linked to the gateway)

  1. Log into the ENGAGE app.
  2. Any added lock that is within range will be listed.
  3. Tap on Connect (located at the bottom of the screen).

    Connect link

  4. The app will retrieve the list of available devices.
  5. Press Connect (located to the right) of the lock you wish to configure.
  6. When the app is connected to the device you will see the device menu.
  7. Select Configure Device from the list.

    Configure Device Option

  8. Tap on Advanced (at the bottom of the configuration screen).
  9. Then tap on Credential Types Accepted. (You will have to confirm a warning).
  10. Tap to the right of the credential type(s) you wish the reader to accept. (A check mark will appear against the selected formats)
  11. When you have selected the required credential type(s), press Save in the upper-right.
  12. Save the previous screen.
  13. You can then disconnect from the lock.

 

If the lock has been linked to the gateway

The following steps explain how to enable Credential Types if the locks have been linked to the gateway (either in Doors.NET or using the ENGAGE app).

  1. Log into the ENGAGE app (ensure your smart device has Bluetooth switched on ).
  2. The app will open up on the site screen.
  3. Your gateway should be listed.
  4. To get the lock to display, you will have to physically go to the lock, and hold the interior lever down.
  5. With the lever held down, present any card to the reader.
  6. In the ENGAGE app, pull-down to refresh the site screen and the lock should appear beneath the gateway.

    Lock now Listed

  7. Tap connect and the lock menu will appear, tap Configure Device.
  8. Scroll to the bottom of the Configuration screen and tap Advanced.
  9. Select Credential Types Accepted.

    credential types accepted

  10. Tap to the right of the credential type(s) you wish to enable.
  11. The tap Save (top right).

    Available Credential Types

  12. Press Save on the previous screen.
  13. You can then disconnect from the lock.

17.2  Enable the Credential Type in Doors.NET

The following steps explain how the custom format is added to Doors.NET. This example details how to add the 32-bit (CSN) Mifare format

  1. Log into the Doors.NET software.
  2. Go to Setup >> Credential Types.
  3. The Access Control tab will open and you will see the available active card formats (by default, there are three formats listed)
  4. Right-click on the 'Standard 26-bit' format and remove it.
  5. Click the Add Active Format button. The format properties will be on the right.
  6. From the format drop-down list, select the format you wish to add.

    Select the new Format

  7. Click the save icon Save Icon.
  8. Right-click the controller on the hardware tree (Setup >> Hardware Setup >> All), select Reset >> Memory.

    MSC Controller Setup

 

18.0 Enrolling Cards into Doors.NET

The quickest and easiest method for adding cards is to use the presentation enrollment method. The presentation enrollment method is also required if you are not enrolling standard 26-bit Wiegand credentials - (only 26-bit Wiegand credentials can be manually enrolled). Press the F1 key while on the cardholders screen of Doors.NET and this will take you to the Cardholders section of Doors.NET where all enrollment methods are fully documented.

 

Presentation Enrollment

 

 

19.0 Operate the Hardware

19.1 Unlock and Lock the Door

You can immediately unlock, lock or temporarily unlock any of the doors either via a right-click on the hardware tree:

 

Right Click Unlock

 

Or you can select the reader on the hardware tree or from the door status grid and use one of the lock/unlock icons located on the ribbon bar.

 

ENGAGE Temp Unlock

 

19.2 Set a Lock Operating Mode

The Allegion LE/NDE Series of locks support several different operating modes that can be accessed via a right-click on the reader: Select Mode >> Extended and you will see a list of options.

 

Note: Different type of lock offer different combinations of operating modes.

 

Lock TypeSupported Reader Modes
NDE SeriesClassroom
LE LEDClassroom
LE IPBClassroom, Privacy, Office and Apartment
LE DeadboltClassroom, Privacy and Apartment

 

Classroom Mode

In Classroom mode: The outside lever is locked and unlocked by key. The inside lever is always unlocked for immediate egress.

Privacy Mode

In Privacy Mode, the lock is secured as part of the Privacy Mode process. When Privacy Mode is disabled, if the lock is still within an auto-unlock period, the lock will unlock (unsecured). If the lock is NOT within an auto-unlock period when Privacy Mode is disabled, then the lock will stay secured.

 

Note: A door position sensor (DPS) Must be installed for Privacy Mode to operate. The door must be in a closed state to enter Privacy Mode.

Apartment Mode

When the lock is set to Apartment Mode the door automatically unlocks when opened and does not re-lock. A valid credential must be presented to the exterior reader or an interior button must be pressed to re-lock the door.

Storeroom Mode

In storeroom mode the outside lever is fixed. Entrance is by key only. Inside lever is always unlocked for immediate egress.

 

20.0 Allegion NDE IPB Support on MSC LP Hardware

The NDEb lock has a Interior Push Button (IPB) that can be configured to perform additional functions when the ENGAGE gateway is communicating with any LP controller. These additional functions are not available for EP and NXT-MSC hardware.

 

The additional functions are as follows:

 

● Office - Lockset is normally secure. Interior push button on inside housing may be used to select a passage or secured status. Valid toggle credentials on the exterior may also be used to change status. Meets the need for a lockdown function for safety and

security. A mechanical key will retract the latch. Inside lever always allows free egress.

 

● Privacy - Lockset is normally secure. Interior push button on inside housing may be used to select a privacy status. The interior push button will disable normal electronic access from the exterior. Opening the door or pressing the interior push button a second time on the inside housing deactivates the privacy status. A mechanical key will always retract the latch. Inside lever always allows free egress. Door position sensor required for function.

 

● Apartment - Lockset is normally secure. Interior push button on inside housing may be used to select a passage or secured status. Opening the door or pressing the interior push button causes the lockset to toggle unsecured. While toggled unsecured, the

lockset can only be secured while the door is closed by pressing the interior pushbutton or using a normal credential on the exterior. Normal electronic access from the exterior is always allowed. A mechanical key will retract the latch. Inside lever always allows free egress.

 

The additional function can be configured by the Extended Feature property:

 

ndeb_extended

 

Attempting to set this feature on MSC EP or NXT-MSC hardware will display the following message:

 

MESSAGE

 

The NDEb can still be used with EP and NXT-MSC hardware and will function normally but the additional Extended Feature modes are not supported.



    • Related Articles

    • Allegion NDE and LE Lock Integration - Quick Start Guide

      1.0 Introduction This quick start guide walks you through the process of setting up the Doors.NET integration between the Allegion Gateway and the Allegion NDE and LE locks. It assumes you have an existing Allegion ENGAGE 'Third-Party' account type ...
    • Allegion No Tour - Full Reference

      1.0 Introduction Allegion No Tour is supported with the Allegion Schlage® Control Smart Locks, NDE or LE Series locks. The No Tour solution allows you to manage your site and its users from virtually anywhere with Keri's Confluence cloud-based app ...
    • Doors.NET and Allegion Lock Integration Overview

      Doors.NET and Allegion Lock Integration Allegion AD, NDE and LE Series locks seamlessly integrate with Keri Doors.Net to provide a cost effective and scalable access control solution to meet your security needs. The integration allows real-time ...
    • Allegion and Keri Integration Data Sheet

      Allegion and Keri Integration Data Sheet (attached).
    • Allegion Lock Operating Modes

      Doors.NET software integrates seamlessly with the Allegion AD-series, NDE and LE series of wireless locks. The Allegion LE/NDE Series of locks support several different operating modes that can be accessed via a right-click on the reader: Select Mode ...