#### Version 1.3.7 >
# Overview
ORBNET have developed an XProtect Access Control Module (ACM) for the Lenel S2 NetBox system. This document details the prerequisites and installation and licensing steps.
# Principal Scheme
This XProtect Access Control integration comprises of the following elements:
- XProtect Access Control Module
- XProtect Management Client (MC) plugin
The following items must also be installed and configured prior to deploying the Access Control Module:
1. S2 NetBox device and associated nodes
2. XProtect 2023 R1 or above system with XProtect Access license installed and sufficient Access Control Door licenses to cover the number of doors required.
**NOTE:** The XProtect Access Control integration should work on older versions of XProtect but this has not been tested and therefore compatibility is not guaranteed.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN.png]]
# Prerequisites
1. S2 NetBox device
1. IP address and port (if port is non-standard)
2. Administrator access to the web administration interface
3. User Account added for use by the integration – details to configure this are provided in this guide (username + password made available)
2. Administrator access to the XProtect Event Server (to install software on)
3. XProtect account with admin privileges (a Domain Service Account or Basic XProtect User)
1. Add new Access Control integration
2. Configure Alarms and assign cameras to readers
4. .NET Framework v4.8 installed on all XProtect servers
5. Installation package from ORBNET
6. A valid license after the 30-day trial period has finished
7. **Any previous S2 Integrations uninstalled and removed completely**
# Features Support
The ORBNET S2 Netbox for XProtect Access Control Module supports the following S2 NetBox features:
- **API Version 1** AND **API Version 2** (N.B. API Version 1 is set to be retired from NetBox 6.0)
- Card holder search and view details (including photos)
- Retrieval of doors and associated readers
- Door commands (Lock, Unlock, Momentary Unlock)
- Events (real-time from S2)
- Multiple partitions
- Activate and Deactivate Outputs
- Personalised Login (XProtect Smart Client)
- Door Status Polling (supported in NBAPI v2)
## Known Lenel S2 Netbox API Limitations
The Lenel S2 NetBox API has several limitations which impact some features of the XProtect Access Control integration:
1. **Reader states are not available**. Therefore, all Readers will show as Normal. If connectivity to the S2 API fails, then all elements will be marked as Unknown until connectivity is restored.
2. **Only one integration connection at a time**. This is not a limitation per se, and note Prerequisites point 7, but the NetBox API only allows a single concurrent connection to the API (for event stream), therefore to avoid contention, remove any existing integration software.
# Installation Steps
The ORBNET ACM and XProtect Management Client Plugin are installed using the supplied installation package. This should be run on the XProtect Event Server by a user with local administrator privileges (XProtect privileges are not required).
**NOTE:** After the installation has completed the XProtect Event Server will require a restart. This should be scheduled during a suitable maintenance window.
1. Double-click on setup.exe in the installer folder. This will launch the install program.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 1.png]]
2. Click Next on the opening screen.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 2.png]]
3. Agree to the End User License Agreement
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 3.png]]
4. Leave the installation folder as the default value and click Next.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 4.png]]
5. Click Next to start the installation process.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 5.png]]
6. The installer will prompt to Stop the XProtect Event Server (if it is running), click Yes to continue:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 6.png]]
7. The installer will prompt to Start the XProtect Event Server, click Yes to continue:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 7.png]]
8. Once the installation has completed, click Close.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 8.png]]
## Confirm Installation
Once the installation process has completed the XProtect Event Server service should be restarted (if the prompted restart in the installation program was not utilised). This will load the necessary Access Control Module and initialise the 30-day trial license.
# Confirm Access Control Integration is accessible
Follow these steps to confirm that the Access Control Module has installed correctly:
1. Open the XProtect Management Client and navigate to Access Control on the left-hand side.
2. Right click on the Access Control node and select Create New.
3. On the Create Access Control System Integration screen, open the Integration plug-in drop-down.
4. Confirm that the S2 Access Control System is visible (it will be added later, this is just to check it is appearing in the list)
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 9.png]]
**NOTE:** If it is not listed, please ensure that the installation completed successfully and that the XProtect Event Server has restarted.
## Confirm Management Client Plugin is accessible
Follow these steps to confirm that the XProtect Management Client Plugin has installed correctly:
1. Open the XProtect Management Client (on the XProtect Event Server).
2. Confirm that the S2 Access Control node is visible under ORBNET Plugins.
3. Click on it and confirm that the plugin contents load.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 11.png]]
# Create S2 API User
The XProtect integration requires an API user to be created within the S2 NetBox system to grant it access. Follow these steps to set up the correct permissions for the user account:
1. Login to the S2 NetBox administration web interface.
2. Navigate to Configuration > Site Settings > User Roles.
3. Click Add and provide a Name and Description:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 13.png]]
4. Scroll down and check Read-Write under API Privilege > Access and tick Restrict User to API Login only (under Security).
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 14.png]]
5. Click Save.
6. From the top bar, Select Administration > People Add.
7. Provide a Last Name and First Name and under the Login section enter a username, password and select the API User Role under User Role:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 15.png]]
8. Click Save when completed.
# Enable S2 NetBox API
In order for the XProtect Access Control integration to communicate with the S2 NetBox system, the API must be enabled. Follow these steps to do so:
1. Login to the S2 NetBox administration web interface.
2. Navigate to Site Settings > Network Controller > Data Integration tab.
3. Under API check Enabled, Use Authentication and Use login username/password.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 16.png]]
4. Leave all other settings as default.
5. Click Save when done.
# Add Access Control Integration
In order to utilise the Access Control Module within XProtect, the Access Control integration must be added. This is done through the XProtect Management Client.
1. Open XProtect Management Client.
2. Navigate to Access Control.
3. Right click on Access Control and select Create New.
4. Provide a Name for the Access Control System (e.g., the organisation or premises).
5. Select [S2 Access Control System] from the Integration plug-in drop-down.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 17.png]]
6. Complete the settings as follows:
| Setting | Default Value | Notes |
| --------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------- |
| Language | English | English is the only language currently available. |
| Address | Localhost | IP address or hostname of the S2 NetBox server. |
| Port | 80 | TCP port of the S2 NetBox server. |
| Connect using HTTPS | Off | Enable if using HTTPS on the S2 NetBox server. |
| S2 API Version | Version1 | Adjust to match the version of S2 API. |
| Username | XProtect | API user for S2. |
| Password | N/A | Password for the S2 API user. |
| Session Timeout | 600 | Session timeout as defined in S2 (entered in seconds). |
| Poll for Portal Status Changes (v2 only) | Off | Enable polling of NBAPI for portal status changes. NOTE: This is only supported in v2 of the NBAPI. |
| Portal Status Changes Polling Interval (in seconds) | 1 | The number of seconds between polling of NetBox API for portal status changes |
7. Once completed, click Next.
8. The Access Control Module will now attempt to connect to the S2 NetBox API to authenticate and import all Access Control elements
If there is an error, you may see the following message:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 18.png]]
9. Click Previous, re-check all settings and try again. If the error persists, contact ORBNET support.
10. Once completed, you can review the configuration that has been added:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 19.png]]
11. Click Next to continue.
12. Use the following screen to associate XProtect cameras to access points (this can be done later if required).
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 20.png]]
13. Click Next.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 21.png]]
14. Click Close to complete.
The Access Control Module is now configured. All the standard XProtect Access Control functions will now be available on the access control units that are available and licensed – for example doors and readers, each ACU and the server.
# Enable Personalised Login
The integration supports XProtect Personalised Login. This must be enabled through the XProtect Management Client as follows:
1. Open XProtect Management Client
2. Navigate to Access Control node and select the relevant S2 Integration
3. Under General Settings, tick Operator login required, and click Save
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 22.png]]
# Configure Alarms
The S2 Access Control System can raise alarms when certain events occur. For example:
- A user denied access to a reader/door.
- A specific door was opened out of office hours.
- A reader went offline.
These alarms are monitored by the XProtect Access Control Module and presented as events. In order to get these alarms to appear within XProtect, the Alarms must be configured, and the door/reader must be licensed. Follow these steps to do so:
1. Open the Management Client.
2. Expand the Alarms node on the left-hand side and select Alarm Definitions.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 23.png|300]]
3. On the right-hand side, right click on Alarm Definitions and select Add New.
4. XProtect presents a several options to configure an Alarm Definition:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 24.png]]
5. Under the Trigger section, open the Triggering event drop-down box and select Access Control Event Categories.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 25.png]]
6. In the subsequent drop-down boxes, select the event category (e.g., Access Denied) and related source:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 26.png]]
7. Set any other options as desired and click Save.
Now, when an Access Denied event on the selected door (in this example) is raised via The Access Control Module, XProtect will raise an alarm which can be observed in the XProtect Smart Client:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 27.png]]
# Adding overlay buttons in the XProtect Smart Client
The XProtect Smart Client supports the placing of “overlay buttons” on live camera tiles to initiate a variety of actions, including Access Control commands. This can be used for example to provide a quick action to open a door that the operator can action based on the activity identified by the live camera feed.
Follow these steps to add an overlay button as described:
1. Open the XProtect Smart Client and login.
2. Ensure the Live tab is selected, and the desired View is open.
3. Click on the Setup button:
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 28.png]]
4. From the left-hand menu, under “Overlay buttons” expand the Access control node and select a command relating to the door in question. Draft this onto the video tile.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 29.png]]
5. Click on the Setup button again to save the changes.
6. Hover the mouse over the edited tile, the overlay button should appear.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 30.png]]
# License Activation
The Access Control Module comes with a free 30-day trial license. After that the software will no longer function. In order to activate a license, follow these steps.
> [!note]
> After a valid license has been loaded the XProtect Event Server will require a restart. This should be scheduled during a suitable maintenance window.
1. Open the XProtect Management Client **_on the XProtect Event Server_** and login.
2. On the left-hand side navigate to ORBNET Plugins > S2 Access Control.
![[ORBNET S2 Milestone ACM Installation Guide v137 EN 31.png]]
3. Click on the Settings tab, this will show the current license status:
![[z_img/d14c22a0b95022cb54e62fc0c6048b99_MD5.jpg]]
4. Complete the Client Name field and click on **Export license request**. This will generate a “.s2licr” file.
5. Send this file to [
[email protected]](mailto:
[email protected]) to get your license activated. Once ORBNET has received payment, a return email will follow containing the “.s2lic” file which needs to be imported as follows.
6. In the same XProtect Management Client, click on **Import valid license**. Select the “.s2lic” file that was sent to you.
7. The license status should now update showing the duration of the license and any other license features.
8. The XProtect Event Server will now need to be restarted to activate any previously unlicensed features. This should be done manually by a system administrator.
9. After the XProtect Event Server has restarted, re-open the Settings tab in the Management Client plugin to confirm the license status.
# Important Locations
The following table lists important locations containing log files. Files from these paths may be requested for support and troubleshooting. Access to all paths should be secured appropriately according to local security policies.
**Base path**
The base path depends on whether the Export Service is running under a Domain Service Account or with a built-in account e.g., NETWORK SERVICE (this is the default account after installation, and suitable for a non-domain environment).
Running as a Windows User Account: C:\Users\<service-user>
Running as Built-in Account: C:\Windows\ServiceProfiles\NetworkService
| | | |
| ---------------------- | ------------------------------------------------------------------------------------ | --------------------- |
| Item | Path | Server/Client |
| MIP Logs | C:\ProgramData\XProtect\XProtect Event Server\logs\MIPLogs\*.log | XProtect Event Server |
| Install Path | C:\Program Files\XProtect\MIPPlugins\ORBNET\S2AccessControl\XProtect Event Server | |
| Management Client Logs | C:\Users\<username>\AppData\Local\S2AccessControl\ManagementClient \Logs\Workstation | |