Avigilon Control Center 5 System Integration Guide

Transcription

1 Avigiln Cntrl Center 5 System Integratin Guide with AMAG Symmetry Security Management System 7.0 INT-AMAG-C-Rev2

2 Avigiln Crpratin. All rights reserved. Unless expressly granted in writing, n license is granted with respect t any cpyright, industrial design, trademark, patent r ther intellectual prperty rights f Avigiln Crpratin r its licensrs. AVIGILON, CAPTURE IT WITH CLARITY, HDSM, HIGH DEFINITION STREAM MANAGEMENT (HDSM), THE BEST EVIDENCE and LIGHTCATCHER are unregistered and/r registered trademarks f Avigiln Crpratin in Canada and ther jurisdictins wrldwide. Other prduct names mentined herein may be the unregistered and/r registered trademarks f their respective wners. and are nt used in assciatin with each trademark in this dcument. Avigiln Tel Fax INT-AMAG-C: Revisin: 2

3 Table f Cntents Intrductin What s New Requirements Fr Mre Infrmatin Installatin Upgrading the Integratin Frm Avigiln Cntrl Center Frm AMAG SMS Server Client Cnfiguratin Adding an Integratin User in AMAG Adding an Integratin User in Avigiln Setting Up Gateway Alarms in Avigiln Setting Up the Vide Integratin Assigning Lgical IDs t Cameras Adding Avigiln Recrder and Cameras t SMS Avigiln AMAG Alarm Gateway Cnfiguring Server Settings Mapping Alarms Backing Up Mapped Alarms Restring Mapped alarms Using the Integratin Mnitring Alarms Mnitring Vide Trubleshting Cannt Add Avigiln Cameras t SMS Purged Avigiln Alarms Still Present in SMS Mapped Avigiln Alarms Displayed As Unknwn Cannt Save Changes in the Cnfiguratin Tl

4

5 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS Intrductin The AMAG Symmetry Security Management System (SMS) and Avigiln Cntrl Center sftware integratin allws fr the tw systems t cmbine alarm mnitring abilities. The integratin includes: The Alarm Mapping Gateway sftware that enables alarms created in the Avigiln Cntrl Center sftware t be mapped t specific device cmmands in the SMS sftware. The Vide Integratin sftware that allws yu t mnitr Avigiln cameras in the SMS sftware. Bth parts f the integratin can be used tgether r separately. What s New Updated Alarm Mapping Gateway sftware fr Avigiln Cntrl Center 5 Imprved alarm mapping wrkflw Reduced dwntime when updating alarm mappings Requirements Vendr Requirements Avigiln Cntrl Center Server Sftware 5.0 r later Avigiln Avigiln Third Party Integratin License: ACC5-AMAG-SMTRY Avigiln Avigiln AMAG sftware integratin: AmagSMSGateway exe Installer includes: Alarm Mapping Gateway sftware Vide Integratin sftware The file can be dwnladed at AMAG Symmetry SMS Server sftware Fr the Alarm Mapping Gateway sftware nly: AMAG Symmetry XML Open Integratin Mdule

6 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS Fr Mre Infrmatin AMAG SMS SDK License: XML-DEV-KIT-V7.0.1 Fr the Vide Integratin sftware nly: AMAG SMS Vide Integratin License: VID-CAM-xxx-V7 Fr mre detailed infrmatin abut the prcedures utlined in this guide, refer t the specific sftware dcumentatin. Avigiln Cntrl Center Client User Guide Avigiln Cntrl Center Server User Guide SMS Sftware User s Guide Security Management System Online Help Installatin Upgrading the Integratin Frm Avigiln Cntrl Center 4 If yu are upgrading t this versin f the Avigiln AMAG integratin sftware, be aware that this versin f the integratin is nly cmpatible with Avigiln Cntrl Center 5. NOTE: T preserve all f yur current integratin settings, yu must upgrade t Avigiln Cntrl Center 5 and make sure all servers in the Site can be accessed by the integratin. If a server is ffline r inaccessible t the integratin during the upgrade, the integratin settings fr that server are lst. It is recmmended that yu back up a cpy f all the alarm mappings befre yu upgrade the integratin. The backup file fr all previus versins f the integratin sftware is called GatewayParams.xml. Be aware that the backup file frm this versin nwards is called AlarmCnfig.xml. Make sure the backup file is labeled crrectly when yu imprt it int the integratin. Fr mre infrmatin, see Backing Up Mapped Alarms n page 11. 2

7 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS NOTE: Avigiln Cntrl Center 5 prvides the ability t rganize multiple servers int Sites and share settings between servers. T use this feature effectively, yu must upgrade all servers in yur Site befre upgrading the integratin r all f the previus mappings may be lst. When yu upgrade the integratin, the installer will shut dwn the integratin Windws service. After the upgrade is cmplete, click Save and Apply in the Cnfiguratin Tl t use the updated cnfiguratin. T cnfirm that the integratin has been cnfigured crrectly, see Avigiln AMAG Alarm Gateway n page 7. Frm AMAG SMS 6.2 If yu are upgrading the AMAG SMS sftware and the Vide Integratin sftware frm versin 6.2 t 7.0.1, uninstall the previus Avigiln Plugin and Alarm Mapping Gateway frm Windws befre installing the fllwing updated sftware. Server Client 1. Install the fllwing n the same server: The SMS Server sftware Install the fllwing as needed: The XML Open Integratin Mdule is required if yu are installing the Avigiln AMAG Alarm Mapping Gateway sftware. (Optinal) The Avigiln AMAG Vide Integratin sftware fr viewing Avigiln vide in the SMS sftware. The Avigiln Cntrl Center Server sftware The Avigiln AMAG Alarm Mapping Gateway sftware Install the SMS Client sftware n the cmputers that require access t the SMS system. Install the Avigiln Cntrl Center Client sftware n the cmputers that require access t the Avigiln Cntrl Center System. 3

8 Cnfiguratin Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS The Avigiln AMAG integratin sftware is used t direct alarm cmmunicatin and vide streams between the Avigiln Cntrl Center sftware and the SMS sftware. Cnfigure the tw applicatins t perfrm the integratin features. Adding an Integratin User in AMAG T give the integratin sftware access t the AMAG system, yu need t add a user with access t all the Cmpany Grups that the integratin will link t and a user with access t the SMS database r SQL Server. See the SMS Sftware User s Guide fr details abut hw t add users. The integratin sftware needs an SMS user and an SMS SQL Server user t cnnect t the SMS sftware. Adding an Integratin User in Avigiln T prtect the security f the Avigiln Cntrl Center Server, add a user t the Avigiln sftware specifically fr cnnecting t the integratin. See the Avigiln Cntrl Center Client User Guide fr details abut hw t add users. This user must have the fllwing permissins t enable all the integratin features: View Live Images Use PTZ View Recrded Images This integratin username and passwrd is required t add Avigiln Servers t the integratin. Setting Up Gateway Alarms in Avigiln Alarms are manually created in the Avigiln Cntrl Center Client sftware. Create the Avigiln alarms yu want mapped t the device cmmands in the SMS sftware. 1. In the Avigiln Cntrl Center Client sftware, right-click the Site in the System Explrer and select Setup. 2. In the Setup tab, click Alarms. 4

9 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS 3. On the Add Alarm dialg bx, click Add. 4. On the Select Alarm Trigger Surce page, select External Sftware Event frm the Alarm Trigger Surce drp dwn list and click Next. 5. On the Select Linked Cameras page, select the cameras t link t this alarm, and set the Pre-Alarm Recrd Time and the Recrding Duratin. Click Next. 6. Select the grups r users wh shuld receive alarm ntificatins, then click Next. 7. (Optinal) If yu wuld like t trigger an actin when an alarm is acknwledged, select the Activate selected digital utput(s) n alarm acknwledgement check bx. a. Select the digital utputs t be activated and specify the duratin. b. Select the Require user cnfirmatin befre activating digital utput check bx if users need t cnfirm the alarm befre the digital utput actin is initiated. c. Click Next. 8. Enter a Name fr the alarm and set the alarm Pririty. The alarm name is used t identify the alarm during the integratin. 9. Ensure the Enable Alarm check bx is selected and click Finish. Setting Up the Vide Integratin Assigning Lgical IDs t Cameras In the Avigiln Cntrl Center Client sftware, assign a lgical ID t each camera. The SMS sftware will nly detect cameras with a lgical ID. By default, cameras d nt have a lgical ID. 1. In the Avigiln Cntrl Center Client sftware, right-click a camera in the System Explrer and select Setup. 2. In the camera Setup tab, click General. 3. In the General dialg bx, enter a Lgical ID fr the camera. The lgical ID must be unique number. 5

10 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS Adding Avigiln Recrder and Cameras t SMS If yu want t mnitr Avigiln cameras in the SMS sftware, yu must first add the Avigiln server and cameras t the SMS system. 1. In the SMS sftware, select the Install tab then click Digital Vide. 2. In the Install Vide & Audi dialg bx, select Avigiln Recrder then click New. NOTE: The Avigiln Recrder ptin is nly listed if yu have the Avigiln AMAG Vide Integratin installed n the SMS server. 3. Cmplete the fllwing fields: a. Vide Server: enter a name fr the Avigiln server. b. IP Address: enter the server s IP address c. Lgin Credentials: enter the username and passwrd yu created in the Avigiln Cntrl Center Client sftware. Fr mre infrmatin, see Adding an Integratin User in AMAG n page Click Save. The new server is nw listed as an Avigiln Recrder. Repeat the previus steps until all the required Avigiln servers have been added. Be aware that yu can nly add a camera t the system after the cnnected server has been added t the system. 6

11 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS 5. Once an Avigiln server has been added t the Avigiln Recrder list, the Avigiln Camera ptin is displayed in the Install - Vide & Audi dialg bx. Select Avigiln Camera then click New. 6. Cmplete the fllwing fields: a. Descriptin: give the camera a name. b. Vide Recrder: select the server the camera is cnnected t. c. Vide Channel: select the camera yu want t see in the SMS sftware. NOTE: Only cameras with lgical IDs are listed. Fr mre infrmatin, see Assigning Lgical IDs t Cameras n page 5. d. If yu are adding a PTZ camera, enable the relevant PTZ cntrls. 7. Click Save. Repeat the previus steps until all the required cameras have been added. Avigiln AMAG Alarm Gateway The Avigiln AMAG Alarm Mapping Gateway is cmpsed f tw parts: the Gateway Windws service that runs autmatically in the backgrund, and the cnfiguratin 7

12 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS applicatin that is used t cnfigure the cnnectin and alarm mappings between the AMAG and the Avigiln systems. Cnfiguring Server Settings Cnfigure the Alarm Mapping Gateway t access the tw applicatins. The cnfiguratin applicatin remembers the server cnfiguratin, s yu d nt need t repeat this prcedure if the settings remain the same. After yu install the integratin sftware, the Cnfiguratin Tl autmatically pens. T access it manually, select All Prgrams > Avigiln > Avigiln AMAG SMS Gateway > Cnfigure Avigiln t AMAG SMS Gateway. If yu upgraded yur integratin and all the cnfiguratins were successfully imprted, yu will autmatically see the Cnfiguratin Tl windw. Click Cnfigure Cnnectins. If this is a new installatin, yu will autmatically see the Cnfigure Cnnectins dialg bx. Click Add. a. In the fllwing dialg bx, enter the Avigiln Server IP Address, User Name and Passwrd, then click OK. Use the username and passwrd yu created fr the integratin. See Adding an Integratin User in Avigiln n page 4. NOTE: If the Avigiln Cntrl Center Server and the Avigiln AMAG Gateway Integratin are installed n the same server, set the server IP Address as instead f the actual IP address. 8

13 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS 1. In the Cnfigure Cnnectins dialg bx, cmplete the fllwing fields: AMAG SMS Server: enter the SMS Server IP address r hstname. AMAG SMS SDK User: enter the SMS username yu created fr the integratin. See Adding an Integratin User in AMAG n page 4. AMAG SMS SDK Passwrd: enter the passwrd fr the SMS user. SQL Server Instance: enter the IP address r hstname fr the SMS database. SQL Server Catalg: enter the name f the SMS server catalg. It shuld be multimax. Use Integrated Security: select this check bx if yur SQL credentials are the same as yur Windws lgin. SQL Server User Name: enter yur username fr the SMS database. SQL Server Passwrd: enter yur passwrd fr the SMS database. 2. Click Cnnect t link the Avigiln Cntrl Center and SMS sftware with the integratin. A ppup message appears t ntified yu that the cnnectin is successful. 3. Click Dne. The Cnfiguratin Tl windw is displayed. The integratin searches bth sftware systems fr alarms that can be mapped tgether. 9

14 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS Mapping Alarms In the Cnfiguratin Tl is a list f all the current alarm mappings, and all the available alarms frm the Avigiln Cntrl Center sftware and the SMS sftware. If the Cnfiguratin Tl is nt already pen, select All Prgrams > Avigiln > Avigiln AMAG SMS Gateway > Cnfigure Avigiln t AMAG SMS Gateway. T map alarms tgether, cmplete the fllwing steps: 1. In the AMAG SMS area, set the device cmmands that will trigger an SMS alarm fr the integratin. The SMS sftware is pre-cnfigured with a set f cmmands fr the devices in yur security system. Fr a detailed list f the available cmmands, see the Security Management System Online Help fr mre infrmatin. a. In the Where drp dwn list, select the device that this alarm will link t. b. In the What drp dwn list, select the cmmand that triggers this alarm. c. If there is a user r rle that needs t be assciated with the alarm, the Wh drp dwn list will aut-ppulate with the available ptins. 10

15 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS 2. In the Avigiln area, select the alarm yu want t map t. Listed here are the alarms yu created in Setting Up Gateway Alarms in Avigiln n page Click >>. 4. Click Save. 5. Repeat the previus steps until all the required alarms have been mapped. 6. Once all the required alarms have been mapped, click Save and Apply. The Gateway Windws service is updated with all the new r changed mappings. Backing Up Mapped Alarms After yu finish mapping all the alarms in the Cnfiguratin Tl, yu can chse t back up a cpy f the mappings. If yu are perfrming this prcedure befre upgrading the integratin, be aware that in lder versins f the integratin the backup file is lcated in the same flder but is labeled GatewayParams.xml. 1. Navigate t C:\Prgram Files\Avigiln\Avigiln AMAG Gateway\. NOTE: The filepath may be different depending n hw yur system is cnfigured. 2. Cpy and paste the AlarmCnfig.xml file t a back up lcatin. Restring Mapped alarms When yu have a backup cpy f the mapped alarms, yu can restre the mapped alarms any time. 1. Lcate yur backup cpy f the AlarmCnfig.xml file. If yu are restring a backup frm a previus versin f the integratin, lcate yur backup cpy f the GatewayParams.xml file. 2. Cpy and paste the backup AlarmCnfig.xml file int the C:\Prgram Files\Avigiln\Avigiln AMAG Gateway\ flder. If prmpted, allw Windws t verwrite the cpy that is currently in the flder. 3. Open the integratin Cnfiguratin Tl. The restred mappings shuld be displayed in the Alarm Mappings list. 4. Click Save and Apply t update the Gateway Windws service and apply the alarm mapping changes. 11

16 Using the Integratin Mnitring Alarms Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS Once the alarms frm AMAG and Avigiln Cntrl Center have been mapped in the Alarm Mapping Gateway, yu can begin t use the integratin. When an SMS alarm is triggered, it will activate the mapped Avigiln alarm and the cnfigured alarm actins are started. T mnitr alarms in the SMS sftware, see the alarm mnitring sectin f the SMS Sftware User Manual. T mnitr alarms in the Avigiln Cntrl Center sftware, see the alarms sectin f the Avigiln Cntrl Center Client User Guide. Mnitring Vide Once the vide integratin is set up in the SMS sftware, yu can mnitr vide captured by Avigiln cameras in the SMS sftware. Fr mre infrmatin abut mnitring vide, see the Digital Vide management sectin f the SMS Sftware User Manual. Trubleshting If the fllwing trubleshting slutins d nt reslve yur issue, cntact Avigiln Technical Supprt Cannt Add Avigiln Cameras t SMS When yu try t add Avigiln cameras t the SMS system, n cameras are listed in the Vide Channel drp dwn list. This ccurs when the cameras in the Avigiln system d nt have lgical IDs. Only cameras with lgical IDS are listed in the SMS sftware. T assign a camera a lgical ID, see Assigning Lgical IDs t Cameras n page 5. 12

17 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS Purged Avigiln Alarms Still Present in SMS After yu have acknwledged an alarm in the Avigiln Cntrl Center Client sftware, yu click Purge t clear the Alarms list. Hwever, when yu access the SMS sftware, the purged alarm is still listed as a Blue alarm in the Alarms screen. This ccurs when a device that triggered the SMS alarm needs t be manually reset. Fr example, a windw with a mnitr pint that has nt been clsed. The Avigiln Cntrl Center sftware is able t acknwledge the SMS alarm but des nt recgnize that the device needs t be manually reset. T clear the alarm frm the SMS Alarms screen, manually reset the device then click Clear. Mapped Avigiln Alarms Displayed As Unknwn Mapped Avigiln alarms in the Cnfiguratin Tl are labeled in red as Unknwn. The Avigiln server that the integratin is cnnected t displays an Errr status in the Cnfigure Cnnectins dialg bx. This issue ccurs if the Avigiln Cntrl Center Server has rebted r is ffline. Perfrm the fllwing steps t ensure the integratin functins crrectly: 1. Check that the Avigiln Cntrl Center Server is nline and cnnected t the lcal netwrk. 2. When the Avigiln Cntrl Center Server is back nline, pen the Cnfiguratin Tl and click Cnfigure Cnnectins. 3. If the Avigiln Cntrl Center Server is nline, the server status wuld be Ready. If it is nt, check the server cnnectivity again. 4. Clse the Cnfigure Cnnectins dialg bx. The Cnfiguratin Tl shuld nw display the crrect alarm names. 5. Click Save and Apply t ensure the alarm mappings are active. 13

18 Avigiln Cntrl Center 5 System Integratin Guide with AMAG SMS Cannt Save Changes in the Cnfiguratin Tl Yu are nt able t save alarm mapping changes in the Cnfiguratin Tl and an errr message is displayed. The issue did nt ccur during yur first access t the Cnfiguratin Tl after the installatin. T wrkarund this issue, perfrm any f the fllwing ptins: Run the Cnfiguratin Tl as an administratr. Disable User Accunt Cntrl (UAC) in yur Windws system. 14