eXguard User Manual

6656-0397 Issue 1

Supplier information
eXguard is designed and manufactured by: TDSi Ltd., Sentinel House, Nuffield Road, Poole, Dorset BH17 0RE England Telephone: Within UK: International: Fax: Within UK: International: E-mail info@tdsi.co.uk Web site www.tdsi.co.uk Copyright Copyright 2003 Time and Data Systems International Ltd., Poole. All rights reserved. This document, and any software supplied with it, may not be reproduced in any form or by any means in whole or in part without prior written consent of the copyright owners. Policy Time and Data Systems has a policy to continuously improve its products. Therefore the company reserve the right to change specifications, colours or prices of its products at any time without prior notice. Limitation of liability In no event shall seller be liable to buyer, whether in contract or in tort or under any other legal theory, for lost profits or revenues, loss of use, or similar economic loss, or for any indirect, special, incidental, consequential or similar damages, arising out of or in connection with the sale, delivery, nondelivery, servicing, use, maintenance, condition or possession of any and all of the system or software, or for any claim made against buyer by any other party, even if seller has been advised of the possibility of such claim. In no event shall seller's liability under any claim made by buyer exceed the amounts paid for the system and the use of the software in respect of which such claim is made. 01202 679730 +44 1202 679730 01202 666222 +44 1202 666222

Page 2

6656-0397 Issue 1

Table Of Contents

Table Of Contents
Supplier information................................................................................................................ 2 eXcel4 is designed and manufactured by:.............................................................................. 2 Telephone: ............................................................................................................................. 2 E-mail ..................................................................................................................................... 2 Web site ................................................................................................................................. 2 Copyright ............................................................................................................................ 2 Policy .................................................................................................................................. 2 Limitation of liability ............................................................................................................ 2 How to Log in ........................................................................................................................... 7 Default log in details............................................................................................................... 7 If your details are not accepted:............................................................................................. 7 If you forget the System Admin password ............................................................................. 7 How to Upgrade your Licence Key ........................................................................................ 7 How to set up a multi-user system ........................................................................................ 8 Principles of operation ........................................................................................................... 8 Licence controls ..................................................................................................................... 8 Networking uses TCP/IP........................................................................................................ 8 How to install a multi-user system ......................................................................................... 8 How to upgrade from a single-user to a multi-user system ................................................... 8 How to use Objective Authentication .................................................................................... 9 How to set up and use Objective Authentication ................................................................... 9 Managing Objects.................................................................................................................... 9 How to create objects ............................................................................................................ 9 How to delete objects............................................................................................................. 9 How to define the properties of an object ............................................................................ 10 Managing Keys and Key Holders......................................................................................... 10

6656-0397 Issue 1

Page 3

Table Of Contents

How to add a Key Holder to an Access Group .................................................................... 10 How to add Keys to a Key Box ............................................................................................ 10 To add single Keys .............................................................................................................. 10 To add a batch of Keys from an import file .......................................................................... 10 How to issue Keys to a Key Holder...................................................................................... 10 How to search for a Key Holder ........................................................................................... 11 How to allow an Access Group into an Access Area........................................................... 11 eXguard Import .................................................................................................................... 11 To export data from eXguard 8 ............................................................................................ 12 To import data from a file ..................................................................................................... 12 eXguard 8 import file format................................................................................................. 12 Rules .................................................................................................................................... 12 Maximum lengths ................................................................................................................. 13 Text file format ..................................................................................................................... 13 How to export Key Holder data and pictures to another application.................................... 14 Managing Relays (inc. Door Lock Relays) .......................................................................... 14 How to create a control key ................................................................................................. 14 To create a control key ........................................................................................................ 14 How to control Doors and Relays manually......................................................................... 14 How to control Doors and Relays using Schedules............................................................. 14 How to control a Relay using Schedules ............................................................................. 14 How to Control a Door using schedules .............................................................................. 15 Managing Events and Alarms .............................................................................................. 15 How to create Operator Alarms ........................................................................................... 15 To create an operator alarm............................................................................................. 15 How to display Events ...................................................................................................... 17 How to display Events for an individual object ................................................................. 17

6656-0397 Issue 1

page 4

Table Of Contents

How to control which Events are recorded....................................................................... 17 To prevent an Event being logged ................................................................................... 17 Managing the database......................................................................................................... 18 How to backup your database manually.............................................................................. 18 How to backup your database automatically ....................................................................... 18 How to backup your database ............................................................................................. 18 Initial backup ........................................................................................................................ 18 Regular backups .................................................................................................................. 18 To backup your database manually ..................................................................................... 19 To backup your database automatically every day.............................................................. 19 To restore a previous backup .............................................................................................. 19 How to re-organise your database....................................................................................... 19 How to limit the size of your database ................................................................................. 19 To set up automatic deletion of Events................................................................................ 20 Reports ................................................................................................................................... 20 How to create Event Reports ............................................................................................... 20 How to create Instant Reports ............................................................................................. 20 How to create a Configuration Report ................................................................................. 20 To create a configuration report for all the equipment connected to one computer ........ 21 To create a configuration report for all the equipment connected to one portal .............. 21 To create a configuration report for all the equipment connected to one ACU................ 21 To add connection information for an ACU ...................................................................... 21 How to create Fire Reports .................................................................................................. 21 To create a fire Report for an Access Area...................................................................... 21 How to create a report using Crystal Reports...................................................................... 21 Creating a report: which Areas each Key Holder is allowed in to........................................ 21 How to install and use a Photo ID system .......................................................................... 23

6656-0397 Issue 1

Page 5

Table Of Contents

How to design and print Badges .......................................................................................... 24 To create a new badge design............................................................................................. 24 To print a badge ................................................................................................................... 24 Troubleshooting .................................................................................................................... 24 Trouble-shooting using the Explorer .................................................................................... 24 Troubleshooting Access Rights ........................................................................................... 25 Trouble-shooting communications ....................................................................................... 25 Is the Communications program for this ACU running?................................................... 25 Glossary ................................................................................................................................. 27 Index ....................................................................................................................................... 29

6656-0397 Issue 1

page 6

eXguard User Manual

How to Log in
1. The first time you use the Explorer on any machine you need to enter the name of your Tenant and Operator, taking care to use the correct spelling and upper case (capital) and lower case (small) letters. The next time you log in, eXguard will type these fields for you. 2. Enter your Password using either upper or lower case letters. 3. Press Enter or click the OK button. This will open The Explorer Main window Default log in details Unless they have been changed by the system administrator, the log in details are as follows: Tenant: Landlord Operator: Admin Password: tdsi

If your details are not accepted: Make sure that the Tenant and Operator fields are entered with the correct upper and lower case letters (your password is not case-sensitive) If you still cannot log in, contact your System Administrator who can issue you with a new password.

If you forget the System Admin password For security reasons, access to the eXguard system is entirely controlled by you, the user. You may, and indeed you should change the Admin password regularly to prevent unauthorised access to your system. Be very careful, however not to forget it. If you forget the Admin password, you may have to reinstall eXguard from scratch, or restore a back-up database that has a known password.

How to Upgrade your Licence Key

1. Obtain an Upgrade Key from your eXguard supplier, or TDSi. 2. Locate the computer which has your current Licence Key attached to its printer port:

3. Shut down all applications running on the computer and switch off the power (this is necessary to protect the license key when it is plugged in)

6656-0397 Issue 1

Page 7

eXguard User Manual

4. Disconnect the printer cable from the back of the Licence Key, if there is one attached. 5. Connect the Upgrade Key to the back of the Licence Key. 6. Power-up the computer 7. Run the eXguard Licence Server, and press the Upgrade button. The Licence Server will now add any additional items to your existing Licence Key. Note that the Licence Server now displays the additional items. 8. Shut down all applications running on the computer and switch off the power 9. Remove the Upgrade Key and discard it 10. Re-connect the printer cable, if one was disconnected 11. Power up the computer; eXguard can now make use of the new licence information

How to set up a multi-user system

Principles of operation In eXguard, all communication between the various software components is done via the database, SQLBase. So, in order for eXguard to work in a multi-user or networked environment, the only requirement is that every component must be able to read and write to the database. The database can be running on the same machine as other components, or on another machine on the network. Licence controls The number of client machines which can use the database at the same time is controlled by your Licence Key and the eXguard Licence Server. Networking uses TCP/IP Communications across the network uses the Internet protocol TCP/IP. In a multi-user system, each computer running an eXguard component must have TCP/IP installed. How to install a multi-user system First, install at least the Database on one computer, and make a note of that computer's IP address. Then install the required software (Explorer, Communications or both) on the other computer(s), entering the IP address of the computer with the Database when requested. Start the License Server on the Database computer before starting software on the another computer

How to upgrade from a single-user to a multi-user system You will need to un-install eXguard and re-install it, selecting the correct Database option. This will NOT remove the existing database. Then you will need to install the required components on the other computers. 6656-0397 Issue 1 page 8

eXguard User Manual

How to use Objective Authentication

Using Objective Authentication means denying access to a Key Holder until an Operator has visually verified that the Key that has been presented belongs to the person at the door. How to set up and use Objective Authentication 1. Decide when Objective Authentication will be used and where. 2. Define Access Areas and Group Schedules that deny access where and when required 3. If required, define "access denied" as an operator alarm, to draw attention whenever a card is presented for authentication 4. Store a picture against all Key Holders as necessary 5. When a key is used, double-click on the Access Denied message in the event list. This brings up a window with the stored picture of the Key Holder 6. Visually compare the displayed picture with the person attempting entry and click on Release Door to allow access. The door automatically re-locks, just as if the key had been granted access automatically. 7. Click on OK to close the window.

Managing Objects
How to create objects You need to be logged in as an Operator with Owner rights for the type of object concerned. For further information, see Operator Rights Explained in the Help system 1. Select the folder which will contain the new object in the Explorer tree. For example, to create a new Access Group, select the Groups folder. 2. Right-click the folder with the right mouse button, and select New... OR select File ... and New... from the Explorer's main File Menu. A properties sheet for the new object is displayed. 3. Fill in the Name of the new object, and define all its relevant properties. If you are not sure how to define the object's properties, just press Help or F1 . 4. Press OK to create the new object, or press Cancel to cancel the creation. How to delete objects You need to be logged in as an Operator with Owner rights for the type of object concerned. For further information, see Operator properties - Rights in the Help system There are four ways to delete objects under Windows using your Keyboard and/or mouse: right-click the object and select Delete .

6656-0397 Issue 1

Page 9

eXguard User Manual

select the object, then select Edit ... then Delete, from the Explorer's menu-bar select the object, then press the Del key on your keyboard select the object, then press the Delete, button on the Explorer tool-bar.

How to define the properties of an object There are several ways to examine or change the properties of an object: Select the object in the eXguard Explorer and press F4 on your Keyboard. Select the object in the eXguard Explorer and press the Properties button on the Explorer toolbar. Select the object in the eXguard Explorer, press the right mouse button, and select Properties from the pop-up menu. Select the object from a list box in any window, press the right mouse button, and select Properties from the pop-up menu.

To examine or change the properties of an object, you need to be logged in as an Operator who has Owner rights for the type of object concerned.

Managing Keys and Key Holders

How to add a Key Holder to an Access Group 1. Locate the Key Holder in the Key Holders list, click the right mouse button and select Properties. This displays the properties of the Key Holder. 2. Click the Groups tab, and press the New button. This displays the Add Key Holder to Access Group dialog and lists the Groups to which the Key Holder does not already belong. 3. Select the new Group from the list, and press the Add button, or just double-click the new Group in the list. How to add Keys to a Key Box Locate the Box where the Keys are to be added, using the eXguard Explorer. To add single Keys Select Add Key from the Box right click menu. This opens the New Keys dialog To add a batch of Keys from an import file Select Import Keys from the Key Box right click menu. This opens the Import Keys Dialog How to issue Keys to a Key Holder 1. Locate the Key Holder using the eXguard Explorer.

6656-0397 Issue 1

page 10

eXguard User Manual

2. Right-click on the Key Holder name 3. Click Issue Key from the right click menu. This opens the Issue Key Dialog How to search for a Key Holder This feature allows you to search for a Key Holder based on any information in their record. 1. Open the Key Holder list (select Key Holders in the Explorer tree) 2. Right-click anywhere in the list displayed in the display (except on an item in column 1) 3. Select Find ... from the pop-up menu. This opens the Find Key Holder window 4. If required, choose a column from the pull-down list 5. Enter some text related to the Key Holder you're looking for. 6. Press the Find button. 7. To search for the next matching Key Holder, press the Find button again, or close the Find Key Holder window and press F3 . How to allow an Access Group into an Access Area You allow an Access Group into an Access Area by dragging the Group from the Explorer tree and dropping it onto the desired Access Area. You drag the Group by selecting it with the left mouse button, and then, whilst keeping the left button down, moving the mouse over the desired Access Area, and then releasing the mouse button. If you only want to allow the Group to be able to enter the area at certain times of day, you need to create a Group Schedule, and to associate the Group with the Group Schedule. eXguard Import The eXguard Import program allows you to import the following data, and their interrelationships, from a text file: Key Holders Keys and Key Boxes Groups

There are two ways of creating this text file: To import Key Holder and Key information from an Utragard 8 database, you need first to export the relevant information from Utragard 8 into an export file, and then import the data from this file into eXguard You can also create your own file: For further information on the import file format, see eXguard import file format in the Help system

6656-0397 Issue 1

Page 11

eXguard User Manual

To export data from eXguard 8 1. If not already installed, install the export program from the eXguard CD (run setup.exe from the ug8xport directory) on the PC containing the eXguard 8 database 2. Run the export program and follow the on-screen instructions 3. When finished, if necessary transfer the resulting file to the computer where eXguard is installed. To import data from a file 1. From the Windows Start button, run the eXguard Import program. You will need to log in as an operator with appropriate rights. 2. Select the name of the file containing data exported from Ultragard 8, or locate it using the adjacent Browse button. 3. Enter or select the name of a file to contain a log of the import process, or locate an existing file using the adjacent Browse button. If the file does not already exist, it will be created for you. 4. Check "log all events" if you want successful as well as unsuccessful transactions to be recorded. 5. If required, enter a figure in the maximum errors field. The import process will abort if the number of errors logged (records not imported) exceeds the figure you put here. As a rough guide it should not need to be more than 5% of the number of people on record in your database. 6. Press OK; observe the progress indicator (large amounts of data take quite some time to process) 7. Click Cancel when finished - do not click OK as this will start another import operation eXguard 8 import file format Rules 1. All lines are comma separated. 2. Data is case sensitive. 3. Any data which is after the character ";" is ignored. this can be used for comment lines. 4. Fields should be contained within quotes. Spaces outside quotes will be ignored. 5. Operations have to be performed in order; e.g. you cannot assign a keyholder to an access group until the access group has been created. 6. Note that for security reasons data is only imported for the currently logged-in tenant. 7. Empty fields must always be included even when they are at the end of a line.

6656-0397 Issue 1

page 12

eXguard User Manual

Maximum lengths Key Holder Name 20 characters Access Group Name Key Box Name Long name Comment Key Number Info[1] to info[16] Key Technology PIN Expiry Start/End 20 characters 20 characters 50 characters 50 characters 8 numeric characters 20 characters see below 4 numeric characters date formatted as 16/5/99 or 16/5/1999 for 16th May 1999 or 16/05/2001 for 16th May 2001

Text file format #INSERT HOLDER, Name, Long Name, Comment, Info[1],Info[2],. . .Info[16] #INSERT ACCESS GROUP, Name, Long Name, Comment #INSERT BOX, Name, Long Name, Comment #INSERT KEY, Key Box Name, Key Number, Key Technology Insert Key (Keybox has to be in database already) Note Key technology is case-sensitive and must be one of the following: Microcard, Proximity, Magnetic, TDSi Wiegand, or 26-bit Wiegand #ASSIGN KEY, Key Holder Name, Key Number, Key Technology, PIN, Expiry Start, Expiry End #ASSIGN HOLDER, Key Holder Name, Access Group Name

Insert Key Holder

Insert Access Group Insert Key Box

Assign a Key to a KeyHolder (Key has to be in database already) Assign a KeyHolder to an Access Group (KeyHolder and Access Group have to be in database already)

6656-0397 Issue 1

Page 13

eXguard User Manual

How to export Key Holder data and pictures to another application You can export personnel data to another application by right-clicking on the Key Holders object in the Explorer tree and selecting Export Keyholder Data. The data will be saved in CSV (comma separated variable) format which can be read by many other types of application. If you wish, you can also export any pictures stored for Key Holders. The pictures are stored as JPG files, with the name of the file being the same as the name of the Key Holder. The name of the picture file is included in the CSV file.

Managing Relays (inc. Door Lock Relays)

How to create a control key When you add a Key into the database, by default it is an Access key and will allow access through doors (when allocated to a Key Holder) subject to the Group membership of that key holder. Another use for a key is to control a relay. Each time such key is used, the chosen relay will change state from Normal to ON, or vice versa (the key must be used at a reader attached to the same Access Control Unit as the relay). To create a control key 1. Add the key into the database if it is not already in - see How to add Keys to a Key Box 2. Locate the key in its key box and open its Properties sheet: 3. Click in the circle to the left of Relay Control, and select the desired Relay 4. Issue the key to a key holder - see How to issue keys to a Key Holder How to control Doors and Relays manually 1. Locate and select the Door or Relay on a Site Plan, or in the Explorer tree. 2. Right-click the object, and select the desired option from the pop-up menu 3. Alternatively, if you have selected the object in the Explorer tree, press the desired option button in the right hand panel. How to control Doors and Relays using Schedules How to control a Relay using Schedules Right-click on any relay (except a relay being used for a Lock) and select Properties Select the Triggers tab and change the Trigger Type to Schedule Select the Schedule tab and click on edit: this opens the Schedule Editor

6656-0397 Issue 1

page 14

eXguard User Manual

How to Control a Door using schedules Note 1: This can affect every door associated with this area. If you only want one door to be affected, you need to create an Area especially for the Door. Note 2: An "unlock" schedule will apply on every selected day - there is no way of having different behaviour on Holidays. If you want an unlock schedule that is different on Holidays, then use a spare Relay to control either the power to the lock or the Egress input. Schedules for Relays can be over-ridden by Holidays. Right-click on the Area associated with the door Select the Schedule tab and click on edit: this opens the Schedule Editor

Managing Events and Alarms

How to create Operator Alarms An Operator Alarm is generated when an event defined as such occurs, e.g. a particular door being left open. To make an Event generate an Operator Alarm, you will need to set the Event properties for the object in question. To create an operator alarm 1. Locate the object in the Explorer tree, right-click it, and select Properties. 2. In the Events tab (the third tab at the top) , right-click the chosen event, and select Properties. This displays the Event action details dialog 3. Click the box beside Generate operator Alarm . 4. To use an existing Alarm procedure, select it from the list of Alarm procedures, or the press New button to create a completely new Alarm Procedure. 5. In the Trigger and Sound tabs, choose any actions required 6. Click on OK to save the information (you may be asked to choose an Alarm Zone for the object in question)

How to control Operator Alarms

There are three operations you can perform on an Alarm: Acknowledge This will set the status of the Alarm to Acknowledged. It will remain visible in the Alarm list but its icon will stop flashing. If there are no other unacknowledged alarms for the object which generated this alarm, then the object's alarm icon will also stop flashing. Process procedure

6656-0397 Issue 1

Page 15

eXguard User Manual

This will open a window which allows you to take control of the alarm and apply some or all of the steps defined in the procedure. When all steps have been performed, the status of the alarm is set to Cleared and the alarm is cleared from the list. If there are no other un-cleared or unacknowledged alarms for the object which generated this alarm, then the object's alarm icon will disappear. Reports can be generated for cleared alarms. Delete This sets the status of the alarm to Cleared without having to process its procedure, although explanatory text must be entered. This can be performed on a multiple selection of alarms and is a quick way of clearing an alarm list. Some organisations may regard such "short-cuts" as a breach of duty. To control an alarm 1. The process of controlling alarms starts with opening an alarm list: If you want to see all alarms Press the Alarm List button: which is located on the eXguard Explorer toolbar If you want to locate the most recent or highest-priority alarm Open the Alarm Manager (if not already open) by right-clicking its icon in the System tray ( lower right of your screen on the Windows Task Bar close to the clock: and choose the required option. Then do one of the following: Click on the Locate button to see the location of the most recent alarm Click on the one of the coloured buttons to see the location of the most recent unacknowledged alarm with the highest priority in that priority band (i.e. top button is for alarms of priority level 1, 2 and 3; second button is for alarms of priority level 4, 5 and 6 etc)

In both cases, the Explorer General Display Area immediately changes to show the Alarm Zone containing the object that has generated the alarm. Right-click on the object and select Show Alarms If you want to see all the alarms for one Alarm Zone Right click on the Zone and select Show Alarms If you want to see all the alarms for one object Right click on the object and select Show Alarms 2. The Alarm List window is displayed. 3. Right-click on the chosen alarm and select the desired action or select the Alarm, and press Alarm on the Alarm List window's menu bar. If you select Process Alarm Procedure, the Alarm Control window is displayed.

6656-0397 Issue 1

page 16

eXguard User Manual

To stop an individual object generating alarms There may be occasions when you want an alarm zone to remain armed, but prevent an individual object from generating alarms. To do this, right-click the object and select Suspend. How to display Events There are two ways events relating to your entire site: Press the Event List button on The Explorer Main window toolbar. This displays an empty Event List Window within the Explorer; any new events will appear in this list. Right-click on Access Control Site - the top object on the Explorer tree - and select Show Events. This opens the Event Lists window. Event Lists in this window can be paused, and you can choose a time period for the list.

How to display Events for an individual object 1. Locate the object in the Explorer tree 2. click it with the right mouse button 3. select Show Events from the pop-up menu For further information, see: How to display Events How to control which Events are recorded Events are generated by Equipment objects, such as ACU's, Doors, Inputs, Relays, and Readers. All such Events are normally logged in the eXguard database, which is essential for commissioning your system, but does use disk space for every event recorded. Once your system is fully commissioned, you may wish to reduce the amount of Event traffic and disk space requirements by turning off Event logging for minor events such as Egress Button Off, or Door Closed. To prevent an Event being logged 1. Locate the chosen object in the Explorer, right-click it and select Properties 2. Select the Events tab and un-check the box to the left of the chosen event: it will then not be reported by the ACU, and will not generate Operator Alarms, or be stored in the database, or displayed in the Event List or Event Reports or Attendance Reports. Tip: When you have set up all the Events for one ACU, including the Events for all its Doors, Inputs, Relays and Readers, just copy and paste the ACU, and the new ACU will have exactly the same Events as the original one.

6656-0397 Issue 1

Page 17

eXguard User Manual

Managing the database

How to backup your database manually 1. From the Windows Start menu, run the eXguard Backup Utility (exbackup.exe). 2. On the Backup Options tab, select Manual 3. Choose the number of Backups you wish to keep (when you have reached this number, each new backup causes the oldest one to be deleted) 4. Select the folder where you want to store the backup copy of your database, or press the Location button to locate the folder using the Windows Explorer. We recommend making backups on a different hard disk - or even different computer - from the database (not a different partition on the same disk as the database) 5. Press the Backup button. This will create a backup copy of your database. How to backup your database automatically 1. From the Windows Start menu, run the eXguard Backup Utility (exbackup.exe). 2. On the Backup Options tab, select Automatic 3. Enter the time of day when backups should be performed 4. Select the folder where you want to store the backup copy of your database, or press the Location button to locate the folder using the Windows Explorer. We recommend making backups on a different hard disk - or even different computer - from the database (not a different partition on the same disk as the database) 5. On the Automatic Options tab, select whether you want Weekly backups, monthly backups, or both (we recommend both) 6. Select the days of the week (we recommend every day) and the day of the month. 7. Leave the Backup program running! How to backup your database As with all computer systems, it is important to keep backup copies of the eXguard database, as a precaution against an emergency such as electronic failure. Initial backup Once your system is installed and ready to run it is essential to make a backup of the database, since this will contain all the details of your system: areas, equipment, key holders, etc. Regular backups However it is also important to realise that the eXguard database will be collecting new event data every day, as well as recording any changes made to the structure, so it is advisable to adopt a regular backup routine to minimise loss of data. In some situations a weekly backup may be quite sufficient whereas in others, a daily backup may be required to minimise loss of event and key holder data.

6656-0397 Issue 1

page 18

eXguard User Manual

To backup your database manually 1. From the Windows Start menu, run the eXguard Backup Utility (exbackup.exe). 2. On the Backup Options tab, select Manual 3. Choose the number of Backups you wish to keep (when you have reached this number, each new backup causes the oldest one to be deleted) 4. Select the folder where you want to store the backup copy of your database, or press the Location button to locate the folder using the Windows Explorer. 5. Press the Backup button. This will create a backup copy of your database. To backup your database automatically every day 1. From the Windows Start menu, run the eXguard Backup Utility (exbackup.exe). 2. On the Backup Options tab, select Automatic 3. On the Automatic Options tab 4. Select the time each day when the backup should be performed. 5. Select the folder where you want to store the backup copy of your database, or press the Browse button to locate the folder using the Windows Explorer. 6. Press the Backup button. This will create a backup copy of your database each day at the specified time, provided that you do not terminate the backup program. To restore a previous backup Warning: Restoring a backup will overwrite your current database, so make a copy beforehand if necessary 1. Close down all eXguard programs on all machines which access the eXguard database. 2. Close down the database server program, SQLBase Server. 3. From the Windows Start menu, run the eXguard Backup Utility (exbackup.exe). 4. Select the folder where you made a backup copy of your database, or press the Browse button to locate the folder using the Windows Explorer. 5. Press the Restore button. This will restore the database from the backup copy. How to re-organise your database Any database can become fragmented and over-large over time. The Reorganise feature in the Backup program will clean up the database and compact it for efficiency. How to limit the size of your database Every Event which is stored in the database occupies a small amount of disk storage. Clearly you cannot keep recording Events for ever without eventually filling up your disk with old Events. 6656-0397 Issue 1 Page 19

eXguard User Manual

eXguard has an Event expiry facility, which automatically deletes Events after a given number of days. The eXguard Licence Server deletes them automatically without Operator intervention, normally soon after midnight each day. To set up automatic deletion of Events 1. Login as an Operator who has Owner rights for Tenants (the highest level of Operator rights). 2. Click the Database menu on the Explorer main window and select Options. This will open the Event Log Control window 3. Select the required options and press OK. Note that the larger the block, the slower the user interface will appear while events are being deleted. The smaller the block, the longer the process of deleting events will take.

Reports
How to create Event Reports Right-click on the Reports folder and select New Report. This creates the new Event Report, and allows you to define its properties. See also: Report properties - General in the Help system

How to create Attendance Reports

Right-click on the Reports folder and select New Attendance Report. This creates the new Attendance Report, and allows you to define its properties. See also: Attendance Report properties - General in the Help system How to create Instant Reports 1. Display a List Box on the screen, for example the list of Key Holders 2. Sort the information in the Instant Report by pressing the column title buttons across the top of the List box. 3. Right-click in any List box anywhere except on an item in column 1, and select Instant Report from the pop-up menu. 4. Select one of the following: View on screen Print Save to file ( RTF, plain text or CSV ) 5. Press OK to create the Report. How to create a Configuration Report A Configuration Report is a useful record of the hardware in your system, together with all the connection information.

6656-0397 Issue 1

page 20

eXguard User Manual

A Relay configuration report lists all of the relays in your system, together with their associations. To create a configuration report for all the equipment connected to one computer Right-click on the computer in the explorer tree and select Configuration report To create a configuration report for all the equipment connected to one portal Right-click on the portal in the explorer tree and select Configuration report To create a configuration report for all the equipment connected to one ACU Right-click on the ACU in the explorer tree and select Configuration report To add connection information for an ACU Right-click on the ACU, select Properties and choose the Wiring Details tabsheet. Then rightclick any connection and choose Properties How to create Fire Reports To create a fire Report for an Access Area Locate the Area in the Explorer tree, click it with the right mouse button, and select Fire Report from the pop-up menu. Disclaimer A Fire report does not necessarily contain correct, up-to-date information. Key Holders can (and do) tail-gate through open doors, borrow Keys from other people, and various other practices which make it unwise for anyone to rely totally on the information in a Fire Report. How to create a report using Crystal Reports eXguard PRO allows read-only access to the database, so that other software may be used to create reports. There are several reporting applications available but the most common is Crystal Reports (www.crystaldecisions.com). This topic is intended to show you the basic steps required to create a sample report using Crystal Reports - but the number of possible reports is limitless and so this can only be an overview. Full details of the database structure, its tables, fields and relationships, is contained in the document "eXguard Database Structure", which you will find on the eXguard CD in the Extras folder. Creating a report: which Areas each Key Holder is allowed in to 1. In the eXguard explorer, create a Database User with a name and password, and appropriate rights. 2. Run Crystal Reports and expand Create New Connection in the Database Expert. Expand OLE DB (ADO) and when prompted for a Provider select Gupta SQLBase OLE DB Provider. 6656-0397 Issue 1 Page 21

eXguard User Manual

3. Click Next and when prompted for a Data Source enter UG2000. In the User ID and Password fields, enter the data you used when creating the Database User in eXguard in step 1. 4. Click Next but do not change anything in the Advanced Information screen. Click Finish. 5. Expand the object that has the same name as your Database User. You will now see a list of all of the available tables in the eXguard database. For the purposes of this report (a list of each Key Holder and the Areas that each is allowed into) we need the following tables: Keyholder Group Area Keyholder_in_group Group_in_area In Crystal Reports 8.5 you can select the desired tables in the left-pane and use the right-arrow to have them appear in the right-pane. However in Crystal Reports 9, while this appears to work, it is necessary instead to use the Add Command feature (above the list of tables). Double-click on this and type in select * from keyholder. Repeat this for each of the tables listed above. As they appear in the list on the right with names like Command, Command_0, Command_1 etc., you can rename them so that their purpose is more obvious. 6. Still in the Database expert, click on the Links tab at the top. You will see that Crystal Reports has tried to make sense of the links between the various fields, but these will be wrong. Click on Clear Links to clear all links and then create your own as follows (note that the direction of the link is most important):

You will see messages from Crystal Reports about multiple starting points and sources - ignore these. 7. Click on OK to close the Database Expert. Now expand the Database Fields object in Field Explorer. Expand the Keyholder and Area objects and drag the Name fields from each onto the report, renaming their Text descriptions, so that your report looks like this:

6656-0397 Issue 1

page 22

eXguard User Manual

8. Click on Preview (if visible) or choose Print Preview from the File menu to see your report.

How to install and use a Photo ID system

There are several requirements for a Photo ID system: 1. Your Licence Key must permit this feature to be used. If you are not sure whether this is already the case, the Licence Server display will tell you or you can refer to "Help About" in the eXguard Explorer - look for the words "Photo ID" against the title "Licensed options". If the Photo ID option is not present, you must upgrade your Licence Key. 2. If you wish to capture "live" images (rather than using ones created elsewhere and stored as BMP or JPG files) then you will need to install appropriate hardware in a computer which has access to the eXguard database. (If this is to be on an additional computer, you may also need to refer to How to set up a multi-user system). At the time of writing, the only supported hardware is the Hauppauge WinTV card. Please visit www. hauppauge.com for details of this product, which is available from many computer hardware outlets, as well as from TDSi. Please refer to the Readme.doc file for any additions to this. Other video "grabber" cards may work if they support "Video for Windows" and have a driver which works under your operating system, but TDSi cannot warrant or support the use of any other cards. 3. If you wish to print Badges you will also need a suitable printer, which must be installed under Windows. Not all badge printers are compatible with eXguard; for a list of compatible printers please refer to the Release Notes (Readme.doc in the program directory). Once the pre-requisites have been satisfied, clicking on the Capture button in the Keyholder Properties - General tabsheet brings up the Video Capture window, which allows you to manipulate and capture an image. Once you have captured an image, you can print it on a Badge; see How to design and print Badges. Another use of stored images is for Objective Authentication. This allows an operator to see a picture of a Key Holder before deciding whether to allow access. For further information, see How to use Objective Authentication

6656-0397 Issue 1

Page 23

eXguard User Manual

How to design and print Badges In order to be able to design and print badges, your Licence Key must permit this feature to be used. If it does not already do so, you must upgrade your Licence Key. If you are not sure whether this is necessary, the Licence Server display will tell you or you can refer to "Help About" in the eXguard Explorer. To create a new badge design Right-click on Badge Designs in the Explorer tree and select New Badge . This opens a Properties sheet for the new Badge. See Badge Design Properties in the Help systemfor details on how to create your design. To print a badge 1. Using the Explorer tree, locate the Key Box which contains the number of the Key you wish to print 2. Left-click on the Key Box to display all the keys in that box 3. Locate the Key and right-click on it, and select Print. This opens the Print Preview window which allows you to see how the Badge will appear before you print it.

Troubleshooting
Trouble-shooting using the Explorer The help file describes a feature that I can't find This Help file is for both eXguard Lite and eXguard Pro. eXguard Lite does not have all of the features of eXguard Pro. Your Licence may not permit certain features to be used (For example, if the PhotoID option is not enabled in your licence, then you cannot capture a live image from an attached camera, and you cannot even see the Badge Designs folder)

I can't add a new Key Holder eXguard Lite is limited to 5000 Key Holders Your Operator Rights may not permit this

I can't add a new ACU Your Licence may mot permit you to add any more Doors than you already have - this will stop you adding a new ACU because an ACU must have at least one Door. Your Operator Rights may not permit this

I can't open the Properties of something Your Operator Rights may not permit this I cannot delete something

6656-0397 Issue 1

page 24

eXguard User Manual

Your Operator Rights may not permit this Some objects cannot be deleted (Folder objects, the Admin operator, the Public Area, the Everyone Group)

Troubleshooting Access Rights If someone is being denied access when you think they should be granted access, check the following: Is eXguard communicating with the ACU (look for events in the event list when you present the card). If so, the event message may tell you why the card was refused access. Is the Key Holder is allowed in the Area (look at the Area tabsheet in Key Holder Properties) Is the reader associated with the Area as an In reader (look at the Associations tab in Area Properties). If all this appears to be in order, perform a Load Keys operation on the ACU and wait for this to complete before trying again.

Trouble-shooting communications During start-up, Communications takes a short while to display a window with the title "eXguard Communications" and displays some status information in its lower-left corner while it is loading data for the ACUs in the database. When this is finished, communications with the ACUs starts and the status bar will show which ACU is being communicated with: Communications activity can also be confirmed by looking at the indicator lights on the RS232/RS485 protocol converter (if you have one) or, if you have a System2, System4 or eXpert in your system, you can remove its front cover to see its indicator lights. Is the Communications program for this ACU running? Note that you can tell if the communications program is running by looking in the Explorer at the computer in question: a red line through the computer means that it is not. Has communication with the ACU been established? You can tell if communication has been established with the ACU by looking at its Event List. To see this list, right-click the ACU and select Show Events, then stop and re-start Communications: If communication cannot be established with any ACU, a "Time-Out" event for that ACU is placed in the list. Also, in the Communications window, the lower left corner will show if any units are "off-line". If communication has been established with the ACU, right-click on the ACU in the Explorer tree and select "Reset ACU". The configuration will be downloaded to the ACU and you will see one or more Restart events in the Event List.

At this point you could confirm that other aspects of the installation are functioning; for example: present a Key at a Reader and confirm you see an event in the general Event List (click on the button)

6656-0397 Issue 1

Page 25

eXguard User Manual

right-click a Door in the Explorer and select Release; confirm the door is unlocked for a few seconds

6656-0397 Issue 1

page 26

Glossary

Glossary

A
Access Area: Any area to which access is controlled ACU: Access Control Unit: the electronics that controls access through the Door. Alarm: An Alarm is a special kind of Event: one which has been defined as being important enough to bring to your attention automatically. Alarm Zone: An Alarm Zone is used to provide a graphical representation of objects that have been designated as capable of producing Alarm events. Anti-passback: Anti-passback is the means of preventing the same Key being used more than once within a given period of time. It is an Access Area property, which can be applied at each reader that grants access into the Area. Although it is an Area property, it is only enforced on multiple doors if those Doors are all controlled by the same ACU.

C
Counter: Held within an ACU, this can count input events or access granted events, and trigger a relay when limits are reached.

D
Database User: An object in the System Folder that allows read-only access to the database. Door: A Door, in the context of an access control system, is any barrier which is controlled by the system and where a person must identify themselves before being allowed access. This is not the same as simply using a spare input to monitor whether a noncontrolled door is open or not.

E
Elevator: A special configuration fo an ACU, where instead of triggering a single lock relay, a combination of relays may be triggered when access is granted.

I
Input: An Input is a connection on an ACU, to which other equipment (such as a switch) may be connected. Some Inputs may have pre-defined functions, such as Door Sense, or Egress Button. Other Inputs may be used to trigger Relays, or generate eXguard Operator Alarms, thereby providing a simple means of integrating Alarm Systems with Access Control. IP Direct: A type of Portal in eXguard where a single IP address represents an Ethernet connection to a single ACU IP Node: A type of Portal in eXguard where a single IP address represents an Ethernet connection to more than one ACU. This includes a situation where there is an Ethernet connection to an eXcel4, and other ACUs are connected to that eXcel4 via RS485.

M
Mantrap: A special configuration where one door must be closed before another one can open

6656-0397 Issue 1

Page 27

Master: An eXpert 2 ACU is considered to be a Master when it has Slave ACUs connected to it.

O
Operator: An Operator is a person with rights to use eXguard on a PC. Each Operator defined within eXguard may be given rights to only certain aspects.

P
Portal: A means of communicating with an ACU, for example, serial communication port, modem, IP node

R
Relay: A Relay is an electrical output device which can be switched ON or OFF by an ACUin response to specific Events known as triggers. There are certain pre-defined relayfunctions, such as Lock Strike, Local Alarm and Remote Alarm. Other Relays can beused to switch equipment on and off, such as lighting, heating or bells. Relay Triggers can be Door, Reader, or Input Events, or a user-defined Schedule. When a scheduled Relay is triggered, the Relay itself can be programmed to generate Event Log entries, or raise Alarms.

S
Schedule: Schedules are used for defining access rights, for defining the level of security that applies to each Area, for setting Relays to turn on and off automatically and for defining periods when Events are to be considered as Alarms. Site Plan: SIte Plans can provide a graphical representation of the layout of your premises and the access control system. Slave: A Slave ACU (eXpander) can be fitted in the same case as an eXpert 2 to create a 4 door controller. Slave ACUs may also be installed separately from the eXpert 2.

T
Tenant: A Tenant is an occupier of a building who manges their own Keyholders. In most cases there is only one tenant, referred to, in eXguard, as the Landlord. Threshold: One of four values defined for a Counter. Each Threshold can have an upper and lower limit, which determine when the asociated Relay will be triggered.

6656-0397 Issue 1

page 28

Index
A Access Area............................................11 Access denied ........................................25 Access Group .........................................10 Access Group into allow ....................................................11 Access Group into ..................................11 Add Keys Key Box...............................................10 Add Keys ................................................10 Adding Key Holder ..........................................10 Adding.....................................................10 Allow Access Group into...............................11 Allow .......................................................11 Another application export personnel data .........................14 Another application.................................14 Automatically backup..............................18 B Backup....................................................18 C Communications Trouble-shooting .................................25 Communications .....................................25 Configuration Report create ................................................. 20 Configuration Report.............................. 20 Control Doors manually ......................... 14 Control Key create ................................................. 14 Control Key ............................................ 14 Control Operator Alarms........................ 15 Control which Events ............................. 17 Create Configuration Report .......................... 20 Control Key......................................... 14 report using Crystal Reports .............. 21 Create .................................................... 14 Create .................................................... 20 Create .................................................... 21 Create Attendance Reports ................... 20 Create Event Reports ............................ 20 Create Fire Reports ............................... 21 Create Instant Reports........................... 20 Create objects.......................................... 9 Create Operator Alarms......................... 15 D Database.......................................... 18, 19 Define properties ........................................... 10

29

Define .....................................................10 Delete objects ...........................................9 Design.....................................................24 Display Events individual object ..................................17 Display Events ........................................17 Display Events ........................................17 E Edit Schedules........................................14 Explorer ..................................................24 Export personnel data another application..............................14 Export personnel data ............................14 G Granted...................................................25 I Import file format.....................................12 Import personnel data.............................11 Individual object display Events .....................................17 Individual object ......................................17 Install ......................................................23 Issue Keys Key Holder ..........................................10 Issue Keys ..............................................10 K Key Box

add Keys ............................................ 10 Key Box.................................................. 10 Key Holder add ..................................................... 10 issue Keys .......................................... 10 search................................................. 11 Key Holder ............................................. 10 Key Holder ............................................. 10 Key Holder ............................................. 11 L Licence Key ............................................. 7 Limits size ..................................................... 19 Limits...................................................... 19 Login ........................................................ 7 M Manually backup .................................... 18 Multi-user system..................................... 8 O Object..................................................... 10 P Photo ID system use...................................................... 23 Photo ID system..................................... 23 Print Badges .......................................... 24 Properties define.................................................. 10

6656-0397 Issue 1

page 30

Index

Properties ...............................................10 R Recorded ................................................17 Reorganise .............................................19 Report using Crystal Reports create ..................................................21 Report using Crystal Reports .................21 Restore ...................................................18 S Search Key Holder ..........................................11 Search ....................................................11 Set ............................................................8 Size limit......................................................19 Size.........................................................19

T Trouble-shooting communications ................................. 25 using................................................... 24 Trouble-shooting .................................... 24 Trouble-shooting .................................... 25 U Upgrade ................................................... 7 Use Photo ID system ................................. 23 Use......................................................... 23 Use Objective Authentication................... 9 Using Trouble-shooting ................................ 24 Using...................................................... 24

6656-0397 Issue 1

Page 31