Avigilon™ System
Integration Guide
for the Avigilon Control Center and Access Control
Manager
© 2014 Avigilon Corporation. All rights reserved. Unless expressly granted 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.
AVIGILON is a registered and/or unregistered trademark of Avigilon Corporation in Canada and other
jurisdictions worldwide. Other product names mentioned herein may be the unregistered and/ or registered
trademarks of their respective owners. ™ and ® are not used in association with each trademark in this document.
This manual has been compiled and published covering the latest product descriptions and specifications. The
contents of this manual and the specifications of this product are subject to change without notice. Avigilon
reserves the right to make changes without notice in the specifications and materials contained herein and shall
not be responsible for any damages (including consequential) caused by reliance on the materials presented,
including but not limited to typographical and other errors relating to the publication.
Avigilon Corporation
http://www.avigilon.com
Revised: 2014-07-28
INT-ACM-B
ii
Table of Contents
Introduction 1
Requirements 1
For More Information 1
Installation 2
Alarm Gateway Component Requirements 2
VidProxy Component Requirements 2
Installing the Integration 2
The Alarm Gateway Component 4
Configuration 4
Adding an Integration User in Avigilon™ Control Center 4
Adding an Integration User in Access Control Manager 4
Adding Avigilon Control Center Alarms 4
Alarm Gateway 5
Configuring Server Settings 5
Mapping Alarms 7
Backing Up Mapped Alarms 8
Restoring Mapped Alarms 8
Monitoring Alarms 8
Troubleshooting 8
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 9
Mapped Control Center Alarms Not Synchronized 9
The VidProxy Component 11
Configuration 11
Adding an Integration User in Avigilon™ Control Center 11
Adding the Control Center Server to the Access Control Manager 11
Adding Cameras to Doors and Inputs 13
Monitoring Video 13
Troubleshooting 14
Integration Does Not Connect 14
iii
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.0 or later
Avigilon Access Control Manager 5.0 or later
Avigilon integration executable file:
Avigilon
AvigilonAcmIntegration.exe
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
1 Introduction
Installation
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.
1. Run AvigilonAcmIntegration.exe.
2. Follow the prompts until you arrive at the following page:
Installation 2
l AviglonACMGateway 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.
3 Installing the Integration
The Alarm Gateway Component
Configuration
Adding an Integration User in Avigilon™ Control Center
To protect the security of the Avigilon™ Control Center system, add a user in the Avigilon™ Control Center Client
software specifically for connecting the integration. The user you add will be used to connect the Avigilon
Control Center 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.
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.
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 above
1.
In the Avigilon™ Control Center Client software, open the Site Groups tab and click .
2.
In the Alarms dialog box, click .
The Alarm Gateway Component 4
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 Cameras 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 Control Center 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 .
Alarm Gateway
The Alarm Gateway is composed of two parts: the Windows service that runs automatically in the background,
and the 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.
5 Alarm Gateway
If you've installed the integration software before, this window is not automatically displayed. Your previous
settings are remembered and the main ConfigurationTool window opens instead. In this case, click Configure
Connections to open the Configure Connections window.
In the ConfigureConnections window, add the details needed for the integration to access the Avigilon Control
Center system and the Avigilon Access Control Manager system.
1. Click Add.
2. In the following dialog box, enter the Control Center erver IP address, user name andpassword.
Use the user name and password that was created for the integration. See Adding an Integration User in
Avigilon™ Control Center on page4.
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 Serve r Port: enter the server port number. The default value is 443
c. ACM User Name: enter your user name for the Access Control Manager server.
d. 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.
Configuring Server Settings 6
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.
To map alarms together, complete the following steps:
1. In the Avigilon area, select a Control Center alarm from the list.
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 Se lect 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.
7 Mapping Alarms
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.
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/
Backing Up Mapped Alar ms 8
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 ConfigureConnections 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.
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 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.
9 Unable to Select an Access ControlManager Alarm
1. In the Windows Services window (services.msc), restart the ACM to ACC Alarm Gateway Service. If it was
not running, start the service.
Mapped Control Center Alarms Not Synchronized 10
The VidProxy Component
Configuration
Adding an Integration User in Avigilon™ Control Center
To protect the security of the Avigilon™ Control Center system, add a user in the Avigilon™ Control Center Client
software specifically for connecting the integration. The user you add will be used to connect the Avigilon
Control Center system to the Avigilon™ integration software. See the Avigilon Control Center Client User Guide
for more details.
l View Live Images
l Use PTZ controls
l Lock PTZ controls
l 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 Se rver.
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.
5. The default port number is 80.
6. 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 above.
11 The VidProxy Component
7. In the Local Username and Local Password fields, enter your username and password for the Access
Control Manager application.
8. Select the Installed check box.
9. 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 the Control Center Server to the Access Control Manager 12
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.
1. In the Access Control Manager application, select Monitor > Events.
2. In the Events list, select an event then perform one of the following:
l Click Recorded Video to play back the recorded event video.
l Click Camera to view the event’s live video stream.
A new window opens to display the selected video. For more information about controlling video, see the
Access Control Manager Help.
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/support-
and-downloads/
13 Adding Cameras to Doors and Inputs
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:
l In the Access Control Manager, the Avigilon Server is set to use port 80.
l If it is 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. Locate this line: <add baseAddress=”http://localhost:80” />
c. Replace 80 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.
l 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
Troubleshooting 14
Loading...