EMBEDDED ACCESS CONTROL Software User Guide PERPETUAL INNOVATION

Transcription

1 EMBEDDED ACCESS CONTROL Software User Guide PERPETUAL INNOVATION

2 Lenel goentry Software User Guide, product version This guide is item number DOC-ENSW- ENU, revision 1.001, November 2009 Copyright Lenel Systems International, Inc. Information in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Lenel Systems International, Inc. The software described in this document is furnished under a license agreement and may only be used in accordance with the terms of that agreement. Lenel is a registered trademarks of Lenel Systems International, Inc. Windows and Microsoft are registered trademarks of Microsoft Corporation in the United States and other countries. Other product names mentioned in this User Guide may be trademarks or registered trademarks of their respective companies and are hereby acknowledged. The software included in this product contains copyrighted software that is licensed under the GPL. You may obtain the complete Corresponding Source code from us for a period of three years after our last shipment of this product, which will be no earlier than , by sending a money order or check for $5 to the following address: Lenel Systems International, Inc Pittsford-Victor Road Pittsford, NY Please write source for goentry in the memo line of your payment. You may also find a copy of the source at This offer is valid to anyone in receipt of this information.

3 Table of Contents Table of Contents CHAPTER 1 Introduction Conventions Used in this Documentation CHAPTER 2 Starting the Embedded Access Control System Install Prerequisites Log on to the Embedded Access Control System Navigate the Embedded Access Control System CHAPTER 3 Hardware Setup Scan for Hardware Configure Card Formats Configure Date and Time Settings CHAPTER 4 Access Management Create System Schedules Creates Access Levels Add a Person CHAPTER 5 Operations Operate Doors Software User Guide 3

4 Table of Contents View Events CHAPTER 6 System Maintenance Backup and Restore the Database Update Firmware Reset the System To Factory Defaults Index Software User Guide

5 CHAPTER 1 Introduction The embedded access control system software is embedded directly onto the hardware controller. For more information on the hardware, refer to the Hardware Installation user guide located at goentry.lenel.com/help/. Using the embedded access control system allows you to: Control access for up to 16 doors based on user-defined access control schedules. Configure schedules to include recurring holidays. Add up to 500 users and badges to the system Monitor events remotely on the system. Open doors remotely. Add reader schedules to help automate the system. Conventions Used in this Documentation The text in this manual is formatted to make it easy for you to identify what is being described. Where a term is defined, the word is represented in italics. Field names are shown in bold. Menus and menu choices are shown in bold italics. All menu choices have accelerator keys, which enable you to select the menu choices using the keyboard. The underlined letter represents the accelerator key for that menu item. Accelerator keys are written, for example, <Alt>, <C>. Keyboard keys are represented in angle brackets. For example: <Tab>, <Ctrl>. Keyboard key combinations are written in two ways: <Ctrl> + <Z> means hold down the first key and press the second <Alt>, <C> means press the first key, then press the second Buttons on the screen are represented in square brackets; for example: [Modify], [Cancel]. Software User Guide 5

6 Introduction 6 Software User Guide

7 CHAPTER 2 Starting the Embedded Access Control System Before starting the embedded access control system you must first install a few prerequisite programs such as Adobe Flash and Microsoft Internet Explorer. The following describes the prerequisite steps you must perform before using the embedded access control system. Once the prerequisites are installed you will be able to access the embedded access control system and learn how to navigate its interface. The procedures in the following sections should be reviewed and followed: Install Prerequisites on page 7 Log on to the Embedded Access Control System on page 7 Navigate the Embedded Access Control System on page 8 Install Prerequisites Before using the embedded access control system you must first connect your Windows computer via an ethernet cable to the VertX hardware. For more information on how to do this, refer to the Hardware Installation Guide. You must also have the following installed on your computer: Internet Explorer 7 or newer. Adobe Flash Player 9 or newer. Log on to the Embedded Access Control System To access the embedded access control system you need to access its IP address through Internet Explorer. Software User Guide 7

8 Starting the Embedded Access Control System How to Access the Embedded Access Control System 1. Open Internet Explorer on the computer that has access to the network that the controller is connected to. 2. Enter the controller s IP address as configured through either the discovery client or virtual port into the address bar of Internet Explorer. 3. Use the default log in credentials to access the embedded access control system. The default user name and password for the administrator are: Username: admin Password: demo IMPORTANT: It is highly recommend that you change the default user name and password. User names and passwords are chosen by the user when they are added to the system. For more information, refer to How to Add a Person on page Select the language you would like the system to use. 5. Click [Log In]. Navigate the Embedded Access Control System Once you log into the embedded access control system you are presented with the Home screen. The Home screen acts as a hub to the other sections of the system. By utilizing the links listed on the Home screen you can quickly navigate to other sections of the embedded access control system to perform necessary tasks to configure your system. How to Navigate the Home Screen 1. On the Home screen a list of navigations links are listed. 2. Click the links to go to the other sections of the system. The navigation menu on the left side of the screen can also be used to navigate to the other sections of the system. 8 Software User Guide

9 CHAPTER 3 Hardware Setup To configure the embedded access control system for use you need to first configure the controllers and door readers that are connected to your system. This is done through the Hardware Setup screens. The procedures in the following sections should be reviewed and followed: Scan for Hardware on page 9 Configure Card Formats on page 11 Configure Date and Time Settings on page 12 Scan for Hardware Installing the hardware for your system is done on the Devices screen. The Devices screen allows you to configure the hardware connected to your system. The hardware is listed in a tree structure. The top of the tree lists your V1000 controller, which is the main unit you ve installed. Listed directly below the V1000 controller are all of your V100 IO Boards, which your doors and readers connect to. Listed below the V100 IO Boards are your doors. Clicking on the doors allows you to configure the door and the reader(s) connected to them. Once the hardware devices are installed they are automatically found by the software and configured by the system. How to Install Hardware 1. Make sure that the hardware has been physically installed and properly connected. 2. On the navigation menu, click Hardware Setup and select Devices. 3. Click [Scan for Hardware Changes]. If the V100 devices are connected properly they will appear in the hardware list. This may take a few minutes depending on how many devices are installed. 4. Click [Save Changes] to save any hardware changes. 5. Optionally, you can change the name of the device to be more descriptive by modifying the text in the Device Name field. Software User Guide 9

10 Hardware Setup How to Configure a V1000 Controller 1. On the navigation menu, click Devices. 2. Select the controller you need to configure. 3. Click Network Configuration to display the network configuration information. 4. Click [Configure]. The Network Properties window opens. The fields are self populating and you should not have to configure them further. If you must then you can configure the properties that you want to change. WARNING! Modifying information listed in the Network Properties windows incorrectly can cause system malfunctions. Modify the Network Properties window only if you know how to do so correctly. 5. Click [Save]. How to Configure a V100 IO Board 1. On the navigation menu, click Hardware Setup and select Devices. 2. Select the reader (V100 IO Board) you need to configure. If you do not see your devices on the Devices screen then click, [Scan for Hardware Changes]. This refreshes the device list. 3. Select how your readers and doors will be used by selecting how many readers will control how many doors. 4. If you make any changes, click [Accept Changes]. How to Configure a Door 1. Select a door that you need to configure. 2. The device information is displayed on the screen. 3. On the Properties tab, configure the following options: a. Normal Grant Access Time - Set the amount of time a door temporarily opens when access is granted. b. Extended Grant Access Time - Set the amount of time a door temporarily opens when a person has Use extended strike/held times enabled on their badge. c. Open Time - Set the amount of time that a door open after a REX event occurs. d. Held Time - Set the amount of time that a door can remain open after a successful access grant or REX event. After that time expires a door held event occurs. e. Alarm Enabled - Enable whether door held and door forced alarm events are triggered. f. REX (Request to Exit) Input - Choose how to handle request to exit inputs. REX input detects if someone has pressed a button or triggered the input in another way to let the hardware know that they want the door to be temporarily unlocked as though someone was granted normal access to the door. REX can be set to be either supervised or unsupervised. An unsupervised input is an unprotected, low security input. Someone can defeat the circuit and a tamper will not be detected. By contrast, a supervised input s circuit is equipped with resistors. Subtle changes in the voltage on the circuit can be detected to determine whether someone has tampered with the wiring. For this reason, supervised inputs are high security. This option can also be set to be normally closed or normally open to accommodate the REX switch connected to this input. 10 Software User Guide

11 Configure Card Formats g. Door Monitor Input - Choose how to handle door monitoring input. Door monitoring input monitors the state of the door whether it is open or closed. If the door being monitored by this input is opened then this input will detect it. If it is opened without a grant access or without being unlocked (by REX for example) then it will cause a door forced alarm to be generated. 4. Depending on the reader selections made you will see tabs with door names that you have created. On these tabs select the options applicable to your system. These include: a. Reader Name - Enter a name that describes the reader. b. Maximum Pin Length - The number entered here is the maximum amount of numbers that the Pin number can be. c. Pin Timeout - The number of seconds that a pin must be entered after a badge has been presented. Only applicable if the reader is in badge and pin mode. d. Attempt Limit - The number of times that the wrong pin number can be entered before the door reader locks a person out. e. Failed Attempt Lockout Time - Used in conjunction with the Attempt Limit field, the number of seconds a person must wait after reaching the attempt limit. f. Access Method - Choose whether the door can be accessed via badge only or badge and PIN. If you choose badge and pin then you must present the badge first at the door and then enter your PIN. 5. Click [Accept Changes]. Configure Card Formats The embedded access control system offers several different card formats to use as badges for people who access the system. When choosing a card format make sure to select the same format as the cards you have purchased. If none of the pre-defined card formats are valid for your system you are able to create a custom card format to use as long as its bit length is greater than 0 and less than or equal to 128. IMPORTANT: Data bits are separated into two continuous fields. The first is the Facility Code which is generally the same for a single facility and Card Number, which is a unique identifier in the system tied to a single identity. How to Add a Card Format 1. On the navigation menu, click Hardware Setup and select Card Formats. 2. Click [Add]. 3. From the Format Type drop-down box, select the card format type that you are using. 4. Add a name for the card format. 5. In the Facility Code field, enter the facility code that you received from the manufacturer of your cards. 6. Click [Accept Changes]. How to Create a Custom Card Format 1. On the navigation menu, click Hardware Setup and select Card Formats. Software User Guide 11

12 Hardware Setup 2. Click [Add]. 3. From the Format Type drop-down box, select Custom. 4. Add a name for the card format. This field must be between 1 and 15 characters 5. Configure the Total Bit Length field. This field must be between 1 and 128 characters. 6. Configure the Starting Bit and Bit Length for the card number and facility code. These fields cannot overlap. 7. Configure the Facility Code field. This is usually a unique identifier for the system. 8. Configure the Number of Even Parity Bits field. The even parity bit is always the left most bit in the card format. 9. Configure the Number of Odd Parity Bits field. The odd parity bit is always the right most bit in the card format. 10. Click [Accept Changes]. Configure Date and Time Settings The date and time being set correctly is integral to the proper display of events as most events use date and time settings to display specific information. How to Configure Date and Time Settings 1. On the navigation menu, click Hardware Setup and select Date and Time. 2. Select the correct time zone for where the system is located. 3. Select whether you want the clocks adjusted automatically for daylight saving time. 4. Configure the Date and Time field to match the current date and time. 5. Click [Save]. 12 Software User Guide

13 CHAPTER 4 Access Management Once you have completed the hardware installation and configuration you must configure the system for daily use. This is done on the Access Management screen. The Access Management screen allows you to create a schedule which will determine when your system is accessible by permitted cardholders. You can also create holidays, access levels, reader schedules, and add additional personnel to the system. You would want to configure schedules, holidays and access levels to control the time and dates that your system will be online and accessible by permitted cardholders. The procedures in the following sections should be reviewed and followed in this order: Create System Schedules on page 13 Add Access Levels on page 15 Add a Person on page 15 Create System Schedules Schedules are user defined days and time that set when the embedded access control system will be online and accessible. For most this will be a normal eight-to-five schedule but obviously can be changed for any work hour. Schedules can also include Holidays, which are user defined dates that compliment the set schedule by creating special hours of operations that may occur annually. Readers can also be assigned reader schedules so that they can be set so the doors are locked or unlocked during certain hours and/or holidays. How to Add Holiday Groups 1. On the navigation menu, click Access Management and select Holiday Groups. 2. Click [Add]. The Holiday Group Properties window opens. Software User Guide 13

14 Access Management 3. In the Name field, enter a name for the holiday. 4. Click [Add Holiday]. 5. Select the date of the holiday. 6. Enable the Repeats Yearly check box if you wish the holiday to repeat yearly. 7. Repeat steps 4-6 to add more holidays. 8. Click [Save Changes]. How to Add Schedules 1. On the navigation menu, click on Access Management and select Schedules. 2. Click [Add]. The Schedule Properties window opens. 3. In the Name field enter a name for the schedule. 4. In the Schedule Intervals listing window, set the hours each day your system will be active. 5. In the Scheduled Holiday Groups listing window, select the holiday groups you want to add. 6. Click [Save Changes]. How to Add Reader Schedules IMPORTANT: Only entry readers can have schedules that put the door in an unlocked state. An exit reader with an unlock scheduled will be ignored. 1. On the navigation menu, click on Access Management and select Reader Schedules. 2. With the Intervals tab selected, click [Add]. a. Click [+] to add a schedule to the reader. b. Select the days of the week you want the schedule to be active. c. Set the hours you want the schedule to be active. d. Select the mode you want the reader to be in for that schedule. The choices are: Badge and Pin - A person needs to present their badge and enter their pin for access. Badge Only - A person needs to present their badge for access. Locked - A door is locked and cannot be accessed. Unlocked - A door is open and does not require credentials to be accessed. First Card In Badge and Pin - The first person to access the door needs to present their badge and enter their pin for access but the door is then unlocked for the duration of the schedule. First Card In Badge Only - The first person to access the door needs to present their badge for access but the door is then unlocked for the duration of the schedule. e. To add different schedule hours to the same days click [+] next to the reader mode dropdown. f. Click [Accept Changes]. 3. Select the Holiday Group tab. a. Click [+] to add a holiday group to the schedule you are creating. b. Select the holiday that you want to add to the reader schedule. For more information on how to add holidays, refer to How to Add Holiday Groups on page 13. c. Set the hours you want the schedule to be active. d. Select the mode you want the reader to be in for that schedule. 14 Software User Guide

15 Add Access Levels e. To add different schedule hours to the same days click [+] next to the reader mode dropdown. 4. Click [Accept Changes]. You can now assign a reader schedule to a door. For more information, refer to How to Add Schedules to Doors on page 18. Note: To view the schedule in a calendar view, select the Weekly Preview tab. Add Access Levels Access Levels are used to control hardware access by one or more Persons that have been added to your system. How to Add Access Levels 1. Once a Schedule has been created, on the navigation menu click Access Management and select Access Levels. 2. Click [Add]. The Access Level Properties window opens. 3. In the Name field enter a name for the access level. 4. Select the reader(s) you wish to configure the access levels for. 5. In the corresponding drop-down box select the schedule you wish to have configured for the access level. 6. Click [Save Changes]. Add a Person On the Persons screen you can add a person who will have access to the doors and/or the embedded access control system itself. From this screen you can also assign badges to those persons so they can physically access the doors. If you already have a list of people that you want to add to the system you can import the list if it s formatted into comma separated values or CSV. The fields that can be imported are listed in the order in which the CSV should be formatted: FirstName, MiddleName, LastName, Person ID, Title, Department, Division, Location, and . How to Add a Person 1. On the navigation menu, click Access Management and select Persons. 2. On the bottom left of the Persons screen, click [Add]. 3. Fill in the name and cardholder ID of the person you are adding. 4. On the Details tab, enter the information for the person you are adding to the system. 5. On the Badges tab, click [Add] to assign a badge for the person you are adding to the system. For more information, refer to How to Assign a Badge to a Person on page If the person you are adding will have access to the embedded access control system then configure the User Account tab. If not, skip to the next step. a. Log on credentials - The log on credentials include the user name and password that the person will use to gain access to the system. Software User Guide 15

16 Access Management b. Role - The role chosen allows the person being added specific abilities in the system. These Roles include: View Only - Can only view information in the system. Operator - Operates the system such as opening and closing doors. Administrator - Administers the system such as adding people to the system and configuring badges. 7. Optionally you can upload photos for your person. To do this: a. With the person selected, double-click the silhouette graphic. The Upload Photo window opens. b. Click [Select File] and browse for the picture you would like to add. The file must be 10kb or less. c. Once the picture is selected click [Upload]. A picture is now associated with the person. 8. Click [Accept Changes]. How to Assign a Badge to a Person IMPORTANT: You must have the badge you d like to assign in hand before beginning this procedure. 1. On the navigation menu, click Access Management and select Persons. On the Persons screen, select the user you would like to assign a badge to. 2. Select the Badges tab and click [Add]. 3. The Badge Details window opens. On the General tab, configure the following options: a. Badge Format - Select the format that corresponds to the badges you are using. Make sure that you do not select Raw Data if you plan on adding the badge using a formatted Badge ID in the future or you will receive unpredictable errors. b. Badge ID - If you are using a specified badge type this number must match the number found on the specific badge you are assigning. c. PIN - Enter the PIN number that the user will enter when the access type calls for PIN access. Note: If you are using a PIN reader it must support the Dorado 8 bit burst format. d. Use extended strike/held times - Enable to allow this badge holder to have extra time to get through the door. e. Pin Exempt - Enable to allow this badge holder to not have to enter a Pin number. 4. While still on the General tab set the dates that this badge will be active for. 5. On the Access Levels tab, select the access levels that the badge will use. An access level is required for all badges. For more information, refer to How to Add Access Levels on page Click [OK]. How to Import Existing Groups of Persons 1. On the navigation menu, click Access Management and select Import Persons. 2. Copy and paste a list of CSV (comma separated values) formatted information into window provided. The order in which to add the user is FirstName, MiddleName, LastName, Person ID, Title, Department, Division, Location, and . Make sure to add a blank value for any blank data. For example, importing someone without a middle name would be FirstName,,LastName. 16 Software User Guide

17 Add a Person 3. Click [Next] and review the information. 4. Click [Import] to import the data. This may take several minutes to complete. Software User Guide 17

18 Access Management 18 Software User Guide

19 CHAPTER 5 Operations The embedded access control system is a door-centric product wherein the system focuses specifically around door access being granted or denied. Most day to day operations will focus on the Doors screen and Events screen. The Doors screen allows you change the door status to be open or closed or locked or unlocked. The Events screen will allow you to view the events that have been triggered by the system. The procedures in the following sections should be reviewed and followed: Operate Doors on page 17 View Events on page 18 Operate Doors The Doors screen allows you to view who was last granted access and change the status of the door to Normal Mode, Lock Door, or Unlock Door. Normal Mode sets the door to whatever is the normal setting for your system, usually locked. Lock Door locks the door allowing no one access. Unlock Door unlocks the door allowing anyone access. You can also select Open Door which will unlock the door for a brief time to allow someone at the door to enter. The Doors screen also allows you to add a schedule to the door. These schedules allow you to further customize access to the doors in the system by setting times when they are unlocked and when a PIN is required to enter. For more information, refer to How to Add Reader Schedules on page 14. How to Change the Door Status 1. On the navigation menu, click Doors. 2. On the bottom right of the screen make sure that you are in Event View mode. 3. Click the drop-down box on the door you want to change the status of. 4. Select Open Door, Normal Mode, Lock Door, or Unlock Door to perform that action. Software User Guide 17

20 Operations Note: When door modes are changed you may see door forced or held alarm events. This behavior is to be expected. How to Add Schedules to Doors 1. On the navigation menu, click Doors. 2. On the bottom right of the screen make sure that you are in Schedule View mode. 3. Using the Reader Schedule drop-down box, select a schedule that is to be used for each door. For more information, refer to How to Add Reader Schedules on page Click [Accept Changes] to save the changes that you have made. View Events The Events screen allows you to view the events that have occurred on the system. Events listed include access granted as well as access denied events. The Events screen also lists the cardholder who initiated the event along with the time that the event occurred. Events are items listed when the system is engaged in certain actions such as when a badge is presented or a door is forced open. Up to roughly fifty events are visible within the view at any one time. You can optionally load more events though your system will run slightly slower while the events load into the system. The Events screen is purely a list of events that have occurred on the system though you are able to export events for the purpose of record keeping. How to Load Historical Events IMPORTANT: If the controller is rebooted all of the historical events are lost and are no longer retrievable by the system. 1. On the navigation menu, click Events. 2. Click the drop-down box on the bottom left of the screen and select either Load All Events or Load More Events. Selecting Load All Events will load all events in your system and may take up to 10 minutes to finish. Selecting Load More Events will only load another onehundred events. How to Export Events 1. On the navigation menu, click Events. 2. Click the drop-down box on the bottom left of the screen and select Export Events. 3. The Events CSV window opens. Click [Copy to Clipboard]. 4. Open a text editor and paste in the events. 5. Save the file to your system using the.csv file extension. The.CSV file extension allows programs like Excel to read the exported data properly. 6. Click [Close] on the Events CSV window to return to the system. 18 Software User Guide

21 CHAPTER 6 System Maintenance Occasionally it will be necessary to perform system maintenance on your system. This includes items such as updating firmware and backing up your database. The procedures in the following sections should be reviewed and followed: Backup and Restore the Database on page 19 Update Firmware on page 20 Reset the System To Factory Defaults on page 20 Backup and Restore the Database It is always a wise decision to create a Backup of your database in case something goes wrong or your system suffers some type of technical failure. You may also want to store the backup database on a secondary computer in case your primary computer fails. If possible you may want to keep the backup database on removable media such as a CD or DVD. How to Backup your Database 1. On the navigation menu, click Hardware Setup and select Backup Database. 2. Click [Download Backup]. 3. Select a location to save the backup and click [Save]. You now have a backup of your database. How to Restore your Database 1. On the navigation menu, click Hardware Setup and select Restore Database. 2. Click [Browse] to locate and open the backup file that you created. Click [Upload Backup]. Your database is now restored. Software User Guide 19

22 System Maintenance Update Firmware You are able to update the firmware for the controller directly from the embedded access control system. It is recommended that you only update the firmware if you are having problems with the controller. It is recommended that you read the release notes for the firmware completely before proceeding. How to Update Firmware IMPORTANT: Once your firmware update has started be aware that the process cannot be cancelled and the firmware can not be downgraded once it has been upgraded. The controller will automatically restart once the firmware has been updated. This may take several minutes. 1. Download the updated firmware file from 2. On the navigation menu, click Hardware Setup and select Firmware Updates. 3. On the Update Firmware screen, click [Browse] to find and open the firmware file that you downloaded from 4. Click [Next]. 5. Click [Update]. The firmware is now updated. Reset the System To Factory Defaults Resetting your system will delete all device configurations including persons and badges and return the device to the state it was in at the time of manufacture. There should be no reason to reset the system unless something catastrophic has happened to your hardware. Make sure you have a complete backup of the system before resetting the system as all data will be deleted and be unrecoverable. How to Reset Your System to Factory Defaults 1. On the navigation menu, click Hardware Setup and select Reset Settings. 2. An administrator must enter their user name and password in the User Name and Password fields. 3. As a final safeguard to resetting the system you must type the phrase listed on the Reset Settings field exactly as shown. 4. Click [Reset System] to delete all data from your system. This will take several minutes. 20 Software User Guide

23 Index A Access Levels how to add C Card Formats how to add a card format how to create a custom card format Conventions... 5 D Database how to backup your database how to restore your database Date configure Devices how to configure a Door how to configure a V100 IO Board how to configure a V1000 Controller. 10 Doors how to change the door status how to configure E Events export historical view F Firmware how to update the firmware H Holidays how to add Home Screen how to navigate... 8 I Import persons Introduction... 5 M Maintenance P Person how to add how to assign a badge how to import... 14, 16 R Reset Settings S Schedules how to add System Maintenance T Time configure Software User Guide 21

24 Lenel Systems International, Inc, 1212 Pittsford-Victor Road Pittsford, New York USA Tel Fax