Avigilon Control Center System
Integration Guide
with GE Facility Commander Wnx
INT-GE-C-Rev3
Copyright © 2013 Avigilon. All rights reserved.
No copying, distribution, publication, modification, or incorporation of this document, in whole or part, is
permitted without the express written permission of Avigilon. In the event of any permitted copying,
distribution, publication, modification, or incorporation of this document, no changes in or deletion of author
attribution, trademark legend, or copyright notice shall be made. No part of this document may be reproduced,
stored in a retrieval system, published, used for commercial exploitation, or transmitted, in any form by any
means, electronic, mechanical, photocopying, recording, or otherwise, without the express written permission
of Avigilon.
GE and the GE monogram are registered trademarks of the General Electric Company.
Facility Commander Wnx is a registered trademark of GE Security.
Avigilon has made every effort to identify trademarked properties and owners on this page. All brands and
product names used in this document are for identification purposes only and may be trademarks or
registered trademarks of their respective companies.
Avigilon
Tel +1.604.629.5182
Fax +1.604.629.5183
http://www.avigilon.com
Revised 2013-2-27
Table of Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
For More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Checking the License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Creating an API Connection in FCWnx . . . . . . . . . . . . . . . . . . . . . . . . . 3
Adding an Integration User in Avigilon . . . . . . . . . . . . . . . . . . . . . . . . . 4
FCWnx Alarm Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Avigilon Alarm Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Avigilon FCWnx Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Configuring Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Mapping Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Backing Up Mapped Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Restoring Mapped alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Monitoring Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
FCWnx Alarms Do Not Appear in the Gateway . . . . . . . . . . . . . . . . . 10
No Response from Mapped Avigilon Alarm . . . . . . . . . . . . . . . . . . . . 10
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
Introduction
The GE Facility Commander Wnx® (FCWnx) and Avigilon Control Center software integration
allows for the two systems to combine alarm monitoring abilities.
Integrations with FCWnx 7.0 enables alarms created in one software to be monitored in both.
While integrations with FCWnx 7.5 enables alarms triggered in FCWnx to activate response
actions in the Avigilon Control Center.
Requirements
Vendor Requirements
Avigilon Control Center Server Software 4.0.2.4 or later
Avigilon Avigilon Third Party Integration License:
ACC-GEFCWNX-NVR
Avigilon Avigilon FCWnx Gateway software integration:
Avigilon FcWnx Gateway.exe
The file can be downloaded at
http://avigilon.com/#/support-and-downloads/forsoftware/integration-and-plug-in-downloads/
GE Facility Commander Wnx 7.0 or 7.5
GE FCWnx API Connectivity License:
WXSWOPT-001APC
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
• Facility Commander Wnx User Manual
1
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
Installation
Server
Install the following on any server in your network. Only the FCWnx API software and the Avigilon
FCWnx Gateway software integration need to be installed on the same server:
1. The Facility Commander Wnx Server software.
2. The Avigilon Control Center Server software.
3. The FCWnx API software
4. The Avigilon FCWnx Gateway software integration
Client
Install the following as needed:
• Install the Facility Commander Wnx Client software on the computers that require
access to the FCWnx system
• Install the Avigilon Control Center Client software on the computers that require
access to the Avigilon Control Center System
Checking the License
After you have installed all the required software, check that the licenses were properly applied.
To check the Avigilon Third Party Integration License (ACC-GEFCWNX-NVR):
1. Open the Avigilon Control Center Admin Tool.
2. Select the Settings tab and click Licensing. The License Activation dialog box
appears.
The dialog box must say Integration Connections: Yes or the software was not properly
licensed.
To check the FCWnx API Connectivity License (WXSWOPT-001APC):
1. In the FCWnx software, select Help > About this application.
2. Ensure the license appears in the application details.
2
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
Configuration
The Avigilon FCWnx Gateway software is used to direct alarm communication between the
Facility Commander Wnx and Avigilon Control Center software. Configure the two applications
for their connection to the Avigilon FCWnx Gateway software.
Creating an API Connection in FCWnx
Add the Avigilon FCWnx Gateway to the FCWnx Server software as an API connection so the
Avigilon FCWnx Gateway software is able to communicate with the FCWnx software.
If the Avigilon FCWnx Gateway is not installed on the same server as the FCWnx Server
software, add the Avigilon FCWnx Gateway as a client in the FCWnx Server software before
completing the following procedure.
1. In the FCWnx Server software, select the Gateways & Interface tab.
2. In the API Connection Window, click Add. The new API Connection screen appears
3. In the Description field, enter a name that will help you identify the Avigilon FCWnx
FCWnx Gateway configuration application software.
4. Enter a new Application Login and Password for the API connection.
5. Select the PC Name from the drop down list. Ensure the PC Name matches the name
of the server where the Avigilon FCWnx Gateway is installed.
6. Click Save.
3
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
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 must have the following permissions to enable all the integration features:
• View Live Images
The Avigilon FCWnx integration user name and password is required to add Avigilon Servers to
the Avigilon FCWnx Gateway configuration application.
FCWnx Alarm Configuration
Alarms in FCWnx are automatically created when controllers and devices are added to the
FCWnx network. If required, alarms can be configured to meet your needs. See the alarms
configuration section in the Facility Commander Wnx User Manual for more information.
If the integration is with FCWnx 7.0, you can also create API alarms to allow for bidirectional
alarm monitoring with the Avigilon Control Center. Non-API alarms can only be triggered through
FCWnx.
Avigilon Alarm Configuration
Alarms are manually created in the Avigilon Control Center Client software. Create the Avigilon
alarms you want mapped to the alarms in the FCWnx software, then assign the required cameras
and settings for the alarm.
If you are configuring the integration to use API alarms in FCWnx 7.0, you can select any Alarm
Trigger Source in step 4 and are not limited to External Software Events. See the Avigilon Control
Center Client User Guide for more information on how to configure other types of alarms.
1. In the Avigilon Control Center Client software, select Tools > Setup then select the
Avigilon Server to define the alarm on.
2. On the server Setup dialog box, click Alarms.
3. On the Add Alarm dialog box, click Add.
4. On the Select Alarm Trigger Source page, select External Software Event from the
Alarm Trigger Source drop down list and click Next.
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.
4
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
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. The alarm name is used to
identify the alarm during the integration.
9. Ensure the Enable Alarm check box is selected and click Finish.
5
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
Avigilon FCWnx Gateway
The Avigilon FCWnx Gateway is composed of two parts: the Avigilon FCWnx Gateway Windows
service that runs automatically in the background, and the Avigilon FCWnx Gateway
configuration application that is used to configure the connection and alarm mappings between
the Facility Commander Wnx and the Avigilon systems.
NOTE: Whenever the Avigilon FCWnx Gateway configuration application is opened, the Avigilon
FCWnx Gateway service is stopped.
If a mapped alarm is activated while the configuration application is open, the alarm will only
appear in the application that detected the alarm.
Configuring Server Settings
Configure the Avigilon FCWnx Gateway to access the two applications.
The Avigilon FCWnx Gateway configuration application remembers the server configuration, so
you do not need to repeat this procedure if the settings remain the same.
1. Open the Avigilon FCWnx Gateway software. Start > All Programs > Avigilon >
Configure Avigilon FCWnx Gateway.
2. Complete the following fields:
• FC Wnx User Name: enter the Application Login name you created in the FCWnx
configuration. See Creating an API Connection in FCWnx on page 3
• FC Wnx Password: enter the password you created in the FCWnx configuration.
See Creating an API Connection in FCWnx on page 3
6
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
• SQL Server Instance: enter the FCWnx database:
<server name>\<instance name>
• SQL Server User Name: enter your username for the FCWnx database.
• SQL Server Password: enter your password for the FCWnx database.
3. Click Add to add the Avigilon Server.
4. In the dialog box, enter the Avigilon Server IP Address, User Name and Password,
then click OK.
Use the username and password created in the Avigilon configuration. See Adding an
Integration User in Avigilon on page 4.
5. Click OK.
The Avigilon FCWnx Gateway searches both software systems for alarms that can be mapped
together.
. The default instance name is SPSQL.
Mapping Alarms
1. Open the Avigilon FCWnx Gateway configuration application.
2. Confirm that the server configurations are correct then click OK.
3. In the Facility Commander Wnx Alarms pane and the Avigilon NVR Alarms pane,
select the alarms to be linked.
7
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
4. Click Add Mapping.
5. Repeat step 3 and 4 until all the alarms you require are mapped.
6. Click Save.
Backing Up Mapped Alarms
After you finish mapping all the alarms in the Avigilon FCWnx Gateway, you can choose to back
up a copy of the mappings.
1. Navigate to C:\Program Files\Avigilon\Avigilon FCWnx Gateway\.
NOTE: The filepath may be different depending on how your system is configured.
2. Copy and paste the GatewayParams.xml file to a back up location.
Restoring Mapped alarms
When you have a backup copy of the mapped alarms, you can restore the integration to use the
back up copy any time.
1. Open the Avigilon FCWnx Gateway configuration application to stop the Gateway
Windows service.
2. Locate your backup copy of the GatewayParams.xml file.
3. Copy and paste the backup GatewayParams.xml file into the C:\Program
Files\Avigilon\Avigilon FCWnx Gateway\ folder.
Allow Windows to overwrite the copy that is currently in the folder.
4. Close the Avigilon FCWnx Gateway configuration application to start the Gateway
Windows service.
5. To check if the mapped alarms were restored correctly, open the Avigilon FCWnx
Gateway configuration application again.
8
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
Monitoring Alarms
Once the alarms from Facility Commander Wnx and Avigilon Control Center have been mapped
in the Avigilon FCWnx Gateway, you can begin to use the integration.
When an FCWnx alarm is triggered, it will activate the mapped Avigilon alarm and the configured
alarm actions are started.
• To monitor alarms in the FCWnx software, see the alarm monitoring section of the
Facility Commander Wnx User Manual.
• To review alarm video in the Avigilon Control Center software, see the alarm search
section of the Avigilon Control Center Client User Guide.
If the API alarms in FCWnx 7.0 are used in the integration, alarms triggered in one software will
appear in the other. It will be possible to monitor and acknowledge the alarms in either software.
• To monitor alarms in the Avigilon Control Center software, see the alarm monitoring
section of the Avigilon Control Center Client User Guide.
9
Avigilon Control Center System Integration Guide with GE Facility Commander Wnx
Troubleshooting
This section contains solutions to issues that may appear in the Avigilon FCWnx integration. If
the suggested solutions do not resolve your issue, contact Avigilon Support at
support@avigilon.com.
FCWnx Alarms Do Not Appear in the Gateway
If the Avigilon FCWnx Gateway service does not connect to the FCWnx software and the FCWnx
alarms do not appear in the gateway configuration application, the integration may have been
unsuccessful. Confirm the following then attempt to map alarms again:
• Ensure alarms have been created in the FCWnx software.
• Ensure the required licenses were applied.
• Ensure the FCWnx API software was installed.
• Ensure the Avigilon FCWnx Gateway was added to the FCWnx Server software as an
API Connection correctly.
• Ensure all usernames and passwords were entered correctly.
No Response from Mapped Avigilon Alarm
If a mapped alarm is triggered in FCWnx but the Avigilon alarm does not respond, the Avigilon
FCWnx Gateway service may not be running.
• Open the Alarm view in the Avigilon Control Center Client software and confirm that
there is an alarm for the triggered event.
• Ensure the Avigilon Third Party License for FCWnx was applied correctly.
• Run the Avigilon FCWnx Gateway configuration application to confirm that alarms from
both systems are populated and that mappings were saved.
• Open the Windows Services window and confirm the Avigilon FCWnx Gateway
service is running.
10
Loading...