Avigilon System Integration Guide

Avigilon™ System Integration
Guide
for the Avigilon Control Center™ and Access Control Manager™
© 2014 - 2017, Avigilon Corporation. All rights reserved. AVIGILON, the AVIGILON logo, ACC, AVIGILON
CONTROL CENTER, ACCESS CONTROL MANAGER, ACM, and TRUSTED SECURITY SOLUTIONS are
trademarks of Avigilon Corporation. Other names or logos mentioned herein may be the trademarks of their
respective owners. The absence of the symbols ™ and ® in proximity to each trademark in this document or at all
is not a disclaimer of ownership of the related trademark. Avigilon Corporation protects its innovations with
patents issued in the United States of America and other jurisdictions worldwide (see avigilon.com/patents).
Unless stated explicitly and in writing, no license is granted with respect to any copyright, industrial design,
trademark, patent or other intellectual property rights of Avigilon Corporation or its licensors.
This document has been compiled and published covering the latest product descriptions and specifications.
The contents of this document and the specifications of the products discussed herein are subject to change
without notice. Avigilon Corporation reserves the right to make any such changes without notice. Neither
Avigilon Corporation nor any of its affiliated companies: (1) guarantees the completeness or accuracy of the
information contained in this document; or (2) is responsible for your use of, or reliance on, the information.
Avigilon Corporation shall not be responsible for any losses or damages (including consequential damages)
caused by reliance on the information presented herein.
Avigilon Corporation
avigilon.com
INT-ACM-G
Revision: 1 - EN
20171103
ii
Table of Contents
Introduction
Requirements
1
1
Licensing Notes
1
For More Information
1
Installation
2
Alarm Gateway Component Requirements
2
VidProxy Component Requirements
2
Installing the Integration
2
The Alarm Gateway Component
Configuration
4
4
Adding an Integration User in Avigilon Control Center Software
4
Adding Avigilon Control Center Alarms
4
Adding an Integration User in Access Control Manager
5
Configuring Alarms in the Access Control Manager
5
Alarm Gateway
6
Configuring Server Settings
6
Mapping Alarms
7
Backing Up Mapped Alarms
8
Restoring Mapped Alarms
8
Monitoring Alarms
9
Troubleshooting
9
Unable to Select an Access Control Manager Alarm
9
Configuration Tool Not Displaying Control Center Alarms
9
Mapped Avigilon Control Center Alarms Displayed as Unknown
10
Mapped Control Center Alarms Not Synchronized
10
Alarms Do Not Display in the ACC Client
10
The VidProxy Component
Configuration
12
12
Adding an Integration User in Avigilon Control Center Software
12
Adding the Control Center Server to the Access Control Manager
12
Adding Cameras to Doors and Inputs
13
Monitoring Video
13
Live and Recorded Video
14
Controlling Recorded Video
14
Controlling PTZ Cameras
15
iii
Selecting a Layout for a View
16
Maximizing and Restoring an Image Panel
16
Maximizing an Image Panel
16
Restoring an Image Panel
16
Troubleshooting
Integration Does Not Connect
16
16
iv
Introduction
The Avigilon™ system integration allows you to achieve a unified security through the use of the Alarm Gateway
component and the VidProxy component.
The Alarm Gateway component allows alarms triggered in the Avigilon™ Access Control Manager to be
monitored and recorded through the Avigilon™ Control Center software.
The VidProxy component allows you to see video and receive events from the Control Center system in the
Access Control Manager application.
Requirements
Vendor
Requirements
Avigilon
Control Center Server software 5.8 or later
Avigilon
Access Control Manager 5.8 or later
Avigilon integration executable file (5.8.4.13):
Avigilon
AvigilonAcmIntegration-5.8.4.13.exe
Access Control Manager license for the VidProxy component:
Avigilon
AC-SW-LIC-AVIGILON
NOTE: A license is not required to use the Alarm Gateway component.
Licensing Notes
l
l
The licenses for ACC6 client are SWR-0460A, SWR-0461A, 24C-ACC6-ENT.
For ACC the integration should work with any Standard or Enterprise edition system. The number of
camera channels does not make a difference to the integration.
For More Information
For more information about the procedures outlined in this guide, refer to the following specific software
documentation:
l
Avigilon Control Center Client User Guide
l
Avigilon Control Center Server User Guide
l
Avigilon™ Access Control Manager User Guide
Introduction
1
Installation
NOTE: If you are installing both Avigilon integration components, make sure all requirements are met.
Alarm Gateway Component Requirements
Before you install the Alarm Gateway component, make sure the Control Center Server and the Access Control
Manager software are installed on the same network. The Alarm Gateway component can be installed on any
workstation that is connected to the same network.
VidProxy Component Requirements
The VidProxy component must be installed on the same server as the Control Center Server software.
Installing the Integration
Both the Alarm Gateway component and the VidProxy component can be installed from the same installer.
By default, both components are automatically selected to install together. If the integration must be installed at
separate locations or if you only need one of the components, make sure you only install the component that is
required.
Installation
2
1. Run AvigilonAcmIntegration-5.8.4.13.exe.
2. Follow the prompts until you arrive at the following page:
l
AvigilonAcmGateway is the Alarm Gateway component.
l
AvigilonVidProxy is the VidProxy component.
3. Click the component that you do not want installed and select the Entire feature will be unavailable
option.
4. Complete the remaining prompts and finish the installation.
Installing the Integration
3
The Alarm Gateway Component
Configuration
Adding an Integration User in Avigilon Control Center Software
To protect the security of the Avigilon Control Center software, add a user in the ACC Client software
specifically for connecting the integration. The user you add will be used to connect the ACC system to the
Avigilon integration software. See the Avigilon Control Center Client User Guide for more details.
The integration user does not need any access permissions but must be added as a recipient to all Control
Center alarms or the alarm will not be listed in the gateway configuration tool.
NOTE: If the password for the ACC Client user is changed, you will need to restart the Alarm Gateway service in
order to see triggered alarms.
Adding Avigilon Control Center Alarms
Alarms are manually created in the Avigilon Control Center Client software. Create as many alarms as needed
for mapping in the gateway.
NOTE: The Control Center user that was created for the integration must be added as an alarm recipient or the
alarm will not be displayed in the gateway configuration application. For more information, see Adding an
Integration User in Avigilon Control Center Software above
1. In the ACC Client software, open the site Setup tab and click
2. In the Alarms dialog box, click
.
.
3. On the Select Alarm Trigger Source page, select External Software Event from the Alarm Trigger
Source: drop down list. Click
after you complete each page.
4. On the Select Linked Devices page, select the cameras to link to this alarm, and set the Pre-Alarm
Record Time: and Recording Duration:.
5. On the Select Alarm Recipients page, select the ACC software user that was added for the integration.
You can also add any other groups or users that need to be notified when this alarm is triggered.
6. (Optional) If you would like to trigger an action when an alarm is acknowledged, select Activate selected
digital output(s) on alarm acknowledgement check box.
a. Select the digital outputs to be activated and specify the duration.
b. Select Require user confirmation before activating digital output(s) check box if the user needs
to confirm the alarm before the digital output action is initiated.
7. Enter a name for the alarm and set the alarm priority. The alarm name is used to identify the alarm during
the integration.
8. Ensure Enable alarm check box is selected then click
The Alarm Gateway Component
.
4
Adding an Integration User in Access Control Manager
To protect the security of the Access Control Manager system, add a user specifically for connecting the
integration to the Access Control Manager software. See the Access Control Manager Help files for more
information.
The integration user must be delegated the following permissions to enable all integration features:
l
Identities Listing
l
Get Alarm Types For Device
l
Doors Listing
l
Panels Listing
l
Subpanels Listing
l
Inputs Listing
l
Outputs Listing
l
Alarm Monitor Acknowledge
l
Alarm Monitor Clear
This user will be used to connect the Access Control Manager system to the Alarm Gateway.
Configuring Alarms in the Access Control Manager
In the Access Control Manager software, alarms are events that have been assigned to an alarm event type.
By default, there are no alarm event types. So, you will need to set an existing event type to be an alarm or
create a new alarm event type.
1. In the Access Control Manager software, select Settings > Event Types.
2. From the Event Type Listing Page, perform any of the following:
l
To set an existing event type to be an alarm:
a. Select the event type you want to set as an alarm.
b. On the following page, select the Alarm check box.
c. Change any other settings as required.
d. Click Save.
l
To create a new alarm event type:
a. Click Add New Event Type.
b. On the following page, give the new event type a name and select the Alarm check box.
c. Set any of the other settings as required.
d. Click Save.
l
Repeat the previous procedures until you've set all the alarm event types that you need.
Any events that are assigned to the event type will now generate an alarm whenever it is triggered.
Adding an Integration User in Access Control Manager
5
3. To add events to the event type, perform the following:
a. Select Physical Access > Events.
b. From the Events Listing Page, select any event that you want to assign to the event type.
c. On the following page, set the Event Type option to be one of the configured alarm event types.
d. Make any other changes as required.
e. Click Save.
f. Repeat this procedure until all required events are assigned to the appropriate alarm event type.
Alarm Gateway
The Alarm Gateway is composed of two parts: a Windows service that runs automatically in the background, and
a Configuration Tool software that is used to map alarms between the two systems.
Configuring Server Settings
Configure the Alarm Gateway to access the two applications.
After you install the integration software, the Configuration Tool automatically opens the Configure Connections
window.
If you've installed the integration software before, this window is not automatically displayed. Your previous
settings are remembered and the main Configuration Tool window opens instead. In this case, click Configure
Connections to open the Configure Connections window.
In the Configure Connections window, add the details needed for the integration to access the Avigilon Control
Center system and the Avigilon Access Control Manager system.
Alarm Gateway
6
1. Click Add.
2. In the following dialog box, enter the Control Center server IP address, user name and password.
Use the user name and password that was created for the integration. See Adding an Integration User in
Avigilon Control Center Software on page 4.
3. In the ACM area, enter the Access Control Manager server details:
a. ACM Server IP: enter the Access Control Manager server IP address or hostname.
b. ACM Server Port: enter the server port number. This is the web server port number that is used to
connect to the ACM appliance. The default value is 443.
c. ACM Service Port: enter the service port number (6050). This is the port number that is used to
access diagnostics and system information from the ACM appliance - if left blank the alarm
gateway will not work. (Prior to the ACM 5.8.2 release the system automatically set the port.)
d. ACM User Name: enter your user name for the Access Control Manager server.
e. ACM Password: enter the password for the user name you entered.
4. Click Test Connection to confirm that the integration alarm gateway is able to communicate with both
systems.
5. Click Done. The Configuration Tool window is displayed.
The integration searches both software systems for alarms that can be mapped together.
If you need to add new Avigilon servers, or edit the server settings later, click Configure Connections in the
Configuration Tool window.
Mapping Alarms
In the Configuration Tool is a list of all the current alarm mappings, and all the available alarms from the Avigilon
Control Center software and the Avigilon Access Control Manager software.
If the Configuration Tool is not already open, select All Programs or All Apps > Avigilon > ACM to ACC Alarm
Gateway > ACM to ACC Alarm Gateway.
Mapping Alarms
7
To map alarms together, complete the following steps:
1. In the Avigilon area, select a Control Center alarm from the list.
Tip: Use the Search bar at the top of the list to find specific alarms.
2. In the ACM area, select the device commands that will trigger an alarm for the integration.
a. Device Type: select the type of device the alarm is related to.
b. Parent Panel and Parent Subpanel: if enabled, select the panel the device is connected to.
c. Device: select the specific device that will trigger the alarm. Devices are listed by their configured
name.
d. Alarm: select a specific alarm.
e. In the Identity area, select the specific user(s) that will trigger the alarm.
Tip: Select the Select All Identities check box if you want to automatically select all the current
identities and any identities that are added to the list later. If you only want to select the current
identities, do not select that check box.
3. Click >> to map the alarms together.
Tip: To see a list of all the identities that are linked to an ACM alarm, double-click the Identities cell of the
mapped alarm.
4. Repeat the previous steps until all the required alarms have been mapped.
5. Click Save and Apply. The integration alarm gateway is updated with all the new or changed mappings.
Backing Up Mapped Alarms
After you finish mapping all the alarms in the Configuration Tool, you can choose to back up a copy of the
mappings.
1. Navigate to C:\Program Files\Avigilon\ACM to ACC Alarm Gateway.
NOTE: The file path may be different depending on how your system is configured.
2. Copy and paste the AlarmConfig.xml file to a backup location.
Restoring Mapped Alarms
When you have a backup copy of the mapped alarms, you can restore the mapped alarms any time.
1. Locate your backup copy of the AlarmConfig.xml file.
2. Copy and paste the backup AlarmConfig.xml file into C:\Program Files\Avigilon\ACM to
ACC Alarm Gateway.
Allow Windows to overwrite the copy that is currently in the folder.
3. Open the integration Configuration Tool. The restored mappings should be displayed in the Alarm
Mappings list.
4. Click Save and Apply to update the integration alarm gateway and apply the alarm mapping changes.
Backing Up Mapped Alarms
8
Monitoring Alarms
Once the alarms have been mapped in the Alarm Gateway, you can begin monitoring alarms in either the
Avigilon Control Center software or the Avigilon Access Control Manager software.
Any alarm action in one systems will be reflected in the other. For example, when you acknowledge an alarm in
the Control Center Client software, the mapped alarm in the Access Control Manager software will be
acknowledged as well.
NOTE: Purged alarms in the Control Center Client software are the same as Cleared alarms in the Access Control
Manager software.
For more information about monitoring alarms in the Control Center Client software, see the Avigilon Control
Center Client User Guide.
For more information about monitoring alarms in the Access Control Manager software, see the Access Control
Manager Help.
Troubleshooting
If the following troubleshooting solutions do not resolve your issue, contact Avigilon Technical Support –
http://avigilon.com/support-and-downloads/.
Unable to Select an Access Control Manager Alarm
After you select all the Access Control Manager alarm details, you are unable to map the alarm to a Control
Center alarm.
This may occur if the Access Control Manager server is not connected to the integration. Try the following:
1. Make sure the Access Control Manager server is accessible on the network.
2. Open the Configuration Tool and click Configure Connections.
3. In the Configure Connections window, click Test Connection to see if the integration is able to
connection to the Access Control Manager server.
Configuration Tool Not Displaying Control Center Alarms
The Configuration Tool does not list any Control Center alarms even though the Avigilon Control Center Server
details were entered correctly in the Configure Connections window.
This issue may occur if there is a connection issue with the Control Center Server.
Check the following:
l
The Control Center Server software is running.
l
The Control Center Server is on the same network as the integration.
l
The Control Center user that was created for the integration was added to all the relevant alarms.
l
Double-check the IP address, user name and password used in the Configured Connections window.
Monitoring Alarms
9
Mapped Avigilon Control Center Alarms Displayed as Unknown
Mapped alarms in the Configuration Tool are labeled in red as “Unknown.” The Avigilon Control Center Server
that the integration is connected to displays an “Error” status in the Configure Connections dialog box.
This issue occurs if the Avigilon Control Center Server has rebooted or is offline.
Perform the following steps to ensure the integration functions correctly:
1. Check that the Avigilon Control Center Server is online and connected to the local network.
2. When the Avigilon Control Center Server is back online, open the Configuration Tool and click Configure
Connections.
3. If the Avigilon Control Center Server is online, the server status would be “Ready.” If it is not, check the
server connectivity again.
4. Close the Configure Connections dialog box. The Configuration Tool should now display the correct
alarm names.
5. Click Save and Apply to ensure the alarm mappings are active.
Mapped Control Center Alarms Not Synchronized
A mapped Control Center alarm is not triggered in the Control Center Client software even though the mapped
Access Control Manager alarm has been activated.
The Access Control Manager software displays the correct alarm state.
This issue may occur if the alarm gateway service was not started correctly.
1. In the Windows Services window (services.msc), restart the ACM to ACC Alarm Gateway Service. If it was
not running, start the service.
Alarms Do Not Display in the ACC Client
If an alarm does not display in Control Center follow the steps below:
1. If the following issues occur, navigate to the service and find alarm gateway service and restart it.
l
l
l
You cannot observe an alarm after reconfiguring ACC or ACM attributes in the alarm gateway
configuration tool.
"Alarmconfig.xml" might not be loaded on a machine which installs ACC and integration build at
the very first time.
If you merge two clusters on ACC the alarm gateway will not work.
2. If restarting the alarm gateway service doesn't work then uninstall integration build and reinstall it
(remember to uninstall both integration and SDK and install them both).
3. If none of the above work, then check the logs in "%programdata/avigilon/avigilonacm logs/%", see if
there is any dump file or any strange messages recorded in AvigilonAcmGateway.Root.log.
4. Other settings to double-check include:
l
That the correct ACC6 license has been used (e.g. SWR-0460A, SWR-0461A, 24C-ACC6-ENT).
Mapped Avigilon Control Center Alarms Displayed as Unknown
10
l
l
l
l
l
l
In the ACC6 alarm setting, make sure "Auto-acknowledge alarm immediately after it activates" is
unchecked.
Make sure the ACM server port is 443 and alarm gateway port (aka service port) is 6050.
Make sure the machine which installs ACC server and integration build has only one SDK version
installed. If you have both Avigilon 6 SDK and Avigilon 5.8.4.12 installed the integration build will
not work.
Make sure the ACC username/password doesn't contain unicode characters and make sure the
ACC user has the password.
Make sure not to merge ACC sites which have alarm gateway connecting to. Currently the Alarm
gateway might not work anymore after ACC sites are merged.
Remember to test the connection to ACM occasionally so that the Alarm gateway can get the
latest ACM configuration. Also remember to move ACC alarms from the alarm mapping list to the
alarm list on alarm gateway configuration tool everytime you change any settings. If necessary,
refresh the device type, device, event drop down lists and re-select them on alarm gateway
configuration tool everytime you change any settings.
Alarms Do Not Display in the ACC Client
11
The VidProxy Component
Configuration
Adding an Integration User in Avigilon Control Center Software
To protect the security of the Avigilon Control Center software, add a user in the ACC Client software
specifically for connecting the integration. The user you add will be used to connect the ACC system to the
Avigilon integration software. See the Avigilon Control Center Client User Guide for more details.
l
l
View Live Images
l
Use PTZ controls
l
Lock PTZ controls
View Recorded Video
The integration username and password is required to link the Control Center system with the Access Control
Manager system.
Adding the Control Center Server to the Access Control Manager
To use the VidProxy component, you must add the Control Center Server as an external system in the Access
Control Manager.
1. In the Access Control Manager application, select Settings > External Systems.
2. In the Avigilon tab, click Add New Avigilon Server.
3. In the Name field, give a name for the Control Center Server.
4. In the Address field, enter the IP address of the server where the integration is installed.
The default port number is 80, however we recommend using port 8080 instead of 80 as ACM might use
port 80. This might create conflicts between VidProxy and ACM if they share the same 80 port. Modify
the VidProxy port in VidProxy config file to 8080 or other available ports and then restart the VidProxy
service.
The VidProxy Component
12
NOTE: After you upgrade VidProxy from an earlier version to the latest version, you will need to
reconfigure the VidProxy config file to set default VidProxy port from 80 to 8080.
NOTE: For more detail on the VidProxy Port, see Integration Does Not Connect on page 16.
5. In the Remote Username and Remote Password fields, enter the Control Center username and password
created for the integration. See Adding an Integration User in Avigilon Control Center Software on the
previous page.
6. In the Local Username and Local Password fields, enter your username and password for the Access
Control Manager application.
7. Select the Installed check box.
8. Click Save.
A list of all the cameras that are connected to the Control Center Server is displayed.
When you return to the Avigilon Servers page, the new server is listed and the server status is Backend Up.
Adding Cameras to Doors and Inputs
Once the Control Center system has connected successfully with the Access Control Manager application, you
can add cameras to doors and inputs. See the Access Control Manager Help files for more information.
Monitoring Video
After the VidProxy component has been installed and configured, you can view video and camera events
through the Access Control Manager application.
Adding Cameras to Doors and Inputs
13
1. In the Access Control Manager application, select Monitor > Events.
2. In the Events list, select an event that displays a camera icon then perform one of the following:
l
Click Live Video to view the event’s live video stream.
l
Click Recorded Video to play back the recorded event video.
A new window opens to display the selected video.
If the video is blocked or the browser displays a warning message about opening insecure or mixed content,
you must configure your web browser to allow video to be displayed.
You can manually allow the browser to display video each time, or you can set the browser to allow insecure or
mixed content to be displayed. For more information, see the Help file for your web browser.
If the browser continues to not display video, contact Avigilon Technical Support: http://avigilon.com/supportand-downloads/
Live and Recorded Video
In the video player, you can choose to watch live or recorded video.
l
To switch between live and recorded video, click either Live or Recorded.
Controlling Recorded Video
To control recorded video, make sure the video player is displaying recorded video then do any of the
following:
Live and Recorded Video
14
l
To select a playback time, click on a point in the Timeline.
l
To start playback, click
.
l
To stop playback, Click
.
l
l
l
Click
to step forward one frame.
l
Click
to step backward one frame.
To zoom in or out on the Timeline, place your mouse over the Timeline and use the scroll wheel to zoom
in or out. You can zoom in to a quarter of a second, and zoom out to see years.
To pan the Timeline:
l
Click and drag the red time marker through the Timeline.
l
Right-click and drag the Timeline.
Controlling PTZ Cameras
If you have a pan, tilt, zoom camera connected to your system, you can control the PTZ camera by using the onscreen controls in the image panel.
NOTE: PTZ controls are only available when viewing live video.
To display the PTZ on-screen controls, click
l
.
In the image panel, drag your mouse from center to move the camera in that direction. The farther the
cursor is from the center of the image panel, the faster the camera will move.
Figure 1: PTZ On-screen Controls
l
If the camera supports Click to Center, click anywhere in the image panel to center the camera at that
Controlling PTZ Cameras
15
point.
l
If the camera supports Drag to Zoom, click and drag on the image panel to create a green box to define
the area you want to zoom in and see.
Selecting a Layout for a View
You can organize how video is displayed by selecting a View layout.
l
On the toolbar, select
, then select one of the layout options.
Maximizing and Restoring an Image Panel
If you have more than one image panel displaying video, you can maximize an individual image panel to enlarge
the video display.
Maximizing an Image Panel
Do one of the following:
l
Inside the image panel, click
l
Double-click the image panel.
.
Restoring an Image Panel
In a maximized image panel, do one of the following:
l
Inside the image panel, click
l
Double-click the image panel.
.
Troubleshooting
If the following troubleshooting solutions do not resolve your issue, contact Avigilon Technical Support –
http://avigilon.com/support-and-downloads/.
Integration Does Not Connect
After adding the Control Center Server to the Access Control Manager application, the integration fails to
connect and cameras are unavailable. In some cases, the Avigilon Servers page displays the server with this
status: Backend Down.
Check the following:
Selecting a Layout for a View
16
l
In the Access Control Manager, the Avigilon Server is set to use port 80 and the ACM appliance is set to
use 443 as the Web Server Port.
l
If one or both ports are set to use a different port number, you will need to change the port number
in the integration configuration file.
a. Open the AvigilonVidProxy.exe.Config file in a text editor. This file is typically
located here: C:\Program Files\Avigilon\Avigilon
VidProxy\AvigilonVidProxy.exe.Config
b. To change the Avigilon Server port, locate this line:
<add baseAddress=”http://localhost:80” />
Replace 80 with the preferred port number.
The recommended steps for setting the VidProxy port are:
i. Check whether port 80 is used by any services because 80 is our default VidProxy
port setting - port 80 is always used by other services.
ii. Filter out all the used ports and fetch all the unused ports. Pick any one of them such
as port A.
iii. Navigate to Windows firewall inbound rule setting in order to open port A. It is better
to provide a distinct name for this inbound rule such as VidProxy.
iv. Change the VidProxy port to port A in ACM Avigilon external system configuration.
v. Modify the VidProxy port in the VidProxy config file.
vi. Restart the VidProxy service.
c. To change the appliance Web Server Port, locate this line:
<add key="AcmServerPort" value="443" />
Replace 443 with the preferred port number.
d. Save the file and restart the Avigilon VidProxy Windows service. In the Services window
(services.msc), locate Avigilon VidProxy and click Restart.
l
Avigilon VidProxy Windows service is started.
If the service will not start, the issue may be because the integration port number is already used by a
different program. Change the port number used in the Access Control Manager and in the
AvigilonVidProxy.exe.Config file.
l
Control Center Server is running.
l
Make sure the connection is not blocked by a firewall.
Integration Does Not Connect
17
Download PDF