This example shows ICPAM integration to VSM 7.12
Principal of operation:
Steps for integration:
In this example, the VSOM server IP address is 192.168.0.60 with hostname vsom4cpam. For ICPAM, the server IP address is 192.168.0.50. Use the hostname and IP address assigned in your deployment.
tail -f /usr/BWhttpd/logs/vsom_be/sensor_be.log
Here is a screenshot of VSOM and ICPAM illustrating an incoming ICPAM trigger that was from a GRANT ACCESS command to a door and that door was not opened, resulting in the log code GW.EV_DOOR_NOT_USED. That log code is highlighted on both sides.
With communications established, the rest of the configuration is from VSOM.
After establishing sensor connectivity between VSOM and ICPAM comes the step to identify sensor types and states that you wish to represent and integrate into VSOM.
Sensor integration in VSOM requires two parameters, a Sensor Unique ID and one or more Sensor States.
In integrating access control sensors into VSOM, like those managed by an application like ICPAM, one useful integration is monitoring a DOOR (Sensor) and tracking door ALARMS (Sensor States), e.g. Door Forced Open, Door Held Open.
Using the ICPAM PC client, in ICPAM REPORTS section, you can export both types of information to use for Sensor Unique ID and Sensor States in VSOM.
For Door’s unique Identifier (UNID) that will be used as the Sensor Unique ID, use the vx_dev report (under More Cisco Templates) under Reports.
Screen shot of VXDEV selection
Run the report which you can export in a variety of formats for reference. Here is a screenshot with the Door UNID (highlighted) that can be used as a Sensor Unique ID in VSOM.
VXDEV report, highlighting the Door1 UNID, “e149D70dSKOePQ+9HaijRg==”
To get a full report of LOG CODES used in ICPAM, use the vx_logcode_cat_member report (under More Cisco Templates)
Screenshot of VXLOGCODE
This will produce a long report (over 1000 lines). Exporting this report out to a CSV format is more useful as a reference. The log codes appear in the column with the heading “elt” in the report. The log codes beginning with GW.EV include the type of codes that ICPAM will report to VSOM as the state change occurs. Other log codes (not beginning with GW.EV) are not reported externally from ICPAM.
Note: Not all event log codes shown in the Report are used or even reported in ICPAM Events! Most, but not all, of GW.EV log codes reported via ICPAM Events will be reported externally, sometimes requiring double-checking on VSOM sensor log files to see what is transmitted as an event. However, to monitor what is actually logged in the Events window in the ICPAM application, you can add a LOG CODES column to the EVENTS windows (under Events & Alarms > Monitoring > Events).
Screenshot of Events with added “Log Code” column
In the screenshot above, log codes such as GW.EV_DOOR_MODE_CHANGED_BY_CMD, GW.EV_DOOR_FORCED_OPEN, and GW.EV_DOOR_FORCED_OPEN_CLEAR, and will be reported outbound from ICPAM for the door action – others will not.
Some useful log codes for DOOR state monitoring from ICPAM include:
Door forced Open: GW.EV_DOOR_FORCED_OPEN
Door Held Open: GW.EV_DOOR_HELD_OPEN
These door states are alarm conditions that would be useful to track in VSOM and to have a camera(s) and recordings associated with the events.
Configuring Sensor information in VSOM – ICPAM example
So far we introduced the baseline preparation for sensor event communication between ICPAM and VSOM and discussed methods for compiling the Sensor Unique ID and the relevant Sensor States from ICPAM to track in VSOM. Now comes the VSOM sensor setup steps.
The sequence of Sensor configuration in VSOM requires three steps:
The DOOR STATES communicated in ICPAM are identified by LOG CODES. You can see LOG CODES by adding a COLUMN to the EVENTS windows (under Events & Alarms > Monitoring > Events).
Default Events Panel
Adding a column – add a check box to Log Code
Events displaying log codes
In ICPAM access control application, typically the DOOR is the entity that you need to monitor. The door state of interest here would be the Door Forced Open or GW.EV_DOOR_FORCED_OPEN which is the state in VSOM that is going to be tracked. Earlier we had shown how to get the unique door ID.