1.0 Introduction

The Site Lock and Site Unlock feature allows you to unlock all doors or a selection of doors on a
specific site - either from buttons in the user interface or from a general purpose input. In addition
to locking and unlocking doors, the Site Lock feature also allows you to configure readers to go
into Lockout mode or Lockdown.

1. Site Lock and Site Unlock is supported on Keri KB, Keri NXT, NXT-MSC, Mercury and
   PXL controllers. It is not supported with Switch Tech locks.
   
   
2. The Site Lock and Site Unlock feature is controlled by a feature flag to allow us to evaluate
   and monitor the performance before a wider rollout. To request access to use this feature,
   please contact your integrator or regional sales manager.

General Notes:

• Site Lock and Site Unlock is a real-time, online-dependent feature - it will not function if the hub, or if the hardware, is offline. The PXL controllers however, have dedicated inputs that can unlock and lock/lockout/lockdown doors (on the local PXL network), even if the hub or hardware is offline - this implementation is covered in separate documents:
  
  - PXL Global Lock: https://borealis.kerisys.com/portal/en/kb/articles/pxl-glu-lock
  - PXL Global Unlock: https://borealis.kerisys.com/portal/en/kb/articles/pxl-glu-unlock
  
  
• Site Lock and Site unlock from the software will not activate if there is an update in progress. This is only noticeable with PXL controllers as these controllers take longer to update.
  
  
• There are certain settings which cannot be edited while Site Lock or Site Unlock is active. For example; you will not be able to set a monitor point as a Site Lock or Site Unlock input while Site Lock or Site Unlock is active.
  
  
• Site Lock and Site Unlock has a precedence setting to determine which mode has priority. This setting only applies to an attempt at overriding the current mode using a hardware input. For example; if Site Lock has precedence and is active it will not be possible to override this mode by activating a Site Unlock hardware input.
  
  
• If the system uses hardware inputs for Site Lock/Site Unlock and there are multiple hubs, then each hub will require individual hardware inputs. Only the UI buttons can action Site Lock/Site Unlock across multiple hubs.
  
  

2.0 Site Lock and Site Unlock Using PXL Controllers

When using PXL controllers the Site Lock and Site Unlock implementation is slightly different
compared to other controller types. There are functionality limitations but there is also extended
functionality that is not available with other controller types.

• If a primary PXL (address #1) does not have 'Use Site Lock/Unlock' selected, then none of the secondary controllers on that local PXL network will respond to Site Lock/Unlock either.
• When enabled on a primary PXL controller all connected secondary PXLs on that local network will respond immediately to Site Unlock or Site Lock/Lockout/Lockdown - you cannot exclude any of the readers from responding.
• Site Lock/Site Unlock can be enabled or disabled on any PXL primary controller (addressed #1)... see section 10.0 to configure a PXL primary to not respond.
• PXL primary controllers have a dedicated Site Unlock input (pins 5 and 6 of TB4). This
  functionality is also available if the controller goes offline.
• Additionally, PXL primary controllers also have a dedicated Site Lock input (pins 5 and 6 of TB8) on an SB-593. This functionality is also available if the controller goes offline.
• In addition to Site Lock, PXL controllers can also be put into Site Lockout and Site Lockdown mode - but the controllers MUST be using firmware version 08.06.09. Any controllers using a lower firmware revision will only support Site Lock.

3.0 Site Lock and Unlock Using Entraguard Controllers

When using Entraguard controllers there are Site Lock and Site Unlock characteristics that are unique to this controller type.

• To use Site Lock or Site Unlock the primary controller MUST be a PXL-500 controller - It cannot be an Entraguard controller.
• Entraguard secondary controllers can respond to Site Lock or Site Unlock.
• Entraguard controllers cannot respond to Site Lockout or Site Lockdown.

4.0 Site Lock and Site Unlock Definitions

Notes:
- Each of the Site Lock and Site Unlock settings can be activated from the button on the Sites screen or from a dedicated hardware input.
- Excluding PXL and Entraguard controllers, you can configure specific doors to not respond to Site Lock or Site Unlock.

• Site Unlock - When the button is pressed or when the input is activated, doors on the site will unlock. They will remain unlocked until the Site Normal button is pressed or when the dedicated Global Unlock input goes inactive.
  
  
• Site Lock - When the button is pressed, or when the input is activated, any doors which have been unlocked from the software or auto-unlocked via a schedule will immediately be locked. They will remain locked until the Site Normal button is pressed or when the dedicated Global Lock input goes active. When the system returns to Site - Normal, doors assigned an auto-unlock schedule will resume following their assigned schedule.
  
  
• Site Lockout - When the Site Lock button is pressed or when a dedicated input goes active, all doors on the site will go into Lockout mode. This mode will deny access to cardholders but the Request-to-Exit (REX) input will still function.
  
  
• Site Lockdown - When the Site Lock button is pressed or when a dedicated input goes active, all doors on the site will go into Lockdown mode. This mode will deny access to cardholders and the Request-to-Exit (REX) will also not function.
  
  
• Site Unlock - Ignore Overrides - If this option is selected you will not be able to lock doors from the Readers screen while Site Unlock is active.
  
  
• Site Lock - Ignore Overrides - If this option is selected you will not be able to unlock doors from the Readers screen while Site Lock is active.
  
  
• Precedence - Determines if a hardware input can override Site Lock or Site Unlock. This does not refer to the buttons in the UI... The Site Unlock button will always be able to override Site Lock and the Site Lock button will always be able to override Site Unlock.
  
  - Site Lock has Precedence - It will not be possible to override Site Lock with a Site Unlock hardware input.
  
  - Site Unlock has Precedence - It will not be possible to override Site Unlock with a Site Lock hardware input.
  

5.0 Enable Site Unlock (All Controller Types)

The following steps explain how to enable the Site Unlock feature for a specific site:

51. Enable the Site Unlock Button

1. From the main menu on the left, click on Sites.
2. The Sites screen will appear.
3. Place a check-mark against the name of the site.
4. Select the Actions menu on the right side of the screen and select Lock/Unlock settings.
   
   
   
   
5. On the Site Lock/Unlock settings form, enable the feature and then enable Site Unlock.
   
   
   
   
6. Save the settings.
7. Select the site again and the NORMAL and SITE UNLOCK buttons will now be enabled on the Sites screen.
   
   

6.0 Enable Site Lock/Lockout/Lockdown (All Controller Types)

The following steps explain how to Enable the Site Lock/Site Lockout or Site Lockdown feature for a specific site:

1. From the main menu on the left, click on Sites.
2. The Sites screen will appear.
3. Place a check-mark against the name of the site.
4. Select the Actions menu on the right side of the screen and select Lock/Unlock settings.
   
   
   
   
5. On the Site Lock/Unlock settings form, enable the feature and then enable Site Lock.
   
   
   
   Note: For further details about the Ignore Override options please refer to section 14.0.
   
   
6. Select the specific lock type that you wish to use for the site:
   
   □ Lock - When Site Lock is activated, all doors which have been manually unlocked or unlocked via an auto-unlock schedule, will immediately be locked.
   
   □ Lockout- When Site Lock is activated, all doors which have been manually unlocked or unlocked via an auto-unlock schedule, will immediately be locked. Additionally, valid credentials will not be able to gain access, however the request-to-edit (REX) inputs will work.
   
   □ Lockdown- When Site Lock is activated, all doors which have been manually locked or which are unlocked via an auto-unlock schedule, will immediately be locked. Additionally, valid credentials will not be able to gain access and the request-to-edit (REX) inputs will be inactive.
   
   
   
   
7. Save the settings.
8. Select the site again and the NORMAL and SITE UNLOCK buttons will now be enabled on the Sites screen.
   
   
   

Note: You can, of course, enable Site Lock and Site Unlock - this will enable all three buttons on the Sites screen.

          

Note: Once Site Lock or Site Unlock is activated the site will remain in that mode until the NORMAL button has been pressed - unless the site has been configured to allow overrides.

7.0 Enable Site Lock/Unlock for PXL Controllers

If you are using PXL controllers you should also enable Site Lock/Unlock on the PXL primary controller(s). This allows you to decide which PXL primary controllers will respond to Site Lock/Unlock and which ones will not respond. Once enabled on a PXL primary controller all PXL secondary controllers on that local network will be configured to respond to Site Lock/Unlock.

7.1 Enabling Site Lock/Site Unlock for a Primary PXL Controller

1. From the main menu on the left, click on Hardware >> Controllers.
2. Locate a PXL primary controller (it will display an assigned IP address).
3. Click on the Actions menu located on the right and select Edit.
   
   
   
4. The primary controller edit form will appear.
5. Place a check-mark against 'Use Site Lock/Unlock'.
   
   
   
6. The PXL primary controller is now configured to respond to Site Lock and Site Unlock.
   

7.2 Configuring Site Lock Options on a PXL Primary Controller

Important Note: Site Lockout and Site Lockdown are not supported on Entraguard controllers, or on PXL controllers which have a firmware version lower than 08.06.09.

When Site Lock/Unlock is enabled on a PXL primary controller the specific site lock mode will be automatically set on the controller when the controller settings are saved. This is defined on the Lock Enabled - Input Driven settings (even when a hardware input is not being used). As this is configurable per primary controller, one PXL local network can be configured for Site Lockdown and a different PXL local network can be configured to go into Site Lockout.

For example, if the Site Lock Type is set to Lockdown then the PXL primary controller will automatically be configured for Site Lockdown.

However, there are other Site Lock options that can be configured on a per-controller basis: They are as follows:

Note: The selected settings described below will also determine how the dedicated Global Lock input will be configured - this is the hard-coded input located on an SB-593 and will function even when the primary controller is offline.

• Global Lock Only - When configured on a PXL primary controller, if Site Lock is activated all PXL doors on the local network will be locked but cardholders will continue to be granted access and the RTE will continue to work.
  
  
• Global Lockdown - When configured on a PXL primary controller, if Site Lock is activated all PXL doors on the local network will be locked and put into Lockdown - cardholders will no longer be granted access and the RTE will no longer work.
  
  
• Global Lockdown allow Total Access - When configured on a PXL primary controller, if Site Lock is activated, all PXL doors on the local network will be locked and put into Lockdown - however cardholders with 24/7 access at the PXL readers can gain access but all other cardholders will no longer be granted access. The RTE will also no longer work.
  
  
• Global Lockout - When configured on a PXL primary controller, if Site Lock is activated all PXL doors on the local network will be locked and put into Lockout - cardholders will no longer be granted access but the RTE will work.
  
  
• Global Lockout allow Total Access - When configured on a PXL primary controller, if Site Lock is activated, all PXL doors on the local network will be locked and put into Lockout - however cardholders with 24/7 access at the PXL readers can gain access but all other cardholders will no longer be granted access. The RTE will continue to work.

8.0 Enable a Site Unlock/Site Unlock Hardware Input (All Controller Types)

The following steps explain how to configure a monitor point to function as a Site Unlock or Site Lock input. It is not possible to configure a door contact or REX input as a Site Unlock input.

Notes:

• If a system or site uses multiple hubs then a hardware input will be required for each hubs. A hardware input will not unlock doors across multiple hubs.
• If you have multiple controllers on your system it is a good idea to activate the monitor point that you wish to use as the Site Lock/Unlock input and then make a note of the name of the input which appears in the Description column of live events. It will then be easy to locate the specific input.
• A monitor point can function as either a Site Lock input or a Site Unlock input. It cannot activate both Site Lock and Site Unlock.
• A Site Lock or Site Unlock input will only lock or unlock doors for the site that the input is associated with.

1. From the main menu, click on Hardware >> Inputs.
   
   
   
   
2. The Inputs screen will appear displaying a list of all inputs on the system which are configured as monitor points.
3. Select the input that you wish to configure.
4. Click on the Actions menu located on the right side of the screen.
5. Select Edit.
6. Rename the input (for example; Site Unlock input or Site Lock input).
7. Scroll down the input settings.
8. Optionally you can change the line supervision of the input. By default, monitor points are
   normally-closed circuits so they become active when the circuit is open. If you change the
   line supervision to a normally-open circuit it will be active when the circuit closes.
9. Place a check mark against Global Lock Input or Global Unlock Input
   
   
   
   
10. Save the input settings.

9.0 Excluding a Reader from Site Lock or Site Unlock

The following steps explain how to exclude a reader from responding to Site Unlock or Site Lock:

Note: This option does not apply to PXL controllers (see the following topic for excluding PXL primary controllers from Site Lock or Site Unlock)

1. Go to Hardware >> Readers.
2. A list of readers will appear.
3. Scroll to the right side of the screen and click on the Actions menu.
4. Select Edit.
5. Scroll to the bottom of the reader settings and place a check mark against Ignore Site Unlock, Ignore Site Lock, or both.

10.0 Excluding PXL Controllers from Site Lock or Site Unlock

It is not possible to exclude individual PXL readers from responding to Site Lock or Site Unlock. However, it is possible to exclude a PXL primary controller from responding. If you exclude a PXL primary controller from Site Lock or Site Unlock then all secondary controllers on that PXL network will also be excluded.

If you have just 1 or 2 doors to exclude from Site Lock or Site Unlock then these doors should be located on a PXL primary controller.

Note: a PXL site can have multiple PXL primary controllers.

1. Go to Hardware >> Controllers.
2. The controller list will appear.
3. Locate the PXL primary controller that you wish to configure (it will have an assigned IP address displayed).
   
   
   
   
4. Click the Actions menu and select Edit.
5. The controller settings will appear.
6. Ensure 'Use Site Lock/Unlock' is deselected.
   
   
   
   
7. Save the controller settings.
8. This primary PXL will now not respond to Site Lock or Site Unlock.
   

11.0 Test Site Unlock

The next step is to test that all readers/doors instantly unlock when Site Unlock is activated.

1. From the Borealis main menu click on Sites.
2. Place a check mark against the site name.
3. Click the SITE UNLOCK button.
   
   
   
   
4. You will see a notification at the top of the screen that the site unlock command has been sent.
5. All doors on the site will unlock immediately and readers will display a green LED.
6. The user interface (on the Sites screen) will also display that Site Unlock is now active.
   
   
   
   

12.0 Test Site Lock/Lockout or Lockdown

1. From the Borealis main menu click on Sites.
2. Place a check mark against the site name.
3. Click the SITE LOCK button.
   
   
   
4. If Site Lock is set to 'Lock' all doors on the site immediately lock. However, valid credentials will be able to gain access and the RTE function will still work.
5. If Site Lock is set to 'Lockout' all doors on the site immediately go into lockout mode - credentials will not gain access but the RTE functionality will still work.
6. If Site Lock is set to 'Lockdown' all doors on the site will immediately go into lockdown mode - credentials will not gain access and the RTE function will also not work.
   
   Note: When using Standard NXT or NXT-MSC controller types the reader LED will be red when the reader is in lockout or lockdown. However, when using PXL controllers the reader will remain at steady amber (during lockout or lockdown).
   

13.0 Precedence Setting

The Precedence option determines if Site Lock can be overriden by a Site Unlock hardware input or if Site Unlock can be overridden by a Site Lock hardware input.

Note: Precedence ONLY relates to hardware inputs. You will always be able to override Site Lock by clicking the Site Unlock button and you will always be able to override Site Unlock by clicking the Site Lock button.

• Site Unlock has Precedence - If Site Unlock is active you will not be able to override it with Site Lock hardware input. The site will need to be put back to the Normal state before a Site Lock input can be used to activate Site Lock mode.
• If Site Lock has Precedence - If Site Lock is active you will not be able to override it with Site Unlock hardware input. The site will need to be put back to the Normal state before a Site Unlock input can be used to activated Site Unlock mode.

14.0 Ignore Override Settings

As briefly mentioned, the ignore override settings means you will not be able to override the Site Unlock or Site Lock states. An example of an override is performing a temp unlock on a door while the door is in Site Lock, Site Lockout or Site Lockdown mode, or manually locking a door from the readers screen while the door is in Site Unlock mode.

14.1 Site Unlock Ignore Override Settings

• If Site Unlock is active and ignore override is enabled, you will not be able to lock a door by setting the mode to lock (from the readers screen). The lock option will be grayed-out.
  
  

14.2 Site Lock Ignore Override Settings

• If Site lock is active and ignore override is enabled, you will not be able to unlock a door by setting the mode to unlock or performing a temp unlock (from the readers screen). The unlock and temp unlock options will be grayed-out on the reader's screen.
  

P/N: 02493-001 Rev. A