Avigilon Control Center 6 System Integration Guide

Transcription

1 Avigiln Cntrl Center 6 System Integratin Guide fr Identiv HIRSCH Velcity Sftware

2 , Avigiln Crpratin. All rights reserved. AVIGILON, the AVIGILON lg, ACC, AVIGILONCONTROL CENTER and TRUSTED SECURITY SOLUTIONS are trademarks f Avigiln Crpratin. Other names r lgs mentined herein may be the trademarks f their respective wners. The absence f the symbls and in prximity t each trademark in this dcument is nt a disclaimer f wnership f the related trademark. Unless stated explicitly and 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. This dcument has been cmpiled and published cvering the latest prduct descriptins and specificatins. The cntents f this dcument and the specificatins f the prducts discussed herein are subject t change withut ntice. Avigiln Crpratin reserves the right t make any such changes withut ntice. Neither Avigiln Crpratin nr any f its affiliated cmpanies: (1) guarantees the cmpleteness r accuracy f the infrmatin cntained in this dcument; r (2) is respnsible fr yur use f, r reliance n, the infrmatin. Avigiln Crpratin shall nt be respnsible fr any lsses r damages (including cnsequential damages) caused by reliance n the infrmatin presented herein. Avigiln Crpratin avigiln.cm INT-HIRSCH-D Revisin: 1 - EN ii

3 Table f Cntents Intrductin 1 What's New in This Release 1 Requirements 1 Fr Mre Infrmatin 1 Installatin 2 Upgrading frm Avigiln Cntrl Center 5 2 Verify the SQL Server Instance Name 2 Server 3 Client 6 Checking the Avigiln License 6 Cnfiguratin 7 Adding an Integratin User in Avigiln Cntrl Center Sftware 7 Identiv HIRSCH Velcity Sftware Alarm Cnfiguratin 7 Avigiln Alarm Cnfiguratin 7 Alarm Gateway 9 Cnfiguring the Server Settings 9 Mapping Alarms 11 Backing Up Mapped Alarms 12 Restring Mapped Alarms 12 Failver Supprt 12 Trubleshting 13 Alarms Are Nt Mapping Crrectly 13 Mapped Avigiln Cntrl Center Alarms Displayed as Unknwn 13 Verify Windws Accunt fr the Integratin 14 iii

4 Intrductin The sftware integratin f Identiv HIRSCH Velcity Sftware and Avigiln Cntrl Center allws fr the tw systems t share alarms. The integratin enables alarms created in ne sftware t be linked t alarms in the ther sftware, s alarms can be mnitred in either system. What's New in This Release Supprt fr the Avigiln Cntrl Center server and camera failver. Requirements Vendr Avigiln Avigiln Avigiln Avigiln Identiv Identiv Identiv Identiv Requirements Avigiln Cntrl Center Server sftware 6 r later Avigiln Cntrl Center Client sftware 6 r later Avigiln Third Party Integratin license: ACC6-HRSH-VLCTY Avigiln integratin executable file: AvigilnHirschVelcityGateway.exe HIRSCH Velcity 3.6 SP2 r later HIRSCH Velcity SDK HIRSCH SDK License HIRSCH Velcity Cnnectr Fr Mre Infrmatin Fr mre infrmatin abut the prcedures utlined in this guide, refer t the fllwing specific sftware dcumentatin: Avigiln Cntrl Center Client User Guide Avigiln Cntrl Center Server User Guide Identiv HIRSCH Velcity Administratrs Guide Identiv HIRSCH Velcity Operatrs Guide Intrductin 1

5 Installatin Use the integratin executable file: AvigilnHirschVelcityGateway.exe t install the Avigiln HIRSCH Alarm Gateway integratin sftware. Upgrading frm Avigiln Cntrl Center 5 If yu are upgrading t the Avigiln Cntrl Center 6 System integratin fr the Identiv HIRSCH Velcity Sftware, be aware that this versin f the integratin is nly cmpatible with Avigiln Cntrl Center 6 r later. NOTE: T preserve all f yur current integratin settings, yu must upgrade t Avigiln Cntrl Center 6 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. Fr mre infrmatin, see Backing Up Mapped Alarms n page 12. NOTE: Avigiln Cntrl Center 6 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. Befre yu perfrm the integratin upgrade, it is recmmended that yu clse the cnfiguratin applicatin. When yu upgrade the integratin, the installer will shut dwn the integratin Windws service. When yu are asked t prvide Windws credentials fr cnnecting the integratin, use the same user accunt as the previus integratin. After the upgrade is cmplete, click Save and Apply in the Cnfiguratin Tl t restart the integratin. T cnfirm that the integratin has been cnfigured crrectly, see Cnfiguratin n page 7. Verify the SQL Server Instance Name If yu are upgrading the integratin fr the Identiv HIRSCH Velcity Sftware frm Avigiln Cntrl Center 5 t Avigiln Cntrl Center 6, cmpare the SQL server instance name fr the Identiv HIRSCH Velcity Sftware with the SQL server instance name used by the integratin installer prgram. After installing the Avigiln Cntrl Center 6 System integratin fr the Identiv HIRSCH Velcity Sftware: 1. Open the SQL Server Management Studi applicatin and check the SQL Server Instance name fr the Identiv HIRSCH Velcity Sftware. 2. Navigate t the directry where the Avigiln HIRSCH Alarm Gateway integratin sftware is installed and lcate the AvigilnVelcityAdminTl.exe.cnfig file. 3. Open the AvigilnVelcityAdminTl.exe.cnfig file and cmpare the name f the SQL server instance specified in this file with the name specified in the SQL Server Management Studi applicatin. Cmplete the fllwing steps nly if the server instance names are different. Installatin 2

6 4. Mdify the instance name in the AvigilnVelcityAdminTl.exe.cnfig file t match the instance name in the SQL Server Management Studi applicatin. 5. Run the AvigilnVelcityAdminTl.exe file t update the Avigiln Cntrl Center 6 System integratin fr the Identiv HIRSCH Velcity Sftware with the crrect SQL server instance name. Server 1. Install the Avigiln Cntrl Center Server sftware anywhere n yur netwrk. 2. Install the Identiv HIRSCH Velcity Sftware server sftware and the Identiv HIRSCH Velcity Sftware SDK sftware n the same server. 3. Select a Windws user accunt fr cnnecting the integratin t the Identiv HIRSCH Velcity Sftware. The Windws user accunt must have Lg On As a Service privilege in Windws and must be an peratr r be part f an peratr grup in the Identiv HIRSCH Velcity Sftware. a. In Windws, pen Administrative Tls and click Lcal Security Settings. b. In the left pane, expand Lcal Plicies and select User Rights Assignment. c. Duble-click Lg n as a Service. d. Click Add a User r Grup and enter the user accunt name in the fllwing windw. e. Click OK. f. In the User Rights Assignment list, duble-click Create glbal bjects t enable live updates. g. Click Add a User r Grup and enter the user accunt name in the fllwing windw. h. Click OK. 4. Check which peratr grup the Windws user accunt is part f, pen the Windws Cmputer Management windw. a. In the left pane, expand System Tls > Lcal Users and Grups > Users. b. Right-click the user and select Prperties. c. Select the Member Of tab and see if any f the Identiv HIRSCH Velcity Sftware peratr grups are listed. d. Click OK. The cmputer may need t restart t apply this change. 5. Give the Windws user accunt the fllwing permissins in the Identiv HIRSCH Velcity Sftware t ensure the integratin functins crrectly. Alarm Viewer Alarms & RTNs - Acknwledge Alarms & RTNs - Acknwledge Multiple Alarms & RTNs - Clear in Standard Mde Alarms & RTNs - Clear Multiple Fr mre infrmatin abut adding permissins t Identiv HIRSCH Velcity Sftware peratr grups, see the HIRSCH Velcity Administratrs Guide. Server 3

7 6. Install the Avigiln HIRSCH Gateway sftware integratin n the same server as the Velcity Server and SDK sftware. a. Run the Avigiln HIRSCH Gateway installer. b. When the Specify Service Prperties page is displayed, enter the username and passwrd fr the Windws user accunt selected fr the integratin. c. Click Next. Server 4

8 7. When the last page f the installer is displayed, click License Velcity. a. In the PSG License Tl windw, cpy the Machine ID. b. Paste the Machine ID int an and it t PSGSUPPORT@IDENTIV.COM. 8. Click Finish. Server 5

9 9. When yu receive a reply frm psgsupprt@hirschelectrnics.cm, save the attached sdklicense.txt license key text file t the flder where Avigiln T hirsch Velcity Gateway is installed. It shuld be the same lcatin as the VelcityAdapter.dll SDK. 10. T check the expiry and the validity f the license, pen the PSG license Tl: PSGLicenseManagement.NET.exe. 11. Cpy and paste the Velcity License frm the text file int the empty text field. Check the validity and expiry f the license by pressing the Validate License and Check Expiry buttn respectively. Client Install the fllwing as needed: Install the Avigiln Cntrl Center Client sftware n the cmputers that require access t the Avigiln Cntrl Center System. Install the Identiv HIRSCH Velcity Sftware client sftware n the cmputers that require access t the Identiv HIRSCH Velcity Sftware server. Checking the Avigiln License After yu have installed all the required sftware, check that the Avigiln license was applied crrectly. 1. Open the Avigiln Cntrl Center Admin Tl. 2. Select the Settings tab and click Licensing. The License Activatin dialg bx appears. The dialg bx must say Integratin Cnnectins: Yes r the sftware was nt prperly licensed. Client 6

10 Cnfiguratin Adding an Integratin User in Avigiln Cntrl Center Sftware T prtect the security f the Avigiln Cntrl Center sftware, add a user in the ACC Client sftware specifically fr cnnecting the integratin. The user yu add will be used t cnnect the ACC system t the Avigiln integratin sftware. See the Avigiln Cntrl Center Client User Guide fr mre details. This user must have View live images permissin t enable all integratin features. This user will be used t cnnect the Avigiln Cntrl Center system t the integratin. Identiv HIRSCH Velcity Sftware Alarm Cnfiguratin Alarms are predefined by the Identiv HIRSCH Velcity Sftware and can be linked t multiple devices in the HIRSCH Velcity system. Yu must be familiar with the names f all the devices that are cnnected t the alarms because the device names are required as part f the integratin setup. One way t help identify the alarms that are t be mapped in the Avigiln HIRSCH Gateway is t add a custm descriptin fr the alarms yu want t use. 1. In the Identiv HIRSCH Velcity Sftware, select Cnsle > Custmizatin. 2. Select Alarms frm the tree in the left pane. 3. In the Custmized Value clumn, enter new alarm descriptins. 4. Next, set the Identiv HIRSCH Velcity Sftware t display custm descriptins. a. Open the Velcity Service Cntrl Manager and select Settings... b. Select Advanced frm the left pane then select the Enable event level descriptin custmizatin check bx. c. Click OK. NOTE: D nt change the Enable event level descriptin custmizatin setting after alarms have been mapped in the integratin r the alarms may nt synchrnize prperly. Avigiln Alarm Cnfiguratin Alarms are manually created in the Avigiln Cntrl Center Client sftware. Create the Avigiln alarms yu want mapped t the alarms in the Identiv HIRSCH Velcity Sftware, then assign the required cameras and settings fr the alarm. Imprtant: On the Select Alarm Recipients page, yu must include the Avigiln integratin user r alarms frm the ther system will nt appear in the Avigiln Cntrl Center Client sftware. Fr mre infrmatin abut adding an integratin user in the Avigiln system, see Adding an Integratin User in Avigiln Cntrl Center Sftware abve. Cnfiguratin 7

11 1. In the ACC Client sftware, pen the site Setup tab and click. 2. In the Alarms dialg bx, click. 3. On the Select Alarm Trigger Surce page, select External Sftware Event frm the Alarm Trigger Surce: drp dwn list. Click after yu cmplete each page. 4. On the Select Linked Devices page, select the cameras t link t this alarm, and set the Pre-Alarm Recrd Time: and Recrding Duratin:. 5. On the Select Alarm Recipients page, select the ACC sftware user that was added fr the integratin. Yu can als add any ther grups r users that need t be ntified when this alarm is triggered. 6. (Optinal) If yu wuld like t trigger an actin when an alarm is acknwledged, select Activate selected digital utput(s) n alarm acknwledgement check bx. a. Select the digital utputs t be activated and specify the duratin. b. Select Require user cnfirmatin befre activating digital utput(s) check bx if the user needs t cnfirm the alarm befre the digital utput actin is initiated. 7. Enter a name fr the alarm and set the alarm pririty. The alarm name is used t identify the alarm during the integratin. 8. Ensure Enable alarm check bx is selected then click. Avigiln Alarm Cnfiguratin 8

12 Alarm Gateway The Alarm Gateway is cmpsed f tw parts: a Windws service that runs autmatically in the backgrund, and a Cnfiguratin Tl sftware that is used t map alarms between the tw systems. Cnfiguring the Server Settings Cnfigure the Avigiln Gateway fr the Identiv HIRSCH Velcity sftware t access the tw applicatins. The Cnfiguratin Tl remembers the server cnfiguratins, s yu d nt need t repeat this prcedure if the settings remain the same. 1. Open the Cnfiguratin Tl sftware. Start > All Prgrams > Avigiln > Avigiln Hirsch Gateway Admin Tl. 2. In the Cnfiguratin Tl, click Cnfigure Cnnectins. NOTE: If yu've already added an Avigiln Server but the versin number is nt displayed click the clumn header t re-srt the server listings and the versin number will be displayed. 3. Click Add t add the Avigiln Server. Alarm Gateway 9

13 In the fllwing dialg bx, enter the Avigiln server IP Address, User Name and Passwrd, then click OK. Use the username and passwrd created in the Avigiln cnfiguratin. See Adding an Integratin User in Avigiln Cntrl Center Sftware n page 7. If yur server is part f a Site, the alarms frm the entire Site will be added t the integratin. 4. In the Velcity area, enter the details required t cnnect the integratin t the Identiv HIRSCH Velcity Sftware. If the Avigiln HIRSCH Gateway is installed n a server with bth the the Identiv HIRSCH Velcity Sftware Server and Client sftware, select the Use Server Default Settings check bx. If nt, enter the fllwing: SQL Server: enter the SQL Server IP address. Database: enter the the Identiv HIRSCH Velcity Sftware Database name. App Rle Passwrd: enter the passwrd fr the peratr cnfigured during the integratin installatin. See Server n page 3. In the Recnnect attempt interval (secnds) text bx, enter the length f time befre the Gateway tries t recnnect with the the Identiv HIRSCH Velcity Sftware Server if it is unexpectedly discnnected. 5. Click Dne t clse the Cnfigure Cnnectins windw. Cnfiguring the Server Settings 10

14 Mapping Alarms 1. In the Velcity area and the Avigiln area, select the alarms t be linked. 2. Click >>. If yu prefer t display the Identiv HIRSCH Velcity Sftware alarms by their custmized descriptin, select the Use custmized descriptins check bx. This check bx shuld be autmatically selected if yu have cnfigured the Identiv HIRSCH Velcity Sftware t d the same. See Identiv HIRSCH Velcity Sftware Alarm Cnfiguratin n page 7 3. If the Identiv HIRSCH Velcity Sftware alarm is linked t multiple devices, the Velcity Alarm Parameter Values ppup dialg bx is displayed. a. Fr each Parameter field, enter the name f the device that yu want t link t this specific alarm mapping. Be aware that the name is case sensitive. b. Click OK. NOTE: If the device name is entered incrrectly, the alarm may nt be triggered. 4. Click Save. 5. Repeat the previus steps until all the required alarms have been mapped. Be aware that since each Identiv HIRSCH Velcity Sftware alarm can be linked t multiple devices, the same alarm can be mapped t multiple Avigiln alarms. Hwever, each Avigiln alarm can nly be mapped t ne Identiv HIRSCH Velcity Sftware alarm. 6. When yu are ready, click Update Service. The Gateway Windws service rebts and applies all the new r changed mappings. A ppup message is displayed t tell yu the status f the service as it rebts. Mapping Alarms 11

15 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. 1. Navigate t C:\Prgram Files\Avigiln\Avigiln Hirsch Gateway. NOTE: The file path may be different depending n hw yur system is cnfigured. 2. Cpy and paste the AlarmCnfig.xml file t a backup 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. 2. If yu are restring a backup frm a previus versin f the integratin, the backup file wuld be named VelcityGatewayCnfig.xml. 3. Cpy and paste the backup file int the C:\Prgram Files\Avigiln\Avigiln Hirsch Gateway\ flder. 4. If prmpted, allw Windws t verwrite the cpy that is currently in the flder. 5. Open the integratin Cnfiguratin Tl. The restred mappings shuld be displayed in the Alarm Mappings list. 6. Click Update Service t restart the Gateway Windws service and apply the alarm mapping changes. Failver Supprt Starting frm ACC SDK 6.0, server and camera failver is supprted when cnfigured within the ACC sftware. See the Avigiln Cntrl Center Client User Guide fr mre details abut setting up server and camera failver. The Avigiln HIRSCH Velcity Alarm Gateway Admin Tl may be cnnected t the IP f any server within an Avigiln site that has the apprpriate license. Once cnfigured crrectly, alarms will cntinue t be synchrnized after a failver, even if the event that the server it is cnnected t becmes unreachable. During a failver, yu may see the fllwing behavir: When a cnnected server ges ffline, the Alarm Mapping list in the Avigiln HIRSCH Gateway Admin Tl will display the list f alarms in red as the failver happens. Smetimes the Avigiln alarm list in the Avigiln HIRSCH Gateway Admin Tl may appear empty during a failver. Alarm state changes fr the site will hwever cntinue t be synchrnized with the Identiv HIRSCH Velcity Sftware. Backing Up Mapped Alarms 12

16 Trubleshting If the fllwing trubleshting slutins d nt reslve yur issue, cntact Avigiln Technical Supprt Alarms Are Nt Mapping Crrectly Avigiln alarms are mapped t the wrng Identiv HIRSCH Velcity Sftware alarms, even thugh the names fr bth alarms are crrect. Check the fllwing: Are yu expecting Identiv HIRSCH Velcity Sftware alarms t display their custmized descriptins r their predefined names? If yu are expecting t see the alarm's custmized descriptins, make sure the Identiv HIRSCH Velcity Sftware is set t display event level descriptin custmizatins and the Gateway cnfiguratin applicatin is set t use custmized descriptins. See Identiv HIRSCH Velcity Sftware Alarm Cnfiguratin n page 7 and Mapping Alarms n page 11 fr mre infrmatin. If yu are expecting t see the alarm s predefined names, make sure the custmized descriptin ptins have nt been enabled. Are there any typs in the parameter names? If yu had t specify parameters fr the alarm mappings, check if the parameters cntain any spelling errrs r typs and remember that the values are case sensitive. The alarms wuld map if the parameters were entered incrrectly but the alarm may nt be triggered because the alarms will be lking fr a device that may nt exist. Mapped Avigiln Cntrl Center Alarms Displayed as Unknwn Mapped alarms in the Cnfiguratin Tl are labeled in red as Unknwn. The Avigiln Cntrl Center 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. Trubleshting 13

17 Verify Windws Accunt fr the Integratin Nrmally, the Windws service AvigilnTHirschGateway under the Lcal System accunt. In sme circumstances, the Windws accunt under which an upgrade f the Avigiln Cntrl Center 6 System integratin fr the Identiv HIRSCH Velcity Sftware was installed, is nt the Lcal System accunt. This can result in a mismatch f lg n accunts fr the Windws service AvigilnTHirschGateway. If the Lcal System accunt was nt used t install the AvigilnTHirschGateway service, cmplete the fllwing steps: 1. Open Windws Task Manager and select the Services tab. 2. Lcate the AvigilnTHirschGateway service in the list, right-click and select and click Open Services. 3. In the Services windw, select the AvigilnTHirschGateway service, right-click and select Prperties. 4. In the Prperties dialg bx, click the Lg On tab and change the accunt t match rhe accunt under which the upgrade f the AvigilnCntrl Center 6 System integratin was installed. Verify Windws Accunt fr the Integratin 14