Avigilon Control Center 5
System Integration Guide
with SYSTIMAX iPatch System
INT-IPATCH-A-Rev1
© 2014 — 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, CAPTURE IT WITH CLARITY, HDSM, HIGH DEFINITION STREAM MANAGEMENT (HDSM), THE BEST
EVIDENCE and LIGHTCATCHER are unregistered and/or registered trademarks 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.
Avigilon
Tel +1.604.629.5182
Fax +1.604.629.5183
http://www.avigilon.com
INT-IPATCH-A: 2014-01-23
Revision: 1
Table of Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
For More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Adding an Integration User in Avigilon . . . . . . . . . . . . . . . . . . 2
Adding Alarms to the Avigilon Control Center System . . . . . 2
Creating Bookmarks for Every Alarm Video . . . . . . . . . . . . . . 3
Configuring Event Notification Profiles
for SYSTIMAX iPatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Using the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Searching for Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Searching for Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
CommScope System Events Not Triggering Avigilon Alarms 7
Avigilon Control Center 5 System Integration Guide with CommScope
Introduction
The Avigilon iPatch integration allows you to monitor any CommScope iPatch system
events in the Avigilon Control Center. You can link the CommScope system events with
alarms in the Avigilon Control Center and record video of the alarm events.
Requirements
Vendor Requirements
Avigilon Control Center Server Software 5.0 and later.
Avigilon Avigilon iPatch integration exe file:
AvigilonIPatchClient.exe
The file can be downloaded at
http://avigilon.com/support-and-downloads/
for-software/integration-and-plug-in-downloads/
CommScope SYSTIMAX iPatch 7.0 and later.
For More Information
For more detailed information about the procedures outlined in this guide, refer to the
specific software documentation.
• Avigilon Control Center Client User Guide
• Avigilon Control Center Server User Guide
• The SYSTIMAX iPatch System Manager User’s Guide
1
Installation
Server
• Install the integration on the same server as the SYSTIMAX iPatch System
Manager software.
• Install the Avigilon Control Center Server software on any server on the same
network as the SYSTIMAX iPatch System Manager software.
Client
• Install the Avigilon Control Center Client software on the computers that
require access to the integration.
Avigilon Control Center 5 System Integration Guide with CommScope
Configuration
Adding an Integration User in Avigilon
To protect the security of the Avigilon Control Center Server, add a user to the Avigilon
software specifically for connecting to the integration. See the Avigilon Control Center
Client User Guide for details about how to add users.
This user does not need any access permissions, only a username and password is
required to join the integration together.
Adding Alarms to the Avigilon Control Center System
1. In the Avigilon Control Center Client software, open the Site Setup tab and
click Alarms.
2. In the Alarms dialog box, click Add.
3. On the Select Alarm Trigger Source page, select External Software Event from
the Alarm Trigger Source drop down list and click Next.
2
Avigilon Control Center 5 System Integration Guide with CommScope
5. On the Select Linked Cameras page, select the cameras to link to this alarm,
and set the Pre-Alarm Record Time and the Recording Duration. Click Next.
6. Select the groups or users who should receive alarm notifications, then click
Next.
7. (Optional) If you would like to trigger an action when an alarm is
acknowledged, select the Activate selected digital output(s) on alarm
acknowledgement check box.
a. Select the digital outputs to be activated and specify the duration.
b. Select the Require user confirmation before activating digital output
check box if users need to confirm the alarm before the digital output
action is initiated.
c. Click Next.
8. Enter a Name for the alarm and set the alarm Priority. Be aware that the name
is case sensitive.
NOTE: The alarm name is used to identify the alarm during the integration. It is
recommended that you enter a name that will help you identify the details of the
alarm.
9. Ensure the Enable Alarm check box is selected and click Finish.
Creating Bookmarks for Every Alarm Video
Setup a rule that will automatically create a video bookmark whenever an alarm is
triggered.
1. In the Avigilon Control Center Client software, open the Site Setup tab and
click Rules.
2. In the Rules dialog box, click Add.
3. On the Select Rule Event page, select Alarm triggered under Alarm Events.
4. In the Rule summary box at the bottom half of the page, click any alarm.
5. In the following dialog box, select the alarm you created in Adding Alarms to
the Avigilon Control Center System on page 2.
6. Click Next.
7. In the Select Rule Action page, select Create Bookmark.
8. In the Rule summary box, define the bookmark details.
9. Click Next.
3
Avigilon Control Center 5 System Integration Guide with CommScope
10. Give the rule a name and schedule when it will be active.
By default, the bookmark created by this rule will automatically be given the
same name as the rule.
11. Click Finish.
Every time the alarm is triggered, a bookmark of the linked video is added to the Avigilon
Control Center system. To help identify a specific bookmark, it is recommended that you
rename the bookmark as soon as possible.
To add or change details in the bookmark, you will need to edit the bookmark manually.
This includes changing the bookmark name, adding pre-recorded video to the bookmark
and adding comments about the bookmarked event. For more information, see the
Avigilon Control Center Client User Guide.
Configuring Event Notification Profiles for SYSTIMAX iPatch
Configure as many Event Notification Profiles as needed for the Avigilon Control Center to
record and track SYSTIMAX iPatch events.
1. In the CommScope imVision System Manager, select Administration >
Optional Event Settings.
2. In the Optional Events list, select the check box for the following options:
o Generate Priority Events for Unscheduled Connections Between
Service Ports
o Track Button Presses
3. Open the Event Notification Profiles page and click +.
4. Give the new profile a name.
5. On the following page, select all the iPatch system events you want to include
in this Event Notification Profile.
6. Next, select the appropriate rack locations.
7. On the Select Notification Method page, select the Execute Local Server
Program check box then click the Pencil icon and select
AvigilonIPatchClient.exe.
The AvigilonIPatchClient.exe is typically located at C:\Program
Files\Avigilon\Avigilon IPatch Gateway\
4
Avigilon Control Center 5 System Integration Guide with CommScope
8. In the Program Parameters field, enter the following parameters:
<IP Address> <Port> <Username> <Password> <Alarm Name> <Alarm Message>
For example:
127.0.0.1 38880 iPatchUser “” Rack1 “Rack 1 warning!”
NOTE: All parameters are required. If a parameter uses spaces, wrap the parameter in
quotation marks or each word is read as a separate parameter. If a parameters is
blank, enter two quotation marks (like “”).
o IP Address: the IP address of any Avigilon Control Center Server within
the Site.
o Port: Avigilon Control Center Server port number. The default port
number is 38880.
o Username / Password: The username and password that was created
for the integration. For more information, see Adding an Integration
User in Avigilon on page 2.
o Alarm Name: Enter the name of the alarm that was created for the
integration. For more information, see Adding Alarms to the Avigilon
Control Center System on page 2.
o Alarm Message: Enter a message that would be sent with the alarm.
9. Click the Check Mark icon at the top of the screen to save the Event
Notification Profile.
10. Repeat this procedure until you’ve added all the iPatch system event
combinations that are required.
Using the Integration
After the integration has been installed and configured, you can monitor SYSTIMAX iPatch
system events through the Avigilon Control Center Client software. For more information
about monitoring alarms, see the Avigilon Control Center Client User Guide.
Searching for Alarms
To quickly find an incident that triggered the alarm you created for the integration, you can
simply perform an Alarm Search.
5
Avigilon Control Center 5 System Integration Guide with CommScope
1. In the Avigilon Control Center Client software, select
> Search
2. In the Search: Alarms tab, select an alarm from the left pane.
3. Set the time range of the search.
4. Click Search.
The search results are displayed in a list on the right. Select a search result to see the
recorded video. For more information about the Alarm Search, see the Avigilon Control
Center User Guide.
Searching for Bookmarks
To quickly find a bookmarked incident, you can simply perform a Bookmark Search.
If you have been updating new bookmarks with relevant names and event details, this
search will be most efficient in helping you find specific incidents. However, if all the
bookmarks have the default name generated by the rule that was created in Creating
Bookmarks for Every Alarm Video on page 3, you may find it harder to locate specific
incidents.
1. In the Avigilon Control Center Client software, select
>
2. In the Search: Bookmark tab, a list of all the available bookmarks are listed on
the left.
3. In the Search field, enter any text that may appear in the bookmark's title,
description or linked camera name.
The search is automatically performed on all the listed bookmarks until only the matches
are displayed. For more information about Bookmark Search, see the Avigilon Control
Center User Guide.
6
Avigilon Control Center 5 System Integration Guide with CommScope
Troubleshooting
If the following troubleshooting solutions do not resolve your issue, contact Avigilon
Technical Support – http://avigilon.com/support-and-downloads/
CommScope System Events Not Triggering Avigilon Alarms
When an event is generated by the CommScope imVision System Manager, the related
Avigilon Control Center alarm is not triggered. If the alarm is not triggered, video is not
recorded or bookmarked.
Perform the following steps to confirm if the integration was configured correctly:
1. Log in to the Avigilon Control Center Client software.
2. Open command prompt and run the integration executable
(AvigilonIPatchClient.exe) with the same Program Parameters used to
configure the System Event Profile in the imVision System Manager. For more
information, see Configuring Event Notification Profiles for SYSTIMAX iPatch
on page 4.
3. Observe the command output.
o If the command output says “Activating Alarm "My Alarm":
success
imVision System Manager may not have been set up correctly. Skip to
step 4.
o If the command output says “Activating Alarm "My Alarm":
success
• Check if the Avigilon alarm was set up to notify the appropriate users.
• Check if you are logged in as one of the users the alarm is supposed to
notify.
o If the command output says “
• Check if the Avigilon alarm name is entered correctly in the imVision
System Manager. Alarm names are case sensitive. If the alarm name
contains one or more spaces, the name must be wrapped in quotation
marks or each word in the alarm name is read as a separate parameter.
• Check that the
Services.msc window, locate AvigilonIPatchGateway in the list and
click Start. If it is already running, you can try clicking Restart.
” and you are able to see the alarm in the Avigilon software, the
” but you did not see any alarms in the Avigilon software:
AvigilonIPatchGateway service is running. In the
Acitvating Alarm “My Alarm”: fail”:
4. In the imVision System Manager, open the site Event Log.
7
Avigilon Control Center 5 System Integration Guide with CommScope
o If the log does not show the event that is meant to trigger an alarm in
the Avigilon software, see the System Manager User Guide for possible
troubleshooting steps.
o If the log shows the event that is meant to trigger an Avigilon alarm:
• Check if the event has an Event Notification Profile. If not, complete the
steps described in Configuring Event Notification Profiles for
SYSTIMAX iPatch on page 4.
• Check if the Event Notification Profile has the correct Event Type and
Location.
• Check if the Event Notification Profile has been setup correctly to
communicate with the integration. For more information, see
Configuring Event Notification Profiles for SYSTIMAX iPatch on page 4.
•The Execute Local Server Program check box must be selected.
•The path to the integration executable must be correct
•The Program Parameters must be correct.
8
Loading...