Information
- Manufacturer: Lenel/S2 (+1 (585) 248-9720 x4 | (800) 631-6046)
- Product: OnGuard 7.6, OnGuard 7.5, OnGuard 8.1
- Type: Device Integration & Alarm Receiver
Supported Features
The OnGuard OpenAccess integration supports the following features:
- Alarms
- Door Pulse
- Get Config
- Sync
Components and Communication
From | To | Port | Use |
SureView Server | OpenAccess Server | 8080 TCP | Integration actions (sync and relay control) |
Prerequisites
License
You must have the following license attached to your OnGuard instance, you should obtain this through your LenelS2 representative:
IPC-011-SURVW01
OnGuard User Permissions
OpenAccess requires an internal OnGuard account. The OnGuard user account used by the integration must have at least the following permissions in OnGuard:- System Pemissions:
- Under "Access control hardware": "Query" on "Access Panels", "Readers", and "Alarm Panels"
- Under "Access control": "Query" on "Segments"
- Monitor Permissions:
- Under "Control": "Open doors"
- Under "Control": "Relay and reader outputs"
The items in OnGuard map to Sureview as follows (OnGuard -> Sureview):
- Segment -> Site
- Panel -> Device
- Door/Output -> Relay
- Alarm -> Alarm
Installation and Configuration
Install the following package on your SureView Device Tier (where 1.x.x.x is the latest available version):
- CC-DEVICESERVICE-OnGuardOpenAccessReceiver-1.0.0.5.svpkg
- CC-DEVICE-OnGuardOpenAccessDevice-1.0.0.3.svpkg
Update the SyncClient.exe.config file to include the DataSource and DataSourceInit config values. These values can be copied from the SVSync.exe.config file.
Alarm Acknowledgements
To enable alarm acknowledgements, set the "AcknowledgeAlarms" config option in the SVOnGuardOpenAccessReceiver.exe.config file to be one of the following options:
- NoAck - No acknowledgements take place.
- AutoAck - Alarms are acknowledged as soon as they hit our system.
- OperatorAck - Alarms are acknowledged when the operator acknowledges them through the SureView UI.
Site setup
Connection details for the OpenAccess integration are as follows:
Host | IP address or host of the OnGuard server hosting the OpenAccess service |
Port | The port the OpenAccess service is running on. default = 8080 |
Username | The username of the OnGuard account that has the access described above. |
Password | The password of the OnGuard account that has the access described above. |
ExtraValue |
|
Create a sync system at the monitoring station level, providing the information in the table above.
Create a root area for the OnGuard system. This will be a catch all for any alarms that come in that don't match to a specific area. Simply create a new device of type "OnGuard OpenAccess Panel" and provide a valid host and port, but leave the user credentials blank.
In each of your Sureview areas do the following to add the panels:
-
- Add a sync entry to the area providing either the Segment ID, Segment Name, Panel ID or Panel Name depending on the sync mode you chose:
- Syncing by Segment ID/Segment Name: this will cause all of the panels under the segment you specify to be added to the area and kept up to date as new panels are added.
- Syncing by Panel ID/Panel Name: this will cause the given panel to be added to the area. Unfortunately when syncing by panels you must add a sync entry for each panel and manually add/delete the entries if you add/remove panels on the area. (Recommended)
- Add a sync entry to the area providing either the Segment ID, Segment Name, Panel ID or Panel Name depending on the sync mode you chose:
Once the panel exists on a area, all alarms for that panel will go to that area instead of the root area.
Troubleshooting
Why am I only seeing panels marked as "Is Online"?
By default, Sureview will only sync on Panels that are marked as online. It is possible to ignore this and bring all panels in regardles of being marked as online or offline. Simply add the following configuration key to the SyncClient.exe.config file: <add key="IgnoreOfflinePanels" value="false"/>
I can connect to Open Access and pull panel information, but I'm not receiving any alarms
Ensure that the following OnGuard services are running:
- LS Communication Server
- LS Event Context Provider
- LS Web Event Bridge
- LS Web Service
- LS OpenAccess
If they are, and you're still not receiving events, confirm that event publishing is enabled by running the following query:
0 = Event publishing disabled
1 = Event publishing enabled
No Results = Event publishing enabled
Cannot connect to Open Access, receiving "request pool full" response
Open Access by default limits the number of requests it can handle in a queue to 32. The error response "request pool full" means we've already hit the limit of 32 and that Open Access cannot handle anymore requests. If this occurs, we can increase the request limit up to a maximum of 253, though a recommended increase would be to 128.
To increase the request pool limit, follow these steps:
- Create a new .INI file in this location: C:\ProgramData\Lnl\
- The name of the file should be: OpenAccess.ini
- The content of the file should be as follows:
- [http_request]
- request_pool_size=128
It is recommended to increase the request_pool_size value to 128 in order to solve this issue. After
changing this setting, restart the LS OpenAccess service in order for the changes to take effect.
Unable to perform GetConfig/Sync
If when performing a GetConfig or Sync, you are receiving no information back and the worker logs contain the following error:
System.Net.WebException: Unable to connect to the remote server ---> System.Net.Sockets.SocketException: No connection could be made because the target machine actively refused it IPADDRESS:PORT
This is because the SureView integration/Service server cannot reach the Lenel server. This can be:
- Firewall - Please ensure that the Lenel server is set to allow connections on that port
- Services not running
- To ensure the port is open, on the Lenel server run netstat -anb in command prompt, there should be an entry in the list for your port (this means that there is an application listening on that port).
- If there is not an entry in the list for your port - this means nothing is listening for the connection. Ensure the following Lenel services are running
- LS Communication Server
- LS Event Context Provider
- LS Web Event Bridge
- LS Web Service
- LS OpenAccess
- If there is not an entry in the list for your port - this means nothing is listening for the connection. Ensure the following Lenel services are running
- To ensure the port is open, on the Lenel server run netstat -anb in command prompt, there should be an entry in the list for your port (this means that there is an application listening on that port).
Enabling Custom Alarms
Custom alarms are disabled by default. To enable, update the alarm receiver config file with the following app setting:<add key="EnableCustomAlarmTypes" value="true"/>
Disabling System Alarms
System alarms are enabled by default. To prevent them from coming in, update the alarm receiver config file with the following app setting:<add key="RaiseSystemAlarms" value="false"/>
Comments
0 comments
Please sign in to leave a comment.