Avigilon Control Center 5 System Integration Guide. for Hirsch Identiv Velocity Access Control Systems

Transcription

1 Avigiln Cntrl Center 5 System Integratin Guide fr Hirsch Identiv Velcity Access Cntrl Systems

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 is a registered and/r unregistered trademark f Avigiln Crpratin in Canada and ther jurisdictins wrldwide. Hirsch, Identiv and Velcity are registered trademarks f Identiv, Inc. 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. This manual has been cmpiled and published cvering the latest publicly available prduct descriptins and specificatins frm Identiv Inc. The cntents f this manual and the specificatins f this prduct are subject t change withut ntice. Avigiln reserves the right t make changes withut ntice in the specificatins and materials cntained herein and shall nt be respnsible fr any damages (including cnsequential) caused by reliance n the materials presented, including but nt limited t typgraphical and ther errrs relating t the publicatin. Avigiln Crpratin Revised: INT-HIRSCH-C ii

3 Table f Cntents Intrductin 1 Requirements 1 Fr Mre Infrmatin 1 Installatin 2 Upgrading frm Avigiln Cntrl Center 4 2 Server 2 Client 5 Checking the Avigiln License 5 Cnfiguratin 6 Adding an Integratin User in Avigiln Cntrl Center 6 Velcity Alarm Cnfiguratin 6 Avigiln Alarm Cnfiguratin 6 Alarm Gateway 8 Cnfiguring the Server Settings 8 Mapping Alarms 9 Backing Up Mapped Alarms 10 Restring Mapped Alarms 10 Trubleshting 11 Alarms Are Nt Mapping Crrectly 11 Mapped Avigiln Cntrl Center Alarms Displayed as Unknwn 11 Cannt Reinstall Integratin 12 iii

4 Intrductin The Hirsch Identiv Velcity and Avigiln Cntrl Center sftware integratin 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. Requirements Vendr Avigiln Avigiln Avigiln Avigiln Hirsch Identiv Hirsch Identiv Hirsch Identiv Requirements Cntrl Center Server sftware 5 r later Cntrl Center Client sftware 5 r later Avigiln Third Party Integratin license: ACC5-HRSH-VLCTY Avigiln integratin executable file: AvigilnHirschVelcityGateway.exe Velcity 3.1 R3 r later Velcity SDK SDK License 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 Velcity Administratrs Guide Velcity Operatrs Guide 1 Intrductin

5 Installatin Upgrading frm Avigiln Cntrl Center 4 If yu are upgrading t this versin f the Avigiln Hirsch integratin sftware, be aware that this versin f the integratin is nly cmpatible with Avigiln Cntrl Center 5 r later. 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. Fr mre infrmatin, see Backing Up Mapped Alarms n page 10 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. 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 6. Server 1. Install the Avigiln Cntrl Center Server sftware anywhere n yur netwrk. 2. Install the Velcity Server sftware and the Velcity SDK sftware n the same server. 3. Select a Windws user accunt fr cnnecting the integratin t Velcity. 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 Velcity. 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. Installatin 2

6 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 Velcity 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 Velcity 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 Velcity peratr grups, see the Velcity Administratrs Guide. 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 installer reaches the Specify Service Prperties page, enter the username and passwrd fr the Windws user accunt selected fr the integratin. c. Click Next. 3 Server

7 7. When yu arrive at the last page f the installer, click License Velcity. a. In the fllwing PSG License Tl windw, cpy the Machine ID. b. Paste the Machine ID int an and it t psgsupprt@hirschelectrnics.cm. 8. Click Finish. Server 4

8 9. When yu receive a reply frm psgsupprt@hirschelectrnics.cm, save the attached license key text file t this flder: C:\Prgram Files (x86)\avigiln T hirsch Velcity Gateway\. 10. In the same directry, pen the PSG license Tl: PSGLicenseManagement.NET.exe. 11. Cpy and paste the Velcity License frm the text file int the empty text field and click Save License. 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 Velcity Client sftware n the cmputers that require access t the Velcity System. 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. 5 Client

9 Cnfiguratin Adding an Integratin User in Avigiln Cntrl Center T prtect the security f the Avigiln Cntrl Center system, add a user in the Avigiln Cntrl Center Client sftware specifically fr cnnecting the integratin. The user yu add will be used t cnnect the Avigiln Cntrl Center 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. Velcity Alarm Cnfiguratin Alarms are predefined by the Velcity sftware and can be linked t multiple devices in the 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 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 Velcity 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 Velcity sftware, then assign the required cameras and settings fr the alarm. NOTE: 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 abve. Cnfiguratin 6

10 1. In the Avigiln Cntrl Center 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 Cameras 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 Cntrl Center 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. 7 Avigiln Alarm Cnfiguratin

11 Alarm Gateway The Alarm Gateway is cmpsed f tw parts: the Windws service that runs autmatically in the backgrund, and the Cnfiguratin Tl sftware that is used t map alarms between the tw systems. Cnfiguring the Server Settings Cnfigure the Avigiln Gateway fr Hirsch Identiv 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. In the fllwing dialg bx, enter the Avigiln server IP Address, User Name and Passwrd, then click OK. Alarm Gateway 8

12 Use the username and passwrd created in the Avigiln cnfiguratin. See Adding an Integratin User in Avigiln Cntrl Center n page 6. 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 Velcity sftware. If the Avigiln Hirsch Gateway is installed n a server with bth the Velcity 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 Velcity Database name App Rle Passwrd: enter the passwrd fr the peratr cnfigured during the integratin installatin.see Server n page 2 In the Recnnect attempt interval (secnds) text bx, enter the length f time befre the Gateway tries t recnnect with the Velcity Server if it is unexpectedly discnnected. 5. Click Dne t clse the Cnfigure Cnnectins windw. 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 Velcity alarms by their custmized descriptin, select the Use custmized descriptins check bx. This check bx shuld be autmatically selected if yu have cnfigured Velcity t d the same. See Velcity Alarm Cnfiguratin n page 6 3. If the Velcity alarm is linked t multiple devices, the Velcity Alarm Parameter Values ppup dialg bx is displayed. 9 Mapping Alarms

13 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 Velcity alarm can be linked t multiple devices, the same Velcity alarm can be mapped t multiple Avigiln alarms. Hwever, each Avigiln alarm can nly be mapped t ne Velcity 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. 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. Backing Up Mapped Alarms 10

14 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 Velcity alarms, even thugh the names fr bth alarms are crrect. Check the fllwing: Are yu expecting Velcity alarms t display their custmized descriptins r their predefined names? If yu are expecting t see the alarm's custmized descriptins, make sure the Velcity sftware is set t display event level descriptin custmizatins and the Gateway cnfiguratin applicatin is set t use custmized descriptins. See Velcity Alarm Cnfiguratin n page 6 and Mapping Alarms n page 9 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 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 11

15 Cannt Reinstall Integratin If yu need t reinstall the integratin, this errr message is displayed near the end f the re-installatin prcess: Avigiln Velcity Gateway Admin Tl is already running. This issue may ccur if the Gateway Cnfiguratin Tl was pen when yu uninstalled the integratin sftware. The Cnfiguratin Tl may prevent parts f the sftware frm terminating, and generates the errr when system autmatically tries t pen the Cnfiguratin Tl at the end f the installatin prcess. T avid this errr message, make sure the Cnfiguratin Tl is clsed when yu uninstall the integratin sftware. If yu have already seen this errr message, cmplete the fllwing steps: 1. Open Windws Task Manager and select the Prcesses tab. 2. Lcate AvigilnVelcityAdminTl.exe in the list and click End Prcess. 3. Open the Cnfiguratin Tl. The Cnfiguratin Tl shuld pen withut any issue. 12 Cannt Reinstall Integratin