E-Plex 5900 Series Card-Connected Lock and M-Unit User Guide. E-Plex PC M-Unit (Version 4) User Guide

Transcription

1 1 E-Plex 5900 Series Card-Connected Lock and M-Unit User Guide E-Plex PC M-Unit (Version 4) User Guide E-Plex 5900 Series Card-Connected Lock and M-Unit User Guide 1

2 Second Edition (for V4.x): November 2010 First Edition (for V3.x): December 2009 The E-Plex PC M-Unit User Guide is a publication of Kaba Access Control. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage and retrieval system, without prior written permission from Kaba Access Control. The information contained in this publication is accurate to the best of Kaba Access Control s knowledge. Specifications are subject to change without notice. Technical Support Please call Kaba Access Control s Technical Support phone line at (800) or (336) between 8:00 a.m. and 5:00 p.m., Monday through Friday (except holidays), Eastern Standard Time. Kaba Access Control 2941 Indiana Avenue Winston-Salem, NC Phone: (800) or (336) Fax: (800) or (336) Document: PKG Kaba

3 TABLE OF CONTENTS 1. ABOUT THE E-PLEX PC M-UNIT GETTING STARTED USING THE PC M-UNIT SOFTWARE Main Menu Setup Menu System Setup Talk to Host PC Menu Download Doors Upload Audits Manual Sync with Separate PC M-Unit Transfer Data from Host to USB Flash (for M-Unit) Transfer Data from USB Flash to M-Unit (for Lock Programming) Transfer Data from USB Flash back to Host (for viewing Lock Audits) Talk to Lock Menu Program Door Audit Door Maintenance Get Diagnostics & Config *Send Firmware* View Menu Door Info Lock Audits Help Menu PC M-Unit User Guide About Exit APPENDIX PC M-Unit Software Installation Page 3 of 23

4 1 ABOUT THE E-PLEX PC M-UNIT The E-Plex PC M-Unit is Kaba s hardware/software product that can be used to program and audit most of Kaba s E-Plex stand-alone, battery operated electronic locks. The E-Plex M-Unit (Maintenance Unit) software application can be installed on any Microsoft Windows XP Home or higher OS compliant PC. For practical purposes, the PC M-Unit program should reside on a Laptop or a Netbook PC so that it can be easily carried as a portable maintenance unit to program and audit locks, in conjunction with the supplied E-Plex PC M-Unit Communications kit. Note: You may also install and operate the E-Plex PC M-Unit software on the stand-alone Host laptop PC where the main E-Plex access control applications software (such as the E-Plex Enterprise) resides, rather than on a separate laptop/netbook PC. From now on, the laptop or the Netbook PC - which will be used as the PC M-Unit portable device - will be referred to simply as the M-Unit in this user guide. This E-Plex PC M-Unit Communications kit from Kaba comes with the following items in the package: 1 An industry standard IrDA (Infrared Data access) adapter with a USB interface to connect to the M-Unit PC, 2 A USB extension cable to connect the above IrDA adapter to the M-Unit, if need be, and 3 A USB flash drive, preloaded with the E-Plex PC M-Unit software application along with its User Guide. One end of the IrDA adapter plugs in to one of the M-Unit s USB ports and the other end of the IrDa transmit/receive infrared data window will be pointed at the E-Plex lock s IrDa window to transfer required data between the M-Unit and the lock. The USB memory (flash) drive will be used to store and transfer the lock configuration data and the audited events data between the M-Unit and the Host PC where the main E-Plex applications software and its locks/user access configuration database reside - eg., the E-Plex Enterprise. The USB drive will be used as a portable transport drive between the two non-networked PCs i.e., the Host PC and the M-Unit. Optionally, if your Host PC operates under a networked environment, either by wired LAN (Local Area Network) or by wireless LAN (via internet access), you will not need the USB drive to transfer data between the Host and the M-Unit. You can simply make use of the Host PC s IP address to transfer data between the two PCs over the network. Imporant: Please consult with your local IT personnel on how to setup your Host PC s network IP addressing and related schemes. There is no networking and IP addressing features offered in the E-Plex Standard software. The functionality and features of the E-Plex PC M-Unit software is generic, so it will work with most of Kaba s current and future E-Plex lock models and their related SACs (Stand-Alone Access Controllers) such as: E3000, E3200, E3600, E3700, E5000, E5200, E5600, E5700 and E5800 Series. The same PC M Unit software can be installed and used to support the following three Kaba s E Plex Access Control applications software: (1) E Plex Enterprise; (2) E Plex FIPS General; and (3) E Plex Standard. Page 4 of 23

5 2 GETTING STARTED The following are the minimum System Requirements for the M-Unit: Microsoft XP Home or higher OS with minimum 1MB of RAM, 4GB of storage memory (flash or hard drive) and at least one USB port. Built-in wireless LAN or wired LAN interface is optional for IP addressing usage with the separate Host PC. There are three ways of using the M-Unit either, (i) as an Integrated unit where the M-Unit software co-exists within the main E-Plex access control software such as the E-Plex Enterprise on the same laptop, (ii) or, as a Separate module where the PC M-Unit software is installed on a separate mini laptop or a Netbook PC and runs from there, independent of the Host PC where the main E-Plex application resides, (iii) or, optionally, in a Networked environment where the separate M-Unit device(s) can transfer data to/from the networked Server/Client PC(s) via IP addressing. Page 5 of 23

6 In the following sections, we will mainly concentrate on how to install and use the M-Unit program on a separate laptop or Netbook PC and use it in conjunction with the main E-Plex applications software on a Desktop Host PC, in this example the E-Plex Enterprise. Before proceeding further, you must have already installed the E-Plex Enterprise software on your Host PC and had logged in so that the Enterprise (Client) software application is running ready to communicate with the separate PC M-Unit. Important: As specified earlier, the PC M-Unit software works in conjunction with Kaba s different E-Plex access control applications software such as the Enterprise, the FIPS General, and the Standard. However, when you install the PC M-Unit software, you can choose only one of the above three applications to be installed and used on the M-Unit PC. Please ensure that your Host PC s E-Plex applications software is running before launching the PC M-Unit software. 1. Install the E-Plex PC M-Unit software from the supplied Kaba s USB flash drive via your M-Unit Netbook (or laptop) PC s USB port and follow the simple software install instructions on the screen. You may also jump straight to the Appendix section at the end of this user guide and follow the software installation instructions with screen shots described there and then come back to step 3. below to continue. 2. The USB drive also contains an electronic copy of this same PC M-Unit User Guide for you to view/print. 3. After the software is installed, run the E-Plex PC M-Unit software (for Standard only, Enterprise only or FIPS only) by clicking the appropriate PC M-Unit program icon on your M-Unit s (Laptop or Netbook PC s) desktop. or, or, If your PC M-Unit is for E-Plex Standard, when launched simply click OK to continue. No login name/password entry is required and the program will directly take you to the Main Menu screen as shown in Section If, on the other hand your PC M-Unit software is either E-Plex Enterprise or E-Plex FIPS, at the very first login you must type in the default login User name as kaba and the default Password also as kaba. The following example on how to login and use the M-Unit software for E-Plex Enterprise PC M-Unit. The procedure is exactly the same for the E-Plex FIPS PC M-Unit software also, the only difference being the locks/users access configuration data will be stored on each program s specific sync folder. Page 6 of 23

7 5. At very first login to this software enter the default name & password as kaba & kaba and the M-Unit program displays the Main menu window. At this point the PC M-Unit can be used only to, (i) access the Setup/System Setup menu, (ii) download from the Host PC s database the actual operators login name/password combo info via the USB flash drive, and (iii) to perform lock maintenance/ diagnostics only. All other functions are grayed out. So you must first transfer the actual operators list (name & password combos), lock configurations data, users access data etc from the Host PC s E-Plex applications database to the M-Unit s database via the USB flash drive. If you are operating under a networked environment, either through wired LAN or wireless LAN interface, you can transfer data back and forth between the separate M-Unit and Host PCs via the Host PC s IP address, instead of performing this operation via the USB flash drive. Once the PC M-Unit has received all configurations data and the actual login name/password combos from the Host PC, you must logout from the PC M-Unit program and log back in again with the actual name/password combo. 6. That is, from now on, you will be able to use all the features of the M-Unit > the main functions being, (i) to download locks/users configuration and access data from the Host PC for programming E-Plex locks, (ii) to program an E-Plex lock via the Kaba s IrDA interface adapter, (iii) to audit an E-Plex lock via the same IrDa interface adapter, and (iv) to upload back to the Host PC any harvested and saved audit events from locks. Important: In the integrated PC M-Unit operation where both the main E-Plex application and the M-Unit software are integrated within the same laptop PC, an inherent loopback IP address of (hidden) is already setup in the software so as to enable the data transfer seamlessly via this loopback IP addressing scheme. Page 7 of 23

8 3 USING THE PC M-UNIT SOFTWARE Ensure that your E-Plex application software (Enterprise, in this example) is running on your Host PC. 1 On your separate M-Unit s desktop screen, click the Kaba E-Plex PC M-Unit software icon to launch the program in this example, the Enterprise PC M-Unit.. Important: From now on, your operator login Name and Password combo will be the actual operator login info, downloaded earlier from the Host PC; click OK. 3.1 Main Menu This will open up the Main Menu of the program as shown below. The Main Menu provides access to six M-Unit functions, each of which is described briefly below. Please refer to Chapter 3 for more detail on each one of the functions that are available from the six drop-down menus. Page 8 of 23

9 Talk to Host PC This menu is used (i) to download locks/doors configuration files with users access rights from Host PC via its IP address, (ii) to upload saved audited files of locks/doors back to the Host PC via its IP address, and (iii) manually do the above two functions via the USB flash drive only, instead of through the IP addressing scheme. Talk to Lock This menu is used (i) to program locks with configuration and users access data via IrDA interface, (ii) to extract audited events from locks via IrDA interface, and (iii) to run the lock diagnostics and read its current state and its stored configuration data parameters via IrDA interface. View This menu is used (i) to view the locks configuration info received from the Host PC before programming the doors, and (ii) to view any previously stored audits of locks right on the M-Unit screen itself. Setup This menu is used to configure the IP Address(es) of the Host PC and any additional (Host) Client PCs, if desired when operating under a networked environment through which the M-Unit will exchange data, Note: As described earlier, inherent but hidden loopback IP address is already setup when the M-Unit works as an integrated M-Unit within the main E-Plex application software on the same/one PC. Exit This menu is used to exit from the PC M-Unit program. Help From this menu, you can view/print the PC M-Unit User Guide and also view Kaba s Customer Support contact info. 3.2 Setup Menu System Setup (not applicable to E-Plex Standard) 1 Click System Setup to open this menu. 2 It will open the System Setup window showing Local in the IP Address field which is always there. This means that there is no direct connection between the separate M-Unit PC and the Host PC to exchange data, and that you have to use the USB flash drive and physically carry it between the two PCs for the data transfer. Page 9 of 23

10 3 If on the other hand, your Host PC is networked and has an IP address, enter that value (eg.only: ) in a blank IP Address field and in the Name field, type in a description of that PC. You can now transfer the data between the two PCs via this IP address directly without using the USB flash drive. 3.3 Talk to Host PC Menu Important: The Host PC applications software (E-Plex Enterprise, in this example) must be running whenever the M-Unit wants to exchange data with the Host. Click Talk to Host PC to open this menu. Note: For E-Plex Standard, only the Manual PCM-Unit Sync option is available Download Doors (not applicable to E-Plex Standard) [Via IP Address only]: Click on Download Doors, select and check the boxes to download the available doors from each site and click the Download button. All the selected doors with their locks/users access data configurations will be transferred from the main Enterprise applications database to the PC M-Unit database. Note: You do not have to initiate any manual data transfer from the Host PC s side. Now you can program these locks any time, one at a time with the portable PC M-Uni with the IrDA interface. Page 10 of 23

11 3.3.2 Upload Audits (not applicable to E-Plex Standard) [Via IP Address only]: Click on Upload Audits, select and check the boxes to upload the saved audits of all locks from your site and click the Upload button. All the selected doors audited events data will be transferred from the M-Unit database to the main Enterprise applications database. Note: You do not have to initiate any manual data transfer from the Host PC s side. Later on, you can view these audited lock events under the Reports menu in the E-Plex Enterprise application Manual Sync with Separate PC M-Unit [Via USB Flash Memory Drive]: Important: You must perform the manual data transfer, both from the (desktop) Host PC side and from the (portable) M-Unit side as described below. This is the only way to exchange data between the two PCs if they are not networked Tranfer Data from Host to USB Flash (for M-Unit): Ensure that the USB flash memory drive is connected to a USB port of the Host PC. First, on the Host PC applications software (E-Plex Enterprise, in this example), from the main menu, click File, and click again Sync with Separate PC M-Unit... Click OK and then Close. Select the doors from the Host PC s database that you want to send to the M-Unit to program these doors/locks, browse to select the data transfer folder location on the USB drive, if one exists, or browse and type in and create a new data transfer folder (eg: <d>:\pcmu-datatransfer), and then click on the Transfer Data button. The locks/users access configuration data files from the selected doors from the Host PC will be transferred to this folder location on the USB drive. Also at the same time, any locks audited files that are stored on the USB drive (from the same folder location) will be transferred to the Host PC s database for viewing/printing under the Reports menu. Click OK and then Close. Page 11 of 23

12 Page 12 of 23

13 Tranfer Data from USB Flash to M-Unit (for Lock Programming): Similarly, to transfer the downloaded doors/users access configuration data files (that were transferred from the Host PC to the USB drive) to the M-Unit database for programming these doors/locks, you will need to plug this USB drive, now into the M-Unit s USB port, and again perform a similar manual data transfer operation on the M-Unit. This action will also transfer any saved lock audit files from the M-Unit database to the USB drive at the same time, which can be later uploaded to the Host PC. Click OK and then Close. Remove the USB flash drive from the Host PC s USB port and connect it to a USB port of the M-Unit. On the M-Unit software from Talk to Host PC menu, click on Manual Sync, browse to point to the same data transfer folder location on the USB drive (eg: <d>:\pcmu-datatransfer), and then click on the Synchronize button. When the data transfer is completed, the Transfer Complete message will be displayed; click OK and then Close Tranfer Data from USB Flash back to Host (for viewing Lock Audits): Later on, you must take the USB flash memory drive and plug it back to the Host PC to retrieve from it any transferred lock audits from the M-Unit. This is done by clicking File/Sync with Separate PC M-Unit and repeat the steps as described in section earlier. You can view/print the lock(s) audits under the Reports menu of the E-Plex application software on the Host PC. 3.4 Talk to Lock Menu Important: Since communicating with an E-Plex lock involves physically carrying the M-Unit to various door locations where the locks are installed, please ensure that you also carry Kaba s PC M-Unit IrDA adapter with your M-Unit. You must attach the USB end of the IrDA adapter to the M-Unit s USB port and point the IrDA lens window end against the lock s IrDA lens window - the distance between the IrDA lens windows of the E-Plex lock and the adapter should be less than about an inch (2.5 cm) or so. This IrDA adapter is a plug-n-play device and so no driver software is required. Also, you must login to the PC M- Unit program in Local connection mode whenever you talk to the lock to program or audit it. Click Talk to Lock to open this menu. Page 13 of 23

14 3.4.1 Program Door 1 Click Program Door to open the next window and select and check the box to program your desired door/lock from its site; do not click the Program button yet. 2 If you want to override one or all of the parameters of the lock that is about to be programmed -> lock ID, lock function etc, click Edit, check the desired box(es) and then click OK. 3 Now on the E-Plex lock pushbutton keypad, enter one of the following sequences as applicable, where Credential = PIN#, or present Card (no # after), or PIN# followed by presenting the Card (no # after): # MasterCredential 900#, or # ManagerCredential 900#, or # M-UnitCredential ;Note: For M-Unit user, no 900# to enter. 4 The lock now enters the Communication Mode, indicated by alternate green and red LEDs of the lock flashing every second for up to 20 seconds. 5 Now hold the M-Unit such that its IrDA adapter (still connected to the M-Unit, either (i) directly or (ii) through the USB extender cable as shown below) lens is facing the IrDA lens of the lock, located above the lock push buttons 1 and 2. The distance between the two IrDA lens windows should be less than about an inch (2.5 cm) or so. (or), 6 Now click the Program button on the M-Unit screen. The transfer of data from the M-Unit to the door lock begins and a Programming Successful message is displayed when done. Page 14 of 23

15 3.4.2 Audit Door 1 Click Audit Door to open the next window and select and check the box to audit your desired door/lock from its site; do not click the Get (Audit) button yet. 2 Now on the E-Plex lock pushbutton keypad, enter one of the following sequences as applicable, where Credential = PIN#, or present Card (no # after), or PIN# followed by presenting the Card (no # after): # MasterCredential 900#, or # ManagerCredential 900#, or # M-UnitCredential ;Note: For M-Unit user, no 900# to enter. 3 The lock now enters the Communication Mode, indicated by alternate green and red LEDs of the lock flashing every second for up to 20 seconds. 4 Now hold the M-Unit such that its IrDA adapter (still connected to the M-Unit, either (i) directly or (ii) through the USB extender cable as shown below) lens is facing the IrDA lens of the lock, located above the lock push buttons 1 and 2. The distance between the two IrDA lens windows should be less than about an inch (2.5 cm) or so. Now on the M-Unit screen select the # (number) of audited events to download (1 through up to 30,000). This number always starts with the most recent audited events stored in the lock. Page 15 of 23 (or),

16 5 Click the Get button on the M-Unit screen. The transfer of audited data from the lock to the M-Unit begins and an Audit Successful message is displayed when done. 6 Click the Display button to view the audited events on the M-Unit screen, though in a brief format. However, when this audit file is uploaded back to the Host PC, you can view/print the complete audits with detail under the Host PC applications Reports menu. Page 16 of 23

17 3.4.3 Maintenance Click Maintenance to open this window. This menu is used to (i) verify if the lock s electronics and firmware are functioning correctly and (ii) in future to update the lock s firmware, if and when new features are offered in the lock by Kaba [*factory support will be required for any lock firmware updates*] Get Diagnostics & Config 1. You will need to talk to the lock via the IrDA adapter interface to perform the lock maintenance functions, just as you would do when programming and/or auditing an E-Plex lock. Please refer to either section Program Door, or section Audit Door on how to initiate this process on the lock side to initiate the lock communications. 2. Click Get Diagnostics and then click Start. The lock diagnostic tests will be performed continuously and the results will be displayed as shown below. Some of the important test display items are the lock s model number, its battery voltage level, its firmware version, the current date & time in the lock etc. 3. Click Stop to discontinue performing the diagnostics and then Close to get back to the previous Diagnostic Display screen. 4. To read the lock s current configuration data parameters, click Get Config; ensure first that you had already initiated the communications with the lock with the IrDA connection. 5. The lock configuration data display will be as shown below the lock in this example is an E- Plex 5700 (PIN & Prox) lock. Some of the important lock configuration parameters shown will be same as that displayed under the lock s Diagnostics submenu. 6. Click Close when done. Page 17 of 23

18 *Send Firmware* Note: The lock s firmware update feature is for future use only and will require Kaba s factory assistance, if and when this feature is offered *it is currently disabled*. 3.5 View Menu Click View; from this menu you can read and view, (i) the lock/user access config data of the door/lock that was downloaded from the Host PC to the M-Unit for the purpose of programming this lock, and (ii) any saved locks audits right on the M-Unit screen Door Info 1. Click Door Info and select the door you are interested in to view its configuration and verify it for accuracy before programming the lock. Page 18 of 23

19 2. Click one tab at a time at the top of this screen to view the Users, Schedules, Holidays and the Configuration data of this door/lock to ensure that all the info is correct; click Close when done Lock Audits 1. Click Lock Audits and select the door from which you want to view the saved audited events of this door, right on the M-Unit screen in a basic format. Page 19 of 23

20 3.6 Help Menu Click Help and then click PC M-Unit User Guide to view or print the PC M-Unit User Guide (this guide) or, click About to view the program s version number and Kaba s Help Desk contact info PC M-Unit User Guide About 3.7 Exit Click Exit to logoff and exit from the PC M-Unit program. Page 20 of 23

21 4. APPENDIX 4.1 PC M-Unit Software Installation The E-Plex PC M-Unit Software and the PC M-Unit User Guide (this guide) are located on the USB flash drive that came with Kaba s PC M-Unit kit. Plug in this USB drive into one of the USB ports of your M-Unit (Laptop or Netbook PC). In a few seconds, you will see the following screen on your M-Unit. Ensure that Show Kaba s E-Plex PC M-Unit Software is highlighted. Click OK to continue which will open the next window, giving you an option to either view/print the PC M-Unit User Guide or install this software. You must first install the Microsoft.Net Framework 2.0, followed by clicking on Install E-Plex PC M-Unit tab. This will open the actual PC M-Unit install window as shown below. You must select and install one of the three available PC M-Unit software to work with your Host PC s E-Plex application such as -> Enterprise, or Standard or FIPS. The PC M-Unit software installation process will begin and you need to just follow the instructions on the screen. The following are a few screen shots taken during the install process. Click Finish when done. Page 21 of 23

22 The E-Plex PC M-Unit software is now installed on your M-Unit portable unit and the program s icon will be displayed on your PC M-Unit s Desktop. Note: It will actually show as either Enterprise PC M-Unit, or as Standard PC M-Unit, or as FIPS PC M-Unit, depending on which PC M-Unit version you installed as shown below: or, or, Whenever you want to run the PC M-Unit program, double click on your installed version of the program icon. Page 22 of 23

23 Kaba Access Control 2941 Indiana Avenue Winston-Salem, NC USA Tel: (800) (336) Fax: (800) (336) E-Plex 5900 Series Card-Connected Lock and M-Unit User Guide PKG Disclaimer: While reasonable efforts were made to ensure the accuracy of this document at the time of printing, Kaba assumes no liability for any errors or omissions. This information is subject to be revised without notice, and changes may be incorporated in future releases.