1.0 Introduction

The following document explains how to setup a new Confluence system that can be used with mobile credentials, allowing you to use your smart phone as an access control credential. The integration is compatible with any Allegion Schlage locks which are Bluetooth Low Energy (BLE) compatible and the associated mobile credential app can be used on Android and Apple iOS smart phones - allowing you to unlock a BLE Schlage lock via Bluetooth (from a maximum
distance of approximately 20 feet away from the lock).

Mobile credentials offer an additional layer of security when compared with physical credentials as the phone itself needs to be unlocked before the mobile credential app can be used. Whereas, in comparison, if a physical credential is lost, anyone who finds that credential could potentially gain access to any door/lock which the credential has access rights to.

Mobile credential supported Schlage locks include: NDEB, LEB and Control (BLE) models as well as the MTB series Wiegand readers.

The Confluence web portal is used to enroll and configure mobile credentials and their access rights. The access data is then immediately sent to the user's mobile app via the Allegion Engage Cloud service.

The mobile credentials also function in a 'No Tour' mode. This means the lock data is written
directly to the mobile credential (as opposed to someone having to physically visit the individual locks to update them). This allows mobile credential management to be performed from any single location that can access the Confluence web portal via the internet.

 

2.0 Download and Install the Allegion ENGAGE App

1. Go to the Google Play Store on your supported Android device or the APP Store on your iOS device.
2. Search for 'Allegion ENGAGE'.
   
   
   
   
3. Tap the INSTALL button to download and install.
4. Then tap OPEN to open the app.

 

3.0 Register an Allegion Engage Partner Account

1. After downloading, installing and opening the ENGAGE app, you will see the login window.
2. At the bottom of the screen, tap on CREATE NEW.
   
   
   
   
3. Read through and accept the terms and conditions.
4. Enter your name and contact e-mail address >> click NEXT.
5. Enter a password for your account (and re-enter) >> click NEXT
6. You will now receive an e-mail to verify your new account. Please click the link and follow the instructions.

 

4.0 Register Your Account and Create a Site

Now that you have created an Allegion partner account you will need to register this account on the Confluence Web Portal. This can be done via a web browser on your PC or smart device.

1. Navigate to http://allegion.aetheros.net
2. Click REGISTER YOUR PARTNER ACCOUNT.
   
   
   
3. Enter your display name, your ENGAGE email address, a new site name and select your world time zone >> click REGISTER.
4. Login to the Confluence Web Portal with your registered e-mail and password.

 

5.0 License Your Confluence Site

Once you have created a new Confluence site on the web portal (allegion.aetheros.net) the
number of locks will need to be enabled on the license as well as the number of mobile
credentials that will be used. Contact Keri Systems sales team to purchase the licensing
for your locks and the quantity of mobile credentials that you require.

Once your Confluence system has been created, licensing information can be viewed
on the Confluence web portal:

1. Go to allegion.aetheros.net
2. Log into the web portal with your Allegion ENGAGE email and password.
3. Click on Advanced.
4. Click on License to view your system license information.
   
   

 

6.0 Commission the Schlage BLE Locks

You must now use the Allegion ENGAGE app to commission/add the Schlage locks to your site.

Note: If you are adding multiple locks of the same type and within close range, it is advisable that you know the serial number for each lock. The serial number is printed on a white label on a new lock. Do NOT throw away this white label until you have completely setup and commissioned the lock.

1. Log in to the ENGAGE app.

2. The app will open and the devices screen will appear.
   
   Note: You can click the menu icon >> Sites to check the site is displayed correctly.
   
   

3. On the Devices screen, tap the orange add (+) icon (in the lower-right corner) - you will see a list of all Schlage device types that can be added.

4. Select the type of lock that you wish to add (for example, a Control lock).
   
   
   
   
   

5. Select to use the default settings for the lock.

6. The app will search for any locks (of the lock type selected) within Bluetooth range.

7. When detected, the lock(s) serial number(s) will also be displayed).
   
   
   
   

8. Tap on the lock and the app will connect to it.
9. The LED on the lock will start flashing red.
10. On screen, tap Yes to confirm the red LED is blinking.
11. Enter a name for the new device. Tap NEXT.
12. You will see a notification that the device is being prepared.
13. Once complete you can add another lock of the same type or tap the FINISH button.
14. The app will disconnect from the lock and you will see the lock on the device screen.
    
    Note: In the lock settings, mobile credential support is enabled by default.

 

7.0 Add the Lock to the Confluence Web Portal

The next step is to add the lock to the Confluence web portal using the Sync Devices option.

1. Go to allegion.aetheros.net
2. Log into the web portal with your Allegion ENGAGE email and password.
3. In the upper-left corner click on Devices.
   
   
   
4. On the Devices screen, click on the SYNC DEVICES button.
5. Within a few seconds the lock/device will appear on the screen.
   
   
6. You will see there is an orange indicator next to the lock. The initial sync will need to be performed using a separate app (called 'Confluence by Keri').

 

8.0 Download and Open Confluence by Keri

1. Open Google Play Store on your Android device or the APP Store on your iOS device.
2. Search for 'Confluence by Keri'.
3. Select the Confluence by Keri app.
   
   
   
   
4. Tap the INSTALL button.
5. Within a few seconds the app will have installed on the phone.
6. Tap the OPEN button.
7. You will see a notification that Location is currently disabled for the app. Go to app settings on your phone and enable Location permissions for the Confluence by Keri app.
   
   
   
   
8. Return to the app, tap OK and you will then see the log in screen.
9. Log into the app with your registered email address and password.
10. Once logged in you will see your site.
11. Tap the site name.
12. The app will then retrieve the locks/devices which are added to the site. Again, you will see the same indicator that the lock needs to be synced.
    
    
    
    
13. To sync the device, tap the device name, select Connect and the app will connect to the device via Bluetooth. Once connected the LED on the lock will be slowly blinking red.
14. Click the SAVE button and the lock will then be synced.
15. From this screen you can see that the administrator can also unlock the door, retrieve audits from the lock and view lock information such as the firmware version and the lock power.
16. To disconnect from the lock click the icon in the upper-right corner.
    
    
    
    
17. You will be returned to the device screen and the lock will no longer have the sync required icon.
18. If you return to the Devices screen on the Confluence web portal the lock will not display the sync required icon there either.
    

 

9.0 Enrolling a New Mobile Credential

Once the lock has been initially synced you will be able to enroll a new mobile credential using the Confluence web portal.

1. In the Confluence web portal, in the upper-left corner click Users then select Users.
   
   
   
   
2. The Users screen will appear.
3. Towards the upper-right of the screen, click the NEW USER button.
4. Enter the first name for the new user.
5. Enter the last name for the new user.
6. Enter the new user's e-mail address.
7. Enter the user's location (for example, where they live or where they work).
8. Select Expire Daily - the user will expire at 23:59:59 on the activation date.
9. Select Never Expire and the user will never expire.
10. If you leave Expire Daily and Never Expire unselected the user will activate on the
    Activation date and time and will expire at the Expiration date and time.
    
    
    
    
11. Click Submit.
12. Click the ADD MOBILE CREDENTIAL button.
    
    
    
13. Select the country for where the user is located.
14. Enter the phone number for the user (the country code is not required).
15. Select the Credential function (typically most users will be set to the Normal function).
    
    
    
    - Normal - This mode unlocks the lock momentarily (with specified relock delay period).
    - Freeze - Freezes the lock in the current state. Lock remains frozen until Freeze credential is presented again. Disables all other credentials except for Pass Through.
    - One Time Use - Allows only one Normal access per assigned lock.
    - Pass Through - Unlocks a lock momentarily, regardless of state. Overrides a lock in Freeze and Lock Down states.
    - Lock Down - Changes the state of the lock to locked and disables all credentials except for Pass Through and Freeze. Present a Freeze to return lock to normal state.
    - Block - Denies access to the lock and records the access attempt as an audit.
    - Delete with Alarm - A delete with audit/alarm credential will log an audit entry that the credential was used. However, the credential will NOT unlock the door. If an alarm is available on the lock, then the alarm will sound. This functionality is the same as the “blocked” credential type.
    - Update from Server - Update from server credential will trigger the update from server in SF210 mode irrespective of lock state. In SF200 mode this credential will be treated as invalid credential.
    - Update From Server + Normal - Update from server+Normal credential will behave as normal credential and then trigger the update from server in SF210 mode irrespective of lock state. In SF200 mode this credential will be treated as normal credential only.
    
    
16. Leave the No Tour option enabled and access rights will then be automatically updated to the mobile credential. The Never Schedule should also be left as enabled.
    
    Important Note: If No Tour or the Never schedule are not enabled then it will not be
    possible to disable access for the mobile credential without physically visiting and updated using the Confluence by Keri app. The Never schedule is used when access to a lock is disabled for a user (see section 15.0).
    
    
    
    Note: Only the first enrolled mobile credential will have the Never schedule displayed. All additional mobile credentials will only display the No Tour option.
    
    
17. Click the SUBMIT button and the mobile credential will be created.
18. The user will receive an SMS message on their smart phone with instructions for
    downloading and installing the Confluence Resident app.
    

 

10.0 Create a New Time Schedule

The Confluence web portal has two schedules defined by default (24/7) and Never. The following steps explain how to create an additional schedule (such as for a typical work week) and once selected for the user's access rights, access will only be granted during the times which are set in the time schedule.

Note: There are a maximum of 16 different time schedules that can be used with the No Tour
function for mobile credentials.

1. From the Confluence web portal go to Users >> Schedules.
   
   
   
2. Click the NEW SCHEDULE button on the right of the screen.
3. Enter a name for the schedule.
4. Select a time when access begins.
5. Select a time when access ends.
   
   
   
   
6. Select the days of the week when access will be granted.
   
   
   
   
7. Click the SUBMIT button to create the schedule.
   
   Note: Scheduled are assigned to locks when assigning access rights (see next
   two sections).

11.0 Assign the User Individual Access Rights

If your site has 11 or less locks, then the easiest method of assigning access is to use the
Individual Access option.

1. On the user record screen, click on the ASSIGN ACCESS button.
   
   
   
2. Next to the lock model toggle the Access setting to enable access for the user.
   
   
   
   
3. By default the time schedule defaults to 24/7 access or you can select a different time schedule from the drop-down list.
4. Click the SAVE button and the individual access will be assigned to the user.

12.0 Create and Assign Access Groups

If your site has more than 11 locks, or if there are locks which are used by many different users, it is best to create access groups. Multiple locks can be added to access groups and any changes made to that group will be applied to all users which are assigned the group.

12.1 Create a New Access Group

The next steps explain how to create an access group (using the default 24/7 time schedule):

1. Go to Users >> Access Groups.
2. Click the NEW GROUP button.
3. Enter a name for the new access group.
4. The 24/7 schedule will already be selected.
5. Tap the SUBMIT button and the new access group will be created.
   
   
   
   
6. The locks can now be assigned to access groups and the access groups can then be assigned to users.

 

12.2 Assign Locks to an Access Group

Now that an access group has been setup and assigned a time schedule, you can assign locks to the group.

1. Go to Devices >> Devices.
2. Locate the lock/device to add to groups.
3. From the Manage drop-down, select Add to Access Group.
   
4. A window will appear with all access groups on the system, so select the group to assign.
5. Click BACK to return to the device list.
6. The assigned access group will then display in the lock record.

 

12.3 Assign Access Groups to Users

1. On the user list, click to reveal the 'Manage' drop-down list.
2. Select 'Add to Access Group'.
3. A window will appear allowing you to select the access group for the user.
4. Select an access group then click the SUBMIT button.
   
   
   
   
5. The access group will now be assigned to the user.

 

Note: After setting up a new access group any locks which are added to the group will need to be synced using the Confluence by Keri management app.

 

13.0 Download the Keri Confluence Mobile Key App

1. Open Google Play Store on your Android device or the APP Store on your iOS device.
2. Search for 'Keri Confluence Mobile Key'.
3. Click the INSTALL button.
   
   
   
   
4. The app will install within a few seconds.
   
   Note: Before opening the mobile key app ensure you have Bluetooth enabled on your phone.
   
   
5. Tap OPEN.
6. Select the country that you are located.
7. Tap the REQUEST OTP button.
8. A 5-digit logon code will be sent to you immediately via SMS.
9. Enter the code into the logon code field and tap the SUBMIT button.
10. The app will authenticate your initial login.
11. You will now see a notification that location permissions needs to be enabled for the app.
12. Go to the Keri Confluence Mobile Key app settings and enable Location permissions.
    
    
    
    
13. Return to the mobile key app and tap OK.
14. Swipe down on the screen and the app will sync with the Allegion server.
    
    Note: Whenever you log into the mobile key app the app will automatically sync with the Allegion server.
    
    
15. Any locks which you are assigned access to will be displayed.
    
    
    
    

 

14.0 Unlocking a Door With Your Mobile Credential

1. Go to within Bluetooth range of the lock. The maximum distance is around 20 feet/6m.
2. Tap and hold the TAP AND HOLD button.
3. The app will connect to the lock and within a few seconds the lock will unlock.
4. When the lock is unlocked the lock's LED will blink green and the lock will beep once.
5. The lock icon in the mobile key app will also go green.
   
   

 

 

15.0 Disabling Mobile Key Access

Note: Disabling mobile key access is done using the Confluence web portal. When a mobile key has had access disabled to a lock, the next time you open the app the updated access rights will be automatically downloaded.

1. Go to allegion.aetheros.net
2. Log into the web portal with your registered e-mail and password.
3. In the upper-left, click on Users >> Users.
   
   
   
   
4. Click the ASSIGN ACCESS button in the upper-right.
5. The device screen will appear.
6. Toggle the Access setting to remove access to the lock.
   
   
   
7. Save the device settings.
8. When the user next opens the app, the app will sync with the Allegion server and access will no longer be granted, at the lock which has access disabled. The look which has access disabled will not display on the locks screen.
   
   Note: When toggling access for a lock to OFF the schedule will automatically be set to Never. When toggling access back on again the schedule will go back to whatever active schedule the lock was previously set to.