Entrapass Corp v5 02 Reference Manual LT en
Entrapass Corp v5 02 Reference Manual LT en
• This End‐User License Agreement (“EULA”) is a legal agreement between You (the company, individual or
entity who acquired the Software and any related Hardware) and KANTECH, the manufacturer of the inte‐
grated security systems and the developer of the software and any related products or components (“HARD‐
WARE”) which You acquired.
• If the KANTECH software product (“SOFTWARE PRODUCT” or “SOFTWARE”) is intended to be accompanied by
HARDWARE, and is NOT accompanied by new HARDWARE, You may not use, copy or install the SOFTWARE
PRODUCT. The SOFTWARE PRODUCT includes computer software, and may include associated media, printed
materials, and “online” or electronic documentation.
• Any software provided along with the SOFTWARE PRODUCT that is associated with a separate end‐user
license agreement is licensed to You under the terms of that license agreement.
• By installing, copying, downloading, storing, accessing or otherwise using the SOFTWARE PRODUCT, You agree
unconditionally to be bound by the terms of this EULA, even if this EULA is deemed to be a modification of any
previous arrangement or contract. If You do not agree to the terms of this EULA, KANTECH is unwilling to
license the SOFTWARE PRODUCT to You, and You have no right to use it.
remove any proprietary notices, marks or labels from the Software Product. You shall institute reasonable
measures to ensure compliance with the terms and conditions of this EULA.
b Separation of Components ‐ The SOFTWARE PRODUCT is licensed as a single product. Its component parts
may not be separated for use on more than one HARDWARE unit.
c Single INTEGRATED PRODUCT ‐ If You acquired this SOFTWARE with HARDWARE, then the SOFTWARE
PRODUCT is licensed with the HARDWARE as a single integrated product. In this case, the SOFTWARE
PRODUCT may only be used with the HARDWARE as set forth in this EULA.
d Rental ‐ You may not rent, lease or lend the SOFTWARE PRODUCT. You may not make it available to others
or post it on a server or web site.
e Software Product Transfer ‐ You may transfer all of Your rights under this EULA only as part of a perma‐
nent sale or transfer of the HARDWARE, provided You retain no copies, You transfer all of the SOFTWARE
PRODUCT (including all component parts, the media and printed materials, any upgrades and this EULA),
and provided the recipient agrees to the terms of this EULA. If the SOFTWARE PRODUCT is an upgrade,
any transfer must also include all prior versions of the SOFTWARE PRODUCT
f Termination ‐ Without prejudice to any other rights, KANTECH may terminate this EULA if You fail to com‐
ply with the terms and conditions of this EULA. In such event, You must destroy all copies of the SOFT‐
WARE PRODUCT and all of its component parts.
g Trademarks ‐ This EULA does not grant You any rights in connection with any trademarks or service marks
of KANTECH or its suppliers.
3 COPYRIGHT
All title and intellectual property rights in and to the SOFTWARE PRODUCT (including but not limited to any
images, photographs, and text incorporated into the SOFTWARE PRODUCT), the accompanying printed materi‐
als, and any copies of the SOFTWARE PRODUCT, are owned by KANTECH or its suppliers. You may not copy the
printed materials accompanying the SOFTWARE PRODUCT. All title and intellectual property rights in and to the
content, which may be accessed through use of the SOFTWARE PRODUCT, are the property of the respective
content owner and may be protected by applicable copyright or other intellectual property laws and treaties.
This EULA grants You no rights to use such content. All rights not expressly granted under this EULA are reserved
by KANTECH and its suppliers.
4 EXPORT RESTRICTIONS
You agree that You will not export or re‐export the SOFTWARE PRODUCT to any country, person, or entity sub‐
ject to US export restrictions.
5 CHOICE OF LAW
This Software License Agreement is governed by the laws of the State of New York.
6 LIMITED WARRANTY
a NO WARRANTY
KANTECH PROVIDES THE SOFTWARE “AS IS” WITHOUT WARRANTY. KANTECH DOES NOT WARRANT THAT
THE SOFTWARE WILL MEET YOUR REQUIREMENTS OR THAT OPERATION OF THE SOFTWARE WILL BE
UNINTERRUPTED OR ERROR‐FREE.
b CHANGES IN OPERATING ENVIRONMENT
KANTECH shall not be responsible for problems caused by changes in the operating characteristics of the
v
HARDWARE, or for problems in the interaction of the SOFTWARE PRODUCT with non‐KANTECH SOFT‐
WARE or HARDWARE PRODUCTS.
c LIMITATION OF LIABILITY; WARRANTY REFLECTS ALLOCATION OF RISK
IN ANY EVENT, IF ANY STATUTE IMPLIES WARRANTIES OR CONDITIONS NOT D IN THIS LICENSE AGREE‐
MENT, KANTECH'S ENTIRE LIABILITY UNDER ANY PROVISION OF THIS LICENSE AGREEMENT SHALL BE LIM‐
ITED TO THE GREATER OF THE AMOUNT ACTUALLY PAID BY YOU TO LICENSE THE SOFTWARE PRODUCT
AND FIVE US DOLLARS (USD$5.00). BECAUSE SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR
LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE LIMITATION MAY
NOT APPLY TO YOU.
d DISCLAIMER OF WARRANTIES
THIS WARRANTY CONTAINS THE ENTIRE WARRANTY AND SHALL BE IN LIEU OF ANY AND ALL OTHER WAR‐
RANTIES, WHETHER EXPRESSED OR IMPLIED (INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABIL‐
ITY OR FITNESS FOR A PARTICULAR PURPOSE) AND OF ALL OTHER OBLIGATIONS OR LIABILITIES ON THE
PART OF KANTECH. KANTECH MAKES NO OTHER WARRANTIES. KANTECH NEITHER ASSUMES NOR
AUTHORIZES ANY OTHER PERSON PURPORTING TO ACT ON ITS BEHALF TO MODIFY OR TO CHANGE THIS
WARRANTY, NOR TO ASSUME FOR IT ANY OTHER WARRANTY OR LIABILITY CONCERNING THIS SOFTWARE
PRODUCT.
e EXCLUSIVE REMEDY AND LIMITATION OF WARRANTY
UNDER NO CIRCUMSTANCES SHALL KANTECH BE LIABLE FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL
OR INDIRECT DAMAGES BASED UPON BREACH OF WARRANTY, BREACH OF CONTRACT, NEGLIGENCE,
STRICT LIABILITY, OR ANY OTHER LEGAL THEORY. SUCH DAMAGES INCLUDE, BUT ARE NOT LIMITED TO,
LOSS OF PROFITS, LOSS OF THE SOFTWARE PRODUCT OR ANY ASSOCIATED EQUIPMENT, COST OF CAPI‐
TAL, COST OF SUBSTITUTE OR REPLACEMENT EQUIPMENT, FACILITIES OR SERVICES, DOWN TIME, PUR‐
CHASERS TIME, THE CLAIMS OF THIRD PARTIES, INCLUDING CUSTOMERS, AND INJURY TO PROPERTY.
WARNING: KANTECH recommends that the entire system be completely tested on a regular basis. However,
despite frequent testing, and due to, but not limited to, criminal tampering or electrical disruption, it is possible
for this SOFTWARE PRODUCT to fail to perform as expected.
vi
vii
Table of Contents
Introduction ............................................................................................... 1
EntraPass Main Features ............................................................................................. 2
EntraPass Manual and Help ......................................................................................... 4
Using the Reference Manual .......................................................................................... 4
Getting Help .................................................................................................................. 5
Technical Support .......................................................................................................... 6
System Architecture ................................................................................................... 7
Software Installation ................................................................................... 9
Recommended Operating Systems ............................................................................... 9
Minimum System Requirements .................................................................................. 9
EntraPass WebStation Server ......................................................................................... 9
Operating System Compatibility ................................................................................. 10
Virtual Environment Supported .................................................................................. 10
Additional Requirements .............................................................................................. 10
Installation Kit ..........................................................................................................10
InstallShield Wizard ...................................................................................................11
Installing EntraPass (New Installation) .......................................................................... 11
Customizable Contact Information ............................................................................... 11
Customizable Background ............................................................................................ 13
System Installation ....................................................................................................14
System Registration ...................................................................................................16
Registering the System ................................................................................................. 17
Adding System Components ......................................................................................... 18
System Components Edition .......................................................................................19
Assigning a Descriptive Name to an Application ............................................................ 20
Communication with the EntraPass Server ...................................................................20
Establishing Communication with the Server ................................................................. 20
Upgrading EntraPass .................................................................................................... 21
Updating EntraPass ...................................................................................................21
Before Updating EntraPass ........................................................................................... 22
Updating EntraPass ...................................................................................................... 22
Removing EntraPass ..................................................................................................23
Getting Started ......................................................................................... 25
Session Start and End ................................................................................................25
Starting the EntraPass Server ....................................................................................... 25
Starting the Gateway Program ...................................................................................... 26
Starting the EntraPass Workstation .............................................................................. 27
Accessing Information on the Server Workstation Connection Status ............................. 28
Modifying your Work Area Properties ........................................................................... 28
Retrieving Hidden Windows on the Desktop .................................................................. 28
Express Setup ............................................................................................................29
System Stand‐Alone Utilities ......................................................................................29
EntraPass Toolbars ....................................................................................................30
Basic Functions .........................................................................................................32
Finding Components .................................................................................................... 33
viii
Introduction
Welcome to EntraPass, a powerful multi‐user access control system that provides all the features
required in the most demanding applications.
What is EntraPass? EntraPass is a comprehensive, menu‐driven access control software package. Among
the many features EntraPass offers, you will find:
• A new database engine (Sybase)
• Remote communication capability
• SmartLink interface with paging systems, HVAC systems, email and more
• Redundancy server for fail‐safe operation (optional)
• Connection to the Kantech IP Link
• KT‐100, KT‐200, KT‐300 and KT‐400 compatibility (Note)
NOTE: You can connect a loop of KT‐200 controllers on the RS‐485 of the KT‐400 if not mixed with other
controllers (Kantech KT‐100, KT‐300 and KT‐400).
• Kantech Telephone Entry System (KTES)
• Third party hardware integration
• Express setup
• Local anti‐passback, interaction between door controllers, and DayPass for temporary visitors
• Elevator control
• Integrated badging capability
• Interactive floor plans
• Configurable desktops by operator
• CardGateway (optional)
• Multiple reader technology
• External alarm system interfacing
• In/Out reporting, Email reports capability
• Visual diagnostics
• Video Integration with American Dynamics family of Intellex® Digital Video Management System (DVMS)
• Support of 40 TVR II
• Support of 40 NVR
• Live video display, recorded video playback, local event logging and saving
• Video archiving via EntraPass Video Vault
• Vocabulary editor
• Intrusion Integration
• Windows 7 Pro 64‐bit supported
What is Access Control? Access control consists of a set of components (door readers, exit detectors,
motion detectors, etc.) that are professionally installed and electronically controlled. System
workstations are used to receive event messages, acknowledge alarms, modify the system database, etc.
2 Introduction
A supporting advantage of access control is that all system events are carefully archived and can be
easily retrieved for inspection purposes.
for a total of 240 external inputs per KT‐400. Adding the 16 onboard inputs of the KT‐400 gives a total of
256 inputs per KT‐400.
• KT‐MOD‐OUT16: This expansion module is an open drain to 12 VDC 16 output module. It can be used for
elevator access control (may require additional hardware). The module supports daisy chaining; you can
interconnect up to 16 KT‐MOD‐OUT16 modules for a total of 256 external outputs per KT‐400.
Kantech Telephone Entry System. The Kantech Telephone Entry System enables users to grant access to
the building, to their visitors, via their own land telephone or cellular telephone. This telephone line can
also serve, via an integrated modem, as a programming link or a monitoring link. The KTES is designed to
be a stand‐alone unit as well as a part of a complete access control system such as EntraPass from
Kantech or any access control system. It can communicate with EntraPass through a Multi‐site Gateway
for programming and monitoring. The KTES installation can also include Kantech controllers (KT‐100, KT‐
300 and KT‐400) as well as any controller that supports a Wiegand interface port. Also, in order to ease
the process of importing and exporting tenant lists, an automated procedure has been implemented to
guide you through the various steps. For details concerning the installation and the local programming
of the KTES, refer to the KTES Installation Manual, DN1769 and KTES Programming Manual, DN1770.
Express Setup. The Express Setup program enables installers to automatically define and configure the
most standard system components. This saves installation time and prevents setup errors. With Express
Setup, the system is fully functional and ready to test the hardware and wiring before the installer
makes the customized changes necessary for a particular site.
EntraPass WebStation. The EntraPass WebStation is a tool that allows for card management from a
remote location to be used with the regular EntraPass product. In addition, it allows manual operations,
door, relay, input, historical reports (.PDF, CSV, XLS, TXT formats) and web views.The interface is ideal to
provide card management to Security personnel, secretaries and managers without the need to deploy a
full EntraPass workstation. The concurrent logins option will provide access to a pre‐determined number
of users according to the options registered in EntraPass. For details concerning the installation and the
usage of the EntraPass WebStation, refer to the Installation Manual, DN1864 and User Manual, DN1709.
Elevator Control Capability. EntraPass allows installers to program up to 64 floors per elevator cab using
expansion devices such as KT‐PC4216, KT‐PC4204 (16 floors maximum) with the KT‐300 or such as KT‐
MOD‐OUT16, KT‐MOD‐INP16 or KT‐MOD‐REL8 with the KT‐400. This indispensable feature in a multi‐
tenant building allows facility managers to restrict specific floor access to authorized cardholders.
Integrated Badging. The Integrated Badging feature was added to EntraPass to allow users to design
and print badges. Pictures and signatures can be imported or, with the necessary devices, captured and
incorporated into cards for printing badges.
Interactive Floor Plans. EntraPass can import and display high‐resolution graphics created on CAD‐type
systems (converted to .jpg or .bmp), allowing you to design a graphic‐based system that operators can
use with minimal training. Interactive icons can be added to floor plans to display component status and
offer full manual operation of the component in real‐time.
Configurable Desktops by Operator. With EntraPass, each Operator can be assigned up to 8
configurable desktops. These desktops display selected windows featuring message events, user photos,
filtered events, high‐resolution graphics and videos, and alarm instructions. Desktops can contain any
combination of windows.
4 Introduction
Interfacing with External Alarm Panels. KT‐100, KT‐300 and KT‐400 controllers allow users to arm,
disarm, and postpone the arming of an external alarm panel . This allows EntraPass to easily integrate
with an external alarm system.
In/Out Feature. The In/Out feature is a low‐cost alternative to high‐priced dedicated In/Out systems. It
enables operators to print or download time sheets in a CSV format to a payroll system.
Visual Diagnostics. EntraPass offers on‐screen real‐time visual representation of the system devices,
with conditions updated in real‐time, including high resolution floor plans that can be imported and
displayed on screen. Interactive system icons can be added to the graphic to display component status in
real‐time. Manual operations may be performed from the real‐time system graphic.
Enhanced Video Integration. EntraPass adds real‐time monitoring capability as a response to the
growing importance of video in access control systems. Integration with American Dynamics’ Intellex®
digital video management system through the powerful Intellex Application Programming Interface (API)
provides real‐time video monitoring as well as video playback. Video can be linked to real‐time video
monitoring as well as video playback. Video can be linked to access events and recorded from one to
sixteen cameras from different Intellex units simultaneously. Presets, sequences, dome control and 1x1,
2x2, 3x3, and 4x4 views are available through the EntraPass software. All cameras can be called up
directly from a floor plan simply by double‐clicking on the camera or dome icon. Operators can configure
viewing parameters for digital video applications through an EntraPass user interface.
EntraPass Video Vault. EntraPass Video Vault enables all video clips from an Intellex alarm or an
EntraPass video alarm to be automatically stored as Audio Video Interlaced format (.AVI) files or Kantech
Video Intellex (.KVI), Kantech Video Archive (.KVA) and American Dynamics’ Network Client’s video
format (.IMG) which can be password protected. Each EntraPass Video Vault may be connected to as
many Intellex units as defined within the EntraPass software. Video may be saved to up to 24 pre‐
programmed hard drive locations. A .bmp image may be associated automatically with each video clip,
and a thumbnail image may be created on the first frame of the video clip.
Vocabulary Editor. Simple and easy program used to translate the software in the language of your
choice. By default, EntraPass is available in English, French, Spanish, German and Italian. It can also be
translated in up to 99 languages, by using this feature.
Intrusion Integration. Addition of a manual operation on the intrusion components. A full access of the
Panel Virtual Keypad attached to a KT‐400 is now provided. A pass‐through mechanism on the KT‐400
links the Panel Manager of the Gateway directly with the panel’s DLL. An auto‐detection function has
been added to fetch the data directly from the hardware panel in order to optimize the provisioning
process. A new event parameter type has also been added to handle most of the Intrusion generic
events.
Getting Help
Our window‐level Help will provide you with immediate and context‐related Help. Press [F1] on your
keyboard to display the Help related to the active window or select Help > Contents from the EntraPass
menu bar. For immediate help, use the Help button, found in all the system windows. You may also use
the right‐click option; it may either display a shortcut menu or the help file of the active window.
6 Introduction
Technical Support
If you cannot find the answer to your question in this manual or in the Help files, we recommend you
contact your system installer. Your installer is familiar with your system configuration and should be able
to answer any of your questions. Should you need additional information, refer to the following table for
the Technical Support Help Desk in your area.
France +33 04 72 79 14 83
System Architecture
8 Introduction
Software Installation 9
Software Installation
Before any installation takes place, make sure that the computers on which the software will be installed
meet the necessary requirements.
For information concerning hardware equipment installed with the software, refer to the
documentation supplied with the hardware.
This chapter contains information related to the EntraPass software. You will find:
• System requirements
• Software installation and upgrading
Depending on the system configuration, there are different system hardware requirements for the
installation of the EntraPass software.
Additional Requirements
For several applications, you can use the following devices:
• A video capture card—to capture user images for card identification
• A sound card—to use warning sounds when an alarm is reported
• A badge printer— to print badges (Badging)
• A signature capture device— to capture signatures (Badging)
• A log printer—(dot‐matrix or laser) to print events (messages and alarms)
• A Report printer—(laser) to print reports
Installation Kit
The EntraPass installation package contains EntraPass software CD‐ROM (and USB flash drive) as well as
the User Manual DN1946. It also contains the CBLK‐10 kit which includes 30 m (100 ft) RS‐232 cable with
RJ‐12 connectors, the DB9F to RJ‐12 (740‐1023) adaptor and the DB9M to DB25F (740‐1041) adaptor. Your
installation CD‐ROM or USB flash drive allows you to install the basic components of your EntraPass:
• 1 Server and 1 server workstation
• 1 Multi‐Site Gateway application
• 2 additional workstations
• 1 WebStation license (must be activated for usage)
• SmartLink
The installation USB drive also includes advanced system components. They require an additional license:
• Oracle/MS‐SQL Interface
• EntraPass Video Vault
• EntraPass WebStation (1 or 3 license packages with a maximum of 3+1 concurrent licenses).
NOTE: Additional options can only be installed after the EntraPass Server has been registered. They
require an additional license.
InstallShield Wizard
The InstallShield Wizard will guide you through the various installation scenarios. Table 2‐1 lists the
various installation scenarios.
Procedure Page
1‐ Installing EntraPass (New Installation) 11
2‐ Adding System Components 18
3‐ Upgrading EntraPass 21
4‐ Updating EntraPass 22
5‐ Removing EntraPass 23
• Modify the parameters accordingly (refer to the picture below for the location of each parameter):
[Custom]
LOGINNAME=
PASSWORD=
WEBSITE= your‐text (see #1)
TECHSUPPORTWEBSITE= your‐text (see #2)
EMAIL= your‐text (see #3)
CUSTOMERTITLE= your‐text (see #4)
CUSTOMERNOTICE= your‐text (see #5)
MASTERLOGO=
DETAILSLOGO= your‐image‐file (see #6)
PROGRAMLOGO=
WATERMARKLOGO=
KTESTKANTECHLOGO=
Software Installation 13
Customizable Background
The background watermark image can be customized prior to software installation.
• Modify the WATERMARKLOGO parameter by adding your image file name (do not forget to put the image
file into the same directory):
[Custom]
LOGINNAME=
PASSWORD=
WEBSITE=
TECHSUPPORTWEBSITE=
EMAIL=
CUSTOMERTITLE=
CUSTOMERNOTICE=
MASTERLOGO=
DETAILSLOGO=
PROGRAMLOGO=
WATERMARKLOGO= your‐image‐file
KTESTKANTECHLOGO=
System Installation
1 Before you begin the installation, make sure that no EntraPass application is running.
2 Insert the software CD‐ROM into the CD‐ROM drive (or the USB flash drive in a USB port). The
installation program should start automatically if your computer is configured to autorun. If the
installation program does not start automatically, click Start > Run, then enter D:\Setup.exe (where D: is
the CD‐ROM drive) in the displayed field.
3 Before you go any further, you will be prompted to Choose setup language. English is selected by default.
NOTE: The setup (InstallShield) language cannot be changed later on if you need to perform an
EntraPass update or install system components with a different language. If you must change the
setup language, you have to remove and re‐install the software.
NOTE: The system and database language depends on the language you select when installing the
software. For example, if you select “English”, it will be the system default language at start up. The
system and database language can be changed from the EntraPass Server and EntraPass Workstation.
4 Click OK. The Welcome screen will be displayed.
• All the installation windows look the same as the Welcome window.
• You will notice the software version you are about to install is located at the top left.
• The middle section of the window contains the instructions you will follow throughout the
installation process. The instructions will be updated automatically when you click Next.
• Back and Next buttons are available at the bottom of the screen to allow navigating back and forth
within the installation screens if you wish to verify or modify a parameter you previously setup.
• You can Cancel the installation at any time.
5 Click Next to continue the installation. The Setup Start window will be displayed.
Software Installation 15
6 Select the operation(s) you wish to perform. The first set of options are for new installs and the last
option is for updates. During the first installation, you will only be able to select one of the install
options. We suggest that you install the first option in the list.
• Install Server, Database and Workstation: This option will install the EntraPass Corporate Edition
system. It will be grayed out if the application is already installed on the machine.
• Install Additional Workstation: This option is selected when you are installing an additional
workstation. It will be grayed out if a server or a workstation is already installed on the machine.
• Install EntraPass System Components: This option allows installing EntraPass optional or additional
system components such as Gateways, WebStations, SmartLink, Video Vault, Oracle/MS‐SQL
Interface and Mirror Database and Redundant Server, etc. The option will be grayed out if the
component has already been installed on the computer.
• Install EntraPass System Tools: This option allows installing EntraPass System Utilities (Vocabulary
Editor, Report Viewer, Video Viewer, SmartLink Network Interface, etc.). An option is greyed out if
the utility has already been installed on the machine.
• Update Installed Applications: This option will be grayed out if the system has not been installed
previously. To update your EntraPass system, see "Updating EntraPass" on page 21.
7 Click Next. The Serial Number window will be displayed.
8 Enter the serial number for the EntraPass Corporate Server or Software. The information is located in the
CD‐ROM pocket. Make sure to enter the correct digits. The Next button is only enabled if the serial
number is valid.
9 Click Next. The system displays the software End‐User License Agreement.
10 Select I accept... if you understand and agree with the conditions described in the end‐user license
agreement or click I do not accept... to cancel the installation.
NOTE: You will not be able to complete the installation if you refuse the terms of the license
agreement. The Next button will remain grayed out until you select I accept...
11 Click Next. The Customer Information screen will be displayed.
12 Enter the User Name and the Company Name.
13 Select the user type: Anyone who will use this computer or Only the person currently logged in and
registered in the system.
14 Click Next. The Choose Destination Location window will be displayed.
15 You can keep the selected directory and click Next, or select another one.
• If you want to change the directory where to install the application, click Change. The Choose Folder
dialog will pop up where you can select the new installation directory.
• Type in the destination directory where you want to install EntraPass or double‐click the directory
structure all the way down to the destination directory. Then, click Ok. The path will be indicated in
the Choose Destination Location window.
16 Click Next. The Ready to Install the Program window will be displayed.
17 If you need to review the parameters you’ve setup, click Back. If everything is ready for the installation,
click Next. The installation will begin.
16 Software Installation
System Registration
It is recommended to register the system as soon as possible so that users can install additional options
and use the access system with no restrictions. In fact, though the system is functional even before the
system registration, it is limited to only 10 cards. Moreover, when the system is not yet registered,
Software Installation 17
operators are logged out after one hour of idle time; then they have to enter the randomly‐generated
20‐character password each time they are logged out.
3 Enter Kantech in the User name field (not case sensitive). Enter the temporary 20‐character password
displayed at the bottom of the Operator login window (the temporary password appears on new
installations only and is highlighted in yellow). The System registration window appears.
18 Software Installation
4 Click the Temporary password in use (...) yellow button to register the system. This button is visible on
new installations only. The System Registration window appears.
NOTE: There are two ways of registering a new system; register online at www.kantech.com or contact
your local
NOTE: technical support to get the registration confirmation code.
5 Go to www.kantech.com and click on the Member Center.
NOTE: If you are not a member yet, submit your request and your membership confirmation should be
received by email within 1‐2 business days.
6 Click on Kantech Registration.
7 Enter the System Serial Number and follow the instructions online.
8 Return to the EntraPass System Registration screen and enter the Registration Confirmation Code, then
click OK. The OK button is only enabled when the registration code is valid.
NOTE: If you exit the Server main window without registering the system, the Change Authentication
Password window is displayed. It is no longer displayed when the system has been registered.
• NetBEUI: The NetBEUI protocol (NetBIOS Enhanced User Interface) uses the computer name to
communicate with devices. Enter the name of the computer where the EntraPass Server software is
installed (case sensitive). The name of the current computer is displayed in the status bar. You may
use the Scan button to browse and to display existing computer names.
• TCP/IP: Enter the TCP/IP address of the computer where the EntraPass Server program is installed.
The EntraPass Server TCP/IP address appears in the Server status bar.
• Domain Name: Enter the computer name or the workgroup from which the EntraPass Server is a
member.
• Local: Enter Local when registering a component on the same computer as the EntraPass Server
software is installed. This option will take the address from the Server software.
3 Check the Provide local TCP/IP address button if this EntraPass workstation connects to the EntraPass
server using a VPN (Virtual Private Network) connection. Type the IP address used by the VPN
application. This address is provided by the VPN application and is usually accessible by clicking on the
minimized VPN icon found in the system tray.
4 You may enter an Authentication Password if you want operators to use a specific password when they
register EntraPass workstations to the EntraPass Server.
Upgrading EntraPass
1 Before you begin the installation, make sure that no EntraPass application is running.
2 Insert the software CD‐ROM into the CD‐ROM drive. The installation program should start automatically
if your computer is configured to autorun. If the installation program does not start automatically, click
Start > Run, then enter D:\Setup.exe (where D: is the CD‐ROM drive) in the displayed field.
NOTE: A database backup will be automatically performed during the upgrade process.
3 Enter the Upgrade Serial Number (located on the Upgrade Certificate).
NOTE: There are two ways of upgrading the system; register online at www.kantech.com or contact
your local Kantech technical support to get the Registration confirmation code.
4 Go to www.kantech.com and click on the Member Center.
NOTE: If you are not a member yet, submit your request and your membership confirmation should be
received by email within 1‐2 business days.
5 Click on Kantech Registration.
6 Enter the System Serial Number and follow the instructions online.
7 Return to the System Upgrade screen and enter the Registration Confirmation Code, then click OK. The
OK button is only enabled when both codes are valid.
8 The next steps are the same as updating EntraPass. Go to “Updating EntraPass” on page 22.
Updating EntraPass
When you update your software, the system automatically detects the components that are installed
and updates them. It is highly recommended to update your system when the system is at its minimum
use (Friday night, for example.)
22 Software Installation
Updating EntraPass
1 Insert the software installation CD‐ROM into the CD‐ROM drive (or the USB flash drive in a USB port).
The installation program should start automatically if your computer is configured to autorun. If the
installation program does not start automatically, click Start > Run, then enter d:\Setup.exe (where d: is
the CD‐ROM or USB flash drive) in the displayed field. The system displays the installation setup window.
2 Click Next. The Welcome window will be displayed.
3 Click Next. The Setup Start window will be displayed.
4 Select Update Installed Applications and click Next. The Previous Software window will be displayed,
listing all the software that are currently installed on your machine.
5 Click Next to continue. The update will start and all programs currently installed on your machine will be
updated.
6 Click Next. The system will verify if there are any other applications or utilities you can install. If this is
the case, a message will popup on screen:
• If you want to install other applications, click Yes and start over at number 2.
NOTE: If the application you want to install requires a serial number, you must call the Kantech
Technical Support Help Desk to register the system before you can go any further: See "System
Registration" on page 16.
• If the installation is completed, click No. The InstallShield Wizard Complete window will popup:
7 You can choose to restart your computer at this time or do it later.
8 Remove the CD‐ROM from the CD‐ROM drive (or the USB flash drive).
Software Installation 23
Removing EntraPass
If you need to remove the EntraPass software from the computer, you will use the Add/Remove Programs
option in the Control Panel.
1 Click Start > Settings > Control Panel.
2 When the Control Panel is opened, click Add/Remove Programs to open the dialog.
3 Select the program you want to delete from the list and click Remove. The Uninstall program dialog will
display on the screen.
4 Select the application you want to uninstall. If you want to uninstall EntraPass completely, check the
Uninstall all applications box.
5 Click Next.
6 Before you go any further, the system will prompt you to confirm.
• Click Yes if you want to continue the uninstall process.
• Click No if you want to cancel the uninstall process.
7 When the uninstall process is completed, the Maintenance Complete dialog will display.
8 Click Finish to exit the wizard.
9 Restart your computer.
24 Software Installation
Getting Started 25
Getting Started
This chapter introduces operators to the EntraPass system graphical user interface and basic functions.
To start an EntraPass session, you have to launch the EntraPass Server, the Gateway and the EntraPass
Workstation. The server is a dedicated computer on a network that manages the access control system
database. It is used to receive and dispatch information from the gateways. Gateways receive
information from sites and transmit it to the server. EntraPass Workstations enable operators to access
and program the system database and components.
NOTE: The Mirror Database and Redundant Server component may be enabled to monitor the activity
of the Primary Server and to serve as an alternative if the Primary Server fails.Take note that even
though the MS‐SQL/ORACLE interface can’t connect to the Redundant Server, all events will be
buffered until the connection to the Primary Server is restored.
NOTE: All authorized system operators must have a unique and confidential login name and password
that should be assigned by the system installer/administrator. It is very important to restrict access to
the EntraPass workstations to authorized personnel only.
5 You may select the Gateway menu item if you want to choose a gateway. The number of gateways that
are communicating with the server is displayed on status bar in the Gateway main window.
NOTE: The status flags show the communication status. The first status flag indicates the status of the
communication with the server. If red, this indicates that the server is not communicating with the
Gateway. This can occur when the server is offline (you may then start the server). The system date
and time, the number of gateways and the server IP address appear also on the status bar.
NOTE: The progress bars are not status bars. You do not need to wait until they fill up.
1 Right‐click the background area of the workstation window. A contextual menu will popup.
2 In the example above, the Status screen was sent to the background. Clicking the Status screen
command in the menu will bring it back to the foreground.
Express Setup
Express Setup allows you to configure system components such as sites and controllers, as well as
devices associated with these components such as doors and inputs. This utility reduces programming to
a minimum, allowing the installer to test the installation and system components. You may use it to
configure a site or to define controllers associated with a site. When used to configure a site, it allows
installers to associate this site to a gateway. It also allows installers to configure the site rapidly, giving
minimum configuration information about the controllers connected to it.
You may launch Express Setup from Windows® menu: Start > All Programs > EntraPass Corporate Edition >
Server > Express Setup or by clicking the Express Setup icon from a number of EntraPass workstations’
windows. When used to configure a controller, it allows operators to assign default values to a controller
and to its associated devices (input, relays and output). In this case, it is launched from a system
message box or from a controller definition menu.
NOTE: You have to login to the server when you launch Express Setup. In fact, as the program allows
you to modify the system devices configuration, it is essential to authenticate yourself before
proceeding with any modification.
For details on Express Setup, see "Express Setup Program" on page 316.
• Express Setup: Program used to configure all the components related to a gateway including the type of
readers used, type of connection, number of sites, number of controllers in a site, etc.
• KT‐Finder: Program used to configure locally or remotely Kantech IP devices such as the Kantech IP Link,
the KT‐400 Ethernet Four‐Door Controller and the KT‐NCC Network Communications Controller (Note).
NOTE: The KT‐NCC Network Communications Controller is only available with EntraPass Global Edition.
• PING Diagnostic: Program used to diagnose network related problems.
• System Report Viewer: Program used by the operator to view reports without having to start a
Workstation. When this utility is installed, operators can view reports sent by other workstations using
the EntraPass email feature.
• Vocabulary Editor: Simple and easy program used to translate the software in the language of your
choice.
• Workstation (Configuration Program): Program, similar to a standard workstation, used by the system
administrator to configure the system logical and physical components.
• Migration Utility: Program used to transfer information relating to software and database for the
upgrade from Special Edition to Corporate Edition or Corporate to Global Edition.
These utilities may be launched from the Windows® Start menu of any computer where EntraPass Server
or EntraPass workstations are installed. For details on EntraPass stand‐alone utilities, see "System
Utilities" on page 305.
EntraPass Toolbars
EntraPass dialogs display most of the following buttons. They are an easy way to access the system
functions. Generally, a “hint” is displayed when you move the cursor over an icon.
You may access the toolbar from any EntraPass dialog window. Icons vary according to the window that
is open. Most of the icons are similar to icons you are familiar with and that are used in the computer
industry.
Icon Description
The New icon is used to insert new information in the system data‐
base. This may be adding a site, a schedule, a controller, etc.
The Save icon saves all the information you have entered since the
last save. Information is saved directly in the system.
Icon Description
The Delete icon is used to delete the currently selected record. As a
security against accidental deletion, a warning is displayed prompt‐
ing you for confirmation.
When a component is erased, all links with other items are erased as
well. However, the records (archives) are kept in the database after
an item is erased.
The Print icon: depending on which menu you are working in, the
Print button can be used to print reports, card lists, event parame‐
ters, etc.
The System Tree View icon displays the components list in a hier‐
archy format. The components displayed in this window can be
selected or unselected.
The Cancel icon is used to cancel all modifications that were made
since the last time a valid save was performed. The system will
prompt you to confirm the operation.
Use the Help icon to view the help content on a specific subject.
32 Getting Started
Icon Description
The OK icon is used to save and accept the modifications, additions
or deletions made to a record in the database of the system.
The Select all icon is used to select all the items or components dis‐
played in a list.
The Unselect all icon is used to unselect all the items or components
that were previously selected in a list of choices.
Basic Functions
Following are the basic system operations:
• Find components
• Use the extended selection box
• Select components, a specific folder, a site or a gateway
• Print lists or reports
• View links between components
• Calling the system tree view
Getting Started 33
Finding Components
The Find Components function allows operators to find a specific item or component in the system
database by using a specific character string.
There are two types of Find Components dialogs: One that can be accessed from any EntraPass window
toolbar; One that will be accessed through all the dialogs that pertain to users (Cards, Visitor Cards and
Daypasses).
1 In both cases, you must click the binoculars button in the toolbar to open the Find component dialog.
• The window on the left is used to find components and the window on the right is used to find cards.
Icons Description
Will search the database for components or cards.
Will search the database for the picture that corresponds to the card you
selected in the list.
Will open a menu where you can select which card index you want to
search on (card number, cardholder name, card information fields, etc.).
2 To start a search, enter a keyword and click the binoculars on the right. To reduce the search results,
check one of the boxes:
• Start with: Results will list all components that start with the one you have just entered, in
alphabetical order, and will include the rest of the list of components available in the database.
• Begins with: Results will list only components with name that start with the text you specified.
34 Getting Started
• Contains: Results will list all components that contain the text you specify.
3 If you want to view the picture that corresponds to the card selected in the list, click the binocular with a
plus sign button.
4 To cancel a search in progress, click the Cancel button.
5 Click OK. The selected component in the list will be displayed in the dialog where you initiated the
search.
Selecting Components
The Component selection function allows operators to select one or more system components. The
method employed may be context sensitive.
Getting Started 35
1 From the active window, click the Select Components button. It opens a secondary window from which
you may select appropriate options.
2 You may need to check options that are displayed or use the Select All button (left) to select all the
displayed options. You may also select Single to view components that are not grouped or select Group
to view the existing groups.
3 From the displayed list, select the component/group you want to display. You may check the View option
to display the components associated with the selected components.
4 Where available, use the Select all button to select all the components, or use the Clear all button to
remove the check marks from the selected components. Click Cancel to return to the previous window
without any selections or changes.
5 Set the required number of columns in the Extended Selection box window to display all components as
required. A Text Filter may be employed to limit the listing.
6 Click OK to apply selections and return to previous window.
3 When you select the Print empty fields and/or the Print component reference option (if available), the
list will include the titles of the fields even if they are empty.
4 When you have finished selecting the fields, you can preview your list before you actually print it. When
you preview the list, you can:
• Define the printer setup
• Print a hardcopy of your report or list
• Save the report or list for later use with the Quick Viewer program or load an existing report. For
more information on this program, see "Quick Report Viewer" on page 322.
5 If you want to modify the settings, close, modify and print your list.
6 You can use the Font button to select a specific font and font size for your list.
7 To select or modify a font selection:
• Select the font type from the Font menu. A preview of your selection will be displayed in the Sample
box.
• Choose the formatting attribute from the Font Style menu (regular, italic, bold or bold italic).
• Enter the font size from the Size menu (10 or 11 is a default). The smaller the font, the more items
appear on your list.
8 You can also select a color from the Color menu (black is a default). The changes appear automatically in
the sample box. Click on OK when you are done. Use the Preview button from the Print window to
preview your output before printing.
NOTE: If there is no printer configured for the computer, an error message appears.
Floating Windows
The floating window button can be used to move the window outside the workstation screen. This
button is located at the left of the Minimize button for windows that support the floating window
function.
It is not possible to go back when the window is floating. It should be closed and then reopened. No
information on the window’s position is kept by the system.
1 From the Reports toolbar > Quick Report Request dialog. Click on the System Tree View button.
2 From the System Tree View, you can double‐click to select or unselect a component. The changes are
automatically updated on the corresponding tab.
3 Click back on the System Tree View button to close it.
Getting Started 39
2 Click on the System Tree View button, you can double‐click to select or unselect a component. The
changes are automatically updated in the Extended Selection Box.
3 Click back on the System Tree View button to close it.
System Devices
The Devices Toolbar
After the installation of the system hardware and software, you have to configure the system devices.
The Devices toolbar, located at the top of the Workstation window will allow you to access all the
devices dialogs (EntraPass applications, Gateways, SmartLink, Redundant Server and Database and
Video Vault) and the physical components (controllers, KTES, relays, doors, third party hardware, etc.).
NOTE: It is recommended to use the Express Setup program to save configuration time and to prevent
setup errors. In addition, using Express Setup allows you to test the hardware and wiring immediately
after the installation.
You run the Express Setup program when you are configuring gateways, sites or controllers for the first
time. You may run the Express set up utility by clicking its icon in EntraPass windows. You may also
launch the Express Setup program from the Windows® Start menu or from the System Registration
window or from a system prompt, when, for instance, you are adding a controller to your system. For
detailed information about using the Express Setup program, see "Express Setup Program" on page 568.
NOTE: If you are using the V ideo Integration feature, EntraPass enables you to assign all system
components into a video view; the same way you assign them to system interactive floor plans
(graphics). To do this, you simply select the video view where you want the system component
(Application, site, gateway, controller, etc.) to appear. V ideo views are defined in the Video menu
(Video tab > Video views).
Comment Field
A comment field is available for the following components:
• EntraPass application
• Gateway
• Site
• Controller
• Door
• Relay
• Input
• Output
The comment field can be modified or deleted at all time. Its length is unlimited. Here is an example from the
42 System Devices
Devices/Door menu:
Comments can also be visualized from the Operation window using a right click on a component:
Comments can also be visualized through the Messages List or a graphic (right‐click on a component and select
View parent/controller). The following window is displayed:
Move the mouse pointer over the controller to display the associated comment.
44 System Devices
Application Configuration
The minimum configuration of an EntraPass software package includes a server, a workstation
application (EntraPass monitoring application) and a gateway application. The gateway application can
be integrated with the EntraPass workstation on the same computer. The software package comprises a
number of applications including:
• A workstation application
• A server application,
• One Multi‐site Gateway application,
• And a number of utilities such as the Vocabulary editor, the Express Database utility, etc.
It is recommended to install the EntraPass server on a dedicated computer for system stability. The
Application dialog allows operators to configure computers where EntraPass is installed. This includes
configuring computers where you have installed: the EntraPass Workstation software, the Gateways, the
Mirror Database and Redundant Server programs, as well as computers where you have installed the
SmartLink Interface, if applicable. To configure the Application, you have to define:
• General parameters applicable to all computers where EntraPass is installed
• Security parameters (applicable to all EntraPass applications)
• Filters (to define which gateways and EntraPass applications will send messages to the Workstation
application being configured).
• Message/alarm controls.
Configuring an Application
1 From the EntraPass main window, select the Devices tab, then click the Application icon. The Application
main window appears.
NOTE: Items displayed in the Application window vary depending on the selected EntraPass
application. For example, if the selected application in a workstation‐type application, tabs such as
Workstation, Gateway and Site, etc., are displayed. If the selected application is a Redundant server,
the Redundant server tab appears.
2 From the Application drop‐down list, select the application you want to configure. This list displays all
applications that have been installed and registered. The Application type drop‐down list displays the
type of the selected item. It may display Workstation, Gateway, Mirror Database and Redundant Server,
etc.
3 Assign a name to the selected application. If you are running the software in two languages, for example
in English and French, you may assign a name in English and in French.
4 Click the Save button to activate the new application.
1 For added security, specify the system behavior when the operator is inactive. This feature provides
additional security to prevent access to the system by an unauthorized person. The default delay is 20
min. You may keep the default delay or change it.
• Select the Application update type:
NOTE: The Auto‐Updater Service monitors the installed versions of the EntraPass Server, the Gateway,
the Smartlink and the Workstations and verify that they are all the same. Otherwise, it will update the
applications so they will be in the same version as the server.
NOTE: For each step during the updating process, a message will be displayed in the Desktop Message
List.
• Manual: The update is started manually.
• Automatic: The update is started automatically as soon as requested.
• Queued: In this mode, the update is done only one application at the time.
• Prompt to download: If an update is available and the workstation is connected, a message is
displayed to prompt the operator asking to update the application. If the workstation is not
connected, the software will proceed with the update with the same parameters as for the
Queued option. If the operator refuse the update, he will be a prompt for the same update
every hour.
• Select the Send to tray on idle if you want the applications to be minimized when there is no action
on the keyboard. If you do this, you have to specify the period after which the application will be
minimized if there is no action on the keyboard: in the Send to tray on idle, enter the delay after
which the applications will be minimized and sent to the task bar.
• Select the Automatic Logout on idle option if you want the application to logout when there is no
action on the keyboard. If you do this, you have to specify the period after which the application will
be minimized: in the Automatic logout on idle enter the delay after which the Operator will be
automatically logged out, (the option has to be checked).
2 If the Video feature is enabled, the Video view field appears. If this is the case, select the Video view in
which you want the defined component to appear. For details on defining video views, see "Video Views
Definition" on page 237.
3 From the Graphic list, you may select the graphic to which the application is assigned, if applicable. For
details on defining graphics, see "Graphics Definition" on page 211.
• Auto disable authentication: if selected, the system will automatically disable authentication when
the application has authenticated itself for the first time.
• Allow auto‐connection: if selected, the EntraPass workstation will automatically attempt to connect
itself to the server following a communication failure.
• Display Login List: if checked, this option tells the system to save the five last login names to make
them available for selection when opening new sessions. This option offers a fast way to open a
session since an operator has only to select a user name and enter a password. You may however
leave this field to its default setting (unchecked) for increased security; this will oblige operators to
enter both a valid user name and password before accessing EntraPass.
• Must be login to close application: checking this option will oblige operators to login before they exit
an EntraPass program.
• Suspend messages: if this option is selected, all incoming messages for this application will be
suspended. Use this option for an EntraPass workstation that is used only to configure components
or when messages are not required.
• Operator must login to view events: checking this option will oblige the operator to login at least
once with a valid username and password before system event messages can be viewed.
• Display description in title bar: check this box to display the application description in the window
titlebar (top).
• Display description in taskbar: check this box to display the application description in the window
taskbar (bottom).
• Disable video: check this option to hide the video view options from this EntraPass workstation user
interface. If this option is checked, the Video Events List, Video Playback and Video desktop options
are disabled in the system. Operators with appropriate user permissions will be able to configure the
Video option but will not be able to view live or recorded video segments.
• Notify when remote sites must be updated: check this option to tell the system to send a notification
before updating remote sites. When this option is enabled, operators will receive a notification
before updating site communicating via a modem. If this option is selected, operators will receive a
notification each time data related to sites (such as schedules, controllers, etc.) are modified. They
will have the choice of updating remote sites (Yes), refusing the change (No) or clicking Details so
that they can select specific sites to be updated.
Defining Workspaces
The Workspace tab allows you to select which workspace configuration and event parameters will be
applied on a specific workstation therefore making EntraPass geographically relevant. This feature
provides the ability to define workstation behavior.
• Apply workstation workspace and event parameters: When checked this will enable the workstation
workspace definition for event messages display.
• When logged out: will apply the selected workspace rules when the no one is logged on the
workstation.
• When logged in: will apply the selected workspace rules when an operator is logged in, overriding
the operator’s workspace definition.
• When shutdown: will apply the selected workspace rules when the workstation is shutdown.
System Devices 47
• Apply operator workspace to filter messages: when operator logs on, the workstation will apply the
operator workspace rules.
• The Process when both workspaces are selected section lists the options available when both Apply
workstation workspace and event parameters and Apply operator workspace to filter messages boxes are
checked.
• Workstation workspace AND Operator workspace: events will be filtered according to the EntraPass
workstation workspace configuration, and filtered again according to the workspace configuration of
the operator who is currently logged on the EntraPass workstation.
• Workstation workspace OR Operator workspace: will select the workspace that has a higher level in
the hierarchy.
• Operator workspace ONLY: Operator workspace will have priority over the workstation workspace.
6 In the Status icon refresh delay section, specify the time interval at which the application refreshes the
condition reported by the status icon visible in the status bar. Refresh delays range from 0.01 to 5.00
min. in increments of 0.01 sec.
7 You can define the Maximum number of records that can be retrieved from archived files and displayed
on screen for the Historical Report Desktop. The maximum is 200,000.
allows operators to interact with the system card database from their MS‐SQL or Oracle programs.
Operators can add, modify and delete cards, or obtain card‐related information from the EntraPass card
database. The card information is updated in all the databases, whatever the program used to modify or
to update the database; MS‐SQL Interface ensures that the modifications are conveyed to the server and
then sent to the workstations.
NOTE: The Oracle/MS‐SQL Interface requires an additional license.
Make sure that the MS‐SQL or Oracle client software is installed on the same computer as the Oracle/
MS‐SQL Interface. It is not recommended to install the Oracle/MS‐SQL Interface on a computer where
EntraPass is installed. Installing the two applications on the same computer may cause problems during
data exchange between EntraPass and the Oracle or MS‐SQL Server. To configure the Oracle/MS‐SQL
database Interface you have to define:
• General parameters (applicable to the Oracle/MS‐SQL Database Interface), including the application
security parameters
• Database parameters, including the database access rights
1 From the Application drop‐down list, select Oracle/MS‐SQL Interface.
2 Define the application on which you have installed the Oracle/MS‐SQL Interface. For more details, see
"Application Configuration" on page 44.
3 Select the Parameters tab to define security parameters for the Oracle/MS‐SQL Interface. For details, see
"Defining Security Parameters" on page 45.
4 Select the ORACLE/MS‐SQL Interface tab to indicate how the EntraPass software will communicate with
the client database and to define the database access rights.
5 From the Database type drop‐down list, select the database server: Oracle 8.0 server, Oracle 7.3 server
or SQL server. Be sure to select the correct server version since the database configuration is different
from one version to another.
NOTE: If the wrong version is selected, the Oracle/MS‐SQL Interface will not communicate and will not
be able to connect to the server.
6 Enter the database Server name.
7 Type the name of the requested Oracle or SQL Database Name.
8 If you are using an Oracle server, type the name of the Oracle data file which points to the data you wish
to access
NOTE: Oracle and SQL servers may be configured to contain more than one database. Accessing an SQL
database requires pointing to its name while accessing an Oracle database requires pointing to its
name and specific data file. Refer to your network administrator for access parameters to the
database specific to your application.
9 Check the Use administrator Access for Initialization option, if applicable. Checking this option enables
you to enter a valid Administrator username and password.
NOTE: It is important to check this box. If you do not, you must manually create the database, the
username and password in the database server.
10 Enter the Administrator user name and Administrator password. The program will automatically create
the database, username and password in the server database
System Devices 51
11 In the Database access area, enter a username and password which will be used by the CardGateway to
connect to the Oracle/SQL database.
NOTE: The database access procedure does not allow the CardGateway to create or modify an existing
user profile on an Oracle/SQL server.
12 Check the Keep deleted records option if you want to keep the record of a card, even when the card is
deleted from the EntraPass database. The record will be kept in the Oracle/MS‐SQL Interface database.
NOTE: If you do not select this option, deleted records will be physically and permanently erased from
the Oracle/MS‐SQL database.
NOTE: When EntraPass creates the card database automatically in the SQL or Oracle Server, it allows a
maximum of 50MB for the card database. If you want to increase the size of the database, you must
create the database manually. For more information, see the next section. Creating Server Databases
Manually.
13 Click the Service tab to define login information when the Oracle/MS/SQL interface runs as a service and
a report needs to be printed.
• The Login to EntraPass service application box must be checked to activate this option.
• Enter the Oracle/MS‐SQL Interface Domain name and Login name.
• Type in the Password and Password confirmation.
When communication between the Mirror Database and the Primary Server fails, the Mirror Database
automatically initiates the delay after which the Redundant Server is automatically started to replace
the Primary Server. The Mirror Database and Redundant Server program cannot run on the same
computer as the EntraPass software server. The Mirror Database and Redundant Server should be
installed on a dedicated computer.
NOTE: You can operate the system with more than one Mirror Database and Redundant Server. The
Mirror Database and Redundant Server feature requires an additional license.
To configure the Mirror database and Redundant Server workstation, you have to define:
• General parameters applicable to the Mirror Database and Redundant Server, including security
parameters
• Redundant Server parameters
• Security parameters
1 From the Application drop‐down list, select the Mirror Database and Redundant Server application.
2 To define parameters in the General tab, See "Defining General Parameters" on page 44.
3 Select the Parameters tab to define security parameters for the Mirror Database and Redundant Server.
For details, see "Defining Security Parameters" on page 45.
4 Move to the Redundant Server tab to define communication parameters for the Mirror Database and
Redundant Server.
5 Select the protocol that is used to communicate with the computer where the Mirror Database is
installed: None, TCP/IP (network server), NetBEUI (computer name) or Automatic.
NOTE: When you select TCP/IP, the Redundant server address field is enabled to allow you to enter the
TCP/IP address of the computer hosting the Mirror Database and Redundant Server. The field can also
be edited when you select NetBeui.
NOTE: If Automatic is checked, the IP address of the computer hosting the Mirror Database and
Redundant Server will be sent to the server for broadcast to all workstations on the network. This
option is particularly useful if you don’t know the IP address or if the computer is set to a dynamic IP
address or if the computer is connected to a DHCP server.
System Devices 53
EntraPass to receive and send messages, reports or commands, and to communicate with client
applications.
NOTE: The SmartLink feature requires no additional license.
EntraPass allows you to configure the SmartLink communication mode. For more information on
SmartLink and how it works, see your SmartLink Reference Manual, DN1327.
1 From Application drop‐down list, select the system SmartLink application.
2 Define the workstation on which you have installed the SmartLink interface. For more details, see
"Defining General Parameters" on page 44.
3 Configure the SmartLink workstation security parameters. For more details, see "Defining Security
Parameters" on page 45.
4 Configure the SmartLink workstation messages. For more details, see "Defining Message Controls" on
page 47.
5 Configure the SmartLink workstation email reports. For more details, see "Defining Email Report
Options" on page 49.
6 Click the SmartLink tab to view and setup the SmartLink connection parameters.
7 From the Mode enabled drop‐down list in the SmartLink serial connection section and the SmartLInk
network connection section, select the appropriate mode of transmission:
• Messages only: SmartLink will only receive messages.
• Commands only: SmartLink will only execute commands (tasks).
• Messages and commands: SmartLink will receive messages and execute commands.
NOTE: When you start the SmartLink application, the connection options for the serial port and
network modes are retrieved from the EntraPass Server. If the network connection mode of the
SmartLink is other than “none”, the SmartLink application will be started to allow a client application
to connect to the SmartLink application, either to execute commands or to receive messages sent
through the network or both process simultaneously.
8 Check the Bypass event parameter preset option if you want to ignore all default settings of the Event
Parameter definition menu (System > Event Parameters). By default, all events are programmed to be
sent to all workstations (including the SmartLink workstation). Check this option to avoid receiving
unnecessary tasks and events that are not intended for the SmartLink application.
NOTE: You will have to “manually” create associations of events and tasks in the Event Parameter
definition menu. For example, you could select the event “Door forced open” and send only a specific
task to the SmartLink application that would send an email.
9 In the SmarLink tasks section, you may define Startup or Default tasks. The task you assign will be
processed automatically when the SmartLink application is started. For details on defining SmartLink
tasks, see "Task Builder Dialogs Description" on page 225.
10 Click the SmartLink email tab to view and setup the SmartLink connection parameters.
11 In the Email server (SMTP or Exchange server) field, enter the IP address of the Email server that will be
used for sending emails.
12 In the Email Port field, enter the number of the port that will be used for sending emails (usually 25).
13 Enter a valid Email address in the Email sender field. This email address will be used for authenticating
the email server.
System Devices 55
After installing and registering the EntraPass Video Vault application, you must define its environment
among other applications. For details about registering EntraPass Video Vault, see "Adding System
Components" on page 43. For details about using EntraPass Video Vault, see "EntraPass Video Vault" on
page 555.
56 System Devices
• KVI stands for Kantech Video Intellex format. The KVI file contains thumbnail and video context
information and places a watermark on embedded.img. It must be viewed with the Intellex Video
Player that uses the American Dynamics API. You must make sure that the API has been installed
on the client’s computer.
• KVA stands for Kantech Video AVI format. The KVA file contains thumbnail and video context
information with no watermark on the embedded .avi. Video files can be viewed using Windows
Media Player or any other AVI player on the market.
• AVI stands for Audio Video Interlaced format. AVI video files are viewed using Windows Media
Player.
• IMG is the Intellex native format. Video data are stored in Intellex format (.img) and can be
viewed using the Intellex Video Player.
• PS: HDVR native compressed video format.
NOTE: KVI and KVA formats enable users to protect video files with a password and to specify key
frames for any selected video event. Key frames offer a fast way for retrieving video segments based
on a still image (bmp) representing the whole video sequence.
• Simultaneous video segment transfers: Select the number of simultaneous downloads. You cannot
retrieve more than one video segment from one video server at a time. However, it is possible to
retrieve more than one segment from more than one video server simultaneously. The minimum
value is 1; the maximum is 8.
NOTE: A high number of retrievals requires more network bandwidth. As the flow of video data
requires a great amount of network bandwidth, contact the Network administrator for these settings.
• Video segment duration limit: Specify the minimum and maximum duration of the video segment to
be archived. The maximum duration is 59 min:59 secs. Moving the cursor over the editable field will
activate a hint indicating the minimum and maximum duration. This feature can prove useful if you
want to restrict the number of archived video segments. For example, the restriction can be based
on the size of the record. For example, you can tell the system to ignore all video recordings with a
duration of less than 10 seconds.
• Default password for KVI and KVA file formats: For increased security, check the box if you want to
protect the archived video segments by a password. The KVI and KVA formats add the benefit of
protecting your archived data with a password. Make sure to enter identical information in the
Password and Password Confirmation fields. Operators with appropriate permission for viewing
archived video segments will be required to enter a valid password before viewing the video
segment.
• Kantech server polling frequency (m:ss) Using the slide bar to specify how often the EntraPass Video
Vault will poll the EntraPass server.
NOTE: Keep in mind that network traffic will be affected by the polling frequency between the
EntraPass Server, Workstations, Gateways and V ideo servers. Faster polling means higher network
bandwidth use.
7 Click the Significant Frame tab to define the key images that will be used as thumbnails to preview video
segments in the directories.
• You must select a setup type:
58 System Devices
• Significant Frame: The most representative still image of the video segment. This key image
serves as a summary for the video segment. It can be used as a thumbnail, for example, when
searching for a specific video segment.
• Significant Frame on Sequence: This feature is used only with dome cameras where a pattern
has been set for the camera to follow and the most representative still image of the video
segment must be defined within that pattern.
• Significant Frame on Preset: This feature is used only with dome cameras where preset positions
have been defined. The most representative image of the video segment can be set taking in
consideration the time needed by a camera to move from the first frame to the next preset
position.
• You can select one of the Default Key Frame types for each significant frame setup type:
• No image: there will be no thumbnail for this video segment.
• First frame: The video segment will be represented by a still image of the pre‐alarm recording.
This automatically enables the Delay for Significant Frame (ss:cc) parameter, which is the delay
calculated after the first frame to select the thumbnail image that will represent the video
segment. Moving the cursor over the editable field will display the min./max. time range
admissible.
• Event Frame: the video segment will be represented by the image that was captured when the
alarm occurred.
8 Click the Service tab to define login information when the EntraPass Video Vault server runs as a service
and a report needs to be printed.
• The Login to EntraPass service application box must be checked to activate this option.
• Enter the EntraPass Video Vault Domain name and Login name.
• Type in the Password and Password confirmation.
* System requirements may differ according to the size of the sites and the number of events generated
per day.
Access granted Arming request denied Time‐out on waiting for a second card
Bad code on keypad Pre‐alarm door opened too long Access granted by tenant (Note 3)
Valid floor selection Door open too long Access denied by tenant (Note 3)
Invalid floor selection Door alarm on relock Auxiliary relay activated by tenant
(Note 3)
Time‐out on floor selection Door unlocked Postal lock request granted (Note 3)
Request to exit granted Reader disabled Postal lock request denied (Note 3)
NOTE 1: The activation period for the event Waiting for keypad is defined under the Keypad delays tab
in Step 8, on page 99).
NOTE 2: The activation period for the event Waiting for a second card is defined in “Configuring the
KT‐400 Ethernet Four‐Door Controller” on page 75 for KT‐400.
NOTE 3: These events are for the KTES only.
8 Under the Keypad delays tab, define keypad options.
• In the Keypad delays section, enter the Inter‐Digit Delay time (m:ss). It represents the maximum
delay permitted between each selection of a keypad key by a user.
• Enter the Time‐out on keypad delay time (m:ss). It is set in seconds. It represents the maximum time
allowed for users to begin entering their personal identification number at a keypad.
NOTE: The maximum time allowed for both the inter‐digit and time‐out on keypad delays is 2 minutes
and 7 seconds, and for KT‐400 this is 4 minutes and 15 seconds.
• In the Delays (Not applicable to KT‐200) section, using the up/down arrows, determine the number
of Invalid attempts before keypad disabled. Users have a maximum of 255 invalid attempts before
the keypad is disabled.
• Enter the Keypad disabled duration delay (h:mm). The maximum duration allowed is 4 hours and 15
minutes. When the counter reaches the maximum, the keypad will be disabled for all cards. It is
disabled for the delay specified in the Keypad disabled duration field.
• Enter the Reset attempt counter delay (m:ss). When the delay specified in the Reset attempt
counter field is expired, the system will set the attempt counter to zero. The maximum delay is 4
minutes and 15 seconds. If the value entered is greater than the maximum allowed, then the system
will use the previous correct value.
System Devices 61
Sites Configuration
A site is composed of controllers attached to the same communication port or connection. The system
can manage up to 32 local sites per Multi‐site Gateway. EntraPass also allows users to add up to 512
remote dial up sites per Multi‐site Gateway. Multi‐site Gateway sites are composed of KT‐100, KT‐
200,KT‐300 and KT‐400 controllers.
Items displayed in the EntraPass Site window vary depending on the selected connection type. For
example, if the selected connection type is an RS‐232, an RS‐232 tab will be displayed to configure the
corresponding serial port and baud rate. If the connection type is dial‐up, three extra tabs will be
displayed for modem configuration.
Six types of connections are available: Direct (RS‐232 and USB), Secure IP (KT‐400), Secure IP (KTES),
Secure IP (IP Link), Ethernet (polling) and Dial‐Up (RS‐232) modem. Check the following table for the
connection type versus the gateway.
Multi‐site
Global Gateway KT‐NCC
Connection Type Gateway
(Note 2) (Note 2)
(Note 1)
Direct (RS‐232 or USB) Yes Yes Yes
NOTE 1: The Multi‐site Gateway is available in all EntraPass Editions. Even though, it is not referred as
a Multi‐site Gateway, the EntraPass Special Edition includes an imbedded Multi‐site Gateway.
NOTE 2: The KT‐NCC and the Global Gateway are only available with EntraPass Global Edition.
1 From the Devices window, click the Site icon.
2 Select the Gateway where the site will be configured.
3 If you are defining a new Site, assign a name to the new site and click the Save icon. The bullet next to
the Site name will turn green.
4 Under the General tab:
• In the Hardware definition and KTES section, specify the number of controllers for the site. There
may be up to 32 controllers per site. If the number specified is greater than the maximum allowed,
the system will set the value to 32.
NOTE: When the connection type is Secure IP (KTES), the number of KTES is automatically limited to a
single KTES per site.
62 System Devices
• In the Daylight saving time options section, check the Use Windows daylight saving time setting box
to automatically switch to daylight saving time according to Windows standard settings. Leave
unchecked if you want to do it manually.
• If you are communicating with a remote site by modem, enter the time difference between gateway
location and EntraPass server location in the Time adjustment based on Gateway timezone (h) field.
This setting will allow events from the remote site to be displayed at local gateway time on EntraPass
workstations located in different timezones.
• Select a Graphic and Video view to which the gateway is assigned, if applicable.The video view will
only be activated If the video feature is enabled in EntraPass.
• Use the scroll list to select the Connection type between the computer and the gateway. This will
determine which tabs will be displayed for configuration.
1 When you specify Secure IP (IP Link), Secure IP (KT‐400) or Secure IP (KTES) from the Connection type
drop‐down list in the General tab, you will be able to access three extra tabs: IP Device IP configuration,
IP Device Automated Connection and IP Device Parameters.
• MAC address: Complete the device MAC address. The first 6 characters in the MAC address (00‐50‐F9)
cannot be modified.
• Check the Online box.
• Obtain IP address automatically: Check this option when configuring the device with a
Reserved DHCP IP address.
• Use the following IP Address: Check this option when you want to assign a static IP address to the
device. When selected the next three parameters will become available.
• IP Address: The static IP address should be provided by the System Administrator.
• Subnet Mask: This address should be provided by the System Administrator.
• Gateway (Router): This address should be provided by the System Administrator.
• DNS server address: This address should be provided by the System Administrator (for Kantech
IP Link and KT‐400 only).
• Protocol: Used to specify the communication protocol, UDP or TCP.
• Port:
• For TCP: Should be 18802 for the host site. Not required for the remote site.
• For UDP: Port 18810 is automatically assigned to the device by default. It should not be
modified unless the IP device is at a remote location, like in a WAN.
NOTE: Port 18802 should be used with KT‐400, KTES and IPLink.
• The EntraPass Special Edition / Multi‐site Gateway IP address will be used.
• IP address: You will enter the gateway computer IP address.
• Domain name: If you don’t have the gateway IP address, you can enter the domain name provided by
the System Administrator (for Kantech IP Link, KTES and KT‐400 only).
NOTE: You must select to either enter the IP address or the domain name. You cannot enter both at the
same time (for Kantech IP Link, KTES and KT‐400 only).
• Test DNS: Once you have entered the domain name, click on the Test DNS button. This should display
the corresponding IP address (for Kantech IP Link, KTES and KT‐400 only).
2 Move to the IP Device Automated Connection tab if you are in a WAN environment.
• The Broadcast configuration box must be checked at all times.
• Private IP Address (LAN): Will assign the IP address automatically.
• Public IP Address (WAN): This IP address should have been provided by your internet provider.
This corresponds to the IP of the remote site.
• Domain Name (WAN): This information should be provided by the System Administrator. This
corresponds to the IP of the remote site.
• Enable KT‐Finder diagnostic for IP device: Check this box if you want to use the KT‐Finder as a
configuration and troubleshooting tool.
3 Move to the IP Device Parameters tab to configure security and communication parameters.
• Encryption key: You will enter a 16‐Digit hexadecimal code to secure your site.
64 System Devices
• Controller’s loop baud rate: Enter the controller’s loop baud rate.
NOTE: For a KT‐200, the maximum baud rate is 19200.
• In the Delays section:
• Heartbeat frequency (mm:ss): Enter the frequency to which you want the IP device to send a
signal to the gateway to indicate it is online (00:15 to 10:00).
• Fail to report after (mm:ss): Enter the delay before acknowledging communication failure (01:30
to 59:59).
• Fail‐soft delay on gateway communication failure (mm:ss): Enter the delay before the IP device will
consider communication with a controller has been lost and the controller is in fail‐soft mode.
• Retry Count: Enter the number of times the IP device will try to communicate with a controller
within the delay setup in the previous parameter before acknowledging communication failure (1 to
15).
• Maximum wait on send command (s.cc): When applicable, enter the maximum delay period that the
gateway will allow for the IP device to acknowledge reception of a command from an EntraPass
workstation (1.00 to 9.99).
• Check the Call immediately when buffer 70% full to force download of a site controller’s event buffer
as soon as it reaches 70% capacity.
NOTE: Do not click the Remote modem delays button. All values are factory‐set for optimum
performances with the supported US Robotics modems. Settings SHOULD NOT be edited unless
recommended by Kantech.
Controllers Configuration
Controllers provide audiovisual feedback on the access decision. Typically, a red/green light (LED)
indicator on the reader informs the cardholder that the door is unlocked or that access has been denied.
A local door alarm can be installed to provide an audible warning if the door is forced open or remains
open after an access.
The controller definition tells the system how a controller is being used and what devices are associated
with it: (doors, input zones, relays and output devices). Controllers may be defined during a gateway or
site configuration; or in the controller definition menu, by selecting either the controller icon (Devices >
Controller) or by using Express Setup program. EntraPass supports four types of controllers: KT‐100, KT‐
200, KT‐300 and KT‐400. These provide the ability to activate local functions associated with a controller.
The number of devices associated with a controller varies according to the controller type. The following
table summarizes the basic components associated with each type of Kantech controller:
Input Auxiliary
Type Door(s) Relays
Zones Outputs
KT‐100 1 4 4 2
KT‐200 2 2 16 4
KT‐300 2 2 8 4
KT‐400 4 4 16 16
Main Features
• Up to 256 inputs (16 onboard with high security double end‐of‐line resistor configuration)
• Up to 256 outputs
• Four Onboard form C relays
• 16 reader output on board
• Onboard 128‐bit AES encryption ensures a high degree of network security
• Removable terminal blocks
System Devices 67
• On Board Ethernet port ensures quick network connectivity, no external Ethernet device required
• Automatic Port Detection
• For readers, locks and other devices, built‐in battery backed power supply ensures continuous operation
and saves installation time and money by eliminating the need for an external power source
• Can act as an IP Master controller on a RS‐485 network
• Compatible with Kantech controllers KT‐100, KT‐300 & (KT‐200 on a separate loop)
• Dedicated Tamper Input
• External lock device power option
• Four configurable output per reader
• Built‐in WEB page configuration
• Multiple Configuration Options (IP, RS‐485 & RS‐232)
• Low network bandwidth consumption
• Visual Status Indicators (LEDs)
• More supervision and monitoring
• Controller local area with anti‐passback
• 100,000 Card per controller and 20,000 stored events in stand‐alone mode
• Activation time on temporary action & events
ioProx Dual Driver (26-Bit and XSF) Yes Yes Yes Yes
Polaris 2KP ABA with Polaris Cards Yes Yes Yes Yes
ioProx with Integrated Keypad (8-Bit Burst) Yes Yes Yes Yes
NOTE: The New reader driver icon allows you to install a custom driver for a specific controller.
Moreover, using this button allows you to add the driver in the Reader+ Driver table, making it
available the next time you want to configure a new controller.
• Use the Disable controller polling when you need to put the controller in disable mode. In disable
mode, the controller will never be polled and all status requests from this specific controller will
send a message that this controller is disabled.
NOTE: This option can be used when a controller is removed temporarily but must not be deleted
(when under repair, for example). It also allows Operators to easily setup the software before the
physical installation is completed.
• Select a Graphic and Video view to which the gateway is assigned, if applicable.The video view will
only be activated If the video feature is enabled in EntraPass.
4 To define the schedules applicable to the new controller, you must move to the Supervision Schedule
tab.
• Select the applicable Schedules for the new controller:
• When a KT‐100 or KT‐300 is selected: only the Power supervision schedule list is displayed.
• When a KT‐200 or KT‐400 is selected, the Power supervision schedule and the Tamper switch
supervision schedule lists are available.
5 Click the Save icon.
5 In the EOL resistor (5.6K) drop‐down list, select the resistor type used with your system. By default, this
choice is set to None. This feature is used as a supervision device for all inputs. In fact, if this feature is
enabled and if an input is disconnected, an alarm message is generated and sent to the Alarm message
desktop (or other desktop configured to receive such events).
NOTE: For details on defining controller options for KT‐100 controllers, see "Defining Controller
Options" on page 78.
The KT‐200 is equipped with two relays. These relays can be activated according to schedules, reported
events or a combination of different logical conditions. The system is expandable to 16 relays using REB‐
8 relay expansion board modules. REB‐8 may be used as relays or as elevator controllers. KT‐2252 are
only used as elevator controllers.
NOTE: Please note that the KT‐2252 elevator controllers are no longer available.
1 16 1
1 32 1
1 64 2
2 8 1
2 16 1
2 32 2
2 64 4
6 In the Floors column, select the floors associated with KT‐2252 controller terminals.
NOTE: The Inputs column refers to the KT‐2252 terminals. When floors have been defined (in the Floor
menu), the Floors column contains the floors associated with the inputs.
System Devices 73
2 9 to 16 Cab 1
3 1 to 8 Cab 2
4 9 to 16 Cab 2
NOTE: The Inputs column refers to the REB‐8 terminals. When floors have been defined (in the Floor
menu), the Floors column contains the floors that are associated with the inputs.
4 In the Floors column, select the floors associated with REB‐8 controller terminals. For details on floor
definition and door group definition, see "Doors Configuration" on page 88.
NOTE: There is no floor confirmation when an REB‐8 is used as an elevator controller.
KT‐300 controllers support Combus modules. The Combus is a 4‐conductor cable bus to which several
expansion modules are connected in parallel to add inputs, outputs, relays and an LCD time and date
display.
1 From the Site menu, click the Controller icon, then select the KT‐300 tab.
2 Enter the controller serial number in the Serial number field. Usually, the number is found on the
controller label. The field is defined to accept only numeric characters, except for the first character. It
may be an a or A. If a lower case character is entered, the system converts it to upper case.
3 Enter the Wait for second access card delay. The maximum time allowed is two minutes and seven
seconds. If the value entered is greater than the maximum allowed, the system will use the existing
value. This feature is useful when access to a place is controlled by two cards.
4 In the Keypad escape key drop down list, choose a keypad escape key if applicable. This feature is
associated with PINs. When a user enters a wrong number, he/she may press the escape key and re‐enter
the PIN, without incrementing the number of attempts.
5 In the EOL resistor (5.6K) drop‐down list, select the resistor type. By default, the Single resistor option is
selected. If you hear a long buzz, verify the number of resistors installed on your system.
5 Check the options related to the module you want to configure (if these are displayed in the window).
NOTE: Usage options of a module vary according to the selected Combus module. For example,
installing the KT3‐LCD and checking the options Combus low power and Display date and time will allow
the KT‐300 to report Combus low power conditions and to display the date and time.
The following table summarizes the options associated with each module:
Combus
Options Additional options
type
KT3‐LCD Combus low power, display date and No additional options
time
KT‐PC4204 Tamper alarm, Combus low power, Low Used as relays (1‐4)
battery, Power failure, lower auxiliary
power
6 Check the Combus low power option so that the KT‐300 will report any Combus low power condition
7 Check Display date and time option so that LCD can display the date and time.
8 When you have finished configuring the Combus module, click the OK button to go back to the Status
relay tab.
9 Associate a Local activation relay for Power failure, Combus failure and Combus low power (Multi‐site
Gateway only). If you want to assign a specific relay, you may click the three‐dot button and select a
specific relay or group of relays.
NOTE: To configure local activation relay, you must configure relays (Devices > Relays), and then select
specific relays for local activation.
10 Under Priority call type, assign the call type option that best suits failure event reporting (Multi‐site
Gateway only). To access the Priority call type feature, the site connection type must be set to Modem.
NOTE: For details on defining controller options for KT‐300 controllers, see "Defining Controller
Options" on page 78.
NOTE: For more information, see "Sites Configuration" on page 61.
EntraPass system. Power outputs are supervised and electronically protected against short‐circuits and surges.
Locking devices are also supervised for short and open circuits.
NOTE: For hardware information on the KT‐400 Ethernet Four‐Door Controller, please refer to the KT‐400
Ethernet Four‐Door Controller Installation Manual, DN1726.
1 From the Devices > Controller menu, click on the General tab and select the Reader type(s).
2 Select the Keypad type (if applicable).
3 Click on the KT‐400 tab. Enter the controller serial number in the Serial number field. The number is
found on the controller label next to the reset button. The field is defined to accept only numeric
characters, except for the first character. It may be an a or A. If a lower case character is entered, the
system converts it to upper case.
4 Enter the Wait for second access card delay. The maximum time allowed is 4 minutes and 15 seconds. If
the value entered is greater than the maximum allowed, the system will use the existing value. This
feature is useful when access to a place is controlled by two cards.
5 In the Keypad escape key drop down list, choose a keypad escape key if applicable. This feature is
associated with PINs. When a user enters a wrong number, he/she may press the escape key and re‐enter
the PIN, without incrementing the number of attempts.
6 In the EOL Resistor (5.6 K) drop‐down list, select the resistor type. By default, the Single resistor option is
selected. If you hear a long buzz from the installed reader/keypad, verify the number of resistors
installed on your system.
The following table summarizes the options associated with each module:
KT‐MOD‐REL8 (Note) Relays (up to 256) and/or elevator outputs (up to 64 per ele‐
vator door)
NOTE: There are already 4 relays available on the KT‐400. Make sure to check the relay number
assignments to prevent redundancy unless it has been planned on purpose.
NOTE: The 9‐16 relay configuration is set by default.
1 If an expansion module(s) is(are) connected to a KT‐400, click the Expansion module configuration
button. The Expansion modules setup appears.
2 To add a KT‐MOD‐INP16, select the Input Module tab and then click on Add. If there is more than one
input modules listed, make sure that you select the correct one before changing the input assignments.
Assign names to the modules in the language fields and choose the options.
3 Select the DEOL: Double end‐of‐line resistor JP4 On checkbox to define a KT‐MOD‐INP16 module in
DEOL.
NOTE: The entire expansion board is used to provide 8 inputs with DEOL. These 8 inputs are added of
the next group of 8 inputs. For example, if inputs #33‐40 are linked to a DEOL module, inputs #33‐40
and #41‐48 will not be available for other modules.
NOTE: Controller inputs 1‐16 are reserved to the inputs on the KT‐400.
78 System Devices
4 Selection of the inputs numbers can be done in two ways: using the drop‐down menu or the Extended
selection box. Right‐click on the inputs menu selection to view the Extended selection box, See "Using
the Extended Selection Box" on page 65.
NOTE: This is an exclusive condition. You cannot select the same item in the Inputs drop‐down menu
and in the Elevator inputs drop‐down menu because it will be a duplicate, and the system does not
accept any duplicate. For example, Inputs # 17‐24 cannot be selected twice. Another way to let you
understand this concept, is that in the Elevator inputs menu the same item will not be available for
the same door. The same concept applies for the Elevator outputs menu.
5 To add a KT‐MOD‐OUT16, select the Output Module tab and then click on Add. When you click on the
Add button, a menu appears and lets you select which output module you want to add. Assign names to
the modules in the language fields and choose the options.
6 To add a KT‐MOD‐REL8, select the Output Module tab and then click on Add. When you click on the Add
button, a menu appears and lets you select which output module you want to add. Assign names to the
modules in the language fields and choose the options.
Warning: There are already 4 relays available on the KT‐400. Make sure to check the relay number
assignments to prevent redundancy unless it has been planned on purpose.
7 From the Summary tab, you can modify all the modules. Make sure to highlight the module you want to
modify in the left column before doing any modifications on the right side.
8 When you have finished configuring the expansion modules, click the OK button to go back to the KT‐400
configuration window.
NOTE: For more information, see "Sites Configuration" on page 61.
• Duress on access granted: this option enables the duress key when access is granted.
• Duress on access denied: this option enables the duress key, even when access is denied.
3 Select a duress key from the Keypad duress key drop‐down list.
NOTE: For added security, you may select the two options. The anti‐passback programming is only
available on a Multi‐site Gateway.
4 From the Anti‐passback options (Multi‐site Gateway only), select the anti‐passback option from the Type
drop‐down list: when an anti‐passback option is enabled, a card cannot be used on an exit door unless it
has been used on a corresponding entry door.
• None: the anti‐passback option is disabled.
• Soft anti‐passback: this option allows a cardholder to use an entry (or exit) reader more than once
without using the corresponding exit (or entry) reader. Only an “Access granted ‐ Passback bad
location” event is sent to the Message desktop.
• Hard anti‐passback: a card used at an entry reader will not be able to access the same entry reader
again until it has used the corresponding exit reader. Only an “Access denied ‐ Passback bad
location” event is sent to the Message desktop.
• Controller local area: this selection enables the Controller local area tab. This option is only
functional with the KT‐400; the Controller Local Area tab will only appear with a KT‐400.
5 In the Forgive schedule section, click the three‐dot button to set a schedule for resetting the anti‐
passback option on all other cards.
NOTE: The Forgive Schedule section is enabled only when Soft anti‐passback or Hard anti‐passback
item is selected.
6 In the Miscellaneous section, indicate options for Enable fail‐soft delay (10‐255 s). During a fail‐soft
mode, the controller operates in stand‐alone mode, following a communication failure.
7 Enter the 32‐bit card family code (optional). You can locate this hexadecimal code on the access card.
8 In the Card count options, use the up or down controls to set the maximum card number. The maximum
card number allowed is 2,147,483,647. The system keeps track of the number of monitored cards that
are in the monitored area and activates a relay when the count is reached. When users exit the area, the
counter decrements and the relay will eventually reset when the count is smaller than the value defined.
9 You may configure the system to Activate a single relay or a group of relays when the maximum count is
reached. Click the three‐dot button to select the relay or relay group that will be activated when the
number is reached.
NOTE: The Activate relay section is enabled only when Soft anti‐passback or Hard anti‐passback item is
selected.
4 Enter the maximum number of cards allowed in the Cards threshold field.
5 Check the Deny access on area full box to prevent more users to enter the area after the cards threshold
has been reached.
6 Click on the three‐dot to select the relay or the relay group to activate when the cards threshold has
been reached.
7 Repeat steps 2 to 6 for each controller local area.
buildings, gated communities, condominiums, office buildings, factories, and industrial sites. Visitors
use the KTES to communicate directly with a tenant and are easily identified by voice communication.
The tenant can grant or deny the visitor access directly from a telephone land line or a cellular phone.
Designed as a stand‐alone unit, the system controls one door, auxiliary relay, and supports postal lock
access. For larger commercial installations, the KTES integrates with EntraPass through a Multi‐site
Gateway and KT‐controllers to provide a complete access control solution. The entire programming of
the system can be done directly on the keypad or remotely from a PC via a modem, Ethernet connection
or RS‐485 interface.
The system reports all events directly to EntraPass, where you can obtain a detailed event log.
Additionally, programmed alarms can be reported to a pager and/or to the EntraPass system via an
integrated modem. For more information on the KTES, please refer to the KTES Installation Manual,
DN1769 and the KTES Programming Manual, DN1770.
NOTE: For reliability and configuration consistency, Kantech currently supports the US Robotics
Sportster external modem only. Even if other type of modem are available, we strongly recommend
using the officially supported external US Robotics.)
• Postal lock contact: This is the input corresponding to the door postal lock (0 to 4). Select an input and
click OK:
NOTE: see "Input Configuration" on page 99 for more information.
• Postal lock Schedule: This is the schedule inside which the input, corresponding to the postal lock,
generates a valid postal lock request when that input is in alarm.
NOTE: See Schedules Definition on page 186 for more information about schedule definition.
5 Disable KTES polling option: Select this checkbox when you need to put the KTES in disable mode. In
disable mode, the KTES will never be polled and all status requests from this specific. Default value is
selected.
6 Specify the Tenants list options:
• Tenants list capacity: By default, the capacity is 250 tenants unless you have registered for 500, 1000
or 3000 tenants total.
NOTE: Remember that you are limited by the options purchased with the software. If you have
registered many KTES options for additional capacity, make sure to assign it to the correct KTES site.
• Tenants list: Select a tenants list. Default value is empty.
NOTE: See Tenants List on page 365 for more information about Tenants list definition.
• Use all tenants from list: Check this box to include all the tenants from the list. Otherwise, leave the
check box empty and click the Customize button. Select the check boxes for tenants to be included
and/or displayed on the LCD. Default value is selected.
• Use the Print button to send a printout of the tenants list to a printer of your choice. Sort by name or
by code and preview before printing.
• Select a Graphic and Video view to which the gateway is assigned, if applicable.
• Telephone line regional setting: The Telephone line regional setting must be set
to specify which telephone line country code should be used by the KTES. Default
value is USA/Canada (0). Click the drop down list to display the available countries:
• Time base: Main time base comes from the AC power input (50 Hz or 60 Hz) for
best accuracies over large operating temperatures. Time base will be automatically
switched to internal Xtal in case of AC power failure. Time base can be forced to
internal Xtal when DC power only or unstable AC source is used. Default value is
60Hz.
• Line monitoring: The telephone line is monitored when busy or disconnected,
when this option is selected. Default value is selected.
NOTE: In order to comply with New Zealand Telepermit requirements, line sensing
must be turned on.
4 Specify the Tenant response setting:
• Keypad key for access granted by tenant: This telephone key can be used by a tenant to grant access to
a visitor. Default value is 9.
• Keypad key for access denied by tenant: This telephone key can be used by a tenant to deny access to a
visitor. Default value is *.
• Keypad key for auxiliary relay activated by tenant: This telephone key can be used to grant access to a
visitor that is using a secondary entrance. Default value is empty.
5 Specify the Wiegand interface options:
• Reader type: This is the Wiegand Interface output format to be sent to the KTES. Default value is
Kantech XSF.
• Reader’s Driver download: Click on the button to open the selection window and select a driver
to download:
• Wiegand integration with an access controller: Selecting this option indicates that the KTES is
connected to an access controller. Otherwise it is operating in Standalone mode.
• Card holder used for postal activated: This is the card number used by the KTES to generate a Wiegand
code when the postal lock is activated. Default value is empty.
• Enter the displaying delay in seconds (0 sec to 4 min:15 secs). Default value is 2 secs.
• Repeat both steps for the second message.
6 Click the Save button.
Special Characters
By combining the commands listed in the following table, you can display the KTES current hour and
date according to different formats. For example:
• The complete current date in the international format: &yyy/&o/&d = 2007/01/18
• The complete current date in the american format: &o/&d/&y = 01/18/07
• The complete current hour in 24 hours format: &h:&m:&s = 14:50:55
• The complete current hour in am/pm format: &h:&m:&s&a = 02:50:55pm
• The current day in 3 letters format: &ww = mon
• The current day in 10 letters format: &wwwwwwwww = wednesday
• The current month in 3 letters format: &oo = jan
• The current month in 9 letters format: &Oooooooo = January
• The complete current date in letters and digits format: &ww &oo &d &yyy = thu jan 18 2007
Display Format
Hour displayed in 24 hours format &h
Hour displayed in 12 hours format &h&a
Minutes &m
Seconds &s
Ten of years &y
Year &yyy
Month &o
Date &d
Day of the week &ww to &wwwwwwwww
Current month in text format &oo to &ooooooooo
• Backlight delay: The Backlight Delay is the maximum delay of inactivity before the LCD backlight turns
low (0 sec to 4 min:15 secs). Default value is 20 secs.
• Next character delay: The Next Character Delay is the maximum delay allowed between each key
press before considering a next character entrance when entering a text string at the keypad (0 sec to
4 min:15 secs). Default value is 2 secs.
• Find user timeout delay: After pressing the Find option key, the Find user timeout delay is the
maximum delay allowed between each key press before cancelling a find sequence (5 sec to 4 min:15
secs) Default value is 15 secs.
• Programming PIN timeout delay: The Programming PIN timeout delay is the maximum delay allowed
to enter a complete valid PIN number before entering in system programming mode (5 sec to 4 min:15
secs). Default value is 20 secs.
• Programming mode timeout delay: The Programming mode timeout delay is the maximum delay
allowed between each key press before exiting from the programming mode and returning to the
welcome messages (5 secs to 9h:59 min). Default value is 60 secs.
3 Specify the Duress options. A Duress alarm is used by employees or tenants to signal for help:
• Duress on access granted: Allows a tenant to trigger a duress alarm after a valid PIN entry. Default
value is unselected.
• Duress on access denied: Allows a tenant to trigger a duress alarm after an invalid PIN entry. Default
value is unselected.
• Keypad duress key: Set this parameter to configure the symbol that will activate the duress functions. A
Duress alarm is used by employees or tenants to signal for help(0 to 9, # and *). Default value is 9.
4 Specify the Supervision Schedule options:
• Power supervision schedule: To define the schedule applicable to KTES power monitoring. Select a
schedule from the list and click OK. Default value is empty.
• Tamper switch supervision schedule: To define the schedule applicable to KTES tamper switch
monitoring. Select a schedule from the list and click OK. Default value is empty.
5 Click the Save button.
NOTE: See Schedules Definition on page 186 for more information about schedule definition.
• Lock power trouble: This parameter defines the relay to be activated in the event of a door lock
problem, locking device disconnected or shorted to ground. Default value is none.
• Other troubles: Relay that will be activated when any other trouble on the KTES occurs. Default value
is none.
• Heater kit activated: Relay that will be activated when cabinet inside temperature falls below +5oC.
Default value is none.
• Postal lock: Relay that will be activated with an entry request from the front door postal lock. Default
value is none.
3 Specify the Pager call type:
For each event you can configure a pager call type. You can select No call (the relay activation for that
event will not be sent to the pager), Immediate call (the relay activation for that event will be sent
immediately to the pager) or Schedule call (the relay activation for that event will be sent to the pager
according to the pager call schedule). Default value is No call. See "If you are assigning or defining
schedules, make sure that you are selecting the proper category for this schedule. For example, if you are
assigning or defining a system schedule (for workstation, operators, event parameters, video triggers)
this schedule will be available for selecting components of this category. If you are selecting a schedule
for physical components such as controllers, doors, inputs, their schedules will be grouped by gateway if
you are using a Global Gateway and by site if you are using a Multi‐site Gateway by site if you are using a
Multi‐site Gateway. If you have defined two sites in your system, there will be two separate groups of
schedules for each site. You can define up to 99 schedules for each site." on page 186.
NOTE: To specify pager call types for each events, the Pager reporting function must be enabled. See
"Defining the Pager Options" on page 86
• Trouble code: The pager code corresponding to the general event that triggered a zone trouble
condition (0 to 999). Default value is 3.
• Field separator: The Field separator is the character to be used as a field separator or delimiter (*,
# or ,). Default value is *.
• Field ending: The Field ending is used to indicate that the call is completed. Remember that you can
enter any signs for the ending parameter (*, # or ,). Default value is #.
3 Specify the General event pager codes:
• Tamper in alarm: The pager code that corresponds to a tamper switch problem (0 to 999). Default
value is 100.
• Power failure: The pager code that indicates an AC power failure on the KTES (0 to 999). Default
value is 101.
• Battery trouble: The pager code that indicates a low battery problem on the KTES (0 to 999). Default
value is 102.
• Buffer 70% full: The pager code sent to indicate that the event buffer for the EntraPass software has
reach a 70% capacity (0 to 999). Default value is 103.
• Other troubles: The pager code that corresponds to any other system event that can occur (0 to
999). Default value is 104.
• Door forced open: The pager code that corresponds to a forced open door (0 to 999). Default value is
120.
• Door open too long: The pager code that corresponds to a door opened for too long (0 to 999).
Default value is 121.
• Door alarm on relock: The pager code that corresponds to a door left opened (0 to 999). Default
value is 122.
• Lock trouble: The pager code that corresponds to a problem with the door locking device supervision
(0 to 999). Default value is 123.
• Keypad disabled: The pager code that corresponds to a keypad disabled condition (when the option is
enabled (0 to 999). Default value is 124.
• Duress alarm: The pager code that corresponds to a duress alarm. A Duress alarm is used by
employees or tenants to signal for help (0 to 999). Default value is 125.
• Access granted: The pager code that corresponds to a granted access. An access granted code is sent
when the tenant was granted access using his PIN (0 to 999). Default value is 140.
• Invalid access schedule: The pager code that corresponds to a denied access. An access denied code
is sent when the tenant was denied access using his PIN (0 to 999). Default value is 141.
• Access granted by tenant: The pager code that corresponds to an allowed access by a tenant to a
visitor (0 to 999). Default value is 142.
• Auxiliary relay activated by tenant: The pager code that corresponds to an allowed access by a tenant
to a visitor at an alternate entrance, different from the main entrance usually used by the tenants or
visitors, for example (0 to 999). Default value is 143.
• Access denied by tenant: The pager code that corresponds to a denied access by a tenant to a visitor
(0 to 999). Default value is 144.
• Tenant traced: The pager code that corresponds to a granted access for a traced tenant (0 to 999).
Default value is 145.
88 System Devices
• Disabled tenant: The pager code that corresponds to an access attempt from a tenant with an
invalid status (0 to 999). Default value is 146.
• Other access denied: The pager code that corresponds to an access attempt from a tenant outside
of his assigned schedule (0 to 999). Default value is 147.
Doors Configuration
This menu is used to define the door parameters on which readers and/or keypads are installed. A door
can be an elevator door, a In/Out door, an entry door for anti‐passback, an exit door for anti‐passback or
an access door. It depends on how the settings are programmed. The controlled door may be secured at
all times or only during defined schedules. The common locking devices used are electric door strikes
and electromagnetic locks. A door may be equipped with one or two readers; one reader on each side.
For doors equipped with two readers, the outer reader has to be defined as an entry reader and the
inner reader as an exit reader.
6 Check the Elevator cab option if the door is to be used for elevator control. When this option is checked,
the Elevator tab is displayed to define the unlocking schedules. Default value is unchecked.
7 Specify the In/Out type from the drop‐down list (default is None):
• None: The reader is considered as an access reader. An access reader generates only “Access
granted/Access denied” events.
• Entry: An entry door is an entry point. In order for the system to record an entry, the door must be
opened after a valid access (if a door contact is installed).
• Exit: An exit door is an exit point. In order for the system to record an exit, the door must be opened
after a valid access (if a door contact is installed).
8 If the Controller Local Areas are enabled then go to Step 11.
9 Specify the Door Anti‐Passback type (default is Access):
• Access: The reader is considered as an access reader. Anti‐Passback options are not used with access
doors. An access reader generates only “Access granted/Access denied” events.
• Entry: An entry door is an entry point. In order for the system to record an entry, the door must be
opened after a valid access (if a door contact is installed).
• Exit: An exit door is an exit point. In order for the system to record an exit, the door must be opened
after a valid access (if a door contact is installed).
10 Go to Step 13.
NOTE: None, Soft anti‐passback and Hard anti‐passback are used only with the KT‐400 and Controller
Local Areas.
11 Specify the Door Anti‐Passback type (default is Access):
• None: the anti‐passback option is disabled.
• Soft anti‐passback: If the destination area is under Deny Access on Local Area Full, access is denied.
When a user is passing his access card to a local area, for example, the system will allow him to
access another local area even if the user was not in the Local area before. The system will generate
the event: “Access granted ‐ Passback bad location“.
• Hard anti‐passback: If the destination area is under Deny Access on Local Area Full, access is denied.
A card used at an entry reader will not be able to access the same entry reader again until it has used
the corresponding exit reader. The system will generate the event: “Access denied ‐ Passback bad
location“.
12 Specify the Local area before and Local area after. These items are enabled and can be specified only for
Controller Local Area.
13 Specify the Door access delay:
• Unlock time (hh:mm:ss): The time during which the door is unlocked on a valid card read or a valid
request to exit event (when the REX is defined to unlock the door). The time range value can be from
00:00:01 to 04:15 (255 sec.) for a KT‐100, KT‐200 and KT‐300; or to 18:12:15 (65535 seconds) for a
KT‐400. If this is an elevator door and a push button (input) is used to enable floor selection, this is
the time during which a floor selection will be allowed. Usually, a longer period should be defined to
allow the user to select floors. Default value is 10s. For more information, see "Defining an Input for
an Elevator Door" on page 102.
• Open time (hh:mm:ss): The time during which a door can remain opened following a permitted
access or a valid request to exit request. This applies only to a door defined with a door contact
90 System Devices
input. The time range value can be from 00:00:01 to 04:15 (255 sec.) for a KT‐100, KT‐200 and KT‐
300; or to 18:12:15 (65535 seconds) for a KT‐400. After this delay has expired, the system will
generate the event “door open too long” and the door piezo will sound to warn the cardholder. You
can use the Pre‐alarm on door open too long (Door window, Contact tab) to sound the door piezo
when half of this delay has expired. It will continue to sound until the door is closed. Default value is
30s.
14 The Extended door access delay (hh:mm:ss) feature allows to keep the door open for an extended period
in order to allow people with disabilities to pass through without triggering an alarm. If you want to use
this option, specify the delays in the Unlock time (default is 40s) and Open time (default is 2 min) fields.
The time range value, for both delays, can be from 00:00:01 to 04:15 (255 sec.) for a KT‐100, KT‐200 and
KT‐300; or to 18:12:15 (65535 seconds) for a KT‐400.
15 Unlock Schedule will allow the system to unlock the door for a predetermine period of time that you will
select.
16 Select a Graphic and Video view to which the gateway is assigned, if applicable. The video view will only
be activated if the video feature is enabled in EntraPass.
NOTE: EntraPass offers the ability to program an extended door access delay and to specify specific
unlock and open time delays reserved for people with disabilities. In addition to setting this special
access delay, the user’s access card must be programmed with this feature. Only available with KT‐
100, KT‐300 and KT‐400.
may “lend” its PIN to another person but cannot prevent further use (in comparison to getting a card
back).
NOTE: This option can be enabled on a reader with an integrated keypad if you want, for instance, to
use the keypad only.
• Reader and keypad: Select this option if both a reader and a keypad are used to permit access to this
door. The keypad will only be used when the “keypad schedule” is valid. Adding a keypad to a reader
significantly increases the level of security. PIN code requirement can be limited by a schedule for
use only outside business hours, for example, rather than during high traffic hours.
3 From the Card and PIN schedule menu, select a schedule during which cardholders will have to enter
their PIN after a valid card read. The time allowed between a valid card read and entering the PIN at the
keypad is set in the Gateway definition menu (Time‐out on keypad option).
4 Check the Enable duress function on keypad option, if desired. Default value is unselected.
5 Select the Keypad relay activation key(s):
• For KT‐100 and KT‐300 Controllers: For doors defined with keypad or reader and keypad, you can
program the star key (*) or pound key (#) to activate a relay. When this feature is enabled, users can
activate a relay simply by pressing the appropriate key.
• For KT‐400 Controllers: For doors defined with keypad or reader and keypad, you can program *, # or
any key to activate a relay or a relay group. When this feature is enabled, users can activate a relay or
a relay group simply by pressing the appropriate key.
4 Check Enable door open too long notification to continue to receive the Door open too long event and
the Pre‐Alarm door open too long in the desktop. If there is no schedule selected, this checkbox is not
available for selection (greyed out).
NOTE: For KT‐200 Controllers, Input 1 (door contact) and 2 (request to exit device) are ideally reserved
for Door 1 of the controller whereas Input 9 (door contact) and 10 (request to exit device) are ideally
reserved for Door 2 of the same controller. The input that is used for the door contact or REX contact
SHOULD NOT have a “monitoring” schedule defined in the “Input Definition” menu.
5 Check the door reading options:
• Door open reading—If selected, this option allows the system to read cards while the door is open.
However the system will not unlock the door if it was locked. If selected, the event “Access granted”
is generated. Otherwise, the event “Access granted ‐ Door open” is generated. Default is checked.
• Door unlocked reading—If selected, this option allows the system to read cards while the door is
unlocked manually by the operator or by a valid unlock schedule. If selected, the event “Access
granted ‐ Door unlocked” will be generated on access. To ignore all access events while the door is
unlocked, leave this option unselected. Default is checked.
• Unlock on access door opened— If selected, this option allows the system to unlock access on door
opened at any time. Default is unchecked.
• Pre‐alarm door opened too long—If selected, this option allows the system to generate the event
“pre‐alarm door open too long” and sound the door piezo when half of the delay defined in the
Open time field is expired. It will continue to sound until the door is closed. Default is unchecked.
NOTE: If the door is a KT400 and if the value entered is higher or equal than the open time and if the
checkbox is selected, a pop up will appear explaining that the delay value is incorrect. Value range can
be between 00:00:01 and 18:12:15 and must be lower than the door open time.
6 Select the appropriate Relock on access option. You may choose to relock an access On door opening or
On door closing. Default value is On door opening.
• Unlock on REX: the door will be unlocked if a valid request to exit is permitted by the controller. This
option may be useful on exit doors such as interior doors, shipping doors or other push doors
through which people carrying packages may pass. The system will permit the exit and generates the
“request to exit granted” event rather than “door forced open” event.
• Resettable REX function: the unlock time is restarted on a valid request to exit. Open and unlock
times are defined in the door definition (Devices > Door > General). Select this option for high traffic
area doors such as manufacturing doors where many users may need to exit at short intervals (for
example after a work shift) to prevent unwanted door open too long or door forced open events.
NOTE: It is recommended to choose either Unlock on REX or Resettable Rex function, not the two options
at the same time. If you choose these two options, the door may remain unlocked for long periods of
time. Moreover, these features should not be used if a door contact has not been defined.
Card Multi‐Swipe
This feature allows using double and triple card swipe actions with the new KT400 firmware (KT‐400: 1.08; KT‐400
V1: 1.11).
1 Select the Multi‐swipe tab.
2 Enable Multi‐swipe: Check to enable the multi‐swipe function. Deselecting will disable the multi‐swipe
function but keep the parameters entered previously for future use.
3 Schedule: The schedule applies to both the double swipe and triple swipe actions and will need to be valid
when the person swipes the card a second time or a third time for the corresponding action to occur.
4 Delay: There is a maximum delay of 3 seconds between two card swipes to be considered by EntraPass as a
double or triple swipe. A beeping sound will be heard two times for the double swipe and three times for the
triple swipe. A long beep indicates a denied entry.
5 Relay: Select a relay to be triggered.
6 Relock on access on double/triple swipe: Relock on access on double swipe or triple swipe checkbox controls
are used to lock the door before executing the double or triple swipe action.
NOTE: By default the system set the unlock time for the door to 10 seconds and the open time to 30
seconds. If the door is kept open for more the 15 seconds after a valid swipe, a pre alarm door open
too long (see the Contact tab) will be triggered and the buzzer on the reader will start to beep.
NOTE: The pre alarm door open too long delay will override the default setting for the Open time. For
example, an unlock time of 10 seconds and an open time of 2:00 minutes. If the pre alarm door open
too long option is selected with a time delay of 00:00:20, 20 seconds before the end of the open time,
the system will trigger a pre alarm door open too long alarm and the buzzer will start to beep on the
reader.
NOTE: This feature is only available on KT‐400 with firmware higher then 1.08.
• Request to arm granted ‐ Alarm interface: Equivalent to an arm door manual operation including panel
partitions arming functionality.
• Temporarily activate relay: A relay or relay group can be selected. A delay can be entered. (between
00:00:01 and 18:12:15).
• Temporarily unlock door: Relock on access on double/triple swipe will be automatically checked and
disabled. A delay can be entered (between 00:00:01 and 18:12:15).
• Toggle door lock: Relock on access on double/triple swipe will be automatically checked and disabled.
• Toggle relay: A relay or relay group can be selected.
• Unlock door: Relock on access on double/triple swipe will be automatically checked and disabled.
4 Once all door event features have been set, select the Access events tab to define relays (or relay groups
if you are using KT‐400) that are to be activated on miscellaneous events.
NOTE: EntraPass offers you the ability to define a relay that will be activated if the Extended delay
feature is used. The card used must be defined with this feature. Only KT‐100, KT‐300, KT‐400 and KTES
can be configured with the Extended door access delay feature.
5 Select the relay that will be activated locally or the relay group (if you are using KT‐400) for each event.
6 Pager call type (applies to KTES only): You can select Do not call (the relay activation for that event will
not be sent to the pager), Call immediately (the relay activation for that event will be sent immediately
to the pager) or Call when scheduled (the relay activation for that event will be sent to the pager
according to the pager call schedule). See "If you are assigning or defining schedules, make sure that you
are selecting the proper category for this schedule. For example, if you are assigning or defining a system
schedule (for workstation, operators, event parameters, video triggers) this schedule will be available for
selecting components of this category. If you are selecting a schedule for physical components such as
controllers, doors, inputs, their schedules will be grouped by gateway if you are using a Global Gateway
and by site if you are using a Multi‐site Gateway by site if you are using a Multi‐site Gateway. If you have
defined two sites in your system, there will be two separate groups of schedules for each site. You can
define up to 99 schedules for each site." on page 186. Default value is Do not call.
NOTE: To specify pager call types for each events, the Pager reporting function must be enabled. See
"Defining the Pager Options" on page 86
Defining Door Options for Controllers and the KTES (Multi‐site Gateway Only)
The following tab only appears when KT‐100, KT‐300, KT‐400 controllers and the KTES have been
configured in a Multi‐site Gateway.
1 Select the Options and alarm system tab (or Options for a KTES).
• Supervised door lock device: This feature is used in specific applications such as bank vaults to
compensate for the slow motor locks. Adding this delay avoids false door forced open alarms if a
user is opening the door before it has been completely secured at the end of unlocking delay. Check
this option if you want to enable it in EntraPass. Default is unchecked.
• Motor lock delay (does not apply to KTES): Enter the time period (hh:mm:ss) after which the door
will be considered locked. Values range from 0s to 18 h:12 min:15 secs. The default value is 0:00 for
inactive. For example, if this delay is set to 5 seconds and unlocking delay is 20 seconds after access
granted; the lock output will d deactivate after 15 seconds and no door forced open alarm will be
generated if the door is opened during the last 5 seconds.
• If a second card read is required, select a schedule from the Second card schedule required (two‐
man rule) list (does not apply to KTES).
• Relay to follow lock output (Only available for KT‐400 and KTES): The relay follows the lock output
status.
• Enable duress function on keypad (KTES only): Set this parameter to enable the duress function on the
door controller keypad. A duress alarm is used by employees or tenants to signal for help. Duress
System Devices 97
function must be previously enabled to operate. Default is unchecked. See "Defining the Options
Parameters" on page 84 for more information.
NOTE: When KT‐100, KT‐300 and KT‐400 are installed in a Multi‐site Gateway, the system offers the
ability to interface an external alarm system.
8 Select the Input tab to define input devices that will be supervised or shunted (no supervision) when the
alarm system is armed. The input description column contains all the inputs that are defined in the
system.
• Using the checkboxes, select the appropriate input where you want an external alarm system to
supervise them. Also select the appropriate item for which you want to suspend supervision (on
entry, on exit, or when the alarm system is disarmed).
9 Select the Disarming request tab to select the Input to postpone arming.
10 Select the applicable schedule from the Enable postpone arming schedule.
11 You may check the Wait for access granted to postpone box. If this option is checked, the alarm system
will be postponed only after a valid card read and the cardholder will then press the selected Keypad
button to postpone the external alarm system.
12 Select the Postpone or disarm access level from the list.
13 Select the Relay tab to define a relay (Partition and Relays for the KT‐400 to define a group of relays) and
input status for the external alarm relays.
NOTE: When you select an Alarm relay, you may specify its Activation type. It may be activated
permanently or temporarily.
Relay Configuration
The output control relays provided on each KT‐100, KT‐200, KT‐300, KT‐400 and KTES can be used to
activate alarms or other devices such as lighting control, ventilation, and air conditioning. These relays
can be activated according to schedules, events reported by the system. They can also be activated to
indicate the status of an alarm system or a combination of different logic conditions.
Defining Relays
1 From the Devices definition tab, select the Relay icon.
2 Select the Gateway, the Site and the Controller from the displayed drop‐down lists, then select the relay
for which you want to define settings.
3 Specify the Operating mode for the relay:
• Normal: the relay is normally de‐energized (deactivated) until it is energized (activated) by an
operator, an event or any other system schedule.
• Reverse: the relay is normally energized (activated or resting) until it is de‐energized (deactivated) by
an operator, an event or any other system function.
4 Specify the Automatic activation schedule: when this schedule is valid, the relay will be triggered
(activated or deactivated) according to the specified activation mode.
5 Specify the Disable relay action: when this schedule is valid, the relay will be deactivated (or activated)
according to the predefined operating mode.
6 Set the Temporary activation timer to indicate the delay during which the relay will be temporarily
triggered following a temporary activation.
NOTE: When the timer is set to zero, the default activation delay is set to five seconds. Maximum time
allowed: 9:06:07 (9 hours, 6 minutes and 7 seconds). When you are using the KT‐400, the maximum
time allowed is 18:12:15 (18 hours, 12 minutes and 15 seconds).
System Devices 99
7 Select a Graphic and Video view associated with the relay, if applicable.
Input Configuration
Door controllers can monitor the state of input points such as: door contacts, interlocks, alarm points,
motion detectors, temperature sensors, any REX and other devices with dry contacts. KT‐100 monitors
the state of 4 input points, KT‐200 monitors the state of 16 input points, and KT‐300 monitors the state
of 8 on‐board input points, with a maximum capacity of 16.
• For KT‐200 only. Inputs are normally closed or normally open dry contacts connected in series with one
resistor. If the dry contact is connected in series with the green resistor, the input number will be odd. If
the dry contact is connected in series with the red resistor, the input number will be even.
• Inputs 1 (door contact) and 2 (request to exit device) are ideally reserved for Door 1 of the controller
whereas Input 9 (door contact) and 10 (request to exit device) are ideally reserved for Door 2 of the same
controller. The input that is used for the door contact or REX contact SHOULD NOT have a “monitoring”
schedule defined in the “Input Definition” menu.
• For KT‐100 Controllers. Input 1 is reserved for door contact while input 2 is reserved for a request to exit
device.
• For KT‐300 Controllers. Input 1 should be reserved for contact on door 1 while input 2 should be used for
request to exit device for door 1 of the controller. Input 3 should be reserved for contact on door 2 while
input 4 should be used for request to exit device for door 2 of the controller.
• For KT‐400 Controllers. Input 1 should be reserved for contact on door 1 while input 2 should be used for
request to exit device for door 1 (REX Door #1) of the controller. Input 5 should be reserved for contact
on door 2 while input 6 should be used for request to exit device for door 2 of the controller. Input 9
should be reserved for contact on door 3 while input 10 should be used for request to exit device for
door 3 of the controller. Input 13 should be reserved for contact on door 4 while input 6 should be used
for request to exit device for door 4 of the controller.
Defining Input
You may define inputs from the Input button of the Devices toolbar. You can also define inputs using the
Express Setup when defining a controller (see "Express Setup Program" on page 568).
1 From the Devices toolbar, select the Input icon.
2 Select a specific gateway (from the Gateway drop‐down list), a site (from the Site drop‐down list), a
controller (from the Controller drop‐down list).
3 From the Input drop‐down list, select the input you want to define.
4 Assign a Monitoring schedule to the selected input: this is the schedule during which the system will
supervise the condition of the input. When the schedule is valid, a change in input condition generates
either an “Input in alarm” or “Input restore” event.
NOTE: The input that is used for the door contact, REX contact or interlock contact SHOULD NOT have a
monitoring schedule.
5 Specify the Normal condition for the input: it may be Closed or Opened.
NOTE: When using single or double EOL resistors, set input Normal Condition to Closed.
100 System Devices
6 Specify the Notify abnormal condition for the input: it may be Alarm or Activate.
NOTE: When configuring event parameters with Input in alarm or Input activated as the selected
event, only the inputs corresponding to these criteria are displayed. See "Event Parameters Definition"
on page 423 for more information.
7 By default, EntraPass will not select the Suspend status update when not monitored. This is to keep data
traffic at a minimum. However, this option can be enabled if necessary.
8 Specify the Input response time. This delay corresponds to a period within which an input must remain in
the same state before a transition is recognized. This delay is expressed in minutes (mm:ss:cc). Values
range from 10 secs to 10 min:55 secs:35 cc for both the alarm response and alarm restore times.
• Alarm response time (mm:ss:cc): The delay before the system generates the input and alarm event.
Default is 50 cc.
• Restore response time (mm:ss:cc): The delay before the system generates the input restore events
(Multi‐site Gateways only). Default is 50 cc.
NOTE: Specifying the input response time allows bouncing time when the contact changes state, and
helps to generate only one event for each transition if this time is longer than the bouncing time. For
example, a 01:00:00 delay requires that a condition remains stable for at least one minute before it is
reported.
9 Specify the Telephone Entry System options (applies to KTES only).
NOTE: To access the modem call type feature, the site connection type must be set to Modem. For
more information, see "Sites Configuration" on page 61. The modem call type feature is supported by
Multi‐site Gateways only.
• Pager call type: You can select Do not call (the relay activation for that event will not be sent to the
pager), Call immediately (the relay activation for that event will be sent immediately to the pager) or
Call when scheduled (the relay activation for that event will be sent to the pager according to the
pager call schedule). See "If you are assigning or defining schedules, make sure that you are selecting
the proper category for this schedule. For example, if you are assigning or defining a system schedule
(for workstation, operators, event parameters, video triggers) this schedule will be available for
selecting components of this category. If you are selecting a schedule for physical components such
as controllers, doors, inputs, their schedules will be grouped by gateway if you are using a Global
Gateway and by site if you are using a Multi‐site Gateway by site if you are using a Multi‐site
Gateway. If you have defined two sites in your system, there will be two separate groups of
schedules for each site. You can define up to 99 schedules for each site." on page 186. Default value
is Do not call.
• Under modem call type, assign the call type option that best suits event reporting. Default value is
Do not call
• Input pager ID: Enter the pager code corresponding to the selected input. Possible values are 201,
202, 203 and 204.
NOTE: To specify pager call types for each events, the Pager reporting function must be enabled. See
"Defining the Pager Options" on page 86
System Devices 101
10 For KT‐400 and KTES only, check Override default EOL (56K), and then, in the drop‐down menu, select the
appropriate item. Default is unchecked.
11 Select a Graphic and Video view associated with the input, if applicable.
• Auto‐detection: The partition and zone labels are automatically detected from the panel.
NOTE: This feature depends on the type of intrusion panel. The device has to be first created in
EntraPass for the DLL to be downloaded into the corresponding gateway or KT‐400. Once downloaded,
the auto‐detection becomes active.
13 Define the Zone, Partition and User parameters.
• These parameters have the following maximum values:
Definitions
Schedules Definition
A schedule indicates when the system will execute certain operations such as automatically unlocking
doors, permitting access to employees, running automatic reports, monitoring inputs, etc. It also
determines when events are to be acknowledged or when to activate relays controlling different
functions (lighting, heat, etc.). You can use the same schedule in different menus, but it is recommended
to create a different schedule for each application, because it is much easier to modify a particular
schedule without affecting other applications.
Each schedule is composed of four intervals. Each interval has a starting and ending time. Each of these
intervals can be individually selected for the seven days of the week, and for 4 holidays. EntraPass gives
you the possibility of programming 99 schedules per gateway and an unlimited number of system
schedules. To do so, you must activate the Upgrade to advanced schedule capability option in the
System parameters dialog (Options toolbar > System parameters > Server).
NOTE: For more information, please See "System Parameters Configuration" on page 283.
EntraPass supports two groups of schedules:
• System schedules: System schedules for global functions such as event parameters, operators login
schedules and video triggers. These are not loaded in controllers.
• Corporate site schedules: These are defined per site. You can define 99 schedules per corporate site for
such purposes as: power supervision (controllers), unlock schedule (doors), Rex schedule (doors),
activation mode (relay), monitoring schedule (input).
If you are assigning or defining schedules, make sure that you are selecting the proper category for this
schedule. For example, if you are assigning or defining a system schedule (for workstation, operators,
event parameters, video triggers) this schedule will be available for selecting components of this
category. If you are selecting a schedule for physical components such as controllers, doors, inputs, their
schedules will be grouped by site if you are using a Multi‐site Gateway. If you have defined two sites in
your system, there will be two separate groups of schedules for each site. You can define up to 99
schedules for each site.
Defining a Schedule
1 From the EntraPass main window, click the Definition tab. Then click the Schedule button.
NOTE: If you have checked the Upgrade to advanced schedule capability option (System parameter >
Server > Schedule tab), the Gateway/Site drop‐down list appears for selection. From the Gateway/site
drop‐down list, select a Site or a System schedule (applicable to system components such as event
parameters, video triggers, operator login).
2 From the Schedule drop down list, select the schedule you want to modify or select the schedule
applicable to the category selected in previous step, or click the New icon to create a new one.
108 Definitions
3 Assign a name (or modify an existing one) to the schedule. It is recommended to choose a meaningful
name.
4 You can click the Holiday icon in the toolbar to view the list of holiday that are defined in the system.
2 Define a second interval for Tuesday from 00:00 to 08:00. The system considers these two intervals as
one continuous interval.
Extended Schedule
This feature (for EntraPass and WebStation 5.01) allows increasing the number of schedule intervals to
20.
NOTE: Schedules with 20 intervals in stand‐alone mode can be used with KT‐400 and KT‐400 V1
controllers only.
See "Schedule" on page 284 for more information.
Floors Definition
The Floor dialog is used to create or edit elevator floors. Once the floors are created, they are grouped
and associated with a schedule that will define when access is permitted.
1 In the Definition tab, click the Floor button.
2 In the Site drop‐down list, select the gateway/site for which you are defining floors. This allows you to
minimize the list of components defined in the system.
3 Select a floor or click the New icon to create a new floor group.
4 Assign a meaningful name to the floor, then click the Close button. The system prompts you to save.
Graphics Definition
A graphic corresponds to the secured area of the system where components (EntraPass applications,
controllers, inputs, relays, etc.) are located on a site. With graphics, operators can easily view the exact
location of a component installed on a site, or the status of components and devices such as doors,
contacts, motion detectors, controllers, panels assigned to the graphic. Operators can perform manual
operations directly from the displayed component (for example, locking/unlocking a door). Operators
can execute tasks with or without confirmation. You can create as many graphics as you need. Each
110 Definitions
graphic can display up to 250 components including using live video as a background. You may also
import graphics or maps from other programs in the following formats (BMP, EMF, WMF, JPEG, GIF, PCX,
PNG, TIF or PCD).
NOTE: EntraPass offers users four sample floor plans. You can customize them to suit your system
needs. The sample floor plans are located at: C:\Program
Files\Kantech\Server_CE\Generaldata\Demobmp folder.
• Select Add Web page as background to have a Web page as background. Enter the URL address of
the site and press Enter on the keyboard, or click Test. The Login and Password are not required
unless the Web page you want to access requires it. Click Test to see that the page is loading
properly. Then, click Save.‘
• Select Clear background in order to clear the background picture of the graphic only leaving the
assigned components. You can use this option when you want to insert a new graphic and leave the
same components.
112 Definitions
2 Once you have positioned the component, and released the mouse button, the Assign From dialog will
pop up on the screen.
3 Select the system component you want to assign to the icon on the screen.
4 Click OK to go back to the previous window.
NOTE: If you do not assign the icon to a component, the icon will not be saved in the graphic. Only
components that were not selected in the graphic will be available for selection.
• Click on the Preview button to display a general view of the printing layout.
Holiday Definition
1 A holiday is treated differently than other days. It is recommended to program holidays at the
beginning of the year; this helps to modify floating holidays for the current year (Easter,
Thanksgiving, etc.). A holiday may be identified by a specific type (Hol 1, 2, 3, 4). The same day may
be defined as a holiday at one site, but as a regular day in another site. From the Definition tab,
select the Holiday button. The Holiday window appears.
2 To create a new holiday, select the New icon.
3 To create a global holiday, proceed with the holiday definition. If you want to define a holiday for a
specific gateway/site, select the gateway/site from the drop‐down list.
4 Assign a name to the holiday.
5 From the Date pull‐down menu, select a the holiday date from the calendar.
6 Check the Recurring option if this is the case for the holiday you are defining.
NOTE: If the holiday is not a recurring holiday, you will have to reprogram it for the following year. You
can program holidays years in advance; but it is recommended to review holidays on a yearly basis.
Definitions 115
7 In the Holiday type section, select the type of the holiday you are defining. This gives you flexibility when
defining a holiday. For example, you may decide that a given day is a holiday for a certain group of users,
but it is a regular day for another group.
8 Click on the + Holiday list button to display a calendar for the next 12 months showing holidays in one of
the three colors identified in the legend.
NOTE: The legend is different from the one used to define schedules. See "Schedules Definition" on
page 107 for more information.
The Task Builder menu allows you to create SmartLink tasks. When you have a SmartLink application
installed, the Task insertion menu for SmartLink button is enabled. It allows operators to send built‐in
task commands to the SmartLink.
NOTE: A new command has been added to SmartLink (BATCHMODIFY) allowing batch modifications to
a group of cards. It is now possible to change parameters for a group of cards of the same type. Only
the data fields indicated in the command will be modified. For more information on task commands,
refer to your SmartLink Reference Manual DN1327.
116 Definitions
1 Click on the Task insertion menu for SmartLink button and a menu will be displayed, or
use the icons corresponding to the most common insertions.
NOTE: When creating SmartLink tasks, only commands that are written in the primary language are
considered as valid commands. For more information on task commands, refer to your SmartLink
Reference Manual, DN1327.
The following table describes the options you will find in the menu.
Parameter Description
Date Insert a date in the task. Options are: Year, Month, Day, YYYY/MM/
DD or MM/DD/YYYY
Time Insert a time in the task. Options are: Hour, Minute, Second,
HH:MM:SS or HH:MM.
Event Insert event description in the task. You can select to display event
name Text or Number.
Location Insert the location where the task must take place. Options are:
EntraPass Application, Gateway or Site.
Information #1 to 4 Insert event information. Options in the database are: Index
Number, Index Text, Component ID and Component Text.
User Information Insert card information in the task. Options are: Card Number, Card
User Name, Card Information #1 to #10 or Comment.
Numerical Value Insert a number in the task.
Character String Insert a string of characters (free text) in the task.
Definitions 117
Parameter Description
Add Delay Insert a delay in 1/10 secs in the task.
Carriage Return Insert a carriage return in the task.
Trim Right Will delete the last character to the right of the task.
Email To insert and email in the task that will be sent automatically when
the event occurs.
Modem To insert a message in the task that will be sent automatically
through a pager when the event occurs.
Serial Device for Messages Select the Serial Com Port and Baud rate to send the message.
Serial Device for Select the Serial Com Port and Baud rate to send the command.
Commands
File File opens the Select a filename dialog that allows you to locate a
file (or create a new one) where all event information entered in
the task will be logged when an event occurs.
Close will close the file.
Commit to disk will save the file to disk. This command will not
close the file.
Execute File opens the Select a filename dialog that allows you to locate the
executable that will be used with the task command.
Parameters open the Enter Character Strings dialog allowing you to
type a string of characters that will be added to the task command.
Action allows you to define how you want to launch the task
(Launch Hidden, Launch Normal, Launch Minimized, Launch
Maximized or Terminate process).
Network Insert a Network Tag.
Command Insert a Command Tag.
Modify Language You can modify the command language to English or French.
Save SmartLink Mode Insert in the SmartLink command to interrupt and place current
SmartLink mode in the background (for example sending and
email). This command must always be used with Restore Previous
SmartLink Mode.
Restore Previous Insert in the SmartLink command to restore the previous SmartLink
SmartLink Mode mode. This command must always be used with Save SmartLink
Mode.
118 Definitions
8 Click OK to attach the email to the SmartLink task. The message will appear in the window.
Inserting a File
1 Click the File (Open) icon. The Select a file name dialog will display on screen.
2 Enter the file name or browse to find the file.
3 Click OK.
Executing a File
1 Click the Execute (File) icon. The Select a file name dialog will display on screen.
2 Enter the file name or browse to find the file.
3 Click OK.
Executing Parameters
1 Click the Execute (Parameters) icon. The Enter character string dialog will display on screen.
Entering Commands
1 Click the Command icon. The SmartLink Task Builder dialog will display on screen.
2 Select a component type from the Component type list.
3 Select a command from the Command list.
NOTE: The toggle command is only available with specific component types such as Door, Input and
Relay.
4 Select a variable from the Variables list. There are three categories of variable that can be linked to a
component type and a command.
• Message Value
• Trigger
• Card Information 1 to 10
6 Select Trigger variable #1 from the Variable list. The task displays at the bottom of the dialog. Click OK.
6 Select User Information 1 from the Variable list. The task displays at the bottom of the dialog. Click OK.
Video Integration
The Video Toolbar
EntraPass offers real‐time monitoring capability as a response to the growing importance of video in
access control systems. The Video feature allows operators to define Video parameters and use video
features from EntraPass user interfaces.
• Video servers for use in EntraPass (identifying the video source and specifying cameras connected to it)
• Video views for Video monitoring using EntraPass desktops
• Video recording triggers
• Recording parameters
• Video event list
• Playback
• Current recording
• Exported video
• EntraPass Video Vault, etc.
NOTE: Installing and using the video feature may take a great amount of your company network
bandwidth (LAN or WAN). The network administrator may control the use of the network bandwidth
for video data transfer.
126 Video Integration
The following diagram shows how the video feature is integrated in EntraPass. The EntraPass Video Vault
utility can be installed on the same computer as any other EntraPass application or on a dedicated
computer.
NOTE: The current version of the software integrates with American Dynamics Intellex and HDVR.
EntraPass supports HDVR‐2U, HDVR‐4U, all versions of Intellex: DVMS8000 (Up to 8 cameras) and
DVMS16000 (Up to 16 cameras), Intellex IP (up to 16 network video streams), Intellex Ultra (16
channels) and Intellex LT. This later version limits the number of cameras to 4, 8 or 16 depending on
the selected Intellex LT (LT‐4, LT‐8 or LT‐16). EntraPass also supports the following models:
• AD‐TVR‐04: AD TVR 04 video channels (models ADTVR04050 and ADTVR04100).
• AD‐TVR‐08: AD TVR 08 video channels (models ADTVR08100 and ADTVR08200).
• AD‐TVR‐16: AD TVR 16 video channels (models ADTVR16050, ADTVR16100, ADTVR16200 and
ADTVR16400).
• AD‐TVR‐VS: AD TVR‐VS 4 video inputs.
• AD‐NVR: Allows users viewing, managing and controlling the video being recorded on the AD‐NVR
through the EntraPass software:
• Can support up to 128 IP cameras
• Up to 400 Mb/sec image streaming
• Base model includes minimal video analytic and can be upgraded to a full analytic package
• One pre‐configured video playback button
• Connect to EntraPass through an IP connection. No other interface needed.
128 Video Integration
4 Check the On‐line option to tell EntraPass that the video server is on‐line.
NOTE: The On‐line option must be unchecked when the server is off‐line for long periods such as
maintenance reasons, for example. Otherwise, EntraPass will continue polling the video server; this
may cause the system to hang.
5 In the IP address field, specify the static IP address of the Video server. Make sure that the Video server
is set to a static IP address. For specific information about the video server IP address, contact your
network administrator.
6 Domain name: Video server domain address.
7 Specify the port information for Video (Intellex only), Communication (Intellex, HDVR and TVR II) and
Event (Intellex only). Make sure that these are the same used by the DVR (Digital Video Recorder).
NOTE: The TCP port (Transmission Control Protocol) is used by the V ideo application to communicate
with EntraPass. Options displayed in the TCP port section depend on the device you are configuring.
For details about ports and their settings, contact your network administrator or the documentation
provided with the Digital Video Recorder (DVR) vendor.
8 Check the Bypass Ping for identification (Intellex only) option if you want to save on bandwidth
utilization. In fact if this option is not checked, the workstation will continually poll for server
identification.
Video Integration 129
9 Check the Specify video server login (Intellex only) option if you want users to enter their credentials
before accessing the Video server. If this option is checked the Login tab appears in the Video Server
window.
10 Check the Bypass DVR Messages option if you want to cancel all the messages coming from Intellex.
11 In the Video server parameters section:
• Enter the Number of cameras. The number of cameras connected to the video server (or use the up/
down arrows) or click the Import camera details button to get this information from the video server.
Using the Import camera details button offers a fast way to define cameras connected to the video
server. In fact, when you click this button, EntraPass will connect to the Video server and get the
number and default names for cameras connected to the DVR.
• Specify the Polling frequency (mm:ss). The polling frequency refers to the delay between two polls
from the Kantech Server to the Video Server. This operation is processed by the Kantech Video
Server Interface.
• Specify Polls before Communication failure. This refers to the number of unsuccessful polls before
the EntraPass Server declares the video server offline. For example, if you enter 4 in this field,
EntraPass will attempt to connect four times to the video server before it declares that the server is
down.
• Indicate the Time zone adjustment. Using the up/down arrows, specify the Time zone adjustment if
the EntraPass server and the DVR server are not in the same time zone. The time zone adjustment
refers to the time zone difference between the DVR server and the EntraPass server. Adjusting the
time zone enables workstations to retrieve events generated by the DVR server at the EntraPass
Server’s time.
• Check the Time for clock synchronization (Intellex only) box. The Time synchronization refers to the
time of the day when the video server will synchronize with the Kantech server for date and time.
This operation is processed by the Kantech Video Server Interface.
NOTE: The EntraPass server serves as the reference time source. The video server will process the time
according to the EntraPass Server’s time. For example, if the EntraPass Server’s time is 3:00 and that
of the video server is 2:00, the T imezone adjustment data will be ‐1 so that the video server can
display the correct information about an event that occurred at a specific time.
Once the Remote video connection option is registered, new parameters can be configured in the Video server
window.
• IP address
• Domain name (from which the RemoteVideoProcess.exe will be executed)
• Communication port (port opened by the RemoteVideoProcess.exe application to monitor incoming
requests from the EntraPass server)
NOTE: The RemoteVideoProcess.exe is not accessible from the redundant server
NOTE: The Video Viewer option, accessible from the EntraPass installation process, must be used for
the RemoteV ideoProcess function to work.
NOTE: Installation of the Remote Video Connection will add 128 new video servers.
• Transfer interval (hh:mm): the interval specified in this field indicates the period during which videos
segments are retrieved from the video server. This feature restricts data retrieval and the availability
of the video server during a specified period of time.
NOTE: The server allows one video retrieval at a time. If, for instance, the specified period is 02:00 ‐‐>
04:00, video segments will be retrieved for two hours per day. If the specified period is 18:00 ‐‐> 06:00,
this indicates an interval of twelve hours starting from 6:00 PM to 6:00 AM.
• Notify on transfer failure (days): this number indicates the number of days allocated for the video
retrieval. If a video segment was not retrieved after the number of days specified in this field, the
video segment will be considered unrecoverable for archiving and EntraPass Video Vault will notify
the operator of the failure.
• File language: This option is applicable to KVI and KVA formats only. Users can choose between
English and French as the language that will be used to describe the archived data.
• Video file format: select the format for the video file that will be retrieved:
• Video Vault default: this is the format defined for the selected EntraPass Video Vault (Devices >
EntraPass Applications > (Select Video Vault application) > Video Vault Process tab).
• KVI (Kantech Intellex Video) Format: The KVI file contains thumbnail and video context
information and places a watermark on embedded .img. It must be viewed with the Intellex Video
Player that uses the American Dynamics API. You must make sure that the API has been installed
on the client’s computer.
• KVA (Kantech Video AVI) Format: The KVA file contains thumbnail and video context information
with no watermark on the embedded .AVI. Video files can be viewed using Windows Media
Player or any other AVI player on the market.
• AVI (Audio Video Interlaced) Format: This is the standard AVI format, with no watermark. Video
files can be viewed using Windows Media Player or any other AVI player on the market.
• IMG Intellex Format: This format places a watermark on the video. It must be viewed with the
Intellex Video Player using the American Dynamics API. You must make sure that the API has been
installed on the client‘s computer.
• PS Format: HDVR native compressed video format. Use eplayer to play.
4 For increased security, check the Use a password for KVI and KVA file formats option if you want to
protect the KVI and KVA archived video segments by a password. Make sure to enter identical
information in the Password and Password confirmation fields. Before viewing video segments archived
on the EntraPass Video Vault being defined, operators will have to enter this password. Archived video
files can be viewed from the Browse Video Vault window.
Camera Definition
EntraPass offers you the ability to assign names to cameras, presets, and patterns for easy identification
in the Video desktop and in all system video events.
The definition of a camera includes identifying its:
• Types (fixed or dome)
• Presets (for dome cameras)
• Patterns (for dome cameras)
132 Video Integration
The camera name is displayed when viewing live or recorded video events (Intellex only). The default
names are Camera1 through Camera n (where n is the last camera number).
Defining a Camera
1 From the Video window toolbar, click the Camera button. The Camera window appears.
2 Select the camera you want to define, then assign it a descriptive name in the enabled language fields. It
is recommended to assign a name both in the primary and secondary languages if the system is running
in two languages.
3 Select the Camera type from the drop‐down list.
• Fixed camera: no preset/pattern; operators cannot control a fixed camera.
• Dome: preset and pattern (Intellex only) available; selecting this option allows operators to control
the camera. If you select this option, assign descriptive names to the camera presets.
4 Check the Show camera option for the camera to be accessible for selection and display in the Video
view desktop. It is important to check this option if you want the camera to be enabled in EntraPass. Only
operators with appropriate permission will be able to view a camera with the Show camera option not
checked (Hidden/covert cameras). To assign permission to an operator: System > Operator definition >
Privileges.
NOTE: If you leave the Show camera box unchecked, the camera will not appear in the V ideo view
component window (Video view > Modify video view components) and will not therefore be assigned in
the V ideo desktop for view. This feature allows to hide a camera from all view. Operators who do not
have appropriate permission will not be able to view, search, export or carry any other operation on a
camera for which they do not have access permission. However, all links and references to this camera
will be kept. This feature is different from deleting a camera since links to a deleted camera are
deleted as well.
5 Check the Select specific events option if you want this camera to record specific events. By default all
camera events are displayed in the Video Events List. However, you can decide which events will be
recorded by a specific camera by checking this option. When you do this, the Event tab appears. You can
then select it and specific events will be recorded by the camera being defined. If this option is checked,
you have to select events that will be recorded by this camera.
6 Using the Up/down controls, adjust the number of presets and patterns for the selected camera if the
selected camera is a dome. When you do this, the Preset or Pattern tabs appear in the Camera window.
7 Select the view type you want to display when an alarm occurs.
• Video View: The video view selected will be displayed when an alarm occurs on this camera.
• Graphic View: The graphic view selected will be displayed when an alarm occurs on this camera.
• The Camera icon in the Camera window toolbar allows you to add custom icons to the list of
available icons. The list of icons is displayed when you click the Camera icon in the toolbar.
• Camera motion alarm: the camera will send to the EntraPass server all video segment events
related to any movement that occurred in the target area.
• Camera override (Intellex only):
• Camera perimeter (Intellex only): the camera will send all video segment events related to an
object, that has crossed into or out of the target area, to the EntraPass server.
• Camera text alarm (Intellex only):
4 Select the Video Vault Comment tab if you want to add information regarding the camera being defined.
KVI and KVA file formats from this camera that will be saved in EntraPass Video Vault will be displayed
with the comment entered in this window.
5 Enter the comment you want to associate with the camera being defined, then save and close the
window.
EntraPass Devices (workstations, gateways, sites, controllers, etc.) can be associated with video views.
Later, the video view can be selected in the components definition in order to display the component in
the video view.
6 Check the Re‐initialize video view delay (mm:ss) option if you want the system to refresh the displayed
image. If you check this box, the displayed image will be automatically updated when the specified delay
is elapsed. This feature is very useful if the defined camera view includes patterns or presets.
7 From the Video control section, make the appropriate choices:
• Show overlay Intellex and HDVR only): check this option if you want the camera identification
(camera name and server) to appear in the Video desktop.
• Show camera control: check this option for use with dome cameras. Selecting this option allows
operators to control a dome camera. It is not available with fixed cameras.
• Show metrics (Intellex only): this option enables the system to display the number of frames per
second (Fps) and the number of bits per seconds (Bps) for the selected camera. The information
appears in the upper section of the Video window (and in the Video desktop).
• Auto‐hide text (Intellex only): if this option is checked, the system will not display the information
related to a camera.
• Enable image zoom (Intellex only): check this option if you want to display the zoom value for the
selected camera.
8 Check the Enable video pattern box to alternate video images in the Video window. If you have defined a
2X2 view, then the video pattern will be composed of four images alternating in the video display
136 Video Integration
according to the delay specified in the Camera display delay field. If you do not check this option, the
video view will display all the cameras simultaneously.
NOTE: The Enable video pattern section is enabled once components have been assigned to the video
view.
9 Check Delay before launching sequence (m:ss) box to specify the transition delay before the images start
alternating in the Video window.
10 Specify the display delays for Cameras, Presets, Patterns and Graphics.
NOTE: These delays indicate the time interval during which a video or graphic appears in the V ideo
display before it is replaced by another. Refer to the following table for the minimum/default delays.
The maximum delay is 9:59 seconds.
11 Select the Details tab to view data about the selected view: video servers, cameras, and when
applicable, camera presets and patterns.
4 Click the Test button to view the result of the selection. The displayed Video view appears in the Video
desktop for video monitoring and surveillance (Desktops > Desktop dedicated to video monitoring).
NOTE: To delete a camera from a cell, right‐click it, then select Delete from the shortcut menu.
5 Click the Close button (bottom left or the “X” top right) to close the Video test window.
Video Triggers
Video triggers are system events that start or stop recording. Any event related to the selected
component type can trigger recording including exception events originating from a video server. A
source component must be specified for each type of triggering event. For example, the “door”
component must be specified for the “Door forced” event message. There is no limit to the number of
definable video triggers.
1 From the Video toolbar, select the Video trigger button. The Video trigger window appears.
2 Click the new icon (or select an existing trigger if you want to modify one). Assign a descriptive name to
the trigger.
NOTE: An alert message appears when you attempt to save before selecting the component type as
well as the component for the trigger being defined.
3 From the Component type drop‐down list, select the component that will trigger the recording event. It
may be a door controller, for example.
4 As a trigger source you can select Single, group or All components from the component radio buttons.
5 Use the three‐dots button to select a component.
6 From the Trigger schedule select a schedule for the trigger to be valid. If necessary, you can define a
specific schedule for this trigger (Definition > Schedule). If there is no schedule selected for a trigger, the
trigger will be disabled.
7 From the Event category selection, choose between the EntraPass or Intrusion groups of events from the
dropdown list.
NOTE: This field is available only when an intrusion panel has been configured in the system.
8 Click on the Events tab and select events from the list.
Recording Parameters
The Recording Parameters menu enables users to define parameters that control video recording and to
associate recording parameters (such as video source, cameras, etc.) with a video trigger. For each
recording event, you must specify parameters such as the video server source, the camera, etc.
A recording can be stopped by a timer (maximum recording time) or by a trigger when a stop recording
trigger is used. A source component must be specified for each type of triggering event. For example,
the “door” component must be specified for the “Door forced” event message. The resulting action
(whether to start or stop recording) must also be specified.
EntraPass offers you the ability to associate multiple recording parameters with one trigger. In this case,
all recordings will be associated with the single event and it will be possible to save all record segments
as a single event recording.
5 Select the Options tab to filter video segments according to their duration.
6 Check the Video segment duration limit option, then enter the duration in the Greater than (mm:ss) and
Smaller than (mm:ss) fields. The value entered is in minutes and seconds. This feature allows you to
target video segments meeting specific duration criteria.
7 Select the Archive State tab to filter events according to the archive status.
8 Check the Archive State option if you want to specify which events will be included in the filter. If you
want to include all events, leave these options unchecked.
9 Click OK to go back to the Video event list window.
NOTE: The Play and Copy from Video Vault buttons are enabled when the selected video event has been
archived on EntraPass V ideo Vault. Archived events are identified by a green flag.
10 Do one of the following using the buttons described bellow:
• Click the Play button to view this video segment of the selected camera for the duration of the
recording. The video appears also in the Video desktop (Desktop menu)
• Click the Export button to export it for future use. For details, see "Exporting Video Files" on page
144.
4 Click Save to close the Enter filename window. When you do this, the Description and password window
appear.
Video Playback
The Video Playback feature offers the ability to view recorded video of up to 16 cameras simultaneously.
To do so, you have to specify the period of time for the playback. A maximum of one hour is allowed:
• Select cameras in the left‐hand pane
• Drag and drop them into the View playback area.
Current Recording
The Current recording feature allows users to view the list of all on‐going recordings. The information
displayed depends on the source of the recording request:
• Started by a video trigger
• Started by an operator
• Started by an alarm on the video server
Initiated by Information
Video server alarm • Initiated by
• Event name
• Start date and time
Video trigger • Initiated by
• Video trigger
• Recording parameter
• Event
• Start date and time
• Remaining time for the recording
Operator • Initiated by
• Workstation
• Operator name
• Start date and time
• Remaining time for the recording
Video Integration 147
Video Desktop
The Video Desktop allows operators to display and monitor, in real‐time, video cameras configured and
connected to the network.
Buttons Description
Use these buttons to select a size for the displayed video.
Note: A bigger image requires more process power. Therefore, selecting a big‐
ger image may result in lower process power.
These buttons are configured in the Operator security level. They enable opera‐
tors to perform pre programmed tasks such as viewing video playback with a
fixed or variable delay, generating video events with fixed or custom parame‐
ters. For details on programing this buttons, see "Security Level Definition" on
page 218.
Use these buttons to Create and Edit video views.
Use this Show view selector button to display a mosaic view of all the cameras,
or one of the cameras defined in the system.
Help and Close buttons. These are EntraPass standard buttons.
4 Click the Show view selector button to display the View selector window. This small window allows you
to so select a specific view or to monitor a specific camera pattern. For instance, if you select a cell in the
View selector, the sequence is interrupted to display the selected cell.
NOTE: When you open the V ideo view selector while a camera is recording, the camera icon will blink
until the end of the recording.
148 Video Integration
5 From the displayed view, you can click a dome camera icon to display control buttons for this camera
(movement, zoom, focus). Available options depend on the Digital Video Management system connected
to your system. Please refer to your DVMS documentation for additional information.
NOTE: If your dome camera is set with pre programmed movement patterns, you can define a view
displaying a pattern composed of one or many of these patterns. For more details, see "V ideo V iews
Definition" on page 134.
Operations
The Operation Toolbar
Under the Operation toolbar, operators will be able to perform manual operations on various system
components (gateway, site, controllers, third party hardware, etc.) such as manually resetting or
monitoring devices, disabling readers, etc. Manual operations are used to override schedules or process
special requests, when necessary. When you launch a manual operation on a component, it is possible
to view the status of the selected components in real‐time. You can also edit components by accessing
the component directly from the operation window.
Icon Description
Select All is used to select all the items or components displayed in the
list.
Unselect All is used to unselect all the items or components that were
previously selected in the list.
Enable Graphic displays the image related to the selected component
(i.e.: door) and will also display the associated components (i.e.: reader).
To display in real‐time, this button must be used with the Enable anima‐
tion button.
Enable Animation will automatically enable the Enable graphic button.
This will activate the current component (i.e.: door) and will display its
status in real‐time.
Help will open the On line help corresponding to the window you are
currently navigating.
NOTE: A hint is displayed when you move your cursor over a button. It gives details about the
operation to be performed.
• Edit: Opens the window corresponding to the selected component to allow editing.
• Extended selection box: Opens the Extended selection box dialog that allows you to search for a specific
component.
Parameter Description
Gateway status Indicates if the gateway is connected or not.
Number of sites Indicates the number of sites for this gateway.
Number of cards Indicates the number of cards processed by this controller
Number of processes Indicates the number of processes
Version Indicates the software and hardware version number.
Local Time Indicates the controller’s current local time.
Last startup Date the last system startup was performed.
NOTE: The information displayed in the status window corresponds to your configuration and will be
different whether you access it from a gateway or a site operations window.
Operations 151
Icon Definition
Hard reset: will delete the existing gateway database and reload it with
new information.
Reset commands should be executed with caution. Before you carry out a
gateway reset operation, we recommend you contact our Technical Support.
For more information, see "Technical Support" on page 6.
Reload: will delete the content of the gateway database, restart the gateway
and reload the data from the system database.
Broadcast: will send a signal to the selected component manually.
NOTE: A hint is displayed when you move your cursor over a button. It gives details about the
operation to be performed.
Selecting a Gateway
1 From the EntraPass workstation main window, select the Operations tab and click the Gateway button to
open the Gateway dialog where all the gateways connected to your system will be listed.
NOTE: Please See "Sites and Gateways" on page 346 for a definition of the icons in the Gateway
window.
• When one or more controller(s) is malfunctioning (when it does not receive data for instance).
After a reload operation, the gateway reorganizes the data received and communicates the new data to
all the sites and controllers.
NOTE: Communication with controllers is suspended during a reload operation.
1 Select the gateway for which you want to reload the data.
2 Click the Reload data button. Gateway data will be updated.
Icon Description
Connect to remote site: Click to connect to a remote site using a pre‐
configured dial‐up connection.
Disconnect remote site: Click to close the connection between this
EntraPass workstation and the remote site.
Force disconnect site: Force disconnect remote site immediately, even if
the system is reloading.
This option is only available in a Multi‐site Gateway.
Disable remaining time: Click to stay connected until clicked again. This
action disables preset connection remaining time. This action bypasses
any idle time.
Update remote site: After selecting site, click to connect and update
parameters.
Update all remote sites: Click to connect and update parameters on all
sites starting with the first site on the list.
Remove site from connect and wait list: Select a site then click to sus‐
pend connection after all sites had been set for update.
Reload IP Link firmware: will force a reload of the selected Kantech IP
Link firmware.
NOTE: For security reasons, the System Administrator may disable this
icon.
Broadcast IP Device: will send a signal to the selected Kantech IP Link
and also the KT‐400 IP Secure.
Operations 153
NOTE: A hint is displayed when you move your cursor over a button. It gives details about the
operation to be performed.
Multi‐site Gateways
Message Description
Site Communication OK All site controllers can communicate with the gate‐
way.
Site Communication Trouble At least one of the site controllers can’t communi‐
cate with the gateway.
Site Communication Failure Communication failed between the site control‐
lers and the gateway.
Site Communication Cannot be The gateway cannot open the communication
Opened port.
Icon Definition
Soft reset: Will not affect the controller database. This command sends
new information to a controller to update its physical components
(relays, inputs, doors and outputs)
Hard reset: Will erase the existing controller database and reload it with
new information in the controller database
Reset commands should be executed with caution. Before you carry out
a controller reset operation, we recommend you contact our Technical
Support. For more information, see "Technical Support" on page 6.
Reload: will reload the controller database; if for example a controller
database is not reloaded correctly due to an erratic operation
Icon Definition
Anti‐passback cards list: displays the number of cards per local area,
obtain a card list in local area controllers, move cards (when you have a
KT‐400 system) and allows you to get position a a card. This feature is
used only for Multi‐site Gateway.
NOTE: A hint is displayed when you move your cursor over a button. It gives details about the
operation to be performed.
Selecting a Controller
1 From the Operations window, select the Controller icon to open the Controller window where you will be
able to reset the controller.
2 From the Gateway/Site pane, select a gateway or site. Controllers attached to this gateway/site appear in
the right‐hand pane.
• From the Controller list, select the controller where the operations will take place. It has to be
highlighted. To perform the operation on a group of controllers, select Controller Group (lower right‐
hand pane).
NOTE: If only one site or gateway is defined in the system, the Site Controller or Gateway list pane will
not appear on the Controller window.
Resetting Cards In and Cards Out Counters or all Controller local areas
This option allows to reset to zero for the cards in and cards out counter.
1 In the Controller dialog, select desired controller or controller group.
2 Click the Forgive icon in the toolbar. Card holders will not be considered inside or outside until the next
use of their card at an entry or exit reader.
Resetting Cards In and Cards Out Counters or all Controller local areas
This option allows to reset to zero for the cards in and cards out counter.
1 In the Controller dialog, select desired controller or controller group.
2 Click the Forgive icon in the toolbar. Card holders will not be considered inside or outside until the next
use of their card at an entry or exit reader.
Operations 157
Icon Definition
Lock door or group of doors: will manually lock the selected door or
group of doors.
Unlock door or group of doors: The selected door or group of doors will
be manually unlocked and will remain unlock until the next valid change
of the unlocking schedule or an operator manually locks the door or
group of doors
Temporarily lock/unlock door or group of doors: Temporarily unlocks
a door or group of doors for a preset delay. Once the delay expires,
the door or group of doors re‐lock automatically.
Return to schedule: Will re‐apply the locking schedule for a door or a
group of doors.
Enable card reader: Will enable a previously disabled door reader.
Disable card reader: Will disable a door reader and user will not be able
to access that door, even if they have access rights.
Arm door (Multi‐site Gateway with KT‐400 only): Does a Request to arm
on the alarm panel.
Disarm door (Multi‐site Gateway with KT‐400 only): Does a Request to
disarm on the alarm panel.
NOTE: A hint is displayed when you move your cursor over a button. It gives details about the
operation to be performed.
There are various reasons why you would want to perform one of these operations; for example you may
need to “disable a reader” for a short period in order to deny access to the door, etc. This operation
allows an operator to lock a door that was previously unlocked by an operator or a schedule. When a
door is manually locked through the Operation menu, it remains locked until:
• The presentation of a valid card (will re‐lock after access), or
• The next valid change of the automatic unlocking schedule (for a door defined with an unlocking
schedule), or
• An operator manually unlocks the door.
158 Operations
• Only floors that have a valid schedule will be available for selection by the user (the elevator panel will
enable the buttons corresponding to the floors).
Icon Definition
Lock elevator floor or group of elevator floors: will manually lock the selected elevator
floor or group of elevator floors.
Unlock elevator floor or group of elevator floors: The selected elevator floor or group
of elevator floors will be manually unlocked and will remain unlock until the next valid
change of the unlocking schedule or an operator manually locks the elevator floor or
group of elevator floors.
Temporarily lock/unlock elevator floor or group of elevator floors: Temporarily
unlocks an elevator floor or group of elevator floors for a preset delay. Once the
delay expires, the elevator floor or group of elevator floors re‐lock automatically.
Return to schedule: Will re‐apply the locking schedule for a door or a group of doors.
Disable card reader: will disable a reader and users will not be able to access any eleva‐
tor floor, even if they have access rights.
Enable elevator floor: will enable a previously disabled elevator floor or floor group.
Disable elevator floor: will disable an elevator floor or floor group and users will not be
able to access that elevator floor or floor group, even if they have access rights.
NOTE: A hint is displayed when you move your cursor over a button. It gives details about the
operation to be performed.
Icon Definition
Deactivate relay: allows an operator to deactivate a relay which was pre‐
viously activated by an operator, event, schedule or input in alarm.
Activate relay: activate a relay which was previously deactivated by an
operator, event, schedule or input in alarm.
Temporarily activated relay: Temporarily activate a relay or group of
relays for a preset delay.
Return to schedule: Will re‐apply a schedule after a manual operation
was performed on a component.
NOTE: A hint is displayed when you move your cursor over a button. It gives details about the
operation to be performed.
Selecting Relays
1 From the Operation window, select the Relay icon.
2 Click the Enable animation icon to view a real‐time display of the relay status.
• The left‐hand pane displays the list of all Sites/Gateways. all Sites/Gateways. You may select All or
select one site/gateway.
• The individual relays associated with the site/gateway selected on the left are displayed in the top
right side of the pane. If you select All on the left, all relays in the system will be listed on the right.
You can select one, several or all relays.
Operations 163
• Relay groups associated to the site/gateway selected on the left are displayed at the bottom right
side of the pane. If you select All on the left, all relay groups in the system will be listed at the
bottom right. You can select one or several or all groups.
Icon Definition
Input normal: returns an input to its normal state as setup in the Device
menu.
Input continuous supervision: will monitor the selected input at all
times.
Input with no supervision will terminate the input monitoring, regard‐
less of its schedule, and will start monitoring with the next pre‐defined
schedule.
Input no supervision temporarily (Shunt): will stop input monitoring
for a pre‐set period of time.
NOTE: A hint is displayed when you move your cursor over a button. It gives details about the
operation to be performed.
Users
The Users Toolbar
The Users toolbar allows you to easily manage the EntraPass cardholder database. The Users toolbar
icons start the following tasks:
• Define and issue cards as well as perform card‐related tasks (find, modify or delete existing cards),
• Design and print badges using the integrated badging feature. Pictures and signatures can be imported
or, with the necessary devices, captured and incorporated into cards for printing badges,
• Define and manage card access groups,
• Define access levels,
• Define visitor card templates,
• Define card types,
• Define and issue day passes,
• Modify groups of cards with batch operations,
• Import or export CSV files,
The integrated badging function in EntraPass allows users to create and print badges. It is also possible
to import or, with the appropriate utilities, to capture and integrate images and signatures on the card
in order to print badges.
• Define and modify the Kantech Telephone Entry System (KTES) tenants list.
Cards Definition
Cards are defined by the following properties: card number, card user name, card type, access level and
status (valid, invalid, pending, lost/stolen or expired). If you have enabled the Use card multiple format
option in the Card format dialog (see "Defining a Card Display Format" on page 277), you will be able to
change the card format for each card individually from the Card dialog. This option allows more
flexibility in assigning user cards for sites equipped with different reader technologies. In other words,
when creating a new card for a user, the operator will be able to select a card format directly in the Card
dialog, according to the reader type used in the area where the user will be accessing the building. If you
have enabled the Enhanced user management feature in the System parameters dialog (see "Credentials
Parameters" on page 292), card definition will be slightly different. In this type of environment,
EntraPass allows for the creation of a user card with no number assigned to it. In both cases, cards will be
defined by: card user name, card type, card access level and status (valid, invalid, pending, lost/stolen).
Cards records can be searched, sorted and deleted.
2 Click the New icon (first icon) in the toolbar. The Card number field is enabled.
3 Enter the number printed on the card (Card number field), then press Enter. If it is a new card, the Card
user name field is initialized with “New user”. If the card already exists, the system displays information
about the card.
4 Enter the cardholder’s name in the Card user name field. You can enter up to 50 characters.
5 Check the Copy to visitor card checkbox. When this option is checked, card information fields are copied
to the Visitor template database (the card number is not copied). This feature enables you to archive
profiles that are retrieved should you issue a temporary card.
6 Click on the Card type box to access the Card type menu. Select the card type for the new card. The card
type is used to group cardholders; it is useful for modifying an existing card group and creating reports,
etc. For more information on how to create/modify card types, see "Card Type Definition" on page 191.
7 Click on the Card filter box to access the Card filter menu. Select the card filter for the new card. The card
filter is used to bring more flexibility to the operators in regards to the cards’ treatment rights. For more
information on how to create/modify card filters, see "Card Filter Definition" on page 64.
NOTE: From the Card type window, you can right‐click the Card type field and choose New to create a
new card type, choose Select to pick an existing card type or you can choose Edit to edit an existing
card type.
NOTE: The system automatically displays the Creation date, the Modification date and the Modification
count information on the upper right‐hand side of the Card dialog.
8 Fill out the Card Information 1 to 10 fields. These are user definable fields. They are used to store
additional information regarding the cardholder. For example, you could use Card Information 1 to store
the employee number; Card Information 2, Department where the employee works; Card Information 3,
employee address, etc. Later, card information fields will be used to index reports, customize cardholder
lists, etc.
NOTE: These information fields are editable labels. To rename an information field label, double‐click
it, then enter the appropriate name in the displayed fields. You can enter up to 50 characters.
9 Click the Save icon.
reports, etc. For more information on how to create/modify card types, see "Card Type Definition" on
page 191.
NOTE: In the Card type field, you can right‐click the Card type field and choose New to create a new
card type, choose Select to select an existing card type or you can choose Edit to edit an existing card
type.
5 Click on the Card number tab, double‐click on Card #1 if you want to change the label.
6 Enter the Card number.
• If EntraPass was previously configured for Multiple Card Format, you can modify the card format by
right‐clicking the Card number field, See "Defining a Card Display Format" on page 277 to enable the
multiple card formats and select a new default card format for Card #1 to Card #5. The default card
format is HH:DDDDD (Hexadecimal and decimal 24 bits).
NOTE: The Access Level will apply to the user which means all 5 cards.
• When the Multiple Card Format is enabled: A list of all card formats will be displayed when you
right‐click in the card number field.
• When a card format has been defined by the system administrator, the card format has a check mark
next to its description.
170 Users
7 As an option, you can assign the Card number immediately. If you are using the EntraPass WebStation,
you can leave the field empty and assign the card number at a later time.
8 If your access rights allow it, you can decide to Display card number or not, then the user card number in
reports and message lists in the EntraPass workstations.
NOTE: The system automatically displays the Creation date, the Modification date and the Modification
count information on the upper right‐hand side of the Card dialog.
9 Check the Use expiration date option and select the corresponding date.
10 Check the Trace option if you want to monitor the use of a particular card. Selecting this option will
cause the “Card traced” event to be generated each time this card is presented to a card reader. For
example, you can request and generate a report containing the “card traced” event in order to verify user
actions.
11 Check the Stolen/Lost option, if the card has been stolen or lost. The card will not be functional
anymore.
12 Repeat Steps 5 to 11 for Card #2 to Card #5, if applicable. The selections can be different for the 5 cards.
Card Handling
Editing a Card
• Enter the card number in the Card number field and press Enter. The system displays the card; you may
then modify the card as required.
• Browse the Card number field using the Up/down arrows and then select the card to be modified.
• Browse the Card user name field, using the Up/down arrows.
172 Users
Finding a Card
You can perform two types of card searches from the Card dialog toolbar:
Deleting a Card
The Delete feature allows an operator who has the proper access rights to remove a card from the
cardholder database. A card that has been deleted from the cardholder database must be re‐issued
again in order to use it again.
1 Locate the card you want to delete.
2 Click the Delete icon, then click Yes in the Warning message box.
NOTE: Although a deleted card is removed from the card database, it remains in the card history; all
events involving that card remain in the event messages database. An event report locating past
events that involved any deleted card can be performed.
4 Check the Wait for keypad option to force users to enter a PIN on keypad to access all doors, then in the
Editable PIN field enter the PIN that users will be required to enter.
5 Editable PIN number: The operator can enter the number of digits needed by the reader/keypad to grant
access (See "Defining a Card Display Format" on page 277 for more information).
NOTE: Selecting the Wait for keypad will delay access to a door for this card until the correct PIN has
been entered on a keypad. This only affects doors defined with both reader and keypad in the Door
Definition menu (Devices > Doors). The keypad schedule must also be valid for this door. For more
information on defining a door, see "Doors Configuration" on page 88.
6 From the Card state drop‐down list, assign a state to the selected card. By default, a card is valid. The
following s are available:
• Valid: the card is functional,
• Invalid: the card is NOT functional,
• Lost/Stolen: the card is NOT functional,
• Pending: the card is not yet functional.
• Expired: the card has reached its expiry date,
NOTE: You cannot force a card state to Pending by selecting this state from the Card state drop‐down
list. To do so, you have to change the Start date.
7 Check the Disable passback option if you want the card to override the passback option when defined.
NOTE: If your are issuing a card for a cardholder with disabilities, check the Extended door access delay
option. To enable this option in the system, you have to define appropriate delays in the Door
definition. This option is also available when defining visitor cards.
8 Allow multiple‐swipe (KT‐400 only): Enable the multi‐swipe action (See "Card Multi‐Swipe" on page 93
for more information).
3 From the Card count value scrolling list, set the maximum number you want this card to be used. You
may enter the number in the field or use the Up/down arrows.
NOTE: Once you set the Card count value, the Card count options field is automatically incremented each
time the cardholder uses the card. After a certain number of uses, you may check the Reset to zero field
if you want the counter to be reset to zero when the maximum value is reached.
Editing a Picture/Signature
1 Right click the image you want to edit.
NOTE: The Barcode area allows you to assign a barcode to a badge for identification purposes. Select any item
from the drop‐down list to be used as the value of the barcode. Select Custom to enable the Value field and type a
specific barcode value. If you do not enter a custom barcode value, the Card number is used as the default value.
2 From the shortcut menu, select Edit (picture or signature).
3 Adjust the features of the image using the displayed options. The Reset all option enables you to go back
to the original image:
• Auto contrast: this feature gives better contrast by intensifying lights and shadows: it makes the
darks darker and the lights lighter. In general, this auto contrast feature gives a good result when a
simple contrast adjustment is needed to improve an image’s contrast.
• Sharpen: this feature provides more definition to blurry images by applying sharpening only when an
edge is found.
• Brightness: this feature allows you to add light to the image by sliding towards the positive values.
• Reset all: this feature allows you to undo all the changes and to restore the original image.
4 Click OK to close the Picture editing window.
5 From the Badge layout pull‐down menu, select a layout to associate with the card you have defined To
define a badge layout, see "Badges Designing" on page 178.
Printing Badges
You may print badges, visitor cards and daypasses from a Card or from all Badge preview windows. The
software is set up to let you print one single or double‐sided badges.
178 Users
Before you print, you have to select a badge printer. It may be any network printer, or a specific badge
printer.
Badges Designing
EntraPass contains a badge layout editor which enables users to create, save, edit or delete badge
templates that are later selected and associated with cards for badge printing. You can create and edit
badge templates, add colored or graphic backgrounds, logos, text, barcodes, and place photo or
signature holders.
Users 179
3 To modify the template background color, right‐click anywhere in the work area. The Properties shortcut
menu appears.
4 Select Properties. The Background properties window appears.
5 Select the appropriate options for the template:
• No background (default setting)
• Use color as background: this option will allow you to apply a background color to all the designs.
• Use image as background. This option allows you to incorporate an image that will be displayed as a
watermark in all the badges.
• Orientation: allows you to select a landscape (horizontal) or portrait (vertical) display.
2 To modify an object property before you drop it, go to Options in the Badge design window, then choose
Show properties on drop. If you do this, the Properties window will open every time you drop an item in
the template work area.
NOTE: To enable last and first name selection in the Card fields menu of the Badge design window, go
to the Options menu, then choose System parameters, select the User name format tab, check Parse user
name checkbox, then select the name (first or last name) that will be used for sorting cardholders’
names. For more information see "User Name Format" on page 289.
3 From the shortcut menu, select the card information field you want to add to the template layout, then
click in the template work area to incorporate that field you have selected.
NOTE: When you add a photo to a badge design template, the photo that appears is only a placeholder.
It indicates where the cardholder’s photo will be displayed. When a badge is assigned to a card, the
appropriate cardholder’s photo is displayed.
4 You may check the Set as default option if you want these properties to apply to all image objects you
add in the badge template.
2 From the Properties window, you can define settings for the barcode that you want to incorporate in the
Badge design.
NOTE: If it is necessary to set Barcode encoding option to Code 39‐Modulo 43, set Field Checksum to
true.
To Add an Image
Background images can be imported from any directory. Scanned images, photos taken with a digital
camera and artwork created in any illustration design program can be incorporated into the badge
design.
1 From the Badge design window, select the Picture icon.
NOTE: The Badging feature supports most available image formats: BMP, JPG, EMF, WMF, GIF, PNG,
PCD, and TIF.
2 Drop the Picture icon in the template work area. The Image properties window appears.
3 Click the Select image from file button. The Open window appears, allowing you to select an image.
Users 185
4 Browse to the desired image, then click Open. The picture appears in the template area.
NOTE: When you import an image, you have to resize it to its original size as illustrated on the
following image.
5 Using the sizing handles, adjust the image to the desired size, then move it to the right‐hand position;
you can use the grid to align it properly. For more information, see "To Align Objects in the Template
Layout" on page 181.
6 Right click the image to modify its properties. For details, see "To Modify Picture Properties" on page 182.
To Place a Rectangle
1 From the Badge design window, select the rectangle tool (next to the Border tool), then click in the work
area.
• Red—Indicates that access to the selected door on the selected date and time is not allowed (not
authorized).
• Green—Indicates that access to the selected door on the selected date and time is allowed
(authorized).
Card Printing
Use the Print feature to print a specific range of all the cards that are stored in the database. You can
select various filters to customize the card list. You can preview your list so that you can modify or verify
the settings (fields) before printing. You can also use the Font button to set a different font and font size
for your report.
NOTE: Whatever your selections, the card user name and card number will always be displayed. By
default, only fields containing information will be printed. If no fields are selected, only cards
containing information will be printed. If you want to print empty fields, check the Print empty fields
option. If you want to print component references, check the Print component references option. If you
want to simply preview card reports there must be at least one printer installed on the computer.
1 From the Card dialog, click the Printer icon.
NOTE: By default, empty fields are not printed. To print empty fields, check the Print empty fields
option.
2 Select a sorting criteria from the Card Index drop‐down list. These are card information fields.
3 If you are printing a specific range, check the Specific range option. Select the field that will be used to
sort the card list. For example, if you select Card number, the cards in the list will be sorted according to
the card numbers in ascending order. This field can also be used to target a specific range of cards when
using the Lower/Upper boundaries fields.
• If you want to print a specific range, you have to specify a starting number in the Lower boundary
field. It has to be used with the Upper boundary field. You must use the “card index field”.
• If you have decided to print a specific range and if you have entered a Lower boundary value, enter
the last number or letter in the Upper boundary field. This field is used with the Lower boundary and
the Card Index field.
NOTE: Only cards that match ALL the selected filters will be printed. For example, if you specify six
filters, all the six criteria must be met. Cards that do not match all the six criteria will not be included
in the range.
4 Select the Filter option if you do not want the system to search through all the cards of the system.
Filters will restrict the search and facilitate the production of the desired card list.
• Start date between—The system will include cards with a “Start date” field which is within the
specified range (Miscellaneous tab).
• End date between—The system will include cards with a “Use end date” field which is within the
specified range (Miscellaneous tab).
• Card —Check the option and then select the desired state. The system will include cards that have
this card state selected in the Card window (Miscellaneous tab).
188 Users
• Card type—Check the option and then select the desired card type. The system will include cards
that have this card type selected in the Card window.
• Select the Exist trace for the system to include cards that have the “Card Trace” option in their
definition (Card window, Miscellaneous tab).
• Select the Exist comment option for the system to include cards that have information in the
Comment field in their definition (Card window, Comment tab).
• Select Exist PIN—The system will include cards that have a PIN.
• Select Exist delete when expired—The system will include cards that have information in the Delete
when expired field (Card window, Miscellaneous tab).
• Select Exist wait for keypad for the system to include cards that have information in the Wait for
keypad field (Card window, Miscellaneous tab).
5 You may also check the Print selected fields to include specific data. If you select this field, no other
fields below, the system will print the cards that match the filters you specified above with the card
number and user name only.
6 Click the Select door access filter button if you want to include cards associated to a door.
7 Select the Based on time option if you want to select cards according to the time or select Based on
schedule if you want to select cards according to a defined schedule.
NOTE: To extend the selection, right click within Select door for access filter window.
8 Check the appropriate field you want to print. The system will include the field content as it appears in
the card definition.
9 You may save the list as a .QRP file (Quick Report) to view later using the Quick Viewer option.
10 You can also use the “Font” button to use a different font and font size for your list. The changes will
appear automatically in the sample box. Use the Preview button from the print window to preview your
report.
• Copying the card information field into the Visitor card database when a new card or a daypass is created
in the system,
• Creating a new visitor card.
longer grant access. You can use profiles that were copied to the “Visitor definition” menu to create day
passes (use the “find visitor” button). You can also use an existing day pass to create a new one.
• Start date—If a start date is selected, the cards will be valid only from this start date. This new date
will be assigned to all cardholders having the selected card type.
• End date—If an end date is selected, the cards will be invalid after this end date. This new date will
be assigned to all cardholders having the selected card type.
• Delete when expired—If selected, the cards will be deleted when the end date specified in the Card
Definition menu is reached.
• Wait for keypad—If selected, all the cardholders of the specified card type will have to enter their
PIN at the keypad after a valid card read, in order to permit access to the door (if keypads are
defined).
• Card access group—If checked, two scroll lists become available to modify card access groups for the
selected Card type. The first scrolling list defines the action to perform on the selected card type.
The second scrolling list contains the card access groups (already defined in EntraPass) that will be
used to perform the action.
• Replace card access group (Replace): replaces the current access level with the one selected in
the scrolling list.
• Update card access group (Update): updates the current access level with the one selected in
the scrolling list except where sites were set to none in the current access level. No new access
levels will be added.
• Add new access level (Add): this option is used in situations when new sites are added and the
sites’ access levels must be added to the current access level list. All sites that are set to none in
the current access level list will be updated with the sites in the new access level list.
• Update add access level (Merge): merges the sites in both lists. The new sites have precedence
over the current ones.
Examples of batch operations on card access levels
Current Access Level New Access Level Replace Update Add Merge
Site Y1 Site X1 Site X1 Site X1 Site Y1 Site X1
• Card layout: If checked, the list of card layout templates will be listed.
• Card filter: Apply the selected card filter to all cardholders of the selected card type
6 Click the Execute button to start the process. The system will prompt you to accept the operation.
7 Click Yes if you want to continue. As soon as the process is initiated, a red indicator is displayed at the
bottom left of the dialog. The indicator will remain red until the end of the process.
194 Users
4 Specify the Add code and Modification code. These codes are used by the system to identify, when
importing a file, which card has to be modified or added to the card database. Default add code is “+”
and default modification code is “+”.
5 Select the Delete code. This code is used by the system to identify, when importing a file, which card has
to be removed from the card database. Default delete code is “‐”. Field separators can be: tab, space,
comma, semicolon (;) and other.
6 Select the Field separator. This code will be used to separate the selected fields when importing or
exporting data. Usually a comma (,) is selected. Keep this in mind when adding users’ last names and first
names separated by a commas.
7 Select the Date format. The date will be exported or imported according to the specified format. The
most commonly used format is YYYY/MM/DD. Other date formats are:
• MM/DD/YYYY
• DD/MM/YYYY
• YY/MM/DD
• MM/DD/YY
• DD/MM/YY
NOTE: The Use DLL feature allows you to enable a program that will convert specific card numbers. You
may use the Remove DLL when you do not wish to enable the program that converts card numbers.
8 Click OK to exist the pattern window and to specify the new pattern name.
9 Enter the pattern name, then click OK. The system automatically returns to the Export/Import CSV file
window. The pattern you have just created is displayed in the Available patterns list.
10 If you want to add or remove fields from your pattern, double‐click the new pattern to edit and make the
necessary modifications. Now you can import or export your information using the new pattern you have
just created.
Exporting Cards
Your organization may need to export the card database data into another application. You may use a
predefined template or create a custom template.
1 From the Users toolbar, select the Import/Export CSV File button. The system displays the Import /
Export CSV file window.
2 From the Select operation drop‐down list, select Export.
3 From the Available patterns list (left‐hand pane), select the pattern you want to use when exporting
cards. If necessary, you may edit the pattern so that it matches the target application pattern, else, you
may create a new one. (For more information on how to create a pattern, see "Creating a New Import/
Export Pattern" on page 194).
4 For the Transaction file, click on the three‐dot, then select the folder in which EntraPass will save the
card database content. You can open the CSV file in Excel, NotePad, etc.
5 Once you have selected/created an export folder, click OK to return to the Import / Export CSV file
window.
196 Users
6 Click the Export button; it is enabled once the transaction file is selected. The system displays a window
allowing you to filter the cards you want to export.
NOTE: For cards to be included in your file, they must match all the selected filters, if one or more
filters are not matched, the card will not be included.
7 In the Export Card’s filter window, specify the cards you want to export. Once you have made all your
selections, click the Export button. The Import / Export CSV file window appears.
NOTE: The Transaction file field shows the target file name and location. By default, the export file is
saved in the specified folder (Exportdata, in this example). The status bar (lower part of the window),
shows the number of imported cards (1, in this example). The default name is YYYYMMDD.csv. You can
open the target file with NotePad for instance.
Importing Cards
1 From the Users toolbar, select the Import/Export CSV File icon. The Import / Export CSV file dialog will
display on screen.
2 In the Select Operation drop‐down list, select Import.
3 Click the Available patterns button to select the pattern that will be used to import the cards information
(for more information on how to create a pattern, see "Creating a New Import/Export Pattern" on page
194).
4 For the Transaction file, click on the three‐dot, browse your hard drive to the CSV file that contains the
data to import into the card database.
5 Once the file has been selected, click Open. You will return to the Import / export CSV file window.
6 If no errors are present (or once you have corrected errors), click Import to complete the operation.
NOTE: The system scans the file to be imported; then it displays the results using a color code. Each
entry is identified by a color flag. A yellow or red flag identifies an entry in error. Errors are frequently
caused by the patterns. You have to select another pattern or edit the pattern you are using so that the
pattern entries have to match the source file entries. There may be errors also even if the transaction
code is identified by a green flag.
3 You may click the Error button to display information about the error. The Process error window shows
that the pattern used is invalid.
4 Click the Close button to go back to the Import Export window.
5 In the Import/Export CSV window, double‐click the pattern you have used for the Import transaction
(Custom, in the example above).
6 From the Field separator drop‐down list, select Comma as the field separator, then click OK. Data in the
Card number field indicates that the import transaction will be successful.
Tenants List
The tenant is a resident in an apartment building or an employee in a company. The tenant can grant
access to a visitor. Tenants list can be created in EntraPass to be used with the KTES.
• Second phone number: Enter a second phone number. The second phone number is used by the KTES
to contact the tenant when there is no answer to the first number (15 digits maximum). Default value is
empty.
• PIN: A Personal Identification Number (PIN) consists of a 4 to 6‐digits number configured for each
tenant. The number of digits available for a PIN has already been configured when the list was created.
Default value is 0000.
• Access schedule: Enter the access schedule. For security reasons, an Access Schedule should be
configured in order to link a schedule with the tenant access rights. A tenant can access the building
according to specific time, days and holidays defined in the system. Default value is Always valid. Refer
to see "Schedules Definition" on page 107 for more information on schedules definition.
• Tenant admin level: Select the administration level for the tenant (Installer, Owner, Maintenance or
Tenant). Default value is Tenant.
• Tenant language: Select the default language used by the KTES for the tenant (System, English,
French, Spanish, Custom). Default value is Default (for more information on the system language,
see "Kantech Telephone Entry System (KTES) Configuration" on page 80.
• Disabled Tenant: A Disabled Tenant status allows the activation of a relay and/or the generation of an
alarm. Default value is unselected (enabled).
• Trace: The trace option allows the activation of a relay and/or the generation of a traceability event.
Default value is unselected (not traced).
• Hide tenant: This option is used if you want the current tenant’s name to be displayed or hidden.
Default value is unselected (displayed).
• Extended door access delay: The extended delays correspond to the additional time lapse a door
should stay unlocked and could be kept opened (for instance, a handicapped person could need more
time to access to a building). Default value is unselected (no extended delay).
• Extended ring: The system can allow an extended number of rings in order to give more time for the
tenant to answer. Default value is unselected (no extended ring).
4 Select the Advanced options tab.
5 Set the Tenant validation date:
• Start date: The Start date is the date from which the tenant can access the system. Enter the date in
the field (mm/dd/yyyy) or click on the calendar button to select a date. Default value is empty.
• Use end date: The end date is the date at which the tenant cannot access the system anymore and its
status is no more valid. Select the checkbox to enable the end date. Default value is unselected (no
end date used). Enter the date in the field (mm/dd/yyyy) or click on the calendar button to select a
date. Default value is empty.
6 Set the Do not disturb option. This functionality is used to place the tenant in a “Do not Disturb” (DnD)
status if the selected schedule is active. You would check the Hide tenant check box if you would like the
tenant to remain hidden from the list or for search option while in the DnD status.
7 The Call second phone number option enables the use of a second phone number immediately
(bypassing the first number) when the schedule is active. If you would like to use the second phone
number only when the selected schedule is active, you would need to make sure the Call second phone
number only on schedule box is checked.
8 Set the Wiegand interface for access granted:
Users 199
• Tenant card number: A 64‐bit number associated to each tenant. This number is used by the tenant
to get access from the KTES.
• Card holder for access granted (not available in EntraPass KTES Edition): This card holder’s number
will be the first card number to be used by the tenant to get access from the KTES.
Step 4: Click the Next button and select the tenants to be imported.
Step 5: Click the Next button and then the Import button to complete the operation.
200 Users
Step 6: Click the Next button to see a summary of the imported data.
Step 1: Click the Export button to run the Tenant Export/Import Wizard.
Step 2: Click the Next button and choose the field to be exported from the list at left. Use the left and
right “hand” buttons to add or remove data fields. A different field separator can also be selected
(default is Comma).
Step 3: Click the Next button and select the tenants to be exported.
Step 4: Click the Next button and select a CSV format destination file. Click the Export button.
Users 201
Step 5: Click the Next button to see a summary of the exported data.
202 Users
Groups 203
Groups
The Groups Toolbar
The groups toolbar is useful to create groups so that operators can perform modifications on a group of
components or other system functions.
NOTE: Each system component has to be defined before it can be included in a group.
You can create:
• Controller groups
• Door groups
• Relay groups
• Input groups,
• Access level groups
• Floor groups
• Component Groups
3 From the Floor group drop‐down list, select an existing group if you want to modify it; or click the New
icon to create a new group. Then enter the name of the group in the language section.
4 From the list of defined floors that is displayed by the system, check the state column for the Floors you
want to include in the group. Only floors that have the state field selected will be enabled when:
• A manual unlock operation is done, or
• An “input” is programmed, for example, as a push button to enable floors for visitors (Devices >
Input definition menu > Elevator tab),
• Cardholders present their card to the card reader to enable floor selection when the controller is
operating in stand‐alone mode (due to communication failure). Only the floors marked with an “X”
are available for selection.
5 Only floors that have state selected will be enabled when:
• A manual unlocking operation is done, or
• An “input” is programmed, for example as a push button to enable floors for visitors (input definition
menu ‐ elevator tab),
• Cardholders present their card at the card reader to enable floor selection and the controller is
operating in “stand‐alone” (due to communication failure). Only the floors marked with an “X” will
be available for selection
System Status
The Status Toolbar
The Status toolbar allows system operators to view the status of various devices and components of the
access system:
• The Connection list button provides information regarding applications registered to the server (operator
name, local identification, etc.).
• The Text button allows operators to view, in text, the status of EntraPass applications, gateways, sites,
controllers (KT‐100, KT‐200, or KT‐300), doors, relays, inputs. The status displayed depends on the
controller installed.
• The Numerical button allows operators to view the statistical status of all components, by gateway. For
example, you can view the number of inputs in an alarm.
• The Graphic button allows operators to display the graphic status of a controller.
• The Database button provides information on the database structure. In addition, an operator can
perform configuration operations or manual commands from the database window.
• The Video Server button allows operators to display the statuses related to the EntraPass Video Vault
process.
Connection List
The Connection List displays details about a selected application, such as: operator name, last query
date, local identification number, etc. It is also used to verify if EntraPass applications are connected to
the server.
between computers. Local identification—Identifies the label of the application on the network. This
name is used by the server to identify your application.
• Network identification—Provides the IP address of the application on the network or NetBEUI name.
• Operator name—Displays the name of the operator currently logged on this application. The
operator name is used for many purposes, such as to identify who performed a modification to a
card, who acknowledged an alarm, etc. For information on modifying the operator name, see
"Operators Definition" on page 215.
• Last query date—Displays the time the application last polled the server. The server and application
exchange information on a regular basis.
• Connected date—Displays the date and time at which this application started its connection with the
server. This date will be used to generate an event and kept in archives.
• Transactions—Displays the number of requests performed by the application (number of exchanges
with the server), i.e. report queries, for example.
• Errors—Displays the amount of errors encountered by the application. This field will reset when the
application is shutdown.
• Messages/Alarms buffered (0/1)
• 0: the number of messages/alarms buffered for this application on the server when the
application is off‐line (not in communication). This number will reset to “0” when the
application connects to the server and messages are sent.
• 1: the number of messages/alarms that were sent to this application since the Server is
operational. If the Server is shutdown, this number will reset.
NOTE: The server holds a maximum of 100,000 messages and 100,000 alarms per workstation (default:
5,000) in the buffer. You can modify these settings through the Workstation Definition menu. You can
also specify if newer or older events should be buffered. Events will be buffered only when the
workstation is off‐line (not connected to the server); and when the fields “Apply operator parameters
for messages” and “Apply operator parameters for alarms” are not selected (for more information, see
"Application Configuration" on page 44).
Text Status
The Text status allows an operator to display the status of a selected component (and sub‐components)
as well as all the characteristics associated with this component in a text form. This menu option applies
to all the system devices: applications, gateways, sites, controllers, doors, relays and inputs. The text
window contains additional buttons/icons that assist operators in their tasks:
• The first seven buttons represent system devices (Workstation, Gateway, Site, Controller, Door, Input and
Output).
• Summary / Detailed list—The magnifying glass icon is used to display components that are not in normal
condition. It displays a summary list or a detailed list.
• Summary: shows the components that are not in normal condition
• Detail: shows all the components in any condition.
• Stop display—This button is used to stop the display when the information is taking too much time. It
cancels or interrupts the process.
• Refresh—Refreshes the status of the selected components.
System Status 209
• Print—Use this button to print the displayed status. You can preview your report before printing it.
Numerical Status
This menu allows an operator to view the number of components in a “not normal” state for a selected
gateway.
1 In the Status tab, select the Numerical status button. The Numerical window appears.
2 From the Gateway drop‐down list, select the gateway for which you want to display the status. The
window displays the number of cards for that gateway, the number of inputs in alarm, the number of
relays manually activated, the number of doors forced open, etc. This can be very useful if you need to
find out how many cards are defined.
Graphic Status
This feature is used to display a graphical status of a door controller, including the status of all its
components (outputs, inputs, power supply status, communication status, etc.) represented by colored
shapes (circle, square, etc.).
• An ellipse shape represents the controller
• A circle represents a door
• A square represents a relay
• A rectangle represents an input. Rectangles may be horizontal (KT‐200 and KT‐300) or vertical (KT‐100).
210 System Status
NOTE: The displayed graphic depends on the type of the controller selected.
System Status 211
3 To find out which items are represented by a colored shape, move the mouse over a colored shape. The
item highlighted on the right‐hand (in the list) identifies the component.
4 Select a controller from the Controller list drop‐down list (right side of the window), double‐click the
item on which status is required.
• Red—The component is “Supervised” and “in a trouble state”.
• Green—The component is “Supervised” and “in normal condition”.
• Yellow—The component is “Not Supervised” and “in a trouble state”.
• Gray—The component is “Not Supervised” and “in normal condition”.
• Blue—The relay is activated (by an event or an operator).
NOTE: If there’s more than one controller site per gateway, the numbers between parentheses (xx)
indicates the controller number and the following numbers (xx) indicate the component number.
Database Status
This window displays the status of the components within the database while browsing the database
structure. The system displays all applications (connected or not), the gateway, controller sites, etc.
You can also perform manual operations directly from the window and edit components in order to
modify their configuration.
1 From the Status window, select the Database icon. The Database window appears.
NOTE: The icon identifies the type of component.
212 System Status
2 In the Database window, select the application you want to view the database. The lower part of the
window displays the actual status of the selected component as well as its full name.
3 Select a component to modify its definition directly from the Database window. For example, if you have
selected a door, right‐click the door to display a shortcut menu.
4 Select a command in the cascading sub‐menu; select a menu option.
Server State
The Server state dialog allows users to view detailed information on the server such as system
information, system global memory, system process memory and system disk space.
214 System Status
System 215
System
The System Toolbar
Use the System toolbar to define parameters for systems operators, security levels, event parameters,
instructions, and message filters. This menu allows you also to view the EntraPass database structure.
You will define system parameters as follows:
• Operator: user name, login name, mandatory card type, password settings for EntraPass operators.
NOTE: Mandatory card type is an optional field. If that option is not selected, the operator will be
created regardless.
• Security level: use this menu to grant or deny access permission on system logical components (desktop
display, card fields, etc.) for an operator’s day to day operations.
• Workspace: use this menu to grant or deny operators access to view and configure the system physical
components (gateways, sites, relays, etc.).
• Event parameters: use this menu to define priority, color, schedule (display, printing schedule,
acknowledgement) as well as tasks for system events.
• Instruction: use this menu to create instructions for alarm messages.
• Message filter: Use this menu to direct event messages from a specific EntraPass application to another
EntraPass application and to define sort criteria for messages that are sent to the Filtered Message
desktop.
• Database structure: Use this menu to display EntraPass physical and logical components and to edit or
sort system components.
Operators Definition
Use the Operator menu to define system operators and to determine their security level and privileges.
An operator is responsible for issuing cards, carrying out manual operations on system components,
requesting reports, arming the system, etc. For security reasons, each operator accessing the system
database should have his/her profile defined to ensure that all the actions performed in the system will
be traceable. You need to create at least one operator account or modify the pre‐created accounts in
order for the operator to use and operate EntraPass and to receive event messages.
There are three default operators created in the system. These are associated with three levels of access
rights:
• Installer (login name and password are kantech): Full access to view, modify, delete, print components.
• Administrator (the login Kantech1 and the password kantech): Medium access with limited access to
system menus.
• Guard (login Kantech2 and password are kantech): Limited access to system menus.
NOTE: You can define operators using the default operators or you can create new operators. For
details about operators’ security levels, see "Security Level Definition" on page 218.
216 System
option is not checked, the system checks the video view settings for this operator: Operator >
Automatic video display checkbox.
NOTE: The Override workstation workspace message option is a privilege granted to operators. It allows
them to receive all events regardless of which workstation they are logged into at the time. If this
option is selected and the Apply operator parameters for messages and Apply operator parameters for
alarms options of the Workstation definition are also selected, then the basic configuration will be
ignored and events will be filtered according to the security level of the operator who is currently
logged into the workstation.
• If required, check Allow login to WebStation from the operator. The WebStation component must
have been registered with the EntraPass Server in order to display the option.
• Check Use workspace as report filter for all requested custom and In/Out reports to be issued
according to the operator’s permissions as defined in his workspace.
9 Click on the Security tab to set operator access parameters.
10 From the Login Schedule pull‐down menu, select the schedule during which the operator will be allowed
to login into the system. You may want to create a specific schedule for an operator (Definition >
Schedule), and then assign the schedule to the operator.
NOTE: To allow an operator to login to different EntraPass applications or to the EntraPass Server
select the field Allow login on application and/or Allow login on server (System > Security Level >
Miscellaneous tab).
11 From the Security Level pull‐down menu, select a security level that will determine which components
an operator has access to. A security level consists of menus through which an operator can modify the
database, create components, view system components and events, etc.
NOTE: It is possible to define up to 250 custom security levels; EntraPass offers 3 built‐in security
levels (Installer, Administrator and Guard) on configuration. The default configuration for Installer
permits access to all system components. The Installer must program other security levels to limit
operator access to menu commands and/or options.
12 From the Workspace pull‐down menu, select a workspace that will determine which physical
components (desktop display, card fields, etc.) the operator will be able to access for day to day operations.
NOTE: EntraPass offers 1 built‐in Installer workspace when you install EntraPass for the first time.
13 Access the Security section to edit the security features of the currently displayed operator profile:
• Operator disabled: use this feature if you want to temporarily suspend or limit an operator access to
the system without using an expiry date. If you select an operator and then check this option, the
selected operator will not be able to run the application.
• Change password at next login: use this feature if you want an operator to change his/her password
at next login.
• Disable operator on bad password: use this feature to limit the number of retries on bad password.
For example, if you set this number to three (3), the operator will be disable after three errors when
entering his/her password.
• Days before password is reset: this feature allows to manage operators’ passwords. At the end of the
number of the days specified in this field, the operator will be prompted to change his/her password.
218 System
• Use expiration date: this feature allows you also to manage operators’ password. When this feature
is checked, you have to select an expiration date (Operator expiration date).
• Operator expiration date: used with the Use expiration date feature, the Operator expiration date
allows you to disable an operator’s access at a specified date.
• Concurrent Logins:
• For concurrent logins into an EntraPass application, select Enabled.
• For concurrent logins into an EntraPass application and through EntraPass WebStations, select
Enabled with concurrent logins from WebStations.
NOTE: The WebStation component must have been registered with the EntraPass Server in order to
display the option.
Concurrent Logins
The EntraPass application allows simultaneous or concurrent EntraPass WebStation logins to the same
EntraPass application. This should be planned in advance so when you are ready to install or update your
application, you have all the option certificates that are required. Check Table 1 for details.
NOTE: Changes to the currently displayed profile will take effect at the next login attempt.
14 Click on the Default value tab to select a mandatory card type (optional).
15 Check the Mandatory field option to enable it.
16 Click on three‐dot to select the card type.
password is case‐sensitive. There are three operators and security levels already configured in
EntraPass. These are: Installer, Administrator and Guard.
• Installer:
• Login name and password: kantech
• Security level: By default, a user defined as Installer has full access to all the system menus. He/she
can read and edit system components and has unrestricted access to the system.
• Administrator:
• Login name: kantech1; password: kantech
• Security level: Administrator. By default, a user defined as Administrator has limited access to a
number of the system menus.
• Guard:
• Login name: kantech2; password: kantech
• Security level: Guard. By default, a user defined as Guard has limited access to the system menu.
• Component display options: components can be displayed with our without their physical address. The
physical address can appear on the left or right of the component name.
1 Select the Miscellaneous tab to define parameters for the security level being defined.
2 In the Login restrictions section, select the appropriate login options:
• Select Allow login on server to allow the operator to login to the EntraPass server (Primary or
Redundant).
• Select Allow login on workstation to allow the operator to login to any application in the system.
3 The Keep on application desktop section allows users to increase the number of active windows on the
desktop. In fact, operators can open five windows at the same time: one configuration window and four
windows from the other categories. EntraPass windows are classified in five categories:
• Configuration screen: this group includes all the menus that allow an operator to program the
system. This group includes such menu items as: User menu (card, Badging, card access group,
access level, visitor, card type; Definition menu; Group menu; Devices menu; System menu; Video
menu; Custom and In/Out reports.
• Operation screen: this group includes all the Operation menu items and the Video playback option.
• Status screen: this group includes windows of the Status menu, Current recording menu and Report
state menu.
• Database screen: The following menus are included in this category: Option menu (card format,
authentication password, select languages, Printers options, Changes date and time, etc.); Items of
the User menu (Daypass, batch operations and Import/Export CSV); View Report, Operation on In/
Out, and View exported videos.
• Report screen: this group includes Quick Report, Custom and In/Out report requests and Video list
windows.
NOTE: These options allow operators to keep more than one window active on the desktop. They can
bring to front or send to back the window they want to display, simply by pressing [ALT‐F6].
4 In the Components physical address section, specify how the component's physical address will be
displayed. This will also affect how components will be sorted.
• Display on left—If selected, components will be sorted by their address (i.e. 01.01.01 Controller xyz).
• Display on right—If selected, components will be sorted by their component name (i.e. Controller
xyz 01.01.01).
• No display—If selected, the address will not be displayed (i.e. Controller xyz) and components will be
sorted by name.
5 In the Miscellaneous section:
• Hide card holder pin content: If selected, it offers you the ability to hide the card holder pin content
from the view.
• Hide Camera from video view: If you are using the Video feature, EntraPass enables you to deny
viewing permission to a specified security level.
NOTE: Checking the Hide camera from video view option tells the system to verify access permission to
cameras before loading a video view. For example, if the selected operator’s security level has access
to a video server but not to all cameras defined in the video server and has access to the selected
video view, the system will hide the camera that has been un‐selected when assigning permission to
the video server. For details, see "Limiting Access to a Specific Camera" on page 453.
System 221
Workspace Definition
Workspaces allow System Administrators to grant or deny operators access to system physical
components such as gateways, sites, relays, etc. Workspaces are defined according to the type of tasks
the operators will be allowed to perform in EntraPass; creating and editing items, viewing components,
printing lists or reports, etc. Operators who are assigned a given workspace will not be able to see nor
modify EntraPass components that are not selected in that workspace definition. Workspaces can also
be used by operators to discriminate the information they want to view on screen. For example, a
System Administrator who has access to all components of the EntraPass system may want to view only
specific components. In that case, the System Administrator can define a specific workspace for that
environment and work within those parameters.
NOTE: There is only one default Installer workspace created when you install EntraPass for the first
time.
222 System
Workspace Filtering
• Hierarchical filter: items in a list will be displayed according to the item selected in the level above. For
example, when selecting a specific site (parent), the system will automatically adjusts itself to display
only the corresponding controllers (children). And if you select a specific controller (parent), the system
will adjust itself to display only the corresponding doors (children), and so on.
NOTE: If a tab is empty, verify that you have selected components from it’s parent.
• Once you have selected the Hierarchical filtering mode, it will remain activated under all tabs.
Defining Schedules
• Move to the Schedule tab to select the list of schedules that will be available to an operator.Select
All schedules if you want all the displayed schedules to be available to the operator who is assigned
this workspace.
• You can also select individual schedules from the displayed list.
3 Save your modifications.
System 223
Defining Controllers
1 Move to the Controller tab to select the list of controllers that will be available to an operator who is
assigned the workspace.
• Select All controllers if you want all the displayed controllers to be available to the operator who is
assigned this workspace.
• You can also select individual controllers from the displayed list.
2 Save your modifications.
NOTE: When you select a controller, you also select all the components defined “under” or related to
the controller (i.e. doors, relays, inputs, outputs). Make sure that you have also selected the gateway
(Gateway and Site tab) for which the selected controller is defined. If the gateway is not selected, the
controller will not be available even if it is selected in the list.
Defining Doors
1 Move to the Door tab to select the list of doors that will be available to an operator who is assigned this
workspace.
• Select All doors if you want all the displayed doors to be available to the operator who is assigned
this workspace.
• You can also select individual doors from the displayed list.
2 Save your modifications.
Defining Relays
1 Move to the Relay tab to select the list of relays that will be available to an operator who is assigned the
workspace.
• Select All relays if you want all the displayed doors to be available to the operator assigned this
workspace.
• You can also select individual relays from the displayed list.
2 Save your modifications.
Defining Inputs
1 Move to the Input tab to select the list of inputs that will be available to an operator who is assigned the
selected workspace.
• Select All inputs if you want all the displayed inputs to be available to the operator assigned this
workspace.
• You can also select individual inputs from the displayed list.
2 Save your modifications.
1 Move to the Access level tab to select the list of access levels that will be available to an operator who is
assigned this workspace.
• Select All access levels if you want all the displayed access levels to be available to an operator who
is assigned this workspace.
• You can also select individual access levels from the displayed list.
2 Save your modifications.
NOTE: Make sure that you have also selected the gateway for which the selected access level is
defined. If the gateway is not selected, the access level will not be available even if it is selected in the
list.
Defining Reports
This feature gives operators access to specific reports according to their workspace. For example, a
System Administrator may have access to all the reports that can be generated whereas the Guards’
Supervisor may only have access to all Guard Tour related reports. The reports will be generated from
the Archived Message list on the workstation desktop. Once the reports have been assigned to
workspaces, operators will only have access to reports that correspond to their workspace.
System 225
1 Move to the Report tab to select the list of reports that will be available to an operator who is assigned
this workspace.
• Select All reports if you want all the displayed reports to be available to the operator who is assigned
this workspace.
• You can also select individual reports from the displayed list.
2 Save your modifications.
Defining Graphics
1 Move to the Graphic tab to select the list of graphics that will be available to an operator who is assigned
the workspace.
• Select All graphics if you want all the displayed graphics to be available to the operator assigned this
workspace.
• You can also select individual graphics from the displayed list.
2 Save your modifications.
Defining Workspaces
This feature gives operators access to information that pertains to specific workspaces according to
other operators workspaces. For example, Guards in the system may have a workspace assigned to them
according to the area they are patrolling and the type of information they can view and edit in
EntraPass. The Guard’s Supervisor, however, must have access the information available to all the
Guards working in his department. In that case the list of workspaces for the Supervisor will contain all
the Guards’ workspaces defined in EntraPass.
1 Move to the Workspace tab to select the list of workspaces that will be available to an operator who is
assigned the selected workspace.
• Select All workspaces if you want all of them to be available to the operator who is assigned this
workspace.
• You can also select individual workspaces from the displayed list.
2 Save your modifications.
restrict access to a specific camera for that workspace. This feature makes it easier to define or modify
permission for accessing a video server, a video view or other video menu items.
1 Move to the Video server tab to select the list of video servers that will be available to an operator who
is assigned the selected workspace.
• Select All video servers if you want all of them to be available to the operator who is assigned this
workspace.
• You can also select individual video servers from the displayed list.
2 Save your modifications.
NOTE: To filter video views available to an operator, the operator’s workspace must have access
permission to the video server associated with this specific video view. For example, if operators are
granted access permission to a video view but their workspace definition does not give them access to
the video server where the video view is defined, the video view will not be available to operators with
this workspace.
Defining Cameras
1 Go to the Camera tab to select the list of cameras available to an operator who is assigned the selected
workspace.
• Select All cameras if you want all the cameras to be available to the operator who is assigned this
workspace.
• You can also select specific cameras from the displayed list.
2 Save your modifications.
Defining Tasks
Associating tasks to a workspace allows you to control the tasks that an operator can define or modify.
1 Move to the Task Builder tab to select the list of tasks that will be available to an operator who is
assigned this workspace.
• Select All tasks if you want all the tasks to be available to the operator assigned this workspace.
• You can also select individual tasks from the displayed list.
2 Save your modifications.
Defining Panels
Associating panels to a workspace allows you to control the panels that an operator can define or
modify.
System 227
1 Move to the Panel tab to select the list of panels that will be available to an operator who is assigned this
workspace.
• Select All panels if you want all the panels to be available to the operator assigned this workspace.
• You can also select individual panels from the displayed list.
2 Save your modifications.
Defining Events
This feature is used to define the event messages that can be displayed to operators who are assigned
the selected workspace.
1 Move to the Events tab to select the list of events that will be displayed on an operator workstation.
• Select the events you want to display for the operator who is assigned this workspace.
2 Save your modifications.
There are more than 400 system events. The most common among them are:
• Access granted
• Input in alarm
• Card modified by operator, etc.
Events are associated with system components, such as doors, controllers, gateways, EntraPass
applications, etc. Every event message is associated with a system component and output devices or
group of devices. For example, an Access granted event can be defined for each individual door or by
default it can be defined for all doors. This flexibility allows for different actions or responses on a door‐
by‐door basis.
228 System
Default associations
Comments
Component Workstation
Default Default All events originating from all components are sent
to all workstations
Default (Specific) Workstation 2 All events originating from all components are sent
to only Workstation 2
Specific (Door 1) Default Only events originating from Door 1 are sent to all
workstations
System 229
• Manual associations: Manual associations are setup by administrator and allow to send messages to
Message desktops for specific events. The following table shows the three types of manual
associations:
Manual association
Example
Component Workstation
Specific Specific Events generated by Door 1 are sent
to only Worksation 1.
Specific Unspecified or default Events generated by Door 1 are sent
to all Workstations (default).
Unspecified or Specific Events generated by any of the Doors
default (default) will be sent to Workstation
1 only.
NOTE: Manual associations take priority over default associations. When you define a manual
association between an event message and a component, the default association is ignored. It can be
restored by deleting the manual association. Manual associations should be used with caution. The
most common use for this feature is the SmartLink application.
1 From the System tab, click the Event parameters icon.
2 From the Event category selection drop‐down list, choose a category between Access control events and
Intrusion events.
3 From the Event drop‐down list, select an event for which you want to define settings.
NOTE: By default, all events are defined to be sent to the Messages desktop of all EntraPass
workstations defined in the system with an always valid schedule. It is recommended to keep default
settings especially when these settings apply to all events/components. However, you may decide to
create manual associations if you want a specific event to generate a specific message or alarm. The
selected event will appear on all doors and will be displayed on all EntraPass workstations.
4 In the Display settings section, specify the display options: by default, all events are programmed to be
displayed in the Messages desktop window of all the EntraPass workstations of the system, and are
assigned an Always valid schedule.
NOTE: If you are running EntraPass SmartLink application, this schedule must remain to “Always valid”
or otherwise messages/commands will not be forwarded to the application.
5 From the Print popup menu, select a schedule to determine when the event will be printed. When this
schedule is valid, the selected event will be printed on the printer defined on the workstation to which it
is being sent.
6 From the Color drop‐down list, select the color that will be used to display the event in the Message
desktop. The default colors are set according to the following convention:
• Red for alarm events;
• Green for elements returning to a normal condition;
230 System
Creating Associations
1 In the Event parameters window, select an Event category and an Event from the drop‐down lists. From
the component pane (on the left) select a component and then select an EntraPass workstation to which
the event message will be sent.
2 Click the Save icon to create the new association. In this case, All access ‐ Door opened events that will
occur on the selected door will be sent to the assigned workstation computer (selected on the right‐hand
side).
NOTE: The Save icon is enabled only when the selected event/component becomes part of an
association.
1 In the Event parameters window, select the category and then the event you want to modify from the
Event drop‐down list.
• Use the Font button to choose a different font (and font size) for your report.
• Select the Preview button before printing, if desired.
Instructions Definition
This menu is used to define instructions that must be assigned to events. When an alarm is generated,
the instruction will display in the Instruction window (Desktop menu) for acknowledgement. Usually,
each line will contain a single directive; the response instructions will be composed of several directives
(lines). This allows for greater flexibility when modifications are required.
Defining an Instruction
1 From the System main window, select the Instruction icon.
2 To create a new instruction, click the New icon. To modify an existing instruction, select one from the
Instruction drop‐down list.
3 Enter the instruction name/identification in the language section.
4 If the Mandatory alarm comment checkbox selected, the operator will have to add a comment in order
to mark the alarm as “acknowledged”.
5 Select an appropriate language tab to enter the instruction. Instructions are entered in one selected
language.
NOTE: You may enter up to 511 characters (including spaces) per instruction.
6 To assign instructions to events, see "Event Parameters Definition" on page 227.
4 Select the Door filters tab to filter doors that will send messages to the Filtered messages desktop.
Additionally, when “Access events” are filtered, the cardholder’s picture can be displayed with the event
(if pictures are assigned to cardholders). You can select which doors will display the cardholder picture
when the event for this door is generated.
5 Check the All doors option or choose specific doors for which the cardholders’s picture will be displayed
an door event.
6 From the Door filter type, select the filter that will be used for filtering Door events:
• Door filter: Only events related to the selected doors will be sent to the Filtered Message desktop
• Pictures filter: Cardholders’ pictures related to cards presented to the selected doors will be sent to
the Filtered Message desktop
• Filters for doors and pictures: Door events related to the selected doors as well as cardholders’
pictures that triggered door events on the selected doors will be sent to the Filtered Message
desktop.
7 Select the EntraPass applications tab to filter applications that will send messages to the Filtered
Messages desktop.
8 Check the All EntraPass applications option for the Filtered Messages desktop to receive all events
originating from all EntraPass applications defined in the system. You may also choose to display events
from specific applications. To do this, select the EntraPass application from which you want to receive
events.
9 Select the Gateway and site tab to filter gateways and sites events sent to the Filtered Messages desktop.
10 Check the All events option to receive events originating from the components of the gateways or sites.
You may select the gateway or the site that will send events to be displayed.
NOTE: When you use filters, the system retrieves events that are already displayed in your Message
desktop and sorts these events according to the settings of the selected filter. If events originating
from a specific gateway are displayed in your messages desktop and this gateway is not selected in the
filter definition, then these events will not be displayed when you select this filter.
11 Select the Special filter tab to filter events according to their type.
• Picture: all events associated with a cardholder’s picture will be displayed in the Filtered Message
desktop.
• Fail‐soft: all events generated by a controller in stand‐alone mode following a communication failure
will be sent to the Filtered Message desktop. Fail‐soft messages are identified with a + sign in the
Filtered Message desktop (and Message Desktop) when this option is select when defining the
Messages list properties (Desktop > Message Desktop > right‐click an event > Properties).
• Video: all video record events will be sent to the Filtered Messages desktop.
NOTE: When you use filters, the system retrieves events that are already displayed in your Message
desktop and filters these events according to the settings of the selected filter. If events originating
from a specific gateway are displayed in your messages desktop and this gateway is not selected in the
filter definition, then these events will not be displayed when you select this filter.
234 System
EntraPass Desktops
The Desktops Toolbar
Use the Desktops toolbar to define Desktops. Desktops can receive and display system events (current or
historical), alarms, cardholders’s picture, system graphics, etc. A desktop can also be used to
acknowledge alarms, display instructions, etc. There are eight (8) pre‐defined desktops. These can be
configured as follows:
It is possible to display more than one window at a time. Depending on their security level, operators
can modify the settings of each of these windows (background color, size, toolbar, etc.). However, an
operator whose access level is ‘read‐only’ on a given desktop cannot modify, move, maximize or
minimize a desktop.
NOTE: Only operators with the required security level can customize their desktops (System tab >
Security Level). They also have the ability to allow “Read‐only operators” to modify their desktop
settings. In this case, the changes apply only to the current session.
3 Choose the Component list filter workspace and the Event message filter workspace from the drop‐down
menus in order to create a temporary workspace.
• The Component list filter workspace lets you select the specific component list of an existing
workspace.
• The Event message filter workspace (optional) lets you select only the upcoming messages, not
the buffered messages, from an existing workspace.
NOTE: A temporary workspace must include a Component list filter workspace selection to be enabled. If
you only select an Event message list filter workspace, the temporary workspace banner will not display.
4 Click OK. A banner displays below the menu bar with the names of each selection of the temporary
workspace.
5 Repeat Steps 1 to 4 to return to the original workspace or double‐click on the banner to create or modify
the temporary workspace.
1 Login, using the user name and password of the operator with ‘full access’ security level.
2 Select the desktop you want to customize, right‐click and select Properties in the menu to open the
Desktop properties dialog.
NOTE: A Permit button appears when the operator who is logged on has ‘read‐only’ access permission.
The permission acquired during this session will be valid until the operator logs out. Click the Permit
button. The operator login window appears. Enter your user name and password, and click, OK. The
temporary permission will be granted.
Desktops Colors
Event colors can now be displayed in a separate column. Text and message background colors can also
be selected.
1 From any message desktop, right‐click on a message and select Properties.
2 Click on the dropdown list and choose a color for the background.
3 Select Display event color in separate column if needed.
4 Click on the second dropdown and choose a color for the message text.
• Picture—When you select this option, the system inserts a card icon next to events containing
cardholder pictures.
• Fail‐soft messages—When you select this option, the system displays a plus (+) sign next to the
events that occurred when controllers were off‐line.
• Video: check this option if you want the selected desktop to display video data from the video
server connected to your system.
• The Miscellaneous section allows you to enable additional options:
• Keep card picture—When selected, the system keeps the latest card picture (if the Picture
window option is selected) until another event containing a card occurs.
• Display toolbar—Displays/hides the toolbar on the top of the Message Desktop.
• Manual properties save only—When you select this option, you have to click the Save button
(once selected, the button is disabled). The system saves all the settings defined in the
Properties window as well as the position of the window within the Messages Desktop.
• Display selected messages (full)—When you select this option, a smaller window is added at the
bottom portion of the Message window. It displays the selected event with its full description.
This feature is very useful when your Message window is too small to display the entire
description of an event.
• Display events in bold: select this option to increase the legibility of text event messages
displayed in EntraPass desktops (Message list, Filtered messages and Alarm desktops).
Moreover, if the color selected for an event message is the same color as the background color,
the event message will be displayed in black bold so that it can always stand out. (This option is
not available for Archived Messages Lists.)
• Last Message on Top: By default, event messages are displayed in ascending order of
occurrence, with the area at the bottom of the screen reserved for the highlighted event. You
can select to display the events in descending order, with the highlighted event showing above
the list of event messages.
• Auto‐scroll delay (mm:ss): Will automatically start scrolling the message list after a pre‐set delay
when the operator selects an item in the list. By default, this option is turned on with a preset
delay. You can select to turn this option off which means that the operator will have to click the
Restart Scroll button in the Messages List. (This option is not available for Archived Messages
Lists.)
• Message background color—Allows the operator to modify the background color of the message
window.
NOTE: To change the font color of system messages: System > Event parameters.
Also, in order to reduce the quantity of data retrieved, a filter can be added to the user name or to the
card information fields (1 to 10) when searching for a card. Enter a name for the filter and click the
button on the left side of the field to display the contextual menu.
• Video recording: This menu items offers three options: Play, Play/Edit/Export and Play from Vault.
Selecting Play allows users to play the video event in the Playback window, offering options to snap
(copy) it and save it for future use. Selecting Play/Edit/Export offers users features similar to the
ones in the Video Event List. Operators can then display details about the event (camera, server,
comment field) and camera information, etc. The video event can also be played and exported.
Selecting Play from Vault allows operators to view a video that is already stored in the EntraPass
Video Vault.
NOTE: If camera icons are not displayed, simply right‐click a video event message, select properties
from the shortcut menu, and check V ideo in the Show icons section of the Properties
• View parent: Displays the parent of each component related to the selected event.
• Edit: This feature offers you the ability to edit each component associated with the selected event. If
Edit is selected, a shortcut menu displays components associated with the selected event. In this
example, the Site definition modified event involves the EntraPass application, the operator who was
on duty when the event was generated and the site related to the event. It is now possible to edit
any of the three components by selecting it from the shortcut menu. If the selected event is an
access event and if the card that triggered the event has already been registered in the system, it will
be possible to edit the card. However, if the card is associated with an Access denied ‐ card unknown
event, the card will be created and registered in the system.
242 EntraPass Desktops
• Send to back: This option only works when the window type is set to floating. It sends the active
window behind the main application window. To bring back to front, right click the desktop button,
then select Bring to front.
• Help: Displays the EntraPass Online Help.
• Properties: This menu item enables users to modify the display properties for the selected desktop.
• + (New)
• = (Modified)
• ‐ (Deleted)
Picture Desktop
If you selected Picture screen when defining the Message desktop, it will be displayed with the Picture
window. Access events are displayed with the cardholder’s picture if you have set the appropriate
display option in the Message filter definition (System > Message filters). For details, see "Message
Filters Definition" on page 232.
• Stretch —This option stretches the picture to the window size without maintaining proportions. The
picture may appear distorted.
• Stretch ratio—This option stretches the picture to the window size while maintaining proportions.
3 The Display multiple pictures option allows you to show up to four photos, depending on your needs.
When selected, you can keep the default value “Message” or choose a specific door for each of the four
photos.
4 Check Apply all the following items for all cells to assign the parameters to all cells.
5 Select the information you want to see displayed with the cardholder’s picture:
• Door: The door where the card was presented will be displayed above of the cardholder’s picture
• Event: The event message will be displayed
• User information: The User information field will be displayed above the picture.
• Comment: If this option is selected, a comment field appears below the cardholder’s picture. The
comment entered when defining the card appears in this field.
NOTE: If a door is associated to a cell (photo) and the option Door is selected (Display selected fields),
the name of that door will be displayed in blue instead of the usual black color.
To view associated comments, select the event and use a right‐click to display the contextual menu, then select
View Comment. A comment can also be added using Add a New Comment.
Alarms Desktop
The Alarms desktop is used to view and to acknowledge alarm events. Alarm events are defined in the
Event Parameter menu (System > Event Parameters). Any event can be defined as an alarm event. Alarm
events require operator acknowledgment and are displayed in the Alarms desktop. A schedule must be
defined for all alarms (System > Event parameters, Alarm settings). When an alarm is generated during a
valid schedule, operators have to acknowledge the alarm. Alarms are displayed with date and time,
alarm description, details, instructions (if defined) and associated graphic or video clip. New events are
added at the bottom of the Alarm desktop unless you have setup the list to display in descending order
(in the Alarm Desktop Properties dialog).
• Acknowledge—When selected, a green point is inserted beside an alarm event to indicate that the
event was acknowledged.
• Re‐visit—When selected, the system flags the selected event. A yellow indicator is inserted beside
flagged events.
• Clear re‐visit: Remove the flag for the selected event.
• Add comment—Allows operators to enter comments concerning the selected event. The added
comments are displayed in the bottom part of the alarm window. A blue + sign beside an alarm event
indicates that a comment was added to the alarm event (visible when icons are enabled: right‐click
an alarm event > Properties > Show icons).
• Print event and comment—When selected, the system prints the alarm event and the associated
comment.
• Delete event—When selected, the selected alarm event is marked for deletion (the indicator
becomes “black” to indicate that the event has been marked for deletion). To view the events
marked for deletion, before you actually purge them, right click anywhere in the window and select
Properties then select View deleted logs.
1 Define a desktop and customize it as an alarm desktop: for this, you have to check the items of the
Alarms desktop section.
2 Check the Display on new alarm option so that operators can automatically view new alarms without
having to open the alarm desktop and secondary windows associated with it.
NOTE: If this option is selected when defining a Filtered message desktop for instance and if the
desktop icon is selected, the filtered message desktop will be displayed (the background color of its
icon turns blue), but the windows below the Display on new alarm section will not be displayed; they
are only displayed when a new alarm occurs. If those windows are displayed (on new alarm), clicking
the “X” in the top right hand corner of one of them will close all the open windows. If Display on new
alarm is not checked, the alarm desktop and all its secondary windows will be displayed on call (that
is, when the alarm desktop is selected).
3 Click OK and Go for your configuration to take effect immediately.
NOTE: When you define a desktop as an alarm desktop to be displayed on new alarm, it is
recommended to reopen the Automatic Alarm Display desktop, to position its windows the way you
want them to appear, then to click OK and GO again. This way, it will appear exactly as you have
defined it.
Acknowledging Alarms/Events
Usually, operators have to acknowledge receipt of an alarm condition (event—such as intrusion, input in
alarm, etc.) by responding in ways such as clicking the acknowledgment button. In EntraPass, operators
acknowledge alarm messages from an alarm warning box or from the Alarms desktop window.
When an alarm message is acknowledged by an operator, the notification is acknowledged or removed at all
workstations.
NOTE: A sound can be added to alarm events. For more details about setting options for an alarm
sound, see "Multimedia Devices Configuration" on page 281.
Acknowledgement options are setup in the EntraPass application definition (Devices > EntraPass
application (selected Workstation) > Alarm tab, Acknowledgement parameters). Events that require
operator acknowledgment are defined in the System > Event Parameters.
NOTE: If the component that is in alarm is assigned to a video view, the video view or video recording
is automatically displayed when an alarm occurs.
EntraPass Desktops 249
Automatic Acknowledgement
Alarms can be automatically acknowledged without operator intervention. This option is enabled in the
Operator definition menu (System > Operators > Privileges, Auto acknowledge).
NOTE: In order for the Manual button to display on the Alarm Desktop window, it is important to close
the EntraPass session and reopen it after you have selected the Auto acknowledge option.
NOTE: Only operators granted the appropriate access privilege should be using this option. If the
Automatic acknowledge feature is used, the alarm message box is not displayed; therefore, it will not
be possible to suspend alarms. If this option is enabled in the Operator definition menu, the Manual
button is added to the Alarms desktop. This button toggles between Manual and Automatic
acknowledgement.
NOTE: This process will occur each time a workstation have a communication failure with the server.
1 Select the alarm event you want to acknowledge (one that has been flagged, for instance), Right‐click to
enable a shortcut menu.
2 Select Acknowledge from the sub‐menu. The status indicator becomes green.
NOTE: To tag an alarm message for specific purposes, select the alarm event you want to identify;
right‐click and select Flag from the sub‐menu. You can also click an alarm message until the color of its
status indicator changes to the desired color.
250 EntraPass Desktops
NOTE: The alarm sound will stop while a comment is entered by the user.
If the alarm event has already been acknowledged, a warning message will be displayed for you to confirm that the
comment should be added.
Instruction Desktop
The Instruction window displays the instructions to follow when an alarm is reported. Instructions will
only be displayed if this option is enabled during the Event Parameters settings (System > Event
parameters, Alarm settings).
Graphic Desktop
The Graphic desktop displays the graphical location of the alarm being reported (if graphics are defined
in the system). A graphic corresponds to the secured area of the system where components (EntraPass
application, controllers, inputs, relays, etc.) are located on a site. With graphics, operators can easily
view the exact location of a component installed on a site, or the status of components and devices such
as area groups, areas, doors, contacts, motion detectors, controllers, assigned to the graphic. In an
emergency situation where muster reporting has been defined, icons will indicate when all employees
have vacated the area. Operators can perform manual operations directly from the displayed component
(for example lock/unlock a door). To define interactive floor plans, see "Graphics Definition" on page
109.
3 Right click anywhere in the Graphic desktop, then, from the shortcut menu, select the graphic you want
to display.
NOTE: If the window is smaller than the graphic size, you can click‐hold‐and‐drag the graphic to move
it around within the Graphic window.
4 You may right click anywhere in the graphic to enable a shortcut menu in order to:
• Adjust the display size of the selected graphic (Fit to screen, Design size or Picture size.
• Select Auto result for the system to display a message indicating the cause of the communication
loss in case of communication failure. If Auto result is not selected, operators will have to manually
request the results for the component by using the Show result.
5 Right‐click a component in abnormal condition to enable a sub menu.
NOTE: Components in alarms are represented by their animated icons. Selecting an animated icon and
viewing its parent components allows operators to learn more about the “alarm condition”.
6 Select Full status from the shortcut menu to display the error list related to one or all the components in
alarm.
7 Select Comment to display comments already assigned to the device (please refer to see "System
Devices" on page 57 for more information).
8 Select the Double click menu item to allow operators to modify the status of a component in alarm from
the Graphic desktop. For example, if the displayed component is a door and if the Double click menu
item was set to Unlock, an operator can manually open the door from the Graphic desktop.
NOTE: When you modify the Double‐click feature via the Graphic desktop, the system does not save the
modifications. Modify the default Double‐click feature via the graphic definition (Definition > Graphics,
Design window, right click a component > Default dblclick menu item). For more information on how to
create graphics and on how to assign components to graphics, see "Graphics Definition" on page 109.
252 EntraPass Desktops
Video Desktop
If the Video feature is enabled in EntraPass, you can configure a desktop as a Video desktop.
2 Select an icon (in the lower part of the window) to determine for instance the size of the views or to
display the Panel window (a small window associated with the video display).
EntraPass Desktops 253
Item Description
Unit name The network name of the remote DVMS system (Intellex in this
example). The Unit name is followed by the DVR IP address
Unit type The type of the unit. can be Intellex, Iris (network client), etc.
Schedule mode The current schedule mode of the remote DVMS unit. It indicates
how images are recorded by the DVR installation. The values for this
field can be:
• Regular (regular schedule)
• Single (only a single camera)
• Custom (a custom schedule has been set by the operator).
Recording in progress The active record statue of the remote DVMS unit. Values can be:
• True: is recording
• False: is stopped.
Time span (h:mm) The time interval (in second) between the oldest and newest images
in the database.
Unit version The official version of the DVMS unit.
Number of cameras The number of cameras connected to the Video server. The source of
the video data is generally a camera, but it may also be a television
station or other video source.The value varies from 0 to 16.
Record mode The record mode can be linear or circular
• (Linear: if you select this option, the recording will continue
uninterrupted until the available space is finished;
• Circular: if you select this option, the DVR will notify the operators
before the recording space is completely filled. The operator will
then choose to continue the recording or to stop it. By default, the
recording mode is set to Circular.
Recording mode The recording standard of the remote unit. The recording standard
depends on the area.Values can be:
• NTSC: the NTSC standard is mainly used in America and in many
Asian countries such as Japan and South Korea or
• PAL: the PAL standard is mainly used in Germany, Great Britain,
China, Australia and Brazil.
EntraPass Desktops 255
Item Description
Estimated remaining images The estimated number of frames that may still be recorded in the
video database before the DVMS unit space is completely filled. This
option is only useful if the recording mode is linear.
Interface version (API) Indicates the version of the application interface between EntraPass
and the selected Video server.
Number of audio The number of audio streams available of the video server unit. The
source of the audio data is generally a microphone, but may be
another audio source.
Record rate The rate code value. This value indicates the aggregate recording rate
for the DVR unit in number of frames per second. The value can be: 1,
2.5, 7.5, 15, 30, 60, 120, other value.
Total number of images The total number of images in the remote unit’s database.
Version compatibility Compatibility between the versions of the DVR unit and the
application interface used.
Number of text The numbers of text data streams available from the DVMS. The text
data source may be a cash register or other device.
256 EntraPass Desktops
Reports 257
Reports
The Report Toolbar
Use the Report toolbar to define and generate reports. These reports may be generated automatically or
requested manually. Reports can be sent by email or by using SmartLink.
• Custom events—Select this option to include your own events. The Custom tab appears when the
Custom events option is selected. This option allows the operator to selects the components that
have generated the selected events according to the setting in the “event” field.
NOTE: When you use the Event field, you have to specify which component(s) should be used or not
used. Once you select an event (i.e. access), the system displays all the doors of the gateway. If you
select Controllers, the system displays all the controllers for the gateway. Once you have selected an
event (i.e. controller events), select the controllers (i.e. list of controllers) to be included in the report.
4 Select the Card tab to specify filter details about the report. The Card tab appears only if a card‐related
event is selected.
5 In the Card index drop‐down list, specify the information that will be used as the filter. For example, if
you select “card number”, only access events in which the defined card numbers appear will be selected.
NOTE: If you select Card number, the Lower and Upper boundary editable fields display the default
numerical values to be replaced by card numbers. If you select Card user name, these fields are enabled
to receive text data. For example, you can enter A in the Lower boundary field and F in the Upper
boundary fields for the system to include events in which the selected door is defined and events in
which the defined card numbers appear but only for card users whose names begin with A to F. If you
select All, the editable fields are disabled.
6 In the Report name tab, enter a name for the report (this name will be displayed on your report).
7 In the Start/end date tab, enter the date and time on which the system will start to collect the events. For
example, if you enter 7:00 and an event occurred at 6:00, this event will not be included. To target events
that occurred during a specific time frame, use the Time period tab.
8 In the Time period tab, check the Specific time frame option to include events that match the specified
time frame. Enter the target time for the report.
9 If you want to overwrite the previous file, select the Miscellaneous tab then check Overwrite existing
output file. If you do this, the existing default output file will be replaced by this new one.
10 Select the Queue priority level. A report with a priority of 1 will be processed before a report with a
priority of 99.
11 Define the output parameters:
• Database output type: Select the database output format (Sybase, DBase IV, CSV, PDF, Excel, RTF or
text).
• Directory—Indicates where the report is saved and stored. The default folder is:
C:\ProgramFiles\Kantech\Sever_CE\Report\your file.xx.
• Output filename—Indicates the output file name. By default, reports are saved on disk in
C:\ProgramFiles\Kantech\Sever__CE\Report\your file.xx. The report filename is composed of the
Reports 259
date and time on which the report was created. You can modify the filename if necessary, but do not
modify the extension.
• Database output process—Select the appropriate output processes. A report template is associated
with each output.
• Database only: The report will be saved in the system database.
• Display (custom, detailed, summary or statistics) report: The report will appear on‐screen.
• Report printed by (sequence, date & time or event): The report will be printed according to the
specified sort order.
• Email (custom, detailed, summary or statistics) report: The report will be sent by email to a
specified valid email address.
• Send to workstation—Select the workstation to which the quick report should be sent.The list
contains all workstations where SmartLink applications have been installed. When SmartLink is
installed on two or more workstations connected to the network, you can generate reports on one
workstation and send the results to another workstation by selecting the SmartLink that corresponds
to the workstation where you want to display the report.
12 Click on the Execute button to launch the report.
13 Click on the Preview button to view the report.
4 Select an event type to display its items in the right‐hand pane. If you select Card type, the right‐hand
pane displays all the card types defined in the system. If you select Doors, all the access system doors are
displayed in the right‐hand pane.
NOTE: If an item in the left‐hand pane (Selected components) is selected, its color changes (turns red).
When it is deselected, it resumes to the default color.
1 In the Custom report window, select a report from the Report drop‐down list. If you are creating a new
report, click the New icon in the toolbar, then enter the necessary information in the language section.
2 From the Report type drop‐down list, select Card use report. When you select the Card use report type,
only events related to card usage are displayed in the left‐hand pane.
3 You may check the Select all events option (when it is checked the display pane is disabled), or you may
select only the events you want to include in the report.
4 Check the Overwrite existing output file option if you want the system to replace the existing output file
each time the report is automatically generated according to the settings defined in the Automatic
report schedule tab.
5 Check the Allow WebStation Request for historical report request through the EntraPass WebStation.
The WebStation component must have been registered with the EntraPass Server in order to display the
checkbox.
6 You may also check the Process separately option if you want the events to be processed individually for
each card. For example, if you want a report for “Access denied events” and “Access granted events”, if
you do not check the Process separately option, the report will contain all these events. When the
Process separately option is checked the report will display Access granted events and Access denied
events separately.
NOTE: The Process separately option appears only when the report type is a Card use report.
7 Move to the Use definition tab to specify the card use options (Not used since or Used since) and defined
periods.
NOTE: The Use definition tab appears only when the selected report type is a Card use report.
8 To define the target period, check the From checkbox and enter a date in the From field. You may select
a date in the calendar when you click the Calendar button. Alternatively, you may use the up/down
controls or enter the Number of days back, starting from today’s date.
9 When you have finished defining the report, save it. You may request it using the Report request button
in the Report toolbar.
10 Select the Automatic report schedule tab to specify details about the report. For details about defining
an automatic report, see "Defining Automatic Report Schedules" on page 263.
• Select None if you want the report to be manually requested (see Report Request).
• Select Weekly if you want a report every week. You have to check the day on which the report should
be executed automatically.
• Select Monthly if the report is needed once a month. You have to specify the day (ex. the second
Friday of the month or the 15th day of the month) when the report will be executed automatically.
• Select Once if you want the report to be executed automatically on a specified date.
3 Select the Queue priority level. A report with a priority of 1 will be processed before a report with a
priority of 99.
4 In the Start at this time field, enter the time at which the system will start executing the report.
5 Specify the Scheduling parameters.
NOTE: These settings are ignored when the report is requested manually by an operator.
• Start this many days back—The report will start collecting events according to the number of days
specified in this field. It is based on the present date.
• Start at this time—Once you specify the amount of days, specify the starting time (i.e.: 7:00am). For
example, if you enter 7:00, events that occurred at 6:00 will not be included in the report.
• Stop this many days back—The report will include the specified number of days entered in this field.
It is based on the present date.
• Stop at this time—Once you specify the number of days, specify the ending time (i.e.:5:00 pm), that
is, the day on which the system will stop collecting data; you may also specify the time at which it
will stop. For example, if you enter 7:00 and an event occurred at 8:00, then this event will not be
included. To target events that occurred during a specific time frame, you have to use the Specific
time frame option.
NOTE: The start and end time are only used for the first day and last day, for example if you start
collecting events on Monday at 8:00 and end on Friday at 17:00 all events between 8:00 Monday and
17:00 Friday will be included. The system does not use the start and end time for each day but for the
whole period.
The following table shows the difference between these database formats and their output file formats:
Database Description
SyBase The new EntraPass database.
Dbase IV A popular database management system format for storing data that is sup‐
ported by nearly all database management and spreadsheet systems. Even
systems that do not use the DBase format internally are able to import and
export data in Dbase format. Output formats are .db and .rdf.
CSV Will save the report in a comma separated values format (yourfile.csv). A data
format in which each piece of data is separated by a comma. This is a popular
format for transferring data from one application to another; because most
database systems are able to import and export comma‐delimited data.
Excel Microsoft Excel file type.
PDF Portable Document Format (PDF) is an open standard for document
exchange. It can be opened with the free application Adobe Reader.
RTF The Rich Text Format (RTF) is a proprietary document file format with
published specification for cross‐platform document interchange.
Most word processors are able to read and write some versions of RTF.
text A text file is a kind of file that is structured as a sequence of lines. Can
be opened by a large number of editing tools.
4 From the Output process drop‐down list, select the report template. It will be used with the requested
report. For details on the output format, see "Defining a Report Output Format" on page 265.
3 Report printed by sequence (Sybase Only): This report is sorted by event sequence number (order in
which they were generated by the system) and printed automatically at the printer of the destination
workstation.
4 Report printed by date and time (Sybase Only): This report is sorted by date and time and printed
automatically at the printer of the destination workstation.
NOTE: The printed reports (option three and four) will be saved in the reports folder in the specified
format. They will also be printed but not displayed.
5 Report printed by event (Sybase Only): This report is sorted by event message (alphabetically) and
printed automatically at the printer of the destination workstation. The report is saved in the reports
folder in the specified format, but not displayed.
In/Out Reports
In/Out reports will be saved in the reports folder, they are not printed nor displayed. User have to
manually retrieve the report to view it, they can also use the “Archive” menu.
1 Single file with all data (CSV only): The report is generated in one file containing the data and the
descriptions (date & time, transaction ID, card number, card user name and door description).
2 Database with transactions (CSV & DBase IV): The report is generated with all the data and transactions
in one single file. It includes the date & time, the transaction ID, the card number and the card user
name.
3 Display In/Out report (Sybase only): The report will automatically be displayed on the desktop when
completed. You can customize the report before you print it manually. It contains: the card number, card
user name, entry time, exit time, contents of the card information field as selected in report definition
and total hours per cardholder. For more information on how to customize the report, see "Previewing
In/Out Reports" on page 275.
4 Two (2) databases with all data (Sybase & DbaseIV): the report will be generated in two separate files:
• One file containing: date, time, event message (transaction type), pkcard, pkdoor, pkdoorgroup.
• One file containing: pk description (explaining pkcard, pkdoor and pkdoorgroup), card number,
object and contents of card information field selected in the report definition menu.
NOTE: PK refers to a component unique number within the system
5 Single database with all data (Sybase & DbaseIV): The report will be generated in one file containing the
data and the descriptions (date and time, transaction ID, card number, card user name, door description
and sequence).
6 CSV compilation In/Out (CSV Only): The report will be generated in two files. One file containing a total,
of hours for instance, by department, and the other file containing detailed information. Depending on
the number of days covered by the report, a “day” column will be reserved for each day.
• Automatic filename—Select this feature if you want the system to automatically use the date and
time as the filename. You cannot use the “overwrite existing output file” when you use this option.
• Filename—If you wish to overwrite the same report (for example—every week), you can enter a
filename here and when the report will be executed according to specifications, the new report will
replace the oldest report.
• Destination: this is where the report should be sent/printed automatically.You can also use the
Overwrite existing output option to specify a different destination file.
Reports 267
• Report language—This field is used to include additional information in your report. Select from the
displayed list.
Requesting Reports
With this feature operators can request pre‐defined Historical reports or Card use reports that were
created using the Custom Report menu. Operators can also email the report to one or multiple
recipients.
NOTE: If your report contain automatic settings, these will be ignored. You must indicate new settings.
1 Under the Report toolbar, click the Report Request icon. The Report request window appears.
2 In the Report list display pane, select the report that you want to execute.
3 Select the Queue priority level. A report with a priority of 1 will be processed before a report with a
priority of 99.
4 You may define output parameters, including the database output type format (Sybase, DBase IV, CSV,
PDF, Excel, RTF or Text), the target folder, the output filename, etc. For more information on how to
select an output format, see "Defining a Report Output Format" on page 265.
NOTE: If a Card use report is selected, the “Date and time” section is disabled.
5 Click Execute. A system message informs you that the report is being processed. The Report options
window appears and is then minimized to the task bar.
6 Select the Preview button to define the report and filter options. This will increase the readability of the
report by adding, for instance, alternating band colors, framing events, icons in the reports, etc., or by
sorting events in the report (by event ID number, alphabetical order or date and time).
7 Enter the description in the Search description field. The report is updated in real‐time when you enter a
filter option.
8 You may use Preview to preview the report or the Properties button to view details about the report.
When you click the Preview button, the system will display the result of the report. From that window,
you can save the report in various formats or print the report.
Emailed Reports
EntraPass allows you to email any report to one or more recipients. The email feature is enabled when
defining an EntraPass workstation and when specifying the report database output format.
Custom, In/Out and quick reports can be sent by email to any valid email address.
NOTE: The Card type tab appears when the Use card type as filter box is checked.
6 Select a filter index, then select a filter mode (None, Include, Exclude). If you have selected a filter index,
select the filter mode and enter the value range in the Upper/Lower boundary fields. To include all the
fields, leave the filter mode to None. For example, if you select Card number as the Filter index, leave the
filter mode to None so that all events triggered by cards will appear in the report.
7 To add information in the sort criteria, select an item from the Additional information drop‐down list.
NOTE: Repeat these steps for all the card information fields that are listed in the filter index field. You
could use the card user name and specify A to F in the Upper/Lower boundary fields for the system to
include events in which the defined card numbers appear but only for card users whose names begin
with A to F (G and up will not be included even if the card number is included in the range).
8 Select the Card type tab if it is displayed, then specify the Card types that will be included in the report.
This tab appears if you have checked the Use card type filter option.
270 Reports
9 Select the Automatic report schedule tab to specify information for automatic reports. For details, see
"Defining Automatic Report Schedules" on page 263.
10 Select the Rules tab to define the rules of In/Out in employee time reports. Rules can be created to
define periods of time as specific values. For example, all employee entries between 7:50 AM and 8:15
AM can be defined as the value of 8:00 AM on reports.
• Select the Keep only the first entry (first IN) and the last exit (last OUT) option to get the time
lapsed between the first reading of the card on an entry reader and the last reading of the card on an
exit reader.
Operations on In/Out
Use the Operation on In/Out feature to manually insert, add or delete In/Out transactions in the
database. This feature is useful for an organization using the In/Out feature for the payroll system, for
instance.
3 Select the View deleted transactions option if you want to view the transactions that were previously
deleted. Deleted transactions are marked with an “X” in the Delete column.
4 Check the Find deleted cards option if you want to find the deleted cards. This does not apply to entries
that were added manually.
5 Specify the Start date, the day on which the system will start to collect the events, by clicking the
Calendar icon and selecting a specific date. Only events that occurred on this date and after are
displayed.
NOTE: The Start date is mandatory to start loading.
6 Specify the End date, that is the day and time on which the system will stop collecting events. Only
events that occurred on the specified date and before are displayed. If you do not specify an end date,
the system will include all the data up to the present day time.
7 In the Site drop‐down list, select the appropriate site to view the In/Out doors.
NOTE: The gateway is mandatory to start loading.
8 You may check the All Doors option, then all the doors displayed under this field will be selected. You
may also select specific doors. All the In/Out events that were generated for the selected doors will be
displayed.
9 Check the View deleted doors option so that even doors that are no longer defined as In/Out doors (but
that have been defined as In/Out) will be displayed.
NOTE: Doors are mandatory to start loading.
10 Enter the necessary information in the transaction table. The transaction table displays the transactions
for the selected cardholder:
• The Delete column indicates transactions that have been deleted (if the View deleted transactions
option is checked). These are identified by an X.
• The Date column indicates the date on which the transaction occurred. Use this field to specify the
date when you manually insert a new transaction.
• The Time column indicates the time at which the cardholder entered or exited an area. Use this field
to specify the time (entry or exit) when manually inserting a new transaction.
• The Transaction column indicates the transaction type. For every entry transaction, there should be
an exit transaction.
• Entry—indicates that this is an entry transaction generated when a cardholder presented his/
her card at a door defined as entry.
• Exit—Indicates that this is an exit transaction generated when a cardholder presented his/her
card at a door defined as “Exit”.
• Manual entry—Indicates that this is an entry transaction that was manually inserted or added in
the system. When you manually insert a transaction, you have to specify if this transaction is an
“Entry” transaction or an exit transaction. For every entry, there should be an exit.
• Manual exit—Indicates that this is an “exit” transaction that was manually inserted or added in
the system. When you manually insert a transaction, you have to specify if this transaction is an
entry transaction or an exit transaction. For every entry, there should be an exit.
272 Reports
• The Door column indicates which door was accessed by this user. When you manually insert a
transaction, you have to specify the door according to the transaction type (Entry or Exit).
NOTE: If you are inserting an entry transaction, only doors defined as “Entry doors” will be displayed in
the list. If your are inserting an exit transaction, only doors defined as “Exit doors” will be displayed in
the list.
11 Click the Load button to load the transactions from the server for this cardholder. You have to enter the
card number, select the gateway/site and door(s), then click the Load button. The button is disabled once
you have loaded the transactions.
12 Click the Add button to add a transaction to the existing transaction list. The new transaction will be
added at the end of the list.
13 Use the Insert button to insert a transaction between existing transactions or above any transaction.
14 Click Cancel to cancel any insertion or modification that was made BEFORE saving.
NOTE: When you delete a transaction that was added manually, it is permanently deleted from the list;
as opposed to transactions that were generated by controllers. When they are deleted, they are
identified by an X in the Deleted column.
The roll call report is handled by the EntraPass Server. In order to operate properly, the server and the
gateway must be running. This allows an accurate reading of the card holder location and for the system
to react on a triggered input. The EntraPass Global, the Corporate Server and the Workstation may run
as services on Windows. The Roll Call functionality is available in both application and services.
Functionalities
• A maximum of 8 roll call reports can be configured through EntraPass.
• Doors must be assigned to a report number (1‐8) in order to be considered for the roll call report (see
"Doors Configuration" on page 88 for more information).
• At runtime, the Roll call report will list all individuals that have swiped a card at a pre‐defined reader. No
other card holder will be shown in the report than the ones who have entered a perimeter after the last
perimeter reset.
• To create an “in‐out” functionality, the operator must make sure that doors considered “out” of a
building or site have a different roll call number. Any door that doesn’t have a number assigned to it will
have no effect on the location of the card holder for the roll call report.
• A configurable reset of the report is available and the default value is 12:00PM (midnight) every day. This
function cleans the report. Reset can be performed for all reports in the roll call report window.
• Upon manual request in Report –> Roll Call Report or on trigger of a pre‐configured input, a report can
be generated up to 3 times to a pre‐defined printer, workstation or email address.
Reports 273
Report State
Use the Report state feature to display a list as well as the status of all requested reports that are still
pending. From the Report tool bar, click on the Report state icon:
Archive Viewing
The Archive feature enables users to view the reports that were defined and saved in the system.
Operators can use it to view reports in any format, or to customize a report before printing it.
NOTE: When you create a report (csv, db or dbf), the system automatically creates an associated rdf
file. This rdf file is the one that is listed in the Archive window. When you click “Preview”, the system
automatically launches the appropriate program to view the report.
Displaying a Report
1 Under the Report toolbar, click the Archive icon. The system displays the default destination folder. If the
report was saved in a different folder, browse the disk, using the scroll‐down arrow (bottom of the
window) to the report you want to display.
2 Select the report you want to view. If there is a printer installed, the Preview button is enabled. It is used
to preview the report before printing it.
NOTE: You must have a printer installed on your computer in order to preview or print reports. To setup
a printer, click on Start > Settings > Printers > Add Printer. For more information, consult your system
administrator.
3 Click the Details button to display information about the report. If you click the Details button, the
Report details window appears, displaying information related to the selected report file such as the
report filename, title, type, date, etc. The Workspace as report filter field indicates whether the report
has been filtered according to the requester’s workspace restrictions.
4 Click the Details button again to close the Report details window.
5 Click the Preview button to view the report in the system displays the Report preview window.
Previewing Reports
1 From the Archive window, select the report you want to view in the right‐hand pane. If you select a
report generated by Sybase, the Report Options window will display allowing you to customize your
report before printing it.
NOTE: If you select a CSV type of report, the report will be generated in a WordPad window, in text
format.
Reports 275
2 Define the filter options: enter a text string in the Search description field. The report will be sorted
leaving only events containing the specified text string. You may refine your filter:
• Contains: All events which contain the specified text will be included in the report.
• Starts with: All events which start with the specified text will be included in the report.
• Ends with: All events which end with the specified text will be included in the report.
• Exact words: All events containing the exact specified text will be included in the report.
3 Click on the Preview button, select a printer from the drop‐down list and click OK. The system displays
the result of the report. From that window, you can:
• Search text within the report
• Print a report
• Save a report in various formats such as PDF, RTF, HTML and TXT
• Load a report (in a.QRP format)
4 Click Properties to access the Reports details window where detailed information is displayed:
• Report filename: Displays the whole path where the report was saved as well as its name.
• Report title: Displays the title of the report.
• Start date: Reports are created for a selected time frame. This option specifies the starting date of
this time frame.
• End date: Reports are created for a selected time frame. This option specifies the ending date of this
time frame as well as the time.
• Requested: Displays the date and time at which the report was requested.
• Delivered: Displays the date and time at which the report was produced and printed.
• Requested by: Displays the name of the operator that requested the report.
• Count: Displays the number of transactions (lines) in the report.
• Output process: Displays a list of the possible templates used for this report.
• Sort by—You may choose a sort order, by user names, or by card numbers.
• Report type—Select this option for easier management. You may choose to include details with or
without total.
3 Click Preview to display the result of the report. From that window, you can save the report (in.QRP
format) or print the report.
EntraPass Options 277
EntraPass Options
The Options Toolbar
The Options toolbar offers users the ability to change a number of system parameters. These include
changing the display format, the authentication password, the date and time, or changing server
parameters. The following menu options are available from both the Workstation and the Server
toolbars:
The following utilities are only available from the EntraPass Workstation application:
• Configure printer options (log and badge printers)
• Configure multimedia devices (alarm, video and signature capture settings)
• Configure custom Messages
• System registration
• Verify server database
• Verify workstation database
• Hexadecimal: Each hexadecimal digit represents four binary digits. An hexadecimal format refers to
the base‐16 number system, which consists of 16 unique symbols: the numbers 0 to 9 and the letters
A to F. For example, the decimal number 15 is represented as F in the hexadecimal numbering
system. The hexadecimal system is useful because it can represent every byte (8 bits) as two
consecutive hexadecimal digits. It is easier for humans to read hexadecimal numbers than binary
numbers.
• FIPS (Federal Information Processing Standard): This card format can use more than 32 bits of data.
3 Check the Use multiple card format box if your environment contains multiple reader types and you
would like to have the capability to select a different reader, that is not the default reader, when creating
a new card.
4 Select one of the Duplicate PIN process in the scrolling box. This feature can be used for example while
loading cards in a batch. An operator may decide to set the PIN option to allow duplication. Later, if
desired, the duplicate PINs can be changed to prevent confusion.
• No duplication: An error appears on the workstation; the PIN field will be reset to the default value
(00000) and will be highlighted, inviting you to enter a new and valid PIN. Only PIN 00000 will be
duplicated regardless of the PIN setting option.
• Notify when duplication: the server verifies if this PIN already exists. If the PIN exists, a message box
appears, indicating that the PIN exists. A Details button will allow operators to view a list of
cardholders who were issued this PIN.
• Duplication: no test will be processed, the PIN will be accepted even if it is a duplicate.
5 Number of PIN digits (KT‐400 only): This function allows using the Keypad Pin Digit option with the new
KT400 firmware. You can choose to have 4, 5 or 6 digits (See "Card Options Definition" on page 173 for
more information).
NOTE: The PIN number must be set up once and kept that way in order to avoid any in duplication if
truncated or filled by the system.
6 When the Enhanced User Management option has been chosen, select an alternate default display
format for Card #2. Repeat Step 6 for Card #3, Card #4 and Card #5.
7 Under the Global display format for KT‐100, KT‐300 and KT‐400, select the appropriate option to
coordinate with the selection in the upper section of the dialog.
• 24‐bit Wiegand card, 5‐digit PIN (KT‐200 default): for up to 24‐bit for KT‐100, KT‐200, KT‐300 and KT‐
400.
• 32‐bit card, 5‐digit PIN: for up to 32‐bit for KT‐100, KT‐300 and KT‐400.
• 24‐bit Wiegand card, 6‐digit PIN: for up to 24‐bit for KT‐100, KT‐300 and KT‐400.
• Up to 16 characters ABA card, 6‐digit PIN: for up to 16 for KT‐100, KT‐300 and KT‐400.
NOTE: KT‐100, KT‐300 and KT‐400 controllers will do a hard reset on card format change. Avoid
alternating between different card formats because this may result in lost card information.
EntraPass Options 279
CAUTION:
Keep in mind that there is no way to reset the connection
password if forgotten after its modification.
NOTE: If you are not using a specific password for authentication, then the user will have to use the
master default password for workstation authentication. The default connection password is kantech,
in lower case. Passwords are case sensitive.
2 From the Select primary language drop‐down list, select the language you want to use as a primary
language. From the Select Secondary language drop‐down list, select the language you want to use as a
secondary language.
3 Log out of EntraPass and login again.
1 From the Printer options window, select the Report printer tab.
4 Select a Priority level for the selected sound so that it is played when an alarm defined with this priority
is sounded.
NOTE: The Priority level refers to the order in which alarm messages are displayed in the Alarm
desktop. In EntraPass, O is associated with the highest priority, and 9 to the lowest.For more
information, see "Event Parameters Definition" on page 227.
5 Click the Play button to listen to the selected sound. The system will play the selected sound.
6 Click the Add button to add a new sound from your personal files. Clicking on this button displays a new
window allowing you to add new alarm sounds.
NOTE: The Current selection section displays the sound currently selected (in use). You can adjust the
delay of the alarm sound in the Delay field.
• The Video bandwidth control option allows you to reduce or increase the bandwidth required to
stream live video without compromising video storage quality and computer performance. The
range value is between 64 KB/s and 8192 KB/s.
NOTE: The video bandwidth control value cannot exceed the EntraPass Server value (see page 476).
Server Parameters
Under the Server tab, you will define server logs capacity, diagnostic capabilities, security parameters,
disk free space threshold, network alarms and icon status.
Server Logs
You can define the maximum number of records to store in the system logs and the system error logs (up
to 100,000). Records include transactions such as: login to server, logout from server, disconnection,
connection, stop or start server, registration requested, etc. These records are kept with the date/time,
the workstation (where the event or error came from), the operator and the description of the
transactions.
Disk Space
The Disk Space feature has been developed as a protection against system failures that may be caused
by the lack of disk space. This feature allows you to monitor the amount of free disk space for optimal
system operation or for generating reports. In fact, EntraPass offers the ability to have the system abort
the execution of a report if the free disk space has reached a specified threshold.
• Disk free space threshold (MB) scroll‐down list: specify a disk free space threshold that indicates when
you want the system to send a message when the amount of free space falls below the value indicated.
This value is in mega bytes. The range value is 2000 up to 99999 MB.
• Time between notifications (hh:mm): enter the amount of time between notifications when the disk free
space has reached the quota specified in the Disk free space threshold field. For example, if you enter
00:30 in the field, a system warning will be displayed every half an hour. The time range value is 00:10 to
24:00.
• Quick backup: When this option is checked, the main server do not close the tables during the
synchronization with the mirror database. Messages can still be received and the database viewed. A
yellow icon is then displayed on the left to indicate that the system is in read only mode.
Redundant Server
NOTE: The Redundant Server component will be available only if it has been previously registered.
284 EntraPass Options
You can define the Auto‐restart delay (m:ss) for the Mirror Database and Redundant Server. The time
range value is 1:00 to 9:59.
Quick synchronize: When this option is checked, the main server do not close the tables during the
synchronization with the mirror database. Messages can still be received and the database viewed. A
yellow icon is then displayed on the left to indicate that the system is in read only mode.
NOTE: The MS/SQL Interface program is not supported by the Mirror Database and Redundant Server.
Even though the MS/SQL Interface cannot connect to the Mirror Database and Redundant Server, the
MS/SQL Interface will buffer all the events.
Schedule
The Schedule tab is where you will be able to upgrade to advanced schedule capability. In fact, EntraPass
offers users more flexibility and ease of use by grouping schedules per gateway, site or system logical
components. This option is not automatically enabled upon installation of version 3.18 and higher of
EntraPass.
NOTE: Make sure that you really need to upgrade to advance schedule before checking the box.
Schedules are grouped as follows:
• System schedules: System schedules are applicable to system logical components such as: event
parameters, operators login schedules, video triggers, etc. System schedules are not loaded in a
particular controller; they are applicable to all the system. You can program an unlimited number of
system schedules.
EntraPass Options 285
• Corporate site schedules: These are defined per site. You can define 100 schedules per Corporate site for
such purposes as power supervision (controllers), door unlocking, REX trigger (doors), activation mode
(relay), input monitoring, etc.
• After checking the box and clicking OK, a warning will popup on screen indicating that the action is
reversible but with consequences.
• We strongly suggest that you perform a backup of your data before activating this option.
• Once the process has been completed, you will notice that the Schedule tab will have disappeared from
the System Parameter dialog.
• Extend schedule interval to 20: This feature (for EntraPass and WebStation 5.01) allows increasing the
number of schedule intervals to 20. Clicking OK will display the following warning message:
A validity test will be performed by EntraPass to ensure that existing schedules are not linked with
controllers other that KT‐400. In addition, the following rules need to be followed:
• A 20 intervals schedule can be changed to 4 intervals but not the opposite.
• For Multi‐site gateways, 20 intervals schedules are compatible with KT‐400 and KT‐400 V1
controllers only.
20 intervals schedules that are not supported cannot be selected. The icon is displayed at the right
side of the field.
NOTE: Schedules with 20 intervals can be used with KT‐400 and KT‐400 V1 controllers only.
Diagnostic
The diagnostic feature allows the system to make network diagnostic.
• Allow diagnostic on network uses the PING (Packet INternet Groper) utility program. This stand‐alone
program diagnoses network intermittent related problems and/or determines whether a specific IP
address is accessible. For details on the PING program, see "System Utilities" on page 305.
286 EntraPass Options
• Show system database reference will display system components unique numbers. For example, if you
are in the Door dialog, you can view the door number by placing your mouse cursor over the Door scroll
list. A hint will pop up to display the component’s (door) unique number.
Icon Status
The Status time out delay (m:ss) parameter allows you to define a period of time before the workstation
queries the server for the latest icon statuses. The higher the delay, the lower the icon refresh rate will
be therefore creating less traffic on the network. The maximum time out delay is 1 min. 30 seconds.
Firmware Parameters
This section contains all the information pertaining to controllers, gateways and IP communication
module, as well as the section to update you firmware.
NOTE: The KTES tab will be available only if a KTES controller have been previously defined in the
system. See "Kantech Telephone Entry System (KTES) Configuration" on page 80 for more information.
KT‐100
The KT‐100 tab specifies the location of the folder containing the firmware for KT‐100 controllers. The
system will use this data to update the installed controllers.
KT‐300
The KT‐300 tab specifies the location of the folder containing the firmware for KT‐300 controllers. The
system will use this data to update the installed controllers.
KT‐400
The KT‐400 tab specifies the location of the folder containing the firmware for KT‐400 controllers. The
system will use this data to update the installed controllers.
• When checked, the Enable TFTP KT‐400 updater option will allow operators to upgrade the KT‐400
firmware from the Update firmware button from the Operation > Site dialog in EntraPass.
EntraPass Options 287
• Enable automatic firmware update: Select to make an update of each KT‐400 with a different firmware
version.
NOTE: The automatic firmware update function applies only to KT‐400s that support it.
NOTE: The Multi‐site Gateway must be restarted in order to enable the TFTP KT‐400 updater.
• For security reasons, you may decide, as a System Administrator to disable this option and not allow
operators to update the firmware.
KTES
The KTES tab specifies the location of the folder containing the firmware for the KTES. The system will
use this data to update the installed KTES.
Kantech IP Link
The IP Link tab specifies the location of the folder containing the firmware for the Kantech IP Link
module. The system will use this data to update the installed firmware.
• When checked, the Enable TFTP IP Link updater option will allow operators to upgrade the IP Link
firmware from the Update firmware button from the Operation > Site dialog in EntraPass.
NOTE: The Multi‐site Gateway must be restarted in order to enable the TFTP IP Link updater.
• For security reasons, you may decide, as a System Administrator to disable this option and not allow
operators to update the firmware.
KT‐401
The KT‐401 tab specifies the location of the folder containing the firmware for KT‐401 controllers. The
system will use this data to update the installed controllers.
• When checked, the Enable TFTP KT‐401 updater option will allow operators to upgrade the KT‐401
firmware from the Update firmware button from the Operation > Site dialog in EntraPass.
• Enable automatic firmware update: Select to make an update of each KT‐401 with a different firmware
version.
NOTE: The automatic firmware update function applies only to KT‐401s that support it.
NOTE: The Multi‐site Gateway must be restarted in order to enable the TFTP KT‐401 updater.
• For security reasons, you may decide, as a System Administrator to disable this option and not allow
operators to update the firmware.
Image Parameters
The Image section is where you will define parameters for the badging features. You will define image
quality for picture, signature and background images.
• If you are using the badging feature, it is recommended to leave the jpeg quality to default. Reducing the
image quality may affect the quality of the pictures imported from badges.
288 EntraPass Options
• If you are not using the badging feature, you may reduce the jpeg quality of your images so that they will
not occupy a large space in the database. You must take in consideration, however, that reducing the
quality of the saved images may affect the quality of the photos imported into badges.
A parameter allows you to save cards and visitor card pictures, signatures and background graphics to a
file instead of directly to the database. We are offering this option for sites that have large banks of
pictures and graphics. The picture, signature and graphic database can currently contain up to 2 Gb of
data each. The parameter will be used in instances where a site may need more space to save pictures,
signatures and graphics.
Graphic
The graphic feature allows you to adjust the graphic quality for use with the EntraPass software.
• Unchecking Use JPEG format for graphics tells the system to save graphics in a tiff format.
NOTE: Remember that this may affect the image quality. If you are not an advanced user, leave these
values to default.
• The JPEG quality value for Graphic background (picture) indicates the quality of the image that will be
saved. If you choose 10, the saved image quality will be poor; 100 indicates an excellent quality.
EntraPass Options 289
• When checking the Save graphics in a file box, the system will create a Graphic directory under
C:\Program Files\Kantech\Server_CE\Data where all graphics will be saved instead of directly in the
database.
NOTE: When modifying an existing graphics, EntraPass will save it to the appropriate file and delete
the corresponding entry in the database.
Report Parameters
The Report tab enables users to define the field separator for reports, disk free space threshold and user
name format.
CSV
Under the CSV tab, you can define the field separator for your reports.
• By default, the system uses a comma (,) as the Field separator. You can modify the comma for another
character. Other options are: Period, Equal, Semicolon, Colon, Space and tab.
• It is recommended to check the Date and time on separate fields option. When selected, CSV (comma
separated values) as the output process for your reports, by default, the system includes the date and
the time in a single field. When you select this option, the system will separate the date and the time
fields.
Disk Space
This feature is a protection when for instance a huge report has been requested. In this case, the system
will abort the execution of the report and displays an alert message indicating the reason of the
cancellation.
• Abort report if free space lower than (MB) scroll‐down list allows you to specify the minimum amount of
free disk space required for the execution of reports. The range value is 2000 to 999,999 MB.
• Maximum event for email report scroll‐down list allows you to specify the maximum number of events
that can be sent via an email report. The range value is 100 to 100,000 events.
• Maximum event for standard report scroll‐down list allows you to specify the maximum number of
events that can be sent in a report. The range value is 1000 to 500,000 events.
• Strict search on card field should be left empty unless you wish to keep the previous method (EntraPass
Version 3.17 and lower) of strict searching a card field for reports.
NOTE: Prior to version 3.18 of EntraPass, the system used a strict search method that required
Administrators to enter specific upper and lower boundaries to attain specific results. For example, for
generating a report that included all users whose last name started with A, the lower boundary had to
be A and the upper boundary had to be AZZZZZ. Now, the system will display all user names that start
with an A just by entering A as a lower and upper boundary.
Video Parameters
The Video section will display only if the Video integration option is enabled in the EntraPass system.
You will define the time synchronization, remote video process and JPEG format for video images.
Parameters
The Parameters tab allows you to define parameters for the video process.
• Disable manual time synchronization will keep the EntraPass server from updating the video server date
and time following a manual modification of time. This feature is useful when, for example, you want to
keep all recording events that occurred at the video server regardless of the actual time at the EntraPass
server.
• The Remote video process control parameters section contains parameters that define remote
management of video processes between the EntraPass Server and the video servers connected to
EntraPass. It manages all the tasks (controls) related to: recordings, polls, events, and presets and
patterns.
• Preset and pattern control application field allows you to enter the number of applications that will
be simultaneously launched for processing presets and patterns. The system is preset with a range
value of 1 to 8 concurrent applications.
NOTE: A Preset and Pattern Control application is launched each time a video recording is started
following a trigger on a preset. If you set this number to 1 and if there are for instance more than 1
video servers with presets and patterns defined, the control application will process presets on all
video servers. If you decide to increase the number of Preset and Pattern Control Applications, keep in
mind that running many concurrent applications takes a great amount of system resources.
• Reset remote video process application will allow the system to terminate and automatically restart
the Remote Video Process application a few seconds later. This option may be used in instances
when the video events are not being displayed.
• Reset remote video process applications control will allow the system to terminate the Control
applications (recordings, polls, events and preset and patterns) and automatically restart the Remote
Video Process application.
• Log Video process error will allow the system to keep a log of all video process errors in the
EntraPass server files. Video process errors are logged in C:\Program
files\Kantech\Server_CE\Bin\Log. Each Remote Video Process Control application generates a log
file:
• RVP_LOG_00.txt (errors generated by RVP0.exe)
• RVPPoll_LOG_01.txt (errors generated by RVPPOLL1.exe)
EntraPass Options 291
Snap
The Snap option allows you to define the image quality that will display in the video thumbnails.
• The Video image snap indicates the quality of the image that will be saved as a thumbnail for each video.
If you choose 10, the saved image quality will be poor; 100 indicates an excellent quality.
Intellex
The Intellex options allow you to define the bandwidth allowed for the video process (for Intellex only).
• Disable DirectX will disable DirectX, a Windows® technology that enables higher performance when
working or viewing graphics and other multimedia contents, including video and sound. By default,
DirectX is enabled with the Video feature. You may sometimes need to disable it if, for example,
video images are not correctly displayed or are not displayed at all.
NOTE: The system will use more system resources when DirectX is disabled
• Limit video bandwidth allows you to reduce or increase the bandwidth required to stream live video
without compromising video storage quality and computer performance. The range value is between
64 KB/s to 8192 KB/s. The value will apply to all workstations including the EntraPass Server.
However, for any specific workstation, this value can be reduced locally from the Options toolbar >
Multimedia Devices > Video on page 282.
• Video vault save delay is used to indicate the time delay before the video vault recording can be
played back.
NOTE: The workstation value cannot exceed the EntraPass Server value.
HDVR
• Video vault save delay is used to indicate the time delay before the video vault recording can be
played back.
TVR
• Video vault save delay is used to indicate the time delay before the video vault recording can be
played back.
292 EntraPass Options
Time Parameters
The Time section allows you to specify which gateway will be used to automatically adjust the time of all
the computers connected to the EntraPass server. This feature is very useful when managing remote
sites.
NOTE: The gateway polls the first controller on the first site at 5:47 am or 05:47, 1:47 pm or 13:47 and
7:47 pm or 19:47 to get the controller time.
• No time adjustment will disable the option.
• By Gateway will automatically synchronize the time of all computers with the Gateway selected in the
scrolling list.
• By Server will automatically synchronize the time of all computers at regular intervals. You must also
select the rate of Hours between refreshes in the adjacent selection box. The range value is 1 to 9999
hours.
Credentials Parameters
Card
Under the Card tab, System Administrators will be able to migrate their EntraPass system to enhanced
user management where users are managed by their user name as well as their card number(s). Each
card holder will be handled by user name and have up to 5 different numbers. This will allow for creating
cards without assigning card number to the new cards, see "Issuing a New Card in Enhanced User
Management Environment" on page 168. This option will be used with the EntraPass WebStation for
card management. For more information on the EntraPass WebStation, please refer to the EntraPass
WebStation User Manual, DN1709.
NOTE: Enabling the migrate to enhanced user management is NOT REVERSIBLE through the software.
However, when the system is migrating data, a backup is performed in EntraPass, so this can be
restored to return to its previous action.
• Migrate to enhanced user management: when checked, EntraPass will migrate to the enhanced user
management (See "Issuing a New Card in Enhanced User Management Environment" on page 168
for more details).
After checking the box and clicking OK, a warning will popup on screen indicating that the action is
irreversible before EntraPass performs a backup of your data.
Once the process has been completed, you will notice that the option is greyed out under the Card tab.
EntraPass Options 293
Toolbar Buttons
The toolbar buttons size can be increased up to 2.5 times the original size, in order to improve visibility
of the text below the button. This is applicable to the EntraPass Server and the EntraPass Workstation.
Logout and log back in to apply the change to the toolbar.
Integration
The Integration tab allows the user to select third party hardware that has been integrated to EntraPass
by Kantech.
DLL registration: The available DLL in this menu will be used to specify which type of hardware the
customer will connect to EntraPass.
• Click on Add to integrate another DLL. For additional details, See Chapter 4 ‘Integrated Panel
Configuration’ on page 103.
NOTE: The DLL integration must be done at the EntraPass Server in order to communicate with the
Multi‐site Gateway where the third party hardware is physically connected and powered up.
Virtual keypad: The Virtual keypad tab allows the user to customize the virtual keypad screen display.
Three different display modes can be selected: Floating, Modal or Stay on top.
Dealer Information
Kap Reminder
A message will be displayed reminding the user that the KAP period is ending. There are two different
notifications: a pop‐up on the screen or an email containing the following information:
Pop‐up Message
A pop‐up message is automatically generated by EntraPass to advise the user that his KAP is expiring:
• 60 days before expiration
• 30 days before expiration
294 EntraPass Options
• On expiration
• 30 days past expiration
The reminder message has to be acknowledged by the user. It will be logged in the events database (displayed in
the Message List) and will appear in reports.
The Dealer Information window has been modified in order to configure the email reminder. Up to 4 recipients
can be added. Clicking the Send reminder now button will save the information and send a reminder immediately.
An new event will also be logged in the desktop events list.
Each workstation will also receive a 60 seconds notification popup message.
The Kap Reminder feature can also be accessed from the About window.
Backup Scheduler
A backup is a copy of the systems database which serves as a substitute or alternative in case the
computer fails. If your system computer fails, you may restore a backup copy onto another computer (on
which the EntraPass Server application has been installed).
• Back up your files regularly, at least once a week or more if many modifications were made to the
database.
• We recommend that you make two backups of all your database files. To be especially safe, keep them in
separate locations.
• To backup your files, you can use:
• the menus of the Server/Backup Tab, or
• the Backup Scheduler to apply automatic schedules, or
• other third party software and hardware (the third party software is not recommended).
NOTE: By default, when you backup or restore files, the Server databases will temporarily be disabled
(not available). The Workstations will not be able to modify the databases.
The Backup Scheduler program is used to schedule automatic backups of your data, archives, and In/Out
databases. Define the default settings and the system will do the rest.
EntraPass Options 295
• Self‐extracting compressed file (full backup): will create an executable file (*.exe) that will
compress the information so as to reduce the amount of disk space taken by the backup.
• Separate files (incremental): will backup all databases. Only the information that was modified
since the last backup will be saved.
• Self‐extracting compressed file (incremental): will create an executable file (*.exe) that will
compress the information so as to reduce the amount of disk space taken by the backup. Only
the information that was modified since the last backup will be saved.
NOTE: Restoring a self‐extracting backup after an EntraPass upgrade can only be done from the
EntraPass Server where the original self‐extracting backup was done.
NOTE: When you have selected “full backup”, each time a backup is done a new sub‐folder containing
the data or the self‐extracting file will be created. If you are using the incremental backup type, only
the information that was modified since the last backup will be saved. If you want to restore
information, you will have to restore all the sub‐folders one‐by‐one (starting from the oldest).
6 Select the frequency of the backup,
• Weekly: the backup will be carried out once a week. Specify which day (example, the backup will be
executed every Thursday).
• Monthly: the backup will be carried out monthly, specify the day of the month (example, the backup
will be carried out every first day of the month).
• Daily: the backup will be carried out every day.
• Now: this option allows you to request a backup when you need it.
7 Enter the time at which the backup will start (24:00 format).
8 Repeat steps 1 to 8 for all the remaining tabs.
9 Click on OK to save.
Custom Messages
The Custom Messages option allows operators with proper security rights to define custom messages
that can generate an event based on a schedule. Up to 10 custom messages can be programmed to
trigger an event at a preset time. And each custom message can be triggered when the schedule
becomes valid, invalid, or both. In other words, you can trigger up to 20 custom events if you take into
account the start and/or end of a schedule interval.
Each custom events will be displayed in the Messages List on the Desktops.
System Registration
This menu is used to register new system components such as the KTES, Workstation, Gateway,
SmartLink, etc. in order to register and use the system's database and to establish communication with
the Server.
NOTE: For more information on how to install and register new applications, See Chapter 2 ‘Software
Installation’ on page 9. Before you install new applications, make sure that you have the proper serial
numbers for the installation.
Workstation Database
1 From the Options toolbar, click the Verify Workstation DB icon. The system displays a warning.
2 Select Yes to continue.
NOTE: This is a surface operation. If your system is experiencing problems, you must run the Database
Utility program from the W indows® Start menu. For more information, See "Verifying Database
Integrity" on page 306.
298 EntraPass Options
The EntraPass Server 299
Server Launch
In order to access the EntraPass Server commands, you have to start the Server and login. Operators are
identified when they log in. This allows them to have access to the security system menu associated with
their security level, and to establish communication and initiate interaction with the workstations.
However, it is not mandatory to login for the Server to operate.
1 From the Windows® Start menu, click Start > All Programs > EntraPass Corporate > Server > Server. You
may also click the Server icon on the desktop, if applicable. After loading itself, the server login screen
will display on the screen.
2 Enter your User name and Password (case sensitive) and click OK to continue. To modify this password,
see "Operators Definition" on page 215.
NOTE: To allow an operator to login to the server, select the “Allow login on server” option, during the
Security Level definition of an operator. For more information, see "Security Level Definition" on page
218.
The status bar at the bottom of the screen indicates the communication status and the colored flags
represent the status of a system logical or physical component: Green indicates that communication is
ok, Red indicates that theirs communication problems, Purple indicates that the database is locked for
authentication.
• Database availability state
• Database locked state: it turns red when the database is locked
• System date and time
• Login name of the operator who is currently logged in the Server
• Number of client connections, that is, the number of workstations connected to the server
• Number of system logs (messages and events)
• Number of error logs
• Computer name (NetbEUI) where the server is installed
300 The EntraPass Server
• Server’s IP address
• Secondary IP address, if the Mirror database and Redundant server communicate with the server
through a TCP/IP connection and if they are configured in the system
• Other IP address, if applicable.
Backups
The Backup Toolbar
A backup is a copy of your system database which serves as a substitute or alternative in case the
computer fails. Backing up your files safeguards them against accidental loss when for example the hard
disk fails or when you accidentally overwrite or delete data. If your computer system fails, you may
restore a backup copy onto another computer, on which the EntraPass server has been installed.
The EntraPass Backup tab allows operators to perform manual backups of the system data (D), archive
(A) and In/Out (T) databases. It is also used to restore backup data. Safeguard tips:
• Back up your files regularly, at least once a week or more if many modifications were made to the
database.
• We recommend that you make two backups of all your database files. To be safe, keep them in different
locations.
• To backup your files, you can use:
• The menu of the EntraPass Backup utility, or
• The EntraPass Backup Scheduler to apply automatic schedules parameter, or
• Other third party software and hardware.
NOTE: By default when you backup or restore files, the EntraPass database will temporarily be
disabled.On the EntraPass application main window, you will notice that the second colored square at
the bottom left of the screen turns red when the database is unavailable. Modifications done on the
workstations will not be applied to the database until the database is available again.
All the system data can be found under the following path: C:\Program Files\Kantech\ Server_CE\XXXX.
If you are using a third party program to perform backups, it is recommended to backup the whole
Kantech directory and sub‐directories. Each time a backup is done (even if it is done automatically), a
The EntraPass Server 301
new sub‐folder containing the data or the self‐extracting file is created. If you are using the
“incremental” backup type and you want to restore information, you will have to restore all the sub‐
folders one‐by‐one (starting with the oldest).
1 Select the View system errors icon to view all the errors that occurred in the system.
2 You may also use the right‐click menu to change the window background or to clear all the data
displayed.
NOTE: For information on system registration, see "System Installation" on page 14.
System Registration
This menu is used to register new system components such as the KTES, Workstation, Gateway,
SmartLink, etc. in order to register and use the system's database and to establish communication with
the Server See "System Registration" on page 297.
Server Utilities
This menu allows users to verity the system database integrity and to restore the system data bases. This
menu is also accessible from workstations. For more information on the system utilities, See Chapter 16
‘System Utilities’ on page 305.
1 Select the Utility toolbar to use the server utilities.
2 Select an icon in the toolbar (according to the task you want to perform, such as, for example, Verify
database integrity. The appropriate dialog will display on screen.
3 Click the Yes button. The system automatically starts the operation and displays a progress bar indicating
that the process is on‐going.
NOTE: Certain windows may provide only a Yes or No button rather than a Rebuild button to start the
operation.
NOTE: The Clean database utility also provides a Yes or No button to clear records from the database
relating to previously erased data.
304 The EntraPass Server
System Utilities 305
System Utilities
This section groups the utility programs of the EntraPass Software. These programs are accessible from
the Windows® Start menu. The following programs are launched from the server or the workstation.
• Database Utility — Program intended to re‐index archived files, update database fields, verify archived
files, verify the database integrity, verify the database index, verify the database links and to verify the
database hierarchy while the server is shutdown.
• EntraPass Video Vault Application — Program used to manage video segments archive. This program
will process requests from EntraPass users to view archived video segments and to monitor video
archiving processes.
• Express Setup — Program used to configure all the components related to a gateway including the type
of readers used, type of connection, number of controller sites, number of controllers in a site, etc.
• KT‐Finder: Program used to configure locally or remotely Kantech IP devices such as the Kantech IP Link,
the KT‐400 Ethernet Four‐Door Controller and the KT‐NCC Network Communications Controller (Note).
NOTE: The KT‐NCC Network Communications Controller is only available with EntraPass Global Edition.
• PING Diagnostic — Program used to diagnose network intermittent related problems.
• Quick Report Viewer — Program used by the operator to view reports without having to start EntraPass.
• System Report Viewer — Program used by the operator to view reports without having to start
EntraPass. This utility is installed from the Setup window.
• Vocabulary Editor — Program used to translate, in the language of your choice, the display text of the
software.
• Workstation — Configuration program, similar to a standard workstation, used by the system
administrator to configure the system logical and physical components.
• Migration Utility — Program used to transfer database information for the upgrade from Special to
Corporate Edition or Corporate Edition to Global Edition.
• The Oracle/MS‐SQL Interface — The MS‐SQL Interface is a program that creates a real‐time copy of the
EntraPass card database in the MS‐SQL or ORACLE Server. This program allows user to modify, add or
obtain card‐related information, all this in real‐time, from the MS‐SQL or ORACLE Server. The Oracle/MS‐
SQL Interface card database, which contains cardholder information, will be updated automatically as
soon as new information is available in the EntraPass card database.
NOTE: The MS‐SQL Interface program is not supported by the Mirror Database and Redundant Server.
• The SmartLink Interface — The SmartLink interface allow users to define a message and format data that
may be sent on the second COM port or to a disk file. Using the SmartLink feature, you can interface to
just about any intelligent device such as video matrix switchers, paging systems, etc.
• EntraPass Online Help — This is the same content as the reference manual but without the screen
captures. Simply click on the (? Help) button and the corresponding topic displays on screen. The online
help language follows the primary language selection, if the EntraPass primary language is english, the
online help will be in english as well. The online help is available in five languages; english, french,
spanish, german and italian.
306 System Utilities
Database Utility
The Database utility program verifies the integrity of the database tables that are used to store events,
alarms, network alarms, and graphics. Basically, the system scans all the system database tables and
corrects errors (when they are found). Usually, the system verifies the database integrity automatically
at start‐up (a system message is displayed). If an operator decides not to perform a database check at
startup, he/she may trigger the operation later, using the Database Utility program. It may also be
necessary to launch the database utility program when for instance the system experiences problems
frequently. This operation should be executed when the system is not used since the system database is
not available during operations on the databases. Some verifications such as re‐indexing the archive
files, updating database fields, verifying archive files, or swapping database languages require that the
EntraPass applications be shutdown. Once all the EntraPass applications that are running on the
EntraPass Server computer are closed, you can start the Database utility. When an operation that
requires the application to be shutdown is launched, the operator is warned that the database access
will be suspended during the operation.
NOTE: The EntraPass Server must be shutdown before you run the database utility.
Swapping Descriptions
This function is used to interchange or to swap the database descriptions.
NOTE: To view detailed information about the numerical values displayed on the main window, login to
EntraPass Video Vault.
3 To view the list of Video servers associated with the EntraPass Video Vault application and the status of
the archiving process, select the View Video server menu item.
• Video server on line, archive period valid: During this period, the EntraPass Server retrieves video
segments from the Video server and queues them for archiving by EntraPass Vault. All video
segments originating from video triggers (automatic or manual) and segments tagged to be archived
in the Video Events List are archived in the EntraPass Video Vault.
• Video server offline, archive period valid: This status is tagged with a red flag. It indicates that the
EntraPass server cannot retrieve video segments from the Video server for various reasons. Video
segments recorded during that period will not be available for EntraPass Video Vault.
System Utilities 311
• Disk ready
• Disk space lower than 100 MB
• Network drive not available
• Cannot access this drive
5 Select Transaction log to view the list of transaction errors.
NOTE: The transaction log window shows all the transactions that have occurred in the software since
the last time it was run. The Filters fields enable users to select the type of transactions to be
displayed.
312 System Utilities
Vocabulary Editor
The Vocabulary Editor allows users to translate the display text of the software in the language of their
choice. EntraPass offers you the possibility of adding up to 99 languages for the purpose of changing the
text language in the graphic user interface. However, you can only run the software in two languages at
a time, a primary and a secondary language. If you want to use the software in a language other than
English, French, German, Italian or Spanish, you can have the database dictionary translated in the
language of your choice. You will then have to integrate the translated dictionary in the software. The
creation of a new display language is carried out in three stages:
• Translating the source text,
• Integrating the newly created language to the EntraPass dictionary in the Server,
• Distributing the new custom language to all EntraPass application.
NOTE: In order to be able to run a new language, your operating system (W indows®) must support the
desired language. For example, your keyboard (characters) and window (display) must support the
specific characters of the desired language. The computers where EntraPass applications are running
must also support the language. For more information on language support, refer to your system
administrator.
NOTE: You must make sure that the Customdictionnary directories are regularly backed up
(C:\ProgramFiles\Kantech\Vocabulary Editor\CustomDictionary\files.xxx.ath) or
C:\ProgramFiles\Kantech\”Application type”\CustomDictionary\files.xxx.0
The table below shows the value of the Vocabulary Editor color codes.
• The “Source language” column contains text based on the basic language that was selected during
the creation of the vocabulary. This column will serve as a “source” for the translation. Software
language columns cannot be modified by the user.
• Use the right‐click to enable a contextual sub‐menu or use the Language editor toolbar. A hint
appears when you position the mouse over a button.
314 System Utilities
Icon Description
Apply changes to operational dictionary: this option is useful when you want to
test your changes before you update other workstations.
Restore operational vocabulary: this option allows the user to easily restore
the default languages. It creates a self‐extracting file which restores the
original dictionary.
Scan dictionary for new entries: this option is useful when the software was
updated.
Create self‐extracting file for update: If you decide to implement the new
vocabulary. The system creates an Updatedictionary.exe file, and prompts you
to select a destination folder for the file.
1 Start the Vocabulary Editor. The Vocabulary Editor window toolbar displays five buttons.
NOTE: The Graphic User Interface will only appear in one of five languages: English, French, German,
Italian or Spanish.
2 Select a newly translated vocabulary.
• You may choose to Apply changes to the Operational dictionary: this option is useful when you want
to test your changes before you update other workstations.
• Restore the operational vocabulary: this option allows the user to easily restore the default
languages. It creates a self‐extracting file which restores the original dictionary.
• Scan dictionary for new entries: this option is useful when the software was updated for example.
3 If you decide to implement the new vocabulary, select the Actions menu, then choose Create self‐
extracting file for update option. The system creates the Updatedictionary.exe file, and prompts you to
select a destination folder for the file:
4 Select the destination folder for Updatedictionary.exe. By default, the Self‐extracting file is stored in
C:\Program Files\Kantech (application).
NOTE: It is recommended to copy the Updatedictionary.exe file on a network folder if you want
operators to access the file to update their software application.
Primary server, update it and re‐start the server. Update the Mirror database and the Redundant server,
then start the Mirror database.
have to translate the new/modified strings following a system upgrade. Therefore, you have to re‐edit
the vocabulary and create a new self‐extracting file. When you re‐open the vocabulary table, new
strings are indicated by a green point. Obsolete strings (no longer used) are tagged red.
NOTE: For easier management, we recommend that you always edit your vocabulary from the same
computer and integrate it to the system using a self‐extracting file.
The following tables summarize how input zones are used by the system for controllers.
The following tables summarize how input zones are used by the system for the KTES.
The following table summarizes how output zones are used by the system.
NOTE: The remaining components (relays and input zones) are undefined, that is, they have been
created but not yet defined. Components that are defined are grayed out. You cannot select them or
change their description. You can change their description in their respective definition menu (Devices
> Relays/Input zones).
By default, the system assumes that:
• The reader is ioProx Kantech XSF Format,
• The power supervision schedule is always valid,
• The failsoft delay is enabled for 45 seconds,
• The resistor type is none (KT‐100, KT‐300, KT‐400 and KTES),
• The wait for second card delay is 30 seconds.
320 System Utilities
Defining Relays
You may configure relays to define their operation mode, activation and deactivation schedules. If you
want to assign a name to the relay, you have to select it. When you use the Select All button, the default
names are kept.
1 Select the first relay if you want to modify its description. The relay tab is enabled. You have to check the
box beside the relay name in order to enable the language section.
2 Check the appropriate options for the Operating mode.
3 In the Automatic activation schedule drop‐down list, choose the appropriate activation schedule.
4 In the Disable relay action drop‐down list, choose the appropriate action.
Defining Inputs
By default, the response time for a REX is 250 ms; it is 500 ms for other input zones. The alarm restore
time is 500 ms by default. The Express Setup program allows you to define the Input Normal State and
Monitoring Schedule.
1 Select the first undefined input (its checkbox is not gray). Check its box to enable the language fields,
then assign names to it.
2 Choose the Input normal state option.
3 Select the Monitoring schedule from the drop‐down list. If you want to assign a custom schedule to the
selected input, you have to define it in the Definition > Schedule.
Icon Description
Use the Zoom out button to zoom out the report view.
Icon Description
Use the Quit button to quit the application.
PING Diagnostic
This stand‐alone program is used to diagnose network intermittent related problems and/or to
determine whether a specific IP address is accessible. It works by sending a packet (block) to the
specified address and waiting for a reply. The PING diagnostic program is used primarily to troubleshoot
Internet connections.
NOTE: If you want this option to be available, you have to select the “Allow diagnostic on network”
field when defining the server parameters. For more information, see "The EntraPass Server" on page
299.
1 From the Windows® Start menu, click Start > All Programs > EntraPass Corporate Edition > Workstation/
Server > PING Diagnostic.
2 From the scrolling list, select the application you want to monitor (Server, Workstation, Gateway, etc.).
3 Select the Block size from the drop‐down list. This field is used to select the amount of data that will be
sent. Selections vary from 1KB to 1024KB (1MB).
4 In the TCP/IP address field, enter IP address of the computer you want to test the communication link.
NOTE: See your Network Administrator for the required TCP‐IP address.
5 When you have entered the TCP/IP address, click the Test button to execute the command. The
information will be sent 16 times.The system displays the number of bytes sent and the number of bytes
received and the delay (in milliseconds).
NOTE: The delay between attempts should be similar, except for the first attempt which could be
longer than the others. If you do not have a response, the message will be displayed in the following
format: Sent(block) Bytes, No Answer (1717)
Workstation
This utility program is useful when a workstation or gateway needs to be configured. It contains all the
menus and features necessary to configure a system with event display, desktops, manual operations or
reports. The system installer can configure all workstations directly from this program without having to
go from workstation to workstation.
Start the Workstation config system utility from Windows® start menu Start > All Programs > EntraPass
Corporate Edition > Server > Workstation. This program can also be launched from a shortcut on the
desktop. When using this option, you must first create the operators and security levels (System
toolbar), then define the gateway, sites, controllers (Devices toolbar).
NOTE: For more information See Chapter 2 ‘Software Installation’ on page 9.
324 System Utilities
Migration Utility
Migrating EntraPass Special Edition to Corporate Edition
EntraPass offers you the ability to migrate your database from Special Edition to Corporate Edition.
Before start the migration process, you must take a backup of your EntraPass Special Edition database.
For more information on backing up your database, see "Backups" on page 300. You will then install
EntraPass Corporate Edition. For details on installing EntraPass Corporate Edition, see "System
Installation" on page 14.
NOTE: Do not run EntraPass Corporate Edition and do not register at this time.
The next step will be to run the migration utility. Once your database has been migrated, you will run
EntraPass Corporate Edition and register it with Kantech Technical Support. For more details on
upgrading EntraPass Special Edition to EntraPass Corporate Edition, see Application Note DN1619.
1 Click on Start > All Programs > EntraPass (software) > Gateway > Gateway. This is when you only have the
“Gateway Only” software installed. You may also click Start > All Programs > EntraPass (software) >
Workstation & Gateway > Gateway (when you have the Workstation & Gateway software installed).
The status bar indicates the system's date and time, the name of the operator who is currently logged,
the status (could be any message such as running, etc.) and the IP address of the EntraPass server (the
green square indicates the server state, if yellow then it is the Redundancy Server).
• Configuration data received from the server: The progress bar indicates that configuration data is being
received from the EntraPass Server. Configuration data can be information such as “Card modifications”,
etc.
• Data requested by workstation: The progress bar indicates that data is being requested from the
EntraPass Workstations of the system (could be any). Data can be information such as “Status Requests”,
etc.
• Messages generated by the gateway: The progress bar indicates that messages are generated from the
gateway. These messages can be: Access granted, input in alarm, Access denied—bad access level, etc.
• Configuration data sent to the controllers: The progress bar indicates that configuration data (which was
received by the EntraPass Server) is being forwarded to the controllers.
NOTE: The progress bars indicate data transfers being executed and that information is being sent
back and forth.
MS/SQL Interface
The MS‐SQL/ORACLE Interface is a program that creates a real‐time copy of the EntraPass card database
in the MS‐SQL or ORACLE Server. This interface allows user to modify, add or obtain card‐related
information, all this in real‐time, from the MS‐SQL or ORACLE database. The MS‐SQL/ORACLE Interface
card database, which contains cardholder information, will be updated automatically as soon as new
information is available in the EntraPass card database.
NOTE: The MS‐SQL/ORACLE Interface program is not supported by the Mirror Database and
Redundant Server.
Depending on the client interface that is used (EntraPass or MS‐SQL/ORACLE Client) to add or modify a
card, the MS‐SQL/ORACLE Interface program ensures that the modifications is conveyed to the EntraPass
Server and vice versa and that the information, whatever its origin, is updated in both databases. (For
more information, see the “exchange data process” diagram).
326 System Utilities
The tbTransactionOut table contains the history of all creations, modifications and deletions of cards
(since the start of the CardGateway). All successful creations, modifications or deletions of a card done
by the MS‐SQL/ORACLE Interface after reading this card in the tbTransactionIn table will also be found in
the tbTransactionOut table.
3 Then, the main application screen will be displayed:
System configuration
• Server name—This field indicates the name of the SQL or Oracle Server as defined in the workstation
definition menu.
• EntraPass State—This field indicates the real‐time status of the EntraPass server. In case of failure,
messages would appear here.
Database
• Database State—This field indicates the real‐time status of the card database.
Transaction Report
• Data received from the EntraPass Server—When card‐related information are modified within the
EntraPass server (database), the information is also forwarded to the MS‐SQL/ORACLE Interface
database where the SQL or Oracle Server will collect the information. This field indicates the number
of transactions that were executed and sent to the card database.
• Data updated on SQL Server—
• Nb of cards sent to EntraPass Server—This field indicates the number of cards that were added or
modified in the SQL or Oracle client application and that were sent to the EntraPass Server’s
database.
328 System Utilities
Transactions
The registry contains the details of the transactions that are processed by the CardGateway program.
You must login to access this screen.
Diagram
The diagram below shows the “DATA EXCHANGE PROCESS” between the CardGateway program and the
MS‐SQL/ORACLE database.
device such as video matrix switchers, paging systems, etc. To do this, a RS‐232 link is cabled between
one of the EntraPass Workstation and the external device. The necessary command strings and protocols
can be easily edited on site to fit just about any job.
The SmartLink simplifies the interfacing to “alien” intelligent devices because it provides the system
installer all the tools necessary to build and maintain the actual interface without having to purchase
“special” drivers from Kantech. In communications, a link is a line or channel over which data is
transmitted. The transmission of data from one computer to another, or from one device to another. A
communications device, therefore, is any machine that assists data transmission. For example, modems,
cables, and ports are all communications devices.
Required Material
• A computer that meets the same requirements as an EntraPass Workstation (see "Minimum System
Requirements" on page 9),
• Installation CD‐ROM for the SmartLink application including the serial number.
Installation
1 Create the new application in the Workstation Registration menu, see "Minimum System Requirements"
on page 9 for more information on how to create new applications,
2 Install the SmartLink application on the computer (see "System Installation" on page 14).
3 Once the SmartLink application is installed, you need to configure the SmartLink application,
4 If you are using the Message Mode, you will need to create tasks. For more information on how to create
tasks with the Task Builder, See Chapter 5 ‘Task Builder Definition’ on page 115.
Network Consumption
The consumption of network time can be divided in many categories:
Messages:
• A message originating from a Server can generate:
• Minimum: 128 bytes + (# workstations, SmartLinks * 32 bytes)
• Maximum: 128 bytes + (# workstations * 416 bytes)
330 System Utilities
Manual Operations:
There are 2 types of manual operations:
• Operations that are used to execute functions such as unlocking a door. These operations, which are
occasionally requested, usually involve an insignificant amount of information.
• Operations which are used to recuperate a component or request a card list. Even though these
operations can be frequently requested, they usually involve an insignificant amount of information. For
example, requesting a door status only requires 16 bytes OUT and 64 bytes IN.
System Utilities 331
Animated Icons
Animated icons indicate the status of physical or logical components in the windows of EntraPass
software. They represent the component status in real time and simulate a movement by displaying a
series of pictures associated with the component. If a particular component status is difficult to identify,
use this section to identify it.
Controllers
Controller animated icons indicate the status of a door controller in the graphic window (Desktop >
Graphic desktop) or in the “Operation” window.
Status unknown
Appears when the EntraPass application has not received the component' status after four (4) attempts.
It is displayed in:
• the Operation window (alarms, door, elevator door, relay, input, reload data)
• or the Desktop > Graphic desktop.
Controller AC failure
Appears when the controller is in AC failure and the tamper switch is in alarm. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Controller Reset
Controller is not communicating
Appears when the controller is communicating and the communication is regular. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Controller Reset.
Controller status is not yet known
Appears when the status of the controller is not yet known. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
Controller is in “Reset” and AC failure
Appears when the controller is in “reset mode” and in “AC failure”. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Controller Reset.
Controller is in “Reset”, “AC failure” and “Tamper in alarm”
Appears when the controller is in “reset mode”, in “AC failure” and the tamper is in alarm. It is displayed
in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Controller Reset
Controller is in reset and tamper in alarm
Appears when the controller is in “reset mode” and the tamper is in alarm. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Controller Reset.
Controller tamper in alarm
Animated Icons 337
Doors
Icons representing a door state indicate the status of door within the graphic window (from the desktop)
or within the “Operation” window.
Door forced open
This animated icon appears when the door is opened and that no access granted nor request to exit was
permitted. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door, Elevator Door
Door forced open (reader disabled)
This animated icon appears when the door is opened and that no access granted nor request to exit was
permitted and the reader is disabled. it is displayed in:
• the “Graphic” window (desktop—graphic)
• the Operation > Door, Elevator Door
338 Animated Icons
This animated icon appears when the door is closed and locked. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door
Door closed and locked (reader disabled)
This animated icon appears when the door closed and locked and that the reader is disabled. It is
displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door.
Door status unknown
This animated icon appears when the door is opened more than the permitted delay set in “open time”.
It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door, Elevator door.
Door open too long (reader disabled)
This animated icon appears when the door is opened more than the permitted delay set in “open time”
and that the reader is disabled. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door, Elevator door.
Animated Icons 339
This animated icon appears when the door is opened and it was unlocked by an operator. it is displayed
in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door > Elevator door.
Door open and unlocked manually (reader disabled)
This animated icon appears when the door is opened and it was unlocked by an operator and the reader
is disabled. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door > Elevator door.
Door is opened and unlocked by schedule
This animated icon appears when the door is opened and it was unlocked by a schedule. It is displayed
in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door > Elevator door.
Door is opened and unlocked by schedule (reader disabled)
This animated icon appears when the door is opened, and it was unlocked by a schedule and the reader
is disable. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door > Elevator door.
Door pre‐alarm on open too long
This animated icon appears when the door is opened more than half the time permitted delay set in
“open time”. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
340 Animated Icons
This animated icon appears when the door is opened more than half the time permitted delay set in
“open time” and the reader is disabled. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door > Elevator door.
Door still opened schedule invalid
This animated icon appears when the door is opened and the unlock schedule is invalid. It is displayed
in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door/Elevator door.
Door still opened schedule invalid (reader disabled)
This animated icon appears when the door is opened and the unlock schedule is invalid and the reader is
disabled. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door/ Elevator door.
Door unlocked by an operator
This animated icon appears when the door is unlocked by an operator (manually). It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door > Elevator door.
Door unlocked by an operator (reader disabled)
This animated icon appears when the door is unlocked by an operator (manually) and the reader is
disabled. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
Animated Icons 341
This animated icon appears when the door is unlocked by a schedule. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door/Elevator door.
Door unlocked by a schedule (reader disabled)
This animated icon appears when the door is unlocked by a schedule and the reader is disabled.
It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door/Elevator door.
Elevator door unlocked and closed
This animated icon appears when the elevator door is closed and unlocked. It is displayed in:
• the Graphic desktop (Desktop > Graphic desktop window)
• the Operation > Door/Elevator door.
Relays
Relays icons indicate the status of a relay within the graphic window (from the desktop) or within the
“Operation” window.
Relay activated by an event
Relay deactivated
Inputs
This section is used to indicate the status of an input within the graphic window (from the desktop) or
within the “Operation” window.
Input activated—Not supervised
• the “Graphic” window (desktop—graphic) when the input is activated, manually operated and the
monitoring schedule is invalid.
• the Operation > Input when the input is activated, manually operated and the monitoring schedule is
invalid.
Input activated—Supervised manual operation
Input in alarm—Supervised
• the Operation > Input when the input is in normal condition and the monitoring schedule is valid.
Input OK—Supervised by operator
This animated icon appears in the “Graphic” desktop when the status of the input is not yet known.
Controller Site:
Site status is not yet known
• the Operation > Reload data when the site is connected and is in “reload data” state.
Controller site—Communication Failure
Gateway:
Gateway—Communication Failure
• the “Graphic” window (desktop—graphic) when the gateway is communicating and the communication is
regular.
• the Operation > Reload data gateway, communication is regular.
Gateway Trouble
• the Operation > Reload data when the gateway is not communicating.
EntraPass Application
Application status is not yet known
Others
Database Initialization
This animated icon is used to indicate a transient stage. This could indicate that the requested
information is not currently available.
350 Animated Icons
No state available
This animated icon is used to indicate a transient stage. This could indicate that the requested
component status is not currently available.
Output status is not yet known
Index
Numerics Controllers 335
Doors 337
1st IN last OUT
Inputs 343
Time & Attendance reports 270 Others 349
3rd party hardware Relays 341
Configuration 103, 105
Site and gateway 346
DLL integration 293
Anti‐passback
Graphic 109
Hard anti‐passback 79
Operations 149, 165
Soft anti‐passback 79
A Assign alarm sound 281
Abort report if free space lower than (MB) 289 Assigning an Access Level to a Cardholder 173
Access Authentication 46
Control 1 Password Modification 279
Events 96 Automatic
Levels Activation schedule 98
Administrator 36 Backup 295
Arming 97 Backup scheduler 295
Bad 96 Logout on idle 284
Create groups 204
Definitions 190
B
Primary access level 173 Background
Managed by user 104 Live video 111
Schedule Web page 111
Tenants 198 Backlight delay (KTES) 85
Acknowledging alarms Backup 300
Acknowledge schedule 230 Folder 295
Automatic 216 Scheduler 294
Definition and purpose 248 Separate files 295
Set priority 230 Type 295
Using the alarm message box 48 Badging 3
Activate relay temporarily 101 Creating a badge 179
Adding 18 Edit a badge layout 179
Adding system components 18 Get picture from file 175
Advanced schedule capability 284 MCI 175
Paste picture 175
Alarm
Video images 175
Controls
Definition 48
Bandwidth
Message box 48
Video 282, 291
Response time 100 Batch operations
Sound 281 Card filter 193
Allow diagnostic on network 285 Battery trouble (KTES) 85
Animated icons Buffer (KTES) 85
352
Controllers 71 Configuration 64
Create floor groups 204, 205 Event trigger
Create floors 109 Task builder 115
Door Events
Input definition 102 Acknowledge schedule 230
Selecting 160 Buffer
Doors 94 Controller 66
Locking floors 161 Color 229
Floor disabling 162 Deleting and restoring associations 230
Floor enabling 162 Display (schedule) 229
REB‐8s 71 Doors 95
Select cab for floor group activation 102 Instructions (assign to events) 230
Email Pager codes (KTES) 87
Options 49 Parameter definition 227
Reports 49 Parameters
Task builder 118 Task 230
Email report authentication 49 Print parameters 231
Enabling Print schedule 229
Arming request schedule 97 Set priority 230
Card readers 160 Viewing associations 230
Door reader 159 Expansion Modules
Duress function on KTES keypad 96 Configuring 76
Fail‐soft delay (KTES) 82 Exported Video 148
Postpone arming schedule 98 Express Setup 29, 316
Signature pad 282 Configuring a corporate gateway 316
TFTP IP Link updater 287 Controllers 320
TFTP KT‐400 updater 286, 287 KTES 320
Video capture 282 Extended door access delay 90, 96
Encryption 45 Tenant 198
End‐of‐line Extended number of ring before answer (KTES)
Double 101 81
KT‐400 66 Extended ring
KTES 82 Tenant 198
KT‐MOD‐INP16 module 77 Extended selection box 34, 40
Override default 101
Extended talk time (KTES) 81
Enhanced user management
External Alarm
Credentials 292
System interfaces 97
New card 168
System options 97
Enter network tag 120 System panel status 97
EntraPass
Configuring 44
F
Starting the server 25 Fail‐safe
Starting the workstation 27 Doors 88
Ethernet polling 316 Fail‐secure
356