TRUE PORTAL Software User Guide
TRUE PORTAL Software User Guide
TRUE PORTAL Software User Guide
Trademarks and patents Interlogix, TruPortal, TruVision, and logos are trademarks of United
Technologies. Microsoft, Internet Explorer, and Windows are registered
trademarks of Microsoft Corporation in the United States and/or other countries.
Apple, iPad, iPhone, and iTunes are registered trademarks of Apple Inc. Android
is a trademark of Google, Inc. Other trade names used in this document may be
trademarks or registered trademarks of the manufacturers or vendors of the
respective products.
Manufacturer Interlogix
3211 Progress Drive, Lincolnton, NC 28092
Authorized EU manufacturing representative:
UTC Climate, Controls & Security B.V.
Kelvinstraat 7, 6003 DH Weert, Netherlands
Certification N4131
FCC compliance This device complies with part 15 of the FCC Rules. Operation is subject to the
following two conditions: (1) This device may not cause harmful interference, and
(2) this device must accept any interference received, including interference that
may cause undesired operation.
Class A: This equipment has been tested and found to comply with the limits for a
Class A digital device, pursuant to part 15 of the FCC Rules. These limits are
designed to provide reasonable protection against harmful interference when the
equipment is operated in a commercial environment. This equipment generates,
uses, and can radiate radio frequency energy and, if not installed and used in
accordance with the instruction manual, may cause harmful interference to radio
communications. Operation of this equipment in a residential area is likely to
cause harmful interference in which case the user will be required to correct the
interference at his own expense.
Class B: This equipment has been tested and found to comply with the limits for a
Class B digital device, pursuant to part 15 of the FCC Rules. These limits are
designed to provide reasonable protection against harmful interference in a
residential installation. This equipment generates, uses, and can radiate radio
frequency energy and, if not installed and used in accordance with the
instructions, may cause harmful interference to radio communications.
There is no guarantee that interference will not occur in a particular installation. If
this equipment does cause harmful interference to radio or television reception,
which can be determined by turning the equipment off and on, the user is
encouraged to try to correct the interference by one or more of the following
measures:
• Reorient or relocate the receiving antenna.
• Increase the separation between the equipment and receiver.
• Connect the equipment into an outlet on a circuit different from that to which the
receiver is connected.
• Consult the dealer or an experienced radio/TV technician for help.
ACMA compliance Notice! This is a Class A product. In a domestic environment this product may
cause radio interference in which case the user may be required to take adequate
measures.
Canada This Class A digital apparatus complies with Canadian ICES-003. Cet appareil
numérique de la classe A est conforme à la norme NMB-0330 du Canada.
European Union directives 12004/108/EC (EMC directive): Hereby, United Technologies declares that this
device is in compliance with the essential requirements and other relevant
provisions of Directive 2004/108/EC.
2002/96/EC (WEEE directive): Products marked with this symbol
cannot be disposed of as unsorted municipal waste in the European
Union. For proper recycling, return this product to your local supplier
upon the purchase of equivalent new equipment, or dispose of it at
designated collection points. For more information see: www.recyclethis.info.
2006/66/EC (battery directive): This product contains a battery that
cannot be disposed of as unsorted municipal waste in the European Union.
See the product documentation for specific battery information. The
battery is marked with this symbol, which may include lettering to indicate
cadmium (Cd), lead (Pb), or mercury (Hg). For proper recycling, return the
battery to your supplier or to a designated collection point. For more information
see: www.recyclethis.info.
OpenSSL and AstraFlex Components are licensed under a Modified BSD License
Copyright © 1998—2011 The OpenSSL Project. All rights reserved.
Copyright © 2008, Yahoo! Inc. All rights reserved.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
CMockery, Google Protocol Buffers (C), Swagger-js, and Swagger-ui are licensed
under the Apache License, Version 2.0 (the “License”)
Copyright © 2006, Google Inc.
Copyright © 2008-2011, Dave Benson.
Copyright © 2015 SmartBear Software
You may not use this file except in compliance with the License. You may obtain a copy of the License at http://
www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
“AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under the License.
Flex-IFrame
Permission is hereby granted, free of charge, to any person obtaining a copy of this Flex-IFrame software and
associated documentation files (the “Software”), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so.
Google Protocol Buffers (C++) is licensed under the New BSD License.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
gSOAP is licensed under the gSOAP Public License (modified MPL license)
Copyright © 2001-2009 Robert A. van Engelen, Genivia Inc. All Rights Reserved.
THE SOFTWARE IN THIS PRODUCT WAS IN PART PROVIDED BY GENIVIA INC AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Please write “source for TruPortal” in the memo line of your payment. You may also find a copy of the source at
www.interlogix.com. This offer is valid to anyone in receipt of this information.
Table of Contents
CHAPTER 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Conventions Used in this Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
CHAPTER 7 Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Backing Up Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Create a Backup File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Schedule Automated Backups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Back Up Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
CHAPTER 8 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Resolving Browser Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Rebooting the System Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
Resetting the Administrator Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
Fuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Hardware Problem States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Troubleshooting Readers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Troubleshooting Card Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Troubleshooting Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Error, Warning and Event Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
Tamper States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Power and Battery Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Backup Battery Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Device Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Door Tamper Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Auxiliary Input Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Auxiliary Output Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Bad Card Format Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
“Objects Have Changed” Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
“NTP Sync Failed” Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Video Player Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109
No Active Video Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
TruPortal™ is a web-based access control solution that is designed to be simple to use, yet
sophisticated. It is compatible with a variety of access control hardware components, including:
• Input devices that detect conditions or events, such as door bells or alarms.
• Output devices such as lights and locks that respond to input devices and/or action triggers.
• TruVision™ Digital Video Recorders (DVRs) and Network Video Recorders (NVRs).
The TruPortal User Interface software is embedded on the System Controller and can be used to:
• Control access for up to 64 doors based on user-defined schedules.
• Configure schedules to include recurring holidays.
• Add up to 10,000 users and badges to the System.
• Add reader schedules to help automate the System.
• Enforce anti-passback (APB).
• Create reader groups.
• Monitor events remotely and automate linking of events to recorded video.
• Open, lock, lock out and reinstate doors remotely.
• The Import/Export Wizard can be used to import persons and credentials data from an existing
database in Comma Separated Values (CSV) format, as well as export data. It can also be used to
delete persons and credential data in batch mode and export events. See the Import/Export
Wizard User Guide included on the Utilities disc for details.
Click the View Help button ( ) in the top-right corner of the TruPortal User Interface to access a
searchable, electronic version of the TruPortal Software User Guide via the online help system.
Click the Show Tool Tips button ( ) to display context-sensitive information when hovering over
fields and icons in the TruPortal User Interface. Tooltips can be toggled on or off by clicking the same
button. Maximize the browser window to display all tool tips; tool tips may not appear if the browser
window is too small.
Click the Disable Wizards button ( ) to turn off the ability to use wizards for configuration.
Wizards can be toggled on or off by clicking the same button. This setting is saved for each user.
The first step in setting up the System is to install the hardware components that will be used by the
System (inputs, outputs, doors, readers, cameras, etc.) according to manufacturer instructions. Be sure
to record data about door configurations that can be used later in naming the devices, reader groups,
and areas when the devices are configured in the User Interface.
Note: Existing TruPortal 1.0 or goEntry 3.0 customers that already have all hardware installed
and configured can skip this step and use the Upgrade Wizard to upgrade the System
Controller. See Using the Upgrade Wizard on page 10.
After installing hardware components, connect the System Controller to a local client workstation or
to Local Area Network (LAN), and then use the Installation Wizard to detect the System Controller
on the network, as described in Preparing for Configuration on page 7.
Topics in this section include:
• System Architecture Overview on page 4
• Documenting the Physical Location of Each Device on page 5
• Connecting to a Local Client Workstation or LAN on page 6
• Installing an Enrollment Reader on page 6
In addition to hard-wired components, the System Controller can communicate with proprietary
Internet Protocol (IP)-based Single Door Controllers (IPSDCs). Plus, companion iPad®, iPhone®, and
Android™ apps enable users to remotely monitor system activity and perform basic administrative
tasks, such as adding or deleting users.
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
In:
Out:
Note: If multiple network appliances use a single network drop by means of a switch or small
router, make sure there is not more than one switch or router between the System
Controller and the network drop.
After hardware devices are installed, the following steps should be performed before launching the
User Interface to perform a full configuration of the System:
1. Consult with the site network administrator to decide how network settings should be configured.
See Determining Network Settings on page 7.
2. If you are an existing TruPortal or goEntry 3.0 customer and all hardware is already installed
and configured, use the Upgrade Wizard to upgrade the System Controller instead of using the
Installation Wizard. See Using the Upgrade Wizard on page 10.
If you are a new TruPortal user, follow the steps in Using the Installation Wizard on page 8 to:
• Detect the System Controller on the local area network.
• Change the default password for the main Administrator account to enhance security.
• Synchronize the date and time on the System Controller with the local client workstation.
• Configure the network settings of the System Controller.
3. Configure any installed IPSDCs to recognize the IP address of the System Controller before
configuring the IPSDCs in the User Interface. Establishing this network connection ensures that
IPSDCs will be detected when the System Controller scans for hardware changes. For more
information, see Configuring IP-Based Single Door Controllers on page 113.
changed if it conflicts with an existing port used on the network. If the port is changed, users will
need to append the port number to the IP address of the System Controller to log into the System
(e.g., https://IPaddress:port).
Note: Ports 0 through 1024 (i.e., well-known ports) are reserved for privileged services. It is
recommended that these ports not be used as the service port.
• If a static IP address will be used, what are the subnet mask, default gateway, and Domain
Name Server (DNS) values for the network? This information will be needed when
configuring network properties for the System Controller.
• Should a Hypertext Transfer Protocol Secure (HTTPS) connection be used? HTTPS is
highly recommended to prevent unauthorized access to the System. This secure protocol encrypts
the packets between the client browser and the System Controller, preventing someone from
gathering user information by spying on network traffic. There may be circumstances that require
non-secure HTTP. For example, if the System Controller is accessed through a Web proxy server
that does not support HTTPS, then the only option is to disable HTTPS.
Note: If you are an existing TruPortal or goEntry user, run the Upgrade Wizard to upgrade
the System Controller from an earlier version instead of using the Installation Wizard.
See Using the Upgrade Wizard on page 10.
The Installation Wizard can also be used to determine the new IP address of an System Controller if
the IP address has changed.
Note: The Installation Wizard is not compatible with Microsoft® Windows® XP.
To use the Installation Wizard:
1. Verify that the System Controller is connected to the local area network so that it can be detected
by the Installation Wizard.
2. Insert the product disc in the local client workstation’s CD/DVD drive.
Note: If the disc image was downloaded and extracted to the client workstation’s hard drive,
open Windows Explorer, navigate to the disc image on the hard drive, and double-click
the start.hta application to launch the Utilities software.
The Utilities software will determine if the client workstation includes the programs required to
run the User Interface.
3. If prompted, click .NET 4.5 Framework and/or Bonjour to install the software.
4. Click the Installation Wizard icon.
5. When the Introduction page appears, select a Language and click [Next].
The Installation Wizard will search for any System Controllers on the network.
6. Select the System Controller in the list and click [Next].
7. On the Login page, type the current Password for the Administrator account.
The default User Name for the Administrator account is admin.
The default Password for the Administrator account is demo.
IMPORTANT: The Administrator account has access to all aspects of the System. Leaving
the default password unchanged is dangerous. People familiar with the
product may know the default password.
8. Type the new password in the New Password and Confirm Password fields and click [Next].
9. On the Date/Time page, select the System Controller Time Zone.
10. If the Panel Date and Time and Client Date and Time values appear in red, either the time
zone set on the System Controller is different from the time zone on the client workstation, or the
time varies between the two devices by more than 10 seconds.
Click [Time Sync] to synchronize the time zone and time on the System Controller with the time
zone and time on the client workstation.
Note: After the initial configuration is complete, the System can be synchronized with a
Network Time Protocol (NTP) server. See Setting the Date and Time on page 15.
11. Click [Next] to continue to the Network Configuration page.
12. Select Static or Dynamic as the connection type for the System Controller.
To configure a static IP address:
a. Type the IP Address for the System Controller that users will type into an Internet web
browser to connect to the System.
b. (Optional) Change the Service Port for the System Controller.
Note: The default Service Port for an HTTPS connection is 443; the default value for an
HTTP connection is 80. Ports 0 through 1024 (i.e., well-known ports) are reserved for
privileged services. It is recommended that these ports not be used as the Service Port. If
the port is changed to a different value, users will need to append the port number to the
IP address of the System Controller to log into the System (e.g., https://IPaddress:port).
c. Type the Subnet Mask for the network to which the System Controller is connected.
d. Type the Default Gateway for the network.
e. Type the DNS Server for the network.
13. Select Enable HTTPS Connection to use a secure hypertext protocol
IMPORTANT: Do not power cycle the System Controller (i.e. turn it off and unplug the
power) during an upgrade.
IMPORTANT: Upgrading is different than updating the firmware. A firmware update only
impacts the firmware, while an upgrade impacts both the firmware and the
core code on the System Controller. Do not use the System Administration >
Firmware Updates page to upgrade the System Controller; use the Upgrade
Wizard instead.
• After an upgrade, the System Controller cannot be converted back to a previous version.
• The Upgrade Wizard is not compatible with Microsoft Windows XP.
• (Recommended) Run the Upgrade Wizard directly from the physical TruPortal DVD, as opposed
to a mounted ISO image.
• Although the Upgrade Wizard provides an option to back up data, an extra backup file can be
created as a precaution (see Create a Backup File on page 89). Configuration settings can also be
backed up (see Saving and Restoring Custom Settings on page 91). To save an historical record
of events, use the Import/Export Wizard to export events in CSV format.
• If upgrading from goEntry to TruPortal, card format information will be preserved.
• Make sure that all users are logged out of the System before using the Upgrade Wizard.
• Make sure that any backup and restore processes are finished.
• The upgrade will be faster and more reliable if the System Controller uses a static IP address. (To
change this setting, see Configure Network Settings on page 17.) If a dynamic IP address is used,
the IP address may change during the upgrade and the process will stop. If this occurs, use the
Installation Wizard to obtain the new IP address and then restart the Upgrade Wizard.
• A [Finish] button appears on many wizard pages; click it to stop the upgrade, if necessary.
To use the Upgrade Wizard:
1. Log into the product web site and download the following files to a local client workstation:
• The ISO image of the latest version of the Utilities disc.
• The NGP.bin source file that will be used to update the firmware.
The wizard will create a folder called \<local documents>\PanelUpgradeWizard that includes
two subfolders: \Backups and \Logs.
5. When the Introduction page appears, select a Language and click [Next].
6. Log in as a user with Execute permissions for the Firmware Updates feature, and then click
[Next].
The Source File page displays details about the firmware on the System Controller.
7. Click [...] to browse to the folder where the NGP.bin file was downloaded.
8. In the Open dialog box that appears, click the NGP.bin file to select it, and then click [Open].
The Source File page displays details about the NGP.bin file.
9. Click [Next].
10. On the Backup page, type the path where data will be backed up, or browse to its location.
Note: Although the Create Backup File check box can be cleared to skip backing up data, it
is recommended that users leave this check box selected to back up data before an
upgrade. This option is intended for factory use only.
IMPORTANT: If no backup file is created while using the Upgrade Wizard, photos will not
be preserved and will need to be restored from an earlier backup.
11. Click [Backup].
12. When a “Backup Successful” message appears, click [Next].
13. On the next page, click [Firmware Upgrade].
A summary of the Upgrade Wizard’s progress appears. This process may take five to ten
minutes. Red squares will appear next to any errors that occurred.
14. When the upgrade is complete, click [Next].
15. If data was backed up in step 11, the Restore page displays the location to which files were
backed up.
a. Click [Restore] to load the backed up data back onto the System Controller.
b. When the “Restore Successful” message appears, click [Next] to verify that the upgrade
occurred on the Upgrade Results page.
16. When the Upgrade Results page appears, click [Finish] to exit the wizard.
17. If a goEntry System was upgraded to TruPortal, review the card format descriptions on the
System Administration > Card Formats page and update them, if necessary. (Card format
descriptions are upgraded in English only.)
18. If IPSDCs are installed, configure each IPSDC to recognize the IP address of the System
Controller before configuring the IPSDC in the User Interface. See Configuring IP-Based Single
Door Controllers on page 113.
TruPortal is designed so that, once configured, persons and credentials can be added and removed
quickly, and access to a facility can be managed. During configuration, the following information will
be defined:
• The areas, doors, credential readers, video surveillance, and auxiliary security systems at a site.
• Access levels needed by the various groups of persons who work at a site.
• Access schedules for regular days and holidays.
• Operator roles for the people who will be managing and monitoring the System.
This section is organized sequentially, with tasks arranged in the order they should be completed to
configure the System.
IMPORTANT: If any IPSDCs are installed, configure them to recognize the IP address of the
System Controller before configuring them in the User Interface. See
Configuring IP-Based Single Door Controllers on page 113.
1. Logging into the System.
2. Setting the Date and Time.
3. Create a Certificate Signing Request.
4. Import a Security Certificate.
5. Configure Network Settings.
6. Configure Site Security.
7. Set the System Language.
8. Add a Card Format.
9. Scan for Hardware Changes.
10. Assign Meaningful Names to Hardware.
11. Configure the System Controller.
12. Optional: Configure I/O Expansion Modules.
13. Configure a Door Controller.
14. Configure a Door.
15. Configure Readers.
16. Optional: Add a DVR/NVR.
Note: If the default service port for the System was changed, append the port number to the IP
address (e.g., https://IP address:port).
3. If using Internet Explorer® and a warning about the security certificate appears, select Continue
to this website (not recommended).
4. Type a Username.
5. Type a Password.
6. (Optional) Select a different Language for the User Interface.
By default, the System includes four languages — English, Spanish, French, and Dutch — but
more can be added. See Managing Language Packs on page 94.
7. Click [Log In].
8. If this is the first time the User Interface is being used on the client workstation, click Accept
when the License Agreement page appears.
The Home page displays several wizards that can be used to quickly add persons, credentials, access
levels, schedules, and holidays. Click a wizard icon and follow the onscreen prompts to add new
items, or refer to the relevant section of this document for step-by-step instructions.
To log out of the System later, click the Logout icon in the top-right portion of the User Interface.
Note: Type either the IP address or the Fully Qualified Domain Name (FQDN) of the server in
the Common Name field. If the panel is configured to use a DHCP-assigned IP address,
then it is highly recommended that the DHCP server be configured to always assign this
IP address to the panel. Otherwise each time the panel is assigned a different IP address,
a new certificate will need to be generated and installed.
The Certificate Signing Request (CSR) text appears in the text box on the right side of the dialog
box.
5. To use a self-signed certificate, click [Install Self-Signed Certificate].
The System Controller will reboot automatically.
6. To use a signed certificate:
a. Copy CSR text and save to a local file to send to a certificate authority.
b. Close the Certificate Signing Request dialog box.
c. See Import a Security Certificate on page 17.
Note: The default Service Port for an HTTPS connection is 443; the default value for an
HTTP connection is 80. Ports 0 through 1024 (i.e., well-known ports) are reserved for
privileged services. It is recommended that these ports not be used as the Service Port.
Configuring Security
The Security tab of the System Administration > System Settings page can be used to configure
certain aspects pertaining to the physical security of a facility.
PIN Codes
The System can be configured for access with a credential only, a credential and Personal
Identification Number (PIN), PIN only, or credential or PIN. Requiring people to present a badge
(credential) and type a PIN code provides added security by preventing access with a found or stolen
badge. Readers can be configured to Credential Only, Credential and PIN, PIN Only, or credential or
PIN based on schedules. (See Scheduling Door and Reader Behavior on page 52.) Note: In PIN Only
mode, all PINS in the system must be unique.
Max PIN Length
PINs can be 4, 6, or 9 digits in length.
Note: IPSDCs support only 1K/Dual supervision, as configured by setting switches on the
panel. Refer to the IP-based Single Door Controller Quick Reference for details.
IMPORTANT: When a new Maximum PIN Length is saved and there are existing credentials
with PIN numbers longer than the new maximum length, a warning prompt
will appear to indicate that existing PIN numbers will be truncated to the new
length. The prompt will allow the user to continue or cancel the save
operation.
4. Select the number of Max PIN Attempts.
5. Select a PIN Lock Out Time.
6. Select a Door Fallback Mode:
• No Access: No access is granted whatsoever.
• Site Code Access: Access is granted if the card matches one of the formats defined on the
System Administration > Card Formats page, and the site code on the card matches the site
code defined for the format.
• All Access: Access is granted if the card matches any format defined on the System
Administration > Card Formats page.
7. Select an option for Input EOL Terminations.
Configuring Devices
This section describes how to configure the following devices:
• System Controller
• Inputs and outputs
• Door controllers
• Doors
• Readers
• Input/output expansion modules
To learn about configuring DVRs/NVRs and cameras, see Configuring Video Devices on page 33.
To learn more about configuring elevators and floors, see Elevator Control on page 44.
Note: If the serial number of a door controller changes (for example, if a door controller is
replaced), all child objects (doors and readers) that still use default names should be
updated to reflect the new serial number of the parent door controller. See Replace a
Door Controller on page 25.
To detect hardware devices in the System:
IMPORTANT: Door controllers will go offline during the scan, which usually takes several
minutes.
1. Select System Administration > Devices.
2. Select the System Controller.
3. Click [Scan for Hardware Changes].
4. Click [Accept Changes].
If the System detects any issues (for example, if no backup battery is installed), a notification will
appear in a black box at the top of the User Interface; click inside the box to open the Monitoring
> Diagnostics page and learn more about the issues. See Diagnostics on page 100.
Note: If default names are not customized, remember that any changes made to the name of a
parent object must also be made to any child objects (for example, the doors and readers
connected to a door controller) to avoid inconsistent device names.
Before beginning this task, consult the installation chart created when devices were installed, as
described in Documenting the Physical Location of Each Device on page 5.
1. Select System Administration > Devices.
2. Select the System Controller.
3. Type a descriptive Device Name.
4. Click [Accept Changes].
5. Select the first door controller on the list.
6. Compare the Serial Number to the installation chart to confirm that the correct device was
selected in the User Interface.
7. Type a descriptive Device Name.
8. Click [Accept Changes].
9. Repeat for each of the devices in the hierarchy.
Note: If any IPSDCs are installed, configure them to recognize the IP address of the System
Controller before configuring them in the User Interface. See Configuring IP-Based
Single Door Controllers on page 113.
Dual door controllers can be connected to as many as four readers on two doors. IPSDCs can be
connected to two readers on a single door. Each door may have two readers, one for access and one
for exit, commonly used with anti-passback.
1. Select System Administration > Devices.
2. Expand the tree below the System Controller.
3. Select the Door Controller.
4. Select the Number of Doors attached to this controller.
5. (Optional) Select a Linked Camera if one is associated with the door controller’s panel.
6. Click [Accept Changes].
Note: If all doors are locked out when a new door controller is added, the new door controller
will remain unlocked. To be locked out, all doors must be reinstated, then all doors
locked out again.
IMPORTANT: If a door controller is replaced, be sure to update child objects (door and
readers) to reflect the new serial number of the parent door controller before
using the [Scan for Hardware Changes] button on the System Administration
> Devices page, as described next. Otherwise, the configuration information
will be overwritten.
To replace a door controller and preserve its configuration information:
1. Back up the database, as described in Create a Backup File on page 89.
2. Replace the door controller board.
3. (FOR IPSDCS ONLY) Use the Integrated Configuration Tool (ICT) to configure the new IPSDC
to recognize the IP address of the System Controller. See Configuring IP-Based Single Door
Controllers on page 113.
4. Update the serial number of the door controller on the System Administration > Devices page.
5. If child objects (doors and readers) still use default names, update them to reflect the new serial
number of the parent door controller.
6. Reboot the System Controller. See Rebooting the System Controller on page 100.
7. Log back in after the System Controller reboots.
The door controller may appear to be offline until it is able to connect to the System Controller.
8. (Recommended) Back up the database and save the updated configuration after the door
controller comes online with the new serial number. See Backing Up Data on page 89 and Saving
and Restoring Custom Settings on page 91.
Configure Doors
Each door needs to be configured for:
• The length of time it should be unlocked when a valid credential is presented.
• The length of time it can be held open before triggering an alarm.
• The type of door strike used (either standard locks or magnetic locks).
• Whether a reader is required for access only, or for both access and exit.
• The types of events and alarms monitored by the door circuitry.
• Auxiliary inputs and relays. For example, a door can be configured for an automatic opener and
extended Request to Exit (RTE) to facilitate access by the disabled.
Configure a Door
1. Select System Administration > Devices.
2. Expand the tree below the System Controller.
3. Expand the tree below the door controller.
4. Select the door to configure.
Note: Some fields will not appear on the Devices page if a door is connected to an IPSDC,
which does not support auxiliary input/output types or tamper input points. Refer to the
IP-based Single Door Controller Quick Reference to learn about modifying DIP switch
settings for input types. After changing DIP switch settings, reboot the IPSDC.
5. Select a Normal Grant Access Time.
Note: The Aux and Tamper inputs listed above do not apply to doors connected to IPSDCs.
17. Click [Accept Changes].
18. Repeat for each door.
Note: Some fields will not appear on the Devices page if a door is connected to an IPSDC,
which does not support auxiliary input/output types or tamper input points. Refer to the
IP-based Single Door Controller Quick Reference to learn about modifying switch
settings for input types.
5. Select a Normal Grant Access Time.
6. Select an Extended Grant Access Time.
This is the amount of time the door will remain unlocked so the person can open it.
7. Select a Door Held Time.
8. Select an Extended Door Held Time.
This is the amount of time the door can remain open so the person can pass through.
9. Select a Door Strike Mode.
• Timed Unlock
• Lock on Close
10. (Optional) Select a Linked Camera if one is positioned to monitor the door.
11. Select an Access Mode.
12. (Optional) Select Request to Exit Enabled if the door is wired for it.
13. (Optional) If Request to Exit Enabled is selected, select Do Not Activate Strike on RTE to
prevent the door strike from energizing when the Request to Exit contact closes.
14. (Optional) Select any alarms the door is wired for:
• Door Held Open
• Door Forced Open
• Tamper
15. If the door is wired for a door opener:
a. Select “Extended RTE” from the Aux Input list.
b. Select “Door Opener” from the Aux Relay list.
c. Select an Aux Relay On Time.
16. Configure the sensor Input Types for:
• Door Contact sensor
• Request to Exit button or sensor
• Aux input from the Extended Request to Exit or magnetic lock contact sensor
• Tamper circuitry
Note: The Aux and Tamper inputs listed above do not apply to doors connected to IPSDCs.
17. Click [Accept Changes].
18. Repeat for each door.
• WARNING! • When configuring a door with magnetic locks, it is important to use the “Mag
Lock Bond Sense” option to prevent the door magnets from prematurely
activating and slamming the door shut, potentially causing injury.
1. Select System Administration > Devices.
2. Expand the tree below the System Controller.
3. Expand the tree below the Door Controller.
4. Select the Door to configure.
Note: Some fields will not appear on the Devices page if a door is connected to an IPSDC,
which does not support auxiliary input/output types or tamper input points. Refer to the
IP-based Single Door Controller Quick Reference to learn about modifying jumper
settings for input types.
5. Select a Normal Grant Access Time.
6. Select an Extended Grant Access Time.
This is the amount of time the door will remain unlocked so the person can open it.
7. Select a Door Held Time.
8. Select an Extended Door Held Time.
This is the amount of time the door can remain open so the person can pass through.
9. Select a Door Strike Mode.
• Timed Unlock
• Lock on Close
10. (Optional) Select a Linked Camera if one is positioned to monitor the door.
11. Select an Access Mode.
12. (Optional) Select Request to Exit Enabled if the door is wired for it.
13. (Optional) If Request to Exit Enabled is selected, select Do Not Activate Strike on RTE to
prevent the door strike from energizing when the Request to Exit contact closes.
14. (Optional) Select any alarms the door is wired for:
• Door Held Open
• Door Forced Open
• Tamper
15. Select “Mag Lock Bond Sense” from the Aux Input list.
16. (Optional) If an alarm light or klaxon is wired to the door, select “Door Held/Forced” from the
Aux Relay list.
17. Configure the sensor Input Types for:
• Door Contact sensor
• Request to Exit button or sensor
• Aux input from the Extended Request to Exit or magnetic lock contact sensor
• Tamper circuitry
Note: The Aux and Tamper inputs listed above do not apply to doors connected to IPSDCs.
18. Click [Accept Changes].
19. Repeat for each door.
Note: Schlage AD-400 wireless locks ignore this setting. Configure the Relatch After value
in the Schlage Utility Software instead. See the TruPortal Wireless Locks Quick
Reference for details.
Note: Schlage AD-400 wireless locks ignore this setting. Configure this feature in the Schlage
Utility Software instead. See the TruPortal Wireless Locks Quick Reference for details.
Door Held Time
When a valid credential is scanned by the reader, the door can be held open for the Normal
Grant Access Time plus the Door Held Time. An event is recorded if a door is held open longer
than that and the Door Held Open alarm option is selected.
If this check box is selected, the door strike will NOT energize when the RTE contact closes. If
this check box is not selected, the door strike energizes when the RTE contact closes.
If the door Aux Input is configured for Mag Lock Bond Sense, the strike relay will remain active
until the magnetic contact sensor is active, the door contact is closed, and the door unlock time
has expired.
Note: IPSDCs do not support Aux input and output. Schlage AD-400 wireless locks ignore
this setting.
Lock On Close
The door will unlock when access is granted and will remain unlocked until either the time
specified in Normal Grant Access Time expires, or the door is opened and closed, whichever
occurs first.
If the door Aux Input is configured for Mag Lock Bond Sense, the strike relay will remain active
until the magnetic contact sensor is active, the door contact is closed, regardless of unlock time.
Note: IPSDCs do not support Aux input and output. Schlage AD-400 wireless locks ignore
this setting.
Access Mode
Reader In Only
The door has a reader to scan credentials for entry, but does not require a person to present a
credential to exit.
Alarm Enabled
Door Held Open
Select this option if the door is wired to detect its opening. If held open longer than the time
selected for Door Held Time, an event will be recorded on the Events page.
Tamper
Select this option if the door is wired to detect reader tampering. If tampering occurs, an event
will be recorded on the Events page.
Note: The Tamper option controls the tamper input point only, not the Door Contact, Request
to Exit, or Aux Input points. Also, this option will not appear on the System
Administration > Devices page if a door is connected to an IPSDC, which does not
support reader tamper input.
Aux Input
Note: This field will not appear on the System Administration > Devices page if a door is
connected to an IPSDC, which does not support auxiliary input/output types. Refer to
the IP-based Single Door Controller Quick Reference to learn about modifying jumper
settings for input types.
None
Indicates the input is not used and not monitored.
Extended RTE
Intended for use only with the Door Opener option selected for Aux Relay.
If “Timed Unlock” is selected for Door Strike Mode, then the magnet will remain inactive until
that time has expired. However, it will still not activate until the magnetic bond sensor and door
contact sensor signals are received indicating the door is closed and bonded to the magnet.
Aux Relay
Note: This field will not appear on the System Administration > Devices page if a door is
connected to an IPSDC, which does not support auxiliary input/output types. Refer to
the IP-Based Single Door Controller Quick Reference to learn about modifying jumper
settings for input types.
None
Indicates the relay is not used and not energized.
Door Held/Forced
A typical use for this option is to have the relay trigger some physical alarm, such as a siren or
light, whenever the door is held or forced open.
Door Opener
Typically used with a door configured with a single reader for entry and a manual release wired
for RTE, and a push button for an Extended RTE automatic opener. The RTE input unlocks the
door for the duration that the manual release is active so that someone can exit normally. The
Aux input (Extended RTE) activates the Aux Relay for the specified Aux Relay On Time. This
relay output activates a door opener that automatically unlocks and opens the door for a person
needing assistance.
This setting only makes sense if Aux Input is configured for Extended RTE.
Input Types
NO (Normally Open)
The sensor switch is normally open.
NC (Normally Closed)
The sensor switch is normally closed.
Unsupervised
The circuit is not wired with a continuity circuit to detect tampering.
Supervised
The circuit is wired with a continuity circuit to detect tampering.
Note: For IPSDCs, refer to the IP-based Single Door Controller Quick Reference for
information about how to configure the switch settings based on input type selection.
Configure Readers
1. Select System Administration > Devices.
2. Expand the tree below the System Controller.
3. Expand the tree below the Door Controller.
4. Expand the tree below the Door.
5. Select the Reader to configure.
6. Select an Access Method.
• Credential Only
• Credential and PIN
• PIN Only
• Credential or PIN
7. Select a Linked Camera if one is positioned to watch this door and reader.
8. If the reader is to be used as a mustering reader, select Muster reader.
• If this option is not selected, the reader will function as a normal access reader.
• If this option is selected, when the system is in muster mode, the reader will function only as
a mustering reader, not an access reader. When not in muster mode, the reader will function
as a normal access reader.
9. Click [Accept Changes].
10. Repeat for other readers.
PIN Only
A person need only enter a valid Personal Identification Number (PIN) to gain access.
Credential or PIN
A person needs to present either a valid credential or enter a Personal Identification Number
(PIN) to gain access.
a. Select Enabled.
b. Type a meaningful name.
c. Select Active On/Off if the relay should be energized when the output is off, otherwise clear
the check box.
d. (Optional) Select a Linked Camera if one is associated with the output.
9. Click [Accept Changes].
Add a DVR/NVR
Before adding a DVR/NVR, see the Release Notes to determine the minimum firmware revision
required. Consult the DVR/NVR documentation for firmware update instructions.
1. Select System Administration > Devices > Video Devices.
2. Click [Add] and choose the appropriate model. If the model of the TruVision recorder is not
listed, try to add it by selecting TruVision Recorder.
3. Type a descriptive name for the device in the Device Name field.
4. Click the Properties tab. For each of the fields:
a. Type the User Name for logging into the device.
b. Type the Password for logging into the device.
5. Click the Addresses tab. For each of the fields:
a. Type the DVR hostname/IP address and Video Port of the device.
b. You may add [+] or delete [-] remote networks for the recorder. Refer to Universal
Accessibility on page 35.
6. Click [Accept Changes].
7. Click the link below Web Browser Configuration and Control to confirm the connection and
check the configuration of cameras attached to the device.
Mobile device Recorder type TruPortal 1.71 or later TruPortal 1.6 or earlier
Universal Accessibility
Recorders can be accessible from different networks with the proper configuration.
Port Forwarding
Port forwarding creates a mapping between an external port number accessible over the Internet to
the device port number on the LAN. This allows multiple recorders to be accessed from a public
network, provided the following setup instructions are followed:
1. Each recorder should be configured for unique ports. Most recorders use ports 80, 8000, and 554.
For example, configure recorder 1 to use ports 81, 8001, and 5541; configure the recorder 2 to
use ports 82, 8002, and 5542.
2. On the firewall/broadband router, configure the port forwarding settings. For example, incoming
TCP port 81 from the WAN side needs to be forwarded to the LAN IP address of recorder 1, TCP
port 81. Incoming TCP port 5542 on the WAN side needs to be forwarded to the LAN IP address
of recorder 2, TCP port 5542.
3. In the TruPortal software, under System Administration > Devices:
a. For a static WAN IP address, use it as the IP address of each recorder.
b. If it is not a static WAN IP address, use the external name of the site. It is assumed that there
is a Dynamic DNS update mechanism in place outside of TruPortal; most modern broadband
routers have a built-in mechanism by which the DNS entry can be updated every time the IP
address changes.
c. For each recorder configured in the device tree, be sure to use the correct port number (e.g.
8001 vs. 8002).
2. Using a router that supports DDNS functionality, enter the details of the account set up with the
service provider using the configuration utility. Refer to the manufacturer documentation.
3. Use static IP addresses for TruPortal panels and recorders connected to the LAN router port.
4. Set up Port Forwarding.
5. In the router configuration utility, register the DDNS URL.
Configuring Areas
Areas represent the spaces in the physical floor plan of a facility, specifically the entrances and exits
to those spaces. Defining areas allows users to identify which readers lead into those spaces, and
which readers lead out of those spaces into adjoining areas. Areas are used to track the physical
location of persons in the facility, which can be viewed in the Roster Report, and for anti-passback
(APB) tracking of credentials.
Add an Area
Before assigning readers to an area, the area must be created.
1. Select Access Management > Areas > Area Definition.
2. Click [Add].
Remove an Area
Configuring Anti-Passback
Anti-passback requires a credential be used to enter and exit an area so that the System knows which
area the credential holder is currently occupying. The System keeps a record of personnel movements
in secure areas, and prevents passage to areas that are logically impossible.
If a person uses a credential to enter an area configured for anti-passback, and then leaves the area
(through a door held open by another person, for example), the System will not know the person has
left the specific area. As a result, if the System is configured for hard anti-passback enforcement, it
will prevent that credential from being used to enter another area, including the one just left, until the
credential's location is reset to a default or neutral area.
Anti-Passback Options
An anti-passback violation occurs when a person presents a credential (ID Badge) to enter an area,
but somehow leaves the area without presenting the ID. The event is triggered when the person tries
to enter another area that is not physically connected to the person's last known area.
None
Anti-passback is not used.
Soft
An event is recorded when a credential violates anti-passback rules.
Hard
The credential violating anti-passback rules is prevented from accessing any areas until the
credential’s location is reset to a neutral or default area.
Configure Anti-Passback
To configure anti-passback, add areas to the System that match the areas in the site or floor plan,
assign readers to those areas, and add credentials.
1. See Add an Area on page 36.
2. See Assign Readers to Areas on page 37.
3. See Add a Credential on page 70.
Note: The Credential pane of the Access Management > Persons page allows users to exempt
individual credentials from anti-passback enforcement.
Mustering
In the event of an incident (such as an emergency or drill), mustering can be used to gather people
together in a specified area. When an incident occurs, the system can have the muster mode enabled.
Muster mode requires muster readers that are configured to be used in the event of an incident.
Note: Persons are mustered based on the system tracking their credentials, their location prior
to the mustering event, and where their credentials were last used. In cases where a
person has multiple credentials assigned and any of the credentials are used on a muster
reader, then the person would be reported as safe during the mustering event.
To utilize mustering, the proper permissions must be configured for the user:
• Mustering (Execution) - allows the user to enable or disable muster mode for the system.
• Mustering (Manipulation) - allows for viewing the muster report, manually changing people
between unsafe and safe areas, or manually adding people.
Click the Enable Mustering button ( ) to turn on the mustering mode for the system. When
mustering is turned on, the icon becomes red. Mustering can be toggled as enabled or disabled by
clicking the same button.
Muster Report
When mustering is enabled, a muster report can be generated. This report lists all persons currently
safe and unsafe. The user can toggle between the safe and unsafe list on the report. Users will use
credentials to check in at specified muster readers. Once a person has done so, they are moved to the
safe list.
1. Click the Open Muster Report Page button ( ) to view the muster report. The report displays
on its own page.
2. Mustering can be toggled on and off by clicking [Enable] or [Disable] on this page.
3. To manually add a person to the list, click [Add Person].
4. To manually move a person to the safe list, click the [Safe] button next to the name.
5. To export the report to a CSV file, click [Export as CSV].
For example, if a door is scheduled to automatically unlock every day from 8:00 a.m. to 5:00
p.m., that door will remain locked on a holiday rather than unlocking as it normally would.
Another example occurs if a person normally has card access to a particular door on Wednesdays
and a programmed holiday occurs on a Wednesday, then that person cannot access the door on
that day.
• To make an exception for a person that needs building access on a holiday, that person must be
assigned to a schedule that is excluded from the holiday group.
For example, to grant a person access to the building on Christmas day, adjust the access level of
the person (for example, an access level called “Support Staff”), link the access level to a specific
schedule (for example, a schedule called “24/7”), and then adjust the 24/7 schedule to include the
Christmas day holiday.
• To perform a scheduled unlock on a holiday, add the holiday to a schedule that is assigned to a
particular door.
IMPORTANT: The creation of a holiday group will take effect immediately. The holidays
added to this group will be excluded from ALL schedules, thereby removing
the specified days from normal operations on that particular date or set of
dates and causing the System to override the regular schedule. Refer to
Creating Holiday Groups on page 39 for details.
1. Select Access Management > Holidays.
2. Click [Add].
3. Type a descriptive name in the Holiday Group Name field.
By default, a newly created holiday group has one holiday in it.
a. Choose the date and pattern of the holiday:
• Single: a one time event.
• Repeats yearly: an event that occurs on the same date each year, such as the 25th of
December.
• Custom: an event that repeats yearly on a specified pattern, such as the last Monday of
May.
b. For a single or repeating holiday, type the start date in the Date field, or click the Calendar
icon next to the Date field to select a date from the Calendar pop-up window.
c. Type the number of days that the holiday spans in the Duration field. (By default, a newly
created holiday is one day long. Valid values are 1 to 366.)
4. To add another holiday to the group, click [Add] in the holiday list pane and repeat steps a
through c.
5. Click [Accept Changes].
b. Click the check box above each day that should be added to the interval.
c. Type values for the start and end times.
d. For a single or repeating holiday, type the start date in the Date field, or click the Calendar
icon next to the Date field to select a date from the Calendar pop-up window.
e. Type the number of days that the holiday spans in the Duration field.
5. Click [Accept Changes].
Creating Schedules
Schedules are used to determine when a person will be granted access at a reader, or when a door will
automatically lock or unlock. Up to 64 schedules can be created and used in the System, including the
following pre-defined schedules:
• All Days 24/7
• Weekdays 8AM-5PM
• Weekdays 9AM-6PM
• Weekdays 7AM-7PM
An interval is the period of time during which a schedule is active. Schedules can include multiple
intervals. For example, if the office cleaning staff vacuums the floors on Wednesdays, but on the
other days of the week cleans only the rest rooms and trash bins, they would need access for more
hours on Wednesday than on other days of the week. In this case, one interval could be created for
Wednesday and another for the other days of the week.
Note the following details about schedules:
• Schedule times are expressed in hours and minutes, not seconds, but interval start times are
relative to the start of the minute (0 seconds), and interval end times are relative to the end of the
minute (59 seconds). In the pre-defined 24/7 schedule, notice that the start time is 12:00 AM and
the end time is 11:59 PM. Expressed in seconds, the start time is 12:00:00 AM and the end time
is 11:59:59 PM, a one second difference. A schedule that passes midnight must be set up this
way, because if 12:00 AM was entered as the start and end time, the schedule would be active for
only 59 seconds (from 12:00:00 to 12:00:59).
• Action triggers, schedules, and manual control can all impact the state of devices and are treated
equally by the System. The last operation executed determines the state of a device.
• When a date is designated as a holiday, the System makes an exception to all normal operations
on that particular date or set of dates unless customized schedule programming is created for the
same date. Refer to Creating Holiday Groups on page 39 for details about how holidays impact
schedules.
• Schedules to control reader access times are assigned via the Access Management > Access
Levels page.
• Schedules to control door locking are assigned via the Monitoring > Doors page.
Add a Schedule
1. Select Access Management > Schedules.
2. Click [Add].
3. Type a descriptive name in the Schedule Name field.
4. Click Holiday Groups.
5. Select the holiday groups that are included in this schedule.
Note: Holidays are exceptions to normal access schedules. Including a holiday group in a
schedule keeps that holiday group from overriding that schedule. For example, if a
holiday group for bank holidays is created and the business office is closed on those
days, that holiday group should not be selected for the schedule for the office workers
access level. However, if the shipping department works on holidays, the bank holiday
group could be selected for the schedule for the shipping workers access level, thus
preventing the bank holiday group from overriding the shipping schedule.
6. Click [Accept Changes].
Copy a Schedule
1. Select Access Management > Schedules.
2. Select the schedule to copy.
3. Click [Copy].
4. Type a descriptive name in the Schedule Name field.
5. Add, remove or change time intervals as required.
6. Click [Accept Changes].
Remove a Schedule
1. Select Access Management > Schedules.
2. Select the schedule to remove.
3. Click [Remove].
The Remove Item dialog box appears.
4. Click [Remove].
Elevator Control
TruPortal supports two types of elevator control. The first type is integration with the Otis Compass
System. A key feature of the Otis System is the ability to restrict or allow cardholders’ access to
specific floors. In addition, the Otis System will direct cardholders to the elevator that will take them
to their desired floor in the most efficient manner.
The second type of elevator control is the configuration of elevators as controllers, using inputs and
outputs to represent floors of the building (IO elevator control, also referred to as hardwired elevator
control). For elevator access control, access levels and schedules are created and assigned to
cardholders’ credentials. Depending on the definition of access levels and schedules, cardholders can
be granted or denied access to specific floors. Elevators may be added as a Devices group. The
system supports up to eight elevators and up to 64 floors.
Configure Elevators
Note: If a reader is already assigned to an area and then configured for elevator control, it will
be treated the same as removing a door controller. A message will appear stating that
this must be corrected on the Reader Assignments tab. Refer to Assign Readers to Areas
on page 37.
1. Select System Administration > Devices.
2. Click Elevators.
3. Click [Add], choosing either Otis Compass System or IO Elevator Controller.
4. Type a descriptive name for the elevator in the Device Name field.
5. For the Otis Compass System:
a. Click [Add], choosing either Compass DES or Compass DER.
b. Type a descriptive name for the elevator in the Device Name field.
c. Click the Properties tab.
1) Enter the Device Address.
2) If you are using access control on elevators, select Enable Allowed Floors and select
the Access Level for Allowed Floors.
d. Click [Add], choosing Compass DEC.
1) Select the Associated door. The door selection must have an entry reader.
2) Enter the IP address.
3) Select the Mode. You may choose Access to authorized floors only or User entry of
destination floor.
6. For the IO Elevator Controller:
a. Click the Properties tab.
b. Select Associated Door. The door selection must have an entry reader.
c. Select the Mode.
• Non-tracking – Credential usage for elevator controls is not tracked. Outputs must be
defined.
• Tracking – Based on credential usage, people are tracked with respect to the floors they
access. If the person has access to the floor selected, the elevator cab is sent to the
desired stop. If the person does not have access to the floor, access will be denied. Both
inputs and outputs must be defined.
d. Select the Floor illumination time. This is required for both non-tracking and tracking
modes.
• In non-tracking mode, this indicates the time a person has to make a floor selection after
access is granted.
• In tracking mode, this indicates the time the relay (in this case, the floor selection) is
active.
e. Select the Floor selection time. This is only required for tracking mode. This indicates the
time a person has to make a floor selection after access is granted.
f. Select a Linked Camera if one is positioned to watch this elevator.
g. If you want to switch the state of outputs assigned to the elevator’s floors, select Reverse
Polarity of Outputs. This controls fail-safe or fail-secure configuration.
• Fail-safe (the check box is not selected): if the system does not function properly, all
floor buttons will be available.
• Fail-secure (the check box is selected): if the system does not function properly, the
destination floor buttons will not function.
7. Click [Accept Changes].
8. Repeat this procedure for additional elevators.
Configure Floors
1. Select System Administration > Devices.
2. Expand the tree below the Elevators.
3. Select the device to configure.
4. Click the Configure Floors tab.
a. Click Add floor to define the elevator floors. The Add Floor to Building dialog box appears.
b. Enter the Starting Floor number. If you are entering a range of floors, enter the Number of
floors.
c. Choose Front or Back from the drop-down list box to define which side of the elevator the
door is on.
d. Click [OK].
e. In the text box, edit the name of the floor to a descriptive name.
f. The floors are assigned to outputs if they are configured for non-tracking mode. The floors
are assigned to inputs and outputs if they are configured for tracking mode. If you want to
change the configuration, make a selection from the drop-down list box. These input and
output assignments must be unique.
5. Click [Accept Changes].
6. Repeat for other floors.
Configuring Email
The System can be configured to send automated emails when certain events occur, such as a
database backup, or when an action trigger is executed.
The System includes one predefined email list to which recipients can be added for automated email
messages. Up to ten email lists, each of which can contain up to ten recipients, can be created for use
with automated emails.
To use the automated email feature, configure the System to use either an internal or external Simple
Mail Transfer Protocol (SMTP) server, and add at least one email recipient to the predefined email
list.
Note: Some ISP and email service providers limit the amount of emails that can be sent each
day and may charge extra for any quantity over that amount. In some cases, a provider
will block the account when the maximum quantity is exceeded. If these issues are
restrictive, consider using a paid SMTP relay service or hosting an internal email server.
1. Select System Administration > Email > Server Settings.
2. Select Enable Email Notifications.
3. If connecting to a secure email server, select the Enable Authentication check box.
a. Type the IP address or hostname of the email server in the Email Server field.
b. Type the port number of the email server in the Port field.
If the email server uses SSL, the default value is 465; otherwise, the default value is 25.
c. If the email server uses SSL, select the Requires SSL check box.
d. Type the user name for the email service account in the User field.
e. Type the password for the email service account in the Password field.
4. If connecting to an email server that does not require a user name and password, leave the
Enable Authentication check box unselected.
a. Type the IP address or hostname of the email server in the Email Server field.
b. Type the port number of the email server in the Port field.
If the email server uses SSL, the default value is 465; otherwise, the default value is 25.
c. If the email server uses SSL, select the Requires SSL check box.
d. Type the name that will appear on automated emails in the Sender Name field.
e. Type the email address that will appear on automated emails in the Sender Email field.
If recipients should not reply to automated emails, consider creating a “no reply” email
account such as “[email protected]” that can be used as the sender address.
5. Click [Accept Changes].
6. Click [Test Email Server] to check the email server settings.
Note: An email list cannot be deleted if it is currently being used by the System.
1. Select System Administration > Email > Email Lists.
2. Click the email list to select it.
3. Click [Remove].
The Remove Item dialog box appears.
4. Click [Remove].
IMPORTANT: For best results, use a person record identifier, such as an employee number,
that is unique to each person in the organization. Without a way to identify
each record as unique, then updates, imports, exports and other database
maintenance actions may result in changes being made to the wrong record.
When user-defined fields are created, they can be designated as protected. The settings for this option
determine whether the user-defined fields with the Protected feature selected are visible or modifiable
by various operator roles. This gives an added level of privacy for sensitive information, such as
home telephone numbers. For example, if users with the Operator role should be able to view all
personal information and users with the Guard role should be able to view only non-protected
personal information, change the operator role settings as shown in the following table:
IMPORTANT: Do not edit the field labels in an attempt to rearrange their order. The data is
associated with the field, not the field label. Changing the label will not
rearrange the order, but will cause the data to be mislabeled.
1. Select System Administration > System Settings.
2. Click the User-Defined Fields tab.
3. Use the Order arrows to move fields upward or downward.
The order of fields on this tab matches the order of fields on the Access Management > Persons
page.
Note: Do not confuse door and reader behavior with access. The Access Management >
Access Levels page is used to assign schedules to readers and reader groups. Access
levels are then assigned to credentials, determining what days and times a person with
that credential can gain entry through the readers in that access level. The mode of
access, credential only or credential and PIN, is not relevant to the access level. (See
Configuring Security on page 18.)
1. Select Monitoring > Doors.
2. Click the Schedule View tab.
3. For each door and reader combination:
a. Select a Schedule.
b. Select a Schedule Mode.
For doors the Schedule Modes are:
• Unlocked
• First Card In
• Locked
For readers the Schedule Modes are:
• Credential Only
• Credential and PIN
• PIN Only
• Credential or PIN
Note: Persons can also have a user account on the System, allowing them to log into and use
the System. User account information is not processed by the Import/Export Wizard.
The Import/Export Wizard can be used to map the fields of a CSV file to the System database table,
and import persons and credentials data from another source, such as a human resources database or
another access control system. Refer to the Import/Export Wizard User Guide for details.
Note: A person record consists of user-defined fields for personal information, access
credentials (badge ID, PIN, access level) and optional user account information to allow
login to the System. Import and export of user account data is not supported. Only user-
defined personal data and credential data can be imported and exported.
Person records can also be added individually, as described in Managing Persons on page 67.
Understanding Triggers
Use the Triggers tab on the Action Triggers page to define trigger conditions that will execute
actions. A trigger consists of one or more condition groups, and a condition group consists of one or
more condition statements.
Each condition statement includes four drop-down list boxes where users can:
• Specify an entity type, such as Door or Schedule.
• Specify an qualifier related to the selected entity type. If Door is selected as the entity type,
options in this list box will include Any, All, and a list of doors defined in the System.
• Specify whether the condition should be true or false.
• Select a condition that would trigger an action. If Door is selected as the entity type, options
include Secure, Unlocked, Locked Out, Held Open, Forced Open, Tampered, Open, and
Mag Sensor Trouble.
The following table lists available trigger conditions for each entity type:
Entity: Area
Entity: Credential
Granted - No Entry Becomes true/false when door is not opened and no APB
violation occurs.
Granted - No Entry Soft Becomes true/false if the door is not opened, and the
APB reader leads to a non-outside area with a soft APB
violation.
Granted - Entry Made Becomes true when door is opened and reader leads to
non-outside area.
Granted - Entry Made Soft Becomes true/false if door is opened and reader leads to
APB non-outside area and soft APB violation.
Granted - Egress Made Becomes true/false if the door is opened, and the reader
leads to an outside area with no APB violation.
Granted - Egress Made Becomes true/false if the door is opened, and the reader
Soft APB leads to an outside area with a soft APB violation.
Granted - No Egress Soft Becomes true/false if the door is not opened, and the
APB reader leads to an outside area with a soft APB violation.
Denied - Any Reason Becomes true/false when access is denied for any
reason.
Denied - Hard APB Becomes true/false when access is denied due to hard
APB violation
Denied - Door Locked Out Becomes true/false when access is denied due to door
locked out.
Entity: Door
Locked Out Becomes true when door is locked out. Becomes false
when door lockout is no longer active
Held Open Becomes true when door held open alarm is active.
Becomes false when door held open alarm is restored.
Forced Open Becomes true when door forced open alarm is active.
Becomes false when door forced open alarm is restored.
Mag Sensor Trouble Becomes true when mag sensor alarm is active.
Becomes false when mag sensor alarm is restored.
Entity: Input
Entity: Output
Off Becomes true when output is off. Trigger false when input
is not off.
Entity: Module
Entity: Reader
Granted - No Entry Becomes true/false when door is not opened and no APB
violation occurs.
Granted - Entry Made Becomes true when door is opened and reader leads to
non-outside area.
Granted - Entry Made Soft Becomes true/false if door is opened and reader leads to
APB non-outside area and soft APB violation.
Granted - No Entry Soft Becomes true/false if the door is not opened, and the
APB reader leads to a non-outside area with a soft APB
violation.
Granted - Egress Made Becomes true/false if the door is opened, and the reader
leads to an outside area with no APB violation.
Granted - Egress Made Becomes true/false if the door is opened, and the reader
Soft APB leads to an outside area with a soft APB violation.
Granted - No Egress Soft Becomes true/false if the door is not opened, and the
APB reader leads to an outside area with a soft APB violation.
Denied - Any Reason Becomes true/false when access is denied for any
reason.
Denied - Facility Code Becomes true/false when access is denied due to invalid
facility code.
Denied - Issue Code Becomes true/false when access is denied due to invalid
issue code.
Denied - Hard APB Becomes true/false when access is denied due to hard
APB violation
Denied - Door Locked Out Becomes true/false when access is denied due to door
locked out.
Entity: Schedule
15 Minutes Before Start Becomes true when 15 minutes prior to schedule start.
Becomes false when schedule starts.
15 Minutes Before End Becomes true when 15 minutes prior to schedule end.
Becomes false when schedule ends.
Entity: System
Lockout All Doors - Becomes true when lockout goes active. Becomes false
Command when lockout is no longer active.
Unlock All Doors - Becomes true when unlock goes active. Becomes false
Command when unlock is no longer active.
Backup Battery Low Becomes true when battery voltage drops below 11.7
VDC. Becomes false when battery voltage goes above
11.7 VDC.
Memory Battery Low Becomes true when battery voltage drops below 2.0
VDC. Becomes false when battery voltage goes above
2.0 VDC. Only checked every 6 hours.
Fuse Tripped Becomes true when any fuse trips. Becomes false when
all fuses are restored.
Time Changed Becomes true when time is changed. Will not rearm for
one minute. Automatically becomes false after one
minute.
• If a Holiday Group check box is excluded from a schedule (i.e. the check box is cleared), then the
schedule will not be active at any time during the days defined in the Holiday Group. This is
regardless of what days of the week are selected for the schedule.
• If the same day is part of one Holiday Group that is included in a schedule and is also part of
another Holiday Group that is excluded from the same schedule, the day will be included in the
schedule.
To guarantee that an action will be triggered regardless of whether or not a day is a holiday, create an
“or” statement with the trigger conditions by using the “Any Can Occur” option. For example, add
one trigger condition that will be true when a Weekdays 9AM - 6PM schedule is in effect, and a
matching trigger condition will be true when holidays are in effect.
The following example shows when a Holiday in Effect trigger is active if a holiday negatively
impacts a schedule for a Weekdays 7AM - 7PM schedule:
No holidays defined
Holiday in Effect
Holiday 1 (2/14-2/16)
check box is cleared
Holiday 2 (2/15-2/18)
check box is cleared
Holiday 1 (2/14-2/16)
check box is selected
Holiday 2 (2/15-2/18)
check box is cleared
Understanding Actions
Use the Actions tab on the System Administration > Action Triggers page to define the actions that
will be executed when a trigger condition becomes true or false. (Action triggers can also be executed
on the Monitoring > Action Triggers page. See Controlling Action Triggers on page 86.)
For example, a condition statement can be defined on the Triggers tab to specify that an action will
occur if any door is forced open. An action can then be configured on the Actions tab that when the
condition statement becomes true, an automated email will be sent out to all supervisors. If a door is
forced open after this action trigger record is created, an automated email will be sent to all on-site
supervisors.
Actions Notes
Entity: Doors/Readers
Open Extended Unlocks door strike for extended grant access time.
Note: Does not affect reader access mode.
Door Buzzer Off Turns off door buzzer output. Note: IPSDCs do not
support this action.
Credential and PIN - In Sets reader to “Credential and PIN” access mode.
Reader Note: Does not affect door strike.
Credential and PIN - Sets reader to “Credential and PIN” access mode.
Out Reader Note: Does not affect door strike.
Credential and PIN - In/ Sets reader to “Credential and PIN” access mode.
Out Readers Note: Does not affect door strike.
Actions Notes
PIN Only - In Reader Sets reader to “PIN Only” access mode. Note:
Does not affect door strike.
PIN Only - Out Reader Sets reader to “PIN Only” access mode. Note:
Does not affect door strike.
PIN Only - In/Out Sets reader to “PIN Only” access mode. Note:
Readers Does not affect door strike.
Entity: Output
Pulse On Pulses output on, then back to off, for the selected
duration.
Note: The accuracy of pulse duration varies
depending on the pulse length. See Pulse Duration
Accuracy on page 121.
Pulse Off Pulses output off, then back to on, for the selected
duration.
Note: The accuracy of pulse duration varies
depending on the pulse length. See Pulse Duration
Accuracy on page 121.
Entity: Area
Actions Notes
Aux Relay Off - Doors See corresponding door command. Affects all
doors with in or out readers associated with the
area.
Credential and PIN - All See corresponding door command. Affects all
Readers readers that can enter or exit the area.
PIN Only - Exit Readers See corresponding door command. Affects all
readers that can exit the area.
PIN Only - All Readers See corresponding door command. Affects all
readers hat can enter or exit the area.
Actions Notes
Note: To provide a quick way to secure all doors in a facility, create an action trigger record to
lock all doors, and then trigger it manually on the Monitoring > Action Triggers page
when necessary.
• Disabled inputs and outputs can be included as an action, but they will have not be implemented
until the input or output is enabled.
• Action triggers, schedules, and manual control can all impact the state of devices and are treated
equally by the System. The last operation executed determines the state of a device.
• Action triggers do not override the global “Lockout All Doors” or “Unlock All Doors” door
states.
• If an entity (for example, a reader) is defined in an action trigger record and then the entity is
deleted from the System, all corresponding action trigger records will also be deleted. If the
entity is recreated, new action trigger records can be created for the entity.
• If the System is configured to send automated emails, an action trigger record can be created to
send a notification to an email list when a trigger condition changes. Email delivery will be
attempted for the selected Retry Limit duration relative to when the action was triggered.
• An e-mail notification contains information about the person triggering the action (as well as the
cardholder’s name and credential information) for certain reader triggers:
– Granted
– Granted – No Entry
– Granted – No Entry Soft APB
– Granted – Entry Made
– Granted – Entry Made Soft APB
– Granted – Egress Made
– Granted – Egress Made Soft APB
– Granted – No Egress Soft APB
– Denied – Any Reason (only if person information is available)
– Denied – Facility Code
– Denied – Issue Code
– Denied – PIN (only if person information is available)
– Denied – Unauthorized
– Denied – Hard APB
Note: Avoid adding large quantities of Email actions to avoid “spamming” recipients.
a. Click [Add] beneath the Activation Actions or Deactivation Actions section.
Note: For security purposes, use Secure FTP or FTPS. Do not use unencrypted protocols such
as CIFS and FTP.
To configure a network share for scheduled backups:
1. Select System Administration > Network Share.
2. Click [Add].
3. Select a communications protocol in the Protocol field to connect to a remote file system, or
select None to use a network folder.
Note: As data is entered in the fields on the page, the Share Name field will change to reflect
the new information.
4. If FTP or FTPS was selected in step 3, type the port number of the connection in the Port field.
5. Type the IP address or hostname of the network share in the Host field.
6. Type the directory location of the network share in the Host field.
7. If a remote file system protocol was selected in step 3, type the user name needed to log into the
system in the User field.
8. If a remote file system protocol was selected in step 3, type the password needed to log into
system in the Password field.
9. Click [Accept Changes].
Managing Persons
Each individual in an organization can have access to the building and access to the System. Access
to the physical facility is controlled by means of a credential (commonly called an ID badge). Access
to the System is controlled by means of a user account to log into the System Controller. To keep the
user accounts and credentials organized, the System associates both with one record for each
individual in an organization. This individual database record is called a “person” because it
corresponds to an actual person.
The distinction between persons, credentials, and user accounts is important. First, everyone who
needs to enter a facility will need a credential (an ID badge with an encoded number that is
recognized by the System). However, not everyone who needs access to the facility will also need
access to the System with a user account. Second, only those who operate and manage the System
will need user accounts. Third, in some cases, operators are located off-site at a central station and
therefore do not require a credential to access the physical facility even though they have a user
account.
The database records, “persons,” allow users to conveniently manage credentials and user accounts
from one record, rather than maintaining separate databases for system users and facility access
credentials.
Add a Person
Before adding person records, be sure to:
• Assign each person record a unique identification number of some kind. This may be an
employee number, for example.
• Add any necessary user-defined fields that can be used to enter personal data about personnel,
such as vehicle license plate number or home telephone number. See Configuring User-Defined
Fields on page 51.
There are several ways to add person records:
• By using the Access Management > Persons page, as described next.
• By using the adding Add Person Wizard available on the Home page.
• By using the Import/Export Wizard provided on the Utilities disc to import person records and
credential data that already exists in CSV format (for example, if such data was exported from
another access control system or employee database). Refer to the Import/Export Wizard User
Guide for details.
• By using the optional Learn-In Reader. See Using an Enrollment Reader on page 70.
• By using the link in an event generated when an unknown person attempts access.
To add person records on the Access Management > Persons page:
1. Click Access Management > Persons.
2. Click [Add].
3. Type a First Name and a Last Name.
4. Click the Details tab.
5. Type the requested information in the user-defined fields.
6. If the person will use the System software, click the User Account tab and create the account.
See Add a User Account on page 72.
7. Click [Accept Changes].
8. If the person requires a credential for access to the physical facility, see Add a Credential on page
70.
Remove a Person
The System can store up to 10,000 person records. However, persons no longer requiring access to a
site or to the System should be removed from the database.
Note: To remove a number of persons in one batch, use the Import/Export Wizard provided on
the Utilities disc.
1. Click Access Management > Persons.
2. Select the Person from the list of persons.
3. Click [Remove].
The Remove Item dialog box appears.
4. Click [Remove].
Note: To update an existing photo, click the existing photo and repeat these steps.
Managing Credentials
Every person who needs to enter a facility will need a credential (i.e., an ID badge with an encoded
number that is recognized by the System). Before assigning a credential, add the person to the
database. See Add a Person on page 68.
Note: Whenever credentials are changed or deleted, the local cache on IPSDCs is cleared to
prevent unauthorized access in case IPSDCU Fallback Mode is being used. See
IPSDCU Fallback Mode on page 19.
Add a Credential
Before adding a credential to a person, first create a record for that person. See Add a Person on
page 68.
1. Select Access Management > Persons.
2. Select the Person needing the credential.
3. Click [Credentials].
4. Click [Add Credential].
5. Click the General tab.
6. Type the Credential ID.
If the optional enrollment reader is attached to the local client workstation, click inside the
Credential ID field and then swipe the person’s badge card through the reader to populate the
field.
7. (Optional) Type the PIN code.
Note: Use a pound sign (#) at the end of each PIN, especially if the PIN length is less than the
Max PIN Length defined on the Security tab of the System Administration > System
Settings page. Pound signs are required for PINs used on devices connected to IPSDCs.
8. (Optional) Select Use extended strike/held times if the person with this credential needs extra
time to open and pass through doors.
9. (Optional) Select Anti-Passback Exempt if using anti-passback and this credential is not to be
tracked.
10. (Optional) Select an Active From and Active To date if the credential has a limited duration for
its validity.
11. Click the Access Levels tab.
12. Select the Access Levels that apply to this credential.
13. Click [Accept Changes].
A credential may also be added using the link in an event generated when an invalid credential is used
to attempt access.
Remove a Credential
A credential does not need to be removed to prevent its use. For example, if an individual reports a
lost credential, rather than delete the credential right away, it can be deactivated until such time as the
individual has had time to search for it. If the credential cannot be found, then, when the individual
requests a new credential, the lost credential can be removed. See Prevent Use of a Lost or Stolen
Credential on page 71.
1. Select Access Management > Persons.
2. Select the Person with the credential to be deleted.
3. Click [Credentials].
4. Click the credential to be deleted.
5. Click [Remove Credential].
6. Click [Remove].
7. When the Remove Item dialog box appears, click [Remove].
Creating Reports
Six pre-defined reports allow users to view information stored in the server database:
Access History
A summary of access attempts by person, filtered by Date Range, Person Name (wildcard),
Reader, Area, and Grant or Deny response.
Audit Log
A record of actions performed by administrators or operators of the system over a period of time.
See Audit Log on page 97.
Credential
A list of credentials assigned, filtered by Person Name (wildcard), Credential ID (wildcard),
Access Levels, and Active or Inactive status.
Reader Access
A list of Persons with access to each reader, filtered by Person Name (wildcard) and Reader.
Roll Call
A list of Persons by current area or last reader, filtered by Person Name (wildcard), Reader, Area,
and events. Select Include “Access/Egress Granted - No Entry” events to include events that
occurred when access or egress was granted, but whether or not access or egress actually
occurred cannot be determined.
Roster
A list of all Persons in the database, filtered by Person Name (wildcard) and Login privileges.
Create a Report
1. Select Reports.
2. Select the type of report to create.
3. Fill out the report-specific fields, as desired.
4. Click [View] to display the report in a new browser window.
5. To export a report:
a. Click [Export].
b. When prompted, click [Save].
c. In the dialog box that appears, navigate to the location where the report will be saved in CSV
format.
d. Click [Save].
Note: If the “Generating reports” notification continues to appear and the main User Interface
dims, the local client workstation may be low on memory. Close the browser window to
end the session, close open programs that are not currently needed, log back in, and try
to create the report again.
Search Persons
1. Select Access Management > Persons.
2. Click [Search] and select a field to search.
The [Search] button appears next to the Search text box and looks like a magnifying glass. When
it is clicked, a list of fields that can be searched drops down beneath the button.
3. Type the search term.
4. Press <Enter>.
Cancel a Search
The Search results will continue to filter the database, even if a user navigates to another page and
returns to the Persons page, until the search is cancelled.
1. Select Access Management > Persons.
2. Click the X to clear the search field.
During day to day operations, facility access can be monitored and controlled by:
• Viewing events.
• Watching security camera video, if cameras were installed.
• Overriding scheduled door behavior to open, unlock, lock out, reinstate, or secure doors.
• Responding to alarms.
Topics in this section include:
• Monitoring Events and Alarms on page 75
• Monitoring Video of Events on page 77
• Controlling Doors on page 81
• Controlling Inputs and Outputs on page 85
• Controlling Action Triggers on page 86
• Resetting Anti-Passback on page 86
• Alarms
• Door tampering
• Doors forced open
• System failures or problems
Note the following details about the Events page:
• Any event associated with a device linked to a camera will have a video record of the event.
• To sort events, click a column header.
• The Events page will auto-scroll when new events are generated if the list is sorted by Date and
Time with the most recent event at the top, and the list is showing the previous new event at the
top (i.e., the list is scrolled all the way to the top).
• Click a device in the Device column to access the Monitoring > Doors page and display details
about a device.
Click an event to display a detail pane that shows the date and time of the event, along with a
description of the event. Additional event information is provided, depending on whether the event is
person-related (for example, Access Granted) or device-specific (for example, Door Unlocked):
• For person-related events, the detail pane will also include the person’s name, credential, and
photo, if available. Double-click a photo to access the Access Management > Persons page and
display details about the individual.
• For device-specific events, the detail pane will include an event description, date, time, device
information, and event-related video, if available.
Click [Close] on the detail pane when finished reviewing event information.
Export Events
The System can store up to 65,535 events. Once this limit is reached, older events are deleted as
needed to make room. Use the Export Events command to store a record of events in a comma-
separated-values (CSV) format file.
1. Select Events.
2. Click the circular [Events] action button.
3. Select Export Events.
4. Choose the location on the client workstation where the file will be saved.
5. Type a descriptive filename with the extension .csv.
6. Click Save.
Note: If the Custom level... button is not enabled, network security policies may be in place to
prevent users from changing Internet Explorer settings. Contact the network
administrator or run Internet Explorer as an administrator.
4. Scroll down the Security Settings list to display the ActiveX controls and plug-ins settings.
5. For Automatic prompting for ActiveX controls, click Enable.
6. For Download signed ActiveX controls, click Enable or Prompt.
7. For Initialize and script ActiveX controls not marked as safe for scripting, click Enable or
Prompt.
8. For Run ActiveX controls and plug-ins, click Enable or Prompt.
9. For Script ActiveX controls marked safe for scripting, click Enable or Prompt.
10. Scroll down the Security Settings list to display the Miscellaneous settings.
11. For Active scripting, click Enable or Prompt.
12. Scroll down the Security Settings list to display the Scripting settings.
13. For Use Pop-up Blocker, click Disable.
14. Click OK, and then click OK again to save the settings.
Also, the first time video is accessed, a message will appear to indicate that a proprietary video player
must be installed. Click [Download and Install] to install the software. (If network security policies
block the download, contact the network administrator or run Internet Explorer as an administrator.)
After a message appears to indicate that the video player was installed successfully, log out of the
System and then log back in to access video.
IMPORTANT: Existing TruPortal 1.0 or goEntry 3.0 users must uninstall (if applicable) the
current version of the TruPortal ActiveX Control via the Control Panel >
Programs and Features > Uninstall a Program option before installing the
updated proprietary video player.
Monitor Video
While the Events page displays recorded video of events linked to specific devices, the Monitoring >
Video page lets users monitor overall site security. For example, if a suspicious person is lurking in
the parking lot, this would not trigger a door or reader event, but if a camera is watching the parking
lot, the person could be detected by a user watching that camera.
Note: Before live or recorded video can be monitored, add at least one video layout. See Add
Video Layouts on page 34.
To monitor video:
1. Select Monitoring > Video.
Note: If a message appears to indicate that the video player needs to be installed, click
[Download and Install]. When installation is complete, log out and then log back in to
play event video. See Before You Begin on page 77 for details.
2. Select a Layout.
3. To view live video, click [Live].
4. To view recorded video, click [Playback] and select an option from the menu that appears.
5. (Optional) To reposition a PTZ camera, click the PTZ button to open and adjust the PTZ
controls.
Iris control Opens or closes the camera iris to adjust for the
amount of light available
Pan and Tilt controls Moves the camera in the direction(s) indicated by
the respective arrow.
PTZ variable speed Controls the speed of PTZ for smoother operation.
Use the slider or click [+] or [–] to change the speed
on the PTZ camera. The number indicates the
current settings.
Single Step Reverse Moves the recorded video back one frame.
control
Single Step Forward Moves the recorded video ahead one frame.
control
Enable PTZ control Opens the Pan, Tilt, Zoom controls (only works with
PTZ cameras).
Controlling Doors
The Monitoring > Doors page shows the status of the doors, the assigned readers, recent events at
those doors, and the assigned schedules. This page allows operators to lock out, open, reinstate, and
unlock doors.
Open a Door
Use the Open Door command to open a door for someone without a credential.
1. Select Monitoring > Doors.
2. Click the Event View tab.
3. Click the Individual Door Commands action button for the door to be opened.
4. Select Open Door.
Unlock a Door
Use the Unlock Door command to override security for the door, allowing anyone to exit or enter
without presenting a valid credential.
1. Select Monitoring > Doors.
2. Click the Event View tab.
3. Click the Individual Door Commands action button for the door to be unlocked.
4. Select Unlock Door.
Reinstate a Door
Use the Reinstate Door command to return the door to its normal mode of operation after unlocking it
or locking it out.
1. Select Monitoring > Doors.
2. Click the Event View tab.
3. Click the Individual Door Commands action button for the door to be reinstated.
4. Select Reinstate Door.
Secure a Door
Use the Secure Door command to lock a door.
1. Select Monitoring > Doors.
2. Click the Event View tab.
3. Click the Individual Door Commands action button for the door to be secured.
4. Select Secure Door.
Note: To provide a quick way to secure all doors in a facility, create an action trigger record to
lock all doors, and then trigger it manually on the Monitoring > Action Triggers page
when necessary. See Configuring Action Triggers on page 53.
Note: If all doors are locked out when a new door controller is added, the new door controller
will remain unlocked. To be locked out, all doors must be reinstated, then all doors
locked out again.
Note: After unlocking all doors or locking out all doors, use the Reinstate All Doors
command before trying to control any door individually.
Unlock All Doors
Releases the locks on all doors, allowing free access and egress. This will be recorded as Event
14644. After issuing this command, reinstate all doors so that individual doors can be controlled
directly.
Unlock Door
Releases the lock on the door, allowing free access and egress, until the door state is changed by
either a reader schedule or a global (“all doors”) command.
Reinstate Door
Restores the door to default behavior based on the schedule.
Lockout Door
Locks the door and ignores credentials, so that no one can enter or exit.
Secure Door
Locks the door.
First Card In
The door will go to locked at the beginning of the schedule and remain in this state until the first
valid credential is swiped. At that point, the door will switch to an unlocked state.
Locked
The door will be locked and require a valid credential for entry during the selected schedule.
PIN Only
A person need only enter a valid Personal Identification Number (PIN) to gain access.
Credential or PIN
A person needs to present either a valid credential or enter a Personal Identification Number
(PIN) to gain access.
Site Code
Access if granted if the card matches one of the formats defined on the System Administration >
Card Formats page, and the site code on the card matches the site code defined for the format.
The credential ID is not checked.
All
Access is granted if the card matches any of the formats defined on the System Administration >
Card Formats page regardless of the site code or credential ID.
Resetting Anti-Passback
Anti-passback requires that a credential be used to enter and exit an area. In this way, the System
tracks which area the credential holder is currently occupying, keeps a record of personnel
movements in secure areas, and prevents passage to areas that are logically impossible. If a person
uses a credential to enter an area configured for anti-passback, and then leaves the area without using
the credential (through a door held open by another person, for example), the System will not record
that the person has left the specific area. As a result, if the System is configured for hard anti-
passback enforcement, it will prevent that credential from being used to enter another area, including
the one just left, until the credential's location is reset to a default or neutral area.
1. Select Monitoring > Anti-Passback Reset.
2. To reset all persons:
a. Click [Reset All].
b. Select an area from the list.
3. To reset selected persons:
a. Select a range of persons by clicking the first name in the list, holding <Shift>, and clicking
the last person. The range of names is highlighted.
b. Select individuals by clicking the first name desired, holding <Ctrl> and clicking on other
names to select them.
c. Click [Reset Selected].
A few simple maintenance activities will help make sure the System runs efficiently with minimal
trouble or disruption to service. These include backing up the database and checking for firmware
updates.
Topics in this section include:
• Backing Up Data on page 89
• Saving and Restoring Custom Settings on page 91
• Updating the Firmware on page 93
• Managing Language Packs on page 94
• Managing Plugins on page 96
• Audit Log on page 97
Backing Up Data
Periodic backups of the System database are highly recommended to ensure quick recovery of
security needs following a disaster. The System saves backups to the local client workstation, so a
copy exists that is not on the System Controller. The encrypted backup file includes all records,
photos, and settings configured in the System with the exception of:
• Door/reader states set manually via the Monitoring > Doors page, and
• Events.
Database backups can also be scheduled to occur automatically, with emails sent out after successful
or failed backups. Events can also be backed up to a CSV file.
backups can be scheduled, as described in Schedule Automated Backups on page 90. (To back up
events, refer to Back Up Events on page 91.)
1. Log into the System as a user with Execute permissions for the Scheduled Backups feature.
2. Select System Administration > Backup/Restore.
3. Click [Schedule Backup].
4. To create a schedule for a database backup:
a. In the Database Schedule Configuration area of the page, select Schedule Enabled.
b. Select the days when the schedule will be backed up.
c. Select a time for the backup.
d. Select the location where the backup file will be sent in the Network Shares field.
e. (Optional) Click [Backup Now] to start the backup immediately.
5. To create a schedule for an event backup:
a. In the Event Schedule Configuration area of the page, select Schedule Enabled.
b. Select Schedule Incremental to back up only those events that occurred since the last
backup.
c. Select the days when the schedule will be backed up.
d. Select a time for the backup.
e. Select the location where the backup file will be sent in the Network Shares field.
f. (Optional) Click [Backup Now] to start the backup immediately.
6. (Optional) To send an automated email after a scheduled backup:
a. Select Send on success, Send on failure, or both check boxes.
b. Select an Email List.
Back Up Events
Note the following details about events:
• Events cannot be restored from a backup file. The file is intended for recordkeeping purposes
only.
• Events can be exported using the Import/Export Wizard provided on the Utilities disc, as
described in the Import/Export Wizard User Guide.
To back up events:
1. Log into the System as a user with Execute permissions for the Backup Database feature.
2. Select System Administration > Backup/Restore.
3. Click [Schedule Backup].
4. In the Event Schedule Configuration area of the page, click [Backup Now].
The Running Scheduled Backup dialog box displays the results of the operation.
IMPORTANT: Restoring a backup will overwrite the database, and any changes made since
the date of the backup will be lost.
1. Log into the System as a user with Execute permissions for the Restore Database feature.
2. Select System Administration > Backup/Restore.
3. Click [Browse].
4. Navigate to the backup file.
5. Select the file and click [Open].
6. Click [Upload Backup File].
Note: If the controller is unable to save files on the card, then the procedure to create a backup
file would automatically start instead. The user would be required to select a location for
the backup file to be stored on the computer. See Create a Backup File on page 89.
IMPORTANT: Using this feature will erase all settings and data, and reset the System to use
the database and pictures stored in the custom settings file. Be sure to create a
current backup before restoring custom settings.
After restoring custom settings, the System Controller will reboot. During this time, it will be offline
for a few minutes. Therefore, it is best to use this feature during periods of little or no access activity,
or credential holders will be forced to wait to gain entry if a Door Fallback Mode was not configured
to allow access when the System Controller is offline.
1. Select System Administration > Save/Reset Settings.
2. Select Restore Custom Settings.
3. Type a Username.
4. Type a Password.
5. Type the security phrase, exactly as shown (case sensitive).
6. Click Restore Custom Settings.
A Warning message appears, stating: “The Device is rebooting,” and displaying a progress bar.
When the progress bar completes, the server will go offline and the browser will display its
default page when it cannot connect to a web address.
Note: If the controller is unable to access files stored on the card, then the procedure to restore
from a backup would automatically start instead. The user would be required to select a
location of the backup file to be restored. See Restore from a Backup on page 91.
7. Clear the browser cache. (In Internet Explorer 8+, press <Ctrl>+<Shift>+<Delete>.)
IMPORTANT: This feature will erase all settings and data (except Network Configuration
settings), and reset the System Controller to the factory default values. Be sure
to create a current backup before resetting factory settings.
1. Select System Administration > Save/Reset Settings.
2. Select Reset Factory Settings.
3. Type a Username.
4. Type a Password.
5. Type the security phrase, exactly as shown (case sensitive).
6. Click Reset Factory Settings.
a. Resetting factory settings causes all events from the audit log to be deleted. A warning
appears, with the option to export the audit log as a CSV file.
• Click Skip to proceed without exporting the audit log.
• Click Export to export the audit log. Then follow the prompt to save the CSV file.
• Click Cancel to exit without resetting or exporting the audit log.
b. A warning appears, stating, “The Device is rebooting,” and displaying a progress bar.
When the progress bar completes, the server will go offline and the browser will display its
default page when it cannot connect to a web address.
7. Clear the browser cache. (In Internet Explorer 8 or later, press <Ctrl>+<Shift>+<Delete>.)
When the server comes back online, the End User Software License Acceptance (EULA) Form
will be displayed.
8. Click Accept.
Note: Updating the System Controller firmware is a different than upgrading the System,
which impacts the core code of the System Controller in addition to the firmware.
Updating can only be done in version 1.72 or later. To switch from one version of
TruPortal to a later version (for example, from version 1.5 to version 1.6) or to upgrade
from goEntry to TruPortal, see Using the Upgrade Wizard on page 10.
IMPORTANT: Do not reset or restart an IPSDC during a firmware update or the IPSDC will
become nonfunctional.
• Back up the database before updating the System Controller firmware. See Backing Up Data on
page 89.
• Events stored on the System Controller are purged during a firmware update. To retain a record
of existing events, back up events (see Back Up Events on page 91) or export events (see the
Import/Export Wizard User Guide).
• Once started, a firmware update cannot be canceled.
Note: Neither English nor the current System Language can be removed.
• After a new language is added, the language becomes available the next time the user logs in.
• If the currently-active language (for example, Spanish) is removed, a user must log out of the
System and then log back in to select the new language.
• Language packs are created for specific versions of the System Controller firmware. The first
two digits of the version number for the language pack (for example, 3.5x.xxxx) must match the
first two digits of the current firmware version, which is displayed on the System Administration
> Language Packs page.
• When the System Controller firmware is updated, English and any other default language packs
(Spanish, French, and Dutch) that are still installed are updated.
• Upgrades or firmware updates will delete all manually installed language packs. To update any
other language pack, download and install the appropriate language pack from the product
website.
• Service pack upgrades do not impact language packs.
Note: The [Add] button is only enabled if fewer than four language packs are currently
installed. If necessary, remove a language pack (except English and the current System-
level language pack) before adding a new language pack. See Remove a Language Pack
on page 95.
6. In the Open dialog box, navigate to the folder to which the language pack (the file has a .NLS
extension) was downloaded, select the file, and then click [Open].
7. When the Language Pack Add-On window appears, click [Install].
8. When installation is complete, click [Finish].
9. To begin using the new language:
a. Log out of the System by clicking the Logout icon in the top-right portion of the User
Interface.
b. Follow the steps in Logging into the System on page 15 and select the new language in the
Language field.
Note: Neither English nor the current System-level language pack can be removed.
1. Select System Administration > Language Packs.
2. Click the language pack to select it.
3. Click [Remove].
The Remove Item dialog box appears.
4. Click [Remove].
Managing Plugins
Plugins are software components which add specific functionality to the TruPortal application.
Currently, there is only one plugin available: 3rd party integration interface (REST API). For more
information, contact TruPortal Product Marketing through your VAR/Distributor channel.
Note: Plugins installed on earlier panel firmware versions are not compatible with version
1.72, and will not be preserved after upgrade. Contact TruPortal Product Marketing to
obtain the appropriate version for panel firmware 1.72.
Install a Plugin
1. Launch a supported Internet browser.
2. Log into the System as a user with Plugins > Modification permissions.
3. Select System Administration > Plugins.
4. Click [Install].
5. Click [Select File]
6. In the Open dialog box, navigate to the folder containing the plugin package (the file has a .LFF
extension), select the file, and then click [Install].
Note: Plugin installation may take up to 10 minutes. The panel will be restarted after
successful installation. The plugin is automatically started after the panel restarts.
Start/Stop/Restart a Plugin
To perform this procedure, you must be logged into the System as a user with Plugins > Execution or
Plugins > Modification permissions.
1. Select System Administration > Plugins.
2. Select the plugin you want to start, stop, or restart.
3. Click [Start], [Stop], or [Restart]. The Status field displays the plugin state change.
Note: There is one button for these functions. The button changes depending on the current
plugin status.
Remove a Plugin
To perform this procedure, you must be logged into the System as a user with Plugins > Modification
permissions.
1. Select System Administration > Plugins.
2. Click the plugin package.
Audit Log
The audit log is a record of actions performed by administrators or operators of the system over a
period of time. For example, whenever a change in configuration is made, such as adding or
modifying a cardholder, the change is tracked in the audit log.
Note: After enabling or disabling HTTPS/SSL, be sure to clear the browser cache, especially
if using Firefox or Chrome.
Here are some other tips for troubleshooting browser issues:
• If the System Controller is reset or the database is restored, Internet Explorer may temporarily
display an XML page instead of the login page. If this occurs, refresh the browser page until the
login page appears.
• The System supports the use of the [Back] and [Forward] browser buttons, but a blank page may
appear occasionally while navigating backward or forward. If this occurs, refresh the browser
page.
• For browsers other than Internet Explorer, the [Back] and [Forward] buttons may not work as
expected when trying to navigate between tabs of a given page (for example, when switching
between the Details and User Account tabs on the Access Management > Persons page). If this
occurs, use a mouse to click the desired tab.
• Maximize the browser window to display all tool tips. Tool tips may not appear if the browser
window is too small.
• When HTTPS security is enabled or disabled on the System Settings > Network Configuration
page, the login page should appear automatically. If the login page does not appear, manually
clear the browser cache and restart the browser to access the login page.
• Browser proxy settings may affect connectivity to the System Controller (which uses ports 80
and 443) when HTTPS is disabled. To resolve this issue, configure proxy servers to allow HTTP
traffic over port 443 by either explicitly (1) specifying port 443 in the panel URL (for example,
http://192.168.1.10:443), (2) adding an exception to proxy settings on the client, or (3)
configuring a service port that is unblocked by the firewall. See Configure Network Settings on
page 17.
Diagnostics
Errors detected by the System are displayed on the Monitoring > Diagnostics page, along with
System statistics, such as the numbers of inputs. All information is queried at login time and every
minute thereafter. To manually refresh the data, click [Refresh].
To access the Diagnostics page:
• Select Monitoring > Diagnostics, or
• Click the Status Indicator that appears in the top center of the User Interface when errors or
warnings occur.
Note the following details about the Diagnostics page:
• Red shading indicates a malfunction, such as offline devices. Yellow shading indicates a
warning, such as a tamper condition.
• An ellipsis (...) appears if additional information about a category is available in a tool tip that
can be displayed by hovering over the ellipsis.
• The System does not include actions for running specific diagnostic tests.
• Click [Download Diagnostic File] to create a single, encrypted file that includes a variety of
system information, including configuration data and logs. No specific personnel information
(for example, names or Social Security numbers) will be included in the file; refer to the Release
Notes for details. The file can be saved locally and sent to Technical Support for use in
troubleshooting issues.
• An accurate reading for DC current cannot be displayed when the System Controller is powered
by a DC source. The DC current information is only displayed when the System Controller has
AC power.
CPU Load Avg 1m, 5m, 15m INF 15m < 0.80
WRN 15m >= 0.80
ERR 15m >= 0.95
Fuses
The fuses protect DC power provided by the System Controller board for use by external peripherals.
Fuse +V 0V
Controller
• Tamper
Modules
• Offline
• Tamper
Doors
• Offline
• Forced
• Held
• RTE Tamper
• Door Contact Tamper
• Door Aux Tamper
• Door Tamper
Digital Input
• Offline
• Tamper
Troubleshooting Readers
If a reader is not responding as desired, use the [Scan for Hardware Changes] button (see Scan for
Hardware Changes on page 22), verify that the reader appears in the Device Tree hierarchy on the
System Administration > Devices page, and check the reader configuration. See Configure Readers
on page 31.
If unexpected events occur for doors or readers connected to an IPSDC, check the IPSDC jumper and
switch settings to make sure that the hardware is configured correctly. For example, the reader Device
Input (DI) port, J2, has two digital inputs which are used for door status devices (door contacts and
exit request input) and can be configured as either supervised or non-supervised digital inputs. If the
inputs are configured as supervised digital inputs in the TruPortal User Interface, they require EOL
resistors. Refer to the IPSDC Quick Reference for details.
Note: RS-485 SNAPP door controllers are not supported by this procedure.
2. Swipe a card without configuring any particular card formats.
3. Check the panel’s event log.
The log should have a “Bad Card Format” event with some additional information on the card data
received by the panel. The card data is shown in the “Person” column, using the following format:
Unknown Person (bits: XX, raw data: YYYY)
where XX stands for the number of bits read from the card (decimal, two or three digits), and YYYY
stands for the raw card data (hexadecimal, number of digits depends on the number of bits on the
card).
The information provided by such an event may help configure the card format properly.
Be sure to verify all the predefined card formats with the same bit count (XX value).
If none of the predefined formats work properly, configure the simplest possible card format setting
suitable for the swiped card:
• Format Type: Custom
• Total Bit Length: set to XX (value obtained from the event logged)
• Card Number/Starting Bit: 0
• Card Number/Bit Length: set to XX (value obtained from the event logged)
• All other fields: set to 0
Note that this configuration ignores parity checks and additional information which may be stored on
the card (facility and issue codes).
Refine card format settings as much as possible. The YYYY value reported with the event may help
set the other parameters properly.
Example:
Reader type: TP-RDR-200A (i.e. Mini-mullion T-200)
Credential type: TP-MFC-KF-LG-25PK (i.e. MIFARE ISO 14443A)
Event generated after card swipe: “Bad Card Format” with additional information: “Unknown Person
(bits:40, raw data:0112262035)”
The user may try to define the simplest possible card format as described above (all bits from the card
considered a card number).
After definition of this format, the system will return the following card number after the next card
swipe: 4599455797
This configuration can be used (the numbers will be unique), but parity is not checked.
Note: According to the reader documentation, the reader reports “4002” format for MIFARE
credentials. The best way to support this format is to select the format, “40 bit CASI
4002.”
In this case, the card number reported after the next swipe would be 2299727898 (which
is the unique number of the MIFARE chip), and parity will be checked.
Troubleshooting Schedules
If a schedule is not behaving as expected, review the following sections:
• Creating Holiday Groups on page 39
• Creating Schedules on page 41
• Considerations for Schedule-Based Action Trigger Records on page 58
Tamper States
The System Controller does not distinguish which of the four door input are in tamper state when it
logs tamper events. The real-time state of inputs in tamper can be viewed on the Monitoring >
Diagnostics page.
Event 14612 Backup Battery Critical Voltage falls below 11.4V, or rises above 10.2V
Event 14613 Backup Battery Cutoff Voltage falls below 10.2V, or rises above 9.0V
Event 14624 Backup Battery Low Voltage falls below 11.7V, or rises above 11.4V
Event 14649 Backup Battery Not Detected Voltage falls below 9.0V
Note: If the System Controller is powered exclusively off of a backup battery, it will shutdown
at 10.2V and the Cutoff and Not Detected events will not be generated.
Fuse Events
Device Events
Device Failed/Restored
Used to indicate general issues with downstream devices. Occurs when any device tamper input
changes state (including External/Wall Tamper, but not Door Tamper), or when a VBUS
communications error is detected. Device will always indicate Controller. For tamper events,
there will be corresponding tamper event for the device. For VBUS error events, there is no way
to report which device has the VBUS error, so there is no corresponding event to show which
device has the VBUS error.
System Trouble/Restored
Used to indicate general issues with the System. Occurs when External/Wall Tamper changes
state. Device will always indicate the System Controller. This event may be used in the future to
identify other trouble conditions.
“Person” field in the event may contain some additional information about unrecognized card format.
Refer to Troubleshooting Card Formats on page 104.
Note: Video can only be viewed in Internet Explorer. Refer to the Release Notes for details.
System Capacities
Attribute Capacity
Access levels 64
Schedules 64
Holiday groups 8
Areas 64
Reader groups 64
Operator roles 32
User-defined fields 10
Video layouts 64
Card formats 8
Email lists 10
Action Triggers 32
Device Capacities
Readers (total) 64
Inputs/Outputs
Attribute Capacity
DVRs/NVRs 4
Cameras 64
Ethernet ports 2
9. If a firewall is enabled on the client workstation, disable the firewall before starting the ICT.
10. Proceed to Using the ICT to Configure IPSDCs on page 116.
To prepare a Windows 8 client workstation:
1. Click the Network icon to open the Network and Sharing Center.
2. Click Change Adapter Settings.
3. On the Network Connections window, right-click the Local Area Connection icon and select
Properties from the menu.
4. In the Local Area Connection Properties dialog box, select either Internet Protocol Version 4
(TCP/IPv4) or Internet Protocol Version 6 (TCP/IPv6).
5. Click Properties.
• If Obtain an IPvx /Address Automatically is already checked, select Use the Following
IPvx Address, where x is the Internet Protocol Version being used (4 or 6).
• If the connection is static, write down the IP address and Subnet mask number. Reset the
computer to these values after the controller configuration is complete.
6. Enter the IP address, 192.168.6.1, or a similar valid IP address (e.g., 192.168.6.x where
x is any number between 1 and 254 except 6).
7. Change the Subnet Prefix Length value to 255.255.255.0.
The default gateway does not need to be changed.
8. Click OK and Close until all open windows are closed.
9. If a firewall is enabled on the client workstation, disable the firewall before starting the ICT.
10. Proceed to Using the ICT to Configure IPSDCs on page 116.
The following table describes the buttons available in the ICT interface:
Apply After all changes are Saves changes from the temporary configuration file to
Changes complete the configuration database.
Restart After selecting Apply The ICT picks up the latest changes from the
Application Changes configuration database and starts again.
Restart After selecting Apply The IPSDC applies the latest changes and starts again.
Controller Changes
Factory To restore IPSDC IPSDC settings are restored to factory defaults. The IP
Defaultsa default settings address settings are retained.
Change User/ To set the user ID Changes the user ID and/or password for the ICT. The
Password and/or password for default values are install, install. For increased
logging into the ICT. security, change the default values.
a. If the default network parameters are restored using the SW7 button, then all parameters (including the IP
address of the IPSDC) will be modified.
IMPORTANT: Before you begin, you must have physical access to the controller.
To enable the ICT temporarily:
1. Press and hold SW4 until D19 (i.e., the Watchdog LED) turns ON. Allow up to five (5) seconds
for D19 to turn ON. (See the IP-Based Single Door Controller Quick Reference for switch
locations.)
2. After D19 is ON, release SW4.
3. D19 turns OFF when the ICT is manually enabled.
The ICT is now enabled until the controller reboots.
To enable the ICT permanently:
1. Complete the steps to enable the ICT temporarily, as listed above.
Permission View
Feature Levels Administrator Operator Guard Only Dealer
Permission View
Feature Levels Administrator Operator Guard Only Dealer
Permission View
Feature Levels Administrator Operator Guard Only Dealer
Port Usage
Hardware devices use ports to allow software applications to share hardware features without
interfering with each other.
The following table provides port information for various devices in the System:
1 second 1
2 seconds 2
3 seconds 3
5 seconds 5
10 seconds 10
15 seconds 15
APB Credential
An acronym for anti-passback. The An ID badge with an encoded number that
prevention of a badge gaining entry in an can be added to the System and used to grant
access control system when that badge has or deny access.
either recently entered the same Reader or
Area (Timed APB) or is not considered to be DES/DER
in the proper current Area required to gain An acronym for the Otis Destination Entry
entry into the new Area (Area APB). Put Server/Destination Entry Redirector. This
simply, it is a method of monitoring a server controls the destination entry
cardholder's entry and exit actions to ensure computers and dispatches elevator cars
that the person does not transfer the card to based on the access decision and passenger
another individual to gain access. load, and destination indicators.
Anti-passback DHCP
Anti-passback can be used to establish a Acronym for Dynamic Host Configuration
specific sequence in which credentials must Protocol. A communications protocol that
be used in order to gain access to an area. lets network administrators manage centrally
and automate the assignment of Internet
PAL Supervised
A video standard used in Europe, Australia, A door or enclosure wired with a continuity
and New Zealand. PAL video broadcasts 625 circuit so as to detect tampering.
lines every 1/25 second.
TCP/IP
PIN Acronym for Transmission Control Protocol/
Acronym for personal identification number, Internet Protocol. A suite of communication
a number typically associated with an protocols used to connect hosts on the
individual and used for access control Internet.
A photos ...................................................... 69
Access History report ..................................... 73 reader groups ......................................... 43
Access Level ........................................... 53, 123 schedules ................................................ 41
Access Levels page ................... 42, 43, 46, 52 user accounts .......................................... 67
Action video cameras ........................................ 34
triggers .................................................... 53 video layouts .......................................... 34
Action triggers Administrator
condition statements ............................. 53 changing the password for ..................... 9
configuring ............................................. 64 user account ............................................. 9
controlling manually ............................. 86 Anti-passback .................... 30, 36, 37, 86, 123
executing manually ............................... 86 configuring ............................................. 38
pulse duration accuracy ...................... 121 Anti-Passback Exempt ................................... 70
triggering manually ............................... 65 Anti-Passback Reset ....................................... 86
understanding actions ........................... 59 APB ................................................................. 123
understanding triggers .......................... 53 Area APB ....................................................... 123
Action Triggers page ...................................... 86 Area Definition page ...................................... 37
Activate credentials ........................................ 71 Audit log
Active From ..................................................... 70 back up .................................................... 97
Active On/Off .................................................. 33 export ...................................................... 97
Active To .......................................................... 70 view ......................................................... 97
ActiveX ............................................................ 33 Aux Input ......................................................... 30
Add Aux Relay ................................................. 26, 30
access levels ........................................... 46 Aux Relay On Time ................................ 27, 31
areas ......................................................... 36 Auxiliary Input Events
card formats ........................................... 20 14640 ..................................................... 108
credentials ............................................... 67 14641 ..................................................... 108
devices .................................................... 22 14642 ..................................................... 108
digital video recorders .......................... 33 4170 ....................................................... 108
email lists ................................................ 50 Auxiliary Output Events
floor groups ............................................ 46 10240 ..................................................... 108
holiday groups ....................................... 39 11264 ..................................................... 108
IPSDCs ........................................ 113, 117
language packs ...................................... 95 B
network share ......................................... 65 Back up audit log ............................................ 97
operator roles ......................................... 47 Backup .............................................................. 66
V
Video
downloading video clips ...................... 79
playback .................................................. 78
player controls ....................................... 80
troubleshooting .................................... 109
viewing events ....................................... 77
Video Devices .......................................... 33, 34
Video Layouts page ........................................ 34
Video page ................................ 77, 78, 80, 109
View audit log ................................................. 97
View Help button .............................................. 2
Voltage ............................................................ 106
W
Warnings
Objects Have Changed ....................... 108
The Device is rebooting ................ 92, 93
Web Browser Configuration and Control ... 33
Wiegand ................................................. 123, 125
Wizards ................................................. 1, 2, 125
Home page wizards .............................. 15
Installation Wizard .................................. 8
Upgrade Wizard .................................... 10