AN-220. KeyWatcher Touch Integration in Protege GX Application Note

Transcription

1 AN-220 KeyWatcher Touch Integration in Protege GX Application Note

2 The specifications and descriptions of products and services contained in this document were correct at the time of printing. Integrated Control Technology Limited reserves the right to change specifications or withdraw products without notice. No part of this document may be reproduced, photocopied, or transmitted in any form or by any means (electronic or mechanical), for any purpose, without the express written permission of Integrated Control Technology Limited. Designed and manufactured by Integrated Control Technology Limited. Protege and the Protege Logo are registered trademarks of Integrated Control Technology Limited. All other brand or product names are trademarks or registered trademarks of their respective holders. Copyright Integrated Control Technology Limited All rights reserved. Publication Date: February AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

3 Contents KeyWatcher Touch Integration 4 Prerequisites 4 Overview 4 Implementing KeyWatcher Touch Integration in Protege GX 5 Configuring Protege GX 5 Enabling the KeyWatcher Touch Integration 5 Adding an Operator 6 Adding a Schedule 7 Adding an Access Level 8 Adding and configuring a User 9 Configuring the Service Manager 11 Installing the KeyWatcher Integration Service Manager 11 Starting the Service 15 KeyWatcher Events in Protege GX 16 Event Types 16 Event Search 18 Contact 19 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

4 KeyWatcher Touch Integration KeyWatcher Touch is an electronic key management system manufactured and distributed my Morse Watchmans Incorporated USA. KeyWatcher Touch cabinets are modular in design, allowing the system to be customized to suit the needs of each site. The user interface comprises of a 7", color touchscreen which can be utilized with the extensive programming and reporting functionality available in Protege GX. Keys available for use within the system are attached to a SmartKey, where each SmartKey contains an identification chip. This allows a user to log on to the KeyWatcher Touch cabinet and have SmartKeys electronically released or returned to key slots within the cabinet, or any other cabinet on site. This Integration allows KeyWatcher Touch system operation to be synchronized with new or existing Users, Access Levels and Schedules within Protege GX. Integration between systems also allows the extensive reporting functionality available within Protege GX to be used with the events and alarms available with KeyWatcher Touch. Prerequisites The software and licensing requirements are as follows: KeyWatcher Touch KeyWatcher Touch Server Software & KeyWatcher True Touch Client Software. KeyWatcher supplies an installation CD for Server & Client software SQL Server software version 2008R2 or 2012 (recommended) MSMQ (Microsoft Message Queue) must be activated in the Windows features on the PC that the Integration service is installed on Basic setup and programming of the KeyWatcher system is be required. This includes setup of the site and creation of the keys and key groups required within the system Protege GX An operational Protege GX system running software version or above A Protege Controller using PRT-CTRL-DIN firmware version 2.08 Build 741 or higher A SOAP Interface license applied to the relevant SSN A KeyWatcher Integration licence applied to the relevant SSN An installation of the KeyWatcher install package which can be downloaded from the ICT website ( IMPORTANT: It is recommended that installers back up both the Protege GX and KeyWatcher Touch databases before enabling the integration service. Overview The following instructions outline the steps required to configure the integration within Protege GX: Enabling the KeyWatcher Touch Integration in Protege GX Adding an Operator, Schedule and Access Level in Protege GX Adding and configuring a User in Protege GX Installing the KeyWatcher Service Integration Manager Starting the Protege GX KeyWatcher Integration Service Understanding KeyWatcher Event Types Running an Event Search to locate KeyWatcher events within a selected time period. 4 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

5 Implementing KeyWatcher Touch Integration in Protege GX Configuring Protege GX The following instructions outline how to configure the KeyWatcher Integration in Protege GX. Enabling the KeyWatcher Touch Integration 1. Navigate to Global Sites. 2. Select the Site for which the KeyWatcher Touch integration is to be enabled for. 3. Take note of the Database ID. This value will be entered into the GX Site ID field when installing the integration service. (see page 11) 4. Click on the KeyWatcher tab. 5. Select the Enable KeyWatcher Integration check box. 6. Assign a value to the User ID Digit Length field. This value must match the User ID Digit Length field assigned in the KeyWatcher True Touch client software. If you wish to change to the User ID Digit Length, changes must be made in the KeyWatcher True Touch Software (Site Configuration Site Settings General Settings). IMPORTANT: Changes made in to this field in Protege GX will not be synchronized back to the KeyWatcher Touch software and could cause programming inconsistencies. AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

6 Adding an Operator 1. Navigate to Global Operator. 2. Click Add. Enter the following details: Name: The name of the operator. User Name: The user name for the operator. This field will be used when configuring the integration service manager later in this application note (see page 11). Password: The password for the operator. This field will be used when configuring the integration service manager later in this application note (see page 11). Confirm Password: This field requires you to enter the same password entered in the Password field. Role: The operator must be assigned the Administrator role in order for the integration to work correctly. 3. Enable the Show PIN numbers for Users check box. Protege GX will present you with a warning. 4. Click Ok to enable the check box. This setting must be enabled in order for the integration to work correctly. 6 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

7 Adding a Schedule 1. Navigate to Sites Schedules. 2. Click Add. 3. Enter a Name for the new Schedule. Enter the following details: Assign a Start Time and End Time for the schedule. Select the check boxes corresponding to the days for which the schedule is to be active. Set the Holiday Mode to Ignore on Holiday. 4. Click Save. Schedules to be synchronized with KeyWatcher can only be defined in Period 1. Additionally, schedules cannot be programmed to operate between days (e.g. 22:00 Monday till 02:00 Tuesday). If both the Start Time and End Time are set to 00:00, a 24 hour time restriction will be created in KeyWatcher. AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

8 Adding an Access Level 1. Navigate to Users Access Levels. 2. Click Add. 3. Enter a Name for the new Access Level. KeyWatcher access can be configured for an existing access level if required. It is not necessary to create a new access level. 4. Click on the KeyWatcher Keys tab. 5. Click Add. 6. Within the Select Records window, select the required key(s). 7. Click OK. 8. Click Save. KeyWatcher Key Groups can also be added if required. 9. Assign the required schedule by selecting it from the drop down menu. In this example, we will assign the KeyWatcher Operation Schedule to the selected key. This action is the equivalent of adding a Time Restriction to a Permission within the KeyWatcher Client software. 10. Click Save. 8 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

9 Adding and configuring a User 1. Navigate to Users Users. 2. Click Add. 3. Enter a Full Name and Last Name for the User. The Name field will be automatically populated. 4. Locate the KeyWatcher section at the bottom of the page. 5. A KeyWatcher ID is automatically assigned to each user who has a valid access level containing KeyWatcher keys or key groups. This value is unique to each user. In this example, the maximum KeyWatcher ID that can be assigned is The KeyWatcher ID can be entered manually in Protege GX. If the ID has already been assigned to a user, Protege GX will present a warning and offer the next available KeyWatcher ID. In this example we previously assigned a User ID Digit Length of 4, allowing for up to 9999 users to be programmed. 7. Click Save. Adding User Credentials A user PIN must be assigned for correct system operation. Card credentials can be used if required. If Using a PIN Number: Protege GX allows the use of 4, 5 or 6 digit PIN numbers, however KeyWatcher limits the PIN number to a maximum of 4 digits. If the PIN number selected is less than 4 digits, additional zeros will be prefixed to the PIN to increase it to the required 4 digit length. It is not possible to leave the PIN field empty in Protege GX. 1. In the Card Numbers section, enter a 4 digit number into the PIN field. This will be the user PIN which allows access to the KeyWatcher Touch cabinets. 2. Click Save. AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

10 If Using Card Credentials: It is possible to have a Wiegand format card reader connected to a KeyWatcher cabinet to allow access to the cabinet without the need to enter a User ID or PIN. The KeyWatcher Touch cabinet must have a card access interface board installed and connected to the KeyWatcher system. Card access functionality must be enabled in the KeyWatcher Touch software settings. The recommended card type is Wiegand 128-bit compatibility, where the card access interface board only supports the Wiegand protocol. Other Wiegand card format types can be downloaded to the KeyWatcher Touch software and are available directly from Morse Watchmans. If a card reader is enabled in the KeyWatcher system, then a facility/card number must be assigned to the user. 1. In the Card Numbers section, assign a facility/card number to the user. 2. Click Save. Assigning the Access Level to the User 1. Click on the Access Levels tab. 2. Click Add. 3. Select the access level created previously and click Ok. In this example we have assigned the KeyWatcher Access Level. 4. Click Save. Protege GX users with access levels that include keys, key groups (or both) will be synchronized and copied into the KeyWatcher software. IMPORTANT: Integrators should not manage Users, Profiles/Permissions or Time Restrictions from within the KeyWatcher Client software. They must be managed from within the Protege GX software and then synchronized with KeyWatcher in order to operate correctly. 10 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

11 Configuring the Service Manager The following instructions outline the installation and service configuration of the KeyWatcher Integration in Protege GX. Installing the KeyWatcher Integration Service Manager 1. Run the executable (*.exe) file to launch the KeyWatcher Integration Service Install Wizard. 2. Click Next. 3. Click Next to begin the installation process. AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

12 4. Configure the settings required to connect to the Protege GX server. Enter the following details: GX Site ID: Database ID for the Site in Protege GX. This value can be found by navigating to Global Sites (see page 5) in the Protege GX software. GX SOAP Address: SOAP Service endpoint URL where the service can be accessed by a client application. GX Operator Name: Name of the operator for the site as configured in Protege GX (see page 6). GX Operator Password: The password of the operator of the site as configured in Protege GX (see page 6). 5. Click Next. 6. Enter the following details: KW IP Address: IP Address of the KeyWatcher server. KW Port: The TCP Port for the KeyWatcher server. It is best to leave this field as default. KW Version: Database Version of KeyWatcher. It is best to leave this field as default. KW Site ID: The name of the KeyWatcher site that is being integrated with Protege GX. This field is assigned by the KeyWatcher client software. 12 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

13 7. Click Next. Enter the following details: KW Windows User Name: Name of the Windows user account for the KeyWatcher True Touch Server assigned during installation of the True Touch Server. KW Windows User Password: Password of the Windows user account for the KeyWatcher True Touch Server assigned during installation of the True Touch Server. KW Admin User Name: KeyWatcher admin username (which has ID 0 in KeyWatcher) which is MorseWatchman by default. This admin user must be configured in the KeyWatcher site that synchronizes with Protege GX. The admin user must also be assigned Administrative Access. KW Admin User Password: KeyWatcher password for the admin user name which is blank by default. 8. Click Next. 9. Enter the following details: Network Adapter: The IP Address of the computer that the integration service is installed on. Sync Interval (Mins): The amount of time before synchronization between KeyWatcher Touch and Protege GX AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

14 10. Click Next to begin the installation. 11. Click Finish. Once the installation is complete, the KeyWatcher Integration Service Manager window will open. 12. Click Save and close the window. IMPORTANT: If any changes are made to the settings within the KeyWatcher Integration Service Manager, then the service must be stopped and restarted for correct operation. 14 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

15 Starting the Service The services used by the integration must be running for Protege GX to be able to communicate with the KeyWatcher Touch system. 1. Press the Windows + R keys. 2. Type services.msc into the search bar and press click OK. 3. Scroll down and locate the Protege GX KeyWatcher Integration Service. 4. Right click on the Protege GX KeyWatcher Integration Service and click Start. AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

16 KeyWatcher Events in Protege GX There are 30 KeyWatcher Events and Alarms that are synchronized with Protege GX when triggered in the KeyWatcher system. These Events and Alarms can be added to the reporting functions and can be viewed in the All Events window of a Status page. Event Types KeyWatcher event types can be viewed by navigating to Sites Event Types. Sort the list in alphabetical order by clicking on the Name heading. 16 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

17 The following table explains the action of each event/alarm. KeyWatcher Event Box AC Power Loss Box Controller Battery Fail Box Controller Battery Low Box Door Illegal Entry Box Door Latch Release Box Door Left Open Notes KeyWatcher Slave box has lost AC power KeyWatcher Touch box battery fault/failure KeyWatcher Touch box battery low KeyWatcher Touch box door has been opened by illegal entry KeyWatcher Touch box door latch released by KW Admin user KeyWatcher Touch box door left open by user Box Location Release Box Slot Release Key Overdue Key Remove Key Remove Emergency Release Key Remove Invalid Key Key Return Not Taken Key Return Inconsistent Key Return Invalid Key Key Return Not Returned Key Return Overdue KWT AC Power Loss KWT Restart KWT Server Not Available Problem Key Server KWT Stopped Sending Status Server Network Down Server Shut Down Server Start Up User Log Off User Logon User Logon Duress KeyWatcher Touch box location released by KW Admin user KeyWatcher Touch box key slot released by KW Admin user Key removed from KeyWatcher Touch box by user is overdue* Key removed from KeyWatcher Touch box by user Key removed from KeyWatcher Touch box using emergency release** Invalid Key removed from KeyWatcher Touch box by user Key removed from KeyWatcher Touch box but not taken Key returned to KeyWatcher Touch box by different user Invalid Key returned from KeyWatcher Touch box by user Key returned to KeyWatcher Touch by user, but not returned to box slot Overdue key returned to KeyWatcher Touch box. KeyWatcher Touch box has lost AC power KeyWatcher Touch server restarting KeyWatcher Touch server not available SmartKey with problem removed from KeyWatcher Touch box. KeyWatcher Touch box stopped sending status to server KeyWatcher Touch server network is down KeyWatcher Touch server shutting down KeyWatcher Touch server starting up * The time limit for an overdue key is assigned in the KeyWatcher Touch software. ** Emergency Release activated by (PIN+9). *** Duress activated by (PIN+7). User has logged off at KeyWatcher Touch box. User has logged on at KeyWatcher Touch box. User logon at KeyWatcher Touch box under duress*** AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

18 Event Search The Event Search function allows you to view what is happening within the system. It generates a temporary report that can be printed but not saved. We will use an Event Search to view KeyWatcher events that have occurred within a selected time period. 1. Navigate to Events Event Search. 2. In the Time Period section, define the period over which you wish to generate an event report for. Either: Select a Period from the drop down box and set a StartDate. The EndDate field will automatically be disabled. Define a custom period by defining the StartDate and EndDate. 3. Disable the Include All Event Types check box. 4. In the Event Types section, click Add. 5. In the Select Event Types window, enter KeyWatcher into the Keyword field to locate KeyWatcher Events. 6. Select the KeyWatcher events you wish to view in the report and click Ok. 7. Click Find. An event report that shows the selected events for the selected time period will be generated. 18 AN-220 KeyWatcher Touch Integration in Protege GX Application Note February 2017

19 Contact Integrated Control Technology welcomes all feedback. Please visit our website ( or use the contact information below. Integrated Control Technology P.O. Box North Harbour Post Centre Auckland New Zealand 4 John Glenn Ave Rosedale North Shore City 0632 Auckland New Zealand Phone: Toll Free Numbers: 0800 ICT 111 ( ) - New Zealand 1800 ICT 111 ( ) - Australia 1855 ICT 9111 ( ) - USA/Canada Web: sales@incontrol.co.nz or support@incontrol.co.nz AN-220 KeyWatcher Touch Integration in Protege GX Application Note February

20

21 APAC Integrated Control Technology Limited 4 John Glenn Avenue, Rosedale, Auckland 0632 PO Box , North Harbour, Auckland 0751, New Zealand sales@ict.co Toll Free: (0800) Phone: 64 (9) AMERICAS Integrated Control Technology (USA) LLC 5265 S Rio Grande Street, Suite 201, Littleton, CO ussales@ict.co Toll Free: (855) Phone: EMEA Integrated Control Technology (Europe) Limited St Mary's Court, The Broadway, Amersham, HP7 0UT, UK emeasales@ict.co Phone: Designers & manufacturers of integrated electronic access control, security and automation products. Designed & manufactured by Integrated Control Technology Ltd. Copyright Integrated Control Technology Limited All rights reserved. Disclaimer: Whilst every effort has been made to ensure accuracy in the representation of these products, neither Integrated Control Technology Ltd nor its employees, shall be liable under any circumstances to any party in respect of decisions or actions they may make as a result of using this information. In accordance with the Integrated Control Technology policy of enhanced development, design and specifications are subject to change without notice