Administrator’s Guide

Version 3.1 R3

MAN006
MAN006-0612, June, 2012

Version 3.1 R3, Revision C

Copyright© 2012 Hirsch Electronics LLC. All rights reserved. ScramblePad® and ScrambleProx® are registered trademarks of
Hirsch Electronics. DIGI*TRAC™, MATCH™, ScrambleCard™, SCRAMBLE*NET™ (abbreviated S*NET), X*NET, and Velocity™ are
all trademarks of Hirsch Electronics.

Microsoft, MS and MS-DOS are registered trademarks, and Windows, Windows 2000, and Windows XP are trademarks of
Microsoft Corporation.

Velocity systems are suitable for use over private (intranet) and public (internet) data networks when configured to use an
encryption method including an Authentication Header and an algorithm capable of Triple-DES or better that is NIST certi-
fied. The encryption must be provided using Listed (NWGQ) Lantronix Model SecureBox SDS1100 encryption modules and
Listed (EPBU) Ever Glow Electronic Co., Ltd., Model DCU120030 plug-in transformers.

Hirsch Identive
1900-B Carnegie Avenue
Santa Ana, CA 92705-5520

Phone: 949-250-8888 or 888-809-8880 (toll-free)

Fax: 949-250-7372
Web: www.hirsch-identive.com
Getting Help
If you encounter a problem that is not discussed in this guide and you need technical
support, do the following:
1. Contact your local dealer or the provider of this product.
2. If your dealer is not available, contact Hirsch Technical Support directly. This can be
done in a number of ways:
Mail: Hirsch Identive
1900-B Carnegie Avenue
Santa Ana, CA 92705-5520

Attn: Technical Services

Phone: 877-HIRSCHX (877-447-7249) toll-free
Fax: (949) 250-7362
Email: [email protected]
WWW: www.hirsch-identive.com

Whenever you call your local dealer or Hirsch, be sure to have your registration
material, serial number and software version number available.
For future reference, record these numbers here.
Serial Number: _________________________________
Version Number: _________________________________
Dealer: _________________________________
Dealer Phone #: _________________________________
CCM Rev/Version #: _________________________________
UL Requirements
The following UL issues are addressed here:
GENERAL
1. UL terms that are applicable to this application can be found “Glossary” on page 283 of the
Velocity Operators Guide (MAN007).
2. The UL Listed Velocity System is comprised of the following: Central Supervisory Station,
XBox, M1N, M2, M8, M16, DS37LH, DS47L, DS47L-HI, DS47L-SPX, Power Limitation Board,
PS2, DTLM1, DTLM2, DTLM3, MELM1, MELM2, and MELM3. The M2, M8, and M16 may
employ the following expansion boards: MEB/BE, AEB8, REB8, and SNIB.
VELOCITY
1. If Alarm Priority levels are assigned by user, then priority must be assigned as follows for UL
applications:
a. Fire alarm and industrial supervision where a risk of injury to persons, or damage or
destruction of property may be involved.
b. Hold-up or panic alarm.
c. Burglar alarm.
d. Watchman tour.
e. Fire-alarm supervision.
f. Burglar-alarm supervision.
g. Industrial supervision where a risk of injury to persons, or damage or destruction of
property will not be involved.
h. Other supervisory services.
Items (b) and (c) may have equal priority. Items (e) and (f) may have equal priority. Items
(g) and (h) may have equal priority.
2. Alarm Stacking feature is not to be used for UL applications.
3. Return to Normal feature is not to be used for UL applications.
4. Video capability of Velocity 3.1 software has not been evaluated by UL.
CENTRAL SUPERVISORY STATION
1. See the introduction to the Velocity Installation Guide (MAN004) for the minimum
hardware and software requirements of the central supervisory station equipment.
2. The data processing equipment and office appliance equipment used as central supervisory
station equipment shall be Listed under Office Appliances and Business Equipment (UL
114) or Information Processing and Business Equipment (UL 478) or Information
Technology Equipment (UL 60950).
3. A redundant server configuration must be employed where the servers and workstations are
networked via a dedicated Ethernet LAN. The network interfaces the protected premise
units through an XBox.
4. The Map Builder function must be employed to display the state and condition of all alarm
points of the system.
5. A “panel logged off” event may be a compromise attempt on the system.
6. Supply line transient protection complying with the Standard for Transient Voltage Surge
Suppressors, UL 1449, with a maximum marked rating of 330 V shall be used on Central
Monitoring Station Equipment.
7. If the XBox is not installed in the Central Monitoring Station, signal line transient protection
complying with the Standard for Protectors for Data communications and Fire Alarm Circuits
(UL 497B) with maximum marked rating of 50 V shall be used on communication circuits
extending beyond 25 feet from the computing systems.
8. The Central Monitoring Station Equipment shall be installed in a temperature-controlled
environment. A temperature-controlled environment is defined as one that can be
maintained between 13–35°C (55–95°F) by the HVAC system. Twenty-four hours of
standby power shall be provided for the HVAC system. The standby power for the HVAC
system may be supplied by an engine-driven generator alone. A standby battery is not
required to be used.
9. In addition to the main power supply and secondary power supply that are required to be
provided at the central supervisory station, the system shall be provided with an
uninterruptible power supply (UPS) with sufficent capacity to operate the computer
equipment for a minimum of 15 minutes. If more than 15 minutes is required for
secondary power supply to supply the UPS input power, the UPS shall be capable of
providing input power for a least that amount of time.
10. The UPS shall comply with the Standard for Uninterruptible Power Supply Equipment (UL
1778) or the Standard for Fire Protective signaling Devices (UL 1481).
11. In order to perform maintenance and repair service, a means for disconnecting the input to
the UPS while maintaining continuity of power to the automation system shall be provided.
12. The alarm system’s network settings shall be designed such that the maximum time lapse
from the initiation of an initiating device circuit until it is annunciated at the central
supervising station shall not exceed 90 seconds.
13. The alarm system’s network settings shall be designed such that the maximum time for the
central supervising station to annunciate a single break, single ground, wire-to-wire short,
loss of signal, or any combination of these shall not exceed 200 seconds.
14. The alarm system configuration shall be designed such that the number of signals on a
single channel shall be limited to 1000.
XBOX
1. XBox configuration and installation are addressed in ,“XBox Installation,” of the Hirsch
DIGI*TRAC Design and Installation Guide (MAN001).
2. UL has not verified the XBox hookup for a remote dialup controller or the modem
loop configuration.
3. The alarm relay contact is rated 24 VDC, 2 A, resistive.
4. Wiring to the RS-232 circuit is limited to the same room (50 feet).
5. Shielded cable must be used on the RS-232 circuit.
M1N
1. Input rating of the M1N is 120 VAC, 50/60 Hz, 500 mA.
2. The Alarm/Control Relay contact rating is 24 VDC, 1 A, resistive.
3. The M1N shall not employ a secondary battery.
M2
1. UL has verified compatibility of the Hirsch DS37L, DS37LH, DS47L, DS47L-HI, DS47L-SPX,
and DS47L-HI-SPX with the M2.
2. The Alarm/Control Relay contact rating is 24 VDC, 1 A, resistive.
M8
1. UL has verified compatibility of the Hirsch DS37L, DS37LH, DS47L, DS47L-HI, DS47L-SPX,
and DS47L-HI-SPX with the M8.
2. The Alarm/Control Relay contact rating is 24 VDC, 1 A, resistive.
M16
1. Input rating of the M16 is 120 VAC, 50/60 Hz, 1A.
2. UL has verified compatibility of the Hirsch DS47L-SPX with the M16.
3. The Alarm/Control Relay contact rating is 24 VDC, 1 A, resistive.
 MAN006-0612

Contents
Getting Help ..................................................................................................................................... iii
UL Requirements ..............................................................................................................................iv
Introduction.............................................................................................................................. 1
Who Should Read This... ...................................................................................................................2
Getting Started....................................................................................................................................3
Starting Velocity .........................................................................................................................3
Velocity Registration ..................................................................................................................3
Splash Screen Modification .....................................................................................................5
Exiting Velocity ..........................................................................................................................5
Velocity Main Menu...........................................................................................................................6
Velocity Administration Main Screen ........................................................................................7
System Tree Window (System Tree Pane) ..............................................................................7
Expanding and Contracting the System Tree ......................................................................8
Velocity Configuration Folder.............................................................................................9
DIGI*TRAC Configuration Folder ...................................................................................11
Interfaces Configuration Folder.........................................................................................13
Components Window (Components Pane) ............................................................................14
Design Mode ..........................................................................................................................15
Velocity Icon Tool Bar .............................................................................................................18
Velocity Menu Bar....................................................................................................................20
File Options ............................................................................................................................21
Console Options .....................................................................................................................22
Window Options ....................................................................................................................22
Add-Ins Options .....................................................................................................................23
Help Options ..........................................................................................................................24
Help Topics........................................................................................................................24
Velocity Hot Keys.....................................................................................................................25
Status Line.................................................................................................................................26
Off Normal Points ..................................................................................................................27
System Icons .............................................................................................................................27
Navigating Velocity..........................................................................................................................29
Navigating Between Modules...................................................................................................29
Using the Mouse and Keyboard................................................................................................29
Mouse Functions ....................................................................................................................29
Keyboard Functions ...............................................................................................................29
Using Velocity Fields and Tools...............................................................................................30
Switching Operators..................................................................................................................31
Locking Workstations ...............................................................................................................32
Managing Desktop Space.................................................................................................................33
Managing Velocity Windows ...................................................................................................33
Column Management................................................................................................................34
Sorting By Column Header ....................................................................................................36
Rearranging Column Headers ................................................................................................36
Resizing Columns and Panes .................................................................................................37

vii
Velocity Version 3.1 Administrator’s Guide

Using Velocity Programs ................................................................................................................. 38

Configuration Preliminaries ................................................................................................. 41
How to Configure a System............................................................................................................. 42
Setting Velocity Preferences ............................................................................................................ 44
Preferences Dialog Box............................................................................................................ 44
General Page Preferences ...................................................................................................... 45
Network Preferences.............................................................................................................. 47
Alarm Options Preferences.................................................................................................... 48
Printers Preferences ............................................................................................................... 50
CCTV/DVR Preferences ....................................................................................................... 51
Getting Started: Basic Configuration............................................................................................... 53
Getting Started: Advanced Configuration ....................................................................................... 54
Hardware Configuration ....................................................................................................... 55
Introduction...................................................................................................................................... 56
Ports ................................................................................................................................................. 59
Adding Ports............................................................................................................................. 60
Modifying Ports........................................................................................................................ 62
Port Properties Dialog Box....................................................................................................... 63
Advanced Port Settings ......................................................................................................... 66
S*NET Systems........................................................................................................................ 66
Device Servers................................................................................................................... 68
X*NET Systems ....................................................................................................................... 69
Controllers ....................................................................................................................................... 71
Adding Controllers ................................................................................................................... 72
Configuring Controllers............................................................................................................ 73
New Controller Dialog Box................................................................................................... 74
Downloading Controller Configurations.................................................................................. 75
Downloading Time Zones and Holidays ............................................................................... 77
Downloading Persons and Credentials .................................................................................. 77
Uploading Controller Setups to Velocity ................................................................................. 77
Uploading Controller Configurations.................................................................................... 78
Exporting Controller Configurations........................................................................................ 78
Duplicating Controllers ............................................................................................................ 80
Renaming Controllers............................................................................................................... 80
Deleting Controllers ................................................................................................................. 80
Moving Controllers .................................................................................................................. 80
Importing Controllers ............................................................................................................... 81
Modifying Controllers .............................................................................................................. 85
Controller Properties ................................................................................................................ 85
Controller General Page ........................................................................................................ 86
Controller Setup Page............................................................................................................ 88
Controller Setup Page: Advanced Options Setup ............................................................. 94
Special Needs Time Extension.......................................................................................... 95
Controller Reporting Page ..................................................................................................... 95
Advanced Reporting Setups .............................................................................................. 97
Controller Passback Page ...................................................................................................... 99
Passback Control ............................................................................................................. 104
Passback Zones: Introduction.......................................................................................... 104
Defining Passback Zones ................................................................................................ 105

viii
 MAN006-0612

Occupancy Count.............................................................................................................106
Two-Person Rule .............................................................................................................106
Calculating Time Increment vs. Threshold Time .....................................................107
Rule Variations .........................................................................................................108
Setting Up Two-Person Rule ....................................................................................108
Controller Control Zone Page ..............................................................................................109
Control Zones ..................................................................................................................109
Control Zones: How to Define.........................................................................................110
Control Zones: Editing Objects .......................................................................................112
Control Zones Properties Dialog Box..............................................................................112
Standard Control Zones Property Sheet....................................................................113
Master Control Zones Property Sheet.......................................................................115
Standard Control Zones ...................................................................................................117
Defining Standard Control Zones .............................................................................117
Master Control Zones ......................................................................................................119
Defining Master Control Zones ................................................................................120
Linking Master Control Zones..................................................................................121
LED Enabling ..................................................................................................................123
Controller Alarm Actions Page ............................................................................................124
Alarm Actions ......................................................................................................................126
Changing Alarm Actions .................................................................................................127
Alarm Types ....................................................................................................................127
Alarm Control Blocks (ACBs) ........................................................................................128
ACB Mappings .........................................................................................................129
Controller Communications Page ........................................................................................132
Download Monitor ...............................................................................................................133
Dial-Up Configuration ...................................................................................................................135
Connecting Modems ...............................................................................................................136
Modem Setup on Windows.....................................................................................................136
Modem Setup on Velocity ......................................................................................................137
Dial-Up Configuration: Modem Pools.................................................................................138
Dialup Location Properties: Host Settings...........................................................................139
Dial-Up Location Properties: Remote Settings....................................................................140
Connection and Buffer Controls ......................................................................................143
Buffer Threshold Setup....................................................................................................144
Doors ..............................................................................................................................................145
Doors: How to Configure........................................................................................................145
Unbundling Doors...................................................................................................................146
Bundling Components to Create Doors ..................................................................................147
Door Configuration Properties................................................................................................147
Door Properties Dialog Box....................................................................................................148
Door Properties: General Page.............................................................................................149
Dual Technology..............................................................................................................152
Dual Technology: Validation During IDFs .....................................................................153
Validate on Dual CCOTZ .........................................................................................153
Validate Immediately CCOTZ..................................................................................153
Extended Access Timers..................................................................................................154
Doors: Enabling Credential Auto Display .......................................................................156
Door Properties: Entry Reader Page ....................................................................................156
Door Properties: Exit Reader Page ......................................................................................157

ix
Velocity Version 3.1 Administrator’s Guide

Door Properties: Relay Page................................................................................................ 157

Door Relay Setup Property Sheet.................................................................................... 157
Door Delay Time...................................................................................................... 159
Door Relay Logic Property Sheet ................................................................................... 160
Door Properties: Input Page ................................................................................................ 161
Door Input Setup Property Sheet .................................................................................... 162
Door Input Logic Property Sheet .................................................................................... 164
Door Input State Change Reporting Property Sheet ....................................................... 165
Relays ............................................................................................................................................ 167
Relays: How to Configure ...................................................................................................... 167
Relay Properties Dialog Box .................................................................................................. 167
Relay General Property Sheet.............................................................................................. 168
Relay Logic Property Sheet................................................................................................. 169
Mapping Control Relays to Alarm Relays ............................................................................ 170
Expansion Relays........................................................................................................................... 172
Expansion Relays: How to Configure .................................................................................... 172
Expansion Relay Properties Dialog Box ................................................................................ 172
Expansion Relay General Property Sheet............................................................................ 173
Expansion Relay Logic Property Sheet ............................................................................... 174
Virtual Relays......................................................................................................................... 175
Using Controllers with Virtual Relays ................................................................................ 177
Inputs ............................................................................................................................................. 178
Inputs: How to Configure.................................................................................................... 178
Input Properties .................................................................................................................... 179
Input General Property Sheet .............................................................................................. 179
Input Logic Property Sheet.................................................................................................. 181
Input State Change Report Property Sheet .......................................................................... 182
Line Modules.......................................................................................................................... 184
DTLM.................................................................................................................................. 184
MELM ................................................................................................................................. 185
RQE ........................................................................................................................................ 185
Expansion Inputs ........................................................................................................................... 186
Expansion Inputs: How to Configure ..................................................................................... 186
Expansion Inputs Property Sheet ........................................................................................... 186
Expansion Input General Property Sheet............................................................................. 187
Expansion Input Logic Property Sheet................................................................................ 189
Expansion Input State Change Reporting Property Sheet ................................................... 190
Readers & Keypads ....................................................................................................................... 193
ScramblePads ......................................................................................................................... 193
MATCH Reader Interface ...................................................................................................... 194
Readers: How to Configure .................................................................................................... 195
Reader Properties Dialog Box ................................................................................................ 195
Reader General Property Sheet............................................................................................ 195
ScramblePad Sharing ...................................................................................................... 197
Hardware Setup ........................................................................................................ 198
Velocity Setup .......................................................................................................... 198
Reader ScramblePad Options Property Sheet ..................................................................... 199
Reader Logic Property Sheet............................................................................................... 202
XBoxes .......................................................................................................................................... 204

x
 MAN006-0612

Adding XBoxes.......................................................................................................................205
Modifying XBoxes..................................................................................................................205
XBox Properties Dialog Box ..................................................................................................206
SNIB2.............................................................................................................................................207
Configuring SNIB2 .................................................................................................................208
SNIB2 Properties Sheet........................................................................................................210
Searching window ................................................................................................................210
Backing Up SNIB2 Encryption Files......................................................................................211
Resetting SNIB2 Encryption...................................................................................................211
Timers.............................................................................................................................................213
Control Mode Timers..............................................................................................................213
Control Delay Timers..............................................................................................................213
Door Timers ............................................................................................................................213
Door Delay Timers..................................................................................................................214
Velocity Configuration ........................................................................................................ 215
Command Sets................................................................................................................................216
Command Sets: How to Define ..............................................................................................216
Command Set Properties Dialog Box .....................................................................................218
Command Sets: Executing ......................................................................................................219
Command Sets: Modifying .....................................................................................................220
Command Syntax....................................................................................................................221
Command 88 ........................................................................................................................221
Command 98 ........................................................................................................................223
Command 188 ......................................................................................................................225
Rules & Conventions ...........................................................................................................226
Credential Templates......................................................................................................................228
Adding Credential Templates .................................................................................................228
Editing Credential Templates..................................................................................................229
Deleting Credential Templates................................................................................................229
Credential Template Properties Dialog Box ..........................................................................230
General Property Sheet ........................................................................................................230
Card Types .......................................................................................................................234
Function Property Sheet .......................................................................................................235
Limits Property Sheet...........................................................................................................236
Options Property Sheet ........................................................................................................239
Functions.................................................................................................................................241
Access Functions..................................................................................................................241
Alarm Functions...................................................................................................................242
Input Control Functions ...................................................................................................245
Control Functions.................................................................................................................246
Priority Levels..................................................................................................................248
Time Zone Control of Relays ...................................................................................249
Password Functions..............................................................................................................249
Special Functions .................................................................................................................250
Indexed Commands .........................................................................................................253
Clear Code Tamper...................................................................................................253
Count Users Other Side ............................................................................................254
Count Users This Side ..............................................................................................254
Forgive All Users......................................................................................................254

xi
Velocity Version 3.1 Administrator’s Guide

Manual Holiday Tables ............................................................................................ 255

Manual Unholiday Tables ........................................................................................ 255
DIGI*TRAC Annunciator ................................................................................................... 256
Door Groups .................................................................................................................................. 257
Door Groups: How to Define ................................................................................................. 257
Changing Time Zones For Door Groups............................................................................. 259
Door Groups: Cloning ............................................................................................................ 260
Door Groups: Properties dialog box....................................................................................... 261
Master Door Groups .............................................................................................................. 263
Function Groups ............................................................................................................................ 265
Function Groups: How to Define ........................................................................................... 265
Function Group Properties Dialog Box.................................................................................. 267
Function Groups: Define Extension Dialog Box................................................................. 269
Defining Code Extensions ................................................................................................... 270
Define Function Dialog Box................................................................................................ 271
Function Groups: Copying ..................................................................................................... 272
Function Groups: Examples ................................................................................................... 273
Operators........................................................................................................................................ 275
Operators: How to Enroll ....................................................................................................... 275
Operator Properties Dialog Box ............................................................................................. 276
General Property Sheet........................................................................................................ 276
Operator Roles Properties Sheet.......................................................................................... 279
Operators: Conflicting Roles ............................................................................................... 280
Domain Administrators ....................................................................................................... 280
Locking Down Operators ....................................................................................................... 281
Person Templates ........................................................................................................................... 283
Roles .............................................................................................................................................. 285
Partitioning ............................................................................................................................. 285
How Velocity Does Partitioning.......................................................................................... 286
How Velocity 3.1 Upgrade Handles Operator Permissions ................................................ 286
Roles: How To Define............................................................................................................ 287
Roles: Copying ....................................................................................................................... 288
Roles: Renaming .................................................................................................................... 289
Role Properties Sheet ............................................................................................................. 289
Role Properties: Members Page .......................................................................................... 291
Role Properties: Add Ins Page............................................................................................. 292
Role Properties: Application Permissions ........................................................................... 292
Permissions and Behaviors.............................................................................................. 301
Roles: Application Permissions Detail............................................................................ 302
Role Properties: Cameras .................................................................................................... 307
Role Properties: Command Sets .......................................................................................... 307
Role Properties: Credential Templates ................................................................................ 307
Role Properties: DIGI*TRAC ............................................................................................. 308
Role Properties: Door Groups ............................................................................................. 309
Role Properties: Event Viewer Filters ................................................................................. 309
Role Properties: Function Groups ....................................................................................... 309
Role Properties: Graphics.................................................................................................... 310
Role Properties: Members ................................................................................................... 310
Role Properties: Person Groups........................................................................................... 311
Role Properties: Person Templates...................................................................................... 311

xii
 MAN006-0612

Role Properties: Reports ......................................................................................................311

Role Properties: Status Viewer Groups................................................................................312
Role Properties: Video Explorer Groups .............................................................................312
Role Properties: Workstations..............................................................................................312
Time Zones.....................................................................................................................................313
Standard Time Zones: How to Define ....................................................................................314
Master Time Zones: How To Define ......................................................................................316
Grand Master Time Zones: How to Define ............................................................................317
Time Zone Properties Dialog Box ..........................................................................................318
Standard Time Zone Properties Page ...................................................................................319
Master Time Zone Properties Page ......................................................................................322
Grand Master Time Zone Properties....................................................................................323
Deleting Time Zones...............................................................................................................325
Time Zones Examples.............................................................................................................325
Time Zones: Explaining the H Column ..................................................................................326
Daylight Savings .....................................................................................................................328
Creating Time Zones On-The-Fly...........................................................................................328
Holidays .........................................................................................................................................330
Holidays: How To Define .......................................................................................................330
Holiday Properties Dialog Box ...............................................................................................331
Holiday Schedules................................................................................................................332
Workstations...................................................................................................................................334
Adding Workstations ..............................................................................................................334
Locking Down Workstations ..................................................................................................335
Alarm Responses............................................................................................................................337
Threat Levels ..................................................................................................................................338
Renaming Threat Levels .........................................................................................................339
Card Data Mapping ........................................................................................................................340
Applying Data Map to Available Reader................................................................................340
Using Customized Card Codes ...............................................................................................341
Interfaces Configuration ..................................................................................................... 343
Serial Port Writers..........................................................................................................................344
Serial Port Writer Property Sheet...........................................................................................345
Serial Port Writer: Advanced Event Selection........................................................................346
Serial Port Writer: Format Dialog Box ................................................................................347
E-mail Writers ................................................................................................................................348
E-mail Writer Properties Dialog Box......................................................................................348
E-mail Writer: Advanced Event Selection ...........................................................................351
E-mail Writer: Design Tips.....................................................................................................352
Message Queue Writers .................................................................................................................356
Message Queues: Preliminaries ..............................................................................................356
Message Queue Writer: How to Define..................................................................................358
XML Writers ..................................................................................................................................360
Installing XML Writers...........................................................................................................361
Configuring XML Writers ......................................................................................................361
Advanced Event Selection ......................................................................................................364
Central Stations ..............................................................................................................................365
Alarm Device Configuration Preparation ...............................................................................366

xiii
Velocity Version 3.1 Administrator’s Guide

Configuring Alarm Panels ................................................................................................... 366

Configuring Alarm Receivers.............................................................................................. 368
Central Stations: Setting Up Velocity .................................................................................... 369
Central Stations: Receiver Setup ......................................................................................... 369
Central Stations: Account Setup.......................................................................................... 373
Central Stations: Area Setup................................................................................................ 374
Central Stations: Point Setup............................................................................................... 375
Central Stations: Operator and Roles .................................................................................. 377
Central Stations: Using Alarm Viewer................................................................................ 377
Central Stations: Placing Alarm Icons on a Map ................................................................ 378
Import/Export Wizards ....................................................................................................... 381
Badge Template Migration Wizard................................................................................................ 382
SAM Database File Import Wizard ............................................................................................... 384
Fields that SAM Wizard Imports ........................................................................................... 386
CCM Import Wizard...................................................................................................................... 388
Velocity Data Export Wizard ......................................................................................................... 390
Velocity Data Export Wizard: Choose Destination................................................................ 391
Select Destination File Format ............................................................................................... 392
Customizing the Export File................................................................................................ 393
Velocity Data Export Wizard: Data Export Result ................................................................ 395
Velocity Data Import Wizard ......................................................................................................... 397
Velocity Data Import Wizard: Data Import Result ................................................................ 399
Velocity Data Import Wizard: Data Source ........................................................................... 399
Velocity Data Import Wizard: Select File Format ................................................................. 400
Velocity Data Import Wizard: Map Data Fields .................................................................... 401
Manual Mapping.................................................................................................................. 402
SNIB2 Import Wizard.................................................................................................................... 403
Add-Ins.................................................................................................................................. 405
Add-In Manager............................................................................................................................. 406
External Application Launcher............................................................................................... 407
Remote Desktop ..................................................................................................................... 409
Tip of the Day......................................................................................................................... 410
Feature Activation.......................................................................................................................... 411
Server Extensions .......................................................................................................................... 412
Installing Server Extensions ................................................................................................... 412
Server Extensions: Uninstalling ............................................................................................. 414
Installing Extension Service on a Client ................................................................................ 414
Alarm Viewer ....................................................................................................................... 417
Starting Alarm Viewer ................................................................................................................... 418
Alarm Viewer Main Screen ........................................................................................................... 419
Icon Bar .................................................................................................................................. 420
Alarm Viewer Columns.......................................................................................................... 420
Address Format.................................................................................................................... 422
How To Use Alarm Viewer............................................................................................................ 424
Acknowledging an Alarm....................................................................................................... 424
Acknowledging All Alarms.................................................................................................... 424
Clearing an Alarm .................................................................................................................. 425
Clearing All Alarms ............................................................................................................... 425

xiv
 MAN006-0612

Displaying a Credential...........................................................................................................425
Copying to Clipboard..............................................................................................................426
Operator Notes ........................................................................................................................426
Replaying a WAV File............................................................................................................428
Playing DVR Video ................................................................................................................428
Get Recorded Alarm Video.....................................................................................................428
Viewing Instructions for an Alarm .........................................................................................429
Viewing a Map for an Alarm ..................................................................................................429
Refresh Alarms on the Alarm Viewer.....................................................................................429
Modifying Alarm Viewer Properties ......................................................................................430
Alarm Viewer Properties Dialog Box.....................................................................................431
Alarm Viewer General Property Sheet ................................................................................431
Alarm Viewer Properties Sorting Page ................................................................................433
Placing Alarm Viewer on the Velocity Desktop.............................................................................435
Closing Alarm Viewer....................................................................................................................436
Badge & Graphic Designer ................................................................................................. 437
Opening Badge & Graphic Designer .............................................................................................438
Setting Up Badge Printers ..............................................................................................................439
Overriding Default Printers.....................................................................................................439
Page Setup ......................................................................................................................................441
Page Setup Dialog Box ...........................................................................................................441
Print Setup Page ...................................................................................................................441
Page Size Page .....................................................................................................................442
Drawing Scale Page .............................................................................................................443
Page Properties.....................................................................................................................444
Fundamentals .................................................................................................................................446
Status Line...............................................................................................................................448
Designer Hot Keys ..................................................................................................................449
Designer Canvas .....................................................................................................................450
Grids.....................................................................................................................................450
Grid Settings ....................................................................................................................452
Ruler Bars.............................................................................................................................452
Menu Tool Bar ........................................................................................................................453
Designer Icon Tool Bar...........................................................................................................458
Icon Tool Bar Repositioning................................................................................................463
Design/Live Mode...................................................................................................................464
Alarm Queue Pane ..................................................................................................................465
Object Library .........................................................................................................................467
VIO (Integrated) Folder .......................................................................................................469
VSO (Standard) Folder ........................................................................................................470
VDO (Databound) Folder ....................................................................................................470
Topology Folder...................................................................................................................471
Directory Pane.........................................................................................................................471
Drawing Selection Tabs ..........................................................................................................473
Pan and Zoom Pane................................................................................................................473
Properties Pane........................................................................................................................474
Showing/Hiding the Properties Pane ...................................................................................477
Editing Properties.................................................................................................................478
Categorizing Properties........................................................................................................478

xv
Velocity Version 3.1 Administrator’s Guide

Closing Badge Designer ......................................................................................................... 478

Basic Procedures............................................................................................................................ 479
Selecting an Object................................................................................................................. 479
Selecting Multiple Objects ..................................................................................................... 480
Copying Objects ..................................................................................................................... 481
Cutting Objects....................................................................................................................... 482
Pasting Objects ....................................................................................................................... 482
Deleting Objects ..................................................................................................................... 482
Resizing or Reshaping an Object ........................................................................................... 483
Rotating Objects ..................................................................................................................... 485
Ordering Objects .................................................................................................................... 486
Moving Objects ...................................................................................................................... 488
Grouping Objects.................................................................................................................... 488
Aligning Objects..................................................................................................................... 489
Mirroring Objects ................................................................................................................... 489
Magnifying the Drawing ........................................................................................................ 490
Panning Drawings .................................................................................................................. 491
Switching Between Drawings ................................................................................................ 491
Undoing an Action ................................................................................................................. 491
Saving Drawings .................................................................................................................... 492
Renaming Drawings and Objects ........................................................................................... 492
Print Preview .......................................................................................................................... 492
Printing Badges and Drawings ............................................................................................... 493
Drawing and Designing ................................................................................................................. 494
Badge Templates: Creating .................................................................................................... 494
Designing a Basic Badge........................................................................................................ 494
Designing a Badge.................................................................................................................. 494
Double-Sided Badges .......................................................................................................... 496
Designing a Drawing.............................................................................................................. 497
Creating a Drawing................................................................................................................. 498
Displaying a Drawing............................................................................................................. 500
Closing Drawings ................................................................................................................... 500
Displaying a Badge Template ................................................................................................ 500
Importing Drawings................................................................................................................ 501
Importing Velocity Objects .................................................................................................... 503
Drawing an Arc ...................................................................................................................... 503
Extending Arcs into Semicircles and Larger....................................................................... 504
Drawing a Chord .................................................................................................................... 504
Drawing an Ellipse ................................................................................................................. 505
Drawing a Control Zone......................................................................................................... 505
Drawing a Line ....................................................................................................................... 506
Drawing a Polygon ................................................................................................................. 507
Drawing a Polyline ................................................................................................................. 508
Drawing a Sector .................................................................................................................... 509
Drawing a Rectangle .............................................................................................................. 510
Inserting Text.......................................................................................................................... 510
Inserting Standard Text ....................................................................................................... 510
Inserting Databound Text .................................................................................................... 511

xvi
 MAN006-0612

Inserting an Image...................................................................................................................511
Inserting a Static Image........................................................................................................512
Inserting a Databound Image ...............................................................................................512
Inserting Magstripes................................................................................................................513
Inserting Barcodes...................................................................................................................514
Object Properties ............................................................................................................................516
Categorizing Properties...........................................................................................................516
Editing Properties....................................................................................................................516
Arc Properties .........................................................................................................................517
Barcode Properties ..................................................................................................................520
Bar Codes & Bar Code Symbologies...................................................................................524
Chord Properties .....................................................................................................................527
Control Zone Properties ..........................................................................................................529
Ellipses Properties...................................................................................................................532
Group Properties .....................................................................................................................535
Image Properties .....................................................................................................................537
Databound Image Properties...................................................................................................539
Line Properties ........................................................................................................................542
Magstripe Properties ...............................................................................................................544
Placed Object Properties .........................................................................................................547
Polygon Properties ..................................................................................................................550
Polyline Properties ..................................................................................................................552
Rectangle Properties ...............................................................................................................555
Sector Properties .....................................................................................................................557
Text Properties ........................................................................................................................559
Databound Text Properties......................................................................................................562
Camera Properties ...................................................................................................................565
Analog Camera Properties ...................................................................................................565
Digital Camera Properties ....................................................................................................568
Quick Link Viewer Properties ................................................................................................570
Command Set Properties.........................................................................................................573
Link Properties........................................................................................................................576
CCTV Call To Monitor Properties..........................................................................................578
General Drawing Properties....................................................................................................581
Inserting Variable Field Names ..............................................................................................582
Add Image Dialog Box ...........................................................................................................585
Adding Color...........................................................................................................................586
Line Color ...............................................................................................................................586
Fill Color .................................................................................................................................586
Back Color ...........................................................................................................................587
Color Palette.........................................................................................................................588
Color Dialog Box .................................................................................................................588
Color Models........................................................................................................................590
HSB model.......................................................................................................................590
RGB model ......................................................................................................................590
Line Style ................................................................................................................................591
Fill Style..................................................................................................................................592
Editing Text.............................................................................................................................593
Edit Text Dialog Box ...........................................................................................................594

xvii
Velocity Version 3.1 Administrator’s Guide

Changing Text Characteristics............................................................................................. 594

Font Dialog Box .............................................................................................................. 594
Font Styles .............................................................................................................................. 595
Bleeding Edge Text ............................................................................................................. 596
Exporting Drawings................................................................................................................ 597
Support for AutoCad ........................................................................................................... 598
AutoCad File Import ....................................................................................................... 599
DXF File Export.............................................................................................................. 599
Advanced Procedures .................................................................................................................... 601
Badge & Graphic Designer Options....................................................................................... 601
Map Hierarchies ..................................................................................................................... 603
Linking Drawings................................................................................................................... 604
Testing Links ....................................................................................................................... 605
Placing Objects on Drawings ................................................................................................. 605
Placing Cameras ..................................................................................................................... 607
Placing Analog Cameras ..................................................................................................... 608
Placing Digital Cameras ...................................................................................................... 609
Placing Command Sets........................................................................................................... 612
Custom Links.......................................................................................................................... 613
CCTV Call Camera to Monitor ........................................................................................... 614
Quick Link Viewer .............................................................................................................. 616
Custom Link Manager ......................................................................................................... 618
Designing a Velocity Object .................................................................................................. 619
Adding VSOs to the Object Library .................................................................................... 619
Adding VIOs to the Object Library..................................................................................... 619
Adding New Folders to the Object Library ......................................................................... 622
Editing Velocity Objects ........................................................................................................ 622
Integration Builder.................................................................................................................. 623
Integration Builder Screen................................................................................................... 625
Cause and Effect Pane..................................................................................................... 626
Using the Integration Builder .............................................................................................. 628
Edit Behavior for VIO Group.............................................................................................. 633
Edit VIO Behavior............................................................................................................... 633
VIOs Made Simple .............................................................................................................. 634
VIO Example....................................................................................................................... 637
Preparation ...................................................................................................................... 637
Creating the VIO ............................................................................................................. 639
Testing the VIO............................................................................................................... 644
AlarmFlash Property............................................................................................................ 645
Show Credential Information ................................................................................................. 645
Custom Badge Fields.............................................................................................................. 646
Topology Object Mapping ..................................................................................................... 647
UDF Property Definitions ...................................................................................................... 648
Layers .................................................................................................................................... 651
Creating Layers.................................................................................................................... 652
Editing Layers...................................................................................................................... 652
Assigning Objects to Layers................................................................................................ 653
Deleting Layers.................................................................................................................... 653
Layers Properties ................................................................................................................. 654

xviii
 MAN006-0612

CCTV Configuration ........................................................................................................... 657

CCTV: How to Define a System ....................................................................................................659
CCTV: Port Configuration .............................................................................................................660
Port Properties Dialog Box .....................................................................................................660
Port Manager...........................................................................................................................663
CCTV: Switcher Configuration......................................................................................................664
Switcher Properties Dialog Box..............................................................................................665
CCTV: Camera Configuration........................................................................................................667
Camera Properties Dialog Box ...............................................................................................667
Presets Page..........................................................................................................................668
Using Presets........................................................................................................................669
CCTV Viewer.................................................................................................................................671
CCTV Viewer Control Functions ...........................................................................................674
Pan-Tilt.................................................................................................................................674
Zoom Mode ..........................................................................................................................674
Focus Mode ..........................................................................................................................674
Iris Mode .............................................................................................................................674
Auto Pan...............................................................................................................................674
CCTV Camera Properties ....................................................................................................675
Triggering CCTV Actions ......................................................................................................675
Customization Manager ...................................................................................................... 677
How To Use Customization Manager ............................................................................................678
Customization Manager Main Screen.....................................................................................679
Alarms.....................................................................................................................................681
Events......................................................................................................................................683
Return to Normal Events.........................................................................................................684
Software ..................................................................................................................................685
Components ............................................................................................................................687
Mouse Rollover....................................................................................................................689
Integrated Devices...................................................................................................................690
Integrated Alarms.................................................................................................................690
Integrated Events..................................................................................................................692
Resetting to Default..............................................................................................................693
Point Customization .............................................................................................................694
Escalation.........................................................................................................................696
Advanced Options Dialog Box ............................................................................................696
Alarm Levels ........................................................................................................................698
Creating Instructions ............................................................................................................698
Foreign Language Text ........................................................................................................699
Customization Import/Export Wizard ............................................................................................700
Diagnostic Window .............................................................................................................. 703
Using the Diagnostic Window........................................................................................................704
Diagnostic Screen ...................................................................................................................706
Icon Tool Bar ..........................................................................................................................707
Generating Reports.........................................................................................................................709
Updating Firmware Revisions ............................................................................................ 711
CCM Firmware Update Wizard .....................................................................................................712
Acquire Firmware ...................................................................................................................712

xix
Velocity Version 3.1 Administrator’s Guide

Import Firmware..................................................................................................................... 713

Update Firmware .................................................................................................................... 713
SNIB2 Firmware Update Wizard .................................................................................................. 715
Acquire SNIB2 Firmware....................................................................................................... 715
Import SNIB2 Firmware......................................................................................................... 715
Update SNIB2 Firmware........................................................................................................ 715
DVR / NVR Configuration and Usage ............................................................................... 717
Configuring the DVR/NVR ........................................................................................................... 719
Add DVR/NVR Unit Properties............................................................................................. 720
General Page........................................................................................................................ 720
DVR/NVR Unit Status page................................................................................................ 723
DVR/NVR Unit Info Page................................................................................................... 724
Operating the DVR or NVR .......................................................................................................... 726
Addressing the DVR/NVR and Attached Cameras................................................................ 726
Addressing a DVR/NVR Camera Directly............................................................................. 727
Viewing DVR/NVR Video From Attached Cameras ............................................................ 727
Viewing DVR/NVR Camera Video .................................................................................... 728
Live View ............................................................................................................................ 728
Live Video Screen........................................................................................................... 729
Video Explorer .................................................................................................................... 731
Search & Retrieve Recorded Video ....................................................................................... 733
Play & Export Local Video .................................................................................................... 734
Play Video Window............................................................................................................. 735
Menu Tool Bar ................................................................................................................ 736
Location Indicators.......................................................................................................... 736
Control Buttons & Speed Slider...................................................................................... 736
Start & End Time Fields.................................................................................................. 737
Navigation Buttons.......................................................................................................... 738
Image Tools..................................................................................................................... 738
Export DVR/NVR Video ....................................................................................................... 740
Generate and Stop Host Alarm............................................................................................... 740
Get Alarm List........................................................................................................................ 741
Time Synchronization ............................................................................................................ 744
Drag & Drop DVR/NVR Camera Views ............................................................................... 744
Drag & Drop with Live View.............................................................................................. 744
Drag & Drop with Video Explorer ...................................................................................... 745
DVR/NVR View Groups........................................................................................................ 745
DVR/NVR Camera Control ................................................................................................... 746
PTZ Camera Controls.......................................................................................................... 749
Camera Quick Views........................................................................................................... 750
Programming Camera Patterns............................................................................................ 751
All Video Events............................................................................................................................ 753
Event History Viewer..................................................................................................................... 756
Generating History Logs ........................................................................................................ 756
Customizing DVR/NVR Logs................................................................................................ 757
DVR/NVR Event List Functions............................................................................................ 759
Triggering DVR/NVR Actions............................................................................................... 759
Enrollment Manager............................................................................................................ 761
Badge Printer Configuration.......................................................................................................... 762

xx
 MAN006-0612

Opening Enrollment Manager........................................................................................................763

Enrollment Manager Main Screen .................................................................................................764
Enrollment Manager Menu Bar ..............................................................................................766
People Tree Pane.....................................................................................................................768
Person Group Subfolders ........................................................................................................769
Personal Information Pane ......................................................................................................769
General Property Sheet ........................................................................................................770
TAB1 - TAB10 Property Sheets ..........................................................................................772
Groups Property Sheet .........................................................................................................772
Additional Images Property Sheet .......................................................................................773
Personal Information Form .....................................................................................................775
Changing User-Defined Fields .......................................................................................................776
User-Defined Setup.................................................................................................................778
Defining Additional Images....................................................................................................781
Device Configuration .....................................................................................................................783
Enrollment Station Configuration ...........................................................................................784
Signature Capture Pad Configuration .....................................................................................786
Scanners Configuration...........................................................................................................787
Scanner Maintenance ...........................................................................................................791
PIV Reader Configuration ......................................................................................................792
Device Configuration for RUU Station ..................................................................................794
Mapping UDF Fields............................................................................................................795
Customizing the Personal Information Form .................................................................................798
Enrolling a New Person..................................................................................................................800
Editing Multiple Persons.........................................................................................................801
Person Templates ....................................................................................................................802
Assigning a Credential to a Person .........................................................................................804
Assigning an Existing Credential to a Person ......................................................................804
Assigning a Person to an Existing Credential ......................................................................806
Assigning a New Credential to a Person..............................................................................806
Assigning a Credential Template to a Person ......................................................................807
Unassigning Credentials.......................................................................................................807
Downloading Credentials.....................................................................................................807
Downloading Multiple Credentials ......................................................................................808
Finding a Person.............................................................................................................................809
Search Groups .........................................................................................................................810
Search Groups Screen ..........................................................................................................811
Finding a Card Credential .......................................................................................................813
Search Filters...........................................................................................................................815
Person Filters...........................................................................................................................815
Quick Find...............................................................................................................................816
Wildcard Symbols................................................................................................................817
Multiple People Selection ..............................................................................................................818
Displaying Credentials for Multiple Persons ..........................................................................818
Modifying an Existing Person........................................................................................................820
Modifying Existing Credentials for a Person..........................................................................821
Deleting Persons .....................................................................................................................821
Person Groups ................................................................................................................................823
Adding People to Person Groups ............................................................................................824

xxi
Velocity Version 3.1 Administrator’s Guide

Batch Enroll Card Credentials................................................................................................ 826

Batch Enroll Card Credential Screen................................................................................... 828
Enrollment Station............................................................................................................... 829
Connecting Enrollment Stations...................................................................................... 830
Configuring Enrollment Stations .................................................................................... 830
Testing Enrollment Stations ............................................................................................ 831
Enrollment Station Diagnostics Dialog Box ................................................................... 831
Capturing a Signature .................................................................................................................... 833
Capturing a Photo .......................................................................................................................... 835
Video Capture...................................................................................................................... 836
Video Dialog Box............................................................................................................ 837
TWAIN Capture .................................................................................................................. 838
TWAIN Setup Dialog Box.............................................................................................. 838
File Capture ......................................................................................................................... 840
Image Preview ..................................................................................................................... 840
Image Preview Dialog Box ............................................................................................. 841
Additional Images .................................................................................................................. 843
E-mailing a Photo ................................................................................................................ 844
Saving a Photo to Another Source....................................................................................... 845
Scanning Enrollment Data...................................................................................................... 846
Verify Scanner Data ............................................................................................................ 848
Scanning Business Cards ................................................................................................ 848
Scanning OCR Licenses.................................................................................................. 849
Scanning Bar Code Licenses........................................................................................... 850
Scanning Passports.......................................................................................................... 851
Reading PIV Cards.......................................................................................................... 852
Read RUU Verification Station....................................................................................... 853
Configuring PIV Readers in Velocity ............................................................................. 854
Previewing a Badge ....................................................................................................................... 859
Print Preview Screen .............................................................................................................. 859
Printing a Badge ............................................................................................................................ 861
Badge Print Status .................................................................................................................. 861
Double-Sided Badge Printing................................................................................................. 862
Credentials ..................................................................................................................................... 863
How to Define Credentials ..................................................................................................... 864
Credential Properties Dialog Box........................................................................................... 864
General Property Sheet........................................................................................................ 865
Function Property Sheet ...................................................................................................... 869
Limits Property Sheet .......................................................................................................... 870
Options Property Sheet........................................................................................................ 873
Define Function Dialog Box ........................................................................................... 875
Credential Biometrics Properties Sheet............................................................................... 877
Writing Fingerprint Data to a Credential ........................................................................ 878
ID Formats (IDF)................................................................................................................. 880
Duress Digits ....................................................................................................................... 881
Setting Up Duress Digits................................................................................................. 881
Using Duress Digits With Code Extension Digits .......................................................... 882
Credentials: Set Expiration Date ..................................................................................... 882
Credentials: Link to Template ............................................................................................. 883
Credentials: Executing Function Groups............................................................................. 884
Credentials: Concatenating UDFs ....................................................................................... 885

xxii
 MAN006-0612

Credentials: Reissue .............................................................................................................886

Credential Tasks......................................................................................................................887
Display Credential Information............................................................................................889
Absentee Limiting ................................................................................................................890
Use Limiting.........................................................................................................................890
Day Limiting ........................................................................................................................890
Executive Passback Override ...............................................................................................891
Forgiving Passback ..............................................................................................................891
Forgiving Users....................................................................................................................891
Alert......................................................................................................................................892
Tagging ................................................................................................................................892
Auto-Delete ..........................................................................................................................892
Credential (User) Management ......................................................................................................894
Global Credential (User) Management ...................................................................................895
Preferences .....................................................................................................................................896
Relative Time Shortcut ...........................................................................................................897
Event Viewer ........................................................................................................................ 899
How To Use Event Viewer .............................................................................................................900
Event Viewer Main Screen .....................................................................................................900
Customizing the Event Viewer's Appearance ......................................................................901
Event Viewer: Suspend Scrolling ...........................................................................................902
Event Viewer: Displaying a Credential ..................................................................................902
Event Viewer: Showing Statistics...........................................................................................902
Event Viewer: Changing Event Colors...................................................................................903
Event Viewer: Copying to Clipboard......................................................................................904
Filter Groups ..................................................................................................................................905
Creating Filter Groups ............................................................................................................905
Editing Filter Groups ..............................................................................................................905
Selecting a Filter Group ..........................................................................................................906
Filtering Events by Type.........................................................................................................906
Event Viewer Properties .................................................................................................................907
Event Viewer Properties Dialog Box......................................................................................907
General Property Sheet ........................................................................................................908
Filters Property Sheet ...........................................................................................................910
Event Types.............................................................................................................................911
Examples ............................................................................................................................... 913
Basic Example................................................................................................................................914
List of Examples .....................................................................................................................917
Example: Access Per Reader..........................................................................................................918
Examples: Alarm Functions ...........................................................................................................920
Example: Pre-Arm Status........................................................................................................922
Example: Conditional Unmask ...............................................................................................922
Example: Partial Unmask........................................................................................................923
Example: Control Zone Triggers on Secure...................................................................................925
Examples: Credential (User) Management ....................................................................................927
Example: Absentee Rules .......................................................................................................927
Example: Day Limiting...........................................................................................................929
Example: Use Count ...............................................................................................................930

xxiii
Velocity Version 3.1 Administrator’s Guide

Example: Global User Management ...................................................................................... 931

Examples: Custom Card Codes ..................................................................................................... 932
Example 1: Custom Card Codes............................................................................................. 932
Example 2: Custom Card Codes – Long Card Codes ............................................................ 933
Examples: Setting Up Smart Cards ............................................................................................... 936
Example: Enrolling PIV Cards into Velocity......................................................................... 936
Example: Enrolling DoD CAC Cards .................................................................................... 940
Examples: Passback....................................................................................................................... 943
Example: Zoned Passback...................................................................................................... 943
Example: Zoned Occupancy Control ..................................................................................... 944
Example: Forgive Passback.................................................................................................... 946
Example: Executive Override................................................................................................. 948
Example: Global Passback ..................................................................................................... 948
Examples: Extended Access .......................................................................................................... 951
Example: Function Groups ............................................................................................................ 954
Example: Globalized Master Control Zones ................................................................................. 956
Example 1............................................................................................................................... 956
Example 2............................................................................................................................... 960
Examples: Holidays ....................................................................................................................... 962
Example: Multiple Tenants Holidays..................................................................................... 962
Example: Half-Day Holidays ................................................................................................. 965
Example: Flex Schedules ....................................................................................................... 968
Example: Unplanned Holidays............................................................................................... 970
Example: Latch Monitor Feature................................................................................................... 972
Example: Long PINs...................................................................................................................... 974
Examples: Man Trap...................................................................................................................... 976
Example: Two-Person Rule ........................................................................................................... 980
Example: Print ACBs Not At Default............................................................................................ 983
Example: Quarter-Second Relay Times......................................................................................... 984
Examples: ScramblePad Options................................................................................................... 986
Example: Deny Under Duress ................................................................................................ 987
Example: Duress without Access ........................................................................................... 987
Example: Silent Code Tamper................................................................................................ 988
Example: Code Tamper Disables Card or Code Holder ........................................................ 990
Example: Code Tamper Disables Credential ......................................................................... 990
Example: Green LED While Relay Active ............................................................................ 992
Example: Green Flash in Door Delay .................................................................................... 993
Example: Yellow Flash for Control Delay............................................................................. 994
Example: Threat Levels ................................................................................................................. 997
Examples: Who's Inside................................................................................................................. 999
Velocity Learning Center .................................................................................................. 1001
Opening the Learning Center....................................................................................................... 1002
Learning Center Main Screen...................................................................................................... 1002
How to Use the Learning Center ................................................................................................. 1003
Closing Learning Center.............................................................................................................. 1003
Report Manager ................................................................................................................. 1005
Opening Report Manager ............................................................................................................ 1007

xxiv
 MAN006-0612

Report Manager Main Screen ......................................................................................................1008

Report Manager: Menu Bar ..................................................................................................1009
Report Manager: Icon Tool Bar ............................................................................................1010
Creating a Report .........................................................................................................................1011
Add a New Report.................................................................................................................1011
List of Existing Reports ........................................................................................................1012
Customizing an Existing Report ..................................................................................................1018
Criteria Page..........................................................................................................................1021
Sorting Page ..........................................................................................................................1023
Selected Criteria List Pane ....................................................................................................1024
Saving Custom Reports.........................................................................................................1025
Previewing a Report .....................................................................................................................1027
Report Preview Screen..........................................................................................................1027
Preview Screen Features ....................................................................................................1029
Printing Reports............................................................................................................................1031
Exporting Reports ........................................................................................................................1032
Exporting Reports & Report Definition Files .......................................................................1032
Exporting Reports .................................................................................................................1032
Importing Reports ........................................................................................................................1034
Importing Previously-Exported Reports ...............................................................................1035
Report Definition Files..........................................................................................................1035
Report Groups ..............................................................................................................................1037
Preferences ...................................................................................................................................1038
Scheduling Agent................................................................................................................ 1039
Scheduling Agent: How To Use ...................................................................................................1040
Activating/Deactivating Credentials .....................................................................................1041
Archiving Alarm and Event Logs .........................................................................................1041
Dialing Remote DIGI*TRAC Networks...............................................................................1042
E-mail Reports ......................................................................................................................1043
Executing Command Sets .....................................................................................................1046
Executing Programs ..............................................................................................................1046
Exporting Data ......................................................................................................................1047
Importing Data ......................................................................................................................1049
Perform Database Maintenance ............................................................................................1050
Printing Reports ....................................................................................................................1051
Report Printing Configuration............................................................................................1053
Synchronizing Controller Clocks..........................................................................................1057
Scheduling Agent Wizard ............................................................................................................1058
Scheduled Tasks Screen........................................................................................................1058
Scheduler Wizard: Select Task Type ....................................................................................1058
Scheduler Wizard: Configuration Screen .............................................................................1059
Scheduler Wizard: Select Schedule Interval .........................................................................1060
Scheduler Wizard: Schedule Detail ......................................................................................1061
Scheduler Wizard (Daily) Dialog Box ...............................................................................1061
Scheduler Wizard (Weekly) Dialog Box ...........................................................................1063
Scheduler Wizard (Monthly) Dialog Box ..........................................................................1064
Scheduler Wizard (One Time Only) Dialog Box...............................................................1066
Running a Task Manually.............................................................................................................1067

xxv
Velocity Version 3.1 Administrator’s Guide

Editing Existing Tasks ................................................................................................................. 1068

Deleting Tasks ............................................................................................................................. 1069
Task Schedule Properties Screen ................................................................................................. 1070
Service Control Manager (SCM)...................................................................................... 1073
Controlling SCM Services........................................................................................................... 1074
Customizing SCM ....................................................................................................................... 1075
Velocity Settings Dialog Box ...................................................................................................... 1076
CCTV Settings...................................................................................................................... 1077
Database Settings.................................................................................................................. 1077
Network Settings .................................................................................................................. 1078
Diagnostics Settings ............................................................................................................. 1079
Advanced Settings ................................................................................................................ 1081
Web Server ........................................................................................................................... 1082
DIGI*TRAC Network Service (DTNS) ...................................................................................... 1084
Restarting Velocity Services ........................................................................................................ 1085
SQL Database Manager .................................................................................................... 1087
Installing SQL Server Help ......................................................................................................... 1089
SQL Database Manager Main Screen.......................................................................................... 1090
SQL Database Manager: Databases............................................................................................. 1092
Database Tasks ..................................................................................................................... 1093
SQL Database Manager Database Properties....................................................................... 1094
Velocity Database Properties Screen................................................................................. 1094
Database Diagrams ............................................................................................................ 1095
Backing Up the Velocity Database.................................................................................... 1096
Back Up Database Dialog Box...................................................................................... 1097
General Page .......................................................................................................... 1097
Options Page .......................................................................................................... 1099
Defining Multiple Backup Locations ................................................................................ 1101
Restoring the Velocity Database ....................................................................................... 1102
Restoring Velocity Database to a New Computer............................................................. 1104
Restoring SNIB2 Encryption Files................................................................................ 1105
Restoring Server Extensions ......................................................................................... 1106
Restore Database Dialog Box ....................................................................................... 1106
General Page .......................................................................................................... 1107
Options Page ................................................................................................................. 1108
Moving Velocity Database to Another Domain ................................................................ 1109
Shrinking Databases .......................................................................................................... 1110
Shrink Database Dialog Box ......................................................................................... 1111
SQL Database Manager: Tables .................................................................................................. 1113
How to Use Tables ............................................................................................................... 1113
View Table Data................................................................................................................ 1113
View Table Properties ....................................................................................................... 1114
Adding a Table .................................................................................................................. 1115
Modify Existing Tables ..................................................................................................... 1116
SQL Database Manager: Programmability.................................................................................. 1118
SQL Database Manager: Stored Procedures ........................................................................ 1118
How to Use Stored Procedures...................................................................................... 1119
Viewing and Modifying Stored Procedures ........................................................... 1119
Creating New Stored Procedures .................................................................................. 1120

xxvi
 MAN006-0612

SQL Database Manager: Views ...................................................................................................1122

How to Use Views ................................................................................................................1122
Creating a New View .........................................................................................................1122
Opening an Existing View .................................................................................................1124
Modifying Existing Views .................................................................................................1125
Displaying View Properties ...............................................................................................1125
SQL Database Manager: Users ....................................................................................................1127
How to Set Up Database User Accounts ..............................................................................1127
Database Users Properties Dialog Box ..............................................................................1128
SQL Database Manager: Management ........................................................................................1130
SQL Database Manager: Security ................................................................................................1131
Logins...................................................................................................................................1131
How to Use Logins.............................................................................................................1131
Create a New Login .......................................................................................................1132
Review Login Properties ...............................................................................................1132
Delete an Existing Login ...............................................................................................1132
SQL Server Login Properties Dialog Box .....................................................................1133
General Login Properties Page ...............................................................................1133
Server Roles Page ...................................................................................................1135
User Mapping Page.................................................................................................1136
Server Roles ..........................................................................................................................1136
SQL Database Manager: Server Objects......................................................................................1138
Server Triggers......................................................................................................................1138
Basic SQL Commands .................................................................................................................1140
SQL Commands: INSERT....................................................................................................1140
SQL Commands: SELECT ...................................................................................................1147
SELECT (T-SQL) ..............................................................................................................1147
SELECT Clause .............................................................................................................1148
INTO Clause ..................................................................................................................1150
FROM Clause ................................................................................................................1150
WHERE Clause .............................................................................................................1152
GROUP BY Clause .......................................................................................................1153
HAVING Clause............................................................................................................1154
UNION Operator ...........................................................................................................1155
ORDER BY Clause .......................................................................................................1156
COMPUTE Clause ........................................................................................................1157
FOR BROWSE Clause ..................................................................................................1158
OPTION Clause .............................................................................................................1159
SELECT (Views) ...............................................................................................................1161
SQL Commands: UPDATE ..................................................................................................1162
Status Viewer...................................................................................................................... 1173
Status Viewer Main Screen ..........................................................................................................1174
Status Window Columns.......................................................................................................1175
Status Viewer: How to Use...........................................................................................................1181
Status Viewer Right-Click Options.......................................................................................1181
Creating Status Groups.................................................................................................................1183
Status Groups Page ...............................................................................................................1184
Column Headers Page ........................................................................................................1185
Status Messages ....................................................................................................................1186

xxvii
Velocity Version 3.1 Administrator’s Guide

Trigger Action Manager.................................................................................................... 1187

Using Trigger Action Manager ............................................................................................ 1187
Adding Trigger Actions........................................................................................................ 1188
Editing Triggers and Actions................................................................................................ 1189
Deleting Triggers and Actions.............................................................................................. 1189
Add Trigger Action Screen .................................................................................................. 1189
Trigger Page ..................................................................................................................... 1190
Select Locations Page.................................................................................................... 1191
Action Page........................................................................................................................ 1191
Troubleshooting.................................................................................................................. 1197
Basic Troubleshooting ................................................................................................................. 1198
System Report Wizard ................................................................................................................. 1201
How Do I... .................................................................................................................................. 1203
Frequently Asked Questions........................................................................................................ 1208
Technical Support ........................................................................................................................ 1213
Who’s Inside ....................................................................................................................... 1215
How To Use Who’s Inside ........................................................................................................... 1216
Who's Inside Screen ............................................................................................................. 1217
Who's Inside: Forgiving Credentials .................................................................................... 1219
Who's Inside: Reassigning Credentials to Another Zone ..................................................... 1220
Worksheets.......................................................................................................................... 1221
Index .................................................................................................................................... 1285

xxviii
 MAN006-0612

Introduction
Velocity© Version 3.1 is the latest version of the Hirsch Electronics security access
program that simplifies the task of controlling and monitoring access to any surveillance
system, no matter how large or small it is.
Velocity provides the kind of functionality you normally expect only from high-end
programs with the ease-of-use of an entry-level system.
Features you'll find in Velocity include:
 Easy-to-use graphical interface
 Intuitive operation
 Choice of controller networks (hardwired or networked)
 Centralized monitoring and control
 Real-time alarm and event monitoring
 Interactive maps with alarm, status, and control
 Dozens of standard reports
 Quick and easy badge and graphics creation

1
Velocity Version 3.1 Administrator’s Guide

Who Should Read This...

If you are an administrator or installer, tasked with the job of setting up and
administering this Velocity system, continue with the Velocity Administrators Guide.
If you are an operator interested in the day-to-day processes of enrolling badge holders,
monitoring security, and generating reports, refer to the Velocity Operators Guide.

2 Who Should Read This...

 MAN006-0612

Getting Started
Starting Velocity
To start Velocity:
 If, during Velocity installation, you checked the box that put the Velocity shortcut on
your Windows desktop, then double click the icon.
 If the Velocity shortcut icon does not appear on your Windows desktop, at the Start
menu, select Programs > Hirsch Electronics Velocity > Velocity.
The Velocity splash screen appears.
This screen disappears after a few seconds and the main Velocity screen appears.
To modify the text that appears on this splash screen, refer to “Splash Screen
Modification” on page 5.
You can make starting Velocity even easier by moving Velocity to your desktop. While
you have the choice to place the shortcut during Velocity installation, you can create a
shortcut later using the following procedure.
To create a shortcut for Velocity on your desktop:
1. From the Windows desktop, select Start > Programs > Hirsch Electronics
Velocity.
2. Right click on Velocity.
A list of options pop up.
3. Select Send to > Desktop (create shortcut).
The Velocity icon appears on your desktop as a shortcut, .
Once the Velocity icon is on your desktop, you only need to double click the icon to
start Velocity.

Velocity Registration
Once you’ve installed and started Velocity for the first time, you are prompted by a
Product Registration screen like this:

To register Velocity 3.1:

1. Do one of these then click Next.
• If you have already registered Velocity and have a Product Activation Key, click
Enter Key. Go to Step 5.

Getting Started 3
Velocity Version 3.1 Administrator’s Guide

• If you have not yet acquired a Product Activation Key, go to Step 2.

The End-User page of the Product Registration appears like this example:

2. Fill out the fields on this page and click Next.

All asterisked (*) fields must be filled out before you can continue to the next
page.
The Product Registration page appears like this example:

3. Do one of these:
• Write the System Identity number down.
• From this screen, click Copy.
4. Do one of these:
• Call the toll-free number on the Product Registration screen and repeat the
System Identity number to the designated Hirsch Sales executive.
• Create an E-mail, paste the System Identity number in the body, and send it to
the address on the Product Registration screen.
The Hirsch account executive will reply to this System Identity with a unique
five-part Product Key.
5. Enter the Product Key in the 'Product Key' field.
6. Click the Register button.
The main Velocity screen appears. The Product Registration screen does not appear
again.

4 Getting Started
 MAN006-0612

Splash Screen Modification

Whenever you open Velocity, the splash screen appears by default. The splash screen
indicates that the system is starting up properly.
The splash screen has a place for the customer to include their own text. For instance
some government customers require inclusion of the End User License Agreement
(EULA) while some dealers may prefer to insert their own name and phone number
for service.
To modify the splash screen:
1. Open Notepad or some other text editor.
2. Locate the file EULA.TXT under the \Velocity directory.
3. Edit the text file as required.
4. Save the changes (Ctrl + S or File > Save).
5. Close the text editor.
The next time the splash screen appears, the text modifications are displayed.

Exiting Velocity
To exit Velocity:
Do one of the following:
 Select File > Exit from the Velocity menu bar
 Click the Exit button, , in the upper right hand corner
 From Velocity, press Alt + F4.

Getting Started 5
Velocity Version 3.1 Administrator’s Guide

Velocity Main Menu

When you open Velocity, a main screen like the following example appears:

This screen is divided into four main sections.

Menu tool bar This is the main menu providing pull-down option lists for such
features as selecting different Velocity program modules (Console
option), quitting the program (File option), adding programs
(Add-Ins), consulting help, and selecting windows within the
program (Window option).
The program modules accessed through the Console option are
also accessible through the Icon Tool Bar.

Icon Tool Bar The icon bar enables the Velocity user to click and open any of the
Velocity modules. The most frequently used modules, such as the
Enrollment Manager and the Event Viewer, are displayed on the
left side of this bar.
The less frequently used functions, like the Badge Designer and
the SQL Manager, are grouped on the right end of this bar.

Main window This is the space within which the Velocity modules appear,
including the Administration window.
If docked, Velocity modules cannot be dragged beyond its border.
For more on this, refer to “Managing Velocity Windows” on page
33.

Status Line Contains information about the operator currently logged on, the
current number of alarms, a download monitor, threat level
indicator, date/time clock, and off normal point monitor.
For more on this, see “Status Line” on page 26.

6 Velocity Main Menu

 MAN006-0612

Velocity Administration Main Screen

The Administration main screen is normally nested within the confines of the main
menu and looks like this example:

The Administration main screen contains the:

 System Tree window (see page 7)
 Components window (see page 14)
 The term ‘window’ is used interchangeably with pane in this guide. Both
terms refer to an area within a larger screen where data or options are
displayed. For example, you will find references to both 'System Tree pane'
and 'System Tree window'. They are the same entity.
Use the Velocity Administration main screen to:
 Add components to the system
 Configure components
 Delete or copy components
 Specify a particular task to be performed by the current system (Task option)
 View the current system from two perspectives (View option)
Both the DIGI*TRAC Configuration and Interfaces Configuration folders include the
computer name, as shown in the previous example.
The Administration window is only available to operators who are members of the
administrator's role.

Hint Most Velocity operators won't need to access the administration window. Their job
is to monitor the system and identify possible problems. Only administrators
responsible for configuring the system should be granted access to this module.

System Tree Window (System Tree Pane)

The System Tree pane is located on the left side of the Velocity Administration main
screen and provides a hierarchical display of basic Velocity system components.
There are three main tree branches or folders:
 Velocity Configuration
 DIGI*TRAC Configuration
 Interfaces Configuration

Velocity Main Menu 7

Velocity Version 3.1 Administrator’s Guide

These three branches and subsidiary folders are shown in the following example:

Each folder is described briefly in the following subsections. More detailed descriptions
are available for each configuration topic in the following sections:
 The Velocity Configuration folder and its uses is outlined in “Velocity Configuration”
starting on page 215.
 The DIGI*TRAC Configuration folder and its uses is outlined in “Hardware
Configuration” starting on page 55.
 The Interfaces Configuration folder and its uses is outlined in “Interfaces
Configuration” on page 343.

Expanding and Contracting the System Tree

Here are instructions on expanding and contracting the system tree:

To expand a folder: To contract one or more folders:

Click on the sign. Click on the sign.

Double click the folder. Double click the expanded folder.

Select and press the right arrow Select the expanded folder and press the left
key. arrow key.

Select and press Enter. Select and press Enter.

Tree elements can consist of several different component types. Each element is
associated with an icon. These icons are described briefly in System Icons.

8 Velocity Main Menu

 MAN006-0612

An example of a fully expanded system tree is shown below:

Notice that the relationship of top-level folders to second-level folders is indicated by

dotted lines running between them. This not only establishes the relationship between
them but also the dominant and subordinate nature of the relationship. As you click
each plus mark to reveal the levels beneath it, the tree can expand to display any
number of nested levels.
You can display the components of a selected folder in the Components window.
To display a selected folder:
 From the System Tree window, double click the element you want to display. The
element you selected appears in the Components window.

Velocity Configuration Folder

One of the three major folders of the Configuration Tree is Velocity Configuration. This
folder provides all the information an operator requires to define the non-hardware
elements of this system.
An example of the Velocity Configuration folder tree is shown below:

Velocity Main Menu 9

Velocity Version 3.1 Administrator’s Guide

The subfolders comprising the Velocity Administration folder are:

This
Defines:
Folder:

Person A group of values that can be applied to a person during

Templates enrollment that can expedite the entering of values into the
Enrollment Manager Personal Information Form.
For more on this, refer to “Person Templates” on page 283.

Credential Most field values for card or code holder credentials. Filling out all
Templates credential fields for each card or code holder is time-consuming
and repetitive. To save time, use a credential template to preset
many of the fields in a template, then only customize a few
remaining fields to individualize the credential, as required, in
Enrollment Manager.
For more on this, refer to “Credential Templates” starting on page
228.

Time Zones All time zones defined for this system. This includes three possible
types of time zones: standard, master, and grand master time
zones.
For more on this, refer to “Time Zones” starting on page 313.

Holidays Holidays recognized by this system.

For more on this, refer to “Holidays” starting on page 330.

Door Groups All door groups associated with this system. A door group
associates one or more readers/ keypads with one or more time
zones.
A master door group associates several door groups. For more on
this, refer to “Door Groups” starting on page 257.

Function Access and control functions are performed whenever an

Groups extension digit is entered along with the normal PIN. For more on
this, refer to “Function Groups” starting on page 265.

Roles The tasks and forms an operator can access and use. It also
specifies which events and alarms are routed to them.
For more on this, refer to “Roles” on page 285.

Operators All system operators recognized by the system. A system operator

is any person who can use Velocity.
For more on this, refer to “Operators” starting on page 275.

Command One or more DIGI*TRAC commands that can be batched and

Sets triggered by any function you select, such as access to a drug
pantry or control to a control zone.
For more on this, refer to “Command Sets” starting on page 216.

Workstations All workstations currently defined for this system. For more on this,
refer to “Workstations” starting on page 334.

10 Velocity Main Menu

 MAN006-0612

This
Defines:
Folder:

Alarm A list of operator notes that can be entered quickly in Alarm Viewer.
Responses For more on this, refer to “Alarm Responses” on page 337.

Threat Levels A list of available threat levels. You can rename any of these threat
levels as required. For more on this, refer to “Threat Levels” on
page 338.

Card Data Digits in established codes or cards that are mapped to MATCH
Mappings code. For more on this, refer to “Card Data Mapping” on page 340.

DIGI*TRAC Configuration Folder

The DIGI*TRAC Configuration folder displays all the information an operator requires to
define and configure hardware for the Velocity system.

The three sub-folders under DIGI*TRAC Configuration specify the three possible
network protocols Velocity supports:

SNET Short for SCRAMBLE*NET protocol. This is the proprietary network

protocol used to connect Hirsch controllers to a host PC port. The host
port can use either a serial or TCP/IP connection.
For more on this, refer to “S*NET Systems” starting on page 66.

XNET Short for XBox Network protocol. This is the network protocol you
should choose if your host PC is connected to Hirsch controllers through
an intervening XBox or SNIB2s. The host port can use either a serial or
TCP/IP connection.
For more on this, refer to “X*NET Systems” starting on page 69.

Dial-Up This branch enables you to configure one or more controllers connected
to this server by a dial-up modem.
For more on this, refer to “Dial-Up Configuration” starting on page 135.

The structure of the DIGI*TRAC tree depends on the protocol you define above.
The second level folders define the Port. Three types of ports are supported by Velocity:
 SNET port—This defines a port used by the host PC to connect directly to one or
more controllers.
 XNET port—This defines a port used by the host PC to connect to one or more
controllers via an XBox or SNIB2.
 Dial-Up port—This port specifies a modem installed in the host PC that can connect
to and communicate with one or more remote controllers.
The next level indicates the component to which the port is connected:
 If this is SNET, , the controller connected to the SNET port is defined. This
specifies values used to configure the controller.

Velocity Main Menu 11

Velocity Version 3.1 Administrator’s Guide

 If this is XNET, , the XBox is next in line. Define the properties of the XBox
connected to this port. You then add one or more controllers that are connected to
this XBox.
 If this is a dial-up connection, , the dial-up location, connected remotely to the
modem is defined. You then define the remote modem settings and one or more
controllers that are connected to this remote modem.
The lowest level defines the components or devices connected to the controller. These
include:

This Folder: Defines:

Inputs Line modules (alarm inputs) connected to this controller.

For more on this, refer to “Inputs” starting on page 178.

Relays Relays connected to this controller. Locks connect to the

controller via these relays.
For more on this, refer to “Relays” starting on page 167.

Expansion Inputs Any expansion inputs (installed or uninstalled) connected to

this controller.
For more on this, refer to “Expansion Inputs” starting on page
186.

Expansion Relays Any expansion relays (installed or virtual outputs) connected

to this controller.
For more on this, refer to “Expansion Relays” starting on page
172.

Readers Any reader connected to this controller, including card,

ScramblePad, and biometric readers.
For more on this, refer to “Readers & Keypads” starting on
page 193.

Doors Doors connected to this controller. A door includes all inputs,

relays, and readers associated with this door.
You can also bundle unbundled inputs, relays, and readers to
form a door. For more on this, refer to “Bundling
Components to Create Doors” starting on page 147.
For more on this, refer to “Doors” starting on page 145.

If SNET is designated, then a final tree structure like this example appears:

12 Velocity Main Menu

 MAN006-0612

If XNET is designated, a tree structure like this example appears:

If the Dial-Up connection is designated, a tree structure like this example appears:

Interfaces Configuration Folder

The Interface Configuration folder is the third main branch in the system tree pane. It
contains all of the subfolders and components required to install and configure an
attached CCTV system. It also provides support for E-mail writers and serial port writer.
An example of the Interface Configuration fully expanded is shown in the following
example:

The elements of this branch are:

This Folder: Defines:

CCTV Closed-circuit TV systems attached to this Velocity system.

For detailed information on configuring and using the CCTV
subsystem functions, refer to “CCTV Configuration” starting
on page 657.

Serial Port Writers How and when alarms/events are sent to the serial port and
in what format.
For more on this, refer to “Serial Port Writers” starting on page
344.

Velocity Main Menu 13

Velocity Version 3.1 Administrator’s Guide

This Folder: Defines:

E-mail Writers How to notify qualified operators and administrators by

E-mail when a specified Velocity alarm occurs.
For more on this, refer to “E-mail Writers” starting on page
348.

XML Writers How and when to send data in XML form to a specified port
or application.
For more on this, refer to “XML Writers” starting on page 360.

Message Queue How to set up a data output compatible with the Microsoft
Writers Windows message queue.
For more on this, refer to “Message Queue Writers” on page
356.

DVR/NVR Configuration and use of one or more DVR or NVR systems

connected to this Velocity network.
For more on this, refer to “DVR / NVR Configuration and
Usage” starting on page 717.

Central Stations Configuration and monitoring of fire alarm systems.

For more on this, refer to “Central Stations” on page 365.
When you select the Interfaces Configuration folder, the Hirsch Trigger Action Manager
appears in the components pane. This feature is explained in “Trigger Action Manager”
starting on page 1187.

Components Window (Components Pane)

The Components pane is located to the right of the System Tree window within the
Administration Main Screen. This window displays elements contained within the file
selected in the System Tree window.
For example, if you select the top-level Configuration folder in the System Tree window,
the Components window displays this arrangement of modules:

This window contains not only all the Velocity modules but also the main Velocity
folders (Velocity Configuration, DIGI*TRAC Configuration, and Interfaces Configuration).
Double click any of the components within this window to open the selected module
or, in the case of the three configuration folders, expand the folder to reveal all relevant
sub-folders.

14 Velocity Main Menu

 MAN006-0612

If you select a lower-level folder, such as Velocity Configuration, from either the System
Tree or Components Window, the Components Window displays the contents of that
folder like this example:

This provides a flat view of the system as opposed to the hierarchical view provided by
the System Tree window.
By expanding the folders within the System Tree window, the elements displayed
within the Components window become more specific, gaining greater granularity.
For example, if you select Holidays from either the System Tree or Components
Window, the Components window displays all holidays currently defined for the
system. In most cases, you will also see a folder at the top of the Components window
entitled Add New... (for example, Add New Holiday). Double click this folder and a
dialog box appears that guides you through the creation of the relevant system
component.

Design Mode
Velocity enables a qualified operator to redesign screens in the Velocity Administration
module. Design mode gives you the ability to:
 resize a screen
 resize fields within a screen
 reposition text describing the fields
To use this mode:
1. Go to the Preferences screen and check the 'Access and Enable Customized
Values for Components in Customization Manager' box on the General page.
2. Make sure the operator in question is a member of a role that has been granted
permission for 'Design Mode - Use'.
3. If not already done, open the Administration module.
4. Open one of the screens within this module, such as Holiday or Credential
Templates properties.
If you open a screen before changing the preferences and permissions required in
Steps 1 - 2, close the screen and reopen it before proceeding to the next step.
5. Click on the icon in the upper left hand corner of the screen, .

Velocity Main Menu 15

Velocity Version 3.1 Administrator’s Guide

In addition to the normal Windows pop-up options, you will see another option at
the bottom of the list like this example:

6. Select Enter Design Mode.

The words [Design Mode] appear in the title bar like this example:

7. To change the position or length of text to the left of an existing field:

a. Click on the text.
Black handles appear around the text like this example:

Reposition text using handles

b. Pull the handles to reposition the text.

8. To resize or reposition a field:
a. Click within the field.

16 Velocity Main Menu

 MAN006-0612

Black handles appear around the field like this example:

Resize or reposition a field

using handles

b. Pull the handles to reposition or resize this field.

In this way, you can accommodate longer or shorter text strings for your specific
security requirements.
9. Continue this process until you have tailored the screen to your requirements.
10. When you're finished, click on the upper left hand icon again.
An option list like this appears:

11. Select Exit Design Mode.

If you have made any changes to the form, a message like this example appears:

12. To confirm your changes, click Yes.

You are returned to the normal mode for this screen.
This method works for the fields, windows, and text that appear on any screen within
the Administration module. To change the text that appears on any of these screens,
refer to Customization Manager.

Velocity Main Menu 17

Velocity Version 3.1 Administrator’s Guide

Velocity Icon Tool Bar

The Velocity icon toolbar looks like this:

A single click on one of these icons opens the associated program.

The most commonly used modules are grouped on the left side of the icon bar:

Opens this This program can also be opened

This icon:
program: through the:

Alarm Viewer main menu bar Console option or by

pressing F8

Event Viewer main menu bar Console option or by

pressing F7

Enrollment Manager main menu bar Console option or by

pressing F3

Graphics main menu bar Console option or by

pressing F6 (Opens Designer in Graphics
mode)

Video Explorer main menu bar Console option

Report Manager main menu bar Console option

Status Viewer main menu bar Console option or by

pressing F9

Less frequently used modules are grouped on the right side of the icon bar:

This This program can also be opened

Opens this program:
icon: through the:

Administration Module main menu bar Console option or by

pressing F2

Customization Manager main menu bar Console option

Badge & Graphics Designer main menu bar Console option

(Opens Designer in Badge mode.)

SQL Database Manager main menu bar Console option

18 Velocity Main Menu

 MAN006-0612

Scheduling Agent main menu bar Console option

CCTV Viewer main menu bar Console option

Who’s Inside main menu bar Console option

Velocity Main Menu 19

Velocity Version 3.1 Administrator’s Guide

Velocity Menu Bar

The Velocity menu (tool) bar is located at the top left of the main menu screen, just
below the Velocity title bar, and looks like this:

It contains four menu items:

File This menu contains these options: Import/Export, Switch

Operator, Restart Operating System, Lock Workstation, Log on
as Different Windows User, and Exit.
For more on this option, refer to “File Options” on page 21.

Console This menu contains options for accessing Velocity programs as well as
the option to set preferences. These programs include: Administration,
Alarm Viewer, Badge & Graphics Designer, CCTV Camera Viewer,
Customization Manager, Video Explorer, Enrollment Manager, Event
Viewer, Graphics, Report Manager, Status Viewer, SQL Manager,
Scheduling Agent, and Who’s Inside.
For more on using these programs, see “Using Velocity Programs”
starting on page 38.
Notice that several of these programs can be started by pressing one
of the function keys along the top of your keyboard. For example, if
you press the F8 key, the Alarm Viewer appears. See “Velocity Hot
Keys” on page 25 for more on this.
The final option shown in this list is the Preferences... option. This
includes setup options for:
• General
• Network
• Alarm Options
• Printers
• CCTV/DVR
For more on this last option, refer to “Setting Velocity Preferences”
starting on page 44.
For more on the Console options, refer to page 21.

Window This menu item enables the operator to move between open Velocity
modules or to change the patterns in which the open modules are
displayed.
For more on the Window options, refer to page 22.

Add-Ins This menu item enables the operator to designate E-mail writers and
server extensions as required by the installation. For more on this,
refer to “Add-Ins Options” on page 23.

Help This menu item provides on-line help topics, the Diagnostic window,
and additional information about Velocity including Velocity registration
information. For more on the Help options, refer to page 22.

20 Velocity Main Menu

 MAN006-0612

File Options

The File option includes these options:

Import/ This option includes these five submenu options:

Export • CCM (Import Only)
• SAM (Import Only)
• Customizations
• Velocity Data Export
• Velocity Data Import
• SNIB2 (Import Only)
For more on the import/export options, see “Import/Export
Wizards” starting on page 381.

Switch Enables you to switch from one operator to another without

Operator... exiting Velocity.
For more on this, refer to “Switching Operators” on page 31.

Restart Select this option to restart the workstation.

Operating This option should only be made available to qualified operators
System since restarting the workstation can result in a loss of current data
{Restart} and make the system vulnerable for the time required to restart.

Lock Return to the Windows log on screen with all open programs still
Workstation running.
For more on this, refer to “Locking Workstations” on page 32.

Log On as Select this option to close Velocity and any other programs that
Different are currently running and return to the Windows log on screen
Windows
User

Exit Exits Velocity.

Velocity Main Menu 21

Velocity Version 3.1 Administrator’s Guide

Console Options
The console options list is accessed from the Velocity main menu bar. It contains a list
of all currently available Velocity programs:

Bring up the programs listed by selecting the program name.

Many of these options can also be activated by pressing a hot key from anywhere
within the Velocity program. Each hot key is displayed to the right of the option. For
example, to open the Event Viewer, press F7 and the Event Viewer appears.
This list also includes the Preferences... option. This important option enables you to
modify or activate components of the Velocity system. You cannot utilize many aspects
of Velocity without first visiting and using this option.
For more on the modules displayed in this list, refer to “Using Velocity Programs”
starting on page 38.
For more on this last option, refer to “Setting Velocity Preferences” starting on page 44.

Window Options
The Velocity menu bar Window option provides one way to bring open Velocity window
to the front.

The standard options above the divider are:

Cascade Arrange open windows in an overlapping pattern from top left to

bottom right, where the last used window is top most, bottom right.

Tile Arrange open windows edge-to-edge in a horizontal line. If enough

Horizontal screen area is available, all windows are completely visible.

Tile Arrange open windows edge-to-edge in a vertical line. If enough

Vertical screen area is available, all windows are completely visible.

Arrange Arrange minimized windows in a vertical array. This is particularly

Icons helpful if windows are behind another window.

Reset to Return window arrangement to the Velocity default. This cancels any
Defaults modifications to the Velocity windows you have made.

22 Velocity Main Menu

 MAN006-0612

Below the divider is a list of windows that are currently opened as MDI child windows.
There is a check mark next to the active window. Select a window from this list to make
it active. This can be done in one of two ways:
 Select the Window option list, then press the number on your keyboard
corresponding to the number that appears before the open window name. For
example, if you want to display the open window designated as 3, press 3 and that
window appears.
 Select the Window option list, then either cursor down to the window you want and
press Enter, or click the window you want. The selected window appears.
The windows that appear in this option list are those set to MDI Child. Modules like
Report Manager, Enrollment Manager, and SQL Database Manager are opened as
parent applications (displayed in the Windows desktop tray) and are not shown in the
Window option list.

Add-Ins Options
When you access the Add-Ins option on the Velocity menu tool bar, you see the
following two options:

This option enables you to:

Add-In This feature enables a qualified operator to augment Velocity's

Manager feature set with new Velocity functions without waiting for
upgrades or patches.

Server This feature brings up the Server Extensions dialog box. Use this to
Extensions configure systems for serial port writer, E-mail writers, DVR reader,
and Central Stations.

Once you have added new features using the Add-In Manager, the Add-Ins option list
increases to include those options, like the following example:

Add-In programs listed as options

In the preceding example, the add-ins External Application Launcher and Velocity
Remote Desktop have been configured. Velocity add-ins are published to the Hirsch
website as they become available from where they can be downloaded and installed
on a Velocity computer. They are also available on DVD or diskette upon request.
For more on these functions, refer to “Add-In Manager” starting on page 406.

Velocity Main Menu 23

Velocity Version 3.1 Administrator’s Guide

Help Options
When you access the Help option list on the Velocity main menu tool bar, you see
these options listed.

These options are:

Help View Velocity's on-line help which is the document you are viewing
Topics now.
For more on this, see “Help Topics” on page 24.

Diagnostic This is an extremely handy tool for diagnosing problems with the
Window system.
For more on the diagnostic window, refer to page 703.
Note: This should only be used for troubleshooting.

Velocity Select this option to open the Velocity Learning Center screen.
Learning This screen provides a portal to a number of Velocity documents,
Center including:
• Release Notes
• Online Help (alternative route)
• System Planning Guide
• Tutorials (alternative route)

Create The Velocity System Report wizard appears. Use this option to create
System a report you can E-mail to Hirsch for further evaluation of a
Report Velocity-related problem. This report lists all relevant aspects of your
Velocity system.
For more on this, refer to “System Report Wizard” on page 1201.

About This dialog box displays information on the current version of

Velocity Velocity including the name of the person possessing the license for
this version of Velocity and the product build number.
From this dialog box, you can press the Register button to register
this version, if needed. For more on registering Velocity, refer to
“Velocity Registration” starting on page 3.
Click OK to return to the main menu.

Help Topics
Once inside Velocity Help, use the Contents, Index, or Search tabs to locate the
specific topic you need.
To display the relevant topic, just double click the entry. There is also a Glossary tab that
provides you with definitions for terms used in the help file.

24 Velocity Main Menu

 MAN006-0612

You can also use the numerous links located throughout the document to jump from
one topic to another as needed.
Notice that topics are arranged in sequences (the yellow window above the web
page), so that you can read about related topics simply by clicking the topic in the
Sequence pane or using the Previous or Next button to arrive at the topic
you want.
If you don’t see this window, refer to the note box on the Velocity hot keys page (page
25).
To navigate to the last screen you displayed, click the Back button, .
In addition, you can jump to related topics using the See Also topics list displayed at
the bottom of most pages.

Velocity Hot Keys

If you're an experienced user, you probably like to keep your hands on the keyboard as
much as possible. Velocity enables you to do this through the use of many function
keys and keyboard combinations. A list of these is shown below.
Open Velocity Programs

Administration F2

Enrollment Manager F3

Browser F4

Graphics F6

Event Viewer F7

Alarm Viewer F8

Status Viewer F9

Of course, the preceding keys only work as long as Velocity is Windows’ current focus.
Exit Screens/Programs

Exit Velocity Alt + F4

Exit Velocity modules Alt + F4 from within:

Enrollment Manager, Report Manager, Graphics
Designer, Customization Manager, SQL Manager,
Scheduling Agent, and CCTV Viewer.
It does not work with Administration, Alarm Viewer,
Event Viewer, and Status Viewer.

Exit a dialog box or Esc from within dialog box or prompt for:
prompt Enrollment Manager, Report Manager, Customization,
Status Viewer, Scheduling Agent, and CCTV Viewer.
It does not work in Administration, Alarm Viewer,
Event Viewer, Graphics Designer, and SQL Manager.

Velocity Main Menu 25

Velocity Version 3.1 Administrator’s Guide

Moving/Manipulating Within a Screen/Program

Move one field forward Tab

Move one field Shift + Tab

backward

Activate a function Enter

Move cursor up Up arrow key

Move cursor down Down arrow key

Move cursor left Left arrow key

Move cursor right Right arrow key

Printing Report

Print the report Ctrl + P

Badge & Graphic Designer contains a separate set of hot keys. For these, see “Designer
Hot Keys” starting on page 449.

Status Line
The bottom line on the main Velocity screen is the status line.

This line contains the following sections:

This Field: Displays:

Current User Current Velocity operator.

Active Alarms Current number of active alarms.

Double click this icon to bring up the Alarm Viewer screen which
provides details about the active alarms. For more on the Alarm
Viewer, refer to “Alarm Viewer” starting on page 417.

Ack Alarms Current number of acknowledged alarms.

Double click this icon to bring up the Alarm Viewer screen which
provides details about the acknowledged alarms. For more on the
Alarm Viewer, refer to “Alarm Viewer” starting on page 417.

Off Normal Current number of off-normal points. This indicates hardware that
has been configured but not yet enabled.
Double click this icon to bring up the Off Normal Points screen. For
more on this, refer to “Off Normal Points” starting on page 27.

26 Velocity Main Menu

 MAN006-0612

Download Monitors downloads as they occur.

Monitor Double click this icon to bring up the Download Monitor screen
which provides details of all downloads occurring at that moment.
For more on this, refer to “Download Monitor” on page 133.

Threat Level This field indicates the current threat level for the system. If
Velocity detects no threat, the level is 00.

Date Current date at this computer.

The default format is month/day/year; however, this defaults to
whichever format you specify in Control Panel (Date & Time).

Time Current time at this computer.

The default format is a 12-hour clock with AM or PM; however, this
defaults to whichever format you specify in Control Panel (Date &
Time).

Off Normal Points

The Off Normal Points dialog box provides a quick list of disabled points.

Two off-normal points

In most cases, off normal points describe two types of activities:

 points associated with a controller, port, input, or expansion input that is temporarily
disabled for maintenance
 points associated with a controller, port, input, or expansion input that has been
programmed off-line and is connected but not yet enabled
In both cases this usually means the 'Enable' checkbox in the device (point) definition
is currently deselected (unchecked).
Each off-normal entry is listed by name, type, and address.

System Icons
The components displayed in both the System Tree and Components windows can
include these icons and the elements they represent:

This indicates:
icon:

Alarm Response

Credential Template

CCTV Port

Velocity Main Menu 27

Velocity Version 3.1 Administrator’s Guide

CCTV Switcher

CCTV or DVR Camera

Command Set

Controller (including the M1N, M2, M8, M16, or MSP)

Dial-Up Location

Door. This door is only enabled when the box to the left is checked. If
unchecked, Velocity considers the door's constituents (input, relay,
keypad, etc.)

Door Group

DVR/NVR Camera

E-mail Writer

Expansion Input (Red = Active, Black = Inactive)

Expansion Relay (Red = Active, Black = Virtual)

Folder. One or more elements of the tree are contained under this
topic.

Function Group

Holiday

Input

Operator

Person Template

Reader

Relay

Role

Serial Port Writer

SNET Port. The physical link between the host PC and the controller
using the serial SNET protocol.

Trigger Action Manager

XBox. The device that enables multiple controllers to communicate

with Velocity using the XNET protocol.

XML Writer

XNET Port. The physical link between the host PC and one or more
controllers through an XBox using the XNET protocol.

Workstation

28 Velocity Main Menu

 MAN006-0612

Navigating Velocity
Navigating Between Modules
Velocity modules are of two types and can be accessed in three different ways:
 One Velocity module, SQL Database Manager, is a separate entity. This program can
be opened from the Windows desktop as well as within Velocity. You can toggle
between open modules by using either the Windows option on the Velocity menu
bar or pressing the Ctrl + Tab key combination.
 Five other Velocity modules—Report Manager, Enrollment Manager, Customization
Manager, Badge & Graphic Designer, and Task Scheduler—can only be opened from
within Velocity. You can toggle between open modules by pressing the Alt + Tab
key combination or by clicking the appropriate icon in the Windows system tray.
You can dock or undock some Velocity modules by right clicking in the window's title
bar. Dockable modules are:
 Administration
 Alarm Viewer
 Event Viewer
 Status Viewer

Using the Mouse and Keyboard

While most of the mouse and keyboard methods in Velocity are the same as most
other MS Windows products, Velocity has a few differences as well.

Mouse Functions
The mouse can be used to move items around the screen or select options from
pop-up menus. In general, these functions are active within Velocity:
Point Move the mouse and the cursor it controls to a word, phrase, icon, link,
or other window function. In many cases, if you hold the mouse over a
link or option for more than three seconds, a short message pops up
telling you what the option or link does.
Click Point your mouse and press the left mouse button. If this is an active
area of the screen, this procedure selects and activates the feature or
program.
Right Click Point the mouse and press the right mouse button. If this is an active
area of the screen, the user will see a pop-up option list displaying one
or more options.
Drag Point and click an item (normally an icon or object) on the desktop.
Then, with the left mouse button held down, pull the selected item to
another part of the screen. Then release the mouse button to leave the
item in the new location. If this is text, the action selects and highlights
the text specified by the dragging motion.

Keyboard Functions
These are functions that use keys on the keyboard to enter information. The keyboard
can also be used to exit windows, activate programs, or perform functions.

Navigating Velocity 29
Velocity Version 3.1 Administrator’s Guide

Some functions that are performed repeatedly utilize the Control (Ctrl) or Alt (Alt) key
in combination with other keys. Newer keyboards also possess a Windows key, which
has a Windows symbol on it. This key is used in combination with several letters to
bring up integrated Windows programs. These key combinations are called hot keys,
shortcut keys, or keyboard shortcuts.
For a complete list of hot keys used in this program, refer to “Velocity Hot Keys” starting
on page 25.
Cursor keys refer to the up, down, left, and right arrow keys normally located on the
number pad portion of your keyboard.

Using Velocity Fields and Tools

Velocity fields differ little from the fields you use throughout MS Windows. A brief
introduction to the fields and tools should help you use them successfully.
A few of the common field types are shown here:

Field Icon Name Description

Radio Button This is a toggle button. It is either selected or

cleared; there is no third choice. To select, click in
the circle and dot appears; to clear it, click again
and the dot disappears.

Check Box Like the radio button, the check box is either
selected or cleared; there is no third option. To
select, click the box and a check mark appears; to
deselect, click again and the check mark
disappears.

Text Type the required text into this field. The length of
the text string depends on the type of information
required. (Frequently, the required size of the string
is specified next to the field.)

Combo Box / Either type in the required value or click the down
Option Box arrow to the right of the box, and a list of possible
options appears. Depending on the type of
information required, you will see all
currently-defined instances of the type displayed. In
lists such as Time Zone options, <Always> and
<Never> are automatically supplied. In addition,
you will often see the <New> option. This indicates
that you can create a new component on-the-fly
from this dialog box without the need to back out
and go to another dialog box before returning to
finish. For example, if you are trying to select a Time
Zone but have not yet defined the one you need,
you can use the <New> option to create a new
time zone that fits your need.

30 Navigating Velocity
 MAN006-0612

Field Icon Name Description

Spin Control This field is used to increment or decrement a

value as required. Use the up spin control button to
increase the value in the box; use the down spin
control button to decrease the value. You can also
type a value directly into the box. With more
complex versions of this field, you can use the Tab
key or mouse to move from one field within the
box to the next, using the spin control buttons to
change each field value as required.

Tool/Button

Slider Bar Use this tool to move a window or list left or right,
up or down. This can be either vertical or horizontal
depending on the type of list. If a list in a window is
longer than the window can accommodate, the
slider will be vertical; if the list is wider than the
window, the slider will be horizontal. Both
horizontal and vertical sliders appear when a list is
both longer and wider than a window can fit.

Button These come in many sizes and shapes. Normally

they are used to bring up another window or dialog
box or, as in the case of this example, to confirm
and store the current values for a dialog box and
return to a previous screen. Position your mouse
over the button then left-click. The OK button can
also be accessed by pressing the Enter key on your
keyboard.

Pop-Up Box The pop-up box is normally activated by the right

mouse button. Right-clicking can bring up a pop-up
box in many places within Velocity. For example, if
you right click on a Velocity module's title bar, the
docking box appears. The option that appears
depends on the field or function closest to the click.

Switching Operators
Use this option to switch between authorized operators without exiting Velocity.
To switch between operators:
1. From the menu tool bar, select File > Switch Operator...
The Switch Operator dialog box appears.

Navigating Velocity 31
Velocity Version 3.1 Administrator’s Guide

2. At the 'User Name' field, enter the name of this operator.

3. At the 'Password' field, enter the password for this operator.
4. If required, at the 'Domain' pick list, select a domain represented by this operator.
This field is normally only used in single workstation installations that are
authenticating against a domain controller. Select either the local computer
workgroup (default) or the windows domain to which the computer belongs.
5. Click OK.
The Velocity screen appropriate to this operator appears. Only those rights and
permissions authorized for this operator appear. If a window is open that is not
permitted for the new operator, it is closed automatically.

Locking Workstations
There are many instances when an operator will need to leave his/her post. While
away, they should secure Velocity by locking the computer.
To lock the Velocity workstation:
 At the Velocity menu bar, select File > Lock Workstation.
The Windows log on screen appears, listing all currently enrolled users of this machine.
All programs currently running, including Velocity, remain running in the background.
 In order to secure your system, you must have a Windows password.
Consult your system or Windows administrator for more on this. A user
without a password is inviting intrusion.
To unlock a locked Velocity workstation:
1. Click the operator name on the log on screen.
A password screen appears.
2. Enter a valid password and click OK.
The Velocity program reappears in exactly the same state as when you locked it.

32 Navigating Velocity
 MAN006-0612

Managing Desktop Space

There are times when Velocity operators will find themselves with multiple Velocity
windows open. Velocity enables an operator to view several windows on the screen at
one time. For example, an operator might be monitoring the Event Viewer, the Alarm
Viewer, and a map-level view of a floor using the Badge & Graphics Designer module
while simultaneously enrolling new employees. This requires that four separate
windows be open at the same time. Even with dual monitors this can become
crowded.
Luckily, Velocity provides the ability to rearrange windows using a number of different
techniques: operators can dock or float multiple windows as well as treat several
windows as child entities within another window or associate specified windows with
specified Velocity modules.

Managing Velocity Windows

Ordinarily, Velocity modules are tied (docked) to the main Velocity screen; however,
this is not always necessary or useful.
To rearrange Velocity windows:
1. Bring up the Velocity module you want to arrange.
 This technique does not apply to dialog boxes or pages within a module,
only to the main screens of certain Velocity modules, including Event
Viewer, Alarm Viewer, Administration, and Status Viewer. This technique
does not work with Enrollment Manager, Graphics, Report Manager,
Customization Manager, SQL Database Manager, or Scheduling Agent.
2. Right click on the module's title bar.
A pop-up option list appears like this:

3. Select the option you want.

The available options are:

Docked Affix to the nearest available corner of the screen on startup.

Modules that can be docked are:
• Administration
• Alarm Viewer
• Event Viewer
• Status Viewer
• Who’s Inside

Floating Allow to move outside the boundaries of the main Velocity

program. This enables operators to drag the module outside the
Velocity window to a free space where it can be easily viewed,
such as to a second monitor (if dual monitors are configured for
this system).

Managing Desktop Space 33

Velocity Version 3.1 Administrator’s Guide

MDI Keep the window inside its current module.

Child For example, if you specify that Alarm Viewer is a child while it is
inside the main Velocity screen, then you cannot move it outside
the Velocity frame. The windows you can set as an MDI child are:
• Administration
• Alarm Viewer
• Event Viewer
• Status Viewer
• Who’s Inside

Docked Specify where the window should be fixed within the Windows
to desktop: top, left, bottom, right. You can specify which corner the
window adheres to using the Docked to... option.

MDI Specify whether the current module should be minimized,

Child as maximized, or restored within the parent window. Attempts to
move it outside the Velocity shell will fail.
• If Minimized, the window appears as an icon within the
main Velocity window.
• If Maximized, the window opens at the largest possible size
within the main Velocity screen.
• If Restored, the window appears at its default size within the
Velocity screen.

 MDI is the abbreviation for Multiple Document Interface.

4. When you release the mouse button over your choice, the window is set.
5. If you selected Docked, select the required docking relationship from the Docked
to list.
If you selected MDI Child, select the required child relationship from the MDI
Child as list.
You can arrange two or more open windows into various patterns using the Window
option on the menu bar. You can also resize Velocity windows as required using normal
MS Windows resizing techniques.

Column Management
One of the most overlooked features of Velocity is column management. This is a
feature built into most Windows products but is frequently not discussed.

34 Managing Desktop Space

 MAN006-0612

Velocity has many screens that contain columns as shown below:

Prime examples of this are:

 Enrollment Manager People tree pane
 Enrollment Manager Credentials pane
 Event Viewer main screen
 Alarm Viewer main screen
 Customization Manager main screen
 Status Viewer main screen
 Who’s Inside screen

Managing Desktop Space 35

Velocity Version 3.1 Administrator’s Guide

Sorting By Column Header

When you have a list in a columnated window, you can sort the list according to any
feature in the column. For example, if we wanted to sort the People Tree List by first
name rather than last name, all we would have to do is click on the First Name column
and the list is automatically reordered like this example:

Notice that the list is now ordered alphabetically A - Z by first name rather than last.
Click the First Name column again and the list inverts: you now see the list sorted Z - A
like this:

You can perform this same ordering trick for any column appearing in the table. For
example, if you want to reorder the list by ID, scroll over to the ID column and click the
ID column header. The list is reordered by ID number.
This provides an easy way to rearrange people, credentials, or any other list element by
a category value without using a search filter.

Rearranging Column Headers

In addition to sorting, Velocity also enables you to move column headers from one
position to another in the following modules:
 Event Viewer
 Alarm Viewer
 Status Viewer
 This feature is not available in the Enrollment Manager, Customization
Manager, or Who’s Inside.
To do this, simply left click on the column header you want to move and drag it to the
new location.

36 Managing Desktop Space

 MAN006-0612

For example, say you want to move the Status column in Status Viewer from its current
position to the left of Address:

To do this, click on the Status column header and drag it to the left until it is on top of
the Address header then drop it. The Status Viewer changes to look like this:

Resizing Columns and Panes

Windows enables you to resize both panes and columns in the same manner. To do
this:
1. Move your mouse pointer to the column or pane border. The pointer icon
changes.
If it rests over the division line between panes, it changes to this:

depending on whether the pane or column is arranged horizontally or vertically.

If it rests over the division line between columns, it changes to this:

2. Click your left mouse button and drag the border in whichever direction you need.
3. Release the mouse button and the column or pane is resized.

Managing Desktop Space 37

Velocity Version 3.1 Administrator’s Guide

Using Velocity Programs

Velocity programs (modules) are accessible in one of three ways:
 With the top-level Configuration folder highlighted in the System Tree pane, Velocity
modules are displayed in the Components pane. Double click the required module
to open it.
 From the Console Options on the main menu bar. Select the required module to
open.
 From the icon bar, click the required icon.

Hint The term Velocity program is used interchangeably with Velocity module in Velocity
Help when referring to the interlinked routines that make up the Velocity suite.

The modules currently available are:

Select this To: Page:

Module:

Velocity Configure the Velocity program. 215

Configuration

DIGI*TRAC Configure hardware comprising the Velocity 55

Configuration system.

Interfaces Configure and use attached CCTV systems, Serial 343

Configuration Port Writer, E-mail Writer, XML Writers, and
attached DVRs.

Add-Ins Learn to operate both the Add-In Manager and 405

the Server Extension features.

Alarm Viewer View and manage alarms as they occur 417

throughout the security system.

Badge & Graphic Design and draw badges for Velocity. 437
Designer The Designer opens in Badge mode.

CCTV Camera Configure and operate a CCTV subsystem 657

Viewer connected to Velocity. This enables you to view
live video from the attached cameras. A CCTV
Camera Viewer option appears in the
Components pane when the top-level
Configuration folder is selected in the System Tree
pane.

Customization Customize the Velocity database and interface for 677

Manager the specific needs of this client.

DVR/NVR Camera Open Video Explorer. 731

Viewer This option appears in the Components pane
when the top-level Configuration folder is selected
in the System Tree pane.

38 Using Velocity Programs

 MAN006-0612

Select this To: Page:

Module:

Enrollment Enroll people (badge and/or code holders) as 761

Manager well as create and assign credentials to those
enrolled people for this security system.

Event Viewer View events as they occur throughout the security 899
system.

Graphics Create map views of security systems throughout 437

the system. Place alarm and relay points on these
maps and administer them directly from the
maps.
Designer opens in Graphics mode.

Report Manager Generate and create reports on system security 1005

and Velocity operations.

SQL Manager Manage the Velocity database. This option links 1087
directly to the SQL 2005 Database Manager. If
you are using the run-time version of SQL 2005,
SQL 2005 Express, the management program is
SQL Server Management Studio Express.

Status Viewer View real-time status of all components 1173

connected to this Velocity system.

Scheduling Agent Schedule housekeeping for the Velocity system 1075

including credential activation/deactivation and
system archiving.

Video Explorer Display Video Explorer for DVR and NVR viewing. 731
The Video Explorer option appears in the
Components pane when the top-level
Configuration folder is selected in the System Tree
pane.

Who's Inside Track the identity of people inside a designated 1215

zone.
In addition, this manual provides these topics to complete your education of Velocity:

Select this To: Page:

Chapter:

Learning Center Read documents on Velocity 3.1. 1001

Updating Update CCM and SNIB2 firmware using either the 711
Firmware CCM Update Wizard or the SNIB2 Update Wizard.

Examples Provide real-world examples of how to use 913

Velocity to perform many tasks.

Import/Export Import and export the Velocity database from one 381
Wizards Velocity workstation to another.

Using Velocity Programs 39

Velocity Version 3.1 Administrator’s Guide

Select this To: Page:

Chapter:

Troubleshooting Troubleshoot problems you might experience with 1197

Velocity.

Worksheets Plan for your Velocity installation and 1221

configuration. These sheets cover almost every
aspect of your Velocity system.
These modules and topics enable you to handle every aspect of security.
The job of setting up the system is handled by the systematically selecting and
configuring the items found in the folders in System Tree pane.
In general:
 To configure security system hardware, refer to “Hardware Configuration” starting on
page 55.
 To set up security features on the system, see “Velocity Configuration” starting on
page 215.
 To set up a fire alarm system, refer to “Central Stations” on page 365.
 To set up CCTV features on the system, refer to “CCTV Configuration” on page 657.
 To set up DVR features on the system, refer to “DVR / NVR Configuration and
Usage” on page 717.
Now that you’ve read the overview, it’s time to starting configuring the system. Proceed
to the next chapter, “Configuration Preliminaries” starting on page 41 to begin.

40 Using Velocity Programs

 MAN006-0612

Configuration
Preliminaries
This chapter prepares you for configuring Velocity 3.1. The configuration process
involves these two general topics:
 Hardware Configuration (starting on page 55)
 Velocity Configuration (starting on page page 215)
The Hardware (DIGI*TRAC) configuration process includes all of those steps that affect
physical devices in your system, such as defining of ports, relays, inputs, and doors. The
Velocity configuration process includes all those steps that involve logical concepts,
such as the defining of time zones, holidays, and operators, as well as the grouping of
these concepts, such as the defining of roles, door groups, command groups, and
master time zones.
While we divide configuration processes into two broad categories, it is not always
easiest or most effective for an administrator to configure a system by going through all
of the hardware configuration procedures then proceeding to configure all of the
Velocity configuration procedures.
You may find that the easiest way to configure a system is to jump back and forth
between hardware and Velocity configuration topics. This chapter should help you
make this decision.
This chapter includes these topics:

Topic See:

How to Configure a System page 42

Setting Velocity Preferences page 44

Getting Started: Basic Configuration page 53

41
Velocity Version 3.1 Administrator’s Guide

How to Configure a System

The following instructions take you through a typical configuration for a normal security
system.
 The following steps assume a basic system. Your system's configuration
may vary depending on its complexity and your security requirements.
To configure a basic system:
1. Start Velocity.
2. Print and complete any worksheets you need to aid you in the following tasks.
See “Worksheets,” starting on page 1221.
3. Set Preferences for the Velocity as described in “Setting Velocity Preferences” on
page 44.
This lets you assign system printers, enable CCTV and Customization Manager, and
configure other peripherals associated with Velocity.
4. Go to the DIGI*TRAC Configuration tree, as described in “DIGI*TRAC Configuration
Folder,” starting on page 11.
5. Determine whether this is an SNET or XNET.
To help you determine this, review the basic definitions in “DIGI*TRAC
Configuration Folder,” starting on page 11, then read “S*NET Systems,” starting on
page 66 and “X*NET Systems,” starting on page 69.
6. Define the Port settings as described in “Ports,” starting on page 59.
7. If this is an XNET system, define the XBox settings. Refer to “XBoxes,” starting on
page 204.
If this an SNET system, skip this step.
8. Define the controller(s) attached to the port or XBox.
Refer to “Controllers,” starting on page 71. If this is a dial-up controller, refer to
“Dial-Up Configuration,” starting on page 135.
9. Define the properties for each device connected to the designated controller(s) in
this order:

For configuring: Refer to:

Doors page 145

Inputs page 178

Relays page 167

Readers & Keypads page 193

Expansion Inputs page 186

Expansion Relays page 172

42 How to Configure a System

 MAN006-0612

10. Go to the Velocity Configuration tree and define these Velocity components:

For configuring: Refer to:

Time Zones page 313

Holidays page 330

Door Groups page 257

Function Groups page 265

Roles page 285

Operators page 275

Credential Templates page 228

Person Templates page 283

11. Enroll people using the Enrollment Manager.

For more on this, refer to “Enrollment Manager,” starting on page 761.
12. Download the modified settings to the designated controllers. Refer to
“Downloading Controller Configurations” on page 75.
13. Define your reports, using “Report Manager,” starting on page 1005.
Of course, there are many other operations Velocity can perform, but these represent
the most basic ones.
For more on basic configuration practices, refer to the Basic and Advanced
Configuration flowcharts starting on page 53.

How to Configure a System 43

Velocity Version 3.1 Administrator’s Guide

Setting Velocity Preferences

When you need to change the way in which Velocity responds, use the Preferences
option. This determines the default values for a whole range of required settings. Many
functions within Velocity depend on enabling or configuring through this screen.
For example, you cannot work with the Badge Designer effectively unless you have
previously defined the default badge printer in the Printers section of the Preferences
dialog box. Similarly, you cannot enroll people using an enrollment station unless you
have previously defined an attached enrollment station through the Enrollment Station
page.
To set preferences for your Velocity server:
1. From the Velocity menu bar, select Console > Preferences...
The Preferences dialog box appears like this example:

2. Make changes and assign values as required.

3. When you're finished, click OK.
You are returned to the main Velocity screen.

Preferences Dialog Box

Use the Preferences dialog box to change initial conditions for a number of features
within Velocity.
There are six tabs available on this dialog box:
 General
 Network
 Alarm Options
 Printers
 CCTV/DVR

44 Setting Velocity Preferences

 MAN006-0612

General Page Preferences

When you click the General tab, a page like this example appears:

The fields on this page are explained below:

Miscellaneous

Show Splash Screen Check this box to indicate that the Velocity splash
screen appears each time Velocity is opened.
The default is checked (enabled).

Access and Enable Check this box to indicate whether Velocity uses
Customized Values for values entered in Customization Manager.
Components in The default is unchecked (disabled).
Customization
If this box is unchecked, all default values for all fields
Manager
throughout Velocity are always used.
Note: Before you can use Customization Manager
effectively, you must check this box.

Use 24-Hour Format Check this box to specify that Velocity uses the
24-hour time format in its viewers. This is the format
favored by the military. For example, 15:12 is
24-hour time format for 3:12 PM. If this box is
unchecked, it assumes that a 12-hour time format is
used.

Automatically Start Check this box to indicate that Velocity should be

Velocity when opened automatically whenever the computer starts.
computer starts By default, this option is unchecked (disabled).

Client Routing Enabled Check this box to enable client routing. When you
enable client routing it allows
the Velocity server to send alarms and events to
specified client machines on the same network.

Setting Velocity Preferences 45

Velocity Version 3.1 Administrator’s Guide

Display Credentials Default

Template: When you activate the right-click Display credential

information option in Graphics or the Display
Credential option in Who's Inside, Alarm Viewer, or
Event Viewer, the badge template you select here is
the one that Velocity uses to display the credential
information. If you select a different template on the
General Doors page, that selection takes precedence
over this selection for that specific door only.
The default is <None>, no badge template is
selected here.
Only those badge templates currently available in
Badge Designer appear in this list. A photo can only
appear if the badge template you select has a photo
placeholder and if a photo was captured or acquired
in Enrollment Manager for the enrollee.

Delay: Indicate the time, in seconds, the credential remains

on the screen before disappearing.
The default is 5 seconds.

Reuse Deleted Codes

When the check boxes in this section remain unselected, it enables qualified
operators to reuse deleted PINs and MATCH codes.

Never reuse PIN codes Select this box to ensure that deleted PINs can never
be reused.
If checked, the box below is activated.

Reuse PINs with When selected, a qualified operator can override the
Operator Override Only 'Never reuse PIN codes' value and reuse this deleted
PIN. For more on this, refer to “General Property
Sheet” on page 865.

Never reuse MATCH Select this box to ensure that deleted MATCH codes
Card Codes can never be reused.
If checked, the box below is activated.

Reuse MATCH with When selected, a qualified operator can override the
Operator Override Only 'Never reuse MATCH Card Codes' value and reuse
this deleted MATCH code. For more on this, refer to
“General Property Sheet” on page 865.

46 Setting Velocity Preferences

 MAN006-0612

Network Preferences
When you click the Network tab, a page like this example appears:

 Most of the time, the default settings Velocity provides do not need to be
changed.
The fields on this page are explained below:

SQL Server Connection

These parameters apply to the connection between Velocity and SQL Server. This
must be correct if Velocity is to communicate properly with its security database.

SQL Server Name From the combo box drop-down list, select the SQL Server
name that applies to the current Velocity database.
This should be the name of the server that has SQL Server
and the Velocity database installed.

Database Enter the name of the Velocity database that SQL Server
points to. Normally this is Velocity.

Network Connection
These parameters define the physical connection that exists between this Velocity
workstation and the network, if one exists.

Port This is the port address used by Velocity workstation to

connect to the database.
The default is 2025.

IP Address Enter the current Velocity server’s computer name.

If the client and server are installed on the same machine,
the name here is the same as the computer name.

Connection This text box specifies the number of seconds that are
Timeout allowed to pass before a Velocity client raises the dialog box
that the connect attempt failed. This can happen when an
initial connection fails while Velocity is started or when a
network break occurs and Velocity attempts to reconnect.
The default is 100 seconds.

Setting Velocity Preferences 47

Velocity Version 3.1 Administrator’s Guide

Alarm Options Preferences

When you click the Alarm Options tab, a page like this example appears:

Alarms

Stack Alarms of Similar Check this box to automatically sort alarms

Types appearing in the Alarm Viewer by Alarm Type.
As indicated by the asterisk, this option is
system-wide. All controllers connected to this
system will stack alarms.

Report Return to Check this box to indicate that Velocity will

Normal Alarms automatically report all Return to Normal (RTN)
conditions. The default is selected, automatic RTN
reporting.
As indicated by the asterisk, this option is
system-wide. All controllers connected to this
system will report all RTN conditions.

Auto Acknowledge of Check this box to automatically acknowledge all

Return to Normal alarms once they return from their alarmed state to
a normal state. The Event Viewer and Alarm Viewer
are both affected by this option.
As indicated by the asterisk, this option is
system-wide. All controllers connected to this
system will auto-acknowledge all Return to Normal
(RTN) conditions.
When left unchecked, the operator must
acknowledge an RTN condition manually. The
default is unchecked.

Require Check this box if you require an operator to

Acknowledgement acknowledge an alarm before it can be cleared.
before Clearing If left unchecked, the operator can clear an alarm
whether it has been acknowledged or not. The
default is checked.

48 Setting Velocity Preferences

 MAN006-0612

Require Entry of Note Check this box to require operators to enter a note
on Acknowledgement whenever they acknowledge an alarm. When the
operator acknowledges an alarm, the Operator
Comments dialog box appears. The operator must
then enter a comment before continuing.
The default is unchecked.

Force New Note for This box is only activated when the previous box is
Multiple also checked. Check this box to require the
Acknowledgement operator to enter a note every time he/she uses
the Acknowledge All feature. When the operator
acknowledges all current unacknowledged alarms,
the Operator Comments dialog box appears. The
operator must then enter a comment before
continuing.
The default is unchecked.

Require Entry of Note Check this box to require operators to enter a note
on Clear whenever they clear an alarm. When the operator
clears an alarm, the Operator Comments dialog box
appears. The operator must then enter a comment
before continuing.
The default is unchecked.

Force New Note for This box is only activated when the previous box is
Multiple Clear also checked. Check this box to require the
operator to enter a note every times he/she uses
the Clear All feature. When the operator clears all
current unacknowledged alarms, the Operator
Comments dialog box appears. The operator must
then enter a comment before continuing.
The default is unchecked.

Repeat Multimedia Check this box to require the Alarm Viewer to

Until Acknowledged replay a WAV file associated with a particular alarm
until that alarm is acknowledged.
In the 'Delay' text box, enter the number of
seconds allowed between the acknowledgement of
an alarm and the end of the multimedia.
The default is unchecked.

Alarm Queueing

Sort Alarms by Alarm Display alarms in the graphics module in order of

Level their alarm level. This means that the level assigned
to a particular alarm in the Customization Manager
affects where an alarm appears in the Graphics
module list.
Alarms can be ordered according to both their
chronology and their alarm level if needed.
The default is unchecked.

Setting Velocity Preferences 49

Velocity Version 3.1 Administrator’s Guide

Display Alarms Oldest Display all alarms in the Graphics module from the
to Most Recent oldest to the most recent. This means that alarms
appearing at the top of the list are the oldest and
the ones at the bottom are the most recent.
The default is selected.

Display Alarms Most Display all alarms in the Graphics module from the
Recent to Oldest most recent to the oldest. This means that alarms
appearing at the top of the list are the most recent
and the ones at the bottom are the oldest.

Printers Preferences
When you click the Printers tab, a page like this example appears:

The fields on this page are explained below:

Report Select a printer from the combo box list that will be used to print
Velocity reports.
Select a printer appropriate to this function such as a laser or
high-speed ink-jet printer. Selecting an inappropriate printer, such
as a badge printer, will cause reports to be previewed ineffectively
and printed incorrectly.
The default is None.

Badge Select a printer from the combo box list that will be used to print
Badges. This must be a dedicated badge printer.
The printer you select here sets the default for Designer (badge
templates) as well. You can override this selection, however,
through the Print Setup tab on Designer's Page Setup dialog box
(see page 441).
Note: You cannot print badge templates from Designer or Enrollment
Manager without first defining a badge printer here.
The default is None.
For more on this, refer to “Overriding Default Printers,” starting on
page 439.

50 Setting Velocity Preferences

 MAN006-0612

Alarm/Event Select a printer from the combo box list that will be used to print
all alarm and event data generated by Velocity.
The default is None.
The printer you select for alarm or log printing must have the
capacity to print line-by-line. For this purpose, you should
purchase a dot-matrix or other line printer. An inkjet or laser
printer uses a whole sheet to print a single line and is therefore
impractical for this purpose.
Once you have selected a printer, specify what this printer will
print by selecting either the 'Print Alarms Only' or 'Print both
Alarms and Events' radio button. If you select the 'Print Alarms
Only' radio button, Velocity and the printer ignore all events and
only prints alarms. This is the default setting.
If you install an Alarm/Event printer, you must set a property in
the Printers settings of Windows before Windows allows you to
print. To do this:
1. From the Windows desktop, select Start > Settings >
Printers. The Printers screen appears with a list of all currently
defined printers.
2. Right click on the line printer you are using as the Alarm/Event
printer and select Properties. The Properties dialog box for
that printer appears.
3. Click on the Advanced tab.
4. Check the “Print directly to the printer” radio button, which will
uncheck the “Spool print documents so program finishes
printer faster” button.
5. Click OK.

CCTV/DVR Preferences
When you click the CCTV/DVR tab, a page like this example appears:

Setting Velocity Preferences 51

Velocity Version 3.1 Administrator’s Guide

The fields on this page are explained below:

CCTV

Video Capture Mode

Enable Off Check this box to enable a dual-monitor configuration to

Screen Capture support CCTV video. The default is checked.

Capture Rate Enter the capture rate for this video feed. The value
determines how often the video is updated.
The default is 100 milliseconds.

Input Type

Input Type Select either Composite or S-Video as the CCTV input type.
Check the connection between the switcher and the
computer.
The default is Composite.

Input Standard

Input Standard Select either NTSC or PAL.

NTSC is the default and the accepted standard throughout
many parts of the world.

Monitor Locking

Use Automatic Check this box to queue automatic camera switches to the
Monitor CCTV Viewer until it is manually unlocked by the operator.
Locking When the operator unlocks the Viewer, the next queued
camera switch occurs. The Viewer then reverts to the locked
state. If there are no queued camera switches, the Viewer
remains in the unlocked state. If an automatic camera switch
(or manual switch from a different workstation) changes the
camera in the Viewer, the Viewer then reverts to the locked
state automatically.

DVR

Enable Check this box to enable the Video Explorer window to pop up
Triggered Video when it is triggered by an alarm or event as specified by the
Explorer 'Optionally launch the Video Explorer...' pick list on the Action
Window page (see page 1191). Only the view group specified by this
pick list is shown in the Video Explorer window (see
“DVR/NVR View Groups” on page 745).
By default this feature is checked and enabled. Disable this
feature to prevent Video Explorer from popping up on clients
where this function is not required, like at badging stations.
This setting is per workstation, not operator or role. The check
box is enabled only if the operator who is logged in has the
role permission to use the Video Explorer; otherwise the check
box is visible but disabled so that the unqualified operator
cannot change its setting.

52 Setting Velocity Preferences

 MAN006-0612

Getting Started: Basic Configuration

This flowchart displays the basic tasks you must perform to configure your Velocity
system.

Getting Started: Basic Configuration 53

Velocity Version 3.1 Administrator’s Guide

Getting Started: Advanced Configuration

This flowchart provides information on performing more advanced configuration tasks.

54 Getting Started: Advanced Configuration

 MAN006-0612

Hardware
Configuration
This chapter introduces you to basic Velocity hardware configuration techniques. The
topics included in this chapter are:

Topics See page:

Ports 59

Controllers 71

Dial-Up Controllers 135

Doors 145

Relays 167

Expansion Relays 172

Inputs 178

Expansion Inputs 186

Readers & Keypads 193

XBoxes 204

SNIB2s 207

Timers 213

55
Velocity Version 3.1 Administrator’s Guide

Introduction
Normally the first step in configuring a Velocity system is defining the nature of the
DIGI*TRAC hardware connected to it. This is done in several stages as illustrated by the
following example:

The components of this system are listed in the System Tree pane under the
DIGI*TRAC Configuration folder which is part of the Administration main window.
An example of the levels within the DIGI*TRAC Configuration folder are shown below:

The top-level system is defined as either

 XNET if an XBox is connected
 SNET if the host is connected directly to the system without going through an XBox
If this is an XNET system, you must define the Port on the computer to which the XBox
is connected, and the Controller(s) to which the XBox is connected. This is done using
the Port configuration dialog boxes.
If this is an SNET system, no XBox is required. You must define the connection between
the Port and Controllers.
The job of defining the controller(s) connected to the host's port is determined by each
controller's configuration. This includes settings for:
 General Definitions (such as name, address, and model)

56 Introduction
 MAN006-0612

 Basic Setup (including timers and duress digits)

 Control Zones
 Passback (including occupancy count and two-person rule)
 Reporting
 Alarm Actions (ACBs)
These properties determine how the controller responds to specific commands, events,
and alarms.
At the lowest level, you must define each of the devices connected to each controller.
These can include:

This Defines:
component:

Port For both XNET and SNET connections, the properties (such as
speed and port type) defining the connection between the
computer and the security system to which it is connected. For
more on this, refer to “Ports” on page 59.

SNET All SCRAMBLE*NET components. This defines a system of one

or more controllers (and their associated devices) connected
directly to the host PC. For more on this, refer to “S*NET
Systems” on page 66.

XNET All X*NET components. This defines a system of one or more

controller (and their associated devices) connect to a host PC
via an XBox. For more on this, refer to “X*NET Systems” on page
69.

Controller For both XNET and SNET, the properties defining this controller.
For more on this, refer to “Controllers” on page 71.

Remote All components connected to the host PC via modem or other

dial-up device. For more on this, refer to “Dial-Up Configuration”
on page 135.

Doors Each door connected to the specified controller. Door definitions

incorporate definitions for a relay, an alarm, and a reader. For
more on this, refer to “Doors” on page 145.

Relays Each output device, such as lock or annunciator, connected to

the specified controller.
Relays are often bundled in Velocity with Doors.
For more on this, refer to “Relays” on page 167.

Expansion Each output device connected to the relay expansion card (e.g.
Relays REB8) installed in the specified controller.
For more on this, refer to “Expansion Relays” on page 172.

Inputs Each input device—mediated by a line module (MELM or

DTLM)—that is connected to the specified controller. Inputs are
often bundled in Velocity with Doors.
For more on this, refer to “Inputs” on page 178.

Introduction 57
Velocity Version 3.1 Administrator’s Guide

This Defines:
component:

Expansion Each input device connected to the alarm expansion card (e.g.
Inputs AEB8) installed in the specified controller. For more on this, refer
to “Expansion Inputs” on page 186.

Readers Each reader connected to the specified controller. These are

often bundled in Velocity with Doors. For more on this, refer to
“Readers & Keypads” on page 193.

XBox If you are using XNET, the properties defined for the XBox
connecting the host PC and one or more controllers. For more
on this, refer to “XBoxes” on page 204.

58 Introduction
 MAN006-0612

Ports
The port is a pathway into and out of the computer. For example, the serial and parallel
ports on a personal computer are external sockets for plugging in communications
lines, modems, printers, and so on.
A Velocity workstation port can connect to the controller(s) in any of these ways:
 directly (via either RS-232 or RS-485 protocol)
 to an XBox which in turn connects to one or more controllers
 to a modem which communicates with another modem connected to either an
XBox or a controller
 to a NET*MUX4 which connects to one or more controllers or an XBox and
controllers
 to a network via an Ethernet port on a Network Interface Card (NIC) installed in the
computer. Through the network, the PC can connect to one or more XBoxes and
associated controllers through a mediating Lantronix LAN device server.
Examples of several possible arrangements is shown in this illustration:

Serial RS-232 or RS-485

SNet
Host PC DIGI*TRAC
Controller

more
Host Net485 RS-485
XNet
Host PC POWERHOST
CANCEL
ALARM
TX NET
RXTX
RX HIRSCH
ELECTRONICS

XBox
DIGI*TRAC DIGI*TRAC
Controller Controller

more
TC/IP
Host PC
Ethernet Network POWER HOST
CANCEL
ALARM
TX NET
RXTX
RX HIRSCH
ELECTRONICS

LAN Server XBox

DIGI*TRAC
Controller

more
S
e
r
i
al
Host PC Modem Modem
POWERHOST
CANCEL
ALARM
TX NET
RXTX
RX HIRSCH
ELECTRONICS

RS-232 or
X
B
o
x

DIGI*TRAC
Controller

You can specify which of these connections the PC uses by selecting the appropriate
port type on the Port Configuration dialog box.
In the illustration above, the first system is an SNET system. The other three are all
variations of the XNET system, since they incorporate an XBox. Of course, SNET
systems can be considerably more complicated than the first example.
Several rules that must be observed when using Velocity are:

Ports 59
Velocity Version 3.1 Administrator’s Guide

 Velocity does not support more than one XBox per COM port
 Each port cannot support above 16 controllers without the addition of a NET*MUX4
to the configuration.
With the new SNIB2, higher speeds, greater encryption, and Ethernet connectivity are
possible as shown in this example:
RS-485 Additional
SNIB2 Controllers

Ethernet
SNIB2
Ethernet

Host
DIGI*TRAC DIGI*TRAC
Controller Controller

RS-485 Additional
Controllers
SNIB2
SNIB2
Ethernet

Additional DIGI*TRAC DIGI*TRAC

Ethernet Controller
SNIB2s Controller

Windows enables Velocity 3.1 to support up to 9999 ports with up to 63 controllers

per port. Obviously, most PCs don't have anywhere near this capacity: the average PC
accommodates 2 serial ports, 1 parallel port, and one or more USB ports. Using native
USB ports and connected USB hubs, you can create even more serial connections.
For more on this, refer to the Velocity Installation Guide in the Browser.

Adding Ports
To add a port:
1. At the System Tree window, click and expand the DIGI*TRAC Configuration system
folder, .
Two port options are currently available: SNET or XNET.
(A third port option, CCTV Port, is also available, but is not part of this discussion.)
2. Select the port option you need by either double clicking on the option in the
Components window or expanding and clicking on the DIGI*TRAC Configuration
branch in the System Tree window.
The Add New Port option appears in the Components window.
3. Depending on which choice you require, double click either Add New SNET Port
or Add New XNET Port in the Components window.
The Port Properties dialog box appears.
4. In the 'Name' field, enter a new port name.
5. Accept the option in the 'Network Type' combo box.
6. Click either the 'Serial Port' or 'TCP/IP' radio box.
• Select Serial Port if the connection to the system is through one of the serial
COM ports on your workstation. The Port Settings section appears. Go to Step
7.
• Select TCP/IP if the connection to the system is through the Ethernet port on
your workstation's NIC. The Network Settings section appears. Go to Step 8.
7. If you selected Serial Port, perform these tasks:

60 Ports
 MAN006-0612

a. At the 'Baud Rate' field, select the appropriate speed. Your choices are either
9600 or 19,200 for S*NET or 9600, 19200, or 38400 for X*NET.
In most cases, use 9600 for S*NET and 38400 for X*NET.
 Port setting above 19200 for SNET and 38400 for XNET are for SNIB2
use only.
b. At the 'Port' field, select an appropriate option. If you select TCP/IP, the Network
Settings section is activated.
8. If you select TCP/IP, perform one of these tasks:
Device Server If this port is connected via Ethernet to a device server, such as Lantronix or Digi
SP1, follow this steps:
a. At the ‘IP Address’ field, enter the proper IP address for the device server
connected to this Velocity PC.
b. At the 'IP Port' field, enter the correct port number for this device server’s IP
port.
All network ports possess an address used to identify the device server's
physical port address.
c. If needed, at the 'Subnet mask' field, enter a subnet mask value indicating the
subnet on which this port resides.
d. If needed, at the 'Default gateway' field, enter the default gateway value
indicating the gateway where this port resides.
 Consult your system administrator for the correct network values.
e. At the 'Max retry attempts' field, specify the maximum number of retries this PC
will attempt. Increment or decrement the value using the counter buttons.
SNIB2 If this port is connected via Ethernet to a SNIB2, follow these steps:
a. Check the XNET 2 Protocol checkbox.
This only appears if you have selected XNET Port.
b. Click the Search button.
Velocity searches for available SNIB2s and displays them in the Searching dialog
box like this example:

Drag the slide bar over to

New SNIB2 detected
the right to see the MAC
Address column. While a
Existing SNIB2s
newly detected SNIB2
does not have an
assigned IP address, it
always should have a
unique MAC address.

c. From the port list, double click the SNIB2 entry you want to configure.

Ports 61
Velocity Version 3.1 Administrator’s Guide

The SNIB2 Configuration dialog box appears.

d. At the 'Name' field, enter the name for this port.

e. At the 'IP Address' field, specify the correct IP address for this PC port.
f. At the 'Port' field, enter the correct port number for this IP port.
All network ports possess an address used to identify the SNIB2’s physical port
address. The default Velocity port is 10001.
g. If needed, at the 'Subnet mask' field, enter a subnet mask value indicating the
subnet on which this port resides.
h. If needed, at the 'Default gateway' field, enter the default gateway value
indicating the gateway where this port resides.
 Consult your system administrator for the correct network values.
i. Click OK.
The Port Properties screen reappears with the Name, IP Address, and IP Port
fields populated.
j. Click OK.
k. At the 'Max retry attempts' field, specify the maximum number of retries this PC
will attempt. Increment or decrement the value using the counter buttons.
If you get port errors, increase this number.
9. Check the 'Enable this Port' box if this port is currently active.
Clear this box if the port is not currently active.
10. If required, click the Advanced button to access the Advanced Settings dialog box
to specify additional options for this port.
11. When you're finished, click OK.

Modifying Ports
To modify an existing port:
1. In the System Tree window, expand or contract the system tree until you can see
the port you need to modify.
2. Do one of these:
• In the system tree pane, right click on the port you want to modify. A pop-up
option list appears. Go to Step 3.
• From the Components window, double click on the port you want to modify.
Got to Step 4.
3. Select Properties.
The Port Configuration dialog box appears.
4. Make changes to the fields as required.
5. If needed, click the Advanced button to specify Advanced Port Settings for this
port.

62 Ports
 MAN006-0612

6. Review or change these settings as required.

For more on this, refer to “Advanced Port Settings” on page 66.
7. When you're finished, click OK.

Port Properties Dialog Box

All fields on this page are explained here.

Name Enter a name for this port. This can be any alphanumeric characters
up to 32 characters long.
Note: If you try to use more than 32 characters, Velocity displays an error
message and reverts to the previously saved name.

Network Type

Serial Port Click this radio button to indicate that the host PC is connected to
the system through one of its serial (COM) ports. The dialog box
displays the port settings properties for that configuration as shown
in this example:

If no COM port is currently available, an error message appears

indicating this. You are defaulted to TCP/IP.

TCP/IP Click this radio button to indicate that the host PC is connected to
the system through its network connection. If this PC possesses a
network interface card (NIC) and the computer is connected to the
security system through this card, then select this option. When
chosen, the Network Settings section is activated.
The dialog box displays the network settings relevant to this
configuration as shown in this example:

Ports 63
Velocity Version 3.1 Administrator’s Guide

XNET 2 Check this box to indicate that the host PC uses only encrypted
protocol X*NET 2 protocol to communicate with the master SNIB2. The
Search button in the 'Network Type' section is activated.
Currently, this checkbox is only available when you are configuring
an XNET port is selected and the master SNIB2 is connected to the
host via Ethernet.
Only the SNIB2 supports this protocol. The original X*NET protocol is
unencrypted.

Reset The Reset Encryption check box is enabled for X*NET 2 ports. New
Encryption X*NET 2 systems have this check box active and checked by default.
If you swap out master SNIB2s or reassign master SNIB2 status to
another SNIB2, the encryption key changes and data sent to the
host becomes unreadable. To overcome this problem, check this
box to reset encryption. Velocity will uncheck this box once polling
commences.

Port Settings (for serial port only)

Baud rate If you specified the Modem or XNet option, this field is active. Pick
a baud rate from the drop-down list. Your options are:
• 2400 baud
• 9600 baud
• 19,200 baud
• 38,400 baud (SNIB2 only)
• 57,600 baud (SNIB2 only)
• 115,200 baud (SNIB2 only)
For Ethernet connections with SNIB2-installed controllers, Velocity
recognizes only XNET port configurations.
The default baud rate is 9600 for S*NET and 38,400 for X*NET.

Port From the combo box pick list, select the serial port on the
computer connected to the Velocity system.
The port values are in the form:
\\workstation\COMx
where workstation is the name for a specific computer and x is the
number of the port on that workstation to which the Velocity
system is connected, such as \\VELOCITYSERVER\COM1. This
enables you to identify which ports are located on which
networked computers. Default is COM1.

Network Settings (for TCP/IP only)

IP Address Enter the IP Address for the device server (such as the Lantronix
UDS-10) connected to this Velocity PC.

64 Ports
 MAN006-0612

Search Click this button to open the Searching dialog box and detect all
currently available SNIB2s.
This button is only active when you are configuring an XNET port
and you have checked the XNET 2 protocol box. For more on this,
refer to “Adding Ports” on page 60.

IP Port Enter the port number for the device server's IP port. All network
ports possess an address used to identify the device server's
physical port address.
• If you are using a Lantronix UDS-10 or UDS100 device server,
set the port value to 10001.
• If you are using the Lantronix MSS100 device server, set the port
value to 3001.
• If you are using the Digi One SP or Digi PortServer TS16, set the
port value to 2001.
The default value is 10001.

Subnet Enter a subnet mask value indicating the subnet on which this port
Mask resides.

Default Enter the default gateway value indicating the default gateway on
Gateway which this port resides.

Max retry Either enter a number or use the up and down buttons to indicate
attempts the number of retries this computer will attempt between it and
the XBox before it times out and stops trying.

Advanced Click this button to bring up the Advanced Settings for Port
Configuration dialog box.
For more on this, refer to “Advanced Port Settings” on page 66.

Enable this Check this box to indicate the port is currently active.
Port When cleared, it indicates the port is not currently active.

Ports 65
Velocity Version 3.1 Administrator’s Guide

Advanced Port Settings

When you click the Advanced button on the Port Configuration dialog box or the
Dialup Location dialog box, the Advanced Port Settings dialog box appears.

Don't change these settings unless you are a trained network

administrator.
The various advanced timeout settings displayed here determine the behavior of the
low-level polling engine. These are made available to fine-tune customer networks, if
the need arises.

Total timeout Specifies the multiplier, in milliseconds, used to calculate the

multiplier total time-out period for read operations.
The default value is 1 ms.

Total timeout Specifies the constant, in milliseconds, used to calculate the

constant total time-out period for read operations.
The default value is 50 ms.
If you begin to get timeout lines in the Event Viewer, try
increasing or decreasing this value until the timeouts cease.
If you have a lease-line configuration, increase this value from
the default of 50 to 400 ms.

Interval Specifies the maximum time, in milliseconds, allowed to elapse

timeout between the arrival of two characters on the communications
line.
The default value is 2 ms.

The defaults provided above represent Hirsch's best estimates based on feedback from
testing. Serial connections should be reliable at the current defaults; however, IP port
performance/reliability can be influenced by such factors as network speed, network
traffic, the number of available routers/hubs, terminal server settings, and so on.
Therefore, there might not be a single optimal setting for IP Ports.

S*NET Systems
A SCRAMBLE*NET system (S*NET) is Hirsch's proprietary security system that does
NOT include an XBox in its connection scheme. While an S*NET does not provide as
many variations or support as many controllers as an X*NET system, it is still capable of
supporting a large number of controllers through these devices:
 DigiBoard serial multiplier boards
 NET*MUX multiplexors
 NET*ADAPT communications adaptors (NA1)
 USB ports and hubs through USB-to-RS232 adaptors

Several examples of S*NET are shown in the following example.

66 Ports
 MAN006-0612

Ports 67
Velocity Version 3.1 Administrator’s Guide

You can connect up to 64 controllers to a single host using only S*NET.

You can also use an S*NET system through a network via a device server, as shown in
the following example:

The essential addition to create this network is the device server. For more on this, refer
to the next section.

Device Servers
Device servers are devices used for serial-to-Ethernet connections. They provide serial
ports—RS-232/RS-422/RS-485 ports using DB-25 connectors or USB ports using USB
connectors—for attaching terminals or PCs on one end and RJ-45 ports for connecting
to Ethernet networks. They are the latest intermediary devices provided for this
purpose. Through the use of serial to USB adaptors, you can also connect USB ports to
a device server, and from there connect to an Ethernet cable.
Terminal Servers
In the 1980's and 1990's, terminal servers became a popular way to connect serial
devices to a network for accessing multi-user host systems. In a terminal server design,
serial devices were physically connected to terminal server ports. The terminal server
itself governed protocol use, and the availability of added features such as multiple

68 Ports
 MAN006-0612

connection support from a single port or dedicated connections to a single system on

power-up. TCP/IP was the protocol of choice for this type of configuration because it
allowed more efficient communications over both the local network (Intranet) and the
Internet.

The primary function of terminal servers was to give terminal users access to network
devices. Connecting network devices to remote serial ports became another popular
use. Printers, modems, converters and other task-specific devices could be attached to
server ports, and these ports could then be accessed from network hosts.
Device Server Technology
Integrated circuit designs have made it possible to shrink the size of terminal servers.
Taking their place are the new single-port device servers, which are both cheaper and
smaller.
You can now attach the serial port of a device to a single-port server and immediately
have network access to that device. Simply install the device server on the nearby
network, attach it to the serial port of the device, and manage the device from
anywhere within the corporate or campus network (Intranet) or from the Internet.

The device servers used currently by Velocity to perform serial connection to the
Internet and intranets is the Lantronix UDS-10.

X*NET Systems
From Velocity's point of view, all systems using an XBox as one of their components is
considered to be an X*NET system.
Technically, only the part of the connection going from the workstation to the XBox is
using X*NET; the connection from the XBox to the controller is still S*NET. However, the
Velocity workstation must talk X*NET in order to communicate with the XBox.
The XBox then translates X*NET to S*NET for communication with the controllers.
The SNIB2 incorporates XBox functionality and can substitute for an XBox in a system.
In this configuration, the SNIB2 communicates with the host using an encrypted form
of X*NET called X*NET 2. This design is preferable for installations requiring
high-security. For more on this, refer to “Adding Ports” on page 60.

Ports 69
Velocity Version 3.1 Administrator’s Guide

An illustration of these two configurations is shown below:

For more on XBox configurations, refer to “XBoxes” on page 204.

70 Ports
 MAN006-0612

Controllers
Controllers, also called panels, are responsible for collecting input signals from and
distributing output signals to all connected devices.
As shown in the above illustration, the controller is the hub of the security control and
monitoring system.
Hirsch currently provides these controllers:

Feature M1N M2 M8 M16 MSP-8R M64

Door Relays 1 2 8 0 0 0
(Supervised)

Door Relays 0 2 0 0 0 0
(Unsupervised)

Base Expansion Relays 0 0 0 0 8 64

Max. Expansion Relays 0 32 32 32 32 64

Base Line Module 1 2 8 16 0 0

Inputs

Max. General Purpose 3 32 32 32 32

Line Module Inputs

Max. Line Module 4 34 40 32 32

Inputs (Door/General
Purpose)

Base Alarm Relays 3 1 4 1 4 4

ScramblePad/Reader 1 2 8 2 1 1
Terminals

Max. Expansion Boards 0 5 5 5 5 4

Base Users 4K 4K 4K 4K 4K 4K

Max. Users 4K 132K 132K 132K 132K 132K

 Unused door relays can be reconfigured to serve as control relays. 'Base'

is used here to indicate what is included within the controller (excluding
expansion cards) for the models shown. Maximum refers to the sum of
what is available in the base model plus what can be added with
expansion boards.
All controllers possess internal 115/230 VAC power supplies, relays status LEDs, and
the command/control module (CCM).
The operator must configure each controller before Velocity can manage it.

Controllers 71
Velocity Version 3.1 Administrator’s Guide

Adding Controllers
To add a controller:
1. From the System Tree window, click to highlight the Port icon.
• If this is an SNET port, the icon looks like this: .
• If this is an XNET port, the icon looks like this:
The Add New Controller option appears in the Components window.
2. Double click Add New Controller.
The Add New Controller dialog box appears. For more on this dialog box, refer to
“New Controller Dialog Box” on page 74.
3. Enter a name for this controller.
4. Optionally, enter a brief description of this controller.
5. Select an address for this controller. Either choose from the available options (1 -
63), or select <Next Available> which automatically assigns this controller the
next available address.
 This value must agree with the SNIB address specified for the physical
controller.
6. Select the model of the controller from the Model option box. Select M1, M2, M8,
M16, or MSP.
7. From the 'Time Zone Controller is located in:' option field, select the time zone
where this controller is currently located.
8. Click either the Use Database Default Setups or Load Setups from
Controller radio button.
• If you select Use Database Default Setups, it downloads the Velocity
default settings to the current controller.
• If you select Load Setups from Controller, Velocity uploads setups and
database information from the controller's memory into the Velocity database.
9. Click the 'Installed' checkbox if this controller is currently connected and operating.
Leave this checkbox empty if the controller is not currently connected to the
Velocity server.
10. Click OK. The newly created controller appears with its icon, , in the System
Tree window like the following example:

11. To customize the controller, proceed to “Configuring Controllers” in the next

section.

72 Controllers
 MAN006-0612

Configuring Controllers
The controller is the configuration level between the port and the security devices. It
mediates signals sent by system devices—such as locks, alarms, detectors, cameras,
and relays—and controls traffic between the host PC with this information.
During the controller configuration, you define most of the characteristics of the system
at the physical level.
Controllers can be configured in one of three ways:
 Configure the controller, all connections, and all user settings from scratch
 Download all current controller settings from the controller itself
 Download current controller settings then add/edit the settings as required

Configuration of the controller is usually done in stages:

1. Define the controller using the New Controller dialog box.
For more on the New Controller dialog box, refer to “New Controller Dialog Box”
starting on page 74.
2. When you've finished defining the controller, customize the settings through the
Controller Properties dialog box.
• Define or change the basic information about the controller, such as name,
description, time zone information, and controller address using the General
page starting on page 86.
• Designate basic settings for this controller, such as code tamper timers, duress
enable, keypad programming options, etc. using the Setup Page starting on
page 88.
• Define reporting functions using the Reporting page starting on page 95.
• Define passback functions using the Passback page starting on page 99.
• Define control zones associated with this controller using the Control Zones
page starting on page 86.
• Define alarm actions associated with this controller using the Alarm Actions
page starting on page 86.
• Define encryption keys, network password codes, or SNET timeout using the
Communications page starting on page 86.
3. Click OK to confirm your modifications.
4. Download the new settings to the controller.
Not all of the fields on all of the controller configuration pages must be supplied with
values. Ascertain which settings are correct for this controller.
There are a number of operations you can perform on existing controllers, each of
which is discussed in the following sections:
 “Downloading Controller Configurations” on page 75
 “Uploading Controller Setups to Velocity” on page 77
 “Exporting Controller Configurations” on page 78
 “Duplicating Controllers” on page 80
 “Renaming Controllers” on page 80
 “Deleting Controllers” on page 80
 “Moving Controllers” on page 80
 “Importing Controllers” on page 81
 “Modifying Controllers” on page 85

Controllers 73
Velocity Version 3.1 Administrator’s Guide

New Controller Dialog Box

This is the initial dialog box when you select either the Add New Controller or
Duplicate option.
It looks like this example:

These options are available:

Basic Controller Information

Name Type in a short name for this controller, such as Controller 1 or

Front Lobby. The more descriptive you can be the better it is.

Description Type in a short description of this controller. Again, the more

specific you can be here, the easier it is to identify the location and
purpose of this controller.

Address From the drop-down option list, select the value that describes the
address you want to assign to this controller. Your options are: 1 -
63 or <Next Available>.
If you select <Next Available>, Velocity automatically selects the
next available address for you. For example, if you have already
defined four controllers then the next one you add would be
automatically assigned the address 5.

74 Controllers
 MAN006-0612

Model From the drop-down option list, select the Hirsch controller model
that describes this controller. The number of doors, readers, inputs,
outputs, and other devices available to this controller depends on
which model you enter.
• M1N has 1 door, but can be unbundled to inputs and relays, if
required
• M2 has 2 doors initially assigned to it, though these can be
changed later to inputs and relays, if required
• M8 has 8 doors initially assigned to it though these also can be
changed to inputs and relays as required
• M16 has no doors but up to 16 inputs
• MSP includes two models: MSP-8R has no assigned doors but
up to 8 relays and 32 inputs; MSP-64R has no assigned doors
but up to 64 base relays and 32 inputs
For more on this topic, see “Controllers” starting on page 71.
Depending on which model you select, the Components Window
reflects the number of doors and/or inputs and relays supported.
If you are duplicating a controller, this option is grayed out.
For more on using doors, see “Doors: How to Configure” starting
on page 145.

Time zone From the drop-down option list, select the time zone where this
controller is controller is currently located. All times are standardized using GMT
located in: (Greenwich Mean Time).
The default is Pacific Time Zone.

Enable Check this box if the controller is currently connected and

operating.
Clear this box if the controller is not yet connected. This box is
checked by default.

Controller Initialization Method – select one of these radio buttons to indicate how
the controller is set up and initialized

Use Check this radio button to download the default setups stored in
Database the database to this controller. At the next opportunity, the
Default workstation downloads all current defaults to the controller.
Setups If you are duplicating a controller, this option is grayed out.

Load Setups Check this radio button to upload all setups currently defined in
from this controller's memory to Velocity. For more on this, refer to
Controller Downloading Controller Information.
If you are duplicating a controller, this option is grayed out.

Downloading Controller Configurations

Velocity automatically sends information to its attached controllers. Whenever you
change the properties of a controller or modify a Velocity configuration value, that
change is queued for download to all affected controllers.

Controllers 75
Velocity Version 3.1 Administrator’s Guide

Velocity normally downloads information to a controller once you click OK on the

Controller Properties dialog box. Any settings that were changed on the property pages
during that session are sent to the designated controller unless the controller/server is
off-line, in which case the download is queued for later delivery.
You can force an immediate download by right clicking an existing controller from the
System Tree Window and selecting the Download option.
Use this download mechanism to update controller configuration with four different
options:
 Download DIGI*TRAC configuration device definitions (controller, readers, doors,
inputs, and outputs), select Configuration. This downloads everything except
date/time and credentials. This option downloads all settings referring to this
controller whether they were changed or not. All old information is overwritten with
new information.
 Download Velocity user database information, select Credentials.
 Download the date and time, select Date/Time. There is no way to set the
Date/Time for all controllers at once. Each controller must be reset individually. This
can also be accomplished through the Task Scheduler.
 Force a controller to forgive all users by selecting the Download > Forgive Users
right click option. This is normally used after an emergency exit or entry. For more
on this, refer “Forgiving Users” starting on page 891.
 While Velocity downloads data to all of its attached servers each time
Velocity is started, this procedure forces an immediate download of
information to a specified server. This is helpful if you have just changed
controller settings and want these changes to take effect immediately.
To download information from the Velocity database to an attached
controller:
1. At the system tree pane, expand the tree until the controller you need appears.
2. Right click on the controller whose information you want to download.
A short option list pops up.
3. Select Download.
A sublist appears.
4. Depending on your requirements select one of the options:

Choose this: If you need to:

Configuration download DIGI*TRAC Configuration device definitions

(controller, readers, doors, inputs, and outputs).
This option downloads all settings referring to this
controller whether they were changed recently or not. Old
information stored on the controller is overwritten with
this new information.

Credentials download Velocity user database information.

Date/Time download the date and time. For more on this, refer to
“Download Monitor” on page 133.

76 Controllers
 MAN006-0612

Forgive Users Forgive all users on this controller.

This is used after an emergency exit or entry is effected
and when passback is enabled. If there is an emergency
and people exit without using their code or card, only the
crash bars, the system will not let them back in without a
passback violation. After this occurs, a Forgive Users resets
their passback status so they can re-enter without
consequences.
For more on this, refer to “Forgiving Users” on page 891.
Also, refer to “Who's Inside: Forgiving Credentials” on page
1219.

Downloading Time Zones and Holidays

Time Zones get downloaded only when they are actually used by a function in the
controller. For example, when Time Zone 4 is applied to a door or an input or is used
by a door group with a credential.
Daylight savings gets downloaded for the current year only. Time and date is
maintained by the Windows control panel. Holidays are downloaded immediately.

Downloading Persons and Credentials

Downloading a person's card and/or code information occurs every time you click OK
after accessing the credential dialog box in Enrollment Manager. Any information that
has been added to or modified from the credential is downloaded to all relevant
controllers. There are right-click options for forcing credential downloads from
Enrollment Manager's credential pane. For more on this, refer to “Downloading
Credentials” on page 807 or “Downloading Multiple Credentials” on page 808.
If the host PC or an attached controller is off-line when you add/change/delete the
person or the person's credential, the modified data is stored in the SQL database until
the server is back on-line; then it is downloaded.

Uploading Controller Setups to Velocity

The Velocity system includes considerable redundancy. If, for some reason, Velocity's
central database becomes corrupted, it can be largely rebuilt by transferring settings
from the memory of all attached controllers using the controller upload feature.
 This following process uploads setups but no credentials.
To upload information from an existing controller:
1. At the system tree pane, expand the tree to reveal the controller from which you
need to upload database information.
2. Right click on the controller whose information you want to upload. An option list
pops up.
3. Select the Upload Setups.
The information in the controller is uploaded to the Velocity database.
A more drastic technique for uploading information is shown with this method:
1. At the system tree pane, expand the tree to reveal the controller from which you
need to upload database information.

Controllers 77
Velocity Version 3.1 Administrator’s Guide

2. Double click the controller to access the Controller General property sheet.
3. Record the vital information for this controller including the current address of this
controller, since you will be reusing this address.
4. Exit the controller's general property sheet.
5. Delete this controller by right clicking on it and selecting Delete. Y
You are prompted to confirm the deletion.
6. Click Yes to confirm your selection. The controller is deleted.
7. Redefine the controller.
The Add New Controller dialog box appears. For more on this dialog box, refer to
“New Controller Dialog Box” on page 74.
8. At the ‘Address’ combo box, select the previous address of this controller. This is
the address you wrote down in Step 3.
Since the controller's SNIB address won't have changed, a connection between
Velocity and this controller is assured.
9. Select the ‘Load Setups from Controller’ radio button.
10. When you're finished with this dialog box, click OK and the uploads proceeds.
11. Repeat Steps 1 – 10 for each controller you need to upload.
 The time it takes to upload information from a controller to Velocity is
dictated by the number of setups and people associated with the
controller. The more of both there are, the longer it takes to complete the
upload.

Uploading Controller Configurations

Controllers can also upload controller information to the server during initial definition.
This is required, for example, when you have connected Velocity to a controller that
already has a full set of settings.
To transfer the settings from the controller to the current Velocity server, select the
Load Setups from Controller radio button on the New Controller Properties dialog
box. Once you click OK, Velocity begins uploading all available settings.
For more on this, refer to “Adding Controllers” on page 72.

Exporting Controller Configurations

To download current default settings to a new controller (or delete all current settings
from the specified controller and replace it with default settings), click the 'Use
Database Default Setups' radio button on the same New Controller Properties dialog
box.
Exporting the current controller configuration enables you to
 back up controller configurations to a secure environment: In the event that a
controller loses its configuration information (through infection, corruption, or
accidental power outage), the backup copy can restore the pre-crash configuration.
 duplicate a configuration in order to replicate it on other controllers: For example, an
installer needs to create the same controller configuration on a number of different
systems that are separated from each other. By exporting the model configuration
to a CD, DVD, or removable hard drive, the installer can then take the backup copy
to the remote location and import that controller configuration onto one or more of
the target controllers.

78 Controllers
 MAN006-0612

To export the controller configuration:

1. From the system tree pane, expand the DIGI*TRAC folder until the Controller
element is revealed.
2. Right click on the controller from which you want to export a configuration.
An option list appears.
3. Select Export Configuration.
The Velocity Configuration Export Wizard appears like this example:

4. Click Next.
The Choose a Destination screen appears.
5. Select a file name or accept the default name with default path: C:\Program
Files\Hirsch Electronics\Velocity\Controller.
To select a new file and/or path name, click the browse button to the right of the
field, .
6. Click Next.
If this is a new file, the wizard asks you if you want the program to create the new
file name. Click Yes.
The Completing the Controller Export Wizard screen appears.
7. Click Finish.
The Configuration Export Results dialog box appears.

If the export was successful, the Configuration Export Results dialog box reports
“Controller Configuration Successfully Exported.”
8. Click OK.
Once you have exported this file to another location, you can copy it to a CD, DVD, or
floppy disk, if needed, and use it to import configuration data to another Velocity
workstation using the Import New Controller function.

Controllers 79
Velocity Version 3.1 Administrator’s Guide

Duplicating Controllers
Many controllers within a system will share configuration values. The task of defining
such labor-intensive parameters as Control Zones and multiple timers is best when
done as infrequently as possible. By duplicating a controller, you can copy work already
done, then change only those values that need to be changed once the controller is
created.
To duplicate an existing controller:
1. At the System Tree pane, expand the DIGI*TRAC Configuration folder until the
controller you want to copy appears.
2. Right click the controller you want to copy.
A pop-up option list appears.
3. Select Duplicate.
The New Controller Properties dialog box appears.
4. Supply the values required, such as a new name and description, then click OK.
The duplicate controller appears as a new branch of either the XBox or SNET port.
5. Rename the controller as required.
This procedure is often used to create and test a configuration before moving the new
controller to another location.

Renaming Controllers
To rename a controller on your system:
1. Expand the DIGI*TRAC Configuration folder until the controller appears.
2. Right click on the controller you need to delete.
A list of options pops up.
3. Select Rename.
The Controller name is highlighted as a text box.
4. Enter a new name for this controller.
The controller you selected is renamed.

Deleting Controllers
To delete a controller from your system:
1. Expand the DIGI*TRAC Configuration folder until the controller appears.
2. Right click on the controller you need to delete.
A list of options pops up.
3. Select Delete.
The controller you selected is deleted from the system.

Moving Controllers
Velocity enables the qualified operator to move a controller from one port to another
within the system tree structure.
For example, you can define a controller for one SNET port then move it to another
SNET port. You can even move a controller between XNET XBoxes and SNET ports, as
required.

80 Controllers
 MAN006-0612

This process is useful when you want to duplicate an existing controller, with all its
currently defined parameters, and move that copy to another port, ready to use.
To move a controller between ports on the system:
1. At the System Tree pane, expand the DIGI*TRAC Configuration folder until the
controller you want to move appears.
2. Right click the controller you want to move and select Properties.
The Controller Properties General page appears.
3. Deselect the ‘Enable’ box.
You cannot move a controller while it is still enabled or an error message appears.
4. Once the controller is disabled, left click to select the controller you want to move
then drag it to the new port.
 You cannot move a controller to a folder where a port does not already
exist. Make sure to define a port before performing this procedure.
5. Release the left mouse button and drop the controller onto the target port.

Importing Controllers
Use this feature to create a new controller on a Velocity system that contains the same
configuration as an existing controller. This enables a qualified operator to install a
previously exported controller profile to a new system.
To import a new controller:
1. Using the Export Configuration option, export the required controller configuration
profile from your source machine to some suitable medium, such as a CD, DVD,
floppy disk, or removable hard disk.
2. On the target machine, expand the DIGI*TRAC Configuration folder on the System
Tree until the XBox element under the New Port element is revealed.
3. Highlight the XBox element.
4. In the configuration pane, double click the Import New Controller option.
The Import New Controller Wizard appears like this example:

5. Click Next.
The Choose the XML file screen appears.
6. In the 'File name' text box, enter the path and name of the XML file you previously
exported.
If needed, click the browse button, , to bring up the Select a source file dialog
box and locate the file you need.

Controllers 81
Velocity Version 3.1 Administrator’s Guide

For example, this XML file is located in the Velocity folder to which it was originally
exported.

7. When you've selected the proper file, click Open.

You are returned to the Import New Controller Wizard page.
8. Click Next.
A preview of the XML file appears as shown in the following example:

9. Review this page then, if you are satisfied with it, click Next.
The Specify Basic Controller Information page appears.

82 Controllers
 MAN006-0612

This page displays the basic information about this imported controller, including
these fields.

Name Type in a short name for this controller, such as Controller

1 or Front Lobby. The more descriptive you can be the
better it is.

Description Type in a short description of this controller. Again, the

more specific you can be here, the easier it is to identify
the location and purpose of this controller.

Address From the drop-down option list, select the value that
describes the address you want to assign to this controller.
Your options are: 1 – 63 or <Next Available>.
If you select <Next Available>, Velocity automatically
selects the next available address for you. For example, if
you have already defined four controllers then the next one
you add would be automatically assigned the address 5.

Model From the drop-down option list, select the Hirsch controller
model that describes this controller. The number of doors,
readers, inputs, outputs, and other devices available to this
controller depends on which model you enter.
• M1N has 1 door, but can be unbundled to inputs and
relays, if required
• M2 has 2 doors initially assigned to it, though these can
be changed later to inputs and relays, if required
• M8 has 8 doors initially assigned to it though these also
can be changed to inputs and relays as required
• M16 has no doors but up to 16 inputs
• MSP includes two models: MSP-8R has no assigned
doors but up to 8 relays and 32 inputs; MSP-64R has no
assigned doors but up to 64 base relays and 32 inputs
For more on this topic, see Controllers - Introduction.
Depending on which model you select, the Components
Window reflects the number of doors and/or inputs and
relays supported.
For more on using doors, see Door Configuration.

Time zone From the drop-down option list, select the time zone
controller is where this controller is currently located. All times are
located in: standardized using GMT (Greenwich Mean Time).
The default is Pacific Time Zone.

Enable Check this box if the controller is currently connected and

operating.
Clear this box if the controller is not yet connected. This
box is checked by default.

Controllers 83
Velocity Version 3.1 Administrator’s Guide

System Code Enter the controller's system code that allows

programmers/configurators access to this controller.
The default is 123.

Disable Check this box to disable the system code. This means that
no system code will be necessary to gain access to this
controller.
The default is unchecked (enabled).

10. If required, change any information on this form.

11. Click Next.
The Map Standard Time Zones page appears.

12. Either map existing time zones to source time zones or let the wizard auto-map
these time zones for you by clicking Next.
Normally, you will select auto-mapping unless you need to change existing map
alignments.
If there are master time zones in this configuration file, the Map Master Time
Zones page appears.

If you do not have any master time zones, skip to Step 15.
13. Either map existing master time zones to source master time zones or let the
wizard auto-map these master time zones for you by clicking Next.
Normally, you will select auto-mapping unless you need to change existing map
alignments.

84 Controllers
 MAN006-0612

If there are grand master time zones in this configuration file, the Map Grand
Master Time Zones page appears.

If you do not have any grand master time zones, skip to Step 15.
14. Either map existing grand master time zones to source grand master time zones or
let the wizard auto-map these grand master time zones for you by clicking Next.
Normally, you will select auto-mapping unless you need to change existing map
alignments.
The Completing the Configuration Import Wizard dialog box appears.
15. Click Finish.
The Configuration Import Results page appears indicating whether the import was
successful or note.
If the import was successful, the newly imported controller appears in the configuration
pane.

Modifying Controllers
Once you have created the new controller, you can edit existing values and include
additional settings as required by accessing the controller's Properties option.
To modify settings for an existing controller:
1. Right click on the new controller icon, , in the System Tree window.
A pop-up list appears.
2. Select Properties from this option list.
The Controller dialog box appears with the General page displayed.
3. Add and edit values on the pages of this dialog box as required.
4. When you're finished, click OK. You are returned to the main Velocity screen.

Controller Properties
When you bring up the Controller Properties sheet, there are seven pages:
 General (page 86)
 Setup (page 88)
 Reporting (page 95)
 Passback (page 99)
 Control Zones (page 109)
 Alarm Actions (page 124)
 Communications (page 132)
Each of these pages is explained in the following subsections.

Controllers 85
Velocity Version 3.1 Administrator’s Guide

Controller General Page

Much of the information that appears on this page has already been supplied in the
New Controller Dialog Box.

All the other fields are read-only. The read-only fields indicate that Velocity has detected
these properties while communicating with (uploading or downloading) the designated
controller.

Name The name assigned to this controller. Any combination of letters

and numbers is acceptable. For example: 'Research Door 1' or
'Controller at the Lobby.' You can also change the controller name
directly from the System Tree window.

Description A brief description of this controller, such as 'controller monitoring

the west door of Research Zone 1.'

Time Zone Click and select from the list the time zone in which this controller
Controller is resides. All time zones are identified by their Greenwich Mean
located in: Time (GMT) designation followed by one or more prominent
capitals or countries that are within that time zone. For example, if
this controller is located in Salt Lake City, Utah, you would select
the '(GTM -08:00) Arizona' zone. The default is (GMT -08:00)
Pacific Time (US & Canada); Tijuana

Address Click and select one of the available addresses (1 - 63) or select
<Next Available> from the drop-down list to choose the next
available address. If you select <Next Available>, Velocity
automatically selects the next available address. For example, if
you have already defined four controllers then the next controller
would automatically be assigned 5.

ID Read-only field specifying the ID Velocity assigned this controller

when it was first defined.

Model Click and select one of the available Hirsch model types from the
drop-down list. Available types are M1, M2, M8, M16, or MSP.

Enable Select this checkbox if the controller is already connected and

on-line. If the controller is yet to be connected, deselect this.

86 Controllers
 MAN006-0612

Additional If required, click and select from the drop-down list a Command
command Set to execute after controller information is downloaded. Only
sets to those commands sets currently defined for the system appear in
download this combo box.
This feature allows the controller's CCM to have special setups
that Velocity cannot yet support for programming needs. Default
is <None>.

Read-Only Fields

Firmware Velocity reads this information directly from the controller.

Revision

CCM Firmware Indicates the revision number of the CCM firmware installed in
this controller. To update your firmware to the latest version, refer
to “CCM Firmware Update Wizard” on page 712.

CCM BIOS Indicates the current version of the BIOS on the CCM firmware.
Note: The version of CCM BIOS this controller has can affect its ability to
update CCM Firmware. For example, if this controller contains a
CCM with CCM BIOS 7.1.8 or earlier, you will need to replace your
CCM, since the flash will not work properly and the controller may
not reboot if powered off.

SNIB2 Indicates the current firmware version stored on the attached

Firmware SNIB2. To update the SNIB2, refer to “SNIB2 Firmware Update
Wizard” on page 715.

Update CCM Click this button to begin the firmware update to the specified
Firmware... controller. For full instructions on doing this, refer to “CCM
Firmware Update Wizard” on page 712.

Update SNIB2 Click this button to begin the firmware update of the controller's
Firmware... SNIB2. For full instructions on doing this, refer to “SNIB2
Firmware Update Wizard” on page 715.

Hardware Specifies the number of alarms, inputs, and relays available on

Configuration this controller. If expansion boards are installed in this controller,
these also appear.

# Alarm Relays Designates the number of alarm relays available on this controller.
Velocity reads this information directly from the controller.

# Inputs Designates the number of inputs available on this controller.

Velocity reads this information directly from the controller.

# Relays Designates the total number of relays available on this controller.

Velocity reads this information directly from the controller.

# XInputs Designates the number of expansion inputs available on this

controller. For expansion inputs to exist, an alarm expansion board
(AEB) must be installed in this controller. Velocity reads this
information directly from the controller.

Controllers 87
Velocity Version 3.1 Administrator’s Guide

# XRelays Designates the number of expansion relays available on this

controller. For expansion relays to exist, an relay expansion board
(REB) must be installed in this controller. Velocity reads this
information directly from the controller.

# VRelays Designates the number of virtual relays configured for this

controller.

Allocate 20% This box is only active (not grayed out) when the controller has
of MEB/CB an MEB/CE board installed. By checking this box, you redirect
memory to 20% of the board's memory from the user buffer to handle
Buffer events and alarms. Here are the three possible scenarios:
• If you have a panel with no MEB/CB64, this checkbox is grayed
out: 1500 Events, 1500 Alarms, 4000 Users.
• If you add a MEB/CB64 but do not check this box: 1500
Events, 1500 Alarms, 65000 Users.
• If you add a MEB/CB64 and check this box: 37000 Events,
5000 Alarms, 56000 Users
If you have installed an MEB/CE128, this essentially doubles all
the previous numbers. Above numbers are rounded down.

Options Indicates the number of expansion boards detected on this

Installed controller, such as SCIB, SNIB, memory boards, AEB, and REB. In
order for information to travel between the controller and the
Velocity host, the controller must be connected to the host or
network on which the host resides. The controller must have an
installed SNIB to connect.

Controller Setup Page

The second page of the Controller dialog box is the Setup page.

88 Controllers
 MAN006-0612

The fields on this page describe the following values:

Code Tamper Defines the time penalty (in seconds) for each invalid code
(Invalid Penalty Timer), and the alarm threshold time to exceed
before a tamper alarm will occur (Threshold Timer) and the
reader is locked up.
Code-tamper detects invalid code/card at a ScramblePad or
card reader, by reporting and tripping a tamper alarm relay if
three invalid codes/cards (default) are entered within one
minute.
Once a Code Tamper alarm occurs, Velocity reports the reader
involved in the system, locks out the keypad and/or card reader
from further entry attempts, and sounds a tone steadily at the
keypad while flashing the Red Status LED for one minute.
Any additional invalid entries at that keypad or reader will
immediately regenerate a code tamper alarm condition.

Invalid Penalty Enter a number from 0 to 99 seconds. (Default is 20 seconds)

Timer: This specifies the time allowed to enter a new code/card after a
person has entered an incorrect code/card before a code
tamper alarm is issued.
To set the code tamper to occur after a single invalid code or
card entry, set the penalty timer to a greater value than the
threshold time.

Threshold Enter a number from 1 to 99 seconds. (Default is 50 seconds)

Timer: When an invalid code/card is used, the Invalid Penalty Timer
starts and begins counting down to zero. When a second code
or card is tried, the penalty timer restarts adding the full penalty
time to whatever time remains from the first invalid entry. This
repeats for each invalid code or card entry until the total of the
penalty time exceeds the Threshold Timer which causes a code
tamper alarm report.
The penalty timer clears by counting down to zero seconds
before it exceeds the threshold time. The penalty timer is also
cleared when a valid code or card is used before the threshold is
exceeded. This allows for errors in code or card entry without
causing a code tamper alarm.

Lockout Time: Enter a number from 0 - 100 minutes that a reader is locked out
after a code tamper alarm has been invoked. No entry at this
keypad/reader will be recognized for the specified time period. If
additional incorrect entries are attempted, this extends the
lock-out interval.
For example, if an operator enters 2 minutes at this field, a
person who enters an incorrect code several times, exceeding
the Threshold Timer, it automatically locks up the keypad for two
minutes before allowing anyone to use that keypad again.
The default is 1 minute.

Controllers 89
Velocity Version 3.1 Administrator’s Guide

Special Needs The special needs time extension—also called Special Needs
Time Extension Extended Unlock (SNUX)—can prolong the interval when a door
is unlocked to accommodate special disabilities and
circumstances. This is used for wheelchairs, deliverymen, or
other requesters who generally take more time to enter or exit
a door than an average individual. Door mode, door open, and
door delay times can all be extended. A person's credential
must be enabled for SNUX use before these limits apply.

Delay: Enter a value from 0 - 8100 seconds. (Default is 0 seconds).

This is the time a person is allowed to get from the reader to the
door after a credential is presented.
If zero (0) seconds is entered, the door relay actuates
immediately after access—there is no delay.

Mode: Enter from 0 - 8100 seconds. (Default is 0 seconds).

This indicates the time the door remains open.

DOTL: Enter a value from 0 - 8100 seconds. (Default is 12 Seconds)

The DOTL timer begins once the door mode timer has expired.
This indicates the time a door can be open before a DOTL alarm
is issued.
If zero (0) seconds is entered, DOTL alarm reporting is disabled.

Tag: This determines whether transactions from people that belong

to a specified time zone cause a special tag alarm to occur.
Specify or define the time zone you require.
Choose from these options: <Never>, <Always>, <New>, or
any previously-defined time zone. If you select <New>, the
Time Zone Properties dialog box appears. You can then define a
new time zone for this purpose.
Tag alarms are generated upon each use of the codes or cards
belonging to the specified time zone, regardless of whether the
access was granted or denied.
Tag alarms can be used to cause special actions. For example,
tracking the arrival or departure of a specific user or users. In
addition, tagging can be used to detect improper access
attempts, such as a terminated employee attempting to gain
access.

90 Controllers
 MAN006-0612

Alert: This determines whether transactions from people that belong

to the specified time zone cause a special audio alert at the
ScramblePad where the transaction takes place. Specify or
define the time zone you require. Choose from these options:
<Never>, <Always>, <New>, or any previously-defined time
zone. If you select <New>, the Time Zone Properties dialog box
appears. You can then define a new time zone for this purpose.
Alert can be used for sending messages to notify a user or group
of users that some special condition exists as they use their
code. For example, a message is waiting for them or that an
unscheduled meeting is taking place.
The alert is a unique series of four “beeps” and a flashing LED
on the ScramblePad where the transaction takes place.

Options

Enable Duress Check this box to enable duress alarm mode. When a user
Alarm Mode: enters a duress digit, the controller issues an alarm.
For more on this, refer to “Duress Digits” on page 881.

Empty Local When checked, this allows you to cancel local controller alarms
Alarm Via by pressing either the controller's reset button or a connected
Reset keypad's reset button.

Validate on Check this box to validate on dual CCOTZ.

Dual CCOTZ This option only affects bad or unknown cards when the
dual-technology reader is not in CCOTZ. It does not affect good
cards or codes of any IDF. This allows users to enter/exit an
access point only if they have both cards and codes. This applies
only to those keypads/readers designated as dual technology.
For a detailed explanation of this feature, refer to “Dual
Technology: Validation During IDFs” on page 153.

Validate Check this box to validate immediately during CCOTZ.

Immediately Selecting this option only affects IDF3 and IDF5 when the
CCOTZ dual-technology reader is in CCOTZ. IDFs 3 and 5 are granted
when the dual reader is in CCOTZ and this option is not
selected. IDFs 3 and 5 report “incomplete dual” when the dual
reader is in CCOTZ and Validate Immediately is selected. IDF 5 is
granted if the person uses code only.
For a detailed explanation of this feature, refer to “Dual
Technology: Validation During IDFs” on page 153.

Enable Global Check this box to enable global user management.

User Specific user management values for each person are enabled
Management: through either the Credential Limits property sheet or the
Credential Template Limits property sheet.
For more on this, refer to “Credential (User) Management” on
page 894.

Controllers 91
Velocity Version 3.1 Administrator’s Guide

Enable Global Check this box to specify all master control zones defined for
MCZ: this controller are global. Enabling master control zones as global
designates that a master control zone created at one controller
can be recognized and used by all other controllers connected
to the same XBox.
If you leave this box unchecked, then MCZs defined on the
Control Zones page of this property sheet only apply to devices
attached to this controller.

Advanced... Click this button to display the Advanced Options Setups dialog
box and specify more specific values for global user
management.
For more on this, refer to “Controller Setup Page: Advanced
Options Setup” on page 94.

Options for The following values apply to local keypad programming only.
Local Keypad This controls how the controller responds to commands issued
Programming at keypads connected to it.
Only

Timeout: Determines how long a keypad stays in programming mode

without detecting command input before it automatically quits
and returns to normal mode. This means that if no commands
have been issued from the keypad within the specified interval,
programming mode is abandoned.
Enter a number from 2 – 20 minutes. The default value is 8
Minutes.

System Code: Enter a password that is used to enter the controller's

programming mode from any connected keypad. The default
password is 123 for local programming.
Note: The default value should be changed as soon as
possible.
To disable the use of a password entirely, click the 'Disable' box
to the right of this field.
If you need to add a duress digit to the code, check the ‘Gen
Codes with Duress Digits’ box and select a Duress Digit from the
‘Duress Digit’ pick list before selecting a system code.

Disable When checked, no programming can be performed from a

keypad connected to this controller. Any value entered in the
'System Code' field is deactivated.

Enable Local Check this box to indicate that the controller resets the initial
System Code programming code password to 123 when the controller is cold
Reset started and reset.
If the checkbox is cleared, the system code entered in the
System Code field is retained.

Local Printer Check this box to indicate that all new user codes are printed to
Shows New this controller's local printer. New users are automatically
User Codes recorded in the Velocity database.

92 Controllers
 MAN006-0612

AutoGen Code Enter number for code length from 3 to 8. This affects local
Length: keypad programming only; it does not affect the adding users
and codes from Velocity.
This length should be left at the factory default unless local
adding of users is required and the code length is not what is
desired.

Gen Codes Check this box to enable this controller to generate codes with
with Duress duress digits when adding users via local keypad programming.
Digits When you select this box, the 'Duress Digit' field becomes
active.

Duress Digit: Select a duress digit from the pull-down option box. Choose
from 0 - 9.
The controller recognizes this number for all keypads connected
to it. If you do not check the previous box, 'Gen Codes with
Duress Digits,' this field is grayed out and inactive.
Note: The controller only issues a duress alarm if the 'Enable Duress
Alarm Mode' box is checked.

Reduce Check this box to specify that the printed descriptions of events
AutoGen is less detailed. This can cut down on data streaming to the print
Printout buffer.

Alarm Relay DIGI*TRAC controllers have up to four dedicated alarm relay

Timers types. A timer can be set for each relay, from 0 (zero), do not
actuate on alarm, to 8100 seconds.
Controllers with a single alarm relay use the same four
separate alarm timers to trip the relay. Each timer is set
individually. If any of the 4 alarm timers is active the relay will
actuate. If one or more of the four conditions is not intended to
trip the relay, set its timer to 0.
You can also specify a map number that enables a specified
control relay to trigger when this alarm relay fires.

General: Specify the time in seconds a general alarm relay triggers. The
General Alarm Relay is tripped by Door Forced or Held Opens,
Input Tamper, Input Shorted, Noisy, Open, and Out-of-Spec,
Occupancy and Passback Violations, and Deadman Timer
Expired.

Duress: Specify the time in seconds a duress alarm relay triggers. The
Duress Alarm Relay is tripped by a user entering their code with
a duress digit at a keypad.

Tamper: Specify the time in seconds a tamper alarm relay triggers. The
Tamper Alarm Relay is triggered by Box Tamper,
ScramblePad/MATCH Reader Physical Tamper and Code
Tampering.

Controllers 93
Velocity Version 3.1 Administrator’s Guide

Trouble: Specify the time in seconds a trouble alarm relay triggers. The
Trouble Alarm Relay is tripped by Power Failures, Battery
Problems, Network Inactive, Keypad, MATCH, Printer and
Modem Off-Lines, Report Buffer Threshold Exceeded, and Tag
Alerts.

SCIB The Serial Communications Interface Board (SCIB) is an add-on

board that can provide a high-speed serial interface between the
controller and a local printer.
Note: All controllers have a parallel port for a local printer.
If a SCIB is installed in this controller, these settings define the
setups for the local printer:

Baud: Set the transmission rate to one of the following values: 300,
600, 1200, 2400, 4800 or 9600.

Parity: Specify the data length by entering seven (7) or eight (8).

Data Bits: Define parity as one of the following: Odd, Even or None.

Stop Bits: Specify the stop bit length by entering (1) or two (2) bits long.

Controller Setup Page: Advanced Options Setup

This screen appears when you click the Advanced button on the Controller Setup
page.

Don't change these settings unless you have a thorough

knowledge of the controller. These settings can compromise
the security of the controller.
This screen includes these two options:

Bypass “no Check this box to indicate that the controller can ignore the
such hardware” “no such hardware” error.
Errors This tells the controller that it does not need to check
equipment before issuing commands that access base or
expansion relays, inputs, or other hardware, even if the
hardware is not currently present or responding.
The default is unchecked.

94 Controllers
 MAN006-0612

Bypass Code Check this box to indicate that the controller will add a new
Conflict code/card to its user database even if there is an apparent
Checking code conflict.
The default is unchecked.

Special Needs Time Extension

Designated persons (credentials) can be defined as authorized to receive an extra
length of time that will be added to the door relay time. This feature is useful for ADA
and other disability provisions.
The Door Mode, Door Open Too Long (DOTL), and Door Delay timers located on the
controller setup page can all be extended by up to 8100 seconds (2.25 hours), as long
as the resulting total does not exceed 8100 seconds. These timers are implemented
on a per controller basis.
Special Needs Access Time Extension durations can only be set in whole seconds only.
The controller's Special Needs Access Time Extension value for 'Delay' field will only
apply at those doors where the 'Door delay time' field has already been set to a
non-zero value of at least 0.25 seconds. If the Door delay time is set to zero, the
Special Needs Access Time Extension value cannot be added.
To qualify a credential for special needs access, you must check the 'Special Needs
Access Time Extension' box on the Credential Options property sheet (see page 873).

Controller Reporting Page

The third page on the Controller Configuration dialog box is the Reporting page which
provides all reporting options for this controller.

These values include:

Disable During Time Zone (Disable the following tasks during the time zone(s)
specified)

On Local Select <Never>, <Always>, a previously-created time zone, or

Printer create a new time zone using <New>, during which Velocity
won't send reports to the assigned local printer.

Controllers 95
Velocity Version 3.1 Administrator’s Guide

Transactions Select <Never>, <Always>, a previously-created time zone, or

create a new time zone using <New>, during which Velocity
won't report transactions. Events and alarms are still reported
unless otherwise disabled. Disabling these reports prevents them
from being logged to the printer, buffer, and Host PC.

Events Select <Never>, <Always>, a previously-created time zone, or

create a new time zone using <New>, during which Velocity
won't report events. Transactions and alarms are still reported
unless otherwise disabled. Disabling these reports prevents them
from being logged to the printer, buffer, and Host PC.

Granted Select <Never>, <Always>, a previously-created time zone, or

Transactions create a new time zone using <New>, during which Velocity does
not report granted transactions. Any denied transactions continue
to be reported. Disabling these reports prevents them from being
logged to the printer, buffer, and Host PC.

Local Printer Setup

Lines Per Specify the number of lines the local printer fits onto a generated
Page page.
The default page length is 0 (None). The American standard for
8.5 x 11 is 58 lines per page. The available range is 40 - 255.

Language From the drop-down option list, select the language in which you
want the page printed.
Options are English (default), German, Dutch, French (Français),
Spanish (Español), or Italian (Italiano). Default is English.

Disable Reporting of

Daily Check this box to disable the daily report of system status that
Midnight occurs every night at midnight. It also disables the Sunday
Report midnight system status and configuration report. By default, this
box is checked.

Internal Check this box to turn off reporting of automatic time-generated

Events events, when time zones start and end, and relay state changes.
By default, this box is unchecked.

External Check this box to turn off reporting of alarm, AC, box and address
Events tamper alarm restorals, on-lines and installation errors, UPS
restoral, alarm secure, line trouble clear, passback violations, and
printer on-line. By default, this box is unchecked.

Transaction Check this box to turn off reporting of all code-generated

Events transactions, but not alarms. By default, this box is unchecked.

Invalid Check this box to turn off reporting of invalid code entries. By
Codes default, this box is checked.

96 Controllers
 MAN006-0612

Relay State Check this box to turn off reporting of relay state changes. Relay
Changes state change reports are useful for verifying correct programming
of the system or for tracking down a programming problem. This
report is usually not enabled because of the large number of
events that can result.
By default, this box is unchecked.

Timezone Check this box to turn off reporting of time zone activation and
State deactivation. By default, this box is unchecked.
Changes

TZ Driven Check this box to turn off reporting of time zone-driven relays and
Relay State their change of state. In other words, whenever the program
Changes detects that a relay controlled by this controller has changed states
during a specified time zone, it disables reporting of that event. By
default, this box is unchecked.
These reports are mainly used for verifying correct programming
and operation of a DIGI*TRAC system.

TZ Driven Check this box to turn off reporting of time zone-driven input
Input masking changes. In other words, whenever the program detects
Masking that an input controlled by this controller has been masked during
Changes a specified time zone, it disables reporting of the event. By default,
this box is unchecked.

Advanced... Click this button to access the Advanced Reporting Setups dialog
box. For more on this, refer to “Advanced Reporting Setups” on
page 97.

Advanced Reporting Setups

The Advanced Reporting Setups screen looks like the following example:

Changing these values can compromise the system's security

and may have an adverse effect on system performance.
In most circumstances, the default values are sufficient for reporting; however, if you
require changes to report message filtering or diagnostic options, use this dialog box.

Controllers 97
Velocity Version 3.1 Administrator’s Guide

The values on this screen are:

Message Filters

Enable the At this combo box, select the type of message whose reporting
following you want to enable. The message types are:
types of: • Host Messages
• Line Printer Messages
• Terminal Messages
• Keypad Messages
The available messages for that message type are displayed in
check boxes beneath the combo box. Each message type
supports a different list of options.
Select each message you require for each message type. When
checked, that message is reported for that controller.
The default setting enables all messages for all message types.

Diagnostic Normally you use these functions to help diagnose problems

Options with a system.

Enable Check this box to turn on an echo every time an operator enters
Command a command at a keypad. This echo is recorded at the local
Echo printer and Velocity server/workstation.

Enable Check this box to turn on printing of all S*NET messages to the
Printing SNET local printer.
Messages on
Local Printer

Enable MCZ Check this box to turn on Master Control Zone reporting. This
Reporting enables Velocity and/or the local printer to record each time a
MCZ is activated.

Enable ACB Check this box to turn on Alarm Control Block reporting. This
Reporting enables Velocity and/or the local printer to record each time an
ACB is activated.

98 Controllers
 MAN006-0612

Controller Passback Page

This is the fourth page of the Controller dialog box and controls how passback control is
performed by the controller.

This page contains the following options and fields:

On Passback If none of these boxes are checked, then the 'Passback Options'
Violation and the Occupancy Options (including the 'Report all
Occupancy Violations in All Zones' box) sections are grayed out
and inactive.

Report (enable Check this box to enable passback and occupancy tracking.
Passback/ When a passback violation is detected by this controller, Velocity
Occupancy generates a report concerning the incident.
Tracking) When this box is not checked, the selected controller turns off
all passback tracking. All fields associated with passback tracking
and reporting are grayed out.
Since passback tracking is required for occupancy tracking, this
effectively disables all occupancy tracking functionality. All fields
on this form associated with occupancy tracking are grayed out.

Generate Alarm When a passback violation is detected by this controller, Velocity

generates an alarm.

Deny Access When a passback violation is detected by this controller, Velocity

denies access at the access point recording the violation.

Passback Options This section is only active if one of the 'On Passback Violation'
boxes is checked above.

Disable During Select from the drop-down list the time during which the
TZ: specified passback options are disabled.
Options include:
• <Never>—passback options are never disabled
• <Always>—these options are always disabled
• One or more time zones previously defined for this controller
• <New>—enables you to define a new time zone for this
specific condition.

Controllers 99
Velocity Version 3.1 Administrator’s Guide

Enable Single Check this box to specify that only people allowed to use a
Zone specific door group can occupy a controlled area at a time.
You can authorize more than one door group to use the same
secure area; however, when the area is unoccupied and this
option is enabled, the first door group to enter automatically
excludes all other authorized door groups until the area is again
unoccupied.

2-Person Rule This section defines the timers and TZ disable parameters for
using Two-Person Rule. The actual rule used for each card or
code is specified through the Credential Limits property sheet
or the Credential Template Limits property sheet.
Once you have qualified a controller for two-person rule, you
can:
• apply two-person rule to a credential template, refer to
either “Limits Property Sheet” starting on page 236.
• apply two-person rule to a credential, refer to “Limits
Property Sheet” starting on page 870.
For more on this, see “Two-Person Rule” on page 106.

Time Increment Enter the interval in seconds allowed between card swipes.
for Each Valid If a second card is not swiped within the specified time interval,
Reader access is denied to the door and an alarm is reported.
The default time increment is 10 seconds.
For more on this, see “Two-Person Rule” on page 106.

Threshold Time Enter a threshold time in seconds. This time establishes a

duration that must be exceeded before access is granted.
The threshold timer needs to be set one second higher than the
'Time Increment for Each Valid Reader' field value for each valid
read. If you are using a card and PIN, setting the value for 10
seconds for both credentials will be insufficient; the time
increment is the maximum seconds allowed for both
credentials and the threshold is one second more.
If the increment and threshold times are correct, the threshold
will be exceeded and access granted when two valid codes are
entered in succession. If the first code's timer runs out before a
second valid code is entered, access will be denied.
The default time is 11 seconds.
For more on this, see “Two-Person Rule” on page 106.

100 Controllers
 MAN006-0612

Disable During Select a time during which the 2-person rule is disabled.
Time Zone Options include:
• <New>—to define a new time zone during which this
feature is disabled
• <Never>—if 2-person rule is never disabled
• <Always>—if 2-person rule is always disabled
• A time zone previously defined during which 2-person rule is
disabled

The following boxes and fields are only active if one of the boxes in the 'On Passback
Violation' section is checked.

Report All Check this box to enable the report of all occupancy
Occupancy violations. Velocity and the local printer (if enabled) will
Violations record and print every occupancy violation detected by the
system.
When this checkbox is not checked, it effectively disables all
occupancy tracking. All fields associated with occupancy
tracking for this controller are grayed out.

Occupancy Options Select a Passback Zone where passback applies.

Apply to this Zone Values range from 2 - 64. By default,
0 = undefined or unrestricted
1 = outside.
When you select a previously-defined zone, the values for
that zone appear in the fields below.
For more on defining passback zones, refer to “Defining
Passback Zones” on page 105.

Number of People Type an even number in the 'Even #' field indicating the
Inside Disable 2 maximum users inside the secured area required before
Person Rule 2-person rule is disabled. This changes a controlled area from
2-Person Rule to normal access based on the area's inside
occupancy count.

Controllers 101
Velocity Version 3.1 Administrator’s Guide

Min Type a number in each of these fields to indicate what the

Max minimums and maximums are allowed within this secured
area. Whenever the total exceeds the maximum allowed or
equals the minimum allowed, access is denied and an
occupancy violation alarm is recorded. The default is set to a
minimum of 2 and a maximum of 0 (zero).
For the minimum, enter a number between 2 and 10 users.
When the area is occupied by one less than the minimum
setting, an occupancy violation alarm occurs after a
20-second delay and keeps recurring every two minutes as
long as the occupancy remains below the minimum. For
example, if the minimum number stipulates at least 4
persons, an alarm is issued when occupancy is 3 or less.
For the maximum, enter a number between 0 (off) and the
maximum number of users supported by the memory of the
system.
For the occupancy controls to work, Passback Zones must be
specified for all readers involved.
Both minimum and maximum counts and transitions can be
used to trigger control zones for special alarms, area
annunciators, or occupancy status signs.

When Occupancy... The occupancy count can be used to trigger a control zone
for automatic masking and unmasking of the protected area
and to change 2-Person Rule to 1-Person Rule once the area
is occupied by the minimum required number of persons.
Use this section to trigger a standard or master control zone
when a change in occupancy count occurs for the associated
area. You can use this command to trigger alarms, area
annunciators, or occupancy status signs. It can also be used
to automatically mask the interior alarms in the controlled
area on the ‘first person in’ and unmask the area on the ‘last
person out.’
Control Zones can be selected to trigger when the following
occupancy conditions occur:

...Goes From 0 to 1 From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count goes from
0 to 1.
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

...Goes From 1 to 2 From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count goes from
1 to 2.
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

102 Controllers
 MAN006-0612

...Goes From 2 to 1 From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count goes from
2 to 1.
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

...Goes From 1 to 0 From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count goes from
1 to 0.
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

...Is At Minimum From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count reaches
the assigned minimum value ('Min' field).
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

...Is At Minimum -1 From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count reaches
the assigned minimum value ('Min' field) minus 1.
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

...Is At Minimum +1 From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count reaches
the assigned minimum ('Min' field) plus 1.
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

...Is At Maximum From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count reaches
the maximum value ('Max' field).
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

...Is At Maximum -1 From the drop-down option list, select a standard or master
control zone to trigger when the occupancy count reaches
the maximum value ('Max' field) minus 1.
If no trigger is required, select <No Control>. If a trigger is
required, select from one of the available standard or master
control zones.

For more on passback control, refer to the next section.

Controllers 103
Velocity Version 3.1 Administrator’s Guide

Passback Control
Passback control requires users to enter through an entry reader, and later, exit through
an exit reader before their ID can be accepted at another designated entry reader.
Passback is used to reduce multiple entries on a single ID by different persons. This is
done by:
 sharing—passing a card back to another entrant
 tailgating—enabling more than one person to enter on the single use of an ID
Passback control also enables the system to track and report on who is inside the
secure area.
To keep track of secure areas, Velocity uses a concept called Passback Zones that
controls the movements of a qualified person through a series of rooms so that the
person cannot backtrack or deviate from the security course set for them.
In order to use passback, these values must be set:
 To specify passback settings for the controller, see “Controller Passback Page” on
page 99.
 To define a passback zone and specify how many minutes a reader must wait
before allowing the same credential to be used again, refer to “Reader Logic
Property Sheet” on page 202.
 To set up a controller to use passback, see “Defining Passback Zones” on page 105.
 To qualify a user for passback, refer to the “Credential Properties Dialog Box” on
page 864.

Passback Zones: Introduction

Passback zones (also called Physical Zones) are actually extensions of common
passback and occupancy definitions, enabling the operator to create an arbitrary
topology around a reader or group of readers.
Using Velocity, a keypad/reader can be defined as an entry or exit point for up to 62
inside zones. Each zone defines a different area, floor, or building.
 Zone 1 is always Outside. Zone 2 - Zone 63 are always Inside.
This makes possible any number of new topologies for tracking occupancy and
passback states (including nested areas, front door/lobby/warehouse/back door
arrangements).
For example:

104 Controllers
 MAN006-0612

In this sample topology, readers would be defined in this way:

Reader From PZ... ... To PZ

1 1 - Outside 2 - Inside

2 2 - Inside 9 - Inside

3 2 - Inside 3 - Inside

4 2 - Inside 18 - Inside

5 1 - Outside 18 - Inside

6 1 - Outside 7 - Inside

7 1 - Outside 4 - Inside

9 2 - Inside 2 - Inside

10 9 - Inside 2 - Inside

12 18 - Inside 2 - Inside

13 18 - Inside 1 - Outside

14 7 - Inside 1 - Outside

16 1 - Outside 7 - Inside

For details on how to define this in Velocity, refer to “Defining Passback Zones” on page
105.

Defining Passback Zones

Defining passback zones is a two-step process:
 Create the passback zone including a definition of its occupancy requirements and
stipulation of the control zones it triggers
 Map the passback zone to a physical location
Step1: To define a passback zone:
1. Add or modify a controller.
2. At the Controller Properties dialog box, click on the Passback tab to reveal the
Controller Passback page.
3. At the 'Occupancy Options Apply to Zone' combo box, select the passback zone
you want to define from the combo box.
The available passback zone options are 2 – 64.
4. At the 'Number of People Inside Disable 2 Person Rule' field, enter the number of
people beyond which this Passback Zone disables the two-person rule.
5. In the 'Min' and 'Max' text fields, enter the minimum and maximum number of
people allowed in this passback zone.
6. In the 'When Occupancy... and Trigger Control Zone' section, select the control
zones within the Passback Zone that are triggered during the following occupancy
conditions.
You can specify either Standard or Master Control Zones to trigger.
7. Repeat Steps 3 – 6 to select other Passback Zones.

Controllers 105
Velocity Version 3.1 Administrator’s Guide

8. When you're finished, click OK.

Only those areas controlled by the readers/doors connected to this specific controller
can be defined. Once you have defined the occupancy requirements and control zone
triggers for each passback zone, you can locate them in relation to the doors or readers
that border them.
Step 2: To map a passback zone to a physical location:
1. From the system tree window, locate each door/reader either bordering a
Passback Zone or between Passback Zones.
2. Double click the reader or door to bring up its corresponding properties dialog box.
• If this is a door, bring up the Logic page for either the Door Properties Entry
Reader or Door Properties Exit Reader.
• If this is a reader unassociated with a door, bring up the Reader Logic property
sheet.
3. In the 'Passback Zones' section, specify the Passback Zones this reader is
separating:
• In the 'From zone' combo box, select the Passback Zone this reader leads
into.
• In the 'to' combo box, select the Passback Zone this reader leads out of.
The range is Zone 1 – 63. The default value is Zone 0 - Unrestricted which
indicates that no passback zone is currently defined for this reader. Zone 1 -
Outside is defined as any area beyond the boundaries of the secured facility. All
other zones (Zone 2 – 63) are Inside and equate to the values available in the
'Occupancy Options Apply to Zone' combo box on the Controller Passback page.
For more on this, refer to “Passback Zones: Introduction” on page 104.
4. When you're finished, click OK.

Occupancy Count
Velocity counts the number of users entering a secure area and keeps a running total.
As users exit from the secure area, they are subtracted from the running total.
Whenever the number of users inside reaches the minimum or maximum levels set by
the controller configuration, an Occupancy Violation Alarm report is sent to the Velocity
workstation. Velocity reports the user number of any person who violates the
occupancy rule.
In addition, the occupancy count can be used to trigger a control zone for automatic
masking and unmasking of the protected area and to change the Two-Person Rule to
One-Person Rule once the area is occupied by the required minimum.
To enable occupancy count for a specified controller, use the “Controller Passback
Page” on page 99.
To enable and set a limit for a user, refer to the “Limits Property Sheet” on page 870.

Two-Person Rule
The two-person rule provides a high level of security for areas by requiring two
authorized persons to be present in order to enter or exit a secure area. This rule is
often applied to such places as high-security military installations, biohazard labs, or
bank vaults.
For example, Mr. Jones cannot enter the high-security lab area unless Mrs. Smith is also
entering the area at the same time.

106 Controllers
 MAN006-0612

The two-person rule is controlled by two time settings. A time increment (in seconds)
is set for each granted access code. A time setting is also set to establish a threshold
time that must be exceeded for access to be granted. If the time settings are correct,
the threshold will be exceeded and access granted when two valid codes are entered
in succession. If the first code's timer runs out before a second valid code is entered,
access will be denied.
When the first valid code is entered at a 2-person access point, the code timer starts
counting down from its set maximum value towards zero. When a second valid access
code is entered the two times are added together, and if their combined time exceeds
the access grant threshold time setting, the door will unlock. If the combined total of
the first code time and the second code time does not exceed the threshold time, the
door will not unlock. This enables control over how much of a delay is allowed
between the two code entries.
Once you have qualified a controller for two-person rule, you can:
 apply two-person rule to a credential template, refer to either “Limits Property
Sheet” starting on page 236.
 apply two-person rule to a credential, refer to “Limits Property Sheet” starting on
page 870.
Doors are enabled for 2-Person Rule using the Door General Properties page as
described on page 149.
Timer and time zone disable parameters are specified on the Controller Passback
property sheet as described on page 99.
Calculating Time Increment vs. Threshold Time
A formula that might help you to remember this is:
If,
2x - t = y
where,
x = granted code increment
t = the time the user actually takes to enter the code
y = the granted access threshold
then access is granted.
Or, to think of this in a simpler way: say it normally takes a user n seconds to enter his
code. Then set the time increment to n+1 and the threshold time to n+2. For example,
if you accept the default assumption that it takes 9 seconds to enter code, then the
time increment would be set to 10 and the threshold time would be set to 11.
To expedite things, we suggest that you formulate a time increment that is practical for
entering codes into this door under any foreseeable situation, then apply the same
time interval to the time threshold.
So, for example, if you specified that 15 seconds is a reasonable value for the granted
code time increment, designate 16 seconds for the granted access time threshold.
The controller automatically checks to prevent a valid code from being entered twice in
a row in order to grant access. 2-Person Rule Violation reports are printed if only one
code is entered before the timeout, or if the same code is entered twice in a row. A
violation triggers the tamper alarm relay, since this is considered an attempt to bypass
the controller.

Controllers 107
Velocity Version 3.1 Administrator’s Guide

The two-person rule can also be combined with occupancy controls for even greater
security.
Rule Variations
There are a number of variations to this rule:
 Two-Person “A/B” Rule. If one person has “A” then they need to find someone with
“B” to unlock the door. A user with neither the “A” nor “B” designation can go with
anyone through a door with two-person rule. Either A+B or B+A is allowed; A+A or
B+B are not allowed.
 Two-Person “Supervisor/Trainee” Rule. S+S, S+T, or T+S is allowed; T+T is not
allowed.
 Two-Person “Executive Override. This overrides the two-man rule. One access-grant
unlocks the door.
The following combinations of credential limits are valid at a 2-Person Rule-enabled
Door:
 Normal + Normal
 A+B
 B+A
 A + Normal
 B + Normal
The following combinations of credential limits are invalid and will not allow access at a
2-Person Rule-enabled door:
 A+A
 B+B
Setting Up Two-Person Rule
To activate two-person rule:
1. Enable doors for Two-Person Rule by checking the 'Enable two person rule' box on
the Door General Properties page (see page 86).
2. Set default 2-Person Rule timers and time zone disable in the '2-Person Rule'
section of the Controller Passback property sheet (see page 99).
3. Enable 2-person rule for:
• a specific credential using the Credentials Limits Property Sheet discussed
starting on page 863.
• a credential template using Credential Template Limits Property Sheet
discussed starting on page 228.
4. In Enrollment Manager, assign the credential or credential template to a person.

108 Controllers
 MAN006-0612

Controller Control Zone Page

The fifth page on the Controller Configuration sheet is the Control Zone page. This page
displays a single button, Edit Control Zones.

Click this button to go to the Standard Control Zones page. For more on this page, refer
to “Standard Control Zones Property Sheet” on page 113.
This page defines and modifies the control zones you require for each controller.

Hint By enabling the Globalized MCZ feature on the Controller Setup page, then
defining a global ID for the MCZ or broadcasting it globally using the Master
Control Zones dialog box, you can 'publish' a group of control zones for use by
every controller connected to the same XBox.

Control Zones
Control Zones link a time zone to an input, relay, or reader. Control Zones determine
where something happens—which relays, alarms, and readers—and when something
happens—during what time and on which days.
A single control zone can contain one time zone with up to:
 8 door inputs/relays
 16 keypads/readers
 16 expansion inputs
 64 expansion relays
In sophisticated systems, one Control Zone can be made to trigger other control zones,
resulting in a cascade of events.
Control Zones can be visualized as a table with columns for Control Zone, Time Zone,
Door Input/Relays, and Expansion Input/Relay numbers like the following example:

Controllers 109
Velocity Version 3.1 Administrator’s Guide

There are two types of Control Zones:

 Standard Control Zones
 Master Control Zones
Each type has a specified range as shown below:

CZ Type Numbers Definition

Standard Control 0 - 191 Consists of a Time Zone and the Inputs and
Zones Relays to be controlled. (CZ 0 = Never/No
Inputs or Relays)

Master Control 192 - 255 Consists of a combination of Standard Control

Zones Zones each capable of performing different
access and control functions simultaneously.

In Velocity, control zones are defined by a specific Controller Properties dialog box. This
means that control zones are initially defined only for an individual controller; however,
Velocity possesses the flexibility to make master control zones global: that is, the
definition for a particular MCZ can be mapped to other controllers, and triggered by
master control zones on other controllers, as long as those controllers are connected to
a specific XBox within this Velocity system.

Control Zones: How to Define

Here are the procedures you use to define both standard control zones and master
control zones.
To define standard control zones:
1. Access the properties for an existing controller.
2. Click the Edit Control Zones button on the Control Zone page of the Controller
dialog box.
The Control Zones dialog box appears with the standard control zone property
sheet displayed. For more on this property sheet, refer to “Standard Control Zones
Property Sheet” on page 113.
3. From the CZ Name column, change the control zone name, if required.
 You cannot change any properties of SCZ0. This is the default for no
actions at any time.
4. Click in the Time Zone column, then click the down button, .
A list of available options appear.
5. Select from an available time zone option for the standard control zone.
Your options are <Never>, <Always>, one or more existing time zones, or <New>.
<New> takes you to the Standard Time Zone Properties page and enables you to
create a new time zone.
Click one or more cells representing the object (door/inputs/ relays) you want to
associate with this control zone. An X appears if the object is enabled for that
control zone. Both base objects and expansion objects are supported.

110 Controllers
 MAN006-0612

To edit the object associated with this cell, right click in the cell and select from a
number of different properties. These options take you to the relay, input, or reader
associated with the cell. For example, if you right click on the cell intersecting SCZ1
and X2 three options pop-up. Select Input Properties... to take you to the Input
Properties sheet associated with Expansion Input 2 (XInput 02).
6. Click OK to confirm your selections or click the Master Control Zones property
sheet to define MCZs.
7. When you're finished, download the changes to the relevant controller.
For more information on this, refer to “Defining Standard Control Zones” on page 117.
Creating a standard control zone only associates a time zone with a group of inputs,
relays, and readers. It does not indicate how these points will be controlled. For that
you must define master control zones.
To define master control zones:
1. Access the properties for an existing controller.
2. Click the Edit Control Zones button on the Control Zone page of the Controller
dialog box.
The Control Zones dialog box appears with the standard control zone property
sheet displayed.
3. Click the Master Control Zones tab.
The Master Control Zones property sheet is displayed. For more on this, refer to
“Master Control Zones Property Sheet” on page 115.
4. From the 'MCZ#' field, select an available number for this master control zone
(192 - 255).
5. From the 'Name' field, type a name for this MCZ or accept the default name.
6. From the 'Description' field, type a brief description of this MCZ.
7. From the 'Set Threat Level To:' field, select a threat level for this MCZ.
8. At the 'Tag' checkbox, check or uncheck to indicate whether this MCZ is tagged.
9. At the 'Alert' checkbox, check or uncheck to indicate whether this MCZ issues an
alert on activation.
10. At the 'Map to Global ID' combo box, select a global ID for this MCZ.
For more on this, see “Master Control Zones Property Sheet” on page 115.
11. At the 'Broadcast Globally' checkbox, click to indicate this MCZ will be broadcast to
every controller connected to this SNET or XNET network.
12. Assign specific actions listed in the left most column to outputs and expansion
relays as required.
13. At the 'Control Zone' column, specify an existing standard control zone when this
takes affect.
If no control zone is required, leave the default CZ0.
14. If required, change relay/output definitions.
15. When you're finished, download the changes to the relevant controller.
For more information on this, refer to “Defining Master Control Zones” on page 120.
You can also assign a standard or master control zone to an area on a map using the
Badge & Graphic Designer. For more on this, refer to “Drawing a Control Zone” on page
505.

Controllers 111
Velocity Version 3.1 Administrator’s Guide

Control Zones: Editing Objects

During the process of associating cells (objects) on the Control Zone property sheet
with time zones to create control zones, you can edit the Input, Output, and Reader
properties which compose those objects. This creates a link between the control zone
property sheet and any one of three component property sheets.
To edit an object:
1. At the Standard Control Zone Properties sheet, right click in a cell.
An option list pops up.
2. Click one of these three options:

For expansion objects

If you select: For base objects (1 - 8):
(X1 - X64):

Input The door properties sheet The Expansion Input

Properties... associated with the object property sheet associated
appears. with this expansion object
Select the page you require appears.
from the tabbed sheets.

Output The door properties sheet The Expansion Relay

Properties... associated with the object property sheet associated
appears. with this expansion object
Select the page you require appears.
from the tabbed sheets.

Reader No property sheet is If this is X1 - X16, the Reader

Properties... associated with this. property sheet associated
Readers are specified by X1 - with this object appears.
X16. If this is X17 - X64, no reader
property sheet appears.
3. Fill out the property sheets as required.
4. Click OK and you are returned to the Control Zone properties exactly where you
left off.

Control Zones Properties Dialog Box

The Control Zones dialog box is divided into two pages or property sheets:
 Standard Control Zones (SCZ)
 Master Control Zones (MCZ)
 Any changes you make to the SCZ or MCZ property sheets won't take
effect until you have either reopened the Controller Properties sheet or
downloaded these changes to the relevant controller.
Both are described in the following subsections.

112 Controllers
 MAN006-0612

Standard Control Zones Property Sheet

The SCZ property sheet looks like this example:

The SCZ page contains this matrix:

CZ# This is a read-only column showing the CZ number for each row.
There are 191 possible SCZs.
SCZ0 is reserved for No Control at any time.

CZ Name Either accept the default name, SCZx, or type a new name for this
control zone.
To create a new name, click in the column and row and type a
new name.
SCZ0 is reserved and cannot be changed.

Time Zone Click in this column and pull-down a list of all possible time zones.
Select from <Never>, <Always), a currently-defined TZ, or <New>
to define and add a new TZ for this purpose.

Controllers 113
Velocity Version 3.1 Administrator’s Guide

1 - X64 Click in one or more of these cells to indicate which

doors/inputs/relays are controlled during this time zone for the
designated SCZ.
The number of base doors/inputs/relays you see is determined by
the controller type specified on the General page. For example, an
M1 has 1 - 4 doors; M8 has 1 - 8 doors.
There are also 64 expansion inputs/relays depicted.
You can go directly from one of these cells to the corresponding
Door, Input, or Output property sheet by right clicking on the cell
and selecting from one of the pop-up options:
If you select Reader Properties... the Reader dialog box appears for
that specific door. Readers are described by expansion points 1 -
16 (X1 - X16).
If you select Input Properties... the Input dialog box appears for
that specific input. If you select an expansion cell (X1 - X64), the
Expansion Input dialog box appears.
If you select Output Properties... the Door dialog box appears for
that specific output. If you select an expansion cell (X1 - X64), the
Expansion Relay dialog box appears.

Tag Click this column and row to indicate this SCZ is tagged. An X
appears when it is selected.
If enabled, the program sends a special Tag Alarm to the Alarm
Viewer each time this SCZ is triggered.

Alert Click this column and row to indicate this SCZ is enabled for alert.
An X appears when it is selected.
If enabled, a special audio alert sounds at the ScramblePad or
ScrambleProx where this SCZ was triggered.

114 Controllers
 MAN006-0612

Master Control Zones Property Sheet

The Master Control Zone property sheet appears whenever you click the Master
Control Zones tab.

These fields and buttons appear:

MCZ Number From this combo box, select the number for this MCZ from the
available numbers.
The available range is 192 - 255.

Name Type the name you want for this new MCZ.

Description Type a brief description of what this MCZ does.

Time Zone Select an existing time zone from the drop-down list or select
<New Time Zone> to create a new time zone for this MCZ.
Select <Never> to indicate this MCZ is not tripped by a time
zone and <Always> to indicate this MCZ always occurs.
This time zone designates the time during which an entered
code or card can trigger the MCZ. Other uses for a MCZ—such
as relay and alarm input linking—are unaffected by this time
zone entry.

Set Threat Select a threat level from the combo box (1 - 99) indicating at
Level To: what level this MCZ stops functioning.
If no level is required, accept the default value, N/C.

Controllers 115
Velocity Version 3.1 Administrator’s Guide

Map to Global Select a global ID from the existing range (0 - 255). This
ID enables a qualified operator to link MCZs, even across multiple
controllers connected to the same XBox. This, in effect, enables
the triggering of actions across more than one controller.
The default value is 0, no global ID.
You must check the 'Enable Global MCZ' box on the Control
Zones Properties Setup page before this field can be used.
For more on this feature, refer to “Linking Master Control
Zones” on page 121.

Broadcast Check this box to indicate that when this MCZ is triggered, that
Globally event is broadcast to all controllers connected to the same
XBox.
This box must be checked in order to trigger MCZs on other
controllers using Global ID (see previous field).
You must check the 'Enable Global MCZ' box on the Control
Zones Properties Setup page before this field can be used.
For more on this feature, refer to “Linking Master Control
Zones” on page 121.

Tag Check this box to enable tagging for this control zone. Tagging
determines whether transactions from users belonging to the
SCZ cause a special Tag Alarm to occur.

Alert Check this box to enable alert for this control zone. Alert
determines whether transactions from users belonging to the
SCZ cause a special audio alert at the ScramblePad where the
transaction takes place.

Output/Relay The entries appearing in this panel indicate those SCZs and
Matrix Actions currently included in the definition of this MCZ.

Action Choose one or more actions from this column.

For explanations of each action, see “Functions” starting on
page 241.

Control Zone Select an existing SCZ from the combo box drop-down list.
When you select an SCZ, the relays/inputs associated with this
CZ are supplied as they appear on the Standard Control Zones
pages.
If no control zone is specified, leave the default <No Control>
option. No relays/inputs are listed.

116 Controllers
 MAN006-0612

1 - X64 The doors/inputs/relays associated with an assigned SCZ

appear in the appropriate cells.
To redefine an SCZ or to create a definition for a new SCZ, click
in one or more of these cells to select the objects you require
for the SCZ assigned to this MCZ. An X appears in the selected
cell.
You can reconfigure a door/input/relay by double clicking in
the appropriate cell:
If you select a bundled door, the Door dialog box appears.
If you select an expansion relay, the Expansion Relay
Configuration dialog box appears.

Standard Control Zones

Standard Control Zones (SCZ) link a time zone with any combination of available relays
for output control or inputs for alarm control. In this way, a SCZ can be used to
designate when and which input can be masked, or when and what relay controlled.
A single control zone contains one time zone with up to 8 Door Inputs/Relays, 16
Expansion Inputs, or 64 Expansion Relays.
Control Zones can be best visualized as a table with columns for control zone, time
zone, door input/relays number, and expansion input/relay number.
 A time zone is used to designate when an available relay or input is
activated by a card or code. The time zone does not effect the triggering
of a control zone by an input or an alarm.
Standard control zones merely associate a given relay, input, or reader with a specific
time interval. The task of controlling them is left to the master control zone that
designates the control or access/Alarm function required. Since line module (inputs)
and relays (outputs) share a common address on a SCZ, the function required for
either the input or output is indicated by the master control zone: either it actuates a
set of relays or masks a set of line modules. For example, say you have defined SCZ2
as including control point 1. This can be either Relay 1 or Input 1. However, once SCZ
is incorporated into an MCZ which specifies that this control zone will be utilized for
Conditional Unmask, it becomes obvious that Input 1 is involved, not Relay 1.
Control Zones can be triggered by cards at a reader or relays (for cascade control), a
change in occupancy count, a specific ACB, or many other events.
In Velocity, 192 Standard Control Zones (SCZ1 - SCZ191) are available. Only one SCZ,
SCZ0, is predefined: <No Control> which indicates ‘no relays and no inputs at any
time.’
Defining Standard Control Zones
To define one or more standard control zones to a controller's database:
1. From the system tree pane, right click the controller whose SCZs you want to
define.
An option list appears.
2. Select Properties. The Controller Properties screen appears.
3. Click the Control Zone tab.
The Controller Control Zone Page appears.

Controllers 117
Velocity Version 3.1 Administrator’s Guide

4. Click the Edit Control Zones... button.

The Standard Control Zone Properties sheet appears. For more on the available
options, refer to “Standard Control Zones Property Sheet” on page 113.
5. Select the row of the control zone you want to edit. The CZ number is identified by
the 'CZ#' column. The range is 0 - 191 where CZ0 is reserved for No Control,
Never.
6. At the cell intersecting the 'CZ Name' column and the required CZ row, click and
enter a name for the control zone.
7. At the cell intersecting the 'Time Zone' column and the required CZ row, click the
combo box and select a time zone from the drop-down list during which the
selected objects are triggered. Select from one of these options:
• Select one of the available time zones.
• Select <New> to bring up the standard time zone property sheet and define
a new time zone for this purpose.
• Select <Always> to indicate that this SCZ is always in effect.
• Select <Never> to indicate that this SCZ is never in effect.
8. Click in the cell of each point (object) you want to associate with this SCZ.
These objects include all base and expansion points supported by the specific
controller.
The number of base points depends on the type of controller defined here. For
example, an M1 or M2 have base points 1 - 4. An M8 will display base points 1 -
8. M16 and MSP do not support any base points, only expansion points. Each base
point identifies both an input and relay point. For example, base point 1 is
associated with both Input 1 and Relay 1.
Points X1 - X64 identify expansion inputs and relays. If no expansion boards are
included in this controller, these points are considered virtual relays and can still be
used. Points X1 - X16 not only identify expansion inputs and expansion relays 1 -
16, it also identifies the base readers 1 - 16, where X1 - X8 identify entry readers
and X9 - X16 identify their complementary exit readers.
See “Dual Technology” on page 152 for more information.
 Readers are associated in Velocity with the points X1 - X16 for reasons of
consistency as much as anything else.

There are no Hirsch controllers that identify more than eight base points
and it became confusing to identify some of the system's readers using
base points and the rest using expansion points. In an effort to make it
more logical, Velocity programmers decided to group all the possible
readers in a sequence starting with X1 since there were more than
enough expansion points to form a series of sixteen.
To associate these points with this SCZ:
a. Click in the cell intersecting the required SCZ row with column of the point you
want to associate with this control zone.
An X appears in the cell. To deselect the point, just click again and the X
disappears.
b. To change the properties of the relay, input, or reader associated with this point,
right click in the cell and an option list appears. Make one of these selections:

118 Controllers
 MAN006-0612

• Select Input Properties... to bring up the Input Properties sheet and make
changes to the settings as required. If this is an expansion point, the Expansion
Input Properties sheet appears.
• Select Output Properties... to bring up the Relay Properties sheet and make
changes to the settings as required. If this is an expansion point, the Expansion
Relay Properties sheet appears.
• Select Reader Properties... to bring up the Reader Properties sheet and
make changes to the settings as required. This property sheet only appears if
you are clicking in the X1 through X16 cells.
c. If needed, click to select the cell intersecting the required SCZ row and the Tag
column.
This marks the SCZ as tagged.
d. If needed, click to select the cell intersecting the required SCZ row and the Alert
column.
This marks the SCZ as alerted.
9. Repeat Steps 5 – 8 for each SCZ you want to define.
10. When you're finished, click OK twice to return to the main Velocity screen.
11. Download these changes to the relevant controller.
12. Once you have defined as many SCZs as you require, you must put them to work
by defining master control zones.

Master Control Zones

Master control zones (MCZs) are a compilation of standard control zones. Using MCZs,
a qualified operator can create sophisticated control routines that can be triggered by
either a single control code entered at any authorized ScramblePad/MATCH reader or a
line module input or relay.
One common use of this feature is to put a single facility, or area within a facility, into
night or day operation mode with a single code entry. For instance, the last person
leaving a building that is equipped with an M8 controller and 16 expansion line module
inputs, could unmask all alarms, lock all doors, shut down the elevator system, shut off
the HVAC, and lock down the vault room with a single ‘Night Code’ at the building's exit
ScramblePad/MATCH reader.
To define MCZs, use the procedure outlined in “Defining Master Control Zones” on
page 120.
 Before you can create a master control zone, you must first create one or
more standard control zones.

For more on this, refer to “Defining Standard Control Zones” on page

117 and “Control Zones: How to Define” on page 110.
Standard control zones only associate points with time zones incorporating relays,
readers, and inputs. The Master control zone indicates how the SCZ should use its
elements by identifying a control or alarm function to be used on that SCZ. The action
invoked, such as Trigger or Force OFF Release, indicates not only the function to be
used but also the point(s) it should be used on.
For example, by specifying that the action Mask is being used on an SCZ that includes
the points Relay8 and Input8, it tells the program that only Input8 is involved; however,
if the action is Unlock, both Relay8 and Input8 are involved since Relay8 must be
unlocked while Input8 is masked.

Controllers 119
Velocity Version 3.1 Administrator’s Guide

For more on these function, refer to “Functions” on page 241.

You can make all defined MCZs effective for all controllers connected to the same XBox
by selecting the 'Enable Global MCZ' feature in the Options section on the Controller
Setup page. Then select the 'Broadcast Globally' box on the Master Control Zones
page.
You can also map a specific MCZ to a global ID that enables any controller connected
to the same XBox to recognize an MCZ created by a single controller.
Defining Master Control Zones
To add one or more master control zones:
1. If you haven't already, create one or more standard control zones.
2. At the Control Zones property sheet, click the Master Control Zones tab.
The Master Control Zones Property Sheet appears.
3. At the 'MCZ #' combo box, select a number for this MCZ from the drop-down list.
The program automatically displays the next available MCZ number; however, you
can choose to assign another number if you prefer.
The range is 192 – 255.
4. At the 'Name' text field, enter a name for the new MCZ, such as 'MCZ196' or
'Shutdown for Evening'.
5. At the 'Description' text field, enter a description of this new control zone. This step
is optional.
6. At the 'Time Zone' combo box, select an option from the pull-down list.
Your selections include:
• A list of all previously-defined time zones
• <New> that enables the operator to create a new time zone by displaying
the standard time zone properties dialog box.
• <Always> indicating that this MCZ is always active
• <Never> indicating this MCZ is not active.
7. At the 'Set Threat Level To:' combo box, select the threat level from the drop-down
option list above which this MCZ is triggered.
Select N/C to indicate that no threat level is required. Threat level values are in the
range 1 – 99. The default is N/C.
8. Check the 'Tag' box to indicate that this MCZ is tagged when triggered. The default
is no tag.
9. Check the 'Alert' box to indicate that this MCZ generates an alert when triggered.
The default is 'no alert'.
10. From the 'Map to Global ID' combo box, select an ID that links this MCZ to another
MCZ with the same global ID.
For more on this, refer to “Linking Master Control Zones” on page 121.
11. Check the 'Broadcast Globally' box, if required. This alerts all controllers on the
same XBox when this MCZ is triggered.
For more on this, refer to “Linking Master Control Zones” on page 121.
12. From the Action matrix, select an action you want performed by the SCZ.
13. Click the cell that intersects the 'Control Zone' column with the 'Action' row. A
combo box appears.
14. Click the down arrow, , to display a list of all SCZs.
The available range is CZ0 – CZ191 where the default is CZ0, <No Control>.

120 Controllers
 MAN006-0612

15. Select the SCZ you want to associate with this action. The control points assigned
to this SCZ are indicated by Xs in the relevant cells.
16. Repeat Steps 12 – 15 for each action you want this MCZ to perform.
To remove previously-defined actions, select the cell that intersects the action's row
and the Control Zone column and specify <No Control>.
To modify a currently-selected SCZ, return to the Standard Control Zones property
sheet and modify the SCZ as required. Any modifications made are reflected in
MCZs that incorporate that SCZ.
17. When you're finished, click OK.
18. Download the new MCZ definition to the relevant controller.
Linking Master Control Zones
One of the most powerful features in Velocity is the ability to link multiple MCZs even
across multiple controllers. In effect, this enables a qualified operator to define a
cascade of actions that occur.
This is accomplished using two new features:
 Global ID
 Global Broadcasting
The Global ID enables a qualified operator to link MCZs, even across multiple
controllers connected to the same XBox. This, in effect, enables the triggering of actions
across more than one controller. It does this by mapping different MCZs to the same
global ID. Two or more MCZs can be mapped to the same global ID.
For example, create MCZ192 and assign it Global ID 1. Now define MCZ193 and
MCZ197 and assign both Global ID 1. Once this is done, Velocity recognizes that if
MCZ192 is triggered, MCZ193 and MCZ197 are also triggered.
Similarly, if MCZ193 is triggered, then both MCZ192 and MCZ197 are also triggered.
The same goes for MCZ197 which triggers both MCZ192 and MCZ193.

Global IDs can also link MCZs across multiple controllers.

 MCZs can only link across multiple controllers if the controllers are
connected to same XBox. A controller connected to XBox 1 cannot
communicate with a controller connected to XBox 2.
For example, create MCZ192 on Controller 1 and assign it Global ID 2. In addition,
enable this MCZ for broadcast globally. Then define MCZ193 and MCZ197 on
Controller 2 and assign both Global ID 2 as well. The system then knows that if

Controllers 121
Velocity Version 3.1 Administrator’s Guide

MCZ192 on Controller 1 is triggered, MCZ193 and MCZ197 on Controller 2 are also

triggered. In this way, you can trigger a cascade of actions across the multiple
controllers.

In this scenario, MCZ197 can trigger MCZ193 (since they are defined for the same
controller) but neither of these MCZs cannot trigger MCZ192 since that is defined on a
different controller. Only MCZ192 is enabled for global broadcast so the cascade is
unidirectional.
You could make triggering bidirectional by enabling either (or both) MCZ193 and
MCZ197 for global broadcast. In this scenario, if you enable MCZ197 for broadcast
globally then triggering MCZ197 would trigger both MCZ193 (since it is located on the
same controller and is assigned the same global ID) and MCZ192 (since Controller 1
would receive the broadcast from Controller 2).

Both global broadcasting and global map IDs are specified through the Master Control
Zone property sheet as detailed starting on page 115.

122 Controllers
 MAN006-0612

Hint For simplicity, in our previous examples we have assigned each MCZ a different
number, even across multiple controllers. This is not normally the case. In complex
systems with many master control zones, it is common practice to use the same
MCZ number on multiple controllers, so that, for example, Controller 1 can define
an MCZ192 and Controller 2 can define another MCZ192. Velocity can recognize
and use both in the same operation as long as they are united by a common
Global ID.

LED Enabling
Two of the available Master Control Zone actions are LED On and LED Off. These
actions enable the MCZ to turn on or off designated LEDs on the ScramblePad readers
that are associated with that MCZ.
To activate an LED associated with a reader and designate a specific LED on that
reader, follow this procedure:
1. Define one or more Standard Control Zone associated with one or more readers.
2. Click to check any reader(s) whose LEDs you want to turn on or off in this way. The
LEDs that will actually be turned off or on are determined by the expansion point
you activated, in this manner:

ScramblePad LED Expansion Points

LED 1 Red X1 - X16

LED 2 Green X17 - X32

LED 3 Yellow X33 - X48

LED 4 Yellow X49 - X64

In this arrangement, X1/X17/X33/X49 could be assigned to Reader 1,
X2/X18/X34/X50 could be assigned to Reader 2, and so on all the way up through
Reader 8 (if it exists).
3. Define a Master Control Zone.
For more on this, refer to “Defining Master Control Zones” on page 120.
4. In the Master Control Zone matrix, go down the Action column until you see the
LED On and LED Off actions.
5. In the Control Zone column, assign the SCZ you just defined to the right of either
the LED On or LED Off action.
• To turn an LED on, select the LED On action
• To turn an LED that is already lit off, select the LED Off action
The points associated with the selected SCZ appear to the right of the Control Zone
column.

Controllers 123
Velocity Version 3.1 Administrator’s Guide

Controller Alarm Actions Page

The sixth page on the Controller Configuration sheet is the Alarm Actions page. This
page defines and modifies alarm actions (ACBs) available through this controller.

For more on alarm actions, refer to “Alarm Actions” on page 126.

Use the Alarm Actions page to specify:
 when alarms will occur (based on inputs)
 whether a host computer at a remote site will be notified
 which types of alarms will be logged
 what actions will occur when an alarm takes place
The Alarm Actions page is a large page involving many columns and rows. For most
monitors you can only see all the columns and rows by using the vertical and
horizontal scroll bars on the bottom and right side of the table. Most of the items to the
right of the Description column contain drop-down option lists. The options on this list
typically can include the <Always> and <Never> conditions, in addition to a list of the
currently-defined zones for that action: time zones (referred to here collectively as TZn)
or control zones (referred to here as CZn).
The fields and buttons on this page are defined below:

Define Alarm Actions window

# Lists all currently applicable Alarm Action numbers. This list is

for display only and cannot be modified. Use the down scroll
bar to scroll the list.

Description Lists all defined alarms. This list is for display only and cannot
be modified. Use the scroll bar to scroll the list.

124 Controllers
 MAN006-0612

General TZ Defines during which time zone the on-board alarm is

triggered for each alarm type.
Duress TZ
Each column has a drop-down option list which includes:
Tamper TZ • <Always> = Alarm is always triggered when alarm action
occurs.
Trouble TZ
• <Never> = Alarm relay is not triggered when alarm action
occurs.
• TZn = Select from an existing time zone during which time
this alarm is triggered when the specified alarm action
occurs.
Default is <Always> for General TZ and <Never> for the
other three alarm types.

Dialout TZ Defines whether the system dials the host (at the central site)
when an alarm action occurs during the specified time zone.
The time zone options include:
• <Always> = Host is dialed when alarm action occurs.
• <Never> = Host is not dialed when alarm action occurs.
(Default)
• TZn = Select from an existing time zone during which time
this the system can dial the host when the specified alarm
action occurs.

Log TZ Defines whether the designated alarm action is logged during

the specified time zone. This controls whether logging takes
place at:
a local printer (if one is installed)
the system’s internal alarm and event buffer memory
the host at the central site
Use the column to change whether or not logging will occur.
The drop-down options include:
• <Always> = Alarm is logged when alarm action occurs.
(Default)
• <Never> = Alarm is not logged when alarm action occurs.
• TZn = Select from an existing time zone during which time
the alarm is logged when the specified alarm action occurs.
Note: If an alarm is not logged, it will not be available later when
Velocity compiles reports.

Controllers 125
Velocity Version 3.1 Administrator’s Guide

Trigger CZ Causes Velocity to trigger a specified Control Zone when this

alarm action occurs. The triggered CZ performs whatever
actions it is set to do as soon as the alarm action occurs.
The options are:
• <No Control> = No CZs are triggered (default)
• CZn = the specified CZ is triggered when this alarm action
occurs
If triggering a control zone is not required, leave the CZ setting
at the default, 0 <No Control>.

CZ Off Causes Velocity to turn the specified control zone control off
for the specified alarm action.
The available options are:
• <No Control> = No CZs are triggered (default)
• CZn = the specified CZ is triggered when this alarm action
occurs
If you don't want to turn off control zone control for this action,
leave the CZ setting at the default, 0 <No Control>.

Undo Changes Click this button to undo any modifications you have made to
the current alarm actions and return to the previous settings.

Restore Click this button to undo all modifications made to the alarm
Factory actions since Velocity was last installed and return to the
Defaults original factory default settings.
Warning: Only use this option if you are sure you want
the original settings. All settings changed since the
defaults will be erased.

Alarm Actions
To make programming of complex sequences easy, Velocity includes Alarm Actions,
also called Alarm Control Blocks (ACBs). Alarm Actions are used to produce results
based on specific conditions, not just the state of line module input.
There are more than three hundred and eighty alarm actions predefined for each of the
base/expansion inputs and outputs, as well as internal events, such as low battery and
firmware-based alarms such as duress and passback violation. There are also discreet
alarm actions for each of the line module inputs, such as Alarm, Door Open Too Long
(DOTL), and Tamper.
Each alarm action can be assigned to trigger a Control Zone or initiate a Dial Host
command in a Remote Site Management application.
For a complete list of ACBs, see “Alarm Control Blocks (ACBs)” on page 128.
Alarm Actions are viewed and modified through the Controller Alarm Actions Page
(page 124).
For specific instructions on modifying an alarm action, see Changing Alarm Actions
(page 127).

126 Controllers
 MAN006-0612

Changing Alarm Actions

Velocity enables you to customize alarm actions through the controller dialog box.
To change the function of an alarm action:
1. Access the controller whose alarm actions you want to customize.
The Controller dialog box appears.
2. Click the Alarm Actions tab.
The Alarm Actions page appears.
3. Select the action you need to modify and click in the column requiring change
(alarm relay TZs, dial, logging, etc.).
The selected cell turns into a combo box.
4. Click the down arrow, , and a drop-down option list appears.
5. Select the option that most closely fits the condition you are trying to create.
6. Modify as many columns as you need to customize the alarm action to your
specifications.
7. Go to the next alarm you need to change and repeat steps 4 - 6.
8. If you make a mistake, click the Undo Changes button at the bottom of the table
to return to the previous settings.
If you need to return to the original factory settings for all the alarm actions, click
the Restore Factory Defaults button.
9. When you're finished with your modifications, click OK.
The changes are made to the controller.

Alarm Types
Hirsch DIGI*TRAC controllers have four dedicated alarm relay types.
Controllers—including the M1N, M2 and M16—that possess a single base alarm relay,
can use the same physical alarm relay to trigger any of the four alarm types. All other
Hirsch controllers—including the M8, MSP-8R, and MSP-16R—that possess four
separate alarm relays, assign a different alarm relay to each alarm type.
These alarm types are:

Alarm Relay
Triggered By:
Type

General • Door Forced or Held Open

• Input Tamper
• Input Shorted
• Noisy, Open, or Out-of-Spec circuit
• Occupancy and Passback violations
• Deadman Timer expired

Duress • Users entering codes with a duress digit

Tamper • Box Tamper

• ScramblePad/MATCH Reader Physical Tamper
• Code Tampering

Controllers 127
Velocity Version 3.1 Administrator’s Guide

Trouble • Power Failures

• Battery Problems
• Network Inactive
• Keypad, MATCH, Printer and Modem Off-Lines
• Report Buffer Threshold Exceeded
• Tag Alerts

 These alarms are the defaults and can be changed using the Controller's
Alarm Actions page. For more on this, refer to “Controller Alarm Actions
Page” on page 124.

Alarm Control Blocks (ACBs)

ACBs are how Hirsch DIGI*TRAC systems create if-then alarm-initiated control
sequences. ACBs now support the ability to trigger a control zone when the alarm
condition is removed (secured), as well as when the alarm occurs. Further, all ACBs can
now be individually enabled based on time zones.
In addition to the hundreds of existing ACBs, the CCM 7.0 adds the following new
ACBs:
 Expansion Inputs 17 to 32
 RQE
 DOTL Warning (Pre-Alarm)
 Line Fault per Input
 Tagged User per Door
 User Denied per Reader
 Access Denied for new access-denied types
There is also a report enabling you to review only ACBs that are not at factory default;
this can be helpful for troubleshooting.
The Action Control Block (ACB) input mappings are shown in the table on page 129.
The table below lists the number of each ACB together with a description and the
default alarm type. In addition, it indicates whether the default for this ACB triggers a log
entry, what control zone is default for this ACB, and what 'state' this ACB produces.
 The Default Alarm Type column indicates the type of controller onboard alarm relay
triggered by the ACB in its default state. This doesn't mean the ACB can only trigger
that alarm relay—only that this alarm relay is programmed by firmware to always
trigger in response to this ACB. The ACB can always be changed to trigger a different
type of onboard alarm relay and at any time zone required.
 The Log TZ column indicates whether the ACB always generates a log entry when it
occurs or not. This can be changed to any defined TZ, including <Never>.
 The Trigger CZ column indicates whether the ACB triggers a control zone. In every
case, the default setting is 0 (No Control). However, this can be changed to any
control zone defined by Velocity.
 The CZ Off column indicates when an ACB causes Velocity to turn control zone
control off for a specified SCZ or MCZ. The default is always 0 (No Control),
however this can be changed to any control zone (standard or master) required.

128 Controllers
 MAN006-0612

 The State column does not appear in the Alarm Actions matrix but indicates
whether the ACB can be triggered on or whether it can be both triggered on and off
(hold). If an ACB is only triggered on, and is therefore temporary, no indication is
provided in this column. If the ACB can be both triggered on and released from
triggering, it is indicated by the word 'hold.' This means the ACB can be sustained
for a duration specified by the program.
ACB Mappings

Default
Trigger CZ
ACB # Description Alarm Log TZ State
CZ Off
Type

1-8 Alarm Input 1-8 general alarm Always 0 0 hold

9-16 Alarm Input 1-8 DOTL/AATL general alarm Always 0 0 hold

17-24 Alarm Input 1-8 Tamper general alarm Always 0 0 hold

25-40 Expansion Alarm Input 1-16 general alarm Always 0 0 hold

41-56 Expansion Alarm Input 17-32 general alarm Always 0 0 hold

57-64 Alarm Input 1-8 DOTL/AATL Always 0 0 hold

WARN

65-72 Alarm Input 1-8 RQE/MRQ Always 0 0 hold

73 Occupancy Violation general alarm Always 0 0

74 Line-Shorted (Alarm Input general alarm Always 0 0

shorted)

75 Duress duress alarm Always 0 0

76 Enclosure Tamper tamper alarm Always 0 0 hold

77-92 Kpd 1-16 Physical Tamper tamper alarm Always 0 0 hold

93-108 Kpd 1-16 CODE Tamper tamper alarm Always 0 0 hold

109 Tag Alert trouble alarm Always 0 0

110 Line Noise (Alarm Input noisy) general alarm Always 0 0

111 Keypad Offline trouble alarm Always 0 0

112 Parallel Printer Offline trouble alarm Always 0 0 hold

113 Serial Printer Offline trouble alarm Always 0 0 hold

114 Passback Violation general alarm Always 0 0

115 UPS Fail trouble alarm Always 0 0 hold

116 AC Fail trouble alarm Always 0 0 hold

117 Membat Fail (Memory Battery trouble alarm Always 0 0 hold

bad)

118 UPS Low trouble alarm Always 0 0 hold

Controllers 129
Velocity Version 3.1 Administrator’s Guide

Default
Trigger CZ
ACB # Description Alarm Log TZ State
CZ Off
Type

119 Line Out-of-Spec (Alarm Input general alarm Always 0 0

out-of-spec)

120 Line Open (Alarm Input open) general alarm Always 0 0

121 Network Offline (Network trouble alarm Always 0 0 hold

inactive)

122 Entry Delay Warning Always 0 0

123 2-Person-Rule Violation tamper alarm Always 0 0

124 Exit Delay Warning Always 0 0 hold

125 Modem Offline trouble alarm Always 0 0 hold

126 Report Buffer Full (Report trouble alarm Always 0 0

Buffer threshold)

127 MATCH Reader Offline trouble alarm Always 0 0

CODE Denial Alarms:

128 Denied: restricted reader Never 0 0

129 Denied: invalid CODE Never 0 0

130 Denied: restricted access zone Never 0 0

131 Denied: restricted control zone Never 0 0

132 Denied: restricted temporary Never 0 0

days

133 Denied: passback violation Never 0 0

134 Denied: access CODE Never 0 0

overridden at relay

135 Denied: Use-Count Exceeded Never 0 0

136 Denied: Absentee Limit Count Never 0 0

Expired

137 Denied: Access Override by Never 0 0

Sgl-Zone

138 Denied: Program Override Never 0 0

139 Denied: Override by max user Never 0 0

count

140 Denied: Two-Person rule Never 0 0

incomplete

141 Denied: Incomplete Dual, no Never 0 0

COTZ

130 Controllers
 MAN006-0612

Default
Trigger CZ
ACB # Description Alarm Log TZ State
CZ Off
Type

142 Denied: Can't unmask active Never 0 0

inputs

143 Deadman Timer Expired Always 0 0

144 - 159 Local Duress at reader 1-16 Never 0 0

160 - Tagged User at Door 1-8 Always 0 0

167

More CODE Denial Alarms:

168-183 Denied: Restricted Reader Always 0 0

1-16

184 Reserved Never 0 0

185 Reserved Never 0 0

186 Denied: Invalid CARD Data Always 0 0

187 Reserved Never 0 0

188 Reserved Always 0 0

189 Reserved Never 0 0

190 Denied: Bad PIN (good card) Never 0 0

191 Denied: Unknown CODE Never 0 0

192 Denied: Value Error Never 0 0

193 Denied: Duress Never 0 0

194 Denied: Threat Level Never 0 0

195 Denied: Reader Disabled Never 0 0

196 Denied: Code Tamper Lockout Never 0 0

197 Denied: Reserved Never 0 0

198 Denied: User Disabled by Never 0 0

Code Tamper

199 Denied: Restricted Access Never 0 0

Zone

200 - 207 Alarm Input 1-8 Line Fault Never 0 0 hold

208 - 223 Expansion Alarm Input 1-16 general alarm Always 0 0 hold
DOTL/AATL

224 - 239 Expansion Alarm Input 17-32 general alarm Always 0 0 hold
DOTL/AATL

240 - 255 Expansion Alarm Input 1-16 general alarm Always 0 0 hold
Tamper

Controllers 131
Velocity Version 3.1 Administrator’s Guide

Default
Trigger CZ
ACB # Description Alarm Log TZ State
CZ Off
Type

256 - 271 Expansion Alarm Input 17-32 general alarm Always 0 0 hold
Tamper

272 - 303 Expansion Alarm Input 1-32 Never 0 0 hold

Line Fault

304 - 335 Expansion Alarm Input 1-32 Always 0 0 hold

DOTL/AATL WARN

336 - 367 Expansion Alarm Input 1-32 Always 0 0 hold

RQE/MRQ

368 - 383 Reserved tamper alarm Always 0 0 hold

To print a list of all ACBs that have changed from their default settings, refer to the ACB
report example.
You can also generate a report of all ACBs using the Velocity Diagnostic Window. For
more on this, refer to “Diagnostic Window” starting on page 703.

Controller Communications Page

The seventh page of the Controller Configuration dialog box is the Communications
page.

This page is used to configure three SCRAMBLE*NET values:

 Set the S*NET timeout
 Reset the controller S*NET network
 Reset the S*NET encryption key

132 Controllers
 MAN006-0612

These values are included to enhance the security of the controller's connection with
the Velocity host.

SNET Specify the number of seconds the controller waits before timing
Timeout out a connection with the host. After connection with the host, if
no data is received within this amount of time, the connection is
dropped.
The default value is 10 seconds.

Network If required, enter a network password for this controller.

Password Each controller has an initial password provided at the factory. This
allows any host to connect to this controller once the controller
uploads the initial password information; however, Velocity has the
ability to change the default password so that any other potential
hosts cannot connect to the controller.

Default If required, enter a new encryption key.

Encryption This feature is provided for those facilities that have proprietary
Key encryption keys and do not want to use the Hirsch-provided
encryption.

Randomize Click this button to randomize the password and/or encryption key.
This avoids the possibility of any patterns.

Default Click this button to revert to the factory default for this password
and/or encryption key.

Download Monitor
The Download Monitor enables the operator to monitor pending downloads and
cancel them, if necessary. This agent resides in the Velocity tray (status line).
To view the download monitor:
 Double click the Download Monitor icon, , on the Velocity status
line.
For more on the status line, refer to “Status Line” on page 26.
The Download Monitor appears like this example:

Only the current download tasks appear in this monitor. As each task is downloaded
successfully, it disappears from the window.

Controllers 133
Velocity Version 3.1 Administrator’s Guide

This screen includes these columns:

Identity The download number assigned to the download. Velocity

increments each new download by one.
This is the same number Event Viewer displays for the download
event, such as “Download 59XX Completed Successfully”.
If an Identity of 0 appears, this is a request for a download that has
no information to send, such as a download of credentials before
any people have been added. Aborting this download does not
remove it; it disappears only after you have stopped and restarted
the DIGI*TRAC services.

Controller The name of the controller to which Velocity is downloading this

instruction.

Start Time The date and time when the download was ordered.
Start Time only shows if the Download Monitor is open when the
download is first requested.

Status The current status of the download. The current status of the
download. There are three states reported:
Queued—the download is scheduled but not yet started
Active—the download is currently running
Cancelled—the download has been cancelled

Description A brief description of the download, such as ‘Define Door’ or

‘Define Users’.

Count The number of DIGI*TRAC commands in the download.

Completed The number of segments already downloaded.

Progress The percentage of the download that has been accomplished.

Errors The number of errors experienced by Velocity while attempting the

download.

To remove a pending download task from the monitor:

1. In the Download Monitor window, right click on the task you want to delete.
A pop-up menu list appears.
2. Select Abort Download.
If this download is currently in progress (the status is Active), this command
cancels the download to the controller. If the download is queued, the request for
download is deleted and this download will never occur.
Aborting a download can result in mismatched settings
between Velocity and the controller. In order to correct this
you will have to either restart the download or upload the
controller settings.
Select Cancel This Menu to close this pop-up option list without doing anything.
The pending task is deleted and removed from the window.

134 Controllers
 MAN006-0612

Dial-Up Configuration
Velocity offers a means for connecting to remote controllers by way of a host's modem.
Velocity supports dialup for the following configurations:
 SNET to a remote SNIB designated as the Master for the SNET channel
 SNET from a remote SNIB designated as the Master for the SNET channel
 Call-back to a remote SNIB designated as the Master for the SNET channel
 Modem pool to utilize more than one modem across all dialup locations
 Scheduling of dialup operations
 Configurable dialup preferences
 Automation of establishing connection for programming and scheduled operations
The type of modem used as well as the speed and protocol required for the
connection are defined by the Dialup Location Properties screen discussed starting on
page 139.
 In order to use Velocity's dial-up capabilities, you must have a modem at
both ends of the connection. Make sure that the host modem and
remote modem are compatible.
Remote connections must be via the Hirsch SNET protocol: this means that the remote
modem must be connected directly to at least one controller via its SNIB as shown in
this illustration:

Velocity supports encryption via SNET. Windows authentication or encryption schemes

are not supported because the hardware side is not a member of a Windows network.
Currently, Hirsch sells and supports two types of modems:
 MultiTech Multi-Modem MT2834 Series (Hirsch #EM9600-DL)
 Zoom 14.4 Pocket Modems (Hirsch #DM96-10708)
Before you can communicate successfully, you must first:
1. Connect the MultiTech host modem to an available serial port on the back of the
Velocity server or workstation.
2. Connect the Zoom 14.4 remote modem to the required controllers through an
XBox.
3. Configure the host modem in Windows.
4. If needed, configure both modems using HyperTerminal.
5. Set up Velocity to communicate with both modems.
Each of these steps is described in the next section, “Connecting Modems” on page
136.
For more information on these matters, refer to the Velocity 3.1 Installation Guide.

Dial-Up Configuration 135

Velocity Version 3.1 Administrator’s Guide

Connecting Modems
Modems connect the host PC to the SNIB on the remote controller in the following
way:

To do this:
1. Set the MultiTech modem’s DIP switches to this:

SW1 UP SW5 DOWN SW9 DOWN SW13 UP

SW2 UP SW6 UP SW10 UP SW14 UP

SW3 DOWN SW7 DOWN SW11 UP SW15 UP

SW4 UP SW8 DOWN SW12 DOWN SW16 DOWN

2. Using a RS-232 serial cable, connect the MultiTech modem to an available COM
(serial) port on the Velocity host.
If you don’t have an available serial port on your computer, you can either install a
serial board, like a DigiBoard, to provide more serial ports, or connect the USB port
on your computer to the modem via a USB-to-serial adapter.
3. Using an RS-232 serial cable, connect the Zoom 14.4 modem to the SNIB board
on the Hirsch controller.
Make sure that the SNIB on the first remote controller is set to Address 1. To do
this, set these switches on the first SNIB:

SW7-11 OFF

SW12 ON

4. If this is a dial-up installation, set your SNIB’s SW3 to ON.

Make sure the SNIB’s MD1 and MD2 jumpers are strapped to the left.
You can daisy-chain additional controllers off of this first controller using RS-485;
however, the first controller’s address must be set to 1.

Modem Setup on Windows

Once physical connections are completed, the modems must be added to the
operating system (Windows 2000/XP).
To do this:
1. At the Windows desktop, select either Start > Control Panel (if this is Windows
XP) or Start > Settings > Control Panel (if this is Windows 2000).
The Control Panel appears.

136 Dial-Up Configuration

 MAN006-0612

2. Select Phone & Modem Options.

The Phone & Modem Options screen appears.
3. Select the Modems tab.
The Modems page appears.
4. Click the Add... button.
The Add Hardware Wizard appears.
5. Check the ‘Don’t detect my modem...’ box.
This enables you to specify the modem you require without any auto-detection.
6. Click Next. The Install New Modem screen appears.
7. From the Manufacturer list, select the manufacturer.
• If this is the MultiTech mode, EM9600-DL, select MultiTech Systems.
• If this is the Zoom 14.4 modem, DM9600, select Zoom Telephonics.
• If you are using another modem, refer to your modem user guide for
information.
8. From the Modem list, select the model representing the model of this modem.
• If this is the MultiTech, select MT2834BA.
• If this is the Zoom 14.4, select 14.4 EX.
• If you are using another modem, refer to your modem user guide for
information.
9. Click Next. The COM port selection page appears.
10. Select the COM port to which this modem is connected from the window.
11. Click Next. The Wizard concludes the installation.
12. Reboot the computer.
The computer updates the Registry and other files.
If this method does not succeed in enabling the host and remote modems to
communicate with each other, you must then use HyperTerminal. For instructions on
using this, refer to the Velocity 2.5 Installation Guide.

Modem Setup on Velocity

Once you have connected the modems you need and configured Windows to use the
modem, you can set up Velocity to communicate with the modem.
To configure Velocity for a dial-up modem:
1. In the system tree pane, click to highlight the Dial-Up folder.
A screen like this example appears:

Dial-Up Configuration 137

Velocity Version 3.1 Administrator’s Guide

Notice that both the Add New Location and Modem Pool Settings options appear
in the Components pane.
2. In the Components pane, double click the Modem Pool Settings option.
The Modem Pool Settings dialog box appears.
3. In the Modem Pool Settings dialog box, check the modems you want for this task,
then click OK.
4. In the Components pane, double click the Add New Location option.
The Dialup Location Properties screen appears.
5. Enter the values required to define this modem connection.
6. Click OK to confirm you selection.
The new connection appears under the Dial-Up folder in the System Tree pane as
well as in the Components pane.
7. Once you have dialed up and connected to the required controller(s), define each
remote controller and its connected devices, you can return to the Dialup Location
Properties screen to define the Remote Settings.
8. From the Components pane, double click on the newly-created dial-up location.
The Dialup Location Properties screen appears with the Remote Settings tab
activated.
9. Click the Remote Settings tab.
The Remote Settings pages appear.
If required, define the settings and characteristics for the remote modem. You must
configure the remote modem if you plan to provide that modem with dial-in
capabilities.
If you only plan to dial out to remote controllers from the host, you may not need
to configure the remote modem.
10. When you're finished, click OK.
Both the host modem and remote modem should now be configured.
Status is not available from the Status Viewer unless there is a current dial-up
connection. If Velocity needs to dial up the connection before seeking status, Velocity
will disconnect from the location after two minutes and status will not be accurate.

Dial-Up Configuration: Modem Pools

Before you can define host and remote settings for dial-up modems, you must first tell
Velocity which modems in your system the program can use for its purposes.
Many businesses use multiple modems for dial-in access to remote sites. Velocity can
use any of these lines once one or more modems are designated as a pool. Velocity
automates the process of using the next available modem, providing more than one
modem is available to the system.
 Dedicated lines are excluded from this list.
To assign one or more modems to a Velocity modem pool:
1. At the Administration system tree window, expand the DIGI*TRAC Configuration
folder until the Dial-Up folder appears.
2. Click on the Dial-Up folder.
The available options appear in the components window.
3. From the components window, double click the Modem Pool Settings option.

138 Dial-Up Configuration

 MAN006-0612

The Modem Pool dialog box appears like this example:

Only those modems installed in this Velocity computer (and detected by Velocity)
are displayed in the window.
4. Click to check one or more modem pools from the window.
5. If required, click Advanced to go to access the Advanced Port dialog box.
For more on this dialog box, refer to “Advanced Port Settings” on page 66.
6. Click OK.
Before you can select modems from the Modem Pool dialog box, you must first
configure your computer for these modems. If you have a system administrator,
consult him/her about this. If you are the system administrator, use the following
procedure:
1. From Windows desktop, select Start > Settings > Control Panel.
2. At the Control Panel, select Phone and Modem Options.
3. At the Phone and Modem Options dialog box, click the Modems tab.
4. Click Add... and configure a new modem for this system.
5. Follow the Install New Modem wizard.
Before proceeding, make sure you have already connected one or more modems
to your computer or to the network to which your computer is connected.
When you're finished, the new modem appears in the Phone and Modem Options
window.
6. Repeat Steps 4-5 for every modem connected to this computer/network.

Dialup Location Properties: Host Settings

This screen indicates the behavior of the host modem. The dialup location properties
dialog box looks like the following example:

Dial-Up Configuration 139

Velocity Version 3.1 Administrator’s Guide

Initially only the Host Settings page is activated. The Remote Settings page is only
activated once the dial-up connection has been defined and the remote controller(s)
have been reached.
The Host Settings page contains the following fields and buttons:

Name: Enter the name you want for this connection. For best results,
use a name that describes the settings, such as 'Salt Lake
factory' or 'Building 6 controllers'.

Modem Settings

Baud rate: Either enter or select from the drop-down option list, the correct
baud rate for this modem. The default is 9600; however,
speeds up to 38,600 are supported.

Phone Enter the phone number where the remote modem is located.
number: The remote modem must be connected to the controller
before a connection is possible between the host and the
remote controller.

Redial Click the up or down spin button to specify the number of

attempts: times the modem attempts to dial the remote modem before
giving up and issuing an alarm notice.

Dedicated line: Enter the name of the dedicated line connected to this
modem. If the dedicated line is already defined, select from the
combo box pick list.
This field is only applicable to installations where dedicated
lines are connected to the modem. If this is a normal phone
line, leave this field blank.

Enabled Check this box to indicate that the modem is currently enabled
and can be used at any time.

Register CCM's Click this button to register the CCM on the remote controller
bearing SNIB address 1. This must be done in order to identify
the remote controller contacted when the remote modem is
dialed.

Once the remote controller with SNIB address 1 is identified and connected to this
modem, the Remote Settings page can be accessed.

Dial-Up Location Properties: Remote Settings

The Remote Settings page includes two subpages: Dialing and Time Zones.

140 Dial-Up Configuration

 MAN006-0612

The Dialing page looks like this example:

The fields on this screen include:

Line type: Click either the Tone or Pulse radio button to indicate
whether the line is tone or pulse.

Host phone Enter up to four phone numbers this remote modem can
numbers: use to dial up the host. This assumes that the remote
modem is dial-in or dial in/out. Numbers must include the
area codes but must exclude parentheses or hyphens.

Buffer threshold Click the spin buttons to indicate the number of alarm
to dial host events the controller must record before the remote
modem dials the host.
For information on setting up this feature, refer to “Buffer
Threshold Setup” on page 144.

Redial attempts: Click the spin buttons to specify the number of attempts the
remote modem makes to the host if the host is busy. The
default is 254 attempts.
For example, assume you set redial attempts to 4. Then if
the controller has an alarm for which it is set to call the host
but the host does not answer, the controller will try again 4
more times (for a total of 5 tries) before giving up.
To specify a time zone during which the redial takes place,
refer to the Time Zone subpage.

Disconnect and Check this box to indicate that the remote modem will
call host back on disconnect from a dialup location when the host calls the
dial in remote site. The remote modem then calls back.

Dial-Up Configuration 141

Velocity Version 3.1 Administrator’s Guide

The Time Zones subpage looks like the following example:

This page indicates the conditions under which the remote modem can dial into the
host modem.
The fields on this screen include:

Dial host at From the drop-down combo box option list, select the time zone
start of Time at the beginning of which the remote modem must call the host.
Zone To create a new time zone for this purpose, select <New> from
the list. The default is <Never>.

Attempt From the drop-down combo box option list, select the time zone
redial at start at the beginning of which the remote modem attempts to call the
of Time Zone host. If the first redial attempt is unsuccessful, the remote
attempts a second redial when this time zone becomes active
again. The remote repeats this process until either the host is
contacted or the remote exceeds the number of redial attempts
stipulated in the 'Redial Attempts' field on the Host Settings
Dialing subpage discussed on page 139.
Note: The remote only makes one attempt at the start of the
designated time zone. If that attempt fails, it must wait for the
designated time zone to come around again.
If, between the time it tries to dial and the next time the time
zone is active, the remote dials out or is dialed into for any other
reason, the alarms will be downloaded and it will not call the host
at the beginning of the specified time zone.
For example, if you set this field to a time zone that starts at 4
p.m., the controller makes an attempt to dial the host at 4 p.m. If
it fails to connect, the remote will redial the host at 4 p.m. on the
next night defined by this time zone. This process continues until
it finally connects and downloads its alarms, or exceeds the redial
attempts.
To create a new time zone for this purpose, select <New> from
the list. The default is <Never>.

142 Dial-Up Configuration

 MAN006-0612

Cancel From the drop-down combo box option list, select the time zone
Dial-Host during which the remote modem cancels any automatic dialup
during Time attempts to the host.
Zone To create a new time zone for this purpose, select <New> from
the list. The default is <Never>.

Disable From the drop-down combo box option list, select the time zone
answer during which the remote modem will not answer any calls from
during Time the host.
Zone To create a new time zone for this purpose, select <New> from
the list. The default is <Never>.

Postpone From the drop-down combo box option list, select the time zone
Dial-Host during which the remote modem ignores the normal event
during Time triggering function. Any calls to the host must wait until the end of
Zone the time zone.
To create a new time zone for this purpose, select <New> from
the list. The default is <Never>.

Connection and Buffer Controls

Once you have installed a dial-up system, you can control it from right-click options at
the dial-up modem.
To do this:
1. Expand the DIGI*TRAC Configuration folder.
The Dial-Up Folder appears.
2. Expand the Dial-up folder until the host modem symbol appears, .
3. Right click on this modem symbol.
A list of options pops up. These options include the following:

Connect Select this option to connect the host modem to its remote
modem. The Velocity workstation and remote controllers are
connected.

Disconnect Select this option to disconnect the host modem from its
remote modem. All Velocity data between the Velocity
workstation and remote controllers stops.

Open Buffer Select this option to manually open the buffer. You can use
this in lieu of the Auto Disconnect Option found on the Host
Settings page.
For more on buffer control, refer to “Buffer Threshold Setup”
on page 144.

Close Buffer Select this option to manually close the buffer. You can use
this in lieu of the Auto Disconnect Option found on the Host
Settings page.
For more on buffer control, refer to “Buffer Threshold Setup”
on page 144.

Dial-Up Configuration 143

Velocity Version 3.1 Administrator’s Guide

Delete Select this option to delete the currently installed host

modem from the Velocity system.

Rename Select this option to rename the currently installed host

modem.

Properties Select this option to bring up the Dialup Location Properties

sheet. For more on this, refer to “Dialup Location Properties:
Host Settings” on page 139.

4. Select the option you require.

Buffer Threshold Setup

To set up the buffer threshold to dial host:
1. In one of the 'Host phone numbers' fields, enter a valid callback phone number
from the remote site to the Velocity host modem.
2. In the 'Buffer Threshold to Dial Host' field, enter the number of alarm events
required to dial the host back.
The maximum allowed is 1700 events.

Hint We recommend that initially you set this to 1600 events. You can lower or raise
this setting as required.

3. Set ACB 126 to dialup host by time zone. To do this:

a. From the System Tree pane, right click on the controller connected to the
remote modem.
The controller you select is defined through the process set forth in Step 6 of
the Dial-Up Configuration instructions.
b. Select Properties.
The Controller properties pages appear.
c. Click the Alarm Actions tab.
d. Scroll down to ACB 126 - Report Buffer Threshold.
e. Click in the DialoutTZ column and select an available time zone option from the
pick list.
Select either <Always> or a predefined TZ.
f. Click OK.
g. Download the updated configuration.

144 Dial-Up Configuration

 MAN006-0612

Doors
In Velocity, a door is defined as a group of devices which can control access between
two areas physically divided by a door. The components normally involved in defining a
door are:
 Door: the physical door itself.
• Relay: the lock or strike that locks/unlocks the door.
• Input: the sensor that detects whether the door is open or not. An input can
also be an RQE.
• Reader(s): the input devices including keypads and/or readers employees
use to request entry to or exit from an area. Hirsch controllers support several
ScramblePad keypads and many different types of readers including magnetic
stripe, proximity, and biometric.
These three components – Relay, Input, and Reader – must be present in any Velocity
definition of a door.
Several possible door arrangements are shown in the following examples:

Doors: How to Configure

To configure an existing door:
1. At the system tree window, click on the controller whose door(s) you want to
configure.

Doors 145
Velocity Version 3.1 Administrator’s Guide

All doors appear in the components window. Currently defined (bundled) doors
are identified by a checked box.
2. In the components pane, double click on the door you want to configure.
Alternatively, right click on the selected door and select Properties from the
drop-down option list.
The Door Configuration dialog box appears.
3. Modify the General page as required.
4. Click the Entry Reader tab.
The Entry Reader page appears.
5. Make changes to the entry reader page as required.
6. If this door has been configured for entry and exit readers on the General page,
click the Exit Reader tab.
The Exit Reader page appears.
7. Make changes to the exit reader page as required.
8. Click the Relay tab.
The Relay Page appears.
9. Make changes to the relay page as required.
10. Click the Input tab.
The Input Page appears.
11. Make changes to the input page as required.
12. When you're finished, click OK to return to the system tree.

Unbundling Doors
Inputs, relays, and readers are initially bundled in doors for the M1N, M2, and M8
controllers; however, these doors can be broken (unbundled) into their constituent
parts.
 You can only unbundle doors for M1N, M2, or M8 controllers.
To break an existing door into its component parts:
1. In the system tree window, select the controller whose doors you want to break
apart.
2. Expand the controller to reveal the Doors folder.
3. Select the Doors folder. All doors appear in the components window.
Those doors that are currently bundled as doors have a check in the box to their
left as shown in the following example.

4. In the components window, uncheck the box of each door you want to break
apart.

146 Doors
 MAN006-0612

The components comprising the affected controller change to reflect the

redistribution of input, reader, and relay definitions. For example, if you unchecked
Door 01, then the Relay folder would gain an extra Relay, Relay 01, the Input folder
would regain a new relay, Relay 01, and the Reader folder would now display an
additional reader, Reader 01. If this door supported both an entry and exit reader,
then a second reader would be added to the Reader folder, Reader 09.
5. Reconfigure each input, reader, and relay as required to reflect its new task.

Bundling Components to Create Doors

If you have unbundled a door, you can reassemble it using the following procedure.
To reassemble (rebundle) a door from existing input, relay, and reader components:
 You can only create doors if you are working with M1N, M2, or M8
controllers.
1. Select the controller you want to use from the system tree window.
2. Expand the controller components to show the doors components. The doors
check boxes appear in the Components window.
3. Find the unchecked door option in the components window and check it.
4. Reconfigure the door as described in “Doors: How to Configure” on page 145.

Door Configuration Properties

When you first configure a controller, the number of doors Velocity displays in the
components pane depends on which controller type you select.
The M1N displays 1 door. The M2 displays 2 doors; for M8 it is 8 doors. The M16 and
MSP are not designed for door access and do not support doors as a default; for this
reason, these controllers do not initially display any doors under the Doors folder
although doors can, in fact, be added to these controllers by bundling inputs, relays,
and readers together as required.
If you are using an M1N, M2, or M8, the component pane displays doors as shown in
the following example:

This example shows the initial configuration for an M2 designated as Controller 1.

While the Inputs and Relays folders are also listed in the system tree window, these
folders contain no components, at least initially. In addition, the Readers folder is
shown; however, the first few entry readers (Reader 01 - Reader 04) are initially
bundled with the doors so they do not appear in the components window; only the
exit (the ‘other-side-of-the-door’) readers are displayed – Reader 09 for Reader 01,

Doors 147
Velocity Version 3.1 Administrator’s Guide

Reader 10 for Reader 02, Reader 11 for Reader 03, and so on right up to Reader 16 in
the case of the M2. At least one input, one relay, and one reader are required to define
each door.
To the left of the door icon in the component window a checkbox appears. If this box is
checked, it indicates that the system currently recognizes a number of inputs, relays,
and readers as doors. When unchecked, the door is unbundled, meaning the input,
relay, and reader previously associated with the door are no longer dedicated to that
function and can be reassigned for other duties.
In fact, there are many situations in which an M8, for example, will be used for fewer
doors than it can support with the rest of the inputs and relays allotted to other uses
such as CCTVs, motion detectors, annunciators, AC actuation, and so on.
To provide this flexibility, Velocity enables the operator to:
 configure existing doors (see page 145)
 break up (unbundle) doors (see page 146)
 regroup (rebundle) doors (see page 147)

Door Properties Dialog Box

The Door Properties dialog box consists of either four or five pages, depending on
which selection you make in the Direction section of the General page:
 General
 Entry Reader
 Exit Reader (this page only appears if you select the Entry & Exit Readers option)
 Relay
 Input
Each page enables the operator to configure all the basic security components for the
door.

148 Doors
 MAN006-0612

Door Properties: General Page

The first page of the Door Properties dialog box looks like this example:

This page includes these fields:

Door Name Either accept the default door designation or enter a short
name for this door. It can be any combination of
alphanumeric characters, but the more descriptive the better,
such as 'Front Door 1' or 'Lab Door 1'.

Direction

Entry Reader Click this radio button to indicate that this door only includes
Only an entry reader. No exit reader is required at this door.
This is the default setting.

Doors 149
Velocity Version 3.1 Administrator’s Guide

Entry & Exit Click this radio button to indicate that this door includes both
Readers an entry and exit reader. This pairing of an entry and exit
reader on the same door is called Dual Technology and is a
frequently used configuration for high-security areas.
An exit reader page is added to this screen like the example
below.

If you specify this option, the requisite exit reader is removed

from the readers folder and is automatically associated with
the default entry reader. For example, if you select this option
for a door that includes Reader 01, then it is automatically
associated with the first available exit reader, Reader 09.
For more on entry and exit reader associations, refer to “Dual
Technology” on page 152.

Auto-Relock – Changes automatic re-locking. Auto-relock automatically relocks the

electric lock and re-arms the door position switch without waiting for the door
access time to expire. It also allows extended access times to accommodate users
who take longer to pass through the door.

On Open Click this radio button to relock and unmask (re-arm) when
door is opened. (Default)

On Close Click this radio button to relock and unmask (re-arm) when
door is closed.

Disable Click this radio button to disable the auto-relocking feature.

Options

Enable two Check this box to enable two-person rule for this door.
person rule

Report door Check this box to indicate that when this door is unlocked too
open too long long it is reported as a DOTL alarm.
when unlocked

150 Doors
 MAN006-0612

Extended Access Timers (minutes)

Extended Use the spin control buttons to specify the number of

Access Override minutes this door can allow extended access before
Time overriding.
The maximum is 1440 minutes. For more on this, refer to
“Extended Access Timers” on page 154.

Extended Use the spin control buttons to specify the number of

Access Warning minutes this door allows for a warning interval during
Time extended access. This causes the ScramblePad to beep a
warning and optionally trigger an ACB from the warning event.
The warning time can set from 0 – 15 minutes.

Photo Callup

Template Select the badge template you want to display every time a
credential goes through this door. The photo object
associated with each credential pops up for the number of
seconds specified in the Delay field.
Only those badge templates currently defined for this system
appear in the drop-down list. The default value is <None>,
indicating that no template appears and photo callup is no
enabled. In order to display a photo as part of your credential
data, you must select a badge template that includes a photo
object.
You can also enable this feature by selecting the Auto
Display Credentials option (see page 156). If you select
<None> here, it automatically deselects the Auto Display
Credentials right click option. For more on this, refer to
“Doors: Enabling Credential Auto Display” on page 156.
This badge template selection overrides any selection you
might make on the General Preferences page (see page 45).
If no badge template is specified here, then the badge
template selected on the General Preferences page is used.

Delay Enter the number of seconds a credential is displayed before

it disappears.
The default is 0 seconds (indefinitely). If you specify 0
seconds, then the credential remains on the screen until you
exit it manually.

Hint Normally you will want to specify a duration for a

credential other than 0. Having to click the exit
button every time you want to hide a credential is
time-consuming, especially when dozens of
credentials are popping up at a well-traveled door.

Doors 151
Velocity Version 3.1 Administrator’s Guide

Dual Technology
Dual technology indicates that a door includes two or more keypads/readers for access
authentication. For example, when a door possesses a ScrambleProx and card reader
on the entry side. While these readers are frequently located on the same side of the
door, this is not required.
 Velocity supports readers with two distinct technologies, such as Prox
and Magstripe.
Velocity supports dual technology with these features:
 Code Tamper on Dual—Code Tamper supports disabling of a credential. This
feature is useful for lost or stolen cards where the card is 'good' but the PIN is 'bad'
at a Dual Technology reader.
Check the ‘Code Tamper Disables User’ box on page 201.
 Unknown Cards on Dual—Normally, a Dual Technology reader scrambles the
ScramblePad display on presentation of an enrolled card and waits for the PIN;
however, if the card is unknown, the controller will reject it immediately.
 Trailing Zeroes on Dual—Trailing zeroes are recognized discretely for the PIN of a
dual user.
This means that a PIN code used for dual such as 56780 is recognized by the
controller database to be different from 5678 or 567800.
 Inhibit Dual in CCOTZ Mode—To allow certain doors to use just a card or just a
code on dual readers at certain times and to require both the card and code at
other times, Hirsch uses a CCOTZ (Card or Code Only Time Zone) mode.
When in the CCOTZ mode, dual is not required at dual readers. This feature works
nicely with threat levels, since CCOTZ can be turned off based on an increased
Threat Level, thus requiring Dual usage.
 Validate on Dual CCOTZ—Delays access denied at dual technology doors during
specified TZs and only for specific IDFs. For more on this feature, refer to the
“Controller Setup Page” on page 88.
 Valid Immediately CCOTZ—Denies or grants access for certain dual technology
doors during specified TZs and only for specific IDFs. For more on this feature, refer
to the “Controller Setup Page” on page 88.
Dual Technology is defined through the Credential Properties ‘IDF’ field (see page
864). Any person assigned a dual-technology credential must use both his/her code
and card at those doors possessing keypads and card readers.
When you specify dual technology for readers on a door, you need to pair these
readers. Here are the entry and exit reader associations:

Entry Reader Associated Exit Reader

01 09

02 10

03 11

04 12

05 13

152 Doors
 MAN006-0612

06 14

07 15

08 16

Dual Technology: Validation During IDFs

Two of the more confusing features in Velocity deal with controller setup for CCOTZ
dual reader technology: Validate on Dual CCOTZ and Validate Immediately
CCOTZ. Both of these features are explained more fully on this page.
Validate on Dual CCOTZ
This feature performs these functions:
 At a dual technology reader that is not in CCOTZ and has not been set to Validate
on Dual, an unregistered or invalid card will be immediately denied due to bad
code.
 At a dual technology reader that is not in CCOTZ and has been set to Validate on
Dual, an unregistered or invalid card will scramble the keypad to ask for a code. It
sends this information to the host to determine whether the credential will be
granted or denied.

Hint This feature was originally created for MOMENTUM users and has little real
efficacy in Velocity. Because it delays denial of access at dual technology stations, it
can serve to disorient or confuse an illegal user who has stolen a large bunch of
cards: the illegal user cannot tell whether he is being denied because of an invalid
card or an invalid code.

Validate Immediately CCOTZ

This feature performs these functions:
 Immediate CCOTZ means that a dual technology reader in CCOTZ acts as a card
reader and as a keypad, but not both. Dual code access is not allowed.
 At a dual technology reader that is in CCOTZ and has not been set to Validate
Immediately, IDF 3 and IDF 5 are both granted access with dual IDF.
 At a dual technology reader that is in CCOTZ and has been set to Validate
Immediately, IDF 3 is denied. IDF 3 does not have the option of using card only or
code only.
 At a dual technology reader that is in CCOTZ and has been set to Validate
Immediately, IDF 5 is denied when trying to use dual. If IDF 5 uses code only, it is
granted access.
This feature was created for Version 6 CCM users who are use to CCOTZ meaning that
either card only or code only users can use the dual technology, but not dual users.
The following table showing how Velocity treats dual technology stations at each IDF for
both features.

Dual Reader, not CCOTZ Dual Reader, CCOTZ

IDF Credential Validate on Validate on Validate Validate

Type Dual (off) Dual (on) Immediately (off) Immediately (on)

1 CODE    

Doors 153
Velocity Version 3.1 Administrator’s Guide

Dual Reader, not CCOTZ Dual Reader, CCOTZ

IDF Credential Validate on Validate on Validate Validate

Type Dual (off) Dual (on) Immediately (off) Immediately (on)

2 CARD    
3 DUAL    Incomplete Dual

4 CARD Scramble Scramble  

DUAL   (card) (card)
5 CODE Incomplete Incomplete  
Dual Dual

DUAL   Incomplete Dual Incomplete Dual

6 CODE    
CARD    
7 CODE Incomplete Incomplete  
Dual Dual

CARD Scramble Scramble  

DUAL   (card or code) (card or code)
Bad CARD Bad Code Scramble Bad Code Bad Code
Card
Legend:
= access granted.
(card) = Access Grant already occurred with a card. The dual was irrelevant.
(card or code) = Access Grant already occurred with a card or code. The dual was irrelevant.
Scramble = Presenting a card causes the keypad to scramble and wait for a code.
Incomplete Dual = Access Denied. Either the time zone or the technology requires a dual credential.
Bad Code = Access Denied. The card presented was not in the system.

Extended Access Timers

An operator can adjust the Door Mode Timer for extended unlock and/or masking
time. This is ideal for airport jetway doors or evening conference rooms, where
propping the door open is a normal condition for limited, requested times.
In Velocity, a person's credential must be enrolled as an 'Extended Access' type. A
person with this privilege on their credential can select the number of minutes of
extended time by entering their PIN followed by an asterisk (*) followed by the desired
number of minutes (up to 1440 minutes or 24 hours).
For example:
2364*12
This would specify that the qualified person with the PIN code 2364 would be able to
keep a door open for 12 additional minutes before it needs to be locked.

154 Doors
 MAN006-0612

To return the door to its normal timers, enter the PIN code (with or without 0 for the
minutes) or enter any valid access code. Reset the extended access to a longer time
anytime.
The extended access feature includes a warning signal that indicates the extended
unlock/masking time is near an end. This warning time can be set to a value of 0 to 15
minutes per door. The warning will activate beeping of the ScramblePad. An Alarm
Action Control Block (ACB) can also be triggered from the warning to initiate other
control functions.
The number of minutes remaining on extended access can be displayed on more
recent DS47L ScramblePads (date code 990618 or later).
 This revision began shipping in June 1999. The revision can be
confirmed by pressing the # and * keys at the same time, which will
present an alternating display of all 8's (all LED Segments) and the
revision date with the two digit year on top, the two digit month in the
middle, and the two digit day on the bottom.
If required, you can display the current progress of the countdown on the validating
keypad:
1. At the validating keypad, bring up the entry or exit reader properties.
2. Select the ScramblePad Options tab.
3. Check the 'Use Keypad numeric LEDs as annunciator' box.
The reader selected to annunciate must be a DS47 with a date code of 990618 or
later.
4. Select the person to whom the extended access function will be assigned.
5. Add a new or existing credential to this person.
6. Click the Function tab to display the function page.
7. At the 'Function Category' combo box, select Access.
8. At the 'Function' combo box, select Extended.
9. At the 'Door Group' combo box, select a door group that includes the reader you
have qualified for display.
10. Click OK.
Now, when the qualified person or operator enters the card/code at this keypad, the
countdown appears on the keypad LEDs. For example, if you have selected 4 minutes
as the extended access time, the display would count down in this fashion:
 At four minutes, the reader displays 004 to indicate 4 minutes remain on the timer.
 At three minutes, the reader changes to a display 003 to indicate 3 minutes remain.
 At two minutes, the reader display changes to 002 and there is a two-minute
warning beep.
 At one minute, the reader display changes to 001 and there is a one-minute
warning beep.
 At zero minutes, the reader display clears, the warning timer beeps, and the relay
turns off after an additional time specified by the associated door relay's 'Door
mode time' setting (the default is 6.00 seconds).
Extended Access works with the Auto Relock feature so if the door is closed, the
remaining unlock time will be set to zero and the door will be secured.

Doors 155
Velocity Version 3.1 Administrator’s Guide

Doors: Enabling Credential Auto Display

Credential auto display (also called photo call-up) enables you to view a photograph,
signature, name, or other relevant information for a person entering or exiting a
designated door.
Once enabled, a window appears every time Velocity issues an Access Granted or
Access Denied for the specified door in the Graphics module.
To enable credential auto display for a door:
1. From the Velocity Administration module, expand the system tree until the Doors
folder is displayed.
2. Click to highlight the Doors folder.
The available bundled doors appear in the Components pane.
3. Right click the door in the Components pane you want to enable for photo call-up.
A pop-up option list appears.
4. Select Auto Display Credentials.
The next time you right click on this door you'll notice that this option is checked.
This door is now enabled for credential auto display.
The way in which the credential is displayed on the screen and how long it remains
displayed depends on which badge template you select from the Door General
properties page. (For more on this, refer to “Door Properties: General Page” on page
149.)

Door Properties: Entry Reader Page

The second page of the Door Properties dialog box looks like this example:

This page is divided into three property sheets:

 General Property Sheet (see “Reader General Property Sheet” on page 195)
 ScramblePad Options Property Sheet (see “Reader ScramblePad Options Property
Sheet” on page 199)
 Logic Property Sheet (see “Reader Logic Property Sheet” on page 202)

156 Doors
 MAN006-0612

Door Properties: Exit Reader Page

If you select the Entry & Exit Readers radio button on the Door General page, the Exit
Reader page appears like this example:

This page is divided into three subpages:

 General Property Sheet (see “Reader General Property Sheet” on page 195)
 ScramblePad Options Property Sheet (see “Reader ScramblePad Options Property
Sheet” on page 199)
 Logic Property Sheet (see “Reader Logic Property Sheet” on page 202)

Door Properties: Relay Page

The Relay page contains two property sheets:
 Door Relay Setup property sheet (page 157)
 Door Relay Logic property sheet (page 160)

Door Relay Setup Property Sheet

The relay setup property sheet looks like this example:

Doors 157
Velocity Version 3.1 Administrator’s Guide

This sheet contains the following fields:

Relay Name Enter a short name for this relay, such as 'Lab3 Relay2' or 'Door
Strike for Door3.' The more specific it is, the easier it is to identify it.

Normal States – The resting state of the relay

Energized Click this radio button to indicate that during its normal or resting
(LED On) state the relay is energized.

De-energized Click this radio button to indicate that during its normal or resting
(LED Off) state the relay is de-energized.

Timers

Door Mode Click the spin buttons to specify the seconds this relay is actuated
time before returning to its resting state. This field is incremented or
decremented in quarter seconds.
For example, if you specify a Momentary Access of this relay, the
relay clicks open then waits this number of seconds before closing
again.
The door timer is momentary with an adjustable time of 1 – 8,100
seconds. It can also toggle its relay on and off on consecutive
access codes or RQE entries if the time is set to 0 (zero) seconds.
A relay's door timer is used by both access codes and RQE input.
The default time is 6 seconds.

Door Delay Click the spin buttons to specify seconds this relay is delayed from
time being actuated. This field is incremented or decremented in quarter
seconds.
The door delay timer is used for special entrance or exit control
applications and is granted only for special credentials. The timer
can be delayed from starting after a granted code, RQE, or time
zone actuation.
The delay duration can be set in the range 1 – 8,100 seconds. This
is especially useful for implementing delayed exit on emergency
doors where local building codes permit such controls to be
installed. It is also useful for bank vaults, where unlock delays after
correct codes are sometimes required.
The default time is 0 seconds.

158 Doors
 MAN006-0612

Control Click the spin buttons to specify the seconds this relay is actuated
mode time before returning to its resting state. This field is incremented or
decremented in quarter seconds. For example, if you specify a
Momentary Mask, this is the number of seconds the door masks its
alarms before unmasking again.
The control timer is momentary with an adjustable time of 1 to
8,100 seconds. A relay's control time is used by Control Zone
trigger codes as well as by line module inputs or relays that trigger
control zones.
The default time is 6 seconds.

Control delay Click the spin buttons to specify seconds this relay is delayed from
time being actuated. This field is incremented or decremented in quarter
seconds.
Use the control delay timer for special control applications to delay
the start of the control timer for any relay from starting after a
granted code, alarm trigger, or relay trigger.
The delay can range from 1 – 8,100 seconds.
The default time is 0 seconds.

Door Delay Time

The door delay timer is used for special entrance or exit control applications. It delays
the actuation of a door's relay for a specified number of seconds after ingress or egress
is requested. The request can come in the form of a granted code, RQE, or time zone
actuation. For example, if you set the door delay timer to 5 seconds, the door will not
unlock for five seconds after a person has punched in the correct code at the door's
keypad.
This timer is especially useful for implementing delayed exit control on emergency
doors, where local building codes permit such controls to be installed. It is also useful
for bank vaults, where unlock delays after correct codes are sometimes required.
The delay duration can be set in the range 1 - 8100 seconds. The default value, 0
(zero), sets the delay timer to no delay.
The door delay time is set at the Door Properties Relay Setup property sheet (page
157).

Doors 159
Velocity Version 3.1 Administrator’s Guide

Door Relay Logic Property Sheet

The door relay logic property sheet looks like this example:

This property sheet contains these fields:

Time Zones

Actuate during Select an option from the drop-down list to designate during
time zone which time zone this door relay is actuated. The door relay can
only be actuated during the specified time zone. If an attempt is
made to actuate this door's relay at any other time, the relay does
not actuate.
Accept the default, <Never>, to specify that this door relay is
disabled. Select <New> to create a new time zone for this
purpose. Select <Always> to indicate that this door relay is
actuated during the specified time zone.

Disable during Select an option from the drop-down list to designate during
time zone which time zone this door relay is disabled. The door relay
becomes disabled at the start of the time zone and is re-enabled
at the end of the zone. This relay can be actuated at any other
time.
Accept the default, <Never>, to specify that this door relay is
never disabled. Select <New> to create a new time zone for this
purpose. Select <Always> to indicate that this door relay is
always disabled.

160 Doors
 MAN006-0612

Auto-clear after Select an option from the drop-down list to designate at the end
time zone of which time zone this door relay is automatically cleared. The
current state of any door relay can be auto-cleared at the end of a
time zone to ensure the automatic reversal of a code-activated
door relay without the need for a manual resetting of the door
relay.
This feature will not affect door relays controlled by a code of
higher priority than a time zone, such as Lock Down and Lock
Open.
Accept the default, <Never>, to specify that this door relay is
never auto-cleared. Select <New> to create a new time zone for
this purpose. Select <Always> to indicate that this door relay is
always auto-cleared.

Control Zones

Trigger relays in Designates that while this door relay is actuated, it triggers relays
control zone in the control zone specified in the drop-down list.
Select from the list of available SCZs. If no trigger is required,
accept the default <No Control> option.

Retrigger relays Designates that while this door relay is actuated, the relays in the
in control zone control zone specified in the drop-down list are retriggered.
Select from the list of available SCZs. If no trigger is required,
accept the default <No Control> option.

Door Properties: Input Page

The Input page of the Door Properties dialog box is subdivided into three property
sheets:
 Door Input Setup property sheet
 Door Input Logic property sheet
 Door Input State Change Reporting Sheet

Doors 161
Velocity Version 3.1 Administrator’s Guide

Door Input Setup Property Sheet

This property sheet determines the initial characteristics of the specified door input.

The following fields are available:

Input Enter a short name for this door input, such as 'Lab3 door input2'
Name or 'Door3 door input1.' The more specific it is, the easier it is to
identify it.

Enabled Check this box to specify that the input is active and connected.

Line Select from the drop-down list the line module type to which this
Module door input is connected.
The options are: DTLM1/MELM1, DTLM2/MELM2, and
DTLM3/MELM3.
For a description of these line modules, refer to “Line Modules” on
page 184.

Normal State When Secure

Normally Click this radio button to indicate this door input is open when
Open secure.
Only one of these two options can be selected at a time.

Normally Click this radio button to indicate this door input is closed when
Closed secure.
Only one of these two options can be selected at a time.

RQE Click this box to indicate this door input is or includes a Request to
Enabled Exit device such as a button or bar.
When this is selected, the next four radio buttons are activated.

162 Doors
 MAN006-0612

Trigger Check this box to mask the alarm associated with this RQE for a
Mask Only specific period of time. Once the time is up, the alarm associated
with the RQE is unmasked.

Trigger Check this box to trigger the door's corresponding relay and mask
Relay and the alarm associated with this RQE for a specific period of time.
Mask Once the time is up, the alarm associated with the RQE is
unmasked.

Retrigger Check this box to mask the alarm associated with this RQE for as
Mask Only long as the RQE is active.

Retrigger Check this box to retrigger the door's corresponding relay and
Relay and mask the alarm associated with this RQE for as long as the RQE is
Mask active.

Timers

Door Mode Use the spin control buttons to specify the seconds (incremented
time in quarter seconds) this door input can be masked before an
alarm is triggered.

DOTL time Use the spin control buttons to specify the seconds allowed before
a DOTL alarm is triggered.

DOTL Use the spin control buttons to specify the seconds allowed for a
Warning DOTL warning before this door input issues a DOTL alarm.
time For example, if you specify 30 seconds as the DOTL time and 5
seconds as the DOTL Warning time, then 25 seconds after the
door input is activated, a warning is activated.

Entry delay Use the spin control buttons to specify the seconds allowed for the
time entry reader's delay time beyond the normal specified. For more
on this, refer to “Door Delay Time” on page 159.

Exit delay Use the spin control buttons to specify the seconds allowed for the
time exit reader's delay time beyond the normal specified. For more on
this, refer to “Door Delay Time” on page 159.

Report Check this box to report a DOTL condition when the door is
DOTL when unlocked.
unlocked

Mask Check this box to mask the tamper alarm even when the door
tamper contact is masked.
when door This box is only active when the line module is DTLM3/MELM3.
contact
masked

Doors 163
Velocity Version 3.1 Administrator’s Guide

Door Input Logic Property Sheet

The Door Input Logic property sheet looks like this example:

The following fields are available:

Time Zones

Mask during Select an option from the drop-down list to designate during
time zone which time zone this door input is masked (disarmed). Accept
the default, <Never>, to specify that this input is never masked.
Select <New> to create a new time zone for this purpose.
Select <Always> to indicate that this input is always masked.

Disable entry Select an option from the drop-down list to indicate during which
delay during time zone the entry reader's delay timer for this door is disabled.
Accept the default, <Never>, to specify that this input's entry
delay time is never disabled. Select <New> to create a new
time zone for this purpose. Select <Always> to indicate that
this input's entry delay time is always disabled.

Control Zones

Actuate relay Select a SCZ from the drop-down list during which the relays
in control associated with this SCZ are actuated by this door input.
zone To actuate a control zone means to actuate its relays for as long
as the alarm is active and release them the moment the alarm
stops. Relay timers are ignored when actuation occurs.
The default, <No Control>, indicates that this input does not
actuate a relay.

Disable relay Select a SCZ from the drop-down list during which the SCZ's
in control associated relays are disabled by this door input. The relays are
zone disabled while the alarm is active. Once it returns to normal, the
disabled state is cleared.
The default, <No Control>, indicates that this input does not
disable a relay.

164 Doors
 MAN006-0612

Trigger relays Select a SCZ from the drop-down list during which the SCZ's
in control associated relays are triggered by this door input.
zone To trigger a control zone means to start the zone's relay control
timers at the moment the alarm occurs. The relay timers will start
and time out even if the alarm stays active.
The default, <No Control>, indicates that this input does not
trigger a relay.

Retrigger Select a SCZ from the drop-down list during which the SCZ's
relays in associated relays are retriggered by this door input. To retrigger
control zone means that the relay timers are not started until the alarm event
is over.
The default, <No Control>, indicates that this input does not
retrigger a relay.

Door Input State Change Reporting Property Sheet

The State Change Reporting subpage looks like the following example:

The following fields are available:

Select All Click this button to check all the options on this page. By default, all
boxes are unchecked.

Deselect Click this button to uncheck all the options on this page.
All

Enable Contact State Change Reporting

Door Check this box to indicate that this input's door contact signal is
Contact reported whenever it changes state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Doors 165
Velocity Version 3.1 Administrator’s Guide

RQE Check this box to indicate that this door input's RQE signal is
reported whenever it changes state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Tamper Check this box to indicate that this door input's tamper signal is
reported whenever it changes state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Line Fault Check this box to indicate that this door input's line fault signal is
reported whenever it changes state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Enable Mask State Change Reporting

Door Check this box to indicate that Velocity will report if this input was
Relay masked/unmasked because of a door relay change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

RQE Check this box to indicate that Velocity will report if this input was
masked/unmasked because of an RQE change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Entry/Exit Check this box to indicate that Velocity will report if this input was
Delay masked/unmasked because of an entry or exit delay change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Unlock Check this box to indicate that Velocity will report if this input was
masked/unmasked because of an unlock change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Time Zone Check this box to indicate that Velocity will report if this input was
masked/unmasked because of a time zone change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Control Check this box to indicate that Velocity will report if this input was
Code masked/unmasked because of a control code change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

You must enable state reporting for each door input placed on a Designer map. For
more on this, refer to “Placing Objects on Drawings” on page 605.

166 Doors
 MAN006-0612

Relays
Relays (Outputs) are those remote devices—like magnetic locks, electric strikes, and
audible signals—that are operated by relays in the controller. Hirsch controllers provide
Door Relays. Door Relays are the large heavy-duty relays found on the M2 and M8
controllers. These are normally used to switch power to output devices requiring a lot
of electricity such as electric locks, electric strikes, and electric turnstiles. For example,
an M2 includes two door relays while the M8 includes eight door relays.
In addition, Hirsch controllers also support Control Relays. These are smaller,
lighter-duty relays and are normally used for auxiliary control applications or operation
of remote heavy-duty relays. These are used to switch equipment on or off—either
directly or indirectly using intermediate relays—such as power or lighting circuits. In
some cases, such as elevator control, control relays enable/disable floor buttons by
providing discrete signals to the elevator control panel.
Hirsch provides a relay expansion board (REB8) that adds up to eight of these control
relays per board. Hirsch also sells the M64 that supports a maximum of 64 control
relays. All relays connected to an REB8 are considered expansion relays.
Velocity normally bundles door relays with inputs and readers to form a pre-defined
door. However, a qualified operator can unbundle these doors, if required, to create
non-door relays.
For configuration instructions, refer to “Relays: How to Configure” on page 167.
If this relay is bundled with a door, refer to “Doors: How to Configure” on page 145.
Use the Relay Properties dialog box to set up each relay connected to this controller
that is not part of a door. Such relays are normally associated with control functions,
such as HVAC and elevator operation, not door access.
 Relays associated with doors are discussed in “Door Properties: Relay
Page” on page 157.

Relays: How to Configure

To configure a non-door relay:
1. From the system tree window, select the controller whose relay you want to
configure and expand that tree.
2. Click to highlight the Relays folder in the hardware tree window.
All relays currently recognized by this controller appear in the components window.
3. From the components window, double click on the relay you want to configure.
The Relay Properties dialog box appears.
4. Configure the relay as required.
5. When you're finished, click OK.

Relay Properties Dialog Box

This dialog box is divided into two property sheets:
 Relay General Property Sheet
 Relay Logic Property Sheet
Each is described on the following pages.

Relays 167
Velocity Version 3.1 Administrator’s Guide

Relay General Property Sheet

The relay general property page looks like the following example:

This property sheet contains the following fields:

Name Enter a short name for this relay, such as 'Lab3 Relay2' or 'Door
Strike for Door3.'
The more specific it is, the easier it is to identify it.

Normal States (Select one)

Energized Click this radio button to indicate that during its normal or
(LED On) resting state the relay is energized. When the relay is in its
normal state, the LED associated with the relay is ON.
This is the normal state for Fail Secure mechanisms. This
effectively inverts the meaning of the outputs: the
normally-open contact becomes the normally-closed contact.
For example, when controlling elevators, change the relays to
energized. This ensures that if the control system power fails,
the relay coil will be de-energized, thus allowing the elevator to
be used.

De-energized Click this radio button to indicate that during its normal or
(LED Off) resting state the relay is de-energized. When the relay is in its
normal state, the LED associated with the relay is OFF.
This is the normal and default state for Fail Safe mechanisms.

Timers

Control mode Click the spin buttons to increase or decrease the seconds this
time relay is actuated before returning to its resting state. This field is
incremented or decremented in quarter (0.25) seconds.
The control timer is momentary with an adjustable time of 1 to
8,100 seconds. A relay's control time is used by CZ trigger
codes as well as by a line module input or relay to trigger a
control zone.
The default time is 6.00 seconds.

168 Relays
 MAN006-0612

Control delay Click the spin buttons to specify seconds this relay is delayed
time from being actuated. This field is incremented or decremented
in quarter (0.25) seconds.
Use the control delay timer for special control applications to
delay the start of the control timer for any base or expansion
relay from starting after a granted code, alarm trigger, or relay
trigger. The delay can range from 1 to 8,100 seconds.
The default time is 0.00 seconds.

Relay Logic Property Sheet

The relay logic property sheet looks like this example:

This property sheet contains these fields:

Time Zones

Actuate during Select an option from the drop-down list to designate during
time zone which time zone this relay is actuated. The relay goes on at the
start time of this time zone and goes off at the end of the zone.
These options are available:
• Select one of the pre-existing time zones.
• Select <New> to create a new time zone for this purpose.
The Standard Time Zone Properties page appears.
• Select <Never> to specify that this relay is never actuated.
• Select <Always> to indicate that this relay is always
actuated.

Relays 169
Velocity Version 3.1 Administrator’s Guide

Disable during Select an option from the drop-down list to designate during
time zone which time zone this relay is disabled. The relay becomes
disabled at the start of this time zone and is re-enabled at the
end of the zone.
These options are available:
• Select one of the pre-existing time zones.
• Select <New> to create a new time zone for this purpose.
The Standard Time Zone Properties page appears.
• Select <Never> to specify that this relay is never disabled.
• Select <Always> to indicate that this relay is always
disabled.

Auto-clear Select an option from the drop-down list to designate at the

after time zone end of which time zone this relay is automatically cleared. The
current state of any relay can be auto-cleared at the end of a
time zone to ensure the automatic reversal of a code-activated
relay without the need for a manual resetting of the relay.
This feature is most often used in combination with a manual
unlock by code (defined through the Access > Unlock
function on the Credential Function page) to ensure an
automatic relock by time zone.
This feature will not affect relays controlled by a code of higher
priority than a time zone, such as Lock Down and Lock Open.
These options are available:
• Select one of the pre-existing time zones.
• Select <New> to create a new time zone for this purpose.
The Standard Time Zone Properties page appears.
• Select <Never> to specify that this relay is never cleared.
• Select <Always> to indicate that this relay is always cleared.

Control Zones

Trigger relays Designates that while this relay is actuated, it triggers relays in
in control zone the control zone specified in the drop-down list.
Select from the list of SCZs; if no trigger is required, leave the
<No Control> option.

Retrigger Designates that while this relay is actuated, the relays in the
relays in control zone specified in the drop-down list are retriggered.
control zone Select from the list of SCZs; if no trigger is required, leave the
<No Control> option.

Mapping Control Relays to Alarm Relays

The DIGI*TRAC M2, M8, M16, and MSP/M64 controllers have one to four dedicated
alarm relays. (The M1N controller does not have dedicated alarm relays.) This feature
enables a control relay to trigger when one of the dedicated alarm relays would
normally fire.
If only one base relay number is specified, it applies to all four alarm relays.

170 Relays
 MAN006-0612

The numbers to which you can set the dedicated alarm relays are in the range of 0 –
72:

0 the Alarm Relay does not trigger any other relays

1–8 the Alarm Relay triggers a Base Relay (1-8)

9 – 72 the Alarm Relay triggers an Expansion or Virtual Relay (1-64)

These values are mapped to the dedicated alarm relay for a specific controller using the
Controller Setup page (see “Controller Setup Page” on page 88).

Relays 171
Velocity Version 3.1 Administrator’s Guide

Expansion Relays
Most controllers contain only a few base relays, most of which are used by doors for
locks and other outputs. If there are more output devices than the base relays can
handle, expansion relay boards accommodate them. In reality, most general-purpose
control—especially for such uses as elevators, jails, and medical cabinets—is
accomplished through expansion relays on expansion relay boards.
Velocity recognizes all points on the REB8 expansion boards as expansion relays
(XRelays).
The relay points on the base Model SP (MSP-8R and MSP-64R) are actually interpreted
as expansion relays by the system firmware. It is important to enable these XRelays and
assign the points to control zones for general-purpose control.
Expansion relays without a physical presence (disabled) are called Virtual Relays. For
more on virtual relays, refer to “Virtual Relays” on page 175.

Expansion Relays: How to Configure

Expansion relays (outputs) are those that are connected to the controller through a
relay expansion board (like the REB8).
Use the Expansion Relay Properties dialog box to set up each relay connected to this
controller.
To configure expansion relays:
1. From the system tree window, select the controller whose relay you want to
configure.
2. Double click the controller to display the components comprising this controller.
3. Click on the Expansion Relays folder (or Virtual Relays folder, in the case of the
M1N) in the hardware tree window.
All expansion relays currently recognized by this controller appear in the
components window. All active (physical) expansion relays are marked in red, .
All virtual relays are marked in black, .
4. From the components window, do one of these:
• Double click on the expansion relay you want to configure.
• Right click on the expansion relay you want to configure. A pop-up option list
appears. Select Properties.
The Expansion Relay Properties dialog box appears with the General property
sheet displayed.
5. Configure the relay as required.
6. Click the Logic tab.
The Logic property sheet is displayed.
7. Configure the relay as required.
8. When you're finished, click OK.
For more on virtual relays, refer to “Virtual Relays” on page 175.

Expansion Relay Properties Dialog Box

This dialog box contains two property sheets:
 Expansion Relay General Property Sheet

172 Expansion Relays

 MAN006-0612

 Expansion Relay Logic Property Sheet

Each property sheet is described on the following pages.

Expansion Relay General Property Sheet

The expansion relay general property sheet looks like this example:

It contains the following fields:

Name Enter a short name for this expansion relay, such as 'Lab3
expansion relay2.' The more specific it is, the easier it is to
identify it.
The maximum characters allowed is 35.

Normal States (You can only select one of these)

Energized (LED Click this radio button to indicate that during its normal or
On) resting state the expansion relay is energized.

De-energized Click this radio button to indicate that during its normal or
(LED Off) resting state the expansion relay is de-energized.

Timers

Control mode Click the spin buttons to specify the seconds this expansion
time relay is actuated before returning to its resting state. This field
is incremented or decremented in quarter seconds.
The control mode timer is momentary with an adjustable time
of 1 – 8,100 seconds.
An expansion relay's control mode time is used by control
zone trigger codes as well as by line module inputs or
expansion relays to trigger control zones.

Control delay Click the spin buttons to specify seconds this expansion relay
time is delayed from being actuated. This field is incremented or
decremented in quarter seconds.
Use the control delay timer for special control applications
that delay the start of the control timer for any base or
expansion relay from starting after a granted code, alarm
trigger, or expansion relay trigger.
The delay can range from 1 – 8,100 seconds.

Expansion Relays 173

Velocity Version 3.1 Administrator’s Guide

Expansion Relay Logic Property Sheet

The expansion relay logic property sheet looks like this example:

This property sheet contains these fields:

Time Zones

Actuate during Select an option from the drop-down list to designate during
time zone which time zone this expansion relay is actuated. The
expansion relay goes on at the start time of the time zone
and off at the end of the time zone.
Three values are always available:
• Select <New> to create a new time zone for this
purpose. The Standard Time Zone property sheet
appears.
• Select <Never> to specify that this expansion relay is not
actuated.
• Select <Always> to indicate that this expansion relay is
always actuated.

Disable during Select an option from the drop-down list to designate during
time zone which time zone this expansion relay is disabled. The
expansion relay becomes disabled at the start of the time
zone and is re-enabled at the end of the time zone.
Three values are always available:
• Select <New> to create a new time zone for this
purpose. The Standard Time Zone property sheet
appears.
• Select <Never> to specify that this expansion relay is
never disabled.
• Select <Always> to indicate that this expansion relay is
always disabled.

174 Expansion Relays

 MAN006-0612

Auto-clear after Select an option from the drop-down list to designate at the
time zone end of which time zone this expansion relay is automatically
cleared.
The current state of any expansion relay can be auto-cleared
at the end of a time zone to insure the automatic reversal of
a code-activated expansion relay without the need for a
manual resetting of the expansion relay.
This feature is most often used in combination with a
manual Unlock by Code to ensure an automatic Relock by
Time Zone.
This feature will not affect expansion relays controlled by a
code of higher priority than a time zone, such as Lock Down
and Lock Open.
Three values are always available:
• Select <New> to create a new time zone for this
purpose. The Standard Time Zone property sheet
appears.
• Select <Never> to specify that this expansion relay is
never cleared.
• Select <Always> to indicate that this expansion relay is
always cleared.

Control Zones

Trigger expansion Select an option from the drop-down list to designate that
relays in control this expansion relay is triggered during the specified control
zone zone.
Select from the list of available SCZs. If no trigger is required,
leave the <No Control> option.

Retrigger Select an option from the drop-down list to designate that

expansion relays this expansion relay is triggered continuously during the
in control zone specified control zone until de-actuated.
Select from the list of available SCZs. If no trigger is required,
leave the <No Control> option.

Virtual Relays
Virtual relays are expansion relays without a physical presence. They are nonetheless
extremely useful in constructing procedures which can be described by control zones.
Virtual relays are logical links between physical actions in which each virtual relay is an
element in a cascade of events leading to an output or alarm. While actual relays trigger
circuits like physical locks, annunciators, and CCTVs, virtual relays trigger only other
virtual relays or actual relays: they aren't directly connected to a physical circuit.
Virtual relays can be thought of as conditional statements in an argument of this form:
If A = B
X = Y

Expansion Relays 175

Velocity Version 3.1 Administrator’s Guide

If A = C
X = Z
where A is the virtual element upon which the value of X depends.
A simple real-world example would be an installation designed with a door, a
ScramblePad, a button, a conveyor belt, and a lock. Normally, a code is entered at the
ScramblePad and the door opens. However, when a code is entered at the beginning
of another time zone, it turns on the conveyor belt instead. One possible way of doing
this is to set up a virtual relay which supplies the logic between pushing the button and
turning on the conveyor belt in a Master Control Zone definition.

A more complex example might go like this: a customer wants the first person to enter
a valid access code at the start of the day to unlock the front door. At lunch time, they
want the door automatically relocked at the beginning of lunch time and unlocked
again by the first valid code at the end of the lunch time. Then, at the end of the day,
the security system should relock the front door. After hours, a valid code momentarily
unlocks/relocks the door as usual. In addition, they want a relock code so if anyone
leaves before the door automatically relocks, they can manually relock it.
After defining the required time zones, you would perform these tasks:
1. Define a SCZ to trigger the onboard relay (front door). In this case, SCZ 1 always
triggers Relay 1
2. Define an MCZ which would unlock the front door. In this case, MCZ 192 unlocks
SCZ 1.
3. Define a time zone for this MCZ. In this case, TZ 65 (all the time) is associated
with MCZ 192. In other words, unless masked, SCZ 1 always unlocks the door
controlled by Relay 1.
4. Define a clear relay condition at the end of the day TZ. Relay 1 is cleared at the
end of MTZ 66 (defined as M-F 8-5).
5. Define a special SCZ that controls a virtual relay. This defines SCZ 2 for TZ 65
(always) affecting Relay 0 (no physical relay), then adds a virtual expansion relay
(VR 17) during SCZ 2.
6. Define the virtual relay to trigger the after-hours MCZ. This means virtual relay VR
17 triggers MCZ 192.
7. Define the physical relay to trigger the special SCZ. This means Relay 1 triggers SCZ
2.
8. Define the time (after hours) during which the virtual relay is disabled. This
instructs the system to disable VR 17 during MTZ 67 (all those hours not defined
by MTZ 66).

176 Expansion Relays

 MAN006-0612

This means that during after hours mode, as defined by MTZ 67, VR 17 will be
disabled, thus not allowing any code to trigger it which in turn does not allow the
triggering of Relay 1 and the unlocking of the front door. However, during the day,
defined by MTZ 66, the first access code entered after VR 17 is enabled triggers the
MCZ to unlock the front door. Even if another code is entered after the front door is
unlocked, it has no effect.
An illustration of this is shown below:

As you can see, the virtual relay is used as a middle step in the logical sequence
leading to the locking or unlocking of the front door.

Using Controllers with Virtual Relays

Virtual relays are used by the M1N to specify events for use by Control Zones. They are
in every other respect identical to an expansion relay except that they have no physical
presence, only a logical presence since the M1N supports no expansion card, therefore
no expansion relays can be wired to the controller. They are nonetheless valuable for
defining control zones within the M1N system.
All other Hirsch controllers—including M2, M8, M16, and MSP—can use expansion
relays for the same purpose. If a relay expansion card (REB8) is installed in the
controller and there are connections between that card and physical relays, the relay is
considered physical; if no expansion card is present, or if there is no connection
between the existing card and a relay, Velocity considers the expansion relay as a
logical relay and treats it in the same manner as the M1N treats a virtual relay.

Expansion Relays 177

Velocity Version 3.1 Administrator’s Guide

Inputs
Input devices are all those switches and sensors that provide the controller with
information about the status of the system. Hirsch requires that all input devices be
connected to the controller through Line Modules.
Input devices of this sort include:
 RQE Devices
 Door Contacts
 Device Tamper Switches
 Interior Motion Sensors
 Perimeter and Fence Alarms
 Break Glass Window Sensors
 Capacitance Duct Sensors
 Above-Ceiling Motion Sensors
While readers and keypads are input devices as well, Velocity categorizes them as
separate components since they do not require a line module to communicate with
the controller. For this reason, they are represented as a separate folder on the Velocity
interface.
For more on readers and keypads, refer to “Readers & Keypads” on page 193.
Inputs can also be represented by devices such as CCTV switchers and cameras, DVRs
and associated cameras, as well as fire alarm (central station) detectors. However,
because these are input devices that not all Velocity systems require or include, Velocity
sorts them into their respective folders under the Interfaces Configuration branch of the
system tree pane. For more on CCTV equipment, refer to “CCTV Configuration” starting
on page 657. For more on DVR equipment, refer to “DVR / NVR Configuration and
Usage” starting on page 717. For more on Central Station equipment, refer to “Central
Stations” starting on page 365.

Inputs: How to Configure

Use the Input Configuration dialog box to set up each input connected to this controller.
 Inputs associated with doors are discussed in “Door Properties: Input
Page” on page 161.
To configure a non-door input:
1. From the system tree window, expand the tree until you display the controllers
whose inputs you want to configure.
2. Expand the controller until the inputs folder is displayed.
3. Click on the Inputs folder in the hardware tree window.
All inputs currently recognized by this controller appear in the components
window.
4. From the components window, double click on the input you want to configure.
The Input Configuration dialog box appears.
5. Configure the inputs as required.
6. When you're finished, click OK.
7. Download the new settings to the controller.

178 Inputs
 MAN006-0612

Input Properties
The Input Properties dialog box is subdivided into three property sheets:
 Input Setup property sheet
 Input Logic property sheet
 Input State Change Report property sheet
 Input property sheets are often bundled under the door properties. You
won't see these property sheets as separate entities unless you have
unbundled one or more existing doors.

Input General Property Sheet

The input general property sheet looks like this example:

This property sheet determines the initial characteristics of the specified input. The
following fields are available:

Input Name Enter a short name for this input, such as 'Lab3 Input2' or 'Door3
Input1.'
The more specific the name, the easier it is to identify it.

Enabled Check this box to specify that the input is active and connected.

Line Select from the drop-down list the type that best describes the line
Module module to which the door inputs are connected.
The options are:
• DTLM1/MELM1
• DTLM2/MELM2
• DTLM3/MELM3
For a description of these line modules, refer to “Line Modules” on
page 184.

Normal State When Secure

Normally When selected, it indicates that this input is open when secure.
Open Only one of these two options can be selected at a time.

Inputs 179
Velocity Version 3.1 Administrator’s Guide

Normally When selected, it indicates that this input is closed when secure.
Closed This is the default setting.
Only one of these two options can be selected at a time.

RQE

RQE Click this box to indicate that this input is or includes a Request to
Enabled Exit device such as a button.
When this is selected, the two fields below it are activated.

Trigger When this input is activated, mask the alarm associated with this
Mask Only RQE for a specific period of time.
Once the time is up, the alarm associated with the RQE is rearmed.

Retrigger When this input is activated, the alarm associated with this RQE is
Mask Only unarmed for as long as the RQE is active.

Timers

Mode time Either enter or use the spin control buttons to specify the seconds
(incremented in quarter seconds) this input can be masked before
an alarm is triggered.
For more on this, refer to “Timers” on page 213.

AATL time Use the spin control buttons to specify the seconds allowed before
an AATL alarm is triggered.

AATL Use the spin control buttons to specify the seconds allowed for a
Warning warning before this input issues an AATL.
time For example, if you specify 30 second as the AATL time and 5
seconds as the AATL Warning time, then 25 seconds after the input
is activated, a warning is activated.

Entry delay Use the spin control buttons to specify the seconds allowed for
time entry delay time beyond the normal specified.

Exit delay Use the spin control buttons to specify the seconds allowed for exit
time delay time beyond the normal specified.

Report Check this box to report an AATL when the door is unlocked.
AATL when
unlocked

Mask Check this box to mask the tamper alarm when the door contact is
tamper masked.
when door This box is only active when the line module is DTLM3/MELM3.
contact
masked

180 Inputs
 MAN006-0612

Input Logic Property Sheet

This property sheet looks like this example:

The following fields are available:

Time Zones

Mask during Select an option from the drop-down list to designate during
time zone which time zone this input is masked (disarmed). In addition to
previously-defined STZs, these options appear in the option list:
• Select <New> to create a new time zone for this purpose.
• Select <Never> to specify that this input is never masked.
• Select <Always> to indicate that this input is always masked.

Disable Select an option from the drop-down list to indicate during which
entry delay time the entry delay for this input is disabled.
during In addition to previously-defined STZs, these options appear in
the option list:
• Select <New> to create a new time zone for this purpose.
• Select <Never> to specify that this input's entry delay time is
never disabled.
• Select <Always> to indicate that this input's entry delay time is
always disabled.

Control Zones

Actuate Select a SCZ from the drop-down list during which the SCZ's
relay in associated relays are actuated by this input.
control zone To actuate a control zone means to actuate its relays for as long
as the alarm is active and release them the moment the alarm
stops. Relay timers are ignored when actuate is used.
Select <No Control> to indicate that this input does not actuate a
relay.

Inputs 181
Velocity Version 3.1 Administrator’s Guide

Disable Select a SCZ from the drop-down list during which the SCZ's
relay in associated relays are disabled by this input.
control zone The relays are disabled as long as the alarm is active. Once the
alarm is over, the relays are reenabled.
Select <No Control> to indicate that this input does not disable a
relay.

Trigger Select a SCZ from the drop-down list during which the SCZ's
relays in associated relays are triggered by this input.
control zone To trigger a control zone means to start the zone's relay control
timers at the moment the alarm occurs. The relay timers will start
and time out even if the alarm stays active.
Select <No Control> to indicate that this input does not trigger a
relay.

Retrigger Select a SCZ from the drop-down list during which the SCZ's
relays in associated relays are retriggered by this input.
control zone To retrigger means that the relay timers are not started until the
alarm event is over.
Select <No Control> to indicate that this input does not retrigger
a relay.

Input State Change Report Property Sheet

This property sheet looks like this example:

182 Inputs
 MAN006-0612

This page determines how this input reports changes of state to the Status Viewer. The
following fields are available:

Enable Contact State Change Reporting

Door Check this box to indicate that this input's door contact signal is
Contact reported whenever it changes state. The results are reported to the
Status Viewer; if left unchecked, results are not reported.

RQE Check this box to indicate that this input's RQE signal is reported
whenever it changes state. The results are reported to the Status
Viewer; if left unchecked, results are not reported.

Tamper Check this box to indicate that this input's tamper signal is reported
whenever it changes state. The results are reported to the Status
Viewer; if left unchecked, results are not reported.

Line Fault Check this box to indicate that this input's line fault signal is
reported whenever it changes state. The results are reported to the
Status Viewer; if left unchecked, results are not reported.

Enable Mask State Change Reporting

Door Relay Check this box to indicate that Velocity will report if this input was
masked/unmasked because of a door relay change of state. The
results are reported to the Status Viewer; if left unchecked, results
are not reported.

RQE Check this box to indicate that Velocity will report if this input was
masked/unmasked because of an RQE change of state. The results
are reported to the Status Viewer; if left unchecked, results are not
reported.

Entry/Exit Check this box to indicate that Velocity will report if this input was
Delay masked/unmasked because of an entry or exit delay change of
state. The results are reported to the Status Viewer; if left
unchecked, results are not reported.

Unlock Check this box to indicate that Velocity will report if this input was
masked/unmasked because of an unlock change of state. The
results are reported to the Status Viewer; if left unchecked, results
are not reported.

Time Zone Check this box to indicate that Velocity will report if this input was
masked/unmasked because of a time zone change of state. The
results are reported to the Status Viewer; if left unchecked, results
are not reported.

Control Check this box to indicate that Velocity will report if this input was
Code masked/unmasked because of a control code change of state. The
results are reported to the Status Viewer; if left unchecked, results
are not reported.

You must enable state reporting for each input placed on a Designer map. For more on
this, refer to “Placing Objects on Drawings” starting on page 605.

Inputs 183
Velocity Version 3.1 Administrator’s Guide

Line Modules
The line module is Hirsch's proprietary link between door contacts (or alarm sensors),
RQE devices, and the controller’s input terminal blocks.

Hint In Velocity, line modules are called alarm inputs; however, a line module is often
more than an alarm module because it accomplishes several additional tasks.

Line modules are the required intermediaries between most alarm inputs and the
controller to which they connect. Line modules provide input supervision by indicating
when a circuit is shorted, opened, noisy and/or out-of-spec. These conditions are
usually considered attempts to breach the security of the system and are therefore
monitored and reported on an input-by-input basis at all times for enabled inputs.
The controller digitally processes the analog measurement of the circuit resistance at an
effective 100 times per second rate. The circuit measures variation in conditions (±2%
with the DTLM3 Line Module and ±4% with the DTLM1/2 Line Modules) then reports
any appropriate alarms upon detection.
Hirsch provides two types of line modules:
 DTLM (Screw Terminals)
 MELM (Flying Leads)
Hirsch also supplies a door contact that includes an integral line module:
 SBMS3-2707A
Each line module type is explained in this section.

DTLM
The DIGI*TRAC line module (DTLM) provides terminal block connections. It is
recommended that DTLMs be limited to a single sensor per input. The DTLM is used
for the RQE, Auto-Relock, Door Forced, and Door Open Too Long (DOTL) functions.
There are three types of DTLM:
 The DTLM1 monitors one input. It is used for alarm applications with ±4%
sensitivity. This indicates door open.
 The DLTM2 monitors one input and one RQE. It is used when an RQE device is
required to mask the line module input and, optionally, trigger the door lock with
±4% sensitivity.
 The DTLM3 monitors one input, one RQE, and one tamper detector. It is used in
high-security applications where alarm, RQE, and tamper detection are required
with ±2% sensitivity.
DTLM inputs are labeled 1, 2, and 3 for simplicity in which 1 normally connects to the
door contact or alarm sensor, 2 connects to the RQE, and 3 monitors a Tamper switch.

Terminals & Functions

Model
HI / LO Input 1 Input 2 Input 3

DTLM1 DIGI*TRAC Alarm Not Available Not Available

DTLM2 DIGI*TRAC Alarm RQE Not Available

DTLM3 DIGI*TRAC Alarm RQE Tamper

184 Inputs
 MAN006-0612

The default configuration for line module input circuits is normally closed. For a closed
circuit, the controller instantly reports an alarm for any attempt to tamper with or cut
the circuit. For a normally open circuit, the circuit cannot be monitored and tampering
goes undetected. All input devices must be isolated ‘dry contact’ types. (A dry contact is
a switch or relay which provides no power to the circuit.)

MELM
The MELM (Miniature Embedded Line Module) performs the same functions as a
DTLM, except it is much smaller and has flying leads instead of terminal connections. It
is ideal for installation inside the RQE or alarm device housing. MELMs provide a pair of
flying leads per input:
 The MELM1 has one input and is used for alarm applications.
 The MELM2 has two inputs and is used when an RQE device is required to mask
the line module input and, optionally, trigger the door lock.
 The MELM3 has three inputs and is used in high security applications where alarm,
RQE, and tamper detection are required with ±2% sensitivity.
Instead of marked terminals, the MELM has colored wires (flying leads) as shown in
this table.

Wire Pair Colors & Functions

Model
HI (white)/ Orange Blue Green
LO (black)

MELM1 DIGI*TRAC Alarm Not Available Not Available

MELM2 DIGI*TRAC Alarm RQE Not Available

MELM3 DIGI*TRAC Alarm RQE Tamper

The default configuration for line module input circuits is normally closed. For a closed
circuit, the controller instantly reports an alarm for any attempt to tamper with or cut
the circuit. For a normally open circuit, the circuit cannot be monitored and tampering
goes undetected.

RQE
A Request-To-Exit device is normally an input device like a bar or button that can be
used to mask (disarm) an alarmed door for authorized exit and to unlock magnetic
locks for exit. RQE devices can be push-button or motion sensors.
An RQE push button can be installed at a receptionist's desk to manually grant access
at an intercom controlled visitor's entry door. RQE Devices are connected to a controller
through a DTLM2, DTLM3, MELM2, or MELM3 Line Module.
RQE Devices may also be used to locally mask an expansion line module input, either
for momentary passage through an alarmed door, or using a key switch for masking
interior motion sensors prior to area occupancy.
You specify that an input device is an RQE in the 'RQE Enabled' field on the Input
Properties General sheet (see “Input General Property Sheet” on page 179) or the
Door Properties - Input Page (see “Door Properties: Input Page” on page 161).

Inputs 185
Velocity Version 3.1 Administrator’s Guide

Expansion Inputs
Most controllers do not possess sufficient base inputs to monitor all the alarms a facility
has. In order to increase the number of alarms that a controller can monitor, Hirsch
provides a line of expansion input boards (also called alarm expansion boards), such
as the AEB8, that are installed in the controller and provide additional connections
(expansion inputs) for alarms. In practice, most general-purpose alarm monitoring is
done through these expansion inputs.
Velocity recognizes all points on the input expansion boards as expansion inputs
(XInputs). However, the points on the base Model 16 appear to the controller firmware
as expansion inputs.
 The Model 1N cannot support expansion inputs since it does not allow
the installation of expansion boards.

Expansion Inputs: How to Configure

Expansion inputs are those that are connected to the controller through an input
(alarm) expansion board (like the AEB8).
Use the Expansion Input Configuration dialog box to set up each input connected to
this controller.
To configure expansion inputs:
1. From the system tree window, double click the controller whose expansion input
you want to configure.
The components comprising this controller appear below it.
2. Click on the Expansion Inputs folder in the hardware tree window.
All expansion inputs appear in the components pane.
3. From the components pane, do one of these:
• Double click on the expansion input you want to configure.
• Right click the expansion input you want to configure. A pop-up option list
appears. Select Properties.
The Expansion Input Configuration dialog box appears with the General property
sheet displayed.
4. Configure the general property sheet as required.
5. Click the Logic tab to reveal the Logic property sheet.
6. Configure the logic property sheet as required.
7. When you're finished, click OK.

Expansion Inputs Property Sheet

The Expansion Input Property sheet consists of three property sheets:
 Expansion Input General property sheet
 Expansion Input Logic property sheet
 Expansion Input State Change Reporting

186 Expansion Inputs

 MAN006-0612

Expansion Input General Property Sheet

The expansion input general property sheet looks like this example:

The following fields are available:

Name Enter a short name for this expansion input, such as 'Lab3
expansion input2' or 'Door3 expansion input1.' The more specific
it is, the easier it is to identify it.
Maximum characters allowed is 32.

Enabled Check this box to specify that the expansion input is active and
connected.
Leave the box unchecked to indicate that the input is not yet
active.

Line Module Select from the pull-down list the type that describes the line
module to which this expansion input is connected.
The options are:
• DTLM1/MELM1
• DTLM2/MELM2
• DTLM3/MELM3
For a description of these line modules, refer to “Line Modules”
on page 184.

Normal State When Secure

Normally Click this radio button to indicate this expansion input is open
Open when secure.
Only one of these two options can be selected: an input can only
be normally open or normally closed, not both.

Expansion Inputs 187

Velocity Version 3.1 Administrator’s Guide

Normally Click this radio button to indicate this expansion input is closed
Closed when secure.
Only one of these two options can be selected: an input can only
be normally open or normally closed, not both.
This is the default setting.

RQE Click this box to indicate this expansion input is or includes a

Enabled request-to-exit device such as a exit button or exit bar.
When this is selected, the next two fields are activated.

Trigger When this expansion input is activated, mask the alarm

Mask Only associated with this RQE for a specific period of time. Once the
time is up, the alarm associated with the RQE is rearmed.

Retrigger When this expansion input is activated, the alarm associated with
Mask Only this RQE is unarmed for as long as the RQE is active.

Timers

Mode time Use the spin control buttons to specify the seconds (incremented
in quarter seconds) this expansion input can be masked before
an alarm is triggered.

AATL time Use the spin control buttons to specify the seconds allowed
before an AATL alarm is triggered.

AATL Use the spin control buttons to specify the seconds allowed for a
Warning warning before this expansion input issues an AATL.
time For example, if you specify 30 second as the AATL time and 5
seconds as the AATL warning time, then 25 seconds after the
expansion input is activated, a warning is activated.

Entry delay Use the spin control buttons to specify the seconds allowed for
time entry delay time beyond the normal specified.

Exit delay Use the spin control buttons to specify the seconds allowed for
time exit delay time beyond the normal specified.

Report AATL Check this box to report an AATL when the door is unlocked.
when
unlocked

Mask Check this box to mask the tamper alarm when the door contact
tamper is masked.
when door This box is only active when the line module is DTLM3/MELM3.
contact
masked

188 Expansion Inputs

 MAN006-0612

Expansion Input Logic Property Sheet

The expansion input logic property sheet looks like this example:

The following fields are available on the logic property sheet:

Time Zones

Mask during Select an option from the drop-down list to designate during
time zone which time zone this expansion input is masked (disarmed).
Three options always appear in this list:
• Select <New> to create a new time zone for this purpose.
The Standard Time Zone property sheet appears.
• Select <Never> to specify that this expansion input is
never masked.
• Select <Always> to indicate that this expansion input is
always masked.

Disable entry Select an option from the drop-down list to indicate during
delay during which time the entry delay for this expansion input is
disabled. Three options always appear in this list:
• Select <New> to create a new time zone for this purpose.
The Standard Time Zone property sheet appears.
• Select <Never> to specify that this expansion input's entry
delay time is never disabled.
• Select <Always> to indicate that this expansion input's
entry delay time is always disabled.

Expansion Inputs 189

Velocity Version 3.1 Administrator’s Guide

Control Zones

Actuate relay Select a SCZ from the drop-down list during which the SCZ's
in control zone associated relays are actuated by this expansion input. To
actuate a control zone means to actuate its relays for as long
as the alarm is active and release them the moment the
alarm restores. The Relay Timers are ignored when actuate is
used.
Select <No Control> to indicate that this expansion input
does not actuate a relay.

Disable relay in Select a SCZ from the drop-down list during which the SCZ's
control zone associated relays are disabled by this expansion input. The
relays are disabled while the alarm is active. Once it restores
the disabled state is cleared.
Select <No Control> to indicate that this expansion input
does not disable a relay.

Trigger relays Select a SCZ from the drop-down list during which the SCZ's
in control zone associated relays are triggered by this expansion input.
To trigger means to start the zone's relay control timers at the
moment the alarm occurs. The relay timers will start and time
out even if the alarm stays active.
Select <No Control> to indicate that this expansion input
does not trigger a relay.

Retrigger Select a SCZ from the drop-down list during which the SCZ's
relays in associated relays are retriggered by this expansion input.
control zone To retrigger means that the relay timers are not started until
the alarm event is over.
Select <No Control> to indicate that this expansion input
does not retrigger a relay.

Expansion Input State Change Reporting Property Sheet

This page determines how this expansion input reports changes of state to the Status
Viewer.

190 Expansion Inputs

 MAN006-0612

The following fields are available:

Enable Contact State Change Reporting

Door Check this box to indicate that this expansion input's door contact
Contact signal is reported whenever it changes state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

RQE Check this box to indicate that this expansion input's RQE signal is
reported whenever it changes state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Tamper Check this box to indicate that this expansion input's tamper signal is
reported whenever it changes state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Line Fault Check this box to indicate that this expansion input's line fault signal
is reported whenever it changes state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Enable Mask State Change Reporting

Door Check this box to indicate that Velocity will report if this expansion
Relay input was masked/unmasked because of a door relay change of
state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

RQE Check this box to indicate that Velocity will report if this expansion
input was masked/unmasked because of an RQE change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Entry/Exit Check this box to indicate that Velocity will report if this expansion
Delay input was masked/unmasked because of an entry or exit delay
change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Unlock Check this box to indicate that Velocity will report if this expansion
input was masked/unmasked because of an unlock change of state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Time Check this box to indicate that Velocity will report if this expansion
Zone input was masked/unmasked because of a time zone change of
state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

Expansion Inputs 191

Velocity Version 3.1 Administrator’s Guide

Control Check this box to indicate that Velocity will report if this expansion
Code input was masked/unmasked because of a control code change of
state.
The results are reported to the Status Viewer; if left unchecked,
results are not reported.

You must enable state reporting for each expansion input placed on a Designer map.
For on this, refer to “Placing Objects on Drawings” starting on page 605.

192 Expansion Inputs

 MAN006-0612

Readers & Keypads

Readers and keypads are those devices that require personal input.
These devices include:
 Keypads/ScramblePads
 MATCH Reader Interface
 Readers
Each of these devices is explained below.

ScramblePads
ScramblePads are Hirsch’s answer to prying eyes. A unique, patented
feature—scrambling digits—eliminates pattern recognition. ScramblePad numbers are
randomly redisplayed each time the START button is pressed so a nearby observer
cannot learn the code by memorizing which buttons are pressed. The numbers are
illuminated displays located behind transparent push buttons.
Slats, or viewing restrictors, are located between the lights and the push buttons.
Vertical viewing restriction (up and down) is ±26° and the horizontal viewing restriction
(side to side) is ±4°. On the high intensity display versions of the keypads (such as the
DS47L-HI), horizontal viewing restriction is increased to ±20°.

Viewing restriction is less on the high-intensity display models. This means that if the
ScramblePad is mounted at the recommended height, 58 inches (147 centimeters),
any person between 4’2” (127 cm) and 6’2” (188 cm) in height can view the
numbers, but only the user can see the numbers clearly. Anyone more than 4° to
either left or right of the ScramblePad won’t be able to see the numbers.
ADA or local codes may require different mounting heights.

Readers & Keypads 193

Velocity Version 3.1 Administrator’s Guide

MATCH Reader Interface

The MATCH Reader Interface Board (MRIB) enables a large range of keypad and reader
technologies to communicate with DIGI*TRAC controllers. All reader and third-party
keypad signals must go through the MRIB before proceeding to the controller.

MRIBs can also be used for dual technology, combining ScramblePads and readers at a
door then passing the combined signals along to an attached controller. The MRIB
should be located at the door. Each MRIB can accommodate up to 2 readers and 2
ScramblePads for dual technology entry and dual technology exit door applications.
The Hirsch DS47L ScramblePad includes both a keypad and MRIB, thereby eliminating
the need for installing a separate MRIB at the location. The Hirsch ScrambleProx
(DS47L-SPX) includes a keypad, MRIB, and reader in one package. This eliminates the
need for installing both a separate MRIB and reader at the required location.
Currently, Hirsch only ships the latest version of this board, the MRIB2 (MATCH2).
Any MRIB2 that was manufactured before 3/27/01 must be
replaced to work with CCM 7. Older MRIBs do not need to be
replaced. To tell how old your MRIB is, look underneath the
MRIB back plate. There should be 3/4-inch chip covered by a
sticker that says MATCH. On that sticker you'll see a date code
like 010327 (YYMMDD).
Through the MRIB, Hirsch controllers support a large variety of readers including:
 Proximity
 Magstripe
 Wiegand
 Bar code
 Touch memory
 Barium ferrite
 Retinal
 Fingerprint
 additional biometric
For a list of readers supported by Hirsch, open the Browser and refer to the DIGI*TRAC
Design and Installation Guide.

194 Readers & Keypads

 MAN006-0612

Readers: How to Configure

Use the Reader Properties dialog box to set up each reader connected to this controller
that is not part of a door. Such readers are normally associated with control functions,
such as turning on/off HVAC and elevator operation, not door access functions.
 Readers associated with doors are discussed in “Door Properties: Input
Page” on page 161.
To configure a non-door reader:
1. From the system tree window, select the controller whose reader you want to
configure and expand that tree.
2. Click on the Readers folder in the hardware tree window.
All readers currently recognized by this controller appear in the components
window.
Only unbundled and unassociated readers appear in this pane.
3. From the components window, double click on the reader you want to configure.
The Reader Properties dialog box appears. Refer to “Reader Properties Dialog Box”
on page 195.
4. Configure the reader as required.
5. When you're finished, click OK.

Reader Properties Dialog Box

The Reader Configuration dialog box is divided into three property sheets:
 Reader General property sheet
 Reader Logic property sheet
 Reader ScramblePad Options property sheet

Reader General Property Sheet

This property sheet specifies some general characteristics of this reader.

Readers & Keypads 195

Velocity Version 3.1 Administrator’s Guide

 Notice that this page is marked as General when the reader is

unbundled, but is marked as Setup when the reader is bundled. This is
done to distinguish the first page of Door properties from the first page
of Door Reader properties.
The following fields are available:

Reader Name Velocity supplies a default reader number, like Reader 01.
If you need another name, enter a short name for this specific
reader. Make it descriptive enough to locate the reader within
this door environment. For example, Exit reader for Door 2 or
Entry reader to main lab.

MATCH Reader This section enables/disables or configures options available

with the Hirsch MATCH board that is connected to this reader.

Enable bezel Click this box to activate the reader's bezel tamper alarm.
tamper The default is unchecked.

LED reverse Click this box to reverse the keypad/reader's LEDs during a
read. Normally the reader flashes green whenever an access is
granted. This reverses the logic and flashes the red LED
instead.
This misleads unauthorized people from entering or exiting an
area if they happen to punch in the right code by accident.
The default is unchecked.

Enable Check this box to enable the use of card formats that use more
Wiegand Hex than 48 bits, such as DESFire and MIFARE cards, at this door.
Pass-through This setting enables the MATCH2 to read the card id as a
hexadecimal code. Unchecking this box will limit the reader to
accepting a maximum of 48-bit cards, read in an octal format.

Disable reader Select the threat level for this door above which the door's
above this reader is disabled no matter who is attempting to use it.
level Enter the value you want or click the spin control buttons to
select 0 - 99, where 0 indicates that no threat level is sufficient
to disable the connected reader. The default is 99.

Disable CCOTZ Select the threat level for this door above which the door's
above this reader disables the card-only during time zone feature
threat level designated in the 'Enable card-only access during TZ' field
above.
Enter the value you want or click the spin control buttons to
select 0 - 99, where 0 indicates that no threat level is sufficient
to disable this feature. The default is 99.

196 Readers & Keypads

 MAN006-0612

Enable Check this box to enable a ScramblePad to use more than one
ScramblePad type of reader on the same side of a door. Ordinarily, a
Sharing ScramblePad is only configured to work with one reader type
at a time; however, there are companies that must provide
access for employees who possess either a mag stripe card or
a prox card in addition to a code.
The default is unchecked.
For more on this, refer to “ScramblePad Sharing” on page 197.

Custom Card From the pick list, select the custom card code you require. To
Codes create a custom card code, refer to “Card Data Mapping”
starting on page 340.

Special Han- This option enables a multi-tech enrollment reader to pass

dling through Wiegand data to specially customize FASCN data from
PIV cards. Options available are:
• None – not applicable to this reader
• 200-bit FASCN bypass
• 75-bit (14 digits) FASCN bypass
• 75-bit (16 digits) FASCN bypass
• 64-bit FASCN bypass
When pass-through data is sent from the MATCH2 to
DIGI*TRAC, the most important digits are the trailing
(least-significant, rightmost) ones. This option enables you to
specify how this reader handles that type of data.

ScramblePad Sharing
Card Reader ScramblePad Sharing is used when you want to have one door with two
different card technologies but only one keypad.
When you present either a prox card to the ScrambleProx or a mag stripe to the
Magstripe Card Reader, the keypad scrambles up for entry of a PIN. Credentials must
be set to dual technology—IDF 3, 4, 5, or 7—for the keypad to scramble.

Readers & Keypads 197

Velocity Version 3.1 Administrator’s Guide

For example, suppose you set up the entry to Door 1 with a ScrambleProx, which has
its internal MATCH board set to Address 1. Then you put a second MATCH board next
to the ScrambleProx, connect a magstripe reader to it, and set this MATCH to Address 9.
Before this feature
can work properly,
you must first wire
MRIB these MATCHs to
(Address 9)
To Controller
share both the
(to Door 1) D*TRAC & KEYPAD
ports as shown in this
illustration.

ScrambleProx Magstripe
(ScramblePad with built in Card Reader
Prox Card Reader) (Address 9)
(Address 1)

Door (Outside)

 You cannot have standard Velocity entry/exit at this door, because you
have already used address 9 (address 1's exit).
With this feature enabled, either the prox card or the mag card causes the ScramblePad
to scramble up. Enter your PIN and you are granted access.
One possible use for this feature might be: Company A has a door with a ScrambleProx
(Prox and PIN). Company B has a door with a Magstripe Reader and a keypad (Mag
and PIN). The two companies merge, forming Company C. ScramblePad Sharing will
allow Company C to continue to use both prox duals and magstripe duals at the same
door.
Hardware Setup
These instructions apply to a ScrambleProx working with a Magstripe Reader.
1. Set the DIP switches on the ScrambleProx to Address 1, Wiegand with parity (4 & 5
ON; 1,2,3,6,7,8 OFF).
2. Plug the DIGI*TRAC connector into the controller.
3. Connect the Magstripe Reader to Reader Connector 1 on the MRIB.
4. Set the DIP switches on the MRIB to Address 9, Mag Stripe (1,4 ON; 2,3,5,6,7,8
OFF).
5. Plug the DIGI*TRAC connector into the controller.
The DIGI*TRAC connector can be daisy-chained, as in the diagram above.
Velocity Setup
To set up Velocity for ScramblePad sharing:
1. Open the relevant Door Properties.
2. On the General Tab, click the Entry & Exit Readers radio button.
3. Check Enable ScramblePad Sharing on the Exit Reader tab (as shown in the
above example).
Do NOT enable ScramblePad Sharing on the Entry Reader tab. In other words, do not
enable ScramblePad Sharing on the side of the door where the readers are located, but
on the other side. So, for example, if you have both readers and ScramblePad on the
entry side of the door, you would enable ScramblePad Sharing on the exit side.

198 Readers & Keypads

 MAN006-0612

Reader ScramblePad Options Property Sheet

This property sheet specifies the characteristics of the ScramblePad associated with this
door:

The fields on this property sheet are:

Scramble Check this box to enable this ScramblePad's keypad display. If

keypad unchecked, the keypad does not scramble its display: numbers
display are always displayed in the correct order.
By default, this box is checked.

Silent Check this box to instruct this ScramblePad keypad to work in

Operation silent mode: no beeps or alarm tones are emitted.
By default, this box is unchecked.

Accept Check this box to allow this ScramblePad to accept programming

programming codes. If left unchecked, no programming codes are accepted by
codes the ScramblePad, meaning no programming can be done from
this keypad.
By default this box is checked.

Accept access Check this box to allow this ScramblePad to accept access codes.
codes If left unchecked, no access codes are accepted by the
ScramblePad, meaning this keypad cannot be used for access.
Frequently, keypads are dedicated so that they are used only for
access or control but not both.
By default this box is checked.

Readers & Keypads 199

Velocity Version 3.1 Administrator’s Guide

Accept Check this box to allow this ScramblePad to accept control codes.
control codes If left unchecked, no control codes are accepted by the
ScramblePad, meaning this keypad cannot be used to run control
zones or command sets, such as turning off the HVAC, disabling
an elevator, or unmasking inputs.
By default this box is checked.

Accept status Check this box to allow this ScramblePad to accept status codes.
requests If left unchecked, no status requests are accepted by the
ScramblePad, meaning this keypad cannot be used for viewing
system status.
By default this box is checked.

Red LED Check this box to set this ScramblePad so that the red LED on
always ON the front panel is always ON.
By default, this box is unchecked.

Green LED Check this box to set this ScramblePad so that the green LED on
always ON the front panel is always ON.
By default, this box is unchecked.

Yellow left Check this box to set this ScramblePad so that the left yellow LED
LED always on the front panel is always ON.
ON By default, this box is unchecked.

Blink yellow Check this box to set this ScramblePad so that during a power
left LED on failure, the left yellow LED on the front panel blinks.
power failure By default, this box is unchecked.

Green LED on Check this box to set this ScramblePad so that the green LED on
while the the front panel is ON whenever a relay associated with the door
relay active to which this keypad is connected is active.
By default, this box is unchecked.

Green LED Check this box to indicate that this ScramblePad flashes its green
flash during LED during a door delay.
door delay By default, this box is unchecked.

Yellow LED Check this box to indicate that this ScramblePad flashes its yellow
flash during LED during a control delay.
control delay By default, this box is unchecked.

Card Reader Check this box to indicate that this ScramblePad will turn its card
LED on while reader LED on while the door relay is active.
relay active This applies to card-only installations. By default, this box is
unchecked.

Report Access Check this box to indicate that this ScramblePad should report all
Grants access grants to Velocity. Whenever this reader grants access, it
reports it to the Velocity Event Viewer. If unchecked, this reader
does not report access grants.
By default, this box is checked.

200 Readers & Keypads

 MAN006-0612

Code tamper Check this box to disable the user after a code tamper is
disables user recorded. The ScramblePad refuses all subsequent access
requests while the code tamper condition lasts.
By default, this box is unchecked.

Silent code Check this box to indicate that this ScramblePad issues a silent
tamper alarm in response to a code tamper. The operator receives the
alarm but no beeps or flashes are emitted by the ScramblePad
itself.
By default, this box is unchecked.

Use Keypad Check this box to specify that this ScramblePad's numeric LEDs
numeric LEDs can be used as an annunciator for several functions including:
as • occupancy counts
annunciator
• countdown timers
• deadman timer countdowns
If user count is required, you must also check the next box, 'Allow
user count display'.
Once this feature is enabled, a request by a card or code for any
of these counts results in a display by the numeric keypad of the
number of people inside/outside, the current time in minutes
before the timer reaches zero, or the time in minutes before the
guard has to be at the next station.
An operator can request occupancy information by using a
card/code that includes the Indexed Command - Count Users
Other Side or Count Users This Side.
An operator can request a countdown timer by using a
card/code that includes the Extended Access function. For an
example of this, refer to “Examples: Extended Access” on page
951.
An operator can request a deadman timer countdown by using a
card/code that includes the Deadman Timer option in “Special
Functions” on page 250.
By default, this box is unchecked.

Readers & Keypads 201

Velocity Version 3.1 Administrator’s Guide

Allow user Check this box and the ScramblePad displays the current user
count display count. If you check this box, you must also check the previous
box, 'Use Keypad numeric LEDs as annunciator' to enable this
function.
Once this feature is enabled, a request by a card or code for
occupancy information results in a display by the numeric keypad
of the number of people inside.
An operator can request occupancy information by using a
card/code that includes one of the Indexed Commands: Count
Users Other Side or Count Users This Side.
By default, this box is unchecked.

Deny codes Check this box to indicate the ScramblePad should deny all code
under duress requests as soon as a duress digit is entered.
By default, this box is unchecked.

Reader Logic Property Sheet

This property sheet defines both CCOTZ usage and passback zone definition.

202 Readers & Keypads

 MAN006-0612

These fields are:

Zones From the drop-down pick lists, specify the passback zones this
From zone: reader separates.
to If this reader is associated with a door that leads from the
outside into a facility area, specify the 'From zone' option as
Zone 1 - Outside and the 'to' field as one of the 63 available
passback zones.
If this reader is associated with a door that leads from one inside
zone to another (like Zone 2 to Zone 6), you would select Zone
2 - Inside in the 'From zone' and Zone 6 - Inside in the 'to' zone.
For more on designing your own passback scenario, refer to
“Passback Control” on page 104.
For more on defining passback zones, refer to “Defining
Passback Zones” on page 105.
Up to 63 passback zones are available including Zone 1 -
Outside and Zones 2 – 63 for inside.
To specify no physical zones for this door, leave both option
fields as Zone 0 - Unrestricted, the default setting.

Timed Either enter the number in the text box or click the up and down
Anti-Passback counter buttons to specify the number of minutes this reader will
wait before allowing the same credential to be used again. The
allowable range is 0 – 255 minutes. The default is 0 minutes.
This is particularly useful in parking lots or garages where an
organization is trying to prevent more than one person from
entering the structure using the same card. For example, if this
feature is activated for 3 minutes, the designated card cannot be
used again at this reader for 3 minutes. Any attempt to do so,
will result in a denial.

Enable Select the appropriate option from the drop-down list to indicate
“card/code-o during which time zone this dual technology reader can grant
nly” access entry using a card or code only (CCOTZ).
during TZ Options include:
• <Never>—CCOTZ is never enabled.
• <Always>—CCOTZ is always enabled.
• An existing TZ—CCOTZ is enabled during this pre-defined time
zone.
• <New>—CCOTZ is enabled during this as-yet-to-be-created
time zone. When you select this option a new time zone
property sheet appears. Create a new time zone during which
the CCOTZ feature is enabled.
The default value is <Never>.

Readers & Keypads 203

Velocity Version 3.1 Administrator’s Guide

XBoxes
The SCRAMBLE*NET Gateway (XBox) provides a high-speed gateway from a Host PC
to a network of DIGI*TRAC controllers. The XBox can support up to 63 DIGI*TRAC
Controllers through a single XBox.
 All systems incorporating an XBox are considered to use the X*NET
protocol.
A simple example of how XBox connects to one or more controllers is shown below:

XBox can also be used to connect remote controllers through modems (leased-line
connections only) like this example:

leased or dedicated
line only

or networked through Lantronix device servers like this:

The XBox connects to two output types:

 S*NET Multi-Drop cable (RS-485)
 S*NET SNIB or Leased-Line Modem (RS-232)
On the other side, XBox connects to the Host PC using either an RS-232 COM port or
an RS-485 COM port. The RS-485 connection is available from the Host PC if a
NET*ADAPT (NA1) is connected to the serial port.
The XBox must be configured if you specified X*NET as your network type in the Port
Configuration Dialog Box.
An alternative to the XBox is the SNIB2 which incorporates XBox functionality. For more
on this, refer to “Configuring SNIB2” on page 208.

204 XBoxes
 MAN006-0612

Adding XBoxes
To add an XBox:
1. If not already done, define the XNET port to which this XBox connects, as
discussed in “Adding Ports” on page 60.
2. At the System Tree pane, expand the DIGI*TRAC Configuration and XNET folders
until the XNET port appears, .
3. Click to highlight the XNET port.
The Add New Xbox option appears in the components pane.
4. From the Components window, double click the Add New Xbox option.
The XBox Configuration dialog box appears as shown on page 206.
5. In the 'Name' field, enter a new XBox name.
6. In the 'Address' combo box, select an appropriate address option.
If needed, you can change this address later.
7. Change the 'Messages per poll' and 'Logoff time' combo boxes, if required.
Under most circumstances you can leave these at the default values.
8. Check the 'Enable this XBox', if this XBox is currently online and operating.
Clear this checkbox, if the XBox is not yet connected.
9. When you're finished, click OK.
The new XBox icon appears in the system tree, .

Modifying XBoxes
To modify an existing XBox:
1. At the System Tree pane, expand the tree until the XBox icon is displayed.
2. From the Components pane, right click the XBox icon.
A pop-up option list appears.
3. Select the Properties option.
The XBox Configuration dialog box appears.
4. In the 'Name' field, modify the XBox name as required.
 You cannot modify the address in the 'Address' field. Once selected, this
address cannot be altered for this XBox.

If you need this address for some reason, delete the current XBox and
create a new one.
5. Change the 'Messages per poll' and 'Logoff time' combo boxes as required.
6. Check or clear the 'Enable this XBox' as required.
7. When you're finished, click OK.

XBoxes 205
Velocity Version 3.1 Administrator’s Guide

XBox Properties Dialog Box

The XBox Properties dialog box looks like this example:

This dialog box contains these fields:

Name Enter a unique name for this XBox.

Address From the drop-down option list, select an address for this XBox.
The address range is 1 - 64.
When you select an address it is removed from the available
address list.

Messages per Use the spin buttons or enter a value indicating how many
poll messages the XBox is allowed to pass to Velocity during each
polling cycle.
The acceptable range is 6 - 15 messages per poll where the
minimum number of messages per poll is 6 and the default is
15 messages.

Logoff time Use the spin buttons or enter a value indicating how many
(seconds) seconds without messages before the XBox logs off and issues
an alarm.
The acceptable range is 0 - 3600 seconds where 0 = never log
off. The default is 10 seconds.

Enable this Check this box to indicate that the XBox is connected. Clear this
XBox box to indicate that the XBox is not yet connected.

Revision A read-only field indicating the revision number of this XBox

detected by Velocity.

206 XBoxes
 MAN006-0612

SNIB2
The SNIB2 is a high-security encryption Secure Network Interface Board. With the
SNIB2 board, a host PC running Velocity can program, monitor, and control up to 63
controllers per board as shown in the following illustration:

RS-485 Up to 16
SNIB2
controllers
Ethernet Ethernet SNIB2

Host
XNET 2
DIGI*TRAC DIGI*TRAC
Controller Controller

RS-485 RS-485 Up to 63
SNIB2
RS-485
controllers
SNIB2

Ethernet Ethernet
DIGI*TRAC
Host NET*MUX4
Controller
XNET 2
DIGI*TRAC
Controller RS-485
RS-485

NET*MUX4

= this cable segment swaps the RX± and TX± wires.

Each connected controller must have its own SNIB2 board installed. The SNIB2
currently provides RS-485 ports as well as a 10/100 Mbps Ethernet port. In addition,
the SNIB2 understands both S*NET and X*NET protocols.
Physically, the SNIB2 board differs from the original SNIB in only two important
respects: there are three switch banks on the SNIB2 (S1, S2, and S3) and there is an
Ethernet connector with its accompanying daughterboard.

RS485 RS232 Not currently

Connector Connector used

Standoff Mounting
P1

P2

G - RX + - TX+ G RX TX V
Holes
RS485 RS232
SW1
ON

1
2
SW1 DIP 3
4
switch bank

P1

LEDs P2

P3
Expansion Board
SW2
Interface Cable
ON

1
2
SW2 DIP 3 Connector
4
switch bank SW3
(EBIC5)
ON

1
2
3

SW3 DIP
4
5
Ethernet daughterboard
6
switch bank 7
8
Never detach the daughter board
from the SNIB2 motherboard.

MAC Address label RJ-45 Ethernet connector

SNIB2 207
Velocity Version 3.1 Administrator’s Guide

In addition, the SNIB2 provides these functional advantages over the original SNIB:
 AES encryption
 Ethernet connectivity
 XBox functionality
 Higher serial speeds
Each of these new features is explained below.
AES Encryption
The SNIB2 employs AES-Rijndael encryption—a symmetric 128-bit block data
encryption technique—between the server and a SNIB2-installed controller without the
need for intermediary devices.
 X*NET2 is only supported by Velocity version 2.6 with Service Pack 1 or
higher. The National Institute of Standards and Technology (NIST) has
awarded the Velocity 3.0 AES Certificate #281.
Ethernet Connectivity
A standard RJ-45 Ethernet port is included on the SNIB2. This enables the connected
controller installed with a SNIB2 to communicate with the server using TCP/IP over
10BaseT or 100BaseT Ethernet networks. This eliminates the need for external device
servers for LAN connectivity.
 Only Ethernet connections using XNET 2 are supported between the
SNIB2 and host. Dial-up and hardwired connections are not supported
at this time.
XBox Functionality
The SNIB2 also incorporates full XBox functionality. This enables the SNIB2 to function
as a gateway for as many as 63 controllers, and provides through software the ability to
globalize certain features.
Globalizing is the process of setting up two or more controllers connected to the same
XBox in order to share credential and control zone information amongst all connected
controllers. Globalization can only be performed within a local XBox group. One SNIB2
acting as an XBox cannot talk to and share information with another XBox. For more on
this, refer to “Global Credential (User) Management” on page 895.
Higher Serial Speeds
Communications between multidropped SNIB2s is now supported at speeds up to
115,200 bps. All SNIB2s in the run must be set to the same speed.
You can install the SNIB2 board in any Hirsch DIGI*TRAC controller except the M1N.
 In order to use the SNIB2, your controller must include CCM 7.3.0 or
higher.

Configuring SNIB2
When the first (master) SNIB2 is connected to the host using Ethernet, configure and
assign a new IP address through the Velocity port properties dialog box.
To do this:
1. At the System Tree window, click and expand the DIGI*TRAC Configuration system
folder.

208 SNIB2
 MAN006-0612

Three port folders are currently available: SNET, XNET, and Dial-Up.
2. Expand the XNET Port folder.
When the Velocity host is connected to a SNIB2 via Ethernet, it views it as an
X*NET port.
3. Double click Add New XNET Port in the Components window. Velocity can only
detect the SNIB2 as an XNET port.
4. Click to select the TCP/IP radio button.
The 'XNET 2 protocol' checkbox is activated and a new Search button appears
below it, as shown in this example:

‘XNET 2 Protocol’ check box

Search button

5. Check the XNET 2 Protocol checkbox to indicate this port is using encrypted
X*NET2 protocol. Leave the box unchecked to indicate you are using unencrypted
X*NET protocol.
When you select this checkbox, the 'Reset encryption' checkbox is activated. Check
this box if the selected SNIB2 already has an encryption key assigned to it and you
want to reset it to a new one. For more on this, see “Resetting SNIB2 Encryption”
on page 211.
6. Click the Search button.
The Searching dialog box appears as described on “Searching window” on page
210.
Velocity searches for all SNIB2s that are currently unassigned IP addresses. The
Searching dialog box appears listing all SNIB2s the program finds.
7. Click to highlight the SNIB2 you want to configure from the list and click OK.
The SNIB2 Configuration dialog box appears. For more on this, refer to “SNIB2
Properties Sheet” on page 210.
8. In the 'Name' field, enter a new port name.
9. At the ‘IP Address’ field, enter the IP address for the SNIB2 connected to this
Velocity PC.
10. At the 'Port' field, enter the correct port number for this SNIB2’s server’s IP port.
All network ports possess an address used to identify the SNIB's physical port
address. The default Velocity port is 10001.
 Consult your system administrator for the correct values for both the IP
address and the port name/number.
11. Click OK.

SNIB2 209
Velocity Version 3.1 Administrator’s Guide

The Port Properties screen reappears with the Name, IP Address, and IP Port fields
populated.
12. At the 'Max retry attempts' field, specify the maximum number of retries this PC
will attempt.
Increment or decrement the value using the counter buttons.
13. Check the 'Enable this Port' box if this port is currently active.
Clear this box if the port is not currently active.
14. If required, click the Advanced button to access the Advanced Settings dialog box
and specify more features for this port.
15. When you're finished, click OK.
The new SNIB2 port appears in the Components window.
For information on importing existing SNIB2 configurations, refer to “SNIB2 Import
Wizard” starting on page 403.

SNIB2 Properties Sheet

There are three fields for this dialog box:

Name: Specify the name of the SNIB2.

This name populates to both the Searching dialog
box and the Port Properties dialog box.

IP Address: Enter the IP address in this field.

Note: For information on which value to enter here, see
your IT administrator.

Port: Enter the port value for this SNIB2.

The recommended value is 10001.

Searching window
The Searching window appears when you select the Search button on the Port
properties screen.
A window like this example appears:

All currently detected SNIB2s appear in this window, like the preceding example.

210 SNIB2
 MAN006-0612

The following columns are displayed:

IP Address The IP address of this SNIB2 assigned when the

SNIB2 was configured for the port.

Port The port through which this SNIB2 communicates

with the Velocity server. This is assigned during port
configuration.

Name The name of the SNIB2 assigned during port

configuration.

Version The version of the firmware detected for this

SNIB2. This firmware can be updated through
Velocity.

MAC Address The factory-assigned 12-digit hardwired address

unique to every SNIB2.

Backing Up SNIB2 Encryption Files

While a newly-restored Velocity program can communicate over a non-SNIB2 network,
the addition of any SNIB2s in attached controllers, requires you to reinstall the SNIB2
encryption files for each SNIB2. Before you can do this, you must first back up the
SNIB2 encryption files from the old machine.
 If you have no SNIB2s on your system, disregard this section.
To back up SNIB2 Encryption Files:
1. Go to the \Hirsch Electronics\Velocity directory on the source machine.
2. Locate the SNIB2-specific .dat files located there.
These files are normally named using this convention:
Velocity_tmp_[SNIB2 address].dat
where [SNIB2 address] is the address for the specific SNIB2 in the Velocity
address format.
3. Copy these files from the source machine to the target machine(s).
Make sure you copy these files to the same \Hirsch Electronics\Velocity directory.
4. Restart Velocity.
Velocity should now recognize all SNIB2 components. For information on restoring the
SNIB2 encryption, refer to “Restoring SNIB2 Encryption Files” on page 1105.

Resetting SNIB2 Encryption

On rare occasions, you may need to reset the XNET 2 encryption. This can happen if
your master SNIB2 is reassigned, fails, or is swapped. In each of these cases, the
encryption key is automatically changed and data received by the host becomes
unreadable. To resolve this problem, you will have to reset encryption on the master
SNIB2 then reset it at Velocity.
To do this:
1. On the SNIB2 board, turn switch 1 on bank 2 (SW2) to ON.
2. Recycle the power on the controller to which the SNIB2 is connected.
3. Turn switch 1 on bank 2 (SW2) to OFF.

SNIB2 211
Velocity Version 3.1 Administrator’s Guide

The encryption key is reset to its default value.

4. Go to Velocity and right click on the SNIB2 port you just reset.
5. Select Properties.
The Port Properties sheet appears.
6. Check the ‘Reset Encryption’ box.

This box is only active and available if this is a SNIB2 running XNET 2 protocol.
7. Click OK.
Encryption is reset for that SNIB2. This is an automatic operation: Velocity and the
master SNIB2 handshake, agree on a randomly selected encryption key, then resume
polling. Once polling resumes, the 'Reset encryption' box is automatically unchecked.
The selected SNIB2 now resumes XNET 2 encryption normally.
The master SNIB2 is in charge of all downstream encryption. Each downstream slave
SNIB2 submits its key to the master who keeps a list of these keys in order to
communicate with each slave.
As an alternative to resetting SNIB2 encryption on a large number of SNIB2s,
particularly if you restoring the Velocity database on a new computer, refer to “Restoring
Velocity Database to a New Computer” starting on page 1104.

212 SNIB2
 MAN006-0612

Timers
Each of a controller's base relays can be set up with a variety of simultaneous timers,
each of which has a different function:
 Control Mode Timers
 Control Delay Timers
 Door Mode Timers
 Door Delay Timers

Control Mode Timers

The Control Timer allows momentary control with an adjustable time of 1-8100
seconds. It can toggle a relay ON and OFF on consecutive control trigger code entries if
its time is set to 0 (zero) seconds.
A relay's Control Time is used by the Trigger function as well as by inputs or relays to
trigger a Control Zone.
Velocity contains several relay control timers:
 Relay Control Mode Time or Expansion Relay Control Mode Time
 Alarm (Input) Mode Time or Expansion Input Control Mode Time
 AATL (alarm active too long) Time
 AATL Warning Time

Control Delay Timers

The Control Delay Timer is used for special control applications. It prevents any base or
expansion relay's control timer from starting after a granted code, alarm, or relay trigger,
in effect adding an additional amount of time to the normal control mode time.
The delay can range from 1 to 8,100 seconds.
Velocity contains these control delay timers:
 Relay control delay time
 Expansion Relay delay time

Door Timers
The Door Timer allows momentary door access with an adjustable time of 1-8100
seconds. It can also toggle its relay ON and OFF on consecutive access code or RQE
entries, if the time is set to 0 (zero) seconds. A Relay's Door Timer is used by both
access codes and the RQE input.
The Door Timer only applies to the controller's door relays. On the M1N, this means
that only Relay 1 has a Door Timer. Door Mode Time applies to the alarm as well. If
your relay/alarms are not set up to operate as doors, this door mode time only applies
to the alarm input, not to the relay.
In addition to control and door timers, there are also delay timers as described below.
Velocity contains these door mode timers:
 Door Relay Mode time (bundled door)
 Door Input Mode time (bundled door)
 Door Control Mode time (bundled door)

Timers 213
Velocity Version 3.1 Administrator’s Guide

 DOTL (door open too long) time (bundled door)

 DOTL warning time (bundled door)

Door Delay Timers

There are two types of door delay timers:
 Door Delay Timers
 Entry/Exit Timers
The Door Delay Timer is used for special entrance or exit control applications. This time
prevents the Door Timer from starting after a granted code, RQE, or time zone
actuation.
The delay duration can be set in the range 1 - 8100 seconds. This is especially useful
for implementing delayed egress control on emergency exit doors where local building
codes permit such controls to be installed. It is also useful for bank vaults, where unlock
delays after correct codes are sometimes required.
Velocity contains these door delay timers:
 Door delay time (bundled door)
 Door control delay time (bundled door)
 Extended access times (bundled door)
The Entry/Exit Delay Timer is actually a special range of the Door Delay Timer. Its range
is 0 - 255 seconds. Entry and exit alarm delays are required when security system
designs call for the alarm control ScramblePad/MATCH Reader to be placed inside the
secure area.
When an entry delay is used, an authorized person enters the secured area which
causes an alarm condition on the input monitoring the entrance door or area. The
alarm is not reported if the authorized individual proceeds to the interior
ScramblePad/MATCH reader and enters a cancel entry delay code. If the cancel entry
delay code is not entered in time, the alarm will be reported. An entry delay warning
report is sent to the system printer whenever an input with an entry delay time goes
into alarm. An audible entry or exit delay tone can be sounded on the ScramblePad if
required by using a master control zone.
This command enables the setting of the entry delay timer. To re-secure the same
facility, an exit timer code is required to enable the authorized user to leave the facility
without causing an alarm. An Exit Delay Warning report is sent to the system printer
whenever an exit delay code is used.
Velocity contains these entry/exit delay timers:
 Entry delay time or Expansion input entry delay time
 Exit delay time or Expansion input exit delay time
 Door Entry delay time (bundled door)
 Door Exit delay time (bundled door)

214 Timers
 MAN006-0612

Velocity Configuration
This chapter details the procedures you use to set up Velocity. This includes creating:

Topic See page:

Command Sets 216

Credential Templates 228

Door Groups 257

Function Groups 265

Operators 275

Person Templates 283

Roles 285

Time Zones 313

Holidays 330

Workstations 334

Alarm Responses 337

Threat Levels 338

Card Data Mappings 340

215
Velocity Version 3.1 Administrator’s Guide

Command Sets
While most DIGI*TRAC Command Language (DCL) commands are handled
transparently by Velocity, there are occasions on which you will need to run raw
commands from the Velocity workstation.
This is done for these reasons:
 Troubleshoot problems associated with XBox or controller operation
 Generate reports on controller-level function (through the 88 or 188 commands)
 Specify access and control functions using Command 98.
 Execute controller-level state changes for inputs and relays
 Run batch commands to one or more controllers
 Run DCL commands not currently supported by Velocity
Don't use this feature unless you have a thorough knowledge
of DCL. Using these commands inappropriately can corrupt
Velocity, its database, and seriously damage the system.
Using command sets is much like entering commands from a ScramblePad,
DIGI*TRAC Network Manager, SNAP, or SAM diagnostic window except that commands
can be batched and sent out quickly.
With a knowledge of DCL, you can use command sets to modify and manipulate the
system in more subtle ways than you could using the Velocity interface. Through this
feature, you can configure your system with these new features.
For a complete explanation of all DCL commands, refer to Chapter 4 of the DIGI*TRAC
Design and Installation Manual available on-line through the Velocity Learning Center.

Command Sets: How to Define

To add command sets:
1. From the system tree window, expand the Velocity Configuration tree to display the
Command Sets folder.
2. Click and highlight Command Sets.
All currently selected command sets appear in the components window. You will
also see the Add New Command Set folder.
3. Double click the Add New Command Set folder.
The Command Set Properties dialog box appears. For more on this, refer to
“Command Set Properties Dialog Box” on page 218.
4. At the 'Command Set Name' field, type a name for this command set.
5. At the 'Controller' combo box, select one of the existing controllers from the
pull-down option list. Only those controllers currently defined for the system are
displayed here.
6. At the 'Function' combo box, select one of the available access or control functions
from the pull-down option list.
Depending on which function you select, the next combo box displays either
'Points' or 'Control Zones'. If you select an access function (such as Access, Unlock,
or Relock), then all the available alarm points are listed; if you select a control
function (such as Control Trigger, Alarm Mask, or Force Off), all existing control
zones are listed.

216 Command Sets

 MAN006-0612

7. From the 'Points' or 'Control Zone' drop-down option list, select the access point or
control zone effected by this function.
Only those points relevant to the Controller and Function entries appear in this list.
For example, if you select Controller 1 in the 'Controller' pick list and Access from
the 'Function' pick list, the Point pick list only displays all the doors attached to
Controller 1, since these are the only points that control access.
Once you have supplied values for the first four fields of this dialog box, Velocity
generates a command in the 'Command' text box that fulfills the stated
requirements. In most circumstances, you should not have to change this
command.
8. If required, at the 'Command' field, modify the supplied command string. Follow
these rules:
• Type the command
• Press the spacebar to insert an asterisk (*) between the command and its
accompanying argument(s)
• Type one or more arguments separated by spaces (asterisks)
For more on syntax, see “Command Syntax” on page 221.
9. Click Add to add this command string to the command string window.
 You don't need to type in START at the beginning of the command or a
pound (#) sign at the end of the command line as you do with raw
DIGI*TRAC Command Language scripting. Velocity understands the
DIGI*TRAC command language and supplies these elements. However,
you must supply an asterisk (*) between command elements or the
command will not execute.
If you make a mistake on one of your command strings, you can edit it by double
clicking the command string and entering a new value.
10. Repeat steps 5 - 9 to add more command strings to this set.
You can send command strings to more than one controller during a command
set.
11. When you've finished adding command strings to the new command set, do one
of these:
• Click Save to save this command set to the current Velocity directory and
return to the main Velocity menu. The dialog box disappears and you are
returned to the main Velocity screen. The new command set appears in the
Command Set folder.
• Click Save as... to copy and back up the command set. The Save As... dialog
box appears. Either accept the default 'Copy of...' designation for this
command set or enter a new name. Click OK. You are returned to main
Velocity screen. The copy of the command set appears in the Command Set
folder.
12. Execute the command set as required.

Command Sets 217

Velocity Version 3.1 Administrator’s Guide

Command Set Properties Dialog Box

The Command Set properties dialog box looks like this example:

This dialog box includes these fields:

Command Type in a name for this command set. This name will be used in
Set Name the Control Zone dialog box to activate the commands.

Controller Select from the available list the controller you want this
command string to affect.

Function From the drop-down option list, select the type of function this
command set will perform.

Point This field changes according to the function selected in the

Control Zone 'Function' combo box.
• If you select an access function (such as Access, Unlock, or
Relock), then all the available alarm points are listed.
• Iff you select a control function (such as Control Trigger, Alarm
Mask, or Force Off), all existing control zones are listed.
From the drop-down option list, select the access point or control
zone affected by this function.

218 Command Sets

 MAN006-0612

Command Velocity automatically supplies the command values in this text

field according to the values you entered in the first four fields.
If required, you can modify the command displayed in this field
by entering a command with associated arguments. Only one
command with required arguments is allowed per string;
however, you can add more strings to include more commands in
this command set.

Hint In most circumstances, you should not have to change this

command. The system-supplied command is specific to the
function you requested.

For more on constructing the command, refer to “Command

Syntax” on page 221 and “Command Sets: How to Define” on
page 216.
Commands allowed here include 88, 98, or 188 commands. See
“Command Syntax” on page 221.

Add Click this button to move a command from the Command field to
the Command Set Window. It is now part of the command set.

Remove Click this button to remove a selected command from the

Command Set window.

Command This window displays all of the command strings currently defined
String Window (added) for this command set.

Save Click this button to save this command set to the Velocity
database.

Save as... Click this button to save this command set as a copy of the
currently-displayed command set.
This is the easiest way to duplicate a command set when you
want to create a similar command set. Once duplicated, modify
the new command set as required.

Cancel Click this button to ignore any changes made to the command
set and return to the main menu.

Command Sets: Executing

Once you've created command sets, you can execute them.
To execute a command set:
1. From the system tree window, expand the Velocity Configuration tree to display the
Command Sets folder.
2. Click and highlight the Command Sets folder.
All currently defined command sets appear in the components window.
3. From the components window, right click the command set you want to execute.
The pop-up list displays a number of options.
4. Select Execute from the pop-up option list.

Command Sets 219

Velocity Version 3.1 Administrator’s Guide

The command strings for the selected command set are initiated on the controllers
specified.
5. Open the Event Viewer and monitor the results of this execution.
6. Notice that the Event Viewer lists not only the command set executed but also the
operator issuing the command.
 You can also restrict the ability of an operator to execute a command set
through the Roles feature.

Command Sets: Modifying

To modify an existing command set:
1. From the system tree window, expand the Velocity Configuration tree to display the
Command Sets folder.
2. Click and highlight Command Sets.
All currently selected command sets appear in the components window.
3. Double click the command set you want to modify.
The Command Set Properties dialog box appears for that command set.
4. Change values as you require for this command set including this:

To: Do this:

Add new command Select a new controller from the Controller combo
strings to the command box.
set Enter a new command in the Command field.
Click Add. The new command string is added to
the command string window.

Edit an existing In the command string window, double click the

command string command you want to edit. The Edit Command
String dialog box appears like this example:

Edit the string as required.

Click OK.

Remove existing Click to highlight the command to be deleted in the

command strings from Command window.
this command set Click Remove. The command disappears from the
window.

5. When you're finished, do one of these:

• Click Save to save this command set to the current Velocity directory and
return to the main Velocity menu. The dialog box disappears and you are
returned to the main Velocity screen. The new command set appears in the
Command Set folder.

220 Command Sets

 MAN006-0612

• Click Save as... to copy and back up the command set. The Save As... dialog
box appears. Either accept the default 'Copy of...' designation for this
command set or enter a new name. Click OK. You are returned to main
Velocity screen. The copy of the command set appears in the Command Set
folder.

Command Syntax
The following sections provide detailed information on several common DIGI*TRAC
commands.

Command 88
When you use an 88 command, the specified controller returns a list of the current
setups and status for the component(s) you requested.
The result of your query is displayed on the screen. The report table presents a lot of
material in a compressed form. While much of the information is self-explanatory,
some of it may require explanation particularly where acronyms are involved.
To fully understand what these lists and forms mean, refer to Chapter 5, “Factory Setup
and Printout,” of the DIGI*TRAC Design and Installation Guide which can be accessed
through the Browser.
The syntax of the command for use in Velocity is:
88 * NN [* First * Last] #
where NN is:

NN Description

0 Complete System Setups and Status

1 Date, Time, Version Number

2 System Information

3 Standard Time Zones

4 Master Time Zones

5 Standard Access Zones

6 Standard Control Zones

7 Relays

8 Alarm / RQE Inputs

9 Alarm Special Setups and Status

10 Doors

11 Keypads / MATCH

12 MATCH

13 Holidays

14 Grand Master Time Zones

Command Sets 221

Velocity Version 3.1 Administrator’s Guide

NN Description

15 Master Access Zones

16 Master Control Zones

17 Detailed Relay Status Only

18 Expansion Relays

19 Detailed Expansion Relay Status Only

20 Expansion Alarm / RQE Inputs

21 Expansion Alarm Special Setups and Status

22 Expansion Line Module Input Door Setups

23 Reporting Setups

24 Remote Site Management Setups

25 System Power Status

26 Transactions Since Midnight

27 Occupancy Controls

28 Virtual Relays

29 Detailed Virtual Relay Status

30 HEC Factory Diagnostics

31 Special Needs Unlock Extension Times

32 Special Keypad / MATCH Setups

33 Custom Card Reader Mapping

Notes
 88*0 prints a complete system status and setup report that lists setups, internal
status, and event summaries.
 88*1 prints the date, time and version number prints the current date, time and the
controller’s CCM Version Number. It also reports the number of users inside and the
total number of users in the controller's database.
 88*2 prints controller information with all of the controller's setup parameters.
 88*3 prints a list of standard time zones with their starting time, ending time, and
days, as well as their current active or inactive state.
 88*4 prints a list of any of the master time zones which have been assigned
standard time zones and their current state.
 88*6 prints each control zone’s time zone and door/relay setups.
 88*7 reports relay setups and status. The detailed report shows the exact current
status of each relay for troubleshooting assistance.
 88*8 prints the input setup tables and their current state.
 88*11 prints keypad and reader setups.
 88*13 prints the holiday list.

222 Command Sets

 MAN006-0612

 88*30 prints a list of numerical tables useful to Hirsch factory engineers in

diagnosing the internal performance of the controller and its attached system.
 No sensitive information is contained in these printouts.
Several extensions enable the user to specify a range of components from that device
group. These optional arguments apply to the following command arguments:
 88 * 5 * First * Last # – Prints a range of Standard Access Zones
 88 * 6 * First * Last # – Print a range of Standard Control Zones
 88 * 15 * First * Last # – Print a range of Master Access Zones
 88 * 16 * First * Last # – Print a range of Master Control Zones
 88 * 18 * First * Last # – Print a range of Expansion Relays
 88 * 19 * First * Last # – Print a range of Detailed Expansion Relay Status.
 88 * 28 * First * Last # – Print a range of Virtual Relays
 88 * 29 * First * Last # – Print a range of Detailed Virtual Relay Status
For a complete list of values generated when you use one or more of these command
variations, refer to Chapter 5 of the DIGI*TRAC Design and Installation Guide.
Examples
To print the Time, Date, Controller CCM Version, Number Of Users Inside & Total Users:
START 88 * 1 #
To print information about Master Control Zone #193:
START 88 * 16 * 193 #
To prints information about Virtual Relays 20 through 30:
START 88 * 28 * 20 * 30 #

Command 98
Most 98 subcommands are intended exclusively for Hirsch
programming and should not be used by Velocity
administrators or operators.
This is a complicated command, involving many subcommands.
The syntax for Command 98 is:
<system id> <event type>, <event subtype>, <Parameter Specs>
For example:
98 * NN * P1 * P2 * P3 * P4
where:
98 = Host Generated Command
NN = Sub-Command
P1 = Parameter 1
P2 = Parameter 2
P3 = Parameter 3
P4 = Parameter 4
In the context of Velocity, the only acceptable value of NN is 1. Thus:
98 * 1 * P1 * P2 * P3 * P4
Here are the available sub-commands:

Command Sets 223

Velocity Version 3.1 Administrator’s Guide

Access Functions

Keyword Parameter Number/Description

P1 0 = Momentary Access
2 = Unlock
13 = Relock

P2 1 = Door Number

P3 0 = Don't Care

P4 0 = Don't Care

Control Functions

Keyword Parameter Number/Description

P1 1 = Control Trigger
6 = Alarm Mask
7 = Alarm Unmask
14 = Force On
15 = Force On Release
16 = Force Off
17 = Force Off Release
18 = Lock Down
19 = Lock Down Release
20 = Lock Open
21 = Lock Open Release
22 = Momentary Mask
26 = Entry Delay Cancel
27 = Exit Timer Start
28 = Mask Alarm/Entry Delay Cancel
29 = Unmask Alarm/Exit Timer Start

P2 0 = Don't Care

P3 1 - 191 = Control Zone (1 - 255 for Control Trigger)

P4 0 = Don't Care

Miscellaneous Functions

Keyword Parameter Number/Description

P1 3 = Alarm Cancel

P2 0 = Don't Care

P3 0 = Don't Care

P4 0 = Don't Care

Examples
Unlock Door 3:
98*1*2*3*0*0#

224 Command Sets

 MAN006-0612

Relock Door 7:
98*1*13*7*0*0#]
Force On Control Zone 7:
98*1*14*0*7*0#
For a more complete explanation of Command 98, refer to Chapter 4 of the
DIGI*TRAC Design and Installation Guide in Velocity Learning Center.

Command 188
Use this command to print a full or partial report list of changes made to setups since
cold start.
For a complete list of all setup values, refer to CMD 88.
The general syntax of this command in Velocity is:
188 * NN * [NN...] #
where NN is:

NN Description Created by:

0 System Setups Command

Report

1 Timestamp (time and date) CMD 50 - 51

2 Holidays CMD 57 - 59

3 Keypad and MATCH CMD 3, 103 - 104

4 Reporting, Duress, and Host CMD 05-09, 18, 105-109, 140,

Setups 191-195

5 Standard Access Zones CMD 17, 24, 117, 201, 203, 217, 249,
349

6 Master Access Zones CMD 204, 217, 249, 349

7 Standard Control Zones CMD 45, 301-303, 345

8 Master Control Zones CMD 304-307

9 Passback & User Management CMD 46, 146, 235-238, 255-257

10 Time Zones CMD 52, 54, 56, 154

11 Action Control Blocks CMD 261

12 Alarm Inputs CMD 70-77, 84, 110, 112, 270

13 Expansion Inputs CMD 111, 113, 170-176, 180, 184,

186

14 Relays CMD 79-83, 85-87, 280-281

15 Expansion Relays CMD 181-183, 185, 187

Notes

Command Sets 225

Velocity Version 3.1 Administrator’s Guide

 Any setup changed using one of the commands cited above will be reported by
CMD 188.
 Printing the time, date, and version number reports the current date, time and the
CCM Version Number for the specified controller.
 Printing the Time Zones prints a list of all standard time zones defined with their
starting time, ending time and days, and their current active or inactive state.
 Printing the access zones or control zones prints their time zone and door/relay
setups.
 Printing the relays prints the relay setup tables and the relay status display. The
detailed report shows the exact current status of each relay changed since cold
start.
 Printing the alarm and sense inputs prints a list of alarm and sense inputs modified
from default and their current state. Printing the keypads/MATCH values prints the
keypads/MATCH reader setup tables. Printing the holidays prints the holiday list.
To fully understand what this command can do, refer to Chapter 5, “Factory Setup and
Printout,” of the DIGI*TRAC Design and Installation Guide which can be accessed
through the Browser.
Examples
To print a list of all system components modified since cold start:
188 * 0 #
To print all holidays:
188 * 2 #
To print a list of all Time Zones and Relays changed since cold start:
188 * 10 * 14 #

Rules & Conventions

DIGI*TRAC commands can be entered through either the Command Set feature or the
Diagnostic window (refer to page 703).
These rules apply to all commands in the DIGI*TRAC Command Language when used
in Velocity:
 The START element of the command that appears at the beginning of a command
does not appear in Velocity. The START button is only required for local keypad
programming.
 The asterisk (*) is used as the space between arguments. The asterisk is generated
in the Command Set module by pressing the spacebar. In the Diagnostic Window
you must add your own.
 Command line syntax consists of command numbers followed by parameters (also
called arguments). Some commands contain multiple parameters each of which
are separated by an asterisk (*). In many cases a parameter is a single entry from a
list of possible entries.
 Once the desired command is identified and parameters are selected, the entry
process is initiated by typing the command number followed by a string of numbers
for the parameters. To end the line in the Command Set module, simply click the
Add button and the program automatically places an end point in memory. In the
Diagnostic Window, press Enter and the program automatically supplies the pound
(#) sign as the end point.
A typical command will have the following arrangement of elements:

226 Command Sets

 MAN006-0612

CMD number*1st parameter*2nd parameter*last parameter

For example, the command to set the date and day of the week (CMD 50) would be
entered like this:
50*010102*4
The first parameter for CMD 50 defines the date which is presented in the format
MMDDYY. This means that ‘010102’ equals January 1, 2002. The second parameter
defines the day of week. The week format uses an 8-day week beginning on 1 =
Monday and ending 7 = Sunday (an eighth day is provided to define a holiday). So, in
this example, '4' equals Thursday.
For more on available DIGI*TRAC commands, refer to Chapters 3 and 4 of the
DIGI*TRAC Design and Installation Guide available on-line through the Browser
module.

Command Sets 227

Velocity Version 3.1 Administrator’s Guide

Credential Templates
Credential templates are security profiles that enable you to bypass the
time-consuming task of creating a new credential from scratch for every enrolled
individual. Using templates, you simply assign an individual a pre-defined template,
generate the necessary user numbers, and you've created the necessary credential. If
you have many employees, this short cut can save many hours in the enrollment
process.
For example, if you have twenty technicians, all of whom use the same lab doors and
require the same permissions, you can create a single lab technician credential
template and assign that template to every member of the group, thereby saving you
the trouble of filling out the same credential information twenty times. Credential
templates include this information:
 Badge template
 IDF for card or code
 Card type (if selected)
 Code number and type (if selected)
 Activation/expiration dates
 Function group (where appropriate)
 Door group (where appropriate)
 Day/Use/Absentee limits
 2-person rule specifications
 Tag, alert, or disable options
 Passback override
 Special needs
 Print and Issue controls
Credential templates do not include this information:
 Stamp number
 Data number
 MATCH number
 PIN
This information must be added on a person-by-person basis at the time the credential
is assigned to the person in Enrollment Manager.
For more on this, refer to “Assigning a Credential Template to a Person” on page 807.

Adding Credential Templates

It's always a good idea to create as many credential templates as you think you'll need
before enrolling users. Before creating credential templates, you should first create
badge templates, function groups, and doors groups.
To create a new credential template:
1. From the system tree window, expand the Velocity Configuration tree to display the
Credential Templates folder.
All currently selected templates appear in the components window.
2. Double click the Add New Template folder.
The Credential Template dialog box appears with the General page displayed.
3. Fill in values as required.

228 Credential Templates

 MAN006-0612

4. When you're finished with the General page, click the Function tab and add
values for this.
5. Click the Limits tab and supply these values.
6. Click the Options tab and supply these values as required.
7. When you're finished, click OK.
The new credential template appears in the Credential Templates folder.
 You cannot add information such as a PIN or card stamp number. This
must be added on a person-by-person basis within Enrollment Manager.

Editing Credential Templates

To edit an existing credential template:
1. From the system tree window, expand the Velocity Configuration tree to display the
Credential Templates folder.
All currently selected templates appear in the components window.
2. Double click the folder of the credential template you want to modify.
The Credential Template dialog box for that template appears with the General
page displayed.
3. Replace values as required.
4. When you're finished with the General page, click the Function tab and change
any values you need to.
5. Click the Limits tab and supply these values.
6. Click the Options tab and supply these values as required.
 The values appearing on the Options page can only be specified at the
time you actually create the template. You cannot modify these values
later.
7. When you're finished, click OK.
 You cannot supply information such as a PIN or card stamp number. This
must be added within the Enrollment Manager.

Deleting Credential Templates

To delete an existing credential template:
1. At the main menu, expand the Velocity Configuration folder.
The Credential Templates folder appears.
2. Click the Credential Templates folder.
All existing templates appear in the Components Window.
3. In the Components window, right click on the template you want to delete.
A pop-up option appears.
4. Select Delete.
You are prompted to confirm your choice.
5. Select Yes.
The template is deleted from the window.

Credential Templates 229

Velocity Version 3.1 Administrator’s Guide

Credential Template Properties Dialog Box

The Credential Template Properties dialog box consists of four pages:
 General property sheet
 Function property sheet
 Limits property sheet
 Options property sheet

Each property sheet is discussed here.

General Property Sheet

The Credential Template General properties sheet looks like this example:

This property sheet defines the basic settings for this credential template.

ID: This is a read-only field. Velocity generates an ID number for

each credential template created.
When you first create a credential template, the value (new)
appears. This is replaced by a generated number when the
credential is created by clicking OK.

Link new Check this box to link this template to any credentials associated
credentials to with it. If a person enrolled and linked to this credential
this template template through the Add New Credential Using Template
option. This means that when this template is changed, the
credentials associated with this template also change certain
field values.
For more on this, refer to “Credentials: Link to Template” on
page 883.
If this box is not checked, this credential template can be
changed without rippling down to every enrollee associated
with the credential template.

Description Type a brief description of this credential template.

230 Credential Templates

 MAN006-0612

Badge From the drop-down list, select the badge template you need
Templates for this credential template. If you need a double-sided badge,
make sure to select a badge template designed specifically for
double-sided printing.
Only those badge templates already defined are displayed in
this combo box list. Badge templates are created using the
Badge & Graphics Designer.
For more on this, refer to the chapter, “Badge & Graphic
Designer,” starting on page 437.
For more on printing double-sided badges, refer to “Printing a
Badge” on page 861.

IDF Select one of the available IDF options from this combo box.
Options are:
• 0 - Badge Only
• 1 - Keypad
• 2 - Card
• 3 - Dual
• 4 - Card + Dual
• 5 - Keypad + Dual
• 6 - Keypad + Card
• 7 - Keypad/Card/Dual
For more on this, refer to “ID Formats (IDF)” on page 880.
The default is 1 - Keypad.

Card If you select any card option—including 2-Card, 3-Dual, or any

other Card + Code option—from the IDF field, this section is
activated.

Type: Select from the drop-down list the type of card this is. Select
from these options:
• Std 26-Bit Wiegand
• Std 27-Bit Wiegand
• Std 28-Bit Wiegand
• Std 29-Bit Wiegand
• One-Field ABA
• Special 1 - 19
The default is Std 26-Bit Wiegand.
For more on this, refer to “Card Types” on page 2-234.
Note: If you are using an enrollment station, you don’t have to specify
the type. The enrollment station automatically detects the card
type and supplies it in this field.

Credential Templates 231

Velocity Version 3.1 Administrator’s Guide

Stamp # This optional field is most often used for record-keeping. Enter
the hot stamp number appearing on this card. This is the
number that is already imprinted on this card (normally on the
back).
If you are using an Enrollment Station to enroll this card, you
don't need to enter this field number or the 'Data' field number
that follows.

Data Type the data appearing on this card. This number is often the
same as the hot stamp number (though not on Hirsch cards).
If you are enrolling this card through an Enrollment Station, you
won't have to supply a number for the optional 'Stamp #' or this
field. If you are not enrolling this card through an Enrollment
Station, you must enter this field by hand in order to generate a
MATCH number.

MATCH Do one of the following:

• Enter numbers in the optional 'Stamp #' and 'Data' fields and
Velocity automatically generates a number for this field.
• Type in the MATCH number from the cross-reference list
provided by Hirsch for all cards (except PVC cards used for
photo badging).
• Enroll the new card through the attached enrollment station.
This field is automatically populated.
Note: The MATCH number must be an 8 - 16 digit number.
If you enter a MATCH code that has already been used, the
program will prompt you. If the system has been enabled for
override, a message appears asking you whether you want to
override and reuse the code. If you have the proper permission,
you can override and reuse the code; however, you cannot
override an existing code unless the original has been deleted.

UDF... Click this button to concatenate currently selected UDF fields

and populate the 'Data' and 'MATCH' fields with the result. The
Concatenate UDFs screen appears.
This is generally only used when the Pass through option is
selected for the Card Type.
This button is only active when you select an IDF that specifies a
Card. If you select IDFs 0 (Badge Only) or 1 (Code Only), this
button is not active.

232 Credential Templates

 MAN006-0612

Enrollment This icon indicates whether the enrollment station is working

Station Status properly or not.
If the station is connected and working correctly, you will see a
normal black and white icon with a green dot, .
If Velocity does not detect an enrollment station even though
the COM port is set in Preferences and the selected IDF
requires a MATCH, you see black and white icon with a red dot,
.
If Velocity does not detect an enrollment station, a red circle and
bar overwrite the icon, .
To test the enrollment station, double click this button. The
Enrollment Station dialog box appears.

Activation/Expiration Date

Activate: The date and time when this credential template becomes
valid.
At the date field, use the down arrow, , to the right of this
combo box to display the calendar. Select the month and day
on which this card/code is activated. You can click the and
buttons to go from month to month. Use the up and down
cursor keys to change the date. The current time is automatically
supplied. To change this, click in the time fields and enter new
values as required.
Alternatively, in the combo box to the right, select from a list of
common date ranges, such as 1 Day, 1 Week, 1 Month, and so
on. This automatically enters a value in the preceding field. You
can then modify the values in the left combo box as required.

Expire: The date and time when this credential is no longer valid. If the
person possessing this credential attempts to use this credential
after the expiration date, Velocity refuses the attempt.
If you want to activate this feature and change the date that
appears in this field:
1. To activate an expiration date, click the check box to the left
of the field.
2. To the right of the field, click the browse button, .
The Set Expiration Date dialog box appears.
3. Specify the date you want to use.
4. Click OK.

Credential Templates 233

Velocity Version 3.1 Administrator’s Guide

On This field is activated when the 'Expire On' checkbox is selected.

Expiration: Three options are available:
• Disable - click this radio button to indicate that this
card/code is disabled on expiration. The card/code is stored
in the database and cannot be reused.
• Delete from Controllers - click this radio button to indicate
that this card/code is deleted from all controller memories.
The card/code is stored in the database and cannot be
reused.
• Disable and Unassign - click this radio button to indicate
that this card/code is disabled and unassigned at expiration.
The card/code is stored in the database and can be reused
by selecting the credential from unassigned, assigning the
unassigned credential to a person, then reactivating it.

Code
If you select any code option—including code, dual, or card and code—from the
IDF field, this section is activated.

Length: Use the spin control buttons, , to specify how many digits
long this code can be.
The range is 3 – 15 digits. The default is 4 digits.

PIN This number cannot be edited using the credential template. It

must be defined for each individual credential.

Auto This button is not available through the credential template. It

only functions for an individual credential.

Duress Digit: Use the spin control buttons to specify a duress digit for this
credential. Available duress digits are 1 - 9.
The default is 0 indicating that no duress digit is required for this
code. For more on this, refer to “Duress Digits” on page 881.

Card Types
Card types are standard formats card manufacturers, such as HID, use to construct their
cards. There are many different card standards available but only a few have become
industry standard. The options supported by Velocity are:

Card Type Description

Standard 26-Bit The 26-bit format is the industry standard format and is an
Wiegand open format. Convenience in ordering cards and universal
access control panel acceptance are the primary benefits in
using the standard 26-bit card format.
This format consists of 255 possible facility codes. Within
each facility code there is a total of 65,535 unique card
numbers.

234 Credential Templates

 MAN006-0612

Card Type Description

Standard 27-Bit The 27-bit format is similar to the 26-bit format except that
Wiegand it offers more facility codes and more unique card
numbers.

Standard 28-Bit The 28-bit format is similar to the 26- and 27-bit formats
Wiegand except that it offers still more facility codes and more
unique card numbers.

Standard 29-Bit The 29-bit format offers one order of magnitude more
Wiegand facility codes and a higher card number maximum.

One-Field ABA Magnetic encoding on a single track using ABA standard

format

Special 1 - 25 OEM formats are a unique data format reserved for the
exclusive use of an OEM customer. The OEM format
structure is defined by the OEM customer and Hirsch. OEM
formats are available in a number of different data lengths
with various data field definitions. The OEM format is the
customer's way of providing their customers with a unique
card, and unduplicated card numbers.

When defining a credential as a card, you must specify which card type it is from the
'Type:' field on the General page of either the Credential dialog box or the Credential
Template dialog box.

Function Property Sheet

The Credential Template Function properties sheet looks like this example:

Credential Templates 235

Velocity Version 3.1 Administrator’s Guide

Use this property sheet to define an action that should be performed when this
code/card is presented.Use this property sheet to define one or more actions that
should be performed when this code/card is presented.

Function(s) This section is divided into two windows: Access Function and
Control Function. When you add a new access and/or control
function, the details of those functions appear in one or the other
of these windows.
Note: A credential template can only define a single function per
controller. When two functions, such as an access and control
function, conflict, a message appears indicating the exact nature
of the conflict.
For more on functions, refer to “Functions” on page 241.

Add... Click this button to add a function to this credential template. The
Define Function dialog box appears. Select the function you
require and it is displayed in either the Access or Control Function
window.
For more on the Define Function dialog box, see “Define
Function Dialog Box,” starting on page 875.

Edit... Click this button after selecting a function from either the Access
Function or Control Function window to edit the function. The
Define Function dialog box appears. Modify the function as
needed.

Delete Click this button after selecting a function from either the Access
Function or Control Function window to remove that function
from the window.

Limits Property Sheet

This Limits properties sheet looks like this example:

236 Credential Templates

 MAN006-0612

Use this property sheet to enable a variety of limits on this credential template
including global user (credential) management, day/use/absentee limits, and 2-person
rule.

Apply Credential Click this box to indicate that the credential management
Management limits specified here are shared amongst all controllers
Globally connected to the same XBox. Before this feature can be
applied, you must first check the 'Enable global credential
management' box on the Controller Properties Setup
page (see page 88) for each affected controller.
For example, if a person using this credential exceeds the
use limit at one door, that information is shared with all
other controllers on the same XBox. This makes it
impossible for the credential to be used at another door
even if it is controlled by another controller.
For more on this, refer to “Global Credential (User)
Management” on page 895.

Threat Authority Use the spin control buttons to increase or decrease the
threat level for this credential template.

Day/Use/Absentee Limits

No Limit Click this radio button to indicate that there are no limits
for this credential template. This is the default value for a
credential template.

Day Limiting Click this radio button to specify that this credential expires
after a specified number of days. (A day is defined as
running from midnight to midnight.)
The 'Day/Use/Absentee Count' spin control field is
activated. Specify the limit in the 'Day/Use/Absentee
Count' field to the right.
For more on this, refer to “Day Limiting” on page 890.

Use Limiting Click this radio button to specify that this credential
template expires after a specified number of uses. The
'Day/Use/Absentee Count' spin control field is activated.
Specify the limit in the 'Day/Use/Absentee Count' field to
the right.
For more on this, refer to “Use Limiting” on page 890.

Absentee Limiting Click this radio button to specify that this credential
template expires after a specified number of recorded
absences. The 'Day/Use/Absentee Count' spin control
field is activated.
Specify the limit in the 'Day/Use/Absentee Count' field to
the right.
For more on this, refer to “Display Credential Information”
on page 889.

Credential Templates 237

Velocity Version 3.1 Administrator’s Guide

Day/Use/Absentee Use the spin control buttons to increase or decrease the

Count number of days, uses, or absences this credential
template is allowed before it expires. The units specified
here depend on the limiting radio button:
• if you select Day Limiting, the count is in days
• if you select Use Limiting, the count is in uses
• if you select Absentee Limiting, the count is in
absences
The allowed range is 1 - 254 days, uses, or absences. The
default value is 0, no limit.

Auto-Delete Click this box to indicate that when the limit is reached as
Credential defined by the fields above, this credential template is
automatically deleted from the controller's memory.
If you have checked the 'Apply Credential Management
Globally' box, all instances of this credential template on
all attached controllers are deleted.
Note: If this option is not checked, this credential is disabled
when the limit is exceeded.
For more on this feature, see “Auto-Delete” on page 892.

2-Person Rule
This section specifies how the 2-person rule is applied to this credential template.
Doors are enabled for 2-Person Rule using the Door General Properties page.
Timers and time zone disable parameters are specified on the Controller Passback
property sheet.
For more on this, refer to “Two-Person Rule,” starting on page 106.

Normal Click this radio button to indicate that the normal 2-person
rule applies to this credential. This person can access a
2-Person Rule-enabled door with any other person
possessing a Normal, A/B Rule “A”, or A/B Rule “B”
designation.

A/B Rule A Two-Person “A/B” Rule. If one person has an A/B Rule “A”
specified in the limits for their credential, they need to find
someone with an A/B Rule “B” or a 'Normal' designation
in order to unlock a 2-Person Rule-enabled door.
This is particularly useful for supervisor/ trainee access
privileges.
For more on these rules, refer to “Rule Variations” on page
108.

238 Credential Templates

 MAN006-0612

A/B Rule B Two-Person “A/B” Rule. If one person has an A/B Rule 'B'
selected in the limits for their credential, they need to find
someone with an A/B Rule “A” or a 'Normal' designation
in order to unlock a 2-person rule-enabled door.
This is particularly useful for supervisor/ trainee access
privileges.
For more on these rules, refer to “Rule Variations” on page
108.

Executive Override Two-Person Executive Override. This allows the holder of

this credential template to override the two-man rule.
It only takes this credential template to unlock the door
even if the door normally requires two people.

Options Property Sheet

The Options property sheet looks like this example:

This page controls a variety of options influencing the way Velocity responds to a
specific credential template.

Actions

Tag Click this box to indicate the credential template is tagged. For
more on this topic, refer to “Tagging” on page 892.

Alert Click this box to indicate the credential template causes an alert.
For more on this topic, refer to “Alert” on page 892.

Disable Click this box to disable all actions while this credential template
is being used.

Passback

Executive Click this box to designate that this credential template allows
Override executive override. For more on this topic, refer to “Two-Person
Rule” on page 106.

Special Needs

Credential Templates 239

Velocity Version 3.1 Administrator’s Guide

Special Needs Click this box to designate that this credential template allows
Access Time an unlock extension beyond the normal unlock interval for
Extension special needs, such as wheelchair access or large parcel
delivery.
Before this feature is enabled, you must first specify intervals in
the ‘Special Needs Time Extensions’ section of the Controller
Setup properties sheet (see page 88). For more on this, refer to
“Special Needs Time Extension” on page 95.

Current Issue Enables an operator to document the current status of this

Status credential. This is particularly helpful if the credential has been
lost, destroyed, or stolen for some reason.
Either enter an issue into this combo box or select one of the
status options from the drop-down list. The default issue list
options include:
• Lost
• Stolen
• Destroyed
This is a read-only field and does not disable the credential
template.

Print Control

Enable Print Check this box to enable print control. Print control is a feature
Control that restricts the number of badges that can be printed using a
credential based on this credential template.
If this credential is not associated with a badge template, this
section has no relevance. A qualified operator can enable Print
Control globally using Enrollment Manager Preferences (see
“Preferences” on page 896.).

Attempts: A read-only field indicating the number of attempts that were

made to print a badge based on this credential template.
This count and the Confirmed count will be identical unless
you check the Display print confirmation box below.

Confirmed: A read-only field indicating the number of badges based on this

credential template that were actually printed. This number
cannot exceed the prescribed Max field.
This count and the Attempts count will be identical unless you
check the Display print confirmation box below.

Max: Enter the maximum number of badges that can be printed for a
badge based on this credential template. Velocity will not allow
either the Attempts or Confirmed counts to exceed the value
entered here unless the operator printing the badge is assigned
to a role that allows overriding of print control (see “Role
Properties: Application Permissions” on page 292).
A qualified operator specify a maximum value globally using
Enrollment Manager Preferences (see “Preferences” on page
896.).

240 Credential Templates

 MAN006-0612

Display print Check this box to enable confirmation when a badge based on
confirmation this credential template attempts to print. This means that
whenever an operator prints a badge based on this credential,
Velocity prompts the operator to indicate whether the badge
printed correctly. If the operator indicates that the badge did
print properly, both the Attempts and Confirmed fields are
incremented by one. If the operator indicates that the badge did
not print properly, only the Attempts field is incremented.
A qualified operator can enable this feature globally using
Enrollment Manager Preferences (see “Preferences” on page
896.).

Issue Control

Enable Issue Check this box to enable issue control.

Number

Count: This field is not relevant for a credential template.

Max: Enter the maximum number of times a credential based on this

template can be issued. Velocity will not allow the Count field to
exceed the value entered here.

Reissue This field is not relevant for a credential template.

Issue Comment This field is not relevant for a credential template.

Table

Functions
Functions are tasks Velocity can do to connected security devices.
Velocity divides functions into five main categories:
 Access Functions (page 241)
 Alarm & Input Functions (page 242)
 Control Functions (page 245)
 Password Functions (page 249)
 Special Functions (page 250)
Each of these functions is explained more thoroughly in the following sections.
For details on how to use these functions, refer to the Velocity Operators Guide,
“Access & Control Functions,” starting on page 203.

Access Functions
Access functions (also called Door functions) apply to only one component: the door.

Credential Templates 241

Velocity Version 3.1 Administrator’s Guide

These functions include:

Function Description Comment

Momentary Actuates the door timer Momentary and Trigger are the only
for a period of time two functions that are timed: going on
specified by the door then turning off according to a timer set
timer. to a predefined interval. All other
functions are either On or Off. This is
the lowest priority level of relay
actuation.

Unlock Actuates the relay and This affects only the door/relay at
leaves it on until it is which it is issued. This is the next
relocked. lowest level of relay actuation; only
momentary is lower.

Relock Relock a relay that has This is the necessary twin to unlock. It
previously been must be used to negate the unlock
unlocked. function and return the door to its
normal resting state. This affects only
the door/relay at which it is issued.

Extended Unlock the door for an The interval during which the door is
Unlock extended period of time. unlocked is designated by the
Extended Access Timers in Door
Properties.
For more on this, refer to “Examples:
Extended Access” on page 951.

The procedures used for invoking these functions is explained fully in the Velocity
Operators Guide, “Access & Control Functions,” starting on page 203.

Alarm Functions
Alarm functions describe a group of operations Velocity uses to control the behavior of
specified alarms and the line modules associated with them.

Momentary Momentary Mask momentarily turns off the reporting of all

Mask alarms from any of the line module inputs for the specified door
group. The door will only remain masked for a specified number
of seconds before it is automatically unmasked.
The time allowed before alarms are unmasked is determined by
the door inputs' Door Mode timer setting.
Masking does not prevent the reporting of line trouble, such as
shorts or open line conditions.

Mask Mask turns off the reporting of all alarms from any of the line
module inputs for the specified door group.
Masking does not prevent the reporting of line trouble, such as
shorts or open line conditions.

242 Credential Templates

 MAN006-0612

Unmask Unmask restores the alarm reporting from all inputs defined for
the specified door group.
Assign Unmask to a door group with a time zone of 65 (Always)
to prevent time restrictions on the unmasking of masked line
module inputs.

Cancel Entry Cancel Entry Timer is used to cancel the entry delay timer and
Delay prevent the reporting of an alarm.
Use an entry delay timer to control access to secure areas where
the ScramblePad is located within the area. The setting for the
entry delay timer is defined at the Entry Delay Time field on the
Door Input Setup Property Sheet. The secured area is defined by
the door group.

Start Exit Start Exit Timer enables personnel within a secure area to exit
Timer that area without tripping an alarm. However, it stipulates that the
unqualified exit from an area can only proceed for a limited time.
The amount of time allowed is set at the Exit Delay Time field on
the Door Input Setup Property Sheet. The secured area is
defined by the door group.

Mask/Cancel This function cancels any entry delay value (as specified on the
Entry Delay Door Input Setup Property Sheet) and masks all interior line
modules for general building occupancy.
It can also mask inputs for occupancy of a specific area defined
by a door group while other areas remain unmasked.

Unmask/Start This function combines the start exit timer function with the
Exit Timer unmask function and is often used to re-secure either an entire
building or a specified area as defined by the door group.
The start exit timer is set by the Exit Delay Time field on the Door
Input Setup Property Sheet

Annunciate Cause a designated ScramblePad keypad's alarm annunciator to

beep five times.
When associated with a Master Control Zone, this action will
cause any ScramblePad included in the MCZ to beep five times.

Credential Templates 243

Velocity Version 3.1 Administrator’s Guide

Pre-arm Pre-Arm Status, also known as ‘Test If Secure’ or ‘Check Secure,’

Status tests all available inputs within the specified door group and
reports whether they are inactive (secure) or active (unsecured).
If all inputs are secure, the ScramblePad where this inquiry is
made flashes its green LED once for an access grant and twice
for a control. If there are unsecured inputs detected, the
ScramblePad flashes its red LED and beeps—one beep for each
active input.
This function is associated with a credential normally assigned to
an operator or guard who enters the credential at a reader or
ScramblePad in order to enquire about the status of the area
controlled by the device.
For an example of this, refer to “Example: Pre-Arm Status” on
page 922.

Conditional Also known as ‘Unmask If Secure,’ this function unmasks/arms

Unmask all inputs in the specified door group, but only if all inputs have
been previously detected as secure. If one point is unsecured
then the entire zone will not unmask.
For example, a window with a door contact is left open. When
the control zone is conditionally unmasked, the command fails
for the whole zone.
For an example of this, refer to “Example: Conditional Unmask”
on page 922.

244 Credential Templates

 MAN006-0612

Partial Also known as ‘Force Arm’ or ‘Arm Around,’ this function

Unmask unmasks all inputs in the specified door group that were
previously detected as secure. All unsecured inputs are left
unarmed.
Normally, of course, a system can only be unmasked if every
input within the prescribed area is currently secure. Otherwise,
any attempt to unmask the area would result in an alarm if one
or more of the inputs within the area is currently unsecured. The
Partial Unmask condition enables the Velocity to 'ignore' an
unsecured input and mask all the currently secured inputs it
detects within the area.
For example, if the boss leaves the safe in his office open, this
condition unmasks whatever inputs are already secure in the
vicinity of the safe, such as the door leading into the office and a
motion detector above the safe. In this way, even if the safe is
not closed, the office door can be unmasked and will notify the
system if anyone attempts to enter the office or approach the
safe without permission.
When this condition is used, the ScramblePad where this
credential is presented flashes:
• green LED if all inputs are detected secure
• red and green LEDs if some inputs are secure and others are
not
For an example of this, refer to “Example: Partial Unmask” on
page 923.

LED On Turns on the LED of the reader associated with this action. For
the procedure used to designate and activate a specific LED
through the Master Control Zone, refer to LED Enabling.

LED Off Turns off the LED of the reader associated with this action. For
the procedure used to designate and activate a specific LED
through the Master Control Zone, refer to LED Enabling.

Alarm functions are configured using the function pages of either credential dialog box
or the credential template dialog box.
The procedures used for invoking these functions are explained fully in the Velocity
Operators Guide, “Access & Control Functions” on page 203.

Input Control Functions

Input control functions are a subcategory of alarm functions that apply to all line
modules inputs whether they are bundled with a door or are separate. They are known
in the door lexicon as Access functions.

Credential Templates 245

Velocity Version 3.1 Administrator’s Guide

Common input control functions include:

Function Description Comments

Momentary Momentarily disables the When used, masks the specified

Mask reporting of a single alarm line module input for a single
condition from any of the alarm actuation only.
line module inputs defined
by the card/code's control
zone.

Mask Turns off reporting of all Line trouble reporting is not

alarms from any of the line disabled during alarm masking.
module inputs as defined by
the code's control zone.

Unmask Restores alarm reporting of Same as arming an alarm.

inputs defined by the code's
control zone.

Both Relay control and Input control functions are implemented by assigning a user
number with control code and an associated control zone.
Input functions are configured for individuals using the function pages of either
credential dialog box or the credential template dialog box.
The procedures used for invoking these functions is explained fully in the Velocity
Operators Guide, “Access & Control Functions” on page 203.

Control Functions
Control functions (also referred to as Output or Relay functions) affect the working of
devices such as electric strikes and door locks not associated with doors, as well as
elevator relays and all other devices that can be turned on or off.
In Velocity there are a large number of control functions:

Function Description Comment

Trigger Actuates the control timer for Trigger is a timed control

every relay specified by the function, like the Momentary
control zone. Once the timer access function: going on then
times out, the relays are returned turning off according to a control
to their default resting states. timer set to a predefined interval.
All other functions are either On
or Off.
A trigger can also be used to
trigger multiple actions in a
Master Control Zone.

Force ON Every relay in the control zone is Can affect both onboard and
actuated. The relay continues to expansion relays.
be actuated until released.

246 Credential Templates

 MAN006-0612

Function Description Comment

Force ON Returns all relays that were Can affect both onboard and
Release actuated by the Force ON expansion relays.
condition to their default resting
state.

Force OFF Disables all relays associated Particularly useful for x-ray rooms
with this control zone. or laboratories where no access
is granted during an examination
or experiment.

Force OFF Returns all relays that were

Release forced off by the Force OFF
control to their default resting
state.

Lock Disables all relays associated Particularly useful for facilities

Down with this control zone. where absolutely no one is
allowed within an area for a
specified time.

Lock This undoes the Lock Down

Down command and returns all relay
Release associated with this control zone
to the next highest condition
currently in effect.

Lock Actuates all relays associated

Open with this control zone.

Lock This undoes the Lock Open

Open condition and returns all relays
Release associated with this control zone
to the next highest condition
currently in effect.

The procedures used for invoking these functions is explained fully in the Velocity
Operators Guide, “Access & Control Functions” on page 203.

Credential Templates 247

Velocity Version 3.1 Administrator’s Guide

Priority Levels
Control functions involve increasing levels of priority as shown below:

Time Zone functions appear at this

priority level. For more on this, refer
to “Time Zone Control of Relays” on
page 249.

As shown above, control functions always override Access functions, represented by

the Momentary Unlock, Unlock, Relock, and Extended Lock functions. Since access
functions involve opening or closing a single door at the keypad/reader, this level of
function can be defined based on a single door or a door group.
Higher levels of control divide themselves into those control functions which are
considered mid-level and those that are considered high-level. Mid-level control
function—such as triggering or forcing relays—require you to define control zones since
they can involve more than a single relay at the current keypad/door. These
higher-level functions enable the user to control a large number of relays and other
outputs from a local keypad or card reader.
While Force and Lock functions are similar, Lock functions are placed at a higher priority
than Force functions and will override Force commands. This means that you can
construct sophisticated scenarios in which relays are locked open or down even while
they are currently forced on or off. In this way, layers of authority can control relays,
providing overrides and default conditions in the event of emergencies or failures. In
this control stack, each time a high-priority function is withdrawn it can expose an
underlying function still in effect.
For example, all relays in a control zone are forced on until the administrator enters a
Lock Down, which immediately disables all the relays; once the administrator has left
the area, the Lock Down is released and the relays are returned to a Force On
condition. The guard can then open and go through the door. Once the Force On

248 Credential Templates

 MAN006-0612

condition is released by a mid-level guard supervisor, a single door within the

controlled area can be entered by a qualified guard, who could not have opened the
door during the Lock Down.
Lock functions can also override time zones.

Time Zone Control of Relays

People often think of time zone functions as control functions. In the preceding chart,
Time Zone functions would go above Force functions but below Lock functions.
When time zones control relays, they are generally defined as being in one of three
states:

Relay State Description

Actuate Relays are actuated during a time zone, going on at the start
time of the zone and off at the end time of the zone.

Disable Relays are disabled during a time zone, becoming disabled at

the start of the zone and ending the disable condition at the
end of the time zone. During the time a relay is disabled, all
access and mid-level control functions, including RQE, are
disabled.

Clear Clears the current relay states for access and mid-level control
functions at the end of a given time zone. The clear relay state
does not affect relays controlled by a code of higher priority than
a time zone, such as Lock Down and Lock Open. This
automatically reverses a code- or card-activated relay from either
access and mid-level control without manually resetting the
relay.
This feature is most generally used in combination with a
manual Unlock by code or card to ensure an automatic Relock
by time zone.

For more information on relay states, refer to configuration information on Relays (page
167), Expansion Relays (page 172), or Doors Relays (page 157).

Password Functions
Password functions control operator access to local ScramblePad programming mode.
Passwords provide five levels of programming command restriction. Starting from Level
5 and going down to Level 1, each password level provides increasing types of
DIGI*TRAC commands as specified by the person's credential. Since access to
programming and password manipulation is an operator activity, the credentials that
control this function are usually assigned only to operator's who must use specific
DIGI*TRAC commands at specific keypads.

Hint Password Level functions are almost never used in Velocity since they involve
programming at the keypad, a procedure which Velocity is designed to circumvent.
For the most part, you can safely ignore these functions.

Credential Templates 249

Velocity Version 3.1 Administrator’s Guide

Any number of persons can be assigned to any password level. Each authorized person
is logged onto the system when programming mode is entered.
 Only one operator can be logged on at a time.
The five password levels are:

Priority Password Level Restrictions

1 System Password All Commands

2 Executive Password All Commands Except Passwords

3 Supervisor Password All Commands Except Setups

4 Operator Password All Except Setups & Add or Print Users With
Codes

5 Service Password All Setups & Print Status, No User

Commands

The Password function is selected through the 'Function Category' combo box on the
Credential Function page. The 'Function' combo box on the same page selects the
priority level this credential supports.

Special Functions
Special functions enable Velocity to provide sophisticated control of such features as
alarm cancel, the watch and time logs, the deadman timer, threat levels, and indexed
commands.
These include:

Special Description Comments

Functions

Alarm Cancel Cancel all alarms within the This function must be
specified zone. When you select selected in order to use the
this function, the 'Door Group' DIGI*TRAC Annunciator. For
combo box appears. more on this, refer to
Select the door group to which “DIGI*TRAC Annunciator” on
this function applies. The default is page 256.
all doors, always.

Watch Log Logs code entry for tracking This function doesn’t grant
guards on their appointed rounds. access, only records the
When you select this function, the guard’s progress.
'Door Group' combo box appears.
Select the door group to which
this function applies. The default is
all doors, always.

250 Credential Templates

 MAN006-0612

Special Description Comments

Functions

Time Log Logs code entry for recording the This function doesn’t grant
arrival and departure times of time access; it only records arrival
log code holders. When you select and departure for time card
this function, the 'Door Group' purposes.
combo box appears.
Select the door group to which
this function applies. The default is
all doors, always.

Deadman Starts a deadman timer at This function allows the

Timer code/card entry. If the timer system to track the safety
expires before the employee’s and security of a user while a
next code/card entry, an alarm is specific task is being
recorded. performed.
When you select this function, Deadman timers are
three combo boxes appear: common in many industrial
Controller, Control Zone, and Time applications such as
as shown here: railroads, refineries, and
other dangerous or
hazardous locations.

1. In the 'Controller' combo box,

select the controller to which
this timer applies.
2. In the 'Control Zone' combo
box, either select an existing
control zone or create a new
control zone <New> during
which this timer is used.
3. In the 'Time' combo box, select
the time in seconds during
which this timer is active.
4. Click Add to display this set of
conditions in the lower
window.
5. Repeat steps 1 - 4 to select
additional conditions if
required.

Credential Templates 251

Velocity Version 3.1 Administrator’s Guide

Special Description Comments

Functions

Indexed Specifies several subfunctions. If you select one of the

Command Combo box fields and windows Manual Holidays, this
appear like this example: forces the location where
this credential was used to
accept a holiday
immediately.
If you select one of the
Unholidays, this forces a
location where this
credential was used to
deselect a prevailing holiday.
If you select Forgive All
Select the subfunction you need.
Users, conditions for all
These options include:
users within a specific area
• Manual Holidays 1 - 4 (defined by the location
• Unholidays 1 - 4 where this credential was
used) are suspended,
• Forgive All Users
enabling rapid entry or exit.
• Clear Code Tamper
If you select Clear Code
• Count Users This Side Tamper, this cancels all
• Count Users Other Side code tamper alarms
registered within an area
For more on this, refer to “Indexed
defined by the location
Commands,” starting on page
where this credential was
253.
used.
If you select Count Users
This Side or Count Users
Other Side, this causes
Velocity to count the number
of users currently
inside/outside the area
defined by the
reader/keypad where this
credential was used.

252 Credential Templates

 MAN006-0612

Special Description Comments

Functions

Set Threat Sets a security (threat) level at the The range of available threat
Level reader/keypad where this levels are 0 (no threat/all
credential was used. Combo Box threat alarms cancelled) to
fields and windows appear like 99 (greatest threat).
this example: A user cannot issue a threat
level higher than the level
they are currently assigned.
For example, if an operator is
qualified to respond to
alarms up to threat level 50,
the operator cannot issue a
threat level alarm of 51 or
greater.
For more on threat levels,
When you select this function, the refer to “Threat Levels” on
'Set Threat Level' field appears. page 338.
Choose the threat level required.
Select the controllers where this
threat level applies. Use the <<
button to move a highlighted
controller from the All Controllers
window to the Selected Controller
window.

Indexed Commands
The following indexed commands are normally assigned by the administrator and
enable the specified credential to perform important ancillary activities.

Clear Code Tamper

Use this subcommand to clear all code tamper conditions at specific sites.
To clear code tamper:
1. Create or choose a credential or credential template.
2. Click the Function tab.
3. Click the Add... button.
The Define Function screen appears.
4. At the 'Function Category' combo box, select Special.
5. At the 'Function' combo box, select Indexed Commands.
The 'Indexed Command' combo box appears together with the 'Selected
Controllers' and 'All Controllers' windows.
6. At the 'Indexed Command' combo box, select Clear Code Tamper.
7. From the 'All Controllers' window, select one or more controllers whose
readers/keypads can accept this command.
8. Click the button to move a highlighted controller from the 'All Controllers'
window to the 'Selected Controller' window.
9. Click OK.

Credential Templates 253

Velocity Version 3.1 Administrator’s Guide

Count Users Other Side

Use this subcommand to count all users currently outside a specific site as defined by
the reader/keypad where this credential is used.
To count users on the other side:
1. Create or choose a credential or credential template.
2. Click the Function tab.
3. Click the Add... button.
The Define Function screen appears.
4. At the 'Function Category' combo box, select Special.
5. At the 'Function' combo box, select Indexed Commands.
The 'Indexed Command' combo box appears together with the 'Selected
Controllers' and 'All Controllers' windows.
6. At the 'Indexed Command' combo box, select Count Users Other Side.
7. From the 'All Controllers' window, select one or more controllers where this feature
can apply.
8. Use the button to move a highlighted controller from the 'All Controllers'
window to the 'Selected Controller' window.
9. Click OK.

Count Users This Side

Use this subcommand to count all users currently inside a specific site as defined by
the reader/keypad where this credential is used.
To count users on this side:
1. Create or choose a credential or credential template.
2. Click the Function tab.
3. Click the Add... button.
The Define Function screen appears.
4. At the 'Function Category' combo box, select Special.
5. At the 'Function' combo box, select Indexed Commands.
The 'Indexed Command' combo box appears together with the 'Selected
Controllers' and 'All Controllers' windows.
6. At the 'Indexed Command' combo box, select Count Users This Side.
7. At the 'New Controllers' window, select one or more controllers where this feature
can apply.
8. Use the button to move a highlighted controller from the All Controllers
window to the Selected Controller window.
9. Click OK.

Forgive All Users

Use this subcommand to forgive all conditions for users at specific readers/keypads.
To Forgive All Users:
1. Create or choose a credential or credential template.
2. Click the Function tab.
3. Click the Add... button.
The Define Function screen appears.

254 Credential Templates

 MAN006-0612

4. At the 'Function Category' combo box, select Special.

5. At the 'Function' combo box, select Indexed Commands.
The 'Indexed Command' combo box appears together with the 'Selected
Controllers' and 'All Controllers' windows.
6. At the 'Indexed Command' combo box, select Forgive All Users.
7. From the 'All Controllers' window, select one or more controllers whose
readers/keypads can accept this command.
8. Click the button to move a highlighted controller from the 'All Controllers'
window to the 'Selected Controller' window.
9. Click OK.

Manual Holiday Tables

Use this subcommand to force a holiday schedule (table) at a specific site.
To force manual holiday tables:
1. Create or choose a credential or credential template.
2. Click the Function tab.
3. Click the Add... button.
The Define Function screen appears.
4. At the 'Function Category' combo box, select Special.
5. At the 'Function' combo box, select Indexed Commands.
The 'Indexed Command' combo box appears together with the 'Selected
Controllers' and 'All Controllers' windows.
6. At the 'Indexed Command' combo box, select the Manual Holiday Table being
forced.
There are four holiday tables available; however, a holiday table is only relevant if it
has already been defined.
7. From the 'All Controllers' window, select one or more controllers whose
readers/keypads can accept this command.
8. Use the button to move a highlighted controller from the 'All Controllers'
window to the 'Selected Controller' window.
9. Click OK.

Manual Unholiday Tables

Use this subcommand to deselect a prevailing holiday schedule (table) at a specific
site. There are four Manual Unholiday Tables to choose from.
To force manual unholiday tables:
1. Create or choose a credential or credential template.
2. Click the Function tab.
3. Click the Add... button.
The Define Function screen appears.
4. At the 'Function Category' combo box, select Special.
5. At the 'Function' combo box, select Indexed Commands.
The 'Indexed Command' combo box appears together with the 'Selected
Controllers' and 'All Controllers' windows.
6. At the 'Indexed Command' combo box, select the holiday table you need to
deselect.

Credential Templates 255

Velocity Version 3.1 Administrator’s Guide

There are four holiday schedules available for deselection.

7. From the 'All Controllers' window, select one or more controllers whose
readers/keypads can accept this command.
8. Use the button to move a highlighted controller from the 'All Controllers'
window to the 'Selected Controller' window.
9. Click OK.

DIGI*TRAC Annunciator
Velocity supports the use of Hirsch's DIGI*TRAC Annunciator.
To configure the Annunciator for use with Velocity:
1. Open the Enrollment Manager.
2. Select or enroll a person or group of people who are allowed to use this device.
3. Create a new credential to activate this device.
Make sure this credential provides either a code or card by which the user can
activate the Annunciator.
4. Click the Function tab.
The function property sheet appears.
5. Select the Single Function radio button.
6. From the 'Function Group' combo box, select Special.
7. From the 'Function' combo box, select Alarm Cancel.
8. At the 'Door Group' combo box, select or create a door group at which the
Annunciator can be activated by the code or card.
9. Finish defining this credential as required.
Once this credential is assigned, each qualified user can activate and consult the
Annunciator as required.
For details on installing and connecting this device, refer to either the DIGI*TRAC
Design and Installation Guide or the DIGI*TRAC Annunciator Guide.

256 Credential Templates

 MAN006-0612

Door Groups
Door Groups answer the questions When and Where. The When is the Time Zone and
the Where is the Door (Reader).
 Door Groups allow you to decide what doors (readers) and at what time people are
allowed access to their building.
 Door Groups combine multiple doors (readers) together for a specific group of
people.
 Each door (reader) may be assigned the same or an individual time zone for access
After you have defined and named all doors connected to a controller or system, but
before you add users, you should create door groups. Most users will access more than
one door (reader) during the course of their daily activities. In order to save time
configuring each user for all the doors he/she will use, it is far easier to assign door
groups that include all the doors they are likely to use.

Hint While we talk about groups of doors here, what we are really grouping are the
readers associated with those doors. In many systems, only one reader is
associated with a door and in such circumstances the reader is the same thing as
the door. However, when you define doors which include both entry and exit
readers, you can theoretically create groups where the entry reader is part of the
group but the exit reader is not. In such circumstances, door groups are actually
reader groups.

For example, Mr. Smythe, a lab technician, must have access to five doors while Ms.
Gray, the receptionist in the lobby, only requires access to three doors. Mr. Blumenthal,
the CEO, of course, has access to all fifteen doors in the complex while Dr. Plumber,
the senior researcher (only slightly less important), has access to fourteen doors.
Instead of spending time assigning each door to Smythe, Gray, Blumenthal, and
Plumber, it is much easier and less time-consuming to assign one or more door groups
tailored to the needs of the company.
To define door groups, see “Door Groups: How to Define” on page 257.
You can also group defined Door Groups into Master Door Groups. For more on this,
refer to “ Master Door Groups” on page 263.

Door Groups: How to Define

To define a door group:
1. From the system tree window, expand the Velocity Configuration tree to display the
Door Groups folder.
2. Click and highlight the Door Groups folder.
All currently selected Doors Groups appear in the components window. You will
also see the Add New Door Group option.
3. Double click the Add New Door Group option.
The Door Group Configuration dialog box appears.
4. Enter a new name for this door group in the 'Door Group Name' text box.
5. In the 'Time Zone' combo box, select a time zone during which this reader or
group of readers is active.

Door Groups 257

Velocity Version 3.1 Administrator’s Guide

You can only select one time zone at a time here. To specify individual time zones
for individual doors, only select those doors and readers requiring a particular time
zone.
To create a new time zone for this purpose, select <New>. The Standard Time
Zones page appears. If required, you can click the Master Time Zones or Grand
Master Time Zones tab to access those pages. Once you've created the time zone
you want, click the button. You are returned to the Door Groups form with the
new time zone displayed in the 'Time Zone' combo box.
6. At the 'Display my network layout' box, do one of these:
• Check the box to display a tree depicting your network layout. Go to the next
step.
• Uncheck the box to display a list of all doors currently associated with this
system as shown below. Skip to Step 9.

Hint Many people add their doors without using the network layout. For example,
imagine you had one hundred M8 controllers and had to create a door group with
all doors. If you deselect the network layout, you could quickly pick the time zone,
select All Doors, then create a door group with all 800 doors. If you left it in
network layout mode, you would have to select each of the 100 controllers to pick
all doors. When not in network layout, you can either sort by the address column
or the door name column for more flexibility.

7. In the system tree window, expand the system tree until the relevant controller
appears.
8. Click to highlight the controller.
All currently selected readers appear in the available doors window to the right.
9. Check the box of each reader you want included in this door group.
To associate more than one time zone with the readers in this group, you can
select only those readers using a specific time zone, then assign a time zone to
those selections, then add them to the group. Once this is done, go back and
select the next time zone and select the doors for which this zone is appropriate.
For example, if you want to define a door group that includes Door 01 - Entry
(which is always available) and Door 01 - Exit (which is only available during the
graveyard shift), you would first select Door 01 - Entry and associate that with
<Always>, add it, then select Door 01 - Exit and associate that with <Graveyard>
before adding it.
10. Click Add.

258 Door Groups

 MAN006-0612

The selected readers appear in the bottom window with their address, door name,
and time zone displayed as in the following example:

11. When you're finished, click OK.

Door groups are used to define a person's credential functions.
Other procedures are:
 For instructions on defining master door groups, refer to Master Door Groups.
 For information on changing existing time zones for specific readers, refer to
“Changing Time Zones For Door Groups” on page 259.
 To remove a reader from the current group, select the door in the lower window
and click Remove. The selected door is removed from the bottom window and is
returned to the right (available doors) window.

Changing Time Zones For Door Groups

To change one or more time zones for a door group:
1. From the system tree window, expand the Velocity Configuration tree to display the
Door Groups folder.
2. Click and highlight the Door Groups folder. All currently selected Doors Groups
appear in the components window.
3. From the components window, double click the door group you want to modify.
The Door Group Configuration dialog box appears. For more on this, refer to “Door
Groups: Properties dialog box” on page 261.
4. Highlight the door(s) in the bottom window you want to edit.
You may highlight multiple doors to make more than one change at a time:
• To select a consecutive group of doors, press your Shift Key and click the first
and last doors in the sequence.
• To select a non-consecutive group, press the Ctrl Key and click each door you
want.
5. Click the Edit button.

Door Groups 259

Velocity Version 3.1 Administrator’s Guide

The Edit Time Zone dialog box appears like this example:

6. Select a time zone from the pull-down combo box and click OK.
The door appears with the new time zone displayed in the Time Zone column.
7. When you're finished, click OK.

Door Groups: Cloning

You can speed the process of adding new door groups by cloning an existing door
group. This not only saves a copy of the selected door group but enables you to
rename it at the same time.
To clone door groups:
1. From the system tree window, expand the Velocity Configuration tree to display the
Door Groups folder.
2. Click and highlight the Door Groups folder.
All currently selected doors groups appear in the components window.
3. Right click the existing Door Group you want to clone.
A pop-up menu list appears.
4. Select Save As... from the list.
The Save As Door Group dialog box appears.

5. Specify a new door group name and press OK. The door group is created.
6. Make changes to this door group as required.

260 Door Groups

 MAN006-0612

Door Groups: Properties dialog box

The fields and buttons on this dialog box are explained below:

Door Group Enter a name for this door group.

Name

Tag Click this checkbox to indicate that this door group is tagged.
For more on this topic, refer to “Tagging” on page 892.

Alert Click this checkbox to indicate that this door group alerts every
time it is used.
For more on this topic, refer to “Alert” on page 892.

Doors

Time Zone This defines the time a selected door is active.

From the drop-down option list, select one of the currently
available time zone options including <Never>, <Always>, or
one of the currently-defined time zones.
To create a new time zone for this purpose, select <New>.
The Standard Time Zones page appears. If required, you can
click the Master Time Zones or Grand Master Time Zones tab
to access those pages. Once you've created the time zone you
want, click the button. You are returned to the Door
Groups form with the new time zone displayed in the 'Time
Zone' combo box.

System Tree All available components on this system appear in this pane. To
pane view this pane, you must have the 'Display my network layout'
box checked below the pane; otherwise, only the available
door pane window appears displaying all currently defined
doors throughout the system as shown in the example below.

Door Groups 261

Velocity Version 3.1 Administrator’s Guide

Available Door All currently available doors (for either the selected controller or
pane for the entire system) appear in this pane. The available doors
for the entire system appears in this window if the 'Display my
network layout' box is not checked.

Select All Click this button to check all of the doors displayed in the
Available Doors pane.

Deselect All Click this button to uncheck all of the doors displayed in the
Available Doors pane.

Add Click this button to select all doors checked in the Available
Door pane for this door group.
All doors added here are moved to the Selected Door pane.

Display my Uncheck this box to hide the System Tree pane; the currently
network available doors for the currently selected controller appear in
layout the single pane with their addresses and index values as shown
in this example:

Check one or more of these doors as needed to include them

in the current door group then click Add.

Selected Doors All doors selected from the Available Doors pane (checked and
pane added) appear in this window.

Remove Click this button after selecting a door from the Selected Doors
pane to remove a door from this door group and return it to
the Available Doors pane.

Edit Click this button after selecting a door from the Selected Doors
pane to change its time zone.
For more on this, see changing time zones for door groups.

262 Door Groups

 MAN006-0612

Master Door Groups

You can group Door Groups into Master Door Groups in much the same way as you
create Master Time Zones. This enables you to group doors from the same or different
controllers and different locations.
Before you can create master door groups, you must first define one or more door
groups.
To define master door groups:
1. In the System Tree pane, expand the Velocity Configuration folder until the Door
Groups subfolder appears.
2. Click to highlight the Door Groups folder.
3. In the Components pane, double click Add New Master Door Group.
The Add New Master Door Group properties page appears.

The Master Door Group Properties page includes these fields and windows:

Master Door Enter the name for this master door group.
Group Name

Tag Click this checkbox to indicate that this master door group is
tagged.
For more on this topic, refer to “Tagging” on page 892.

Alert Click this checkbox to indicate that this master door group
alerts every time it is used.
For more on this topic, refer to “Alert” on page 892.

Contains: This window includes all door groups assigned to this Master
Door Group.

Does not This window lists all currently-defined door groups not
contain: currently assigned to this Master Door Group. Initially, this
contains all defined door groups.

Move the selected door group(s) from the Does not contain
to the Contain window.

Door Groups 263

Velocity Version 3.1 Administrator’s Guide

Move all of the door groups from the Does not contain to the
Contain window.

Move the selected door group(s) from the Contain window

to the Does not contain window.

Move all the door groups from the Contain window to the
Does not contain window.

4. At the 'Master Door Group Name' text box, enter a name for this master door
group.
5. Check the Tag and/or Alert boxes to tag or alert this master door group.
6. In the 'Does not contain:' window, click to highlight one or more currently-defined
door groups.
To select two or more non-consecutive door groups, hold down Ctrl while you
click. To select consecutive door groups, hold down Shift and click.
7. Click the button. All selected door groups are moved to the 'Contain:'
window.
To select and include all of the door groups listed in the 'Does not contain:'
window, click the button.
To remove door groups from the ‘Contains’ window:
a. Select one or more door groups from ‘Contains’ window. To select two or more
door groups, use the Ctrl and Shift keys as specified in Step 6.
b. Click the button. The door groups are moved back to the ‘Does not
contain’ window.
To remove all of the door groups from the ‘Contains’ window, click the key.
8. When you're finished, click OK.
 A master door group must not exceed more than 8 door groups that
include doors from the same controller. If you exceed this limit, the
Conflicts Detected screen appears. Use this screen to edit your master
door group.

264 Door Groups

 MAN006-0612

Function Groups
Function groups combine the concept of the code extension digit with a control
function. By adding extension codes to a regular PIN code, a qualified person can
activate many different activities. For example, the first person to enter a building in the
morning could enter a function group extension that opens the front door, turns on the
lights, starts the air conditioner, and masks all alarms. Once defined, each function
defined for a function group can be activated by any qualified user belonging to the
relevant function group.
 Velocity 3.1 supports up to 255 function groups.
To use a function group, you must:
 define tasks this group can perform and assign each task a different extension digit
using the Function Group Properties dialog box. (If a particular task is always
performed when a member of this group enters a code or card, then no extension
code is entered.)
 assign function groups to credentials through the Credential function property sheet
or the Credential Template function property sheet.
 assign the credential or credential template with that function group to persons
through the Enrollment Manager.
For information on the basics of functions, refer to “Functions,” starting on page 241.

Function Groups: How to Define

To define a function group:
1. From the system tree window, expand the Velocity Configuration tree to display the
Function Groups folder.
2. Click to highlight Function Groups.
All currently defined Function Groups appear in the components window. In
addition, the Add New Function Group option appears.
3. Double click Add New Function Group.
The New Function Group Properties dialog box appears. For more on this, refer to
“Function Group Properties Dialog Box” on page 267.

Hint A quick way to create a new function group is to copy and rename an existing
function group then modify it using Steps 5 - 8.

4. Type a new name in the ‘Function Group Name’ field.

Use up to 32 characters for the name.
5. Perform one of these operations:
• To define a new function, click the Add... button
• To edit an existing line, select the line you need to edit from the Code
Extensions window, then click the Edit... button
• To delete an existing line, select the line you want to delete from the Code
Extensions window, then click the Delete button. You are prompted to
confirm you choice. Select Yes to delete the code extension
If you clicked either Add or Edit, the Define Extension dialog box appears. For more
on this, refer to “Function Groups: Define Extension Dialog Box” on page 269.

Function Groups 265

Velocity Version 3.1 Administrator’s Guide

For more on the process of defining code extension digits, refer to “Defining Code
Extensions” on page 270.
6. Specify either a code extension indicating the extension code that triggers this
function or a blank indicating that the associated function is triggered whenever
this function group is invoked.
A code extension is a number between 1 and 99 that follows the normal user PIN
code. This code extension is usually preceded by an asterisk in this manner:
6739*5 where the 5 is the code extension. For more on this, refer to “Defining
Code Extensions” on page 270.
7. Click Add...
The Define Function dialog box appears. For more on this, refer to “Define Function
Dialog Box” on page 271.
8. At the 'Function Category' combo box, select the category you require from the
drop-down list.
Options include: Access, Relay, Alarm, Password, or Special.
9. At the 'Function' combo box, select the relevant function from the drop-down list.
The functions that appear depend on which category you select in the 'Function
Category' pick list. For example, if you select Access, the available functions are
Momentary, Unlock, Relock, and Extended.

Hint You can define only one function per code extension and that code extension can
only apply to one controller. This means that if you attempt to define two functions
involving a single controller for a single code extension, you will get an error
message.

For example, if you try to define the extension digit 3 with both Momentary Access
for Door Group 1 (which is attached to Controller 1) and Relay Trigger for
Controller 1, an error message will appear. If, however, you define the same digit
with both a Momentary Access for Door Group 1 and Relay Trigger for Controller 2,
this is accepted, since you have two functions that are affecting two different
controllers.

10. At the 'Door Group' combo box, specify either a Door Group or Master Door Group
to which this function applies.
Only those door groups currently defined by the system appear in the drop-down
list. To create a new door group or master door group, select either <New Door
Group> or <New Master Door Group> from the drop-down list. You are taken
to the relevant door group property sheet.
11. When you're finished, click OK.
You are returned to the Define Extension dialog box. The newly defined function
appears in the Function(s) window. If you have defined an access function, it
appears in the Access Function subwindow; if you defined a control function, it
appears in the Control Function subwindow.
If no extension code is specified on the Define Extension dialog box, it indicates
that whenever this function group is invoked, the associated functions are instantly
activated.
12. To define additional extensions and associate them with the required functions,
repeat steps 7 - 11.
13. When you're finished, click OK.

266 Function Groups

 MAN006-0612

You are returned to the New Function Group Properties dialog box.
The new code extension is displayed in the Code Extensions window like the
following example:

Code Extensions

Notice that where no code extension is defined for this function, a set of angle
brackets, <>, appear in the Extension column of the Code Extensions window. Also
notice that each code extension supports only a single function per controller. You
will get an error message if you try to define two or more functions for the same
code extension and controller.
14. To define more code extensions, repeat steps 5 - 13.
15. When you're finished, click OK to confirm your current choices and exit.
The main Velocity menu reappears.
Once you're finished, you can immediately download the new function group
information to the relevant controller(s). For more on this, refer to “Downloading
Controller Configurations,” starting on page 75.
You can save time in creating multiple function groups by cloning and modifying them.
For more on this, refer to “Function Groups: Copying,” starting on page 272.

Function Group Properties Dialog Box

The Function Group Properties dialog box looks like this example:

Function Groups 267

Velocity Version 3.1 Administrator’s Guide

This dialog box contains these fields and buttons:

Name Enter the name of this function group. Maximum is 32

characters.

Code This window lists all existing code extensions defined for this
Extensions function group and the function they perform. This enables a
window qualified person to type in an additional number after the star
or asterisk key on the keypad to perform the specified task.
This window has three columns:
• Extension displays the currently defined extension digit for
this function. If no code extension is specified, angle brackets
appear in the code extension column, <>.
• Function displays the function defined for the extension digit.
• Detail defines the door group or controller/control zone
affected by this extension digit (as shown in the example
above).
To edit a code extension item, simply click on the extension line,
then click the Edit button. The Define Extension dialog box
reappears. Make changes to the line as you require.
Code extensions are defined in the Define Extension dialog box.
For more on defining code extensions, refer to “Defining Code
Extensions” on page 270.

Add... Click this button to create a new code extension and associate a
function with it. The Define Extension dialog box appears.
For more on defining code extensions, refer to “Defining Code
Extensions” on page 270.

Edit... Select an existing code extension line from the Code Extensions
window then click this button to modify the code extension.
The Define Extension dialog box appears.
For more on defining and modifying code extensions, refer to
“Defining Code Extensions” on page 270.

Delete Select an existing code extension line from the Code Extensions
window then click this button to delete the selected extension.
The extension is deleted but not made permanent until you
click OK to exit this dialog box.
To restore a function extension you have just deleted, click
Cancel.

268 Function Groups

 MAN006-0612

Function Groups: Define Extension Dialog Box

The Define Extension dialog box looks like this example:

The Define Extension dialog box includes these fields:

Extension Enter an extension code from 1 - 99.

Digits If you leave this field blank, it indicates that no code extension is
required.

Add... Click this button to display the Define Function dialog box and
define new functions that are triggered by the specified extension
digit.

Edit... Click this button to display the Define Function dialog box for a
function highlighted in the Function(s) window. Modify the
values on this page as required.

Delete Click this button to delete the function highlighted in the

Function(s) window. The function disappears from the window.
If you change your mind after you delete a function, simply click
the Cancel button and the function is reinstated; otherwise, to
confirm your selection, click OK.

Function(s) This window displays all the functions currently defined for this
extension and function group. This window is divided into
subwindows: Access Function and Control Function.
No extension digit can support more than one function, whether
access or control, per controller. For example, if you try to define
the extension digit 3 with both Momentary Access for Door
Group 1 (which is attached to Controller 1) and Relay Trigger for
Controller 1, an error message will appear. If, however, you
define the same digit with both a Momentary Access for Door
Group 1 and Relay Trigger for Controller 2, this is accepted, since
you have two functions that are affecting two different
controllers.

Function Groups 269

Velocity Version 3.1 Administrator’s Guide

Defining Code Extensions

Use this procedure to define a code extension for one or more functions.
The code extension follows the normal PIN separated by an asterisk, in this way:
95684*4, where 4 is the code extension. This enables a user to perform one or more
tasks using the same PIN.
 The asterisk is represented on the ScramblePad keypad as the blank key
above the START button. The execute command button, referred to as the
# key, is the lower right key. The stylized image below displays these
keys:

To define a code extension:

1. Access the Function Group Properties.
The Function Group Properties dialog box appears.
2. Do one of these:
• To add a new code extension, click the Add... button.
• To edit an existing code extension, click to highlight an existing code extension
in the Code Extensions window and click the Edit... button.
The Define Extension dialog box appears.
3. At the 'Extension Digits' text field, enter the extension code you require for this task.
Enter a number from 1 to 99. If you leave this field blank, it indicates that no code
extension is required.
If you leave this text field blank, it means there is no code extension required for
this function.
4. Click the Add... button to define one or more functions that are triggered by the
entry of this code extension.
The Define Function dialog box appears.
5. At the 'Function Category' combo box, select the category you require from the
drop-down list.
Options include: Access, Relay, Alarm, Password, or Special.
6. At the 'Function' combo box, select the relevant function from the drop-down list.
The functions that appear depend on which category you select in the 'Function
Category' pick list. For example, if you select Access, the available functions are
Momentary, Unlock, Relock, and Extended.

270 Function Groups

 MAN006-0612

 You can define only one function per code extension and that code
extension can only apply to one controller. This means that if you
attempt to define two functions involving a single controller for a single
code extension, you will get an error message.
7. At the 'Door Group' combo box, select the door group or master door group to
which you want these functions to apply.
Only those door groups currently defined by the system appear in the drop-down
list. To create a new door group or master door group, select either <New Door
Group> or <New Master Door Group> from the drop-down list. You are taken
to the relevant door group property sheet.
8. Click OK.
You are returned to the Define Extension dialog box. The newly defined function
appears in the Function(s) window. If you have defined an access function, it
appears in the Access Function subwindow; if you defined a control function, it
appears in the Control Function subwindow.
9. Click OK again to return to the Function Group properties screen.
The code extension you just defined or edited appears in the Code Extensions
window.
10. Click OK again to exit the Function Group properties screen and return to the main
Velocity screen.

Define Function Dialog Box

The Define Function dialog box looks like this example:

The fields on this screen are explained below:

Function Select the category you need from the drop-down list. There are
Category five options:
• Access
• Relay
• Alarm
• Password
• Special
For more on this, refer to “Functions,” starting on page 241.

Function Groups 271

Velocity Version 3.1 Administrator’s Guide

Function Select the option you need from the drop-down list. Depending
on which category you selected above, the options differ as shown
below:
Depending on which category you selected above, the options
differ as shown below:
Door Group If you select Access, Special, or Password, this field appears.
Select the door group this code extension affects from the
drop-down option list.
To create a new door group for this purpose, select <New> and
the Door Group Configuration dialog box appears.
Controller If you select Relay or Alarm, this field appears.
Select the controller this code extension affects from the
drop-down option list.
Note: Only those controllers currently defined for the system appear in
this list.
Control Zone If you select Relay or Alarm, this field appears.
Select the control zone this code extension affects from the
drop-down option list.
Both SCZs and MCZs are displayed. If no control zone is affected,
specify <No Control>.

Function Groups: Copying

One of the easiest ways to create new function groups is to copy an existing function
group then modify it as you need.
To copy and edit an existing function group:
1. From the System Tree pane, expand the Velocity Configuration folder until the
Function Groups folder appears.
2. Click to highlight the Function Groups folder.
The currently defined function groups appear in the Components pane.
3. Right click the function group you want to use as the model for the new function
group.
A list of options pops up.
4. Select Save As... from the pop-up list.
The Save As dialog box appears.
5. In the name text box, enter a new name for this function group and click OK.
The newly named function group appears below the function group from which it
was cloned.
6. Double click on the newly-named function group and modify the new function
group as required.
For more on creating and modifying a function group, refer to “Function Groups:
How to Define,” starting on page 265.
7. Download the new function group information to the relevant controller(s). For
more on this, refer to “Downloading Controller Configurations,” starting on page
75.

272 Function Groups

 MAN006-0612

Function Groups: Examples

Example 1: Access + Unlock/Relock
A simple access and unlock/relock example is shown below:

In this function group, 'Access + Unlock Relock', three codes are defined.
The main root code is defined as 2495:
 Momentary Access for this group results from entering the code without extensions:
2495#.
 Unlock is achieved for this group by entering 2495*1#.
 Relock is accomplished for this group by entering 2495*2#.
Each extension digit and the function it activates are defined by clicking the Add...
button as specified in “Function Groups: How to Define” on page 265.
This means that any member of this group using the specified code can enter a door
on a timer. By entering the extension code 1, the door is unlocked and remains
unlocked until the extension digit 2 is entered at which time the door is immediately
relocked.

Function Groups 273

Velocity Version 3.1 Administrator’s Guide

Example 2: Lock Down

Another example, demonstrates how you can use function groups to define a relay lock
down condition.

In this function group, 'Access + Lock Down', three codes are defined. The root code is
defined as 2495.
 Momentary Access for this group results from entering the code without extensions:
2495#.
 Lock Down is achieved for this group by entering 2495*1#.
 Lock Down Release is accomplished for this group by entering 2495*2#.
This means that any member of this group using the specified code can enter a door
on a timer. By entering the extension code 1, Lock Down is imposed on the door relay.
When Lock Down is no longer required, the extension code 2 is entered and the relay
releases.

274 Function Groups

 MAN006-0612

Operators
Operators are the people who run the Velocity system. Like badge holders, operators
must have card and/or code access to some part of the security system.
In addition, however, operators have access to all or part of Velocity operations and
functions. This requires that they be provided with permissions and grants, allowing
them to use at least a portion of Velocity's functions.
For more on defining and enrolling operators, see “Operators: How to Enroll” on page
275.
Before Velocity operators can function within a Windows domain, they must first be
defined as Windows administrators. For more on this, refer to “Domain Administrators”
on page 280.

Operators: How to Enroll

To define and enroll an operator:
1. From the system tree window, select the Velocity configuration tree.
2. Expand the Velocity configuration tree.
The Operators folder appears.
3. Click and highlight the Operators folder.
The current operators appear in the components window.
In addition there is an Add New Operator option.
4. Double click the Add New Operator option in the components window.
The Operator Properties dialog box appears with the General property sheet
showing.
5. At the General property sheet, supply values as required.
To enroll a person already defined as a user of this Windows machine, save time
by clicking the Find... button and select the person. The person's name and
current password are supplied.
6. Click the Roles tab.
The Roles property sheet appears.
7. Select one or more roles to which this operator belongs. Use one of these
procedures:
• Select the role(s) you want from the 'Not a Member of' pane then click the
Add... button.
• Double click the role(s) you want from the ‘Not a Member of’ pane. The role
is moved to the ‘Member of...’ pane.
Only those roles previously defined for the system appear in these panes.From the
'Workstation' combo box, select the workstation for which these permissions apply.
 Only those operators who are members of the default Administrators
role can create roles or assign permissions to that role. No other role can
be created that gives access to the role creation task.
Once an operator is enrolled, you can assign a role to him/her through the Roles
Member folder.

Operators 275
Velocity Version 3.1 Administrator’s Guide

If you have assigned two or more roles to the same operator, there may arise
conflicts between one role that allows a particular feature and another that does
not. In order to reconcile these conflicts, Velocity has designed several conflict
rules.
8. When you're finished, click OK.
The new operator appears in the components window under Operators.
 If an operator is a member of two or more roles with conflicting
permissions, the role with the greater permission generally takes
precedence; however, if this is a hardware permission (DIGI*TRAC
folder) then the most restrictive role is accepted. For more on this, refer
to “Operators: Conflicting Roles” on page 280.
Large systems that serve many people often require more than one operator with
domain administrator privileges, such as Velocity operator assignment and password
allocation. In order to assign domain administrator privileges, you must first define the
person as a Velocity operator, then define that Velocity operator as a domain
administrator. Only a person who currently possesses domain administrator privileges
can perform this procedure.
For more on this, refer to “Domain Administrators” on page 280.

Operator Properties Dialog Box

The Operator configuration dialog box is divided into three property sheets:
 General property sheet
 Roles property sheet
Each of these sheets is discussed below:

General Property Sheet

The Operator General properties sheet looks like this example:

These fields defines the basic information for each operator.

276 Operators
 MAN006-0612

Hint If you have installed Velocity on an existing Windows machine, you can save time
by using the Find... button to quickly identify each Windows user you want to
make a Velocity user. The person's name and password are automatically
supplied.

Name Type the name of the new operator.

Description Type a brief description of the operator's duties or title, if

required.

Windows Credential

Password Type the new password for this operator.

Confirm Retype the new password.

Password The 'Password' and 'Confirm Password' entries must match. If
they don't, an error message appears. Retype the password.
Note: You must be logged on as an administrator or a member of an administrators group
in order to activate or disable the four Windows Credential check boxes.

User must When checked, it indicates that this password is only good until
change the operator logs on for the next time. At this point, he/she
password at must change their password again. This box is checked by
next logon default.
This increases the level of security but makes it more difficult
for the operator to memorize a password. (You must be logged
on as an administrator or a member of an administrators group
in order to activate or disable these features.)
When this box is cleared, both the 'User cannot change
password' and 'Password never expires' check boxes are
activated.

User cannot Check this box to indicate that this operator cannot change
change his/her password. Only the administrator or a member of the
password administrator group other than this operator can change this
password.
This box can only be activated by deselecting the 'User must
change password as next logon' box.
(You must be logged on as an administrator or a member of an
administrators group in order to activate or disable these
features.)

Password Check this box to indicate that the operator's password never
never expires expires.
This box can only be activated by deselecting the 'User must
change password at next logon' box.
(You must be logged on as an administrator or a member of an
administrators group in order to activate or disable these
features.)

Operators 277
Velocity Version 3.1 Administrator’s Guide

Account is Check this box to indicate that the current operator account is
disabled disabled.
The assigned operator cannot access Velocity until this box is
unchecked by another member of the administrators group.
(You must be logged on as an administrator or a member of an
administrators group in order to activate or disable these
features.)

Find... Click this button to display the Users dialog box and find the
user you want to identify.
This shortcut enables you to identify existing Windows users
and assign them as Velocity operators. Their current name and
password is automatically supplied. This saves time when you
have installed Velocity on an existing Windows machine where
many operators have already been identified.

Restrict by Check this box to indicate that this operator's activity on Velocity
Shift: is restricted to certain times.
Any attempt to use Velocity outside of the start and end range
specified below results in an alarm and the request for access
to Velocity is denied.

Start: The time when the operator's shift begins. If the 'Restrict by
Shift' box is checked, this field is active. Designate a start time in
one of these ways:
Click in the first field, enter a value (either by typing a value or
pressing the up or down cursor buttons), then press the right
cursor button to continue to the second field. Repeat this
process for each field until the time is complete.
Click the spin control buttons to increase or decrease the time.

End: The time when the operator's shift ends. If the 'Restrict by Shift'
box is checked, this field is active. Designate an end time in one
of these ways:
Click in the first field, enter a value (either by typing a value or
pressing the up or down cursor buttons), then press the right
cursor button to continue to the second field. Repeat this
process for each field until the time is complete.
Click the spin control buttons to increase or decrease the time.

Auto lock Check this box to indicate that Velocity locks up the workstation
workstation after a designated number of minutes have elapsed.
after x minutes Either enter a value by typing in the following field or use the
of idle time spin control buttons next to the minutes field to change the
minutes.
If this box is cleared, it indicates that the Velocity workstation
does not lock after a certain number of minutes.

Acknowledge Indicate the priority level of event this operator is allowed to

alarms up to view.
level The range is 1 - 99 with the default 99 (the highest).

278 Operators
 MAN006-0612

Operator Roles Properties Sheet

The Roles tab of the Operator Properties sheet looks like this example:

This page enables the qualified operator to define the role(s) of which the selected
operator is a member.
This page includes these windows:

Member of... This window includes a list of all roles of which this operator is
a member.
You add roles to this window using the Add... button and
remove roles from this window using the Remove button.
Alternatively, double click the role you want to move and it is
automatically moved to the other window.

Not a Member This window includes a list of all currently-defined roles of

of... which this operator is not a member.
You move roles of this window to the Member of... window
using the Add... button. Alternatively, double click the role you
want to move and it is automatically moved to the other
window.

Remove Click this button after selecting a role in the Member of...
window to remove that role from that window and place it
back in the Not a Member of... window.
Alternatively, simply double click the selected role and it is
moved automatically to the other pane.

Add... Click this button after selecting a role from the Not a Member
of... window to move that role from that window to the
Member of... window.
Alternatively, simply double click the selected role and it is
moved automatically to the other pane.

Operators 279
Velocity Version 3.1 Administrator’s Guide

To enroll this operator as a member of a role:

 From the Not a Member of... window, click to select a role you want to make this
operator a member of. Click Add...
 From the Not a Member of... window, double click the selected role and it is
automatically moved to the Member of... window.
The selected role(s) move to the Member of... window. All the rights and permissions
defined for each role in the Member of... window now apply to this operator.
You can also add an operator to a role through the Member folder in the Role
properties sheet.
To unenroll this operator as a member of a previously selected role:
 From the Member of... window, click to select a role you want to remove. Click Add...
 From the Member of... window, double click the selected role and it is automatically
moved to the Not a member of... window.

Operators: Conflicting Roles

If you assign two or more roles to the same operator, there will inevitably arise
differences between access permissions. In general, Velocity gives priority to the role
with the most permission and access. This rule applies to all Velocity program folders
except the DIGI*TRAC folder. For example, Role A might allow the operator to use
Enrollment Manager, whereas Role B restricts the use of Enrollment Manager. In this
case, Role A is observed since it gives the greater access of the two.
This rule does not apply to the DIGI*TRAC folder which handles all hardware
restrictions. In this case, the most restrictive role is always observed. For example, if
Role A does not allow access to Controller 3 and Role B does allow it, then Role A is
always observed.

Domain Administrators
By default, only the domain administrator can define Velocity operators. This means
that responsibility for defining new operators is often assigned to one person. On a
small system this default is probably desirable. On larger systems, however, there are
many conditions under which this arrangement is unrealistic or inefficient. Most large
Velocity installations require more than one person who can create operators for
Velocity.
Only a person currently possessing domain administrator privileges can assign another
operator those privileges.
 You cannot create an administrator within Velocity with the authorization
to create operators. You can only create a domain administrator using
Windows 2000 Server.
To create additional domain administrators to handle the task of creating Velocity
operators:
1. If you haven't already, create the operator definition within Velocity for the person
you want to make the Velocity administrator.
2. Exit Velocity.
3. On the domain controller's Windows 2000 Server desktop, double click the My
Network Places icon.
The My Network Places screen appears.

280 Operators
 MAN006-0612

4. Double click the Entire Network icon. The Entire Network screen appears.
5. Click the entire contents hyperlink at the bottom of the page.
This is the underlined blue link within the sentence 'You may also view the entire
contents of the network.' The Entire Network screen changes to display several
icons.
6. Double click the Directory icon. The network directory expands to reveal folders
within the directory.
7. Double click the Velocity domain icon.
The Velocity domain folder expands. One of these folders should be the Users
folder.
8. Double click the Users folder.
The Users folder expands. One of the subfolders should be the Domain
Administrators folder.
9. Double click the Domain Admins folder.
The Domain Admins Properties sheet appears.
10. Click the Add... button.
The Select Users, Contacts, or Computers screen appears with a list of all available
operators (users).
11. From this list, click to highlight the name of the user you want to provide with
administrator privileges.
12. Click Add. The name is added to the lower window.
13. Click OK twice.
14. Exit to the Windows desktop.
Next time the specified operator signs onto Windows, that operator will be able to
exercise operator creation privileges within Velocity.

Locking Down Operators

There are occasions when an operator may need to be restricted immediately from
using any workstation in the Velocity system. This occurs when the operator has been
summarily fired or compromised in some way. To bar this person access to any
workstation until that person can be escorted from or leave the building, use this
procedure:
1. At the system tree pane in the Administration window, expand the Velocity
Configuration folder.
2. Click to highlight the Operators folder.
All currently defined operators appear in the components pane.
3. Right click on the operator you want to lock down.
4. From the pop-up option list, select Lock Down.
A prompt appears asking you to confirm your selection.
5. Click Yes.

Operators 281
Velocity Version 3.1 Administrator’s Guide

A red icon appears in the place of the operator icon, like the following example:

The operator is now locked down and cannot use any workstation in the Velocity
system.
You can also lock down a specific workstation by using the Workstation Lock Down
feature. See “Locking Down Workstations,” starting on page 335.
To release a locked down operator:
1. Repeat Steps 1 - 3 of the previous instructions.
2. From the pop-up option list, select Enable.
A prompt appears asking you to confirm your selection.
3. Click Yes.
The red icon is replaced by the normal operator icon.

282 Operators
 MAN006-0612

Person Templates
Create person templates to expedite the task of enrolling people into the Enrollment
Manager. Using this shortcut, a qualified operator can automatically populate new
employee forms with pertinent values.
For more on this, refer to “Person Templates” on page 802.
To define a new person template:
1. From the main System Tree pane, expand the Velocity Configuration folder until the
Person Templates folder appears.
2. Click to highlight the Person Templates folder.
All currently defined Person Templates appear in the Components pane.
3. From the Components pane, double click the Add New Person Template
option.
The Add New Person Template page appears like this example:

4. In the 'Template Name' text box, enter a template name for this new person
template.
5. At the General tab, enter all appropriate values for the fields you require.
You don't need to supply values for every field that appears here, only those fields
that are relevant to a group of people. For instance, if you want to create a person
template for Research and Development, you might select 'Research &
Development' from the Division pick list, enter the company name in the
Company field, enter the base phone number for the R & D Department in the
Business Phone field.
Any field you leave blank will require a new value when this person is enrolled.
Only those fields previously defined using the User Defined Fields feature appear
on this screen. For more on user-defined fields, refer to “User-Defined Setup” on
page 778.
6. If required, click additional tabs to reveal pages possessing fields you need to enter.
7. If required, click the Groups tab and specify to which Person Groups a member of
this Person Template belong.
8. When you're finished, click OK.
The new person template is added to the component window list.
9. Click Cancel to exit this screen.

Person Templates 283

Velocity Version 3.1 Administrator’s Guide

The new Person Template appears in the Components window. When a qualified
operator enrolls a person using a Person Template, this template appears in the ‘Select
Person Template’ window as shown on page 865.

284 Person Templates

 MAN006-0612

Roles
A large Velocity system can require many operators, working at different stations and
overseeing different aspects of the system. Only one or two of these operators, such as
the installer or administrator, will have access to every system feature. Most operators
will only need to see a portion of the system, or access a few of the features. In order
to assign access rights and privileges to many operators, Velocity created a new
concept: the role. A role is a list of tasks and features that are available to operators
who are assigned that role.
Roles streamline the process of assigning rights and privileges to operators by defining
many of the attributes for an entire class of operators in advance. Once you have
defined a set of roles, you can assign a new operator one or more of these roles,
supply personal information, and the operator is defined. You cannot qualify an
operator to use a module or feature that is not allowed by the role(s) of which they are
a member.
For example, if you create a role that allows access to every Velocity module except
Customization Manager, then any operator who is a member of that role can use any
Velocity module except Customization Manager, unless the operator is also a member
of another role that does allow access to Customization Manager. Or imagine a role
that enables its members to access Cameras 1 – 6 of a CCTV system, but blocks
access to Cameras 7 – 12.
Roles can be defined broadly or narrowly, enabling access to large blocks of the
system, or to small details, like individual doors or inputs. For instance, if you need to,
you can even create a role that restricts members to what port events they can view.
If you need to change an operator's duties, create a new role (often by modifying a
renamed or copied role), then apply that new role to the current operator.

Hint In Velocity 3.0 and later, Roles replaces Operator Groups. In previous versions of
Velocity, there were rights, conferred on an operator group, and permissions,
conferred on an individual operator. Roles replace both rights and permissions.

Roles also answer the need, so often requested by security system professionals,
for in-depth, low-level partitioning.

Partitioning
Partitioning is the procedure for dividing activities, objects, and data into logical
subgroups that can only be viewed by those operators permitted to view that
subgroup. As the name implies, partitioning sets up logical partitions around specified
activities and objects so that only those operators that are permitted to view that activity
or object are actually allowed to.
Objects that can be partitioned include:
 people
 alarms and events
 program functions
 module features
When partitioning involves alarms and events, we refer to it as alarm and event routing,
since it entails the directing of only specified event and alarm data to those operators
who have permission to view it.

Roles 285
Velocity Version 3.1 Administrator’s Guide

Hint While a simple security system, involving a few doors and a dozen employees,
may never use an advanced feature like partitioning, a more sophisticated system
that includes multi-use buildings, hundreds of employees, and/or dozens of
operators, most decidedly will utilize this feature.

Velocity creates and manages partitions through the Role feature.

How Velocity Does Partitioning

With the advent of Velocity 3.0 and later, the idea of Operator Rights and Permissions
has been consolidated into the Role feature. Roles provide Velocity system
administrators with control over what data and features an operator sees and what
functions they can perform.
Through the fifteen available role categories, Velocity provides the ability to control an
operator’s right to view, add, change, or delete
 data related to people and credential templates
 topology objects such as ports, controllers, doors, inputs, relays, CCTV, and DVRs
In addition, through the Application Permissions section, roles can restrict an operator's
view of any Velocity module, including Enrollment Manager, Badge and Graphic
Designer, Customization Manager, even the Administrator window. Groups defined for
use within a particular module – Status Viewer groups, Event Viewer groups, Video
Explorer groups, Enrollment Manager person groups – can also be partitioned, to limit
access to these groups and their associated data by members of a designated role.
Another important component of partitioning is Alarm and Event Routing. Velocity
provides control over the alarms and hardware events that operators can receive at a
specific workstation during a specific time period (time zone). The rules for alarm and
event routing are configured under Roles > Application Premissions (see “Role
Properties: Application Permissions” on page 292.) and are based on:
 the time zone during which this routing will occur
 the points and alarm/event types for which the alarms are to be routed
Unlike all other Role permissions, where highest permissions win, alarm and event
routing is bound by the 'lowest permission denies' rule. For example, if you are a
member of a role that has been denied routing of an event to a workstation for a point,
even if another role (with the exception of Administrators) has been granted routing of
the event to the same workstation, it will not be sent to the client.
For more on this, refer to “Roles: How to Define” in the next section.

How Velocity 3.1 Upgrade Handles Operator Permissions

If you have upgraded from Velocity 2.6 to this version of Velocity, keep in mind that
none of the permissions that were assigned to operators in that version will be checked
off in this version's Roles (except for the Administrator who will always have permission
to everything).
For Velocity 2.6 Operator Groups, if 'Add' rights were given, the operator who was a
member of that operator group was also able to save and view even if these rights
were not checked off. In Velocity 3.0 and later, however, when Add is checked, Save
and View are also checked.

286 Roles
 MAN006-0612

When upgrading, if Add permissions were given, then the Save and View are also
checked for consistency. If Add was not part of the granted permissions given in
Velocity 2.6, then Save and View are not checked either and the Administrator must
check both Save and View manually.
The components that had Add for 2.6 but do not for 3.0 are:
 CCTV Camera
 Control Zone editor
 Dialup modem pool
 Door
 Expansion input
 Expansion relay
 Input
 Reader
 Relay
These must all be added manually.

Roles: How To Define

 Only those operators who are members of the default Administrators
role can create roles or assign permissions to that role. No other role can
be created that gives access to the role creation task.
To define Roles:
1. From the system tree window, select the Velocity configuration tree.
2. Expand the Velocity Configuration folder.
The Roles folder appears.
3. Click to highlight the Roles folder.
The current roles appear in the components window. These should include the
default Administrators and Operators roles. In addition there is a Add New Role
option.

Hint Administrators should leave the settings for the default Administrators and
Operators roles unmodified. Use them as your standard default settings from
which to assemble other roles. Use the Copy right-click option to create new roles.

Notice that the default Administrators role allows access to every available Velocity
feature and screen. Conversely, the default Operators role includes no access to
any Velocity features or screens.
4. Double click the Add New Role folder.
The Enter Role Name... text box appears like this example:

5. In the Role name field, enter the name of this new role.

Roles 287
Velocity Version 3.1 Administrator’s Guide

6. If required, check the Create with permissions turned on box to check

(enable) every Role permission available.
7. Click OK.
The Role properties sheet appears with the top-most Members folder highlighted
in the tree pane and the default <Always> option displayed in the 'Active time
zone' field at the top of the screen.
8. If required, at the 'Active time zone' pick list, provide a different time zone for this
role. This indicates during which time period the DIGI*TRAC settings for this role
are active; during any other time, Velocity will consider the DIGI*TRAC settings for
this role inactive. All other subfolder settings, such as Application Permissions and
Command Sets, are independent of the selected time zone.
Only those time zones previously defined for this system appear on this option list.
9. Select each folder in turn from the tree pane and enable or disable permissions as
required in the components pane.
You can check or uncheck all permissions in a specific folder, using one of these
techniques:
• Right click the folder and select Select All or Deselect All as needed.
• At the upper left corner of the Roles properties sheet, click the button to
select all permissions or the button to deselect all permissions.
10. On the Members folder, add all those operators who you want to make a member
of this role.
You can also add members to this role from the Operator Roles property sheet.
11. When you're finished defining this roles, click OK.
You are returned to the main menu with the new role displayed in the Roles folder.
If you have already created a role that you would like to use as the basis for another
role, use the Role Copy feature. For more on this feature, refer to “Roles: Copying” on
page 288.

Roles: Copying
If you have created one or more roles, it becomes easier to create more roles by using
previously created roles as templates through the copy feature.
To copy an existing role:
1. From the System Tree pane Velocity Configuration folder, select the Roles folder.
All currently defined roles appear in the Components pane.
2. From the Components pane, right click on the role you want to use as the
template for a new role.
An option list pops up.
3. From the pop-up option list, select Copy.
The Enter Role Name... text box (see page 288) appears.
4. Enter the new name for this role and click OK.
The new role appears in the Components pane.
5. Rename the role as needed using the instructions in “Roles: Renaming” on page
289.
6. Using the instructions found in “Roles: How To Define” on page 287, customize
this new role as required.

288 Roles
 MAN006-0612

Roles: Renaming
If you need to create one or more roles, it becomes easier to create more roles by
copying an existing role then renaming it before customizing permissions within it.
To rename a role:
1. From the System Tree pane, select the Roles folder from the Velocity Configuration
tree.
All currently defined roles appear in the Components pane.
2. From the Components pane, right click on the role whose name you want to
change.
An option list pops up.
3. From the pop-up option list, select Rename.
The current role name becomes a text box with the current text highlighted.
4. Enter the new name for this role, then click outside the text box.
The new role name appears in the Components pane.
5. Using the instructions found in “Roles: How To Define” on page 287, customize
this role as required.

Role Properties Sheet

The Role property sheet is divided into two panes, as shown in the following example:

The fields and panes on this screen are:

Click this button to check all of the available permissions for

the selected role folder.
Optionally, check the Create with all permissions turned
on box when the Enter Role Name dialog box appears.

Click this button to uncheck all of the available permissions for

the selected role folder.

Roles 289
Velocity Version 3.1 Administrator’s Guide

Active Time Select the time zone from the drop-down option list. All
Zone currently defined time zones are displayed here. During the
time zone you select, the DIGI*TRAC properties you designate
for this role apply; when this time zone is not active, the
DIGI*TRAC role properties do not apply. This role and the
properties selected for it, excluding those properties specified
for the DIGI*TRAC subfolder, still apply to the specified role, no
matter what time zone is currently active. The default time
zone is <Always>.

Role folder pane The left pane lists the major categories of privileges (rights,
permissions, and properties) a role can define. These
categories are represented as folders and include:
• Members (page 291)
• Add-Ins (page 292)
• Application Permissions (page 292)
• Cameras (page 307)
• Command Sets (page 307)
• Credential Templates (page 307)
• DIGI*TRAC (page 308)
• Door Groups (page 309)
• Event Viewer Filters (page 309)
• Function Groups (page 309)
• Graphics (page 310)
• Members (page 310)
• Person Groups (page 311)
• Person Templates (page 311)
• Reports (page 311)
• Status Viewer Groups (page 312)
• Video Explorer Groups (page 312)
• Workstation (page 312)

Component The right pane, the roles component pane, lists those privileges
pane and properties specific to the selected folder.
For example, if you select Members, as shown in the example
above, the option Add New Member appears in this pane.

Use this property sheet to define which rights and permissions each role controls.
 The Application Permissions folder is the most important of the folders in
the role tree pane. Many of the permissions contained in the other
folders cannot be used until the operator is granted permission in the
Application Permissions folder to actually access and use the module or
feature described.
Each of the pages on this property sheet appear on the following pages.

290 Roles
 MAN006-0612

Role Properties: Members Page

When you select the Members folder on the Role property sheet, the Role properties
components pane displays a list of all operators currently included in this role.
While you can add operators to roles through the Operator properties sheet (when you
enroll an individual operator), it is often easier and quicker to do it through this feature.
To enroll a new member with this role:
1. In the role properties left pane, select the Members folder.
2. The current members of this role appear in the right pane along with the Add New
Member option.
3. In the role properties right pane, double click the Add New Member option.
The Add New Member dialog box appears like this example.

All currently enrolled operators who are not yet a member of this role appear in
this window.
 Only those operators who have been previously enrolled appear in this
pane.
4. Click to highlight the operator you want to enroll as a member of this role.
5. Click OK.
You can only add one member at a time.
6. Repeat Steps 1 - 4 to add new members to this role.
The Role properties page reappears with the newly enrolled member(s) appearing in
the components pane.
Roles can also be assigned to individual operators through the Operator Roles property
page (see “Operator Roles Properties Sheet,” starting on page 279).

Roles 291
Velocity Version 3.1 Administrator’s Guide

Role Properties: Add Ins Page

When you select the Add Ins folder on the Role property sheet, the Role properties
components pane displays a list of all currently defined Add In components as shown
in this example:

 Only those Add Ins currently defined on this system appear in the Role
properties components pane.
To add one or more add-ins to this role:
 Check one or more of the Add In boxes to grant access to these credential
templates.
This enables the operator who is a member of this role to use each add-in you check.

Role Properties: Application Permissions

When you click the Application Permissions folder in the Role properties left pane
you are presented with a three-pane screen like this example:

The panes and fields on this screen are:

Name This pane lists all Velocity components and modules shown in
the Velocity system tree, including CCTV Switcher, Controller,
Expansion Input, Enrollment Manager, Function Group, Holiday,
Relay, and Standard Time Zone.
When you select a component name, one or more
permissions appear in the Operator can... pane.

292 Roles
 MAN006-0612

Role can... This pane provides a list of permissions that the operator
assigned this role can perform with the component or module
highlighted in the Name pane. Click to check the box of each
permission this role requires.
Some of the more common permissions are:
Add — The operator assigned this role can add items to this
component. Selecting this element automatically selects Save
and View.
Delete — The operator assigned this role can delete items
from this component.
Save — The operator assigned this role can save changes
made to this component. This includes both new and modified
component items.
View — The operator assigned this role can select the
Properties option to open and view component properties. If
left unchecked, the operator cannot access the property
page(s) that define this component. Only those tabs (pages)
checked for this role can be viewed; all unchecked tabs are
hidden.
Note: Many components enable the administrator to limit the pages
accessible to a particular role, especially when the feature has
multiple or tabbed pages.
Use — The operator assigned this role can use this module.
Use Functions — The operator assigned this role can use the
function(s) associated with this module.
Note: Conferring a permission like Add presupposes the ability to
both Save and View without which adding is impossible. For
this reason, when you select Add, the Save and View check
boxes are automatically checked as well. There are examples
of this pattern throughout this pane. For more on this, refer to
the following table.

This table provides a complete list of what the Application Permissions panes contain:

Name: Role can...

Administration Use
Module Use Functions

Alarm Responses Add

Delete
Save
View

Roles 293
Velocity Version 3.1 Administrator’s Guide

Name: Role can...

Alarm Viewer Alarm Viewer - Use

Alarm Viewer - Change Properties
Alarm Viewer - Close with Active Alarms
Alarm Viewer - Clear in Restricted Mode (Use with Caution)
Alarms & RTNs - Acknowledge
Alarms & RTNs - Acknowledge Multiple
Alarms & RTNs - Clear in Standard Mode
Alarms & RTNs - Clear Multiple
Alarm Viewer - Copy to Clipboard
Alarm Viewer - Add Notes

Badges Edit
Preview
Print
Override Print Control

CCTV Camera Save

View
View General Tab
View Presets Tab
CCTV Camera Viewer - Use

CCTV Switcher Add

Delete
Save
View
View General Tab
View Triggers/Actions Tab

Central Stations Add

Account Delete
Save
View
View General Tab

Central Stations Add

Area Delete
Save
View
View General Tab

Central Stations Add

Point Delete
Save
View
View General Tab

Command Set Add

Delete
Save
View
View Properties Tab

294 Roles
 MAN006-0612

Name: Role can...

Control Zone Editor Save

View
View Standard Control Zones Tab
View Master Control Zones Tab

Controller Add
Delete
Save
View
View General Tab
View Setup Tab
View Reporting Tab
View Passback Tab
View Alarm Actions Tab
View Control Zones Tab
View Communications Tab
Firmware - Update CCM/SNIB2 Firmware

Credential Template Add

Delete
Save
View
View General Tab
View Function Tab
View Limits Tab
View Options Tab

Customization Customization Manager - Use

Manager Customization - Enter Window Design Mode

Dialup Location Add

Delete
Save
View
View Host Settings Tab
View Remote Settings Tab

Dialup Modem Pool Save

View
View General Tab

Door Save
View
View General Tab
View Entry Reader Tab
View Exit Reader Tab
View Input Tab
View Relay Tab

Roles 295
Velocity Version 3.1 Administrator’s Guide

Name: Role can...

Door Groups Add

Delete
Save
View
View General Tab

DVR Unit Add

Delete
Save
View
View General Tab
DVR Event History - Use
All Video Events - Use

E-mail Writer Add

Delete
Save
View
View Setting Tab
View E-mail Content Tab

Enrollment - Add
Credential Delete
Save
View
View General Tab
View Function Tab
View Limits Tab
View Options Tab

Enrollment - Person Add

Delete
Save
View
View General Tab
View TAB 1 - TAB 10 Tabs
View Groups Tab
View Additional Images Tab

296 Roles
 MAN006-0612

Name: Role can...

Enrollment Credentials - Allow Override of Old Card Codes

Manager Credentials - Allow Override of Old PIN Codes
Credentials - Assign & Unassign
Credentials - Batch Enroll
Credentials - Force Download
Credentials - Forgive Passback
Credentials - Link to template
Credentials - Override Code Tamper
Credentials - Reset Limit Count
Credentials - Print Control
Credentials - Issue Control
Enrollment Manager - Change User Defined Fields
Enrollment Manager - Device Configuration
Enrollment Manager - Display PIN Codes
Enrollment Manager - Find Credential by PIN
Enrollment Manager - Manage Person Folders
Enrollment Manager - Manage Person Groups
Enrollment Manager - Preferences
Enrollment Manager - Use

Event Viewer Use

Display State Changes
Change Properties
Copy to Clipboard

Expansion Input Save

View
View General Tab
View Logic Tab
View State Change Reporting Tab

Expansion Relay Save

View
View General Tab
View Logic Tab

Function Group Add

Delete
Save
View
View Function Group General Tab

Function Group Add

Extensions Delete
Save
View
View Define Extension General Tab

Grand Master Time Add

Zone Delete
Save
View

Roles 297
Velocity Version 3.1 Administrator’s Guide

Name: Role can...

Graphics Graphics - Use

Graphics - Use Custom Link Manager
Graphics - Use Design Mode
Graphics - Use Functions

Holiday Add
Delete
Save
View
View General Tab

Input Save
View
View General Tab
View Logic Tab
View State Change Reporting Tab

Master Door Group Add

Delete
Save
View
View General Tab

Master Time Zone Add

Delete
Save
View

Message Queue Add

Writer Delete
Save
View
View Settings Tab

Operator Add
Delete
Save
View
View General Tab
View Roles Tab

Person Template Add

Delete
Save
View
View General Tab
View TAB 1 - TAB 10 Tabs
View Groups Tab
View Additional Images Tab

298 Roles
 MAN006-0612

Name: Role can...

Ports Add
Delete
Save
View
View General Tab

Reader Save
View
View General Tab
View Logic Tab
View ScramblePad Options Tab

Relay Add
Delete
Save
View
View General Tab
View Logic Tab

Reports Report Manager - Use

Reports - Add & Delete Reports and Report Groups

Serial Writer Add

Delete
Save
View
View General Tab
View Settings Tab

Service Control Change Settings

Manager

Standard Time Add

Zone Delete
Save
View

Status Viewer Use

Use Functions
Add, Edit, and Delete Status Groups

Roles 299
Velocity Version 3.1 Administrator’s Guide

Name: Role can...

Velocity Video Explorer

Console Add-Ins - Use Managers
Console Preferences - Use
Console Preferences - Change Printer Settings
Diagnostic Window - Use
Download Monitor - Use
Install Velocity Clients
Linked Devices - Manage
Off-Normal Window - Use
SQL Manager - Use
Scheduling Agent - Use
CCM Import Wizard - Use
Customization - Import/Export Wizard - Use
Export Controller Configuration - Use
Import Controller Configuration - Use
SAM Import Wizard - Use
SNIB2 Import Wizard - Use
Data Export Wizard - Use
Data Import Wizard - Use
Exit Velocity - Close Velocity
Exit Velocity - Lock Workstation
Exit Velocity - Log On as a Different Operator
Exit Velocity - Restart

Who's Inside Use

Permission to forgive users
Display Who's Inside HTML Report
Assign Credentials to Zone

Workstations Add
Delete

XBox Add
Delete
Save
View
View General Tab

XML Writer Add

Delete
Save
View
View Settings Tab

For more detailed explanations of many of these permissions, refer to “Roles:

Application Permissions Detail,” starting on page 302.

300 Roles
 MAN006-0612

Permissions and Behaviors

In many situations, a permission is defined by the ability to do one or more of these
four tasks:

View View the properties for a specified element.

Add Add a new element or modify an existing element. Selecting

this element automatically selects Save and View.

Save Save changes made to a new or existing element.

Delete Delete an existing element.

Some of these permissions require the selection of one or more other permissions. For
example, selecting Add, presupposes the ability to both Save and View without which
adding is impossible. For this reason, checking a particular box can actually enable
more than just the selected permission. When this occurs, a message like this example
appears:

Click OK to continue. The associated permissions are also granted.

 When you select View, it enables you to select the Properties option from
the list that pops up when you right click the selected element. For
example, if you check the View permission for the Controller application,
it enables any operator assigned this role to right click on a controller in
the Administration window under the DIGI*TRAC Configuration folder
and select Properties. Only those tabbed pages you check appear. If you
have not checked the Add box for this role, the property sheets are
read-only.
The circumstances under which this occurs are shown in the tab below:

Settings Behavior

View Add Save Delete Add/Edit Delete Save View

Element Element Element Element
Props

 No No No No

 No No No Yes

 Yes No Yes Yes

 No No No No

  Yes No Yes Yes

  No Yes No Yes

Roles 301
Velocity Version 3.1 Administrator’s Guide

Settings Behavior

View Add Save Delete Add/Edit Delete Save View

Element Element Element Element
Props

  No No Yes Yes

   Yes No Yes Yes

   No Yes Yes Yes

    Yes Yes Yes Yes

If you attempt to uncheck one of the associated permissions, another message

prompts you to uncheck the underlying setting. For example, if you attempt to uncheck
Save before you have uncheck Add, you are prompted.
Operators are not responsible for creating, modifying, or configuring elements within
Velocity; these are the sole domain of Velocity administrators and installers.

Roles: Application Permissions Detail

This provides more detail on certain application permissions that can be enabled for a
role.

If you checked: Allow an operator who is a member of this role to:

Administration Module - Use access the Administration window including the system tree
and components panes. Without this access, the operator
cannot access the system configuration components.

Administration Module - Use use all functions included in the Administration window.
Functions

Alarm Receiver add, delete, save, view, or view the general page for the central
station alarm receiver.

Alarm Responses add, delete, save, or view the alarm responses folder.

Alarm Viewer - Change modify the look and feel of Alarm Viewer using the Properties
Properties option.

Alarm Viewer - Close with enable this operator to close Alarm Viewer even if some alarms
Active Alarms are still active.

Alarm Viewer - Use access, view, and respond to the Alarm Viewer.

Alarm Viewer - Clear in clear an alarm even though it has not returned to normal.
Restricted Mode (Use with Permission should only be given to an administrator or
Caution!) qualified technician in order to troubleshoot the system or
expedite exit of an area during an emergency.
Use this feature with extreme caution. In
most cases, a cleared but unacknowledged
alarm represents an unacceptable breach of
security.

302 Roles
 MAN006-0612

If you checked: Allow an operator who is a member of this role to:

Alarms & RTNs - Acknowledge acknowledge alarms and RTNs on the Alarm Viewer. The
operator can use the Acknowledge function.

Alarms & RTNs - Acknowledge acknowledge multiple alarms and RTNs on the Alarm Viewer.
Multiple The operator can use the Acknowledge All function.

Alarms & RTNs - Clear in clear an alarm and its RTN from Alarm Viewer. The operator can
Standard Mode use the Clear function.

Alarms & RTNs - Clear Multiple clear multiple alarms and RTNs from Alarm Viewer. The
operator can use the Clear All function.

Alarm Viewer - Copy to copy alarm information to the clipboard.

Clipboard

Alarm Viewer - Add Notes add operator notes to an alarm.

Badges - Edit edit badge templates in Badge Designer.

Badges - Preview access the print preview screen in Enrollment Manager.

Badges - Print print badges in Enrollment Manager.

CCTV Camera save, view, view General tab, and view Presets tab for CCTV
cameras.

CCTV Camera Viewer - Use access and use CCTV Camera Viewer.

Console Add-Ins - Use access and use the Add-In options under the Console menu
option.

Console Preferences - Change access and change all preferences that appear on the Velocity
All Preferences dialog box. This includes the General, Network,
Alarm Options, Enrollment Station, Printers, and CCTV pages.

Console Preferences - Change access and use two pages of the Velocity Preferences dialog
Enrollment & Printers box. The two pages that appear are the Enrollment Station and
Printers page. The General, Network, Alarm Options, and CCTV
pages do not appear and are not accessible.

Credentials -Allow override of access and select the 'Reuse MATCH Card Codes with an
Old Card Codes Operator Override Only' option in the 'Reuse Deleted Codes'
section of the Preferences General page.

Credentials - Allow override of access and select the 'Reuse PINs with an Operator Override
Old PIN Codes Only' option in the 'Reuse Deleted Codes' section of the
Preferences General page.

Credentials - Assign & assign or unassign credentials to persons in the Enrollment

Unassign Manager.

Credentials - Batch Enroll use the batch enroll feature to enroll credentials in Enrollment
Manager.

Credentials - Force Download force a download of a credential to the controller in Enrollment

Manager.

Roles 303
Velocity Version 3.1 Administrator’s Guide

If you checked: Allow an operator who is a member of this role to:

Credentials - Forgive Passback forgive passback of a credential in Enrollment Manager.

Credentials - Override Code override code tamper for a credential in Enrollment Manager.
Tamper

Credentials - Reset Limit Count reset the limit count for a credential in Enrollment Manager.

Customization - Enter Window enable operator to customize the Personal Information form by
Design Mode entering design mode in Enrollment Manager.

Customization - Import/Export access the Customization Import/Export Wizard through the

Wizard - Use File > Import/Export options on the menu tool bar.

Customization Manager - Use access and use the Customization Manager.

Data Export Wizard - Use access and use the Data Export Wizard.

Data Import Wizard - Use access and use the Data Import Wizard.

Diagnostic Window - Use access and use the Diagnostic Window.

Download Monitor - Use access the Download Monitor.

DVR Camera Viewer - Use access and use the DVR Camera Viewer.

Enrollment Manager - Change change the user-defined fields in Enrollment Manager.

User-Defined Fields

Enrollment Manager - Device access the Device Configuration option in Enrollment Manager.
Configuration

Enrollment Manager - Display enable the operator to see credential codes in the ‘PIN’ field.
PIN Codes

Enrollment Manager - Find enable this operator to find a credential by sorting by PIN
Credential by PIN codes.

Enrollment Manager - Use access Enrollment Manager. Without this, the operator cannot
create, modify, or view badging or access code information

Event Viewer - Display State enable operators to see when a state changes in Event Viewer.
Changes If unchecked, only the initial state of an event is viewable; any
change that may occur while the operator is viewing Event
Viewer is not displayed.

Event Viewer - Use access the Event Viewer. Viewing events should require a
higher level of security than viewing alarms.

Exit Velocity - Close Velocity enable operator to exit Velocity by using the Close Velocity
option.

Exit Velocity - Lock enable operator to select the Lock Workstation option on exit.
Workstation This privilege should only be granted to administrators and
technical personnel who need to test another operator's range
of activities.

304 Roles
 MAN006-0612

If you checked: Allow an operator who is a member of this role to:

Exit Velocity - Log On as a enable operator to select the Log On as a Different Operator
Different Operator option on exit.

Exit Velocity - Restart enable operator to select the Restart option on exit.

Firmware - Update CCM download firmware updates from the Velocity server to one or
Firmware more controllers using the Download Firmware feature.

Graphics - Use access Live mode on the Graphics module. This enables
operators to monitor icons through the Graphics module and
perform other simple operator functions. It does not allow
access to Design Mode or permit operators to control icons.
This is a function most operators must perform.

Graphics - Use Custom Link access and use Custom Link Manager in the Graphics Designer
Manager module.

Graphics - Use Design Mode access Design Mode on the Graphics module. This enables a
qualified operator to design maps and populate them with
components.
Using the Graphics module in Design mode is normally an
administrator function.

Graphics - Use Functions use the finished maps to control inputs and outputs placed on
the maps, including popping a door or testing an input.
This is a function most operators must perform.

Off-Normal Window - Use access and view the Off-Normal Points window.

Report Manager - Use access and use the Report Manager. This provides the ability to
generate previously defined reports.
Some reports are normally handled by operators; others are
administrator responsibilities. You can specify access to
individual reports within the Roles function.

Reports - Add & Delete Reports add or delete reports or create report groups.
and Report Groups

SAM Import Wizard - Use access the SAM Import Wizard through the File >
Import/Export options on the menu tool bar.

Service Control Manager - use and change the settings for services using the Service
Change Settings Control Manager.

SNIB2 Import Wizard - Use use and change the SNIB2 Import Wizard accessed through
the File > Import/Export options on the menu tool bar.

SQL Manager - Use access the SQL Database Manager. This enables operators to
reconfigure the Velocity database.

Roles 305
Velocity Version 3.1 Administrator’s Guide

If you checked: Allow an operator who is a member of this role to:

Status Viewer - Add, Edit, and use the add, edit, and delete features for creating status groups
Delete Status Groups in Status Viewer. While you can access the Status Groups page
with normal Status Viewer access, you cannot use any of the
additional features without this permission.

Status Viewer - Use access and view the Status Window.

Status Viewer - Use Functions enable the operator to use the control functions in Status
Viewer.

Velocity Scheduling Agent - access and use the Scheduling Agent.

Use

Velocity - CCM Import/Export access the CCM Import Wizard through the File >
Wizard - Use Import/Export option on the menu tool bar.

Workstation - Add New enable addition of one or more workstations.

Workstation - Delete enable selected operator to ability delete workstations and their
settings from Velocity.

Many categories of application permissions include the following check boxes:

Permission Allow an operator who is a member of this role to:

Add Create a new item or modify an existing item in Velocity.

Note: Permission to save, view, view tabs, and all relevant restrictions
are automatically checked when this permission is checked.
When this permission is selected, a note appears noting this
fact. For more on this, refer to “Permissions and Behaviors,”
starting on page 301.

Save Save changes made to this item in Velocity.

Delete Delete an existing item in Velocity.

View View properties associated with this item. This enables an

operator assigned this role to select the Properties option from
the right click option list for the selected component and view
all tabs (pages) that are checked. Only those pages that are
actually checked can appear. Unless the Add option is also
chosen, all property pages viewed cannot be modified.

View * Tab View the designated page associated with the properties of this
item. Only those tabs (pages) that are checked can be viewed.
Unless the Add option is also chosen, all property pages
viewed cannot be modified.

306 Roles
 MAN006-0612

Role Properties: Cameras

When you select the Cameras folder on the Role property sheet, the Role properties
components pane displays a list of all currently defined cameras like this example:

 Only those cameras currently defined on this system through either a

CCTV switcher or DVR appear in the Role properties components pane.
To add/delete access of cameras from this role:
 Check one or more of the camera boxes to grant access to the cameras within
those groups.
 Uncheck one or more camera boxes to deny access to those cameras.
This enables the operator provided with this role to view or control each camera you
check.

Role Properties: Command Sets

When you select the Command Sets folder on the Role property sheet, the Role
properties components pane displays a list of all currently defined command sets.
 Check one or more of the command set boxes to use the selected command sets.
This enables the operator provided with this role to use each command set you check.
 Only those command sets currently defined on this system appear in the
Role properties components pane.

Role Properties: Credential Templates

When you select the Credential Templates folder on the Role property sheet, the
Role properties components pane displays a list of all currently defined credential
templates.
 Check one or more of the credential template boxes to grant access to these
credential templates.
 Only those credential templates currently defined on this system appear
in the Role properties components pane.
This enables the operator provided with this role to view or edit each credential
template you check.

Roles 307
Velocity Version 3.1 Administrator’s Guide

Role Properties: DIGI*TRAC

When you select the DIGI*TRAC folder on the Role property sheet, the Role properties
components pane displays a list of the current DIGI*TRAC system tree, much as it
would appear in the System Tree pane.

 Only those DIGI*TRAC components—including ports, XBoxes, controllers,

doors, inputs, and outputs—currently defined on this system appear in
the Role properties components pane.
This screen contains the following elements:

Window This window includes checkboxes for all hardware Velocity

currently identifies as part of this security system. Check each
component you want to include in this role.
The hardware events include an expandable system tree
including all components currently defined for this system. This
tree expands exactly the same as it does in the Velocity system
tree pane. An example of this is shown below:

When you check to select a device, all events and alarms

associated with that device are automatically selected. You can
check as many devices as you require to define this role.
To select all the devices shown, click the button. To
deselect all currently checked devices, click the button.

308 Roles
 MAN006-0612

Active time If required, select the time zone during which the selections
zone you make here are applicable. During all other time zones,
Velocity will not observe these DIGI*TRAC selections.
Only those time zones currently defined for this system appear
in the drop-down list. The default value is Always.

To assign DIGI*TRAC components and properties to this role:

1. In the upper right pane, expand the tree as required.
This function in exactly the same manner as the main Velocity system tree pane.
2. From this tree pane, click to highlight the DIGI*TRAC component whose privileges
you want to assign.
3. Check or uncheck each component as required.
4. In the 'Active time zone' pick list, select the time zone during which the following
properties are enabled.
Only those time zones previously added to this system, or those available by
default (like <Always> and <Never>), appear in this list. The <Always> time
zone is the default selection.
This enables the operator provided with this role to access and monitor each
component you check during that time zone specified. All alarms and events available
for a specific component are available to qualified role members.

Role Properties: Door Groups

When you select the Door Groups folder on the Role property sheet, the Role
properties components pane displays a list of all currently defined door groups.
 Only those door groups currently defined on this system appear in the
Role properties components pane.
 Check one or more of the door group boxes to grant access to the doors within
those groups.
This enables the operator provided with this role to view, edit, or control each door
group you check.

Role Properties: Event Viewer Filters

When you select the Event Viewer Filters folder on the Role property sheet, the Role
properties components pane displays a list of all currently defined event viewer filter
groups.
 Only those event viewer filter groups currently defined on this system
appear in the Role properties components pane.
 Check one or more of the event viewer filter boxes to grant access to event filters
within those groups.
This enables the operator provided with this role to filter events appearing in the Event
Viewer using the filter you check.

Role Properties: Function Groups

When you select the Function Groups folder on the Role property sheet, the Role
properties components pane displays a list of all currently defined function groups.

Roles 309
Velocity Version 3.1 Administrator’s Guide

 Only those function groups currently defined on this system appear in

the Role properties components pane.
 Check one or more of the function group boxes to grant access to the functions
within those groups.
This enables the operator provided with this role to access, edit, and use each function
group you check.

Role Properties: Graphics

When you select the Graphics folder from the left pane of the selected Role property
sheet, the Role properties components pane displays a list of all currently defined
graphics (drawings) like this example:

 Only those graphics currently defined on this system appear in the Role
properties components pane.
 Check one or more of the graphic boxes to grant access to the selected graphics.
This enables the operator provided with this role to access and view each graphic you
check, including the alarms placed on it.

Role Properties: Members

When you select the Members folder on the Role property sheet, the Role properties
components pane displays a list of all operators currently included in this role.
While you can add operators to roles through the Operator properties sheet (when you
enroll an individual operator), it is often easier and quicker to do it through this feature.
To enroll a new member to this role:
1. In the role properties left pane, select the Members folder.
The current members of this role appear in the right pane along with the Add New
Member option.
2. In the role properties right pane, double click the Add New Member option.
The Add New Member dialog box appears like this example:

310 Roles
 MAN006-0612

All currently enrolled operators who are not yet a member of this role appear in
this window.
• Only those operators who have been previously enrolled appear in this
pane.
3. Click to highlight the operator you want to enroll as a member of this role.
4. Click OK.
You can only add one member at a time.
5. Repeat Steps 1 - 4 to add new members to this role.
The Role properties page reappears with the newly enrolled member(s) appearing in
the components pane.
Roles can also be assigned to individual operators through the Operator Roles property
page.

Role Properties: Person Groups

When you select the Person Groups folder on the Role property sheet, the Role
properties components pane displays a list of all currently defined person groups.
 Only those person groups currently defined through Enrollment
Manager appear in the Role properties components pane.
 Check one or more of the person group boxes to enable the operator to access and
use the selected person group(s). By default, the Everyone person group appears,
but is unchecked.
This enables an operator assigned to this role to access, view, and edit each person
group you check.

Role Properties: Person Templates

When you select the Person Templates folder on the Role property sheet, the Role
properties components pane displays a list of all currently defined person templates.
 Only those person templates that are currently defined appear in the
Role properties components pane.
 Check one or more of the person template boxes to enable the operator to access
and use the selected person template(s) for enrollment tasks.
This enables an operator assigned to this role to access, view, and use each person
template you check during the enrollment process.

Role Properties: Reports

When you select the Reports folder on the Role property sheet, the Role properties
components pane displays a list of all currently defined reports.
 Only those reports currently defined on this system appear in the Role
properties components pane. There are a large number of reports that
Velocity creates by default. You can add to these reports, or customize
existing reports, as required by your security environment.Only those
reports currently defined on this system appear in the Role properties
components pane. There are a large number of reports that Velocity
creates by default. You can add to these reports, or customize existing
reports, as required by your security environment.

Roles 311
Velocity Version 3.1 Administrator’s Guide

 Check one or more of the report boxes to enable access to each required report.
This enables the operator provided with this role to view, use, and generate each report
you check.

Role Properties: Status Viewer Groups

When you select the Status Viewer Groups folder on the Role property sheet, the
Role properties components pane displays a list of all currently defined status viewer
groups.
 Only those status viewer groups currently defined on this system appear
in the Role properties components pane.
 Check one or more of the status viewer group boxes to grant access to the
functions within those groups.
This enables the operator provided with this role to access and use each status viewer
group you check.
 Before operators can actually access this function, you must grant them
access to the module through the Application Permissions folder.

Role Properties: Video Explorer Groups

When you select the Video Explorer Groups folder on the Role property sheet, the
Role properties components pane displays a list of all currently defined video explorer
groups.
 Only those Video Explorer groups currently defined on this system
appear in the Role properties components pane.
 Check one or more of the Video Explorer group boxes to grant access to the
switchers and cameras included within those groups.
This enables the operator provided with this role to access and view video input made
available through the group you check.
 Before operators can actually use this function, you must grant them
access to the module through the Application Permissions folder.

Role Properties: Workstations

When you select the Workstations folder on the Role property sheet, the Role
properties components pane displays a list of all currently defined workstations.
 Only those Velocity workstations currently defined on this system appear
in the Role properties components pane.
Check one or more of the workstations to grant access to those workstations for all
members of the designated role.
This enables the operator provided with this role to access and view the Velocity
workstation.
 Before operators can actually use this function, you must grant them
access to the module through the Application Permissions folder.

312 Roles
 MAN006-0612

Time Zones
Time Zones are one of the most basic units of Velocity configuration. Each time zone
includes:
 Name
 Start Time (where 00:00 is midnight)
 End Time (where 24:00 is midnight)
 Days of week (1-8 days including the holiday enabler)
 Holiday schedules (1-4 possible schedules)
The week starts on Monday and ends on Sunday. They can include extra days for
holidays.
There are three types of time zones you can define in Velocity:
 Standard Time Zones
 Master Time Zones
 Grandmaster Time Zones
Standard Time Zones (STZs) are defined during the system programming procedure.
Each STZ is defined by entering a name, a starting time, an ending time, and, where
enabled, one to four holiday schedules.
Time periods defined by the starting and ending time can be set to a full 24-hours or
any limited set of hours. Each STZ also includes up to eight (8) authorized
days-of-the-week during which access (or some other activity) is granted for the
specified hours-of-the-day. Besides access, Standard Time Zones can also be set up to
automatically unlock and relock doors during hours of free or public access as well as
trigger relays or alarms as required.
There are 66 Standard Time Zones, two of which are predefined: <Always> and
<Never>. In addition, there are 64 editable STZs that you can define as required by
your system.
STZs can include holidays. If holidays are included in a time zone, access is authorized
for all people assigned a door group with the specific STZ whenever the system's
calendar detects a scheduled holiday date.
If holidays are not included in a time zone, persons with that STZ are denied access
whenever the system detects a scheduled holiday for the entire day.
Holidays are defined separately in Velocity and are generally grouped together into
holiday schedules. Up to four holiday schedules can be assigned for each defined time
period. In addition there is an H column that indicates that the selected holiday
schedules are either included or excluded from the current time zone.
 If you check the H day cell for a specified time zone and indicate one or more
holiday schedules, the time zone is active (door unlocked) even during the holidays
included in the selected holiday schedules.
 If you don't check the H day cell for that time zone, then the TZ is inactive during
selected holidays (door locked).

Time Zones 313

Velocity Version 3.1 Administrator’s Guide

For example, say you define Friday, July 4, 2003 as one of the dates on Holiday
Schedule 1. Then define Time Zone 1 as including Holiday Schedule 1. Normally, TZ1
allows front door access from 6:00 - 18:00 Monday - Friday; however, because we
included Holiday Schedule 1 in the define of TZ1, the front door will be locked to
normal traffic on July 4 even though it's a Friday. However, if you checked the H
column, Time Zone 1 would be active even during July 4. For more on this, refer to
“Time Zones: Explaining the H Column” on page 326. For more on Holidays, refer to
“Holidays” on page 330.
In addition, there are Master Time Zones and Grand Master Time Zones which support
the grouping of Standard Time Zones for flexibility in programming.
The programmer also has the option to group Time Zones. Up to 8 Standard Time
Zones can be defined as a Master Time Zone. Additionally, up to 8 Standard or Master
Time Zones can be defined as a Grand Master Time Zone.
Master Time Zones (MTZs) are used when:
 A Time Zone must extend past midnight
 Multiple start/end times occur on a single day
 Different start/end times occur on different days
Grandmaster Time Zones (GTZs) are compilations of Standard and Master Time Zones
and are used when a large or irregular block of time must be specified.

Standard Time Zones: How to Define

To define a time zone:
1. From the system tree window, select the Velocity Configuration tree.
2. Expand Velocity Configuration to view the Time Zones folder.
3. Click the Time Zones folder.
Three available time zone options—Standard, Master, and Grandmaster—appear in
the Components window.
4. From the Components window, double click Standard Time Zones, Master
Time Zones, or Grandmaster Time Zones.
The Time Zone matrix appears with the page you selected uppermost.
• If you select standard time zone, the Standard Time Zone Properties page
appears. Refer to “Standard Time Zone Properties Page” on page 319.
• If you select master time zone, the Master Time Zone Properties page
appears. Refer to “Master Time Zone Properties Page” on page 322.
• If you select grandmaster time zone, the Grandmaster Time Zone Properties
page appears. Refer to “Grand Master Time Zone Properties” on page 323.
If you select STZ, the default time zones <Always> and <Never> appear along
with any other time zones previously defined.
5. To create a new time zone, do one of these:
• click the New Time Zone icon, , to the right of the time zone buttons
• press Ctrl + N
• select File > New from the Velocity menu bar.

314 Time Zones

 MAN006-0612

The Choose Name dialog box appears.

6. Select a name for this STZ.

7. Click OK.
The new STZ row appears in the table.
8. Click in the new STZ's Start column.
The hour digits are highlighted.
9. Specify the hour using one of these key combinations:
• The up and down cursor keys
• The number keys
10. Press the right cursor key or click in the minute digit field.
The minute digits are highlighted.
11. Specify the minutes using one of these key combinations:
• The up and down cursor keys
• The number keys
12. Press the left cursor key or click to highlight the hour field for the STZ's End
column.
13. Repeat Steps 9 - 11 to specify the end time.
14. Click to check each day cell that is appropriate to the interval you have just defined.
15. Click to check each holiday schedule you require for this STZ.
If you check the H column, it indicates this STZ is in effect even during the
specified holiday schedules. If the H column is unchecked, it indicates that the STZ
is in effect except during the specified holiday schedules. For more on this
concept, refer to “Time Zones: Explaining the H Column” on page 326.
16. When you're finished, save your STZ definition by doing one of these:
• Click the save icon, , to the right of the time zone buttons
• Press Ctrl + S
• Select File > Save from the Time Zone Properties menu bar
17. Press Alt + F4 or click the button at the upper right corner of the screen to
return to the main Velocity screen.
 You must save time zone definitions before exiting. If you try to exit
without first saving your changes, a message appears like this:

Click Yes to save the changes you've made.

For examples of how time intervals work, refer to “Time Zones Examples” on page 325.

Time Zones 315

Velocity Version 3.1 Administrator’s Guide

Master Time Zones: How To Define

To define a Master Time Zone:
1. From the system tree window, select the Velocity Configuration tree.
2. Expand Velocity Configuration to view the Time Zones folder.
3. Click the Time Zones folder.
Three available time zone options—Standard, Master, and Grandmaster—appear in
the Components window.
4. From the Components window, double click Master Time Zones.
The Master Time Zone Properties page appears.
5. To create a new master time zone, do one of these:
• click the New Time Zone icon, , to the right of the time zone buttons
• press Ctrl + N
• select File > New from the Velocity menu bar.
The Choose Name dialog box appears.

6. Select a name for this MTZ.

7. Click OK.
The new MTZ row appears in the table.
8. Click in the first STZ row.
A button appears.
9. From the drop-down option list, select one of the available STZs.
Only those STZs previously defined for this system appear in this list.
The start and end time interval, included days, and holidays defining the selected
STZ appear in the MTZ matrix.
10. Repeat Steps 8 - 9 to add the STZs you require to define this MTZ.
11. When you're finished, save your changes by doing one of these:
• Click the save icon, , to the right of the time zone buttons
• Press Ctrl + S
• Select File > Save from the Time Zone Properties menu bar
12. Press Alt + F4 or click the button at the upper right corner of the screen to
return to the main Velocity screen.
 You must save time zone definitions before exiting. If you try to exit
without first saving your changes, a message appears like this:

Click Yes to save the changes you've made.

For examples of how time intervals work, click “Time Zones Examples” on page 325.

316 Time Zones

 MAN006-0612

Grand Master Time Zones: How to Define

To define a Grand Master Time Zone:
1. From the system tree window, select the Velocity Configuration tree.
2. Expand Velocity Configuration to view the Time Zones folder.
3. Click the Time Zones folder.
Three available time zone options—Standard, Master, and Grandmaster—appear in
the Components window.
4. From the Components window, double click Grand Master Time Zones.
The Grand Master Time Zone Properties page appears.
5. To create a GTZ, do one of these:
• click the New Time Zone icon, , to the right of the time zone buttons
• press Ctrl + N
• select File > New from the Velocity menu bar.
The Choose Name dialog box appears.

6. Select a name for this GTZ.

7. Click OK.
The new GTZ row appears in the table.
8. Click in the first MTZ row.
A button appears.
9. From the drop-down option list, select one of the available MTZs or STZs.
Only those STZs and MTZs previously defined for this system appear in this list.
10. Save your changes by doing one of these:
• Click the save icon, , to the right of the time zone buttons
• Press Ctrl + S
• Select File > Save from the Time Zone Properties menu bar
Additional rows are added to the GTZ definition.
11. Repeat Steps 8 - 10 to add other STZs and MTZs you require to define this GTZ.
12. Press Alt + F4 or click the button at the upper right corner of the screen to return
to the main Velocity screen.
 You must save time zone definitions before exiting. If you try to exit
without first saving your changes, a message appears like this:

Click Yes to save the changes you've made.

For examples of how time intervals work, click “Time Zones Examples” on page 325.

Time Zones 317

Velocity Version 3.1 Administrator’s Guide

Time Zone Properties Dialog Box

The Time Zone dialog box consists of three property pages:

 Standard Time Zone
 Master Time Zone
 Grand Master Time Zone
You can move back and forth between these pages by clicking the corresponding tab.
All three property pages also include the menu tool bar. This tool bar includes these
options:

File This option includes the following standard options:

• New - Create a new time zone for the currently displayed page. You
can also press Ctrl + N.
• Save - Save changes made to the currently displayed page. You can
also press Ctrl + S.
• Delete - Delete the currently selected time zone.
• Close - Close the Time Zone Properties dialog box.

318 Time Zones

 MAN006-0612

View Select the Holiday Schedules option to display the current holiday
schedules in a pane above the time zone matrix like this example:

This enables you to review the present holiday schedule definitions before
assigning one or more to the current time zone.
You can also edit a holiday schedule name/description by clicking in the
Description column and editing the schedule name. The name will be
changed throughout the system.

Help Select this option to display help pages relevant to the current topic.

Standard Time Zone Properties Page

The Standard Time Zone Properties page looks like this example:

This page contains these fields:

Menu tool Refer to Time Zone menu toolbar in “Time Zone Properties Dialog
bar Box” on page 318.

Time Zones 319

Velocity Version 3.1 Administrator’s Guide

Name A descriptive name for the standard time zone like 'Standard Work
Week' or 'Shift 2'.
As indicated by the legend at the bottom of the property sheet, the
background indicates the current state of this STZ:
• If the STZ is being used by a controller, the background is yellow.
• If the STZ is not currently referenced by a controller, the
background is peach.
• If the STZ is unchangeable, the background is gray.
To change the name:
1. Double click the name you want to change. The Choose Name
dialog box appears.

2. Enter a new name.

3. Click OK.
There are 66 standard time zones (STZ0 - STZ65) you can choose
from, two of which are predefined and cannot be changed:
<Never> (STZ0) and <Always> (STZ65). This leaves 64 editable
standard time zones (STZ1 - STZ64) that you can define.

Start The beginning time for this zone.

To set the start time:
1. Click the 'Start' column for the time zone you need. The hour
field is highlighted.
2. Use the up and down cursor keys to change the hours, or enter
the hour you need.
The time is based on a 24-hour clock in which 00:00 is
midnight.
3. Tab to or click on the minute field.
Use the up and down cursor keys to change the minutes, or
type in the minutes you need.
Once you're finished with the 'Start' fields, press the Tab key to go
to the 'End' fields.

320 Time Zones

 MAN006-0612

End The ending time for this zone.

To set the end time:
1. Click the 'End' column for the time zone you need. The hour
field is highlighted.
2. Use the up and down cursor keys to change the hours, or type
in the hour you need.
The time is based on a 24-hour clock in which 24:00 is
midnight.
Note: The Start definition for midnight is different from the End definition.
3. Tab to or click on the minute field. Use the up and down cursor
keys to change the minutes, or type in the minutes you need.
Note: The end time cannot be less than the start time. STZs cannot cross
midnight.

Days Days of the week for which this STZ's time interval applies.
MTWTFSS Check each day applying to this time zone. A check mark appears.
For examples of how this works, click “Time Zones Examples” on
page 325.

H If you check H, the Time Zone is in effect EVEN during selected

holiday schedules.
If you do NOT check H, the Time Zone is in effect EXCEPT during
selected holiday schedules.
For example, in the preceding example screen, all days defined in
Holiday Schedule 3 are included in the STZ Mon-Fri 9AM-6PM
because the H day is checked. If the H is not checked, all days
defined in Holiday Schedule 3 would be excluded.
For more on this, refer to “Time Zones: Explaining the H Column”
on page 326.

Holiday The holiday schedules that apply to this STZ.

1234 Remember: if you check H in the previous days column, the STZ is
in effect even during the holiday schedules you check in these
columns. If you don't check H in the previous days column, the STZ
is in effect except during the select holiday schedules. You can
assign one or more holiday schedules to each STZ.
For examples of how this works, refer to “Time Zones Examples” on
page 325.
For more on defining holiday schedules, refer to “Holidays: How To
Define” on page 330.

Click this icon to create a new time zone. The Choose Name dialog
box appears.

Click this icon to save changes made to this time zone table.

Click this icon to delete a selected STZ.

From this page, you can easily proceed to the Master Time Zones and Grand Master
Time Zones pages by clicking the corresponding tab.

Time Zones 321

Velocity Version 3.1 Administrator’s Guide

Master Time Zone Properties Page

The Master Time Zone Properties page looks like this example:

This page contains these fields and buttons:

Menu tool Refer to Time Zone menu toolbar in “Time Zone Properties Dialog
bar Box” on page 318.

Name A brief description of the master time zone. As indicated by the

legend at the bottom of the property sheet, the background
indicates the current state of this MTZ:
• if the MTZ is being used by a controller, the background is yellow.
• if the MTZ is not currently referenced by a controller, the
background is peach.
The name for this master time zone is created using the Create
New Time Zone icon in the upper right corner, .
To change the name:
1. Double click the current name. The Choose Name dialog box
appears.

2. Type in a new name.

3. Click OK.

322 Time Zones

 MAN006-0612

Standard The STZs during which this MTZ is in effect.

Time To select STZs for this MTZ:
Zones
1. Click in the first available row under this column. A combo box
appears.
2. Click the combo box and an option list drops down listing all
currently selected STZs.
3. Select one of the existing STZs or select <New> to create a new
STZ.
The selected STZ appears in the list with all of its assigned
intervals displayed as shown in the example above. This list is
the same matrix shown in the Standard Time Zone Properties
page and can be changed from this page just as if you were on
that property page.
4. Select more STZs as required for this MTZ using steps 1-3.
5. If needed, you can modify a displayed STZ directly from this
page or return to the Standard Time Zone page to make your
modifications.
6. Save the MTZ definition by:
• clicking the Save File icon,
• pressing the Ctrl + S keys
• selecting File > Save from the menu bar
If you change an existing STZ, you are prompted to confirm these
changes. You can also add an STZ from this page just as you would
do on the Standard Time Zone page.

Click this icon to create a new master time zone. The Choose Name
dialog box appears.

Click this icon to save changes made to the time zone table.

Click this icon to delete the selected master time zone.

 Remember to save MTZ additions or modifications.

Grand Master Time Zone Properties

The Grand Master Time Zone Properties page looks like this example:

Time Zones 323

Velocity Version 3.1 Administrator’s Guide

This page includes these fields and buttons:

Menu tool bar Refer to Time Zone menu toolbar in “Time Zone Properties
Dialog Box” on page 318.

Name The name of the grand master time zone. As indicated by the
legend at the bottom of the property sheet, the background
indicates the current state of this GTZ:
• if the GTZ is being used by a controller, the background is
yellow.
• if the GTZ is not currently referenced by a controller, the
background is peach.
The name is created using the Create New Time Zone icon in
the upper right corner, .
To change the name:
1. Double click on the name you want to change. The Choose
Name dialog box appears.

2. Change the name as required.

3. Click OK.
The Grand Master Time Zone Configuration screen reappears.

Master/ To add a master or standard time zone to the GTZ definition:

Standard 1. Click in the first available column of the appropriate
Time Zones Master/Standard Time Zones column. A combo box appears.
2. Click this combo box and a list of all available standard and
master time zones appear.
3. Select the STZ or MTZ you need for this GTZ. To add a new
STZ or MTZ, select <New>.
Note: Before an STZ or MTZ can appear in the option list, it must be
saved.
4. Repeat steps 1 - 3 to add more STZs/MTZs to this definition.
You can make changes to a MTZ or STZ directly on this page. All
changes ripple through the application.
Note: If you try to select a STZ then select an MTZ which includes the
previously-selected STZ, then the STZ disappears from the list
and is replaced by the MTZ. Reselecting the STZ causes the MTZ
to disappear.

Click this icon to create a new grand master time zone. The
Choose Name dialog box appears.

Click this icon to save changes made to the time zone table.

Click this icon to delete the selected grand master time zone.

324 Time Zones

 MAN006-0612

Deleting Time Zones

You can delete a time from any of the three time zone pages—standard, master, or
grand master.
To delete a time zone:
1. Click on the time zone you want to delete.
2. Do one of the following:
• Press the Delete key.
• From the menu bar, select File > Delete.
• Click the Time Zone Delete button, . This button is located to the right of
the save file button.
You are prompted to confirm the deletion.
3. Click Yes to confirm the deletion. The time zone disappears from the time zone
matrix.
 You cannot delete:
• the <Always> or <Never> time zones. These are system defaults and
must remain in the system.
• any time zones currently used by a controller. If you try to delete one of
these time zones, a message appears informing you which controller(s)
currently use this time zone. You must delete the use of the time zone
from each controller before you can delete it from the system.

Time Zones Examples

This shows several time line examples indicating how both time zones and holidays
can be used within Velocity.
Step 1
First we define two holiday schedules:

Holiday Schedule Holiday Dates

1 7/14/01, 12/25/01, 1/1/02

2 12/24/01, 12/31/01

Step 2
Now we define time zone lines according to the following example:

Time Zones 325

Velocity Version 3.1 Administrator’s Guide

What this means is:

Starting Ending
Name Days H1234 Explanation
Time Time

Time Zone 1 6 AM 4 PM M-F 1 TZ1 is valid only M-F 6-4. The

three holidays in Schedule 1
are excluded.

Time Zone 2 9 AM 6 PM M-F 2 TZ2 is valid only M-F 9-6. The

two holidays in Schedule 2
are included.

Time Zone 3 8 AM 4 PM M-F 1 TZ3 is valid only M-F 8-4. The

three holidays in Schedule 1
are included.

Time Zone 4 9 PM 6 PM M-F 12 TZ4 is valid only M-F 9-6. The
five holidays defined by
Schedules 1 and 2 are
included.

Time Zone 5 6 AM 6 PM M-F 1 TZ5 is valid only M-F 6-6. The

three holidays in Schedule 1
are excluded.

Time Zone 6 6 AM 6 PM M-F 2 TZ6 is valid only M-F 6-6. The

two holidays in Schedule 2
are included.

Time Zones: Explaining the H Column

The use of the H column on the Standard Time Zone page in Velocity is a complex
concept. The following page should help you understand it.
Keep in mind that when you:
 Check H --> the Time Zone is in effect EVEN during holiday schedules selected.
 Don't check H --> the Time Zone is in effect EXCEPT during holiday schedules
selected.
Time Zones will ignore any holidays not in holiday schedules selected.
So, on to the example...
Step 1: Define Holidays

Schedule 1 Friday, July 4, 2003 U.S. Independence Day

Sunday, May 11, 2003 Mother’s Day

Schedule 2 Tuesday, July 1, 2003 Canada Day

326 Time Zones

 MAN006-0612

Step 2: Define Time Zones

Start Stop Holiday

Name Days
Time Time Schedule

Lobby Door 1 07:00 18:00 MTWTF H 1,2

Lobby Door 2 07:00 18:00 MTWTF H

Amer. Exec. 00:00 24:00 MTWTF H 1

Cana. Exec. 00:00 24:00 MTWTF H 2

Americans 08:00 17:00 MTWTF 1

Canadians 08:00 17:00 MTWTF 2

Plant Care 08:00 17:00 MTWTF 1,2

Guards 00:00 24:00 MTWTFSS

What this means:

Lobby Door 1 07:00 18:00 MTWTF H 12
Lobby Door is open Monday–Friday 7 am to 6 pm, including Tuesday, July 1 and Friday,
July 4. It is also open Sunday, May 11.
Lobby Door 2 07:00 18:00 MTWTF H
Lobby Door 2 is open Monday–Friday 7 am to 6 pm, including July 1 and July 4. As
there are no holiday schedules selected, all holiday schedules are ignored. It is not
open May 11 since this is a Sunday.
Amer. Exec. 00:00 24:00 MTWTF H 1
American Executives have access 24 hours a day, 5 days a week, including all holidays
in Holiday Schedule 1. They have access Sunday, May 11 and Friday, July 4. Schedule
2 is ignored, but they have access on July 1, because it is a Tuesday.
Cana. Exec. 00:00 24:00 MTWTF H 2
Canadian Executives have access 24 hours a day, 5 days a week, including July 1. As
Holiday Schedule 1 is not selected, they do not have access Sunday, May 11, but they
do have access Friday, July 4.
Americans 08:00 17:00 MTWTF 1
American Door is open Monday–Friday 8 am to 5 pm, except July 4. (Remember: if H
is not checked, it excludes the selected holidays.)
Canadians 08:00 17:00 MTWTF 2
Canadian Door is open Monday–Friday 8 am to 5 pm, except July 1 and May 11.
Plant Care 08:00 17:00 MTWTF 12
Plant care has access, during regular business hours, except on July 1 & 4 and May 11.
Guards 00:00 24:00 MTWTFSS
Guards have access 24/7. There are no holidays selected, so this time zone ignores all
holidays.

Time Zones 327

Velocity Version 3.1 Administrator’s Guide

Daylight Savings
Daylight savings time is controlled by the Windows system clock. Make sure your
Windows system is correctly enabled and calibrated.
To adjust your operating system for daylight savings:
1. Move your cursor to the tray at the bottom of the Windows desktop.
The Windows tray should appear with the time displayed in the right hand corner.
2. Double click the time field.
The Time dialog box appears.
3. Click the Time Zone tab.
The Windows time zone page appears like the following example:

4. At the time zone combo box, make sure you have selected the correct time zone
for this Velocity server.
5. Check the 'Automatically adjust clock for daylight savings changes' box below the
map as shown in the preceding example.
6. Click OK.

Creating Time Zones On-The-Fly

Many Velocity components require a time zone to define them, including Door Groups,
Credentials, and Function Groups. Some of these time zones will already exist but
others are not yet created. Instead of backing out of your current operation just to
define a new time zone for this purpose, you can create a time zone on-the-fly from
the current dialog box using the following technique.
To define a time zone on-the-fly:
1. At any time zone combo box throughout Velocity, click on the Time Zone combo
box.
One of the choices you'll see is <New>.
2. Click on <New>.
The Standard Time Zones Properties dialog box appears.
Above this dialog box appear three tabs to choose from: Standard Time Zone,
Master Time Zone, or Grandmaster Time Zone.
3. Either select this property sheet or click one of the other tabs to select that
property sheet.
• If you select standard time zone, the Standard Time Zone Properties page
appears.
• If you select the master time zones tab, the Master Time Zone Properties
page appears.
• If you select the grand master time zone tab, the Grand Master Time Zone
Properties page appears.

328 Time Zones

 MAN006-0612

4. Fill out the form as required.

5. Save your changes.
6. When you're finished, click OK.
You are returned to your previous screen with the time zone you just created displayed
in the Time Zone combo box.

Time Zones 329

Velocity Version 3.1 Administrator’s Guide

Holidays
Velocity can define up to four holiday schedules (sometimes called a holiday table)
with up to 365 holidays (366 for a leap year) per schedule.
These holidays can then be included in the definition of time zones.
 You can only define holidays for the current year and the following year.
For example, you could define holidays for 2002 and 2003, but not
2004. In addition, you must define a year for each holiday defined
whether it is a recurring holiday or not. For example, you cannot simply
define 'New Years' you must define 'New Years 2003'.
A holiday schedule is a group of days defined as holidays for this system. Schedule 1 is
checked by default. You can assign one or more holiday schedules to a standard time
zone.
If holidays are included in the time zone for a person's door group (by selecting the cell
that intersects the STZ row with the H column), access will be authorized when the
system's calendar detects a scheduled holiday date.
If a holiday schedule is not authorized, the specific door group denies access for each
designated holiday date.

Holidays: How To Define

To define a holiday:
1. From the system tree window, select the Velocity Configuration tree.
2. Click the Holidays folder.
All holidays currently recognized by Velocity appear in the components window. In
addition, there is an Add New Holiday folder.
3. Double click the Add New Holiday folder.
The Holiday properties dialog box appears. For more on this, refer to “Holiday
Properties Dialog Box” on page 331.
4. In the 'Name' field, type a name for this holiday.
 We suggest that you include the year in the holiday name, for example,
Christmas 2002.
5. In the 'Date' field, do one of these:
• Click on the day you need. Press Shift while clicking a start and end date on
the calendar to select a range of days. Click a selected (shaded) date to
deselect it; in this way, you can select a non-contiguous series of days. To go
backward or forward a month, click the or button at the upper left
and right hand corner of the calendar. A month displayed decrements or
increments as required.

330 Holidays
 MAN006-0612

• Click the button, and an expanded holiday properties sheet appears

with a calendar of the entire current year displayed like this example:

Click on the day you need. Press Shift while clicking a start and end date on the
calendar to select a range of days. Click a selected (shaded) date to deselect it; in
this way, you can select a non-contiguous series of days. To go backward or
forward a month, click the or button at the upper left and right hand
corner of the calendar. A month displayed decrements or increments as required.
To return to the previous single-month format, click the button.
6. At the 'Holiday Schedules' section, check one or more of the holiday schedules.
7. Click OK when you're finished.
 Checked holiday schedules are included in a time zone only if the H cell
is also checked on the Standard Time Zone properties page. If the H is
not checked, then no holidays can be included.

Holiday Properties Dialog Box

The Holiday Properties dialog box looks like this example:

The fields on this sheet are:

Name Enter a name for this holiday. Make the name descriptive, if
possible, such as 'New Years 2001' or 'Christmas 2002.'
As shown in these examples, we recommend that you include the
year in your name since Velocity views each holiday as a unique
date (that is, New Years 2002 is different from New Years 2003).

Holidays 331
Velocity Version 3.1 Administrator’s Guide

Date Specify the date on which this holiday occurs.

Do one of these:
• Click on the day you need. Press Shift while clicking a start and
end date on the calendar to select a range of days. Click a
selected (shaded) date to deselect it; in this way, you can select a
non-contiguous series of days. To go backward or forward a
month, click the or button at the upper left and right
hand corner of the calendar. A month displayed decrements or
increments as required.
• Click the button, and an expanded holiday properties sheet
appears with a calendar of the entire current year displayed like
this example:

Click on the day you need. Press Shift while clicking a start and
end date on the calendar to select a range of days. Click a
selected (shaded) date to deselect it; in this way, you can select
a non-contiguous series of days. To go backward or forward a
month, click the or button at the upper left and right
hand corner of the calendar. A month displayed decrements or
increments as required.
To return to the previous single-month format, click the button.

Holiday Check one or more of the holiday schedules to which this holiday
Schedules applies. For example, if you check Holiday Schedule 2 and 4, the
currently-defined holiday is added to both schedules.
Velocity supplies up to four schedules.

 You can only add holidays for this year and next year to Standard Time
Zones.
Daylight savings is effective for the current year only.

Holiday Schedules
Four Holiday Schedules (also called Holiday Tables) allow for more flexibility in defining
holidays. You now have an option to select which Holiday Table(s) apply to the
Standard Time Zone.
 The daylight savings changeovers are controlled by Windows. For more
on this, see Daylight Savings.

332 Holidays
 MAN006-0612

Several examples of how schedules are used are:

Multiple Tenants
Your building contains several tenants who not only require different hours of access
but, for religious, national, personal, or monetary reasons, also observe different
holidays. The building might contain a common lobby which should be open during
non-holidays and also open during days that are holidays for some, but not all, tenants.
To set up this example, we'll set up Holiday Table 1 for Company #1, Holiday Table 2
for Company #2, and Holiday Table 4 for the common lobby. We'll then set up
different Standard Time Zones that refer to the different holiday tables.
Half-Day Holidays
Your building has one tenant, who has a certain number of full-day holidays and also a
few half-holidays. On a half-holiday, the employees are expected to work until noon.
Set up the full Holidays in Holiday Table 1 and the half-day Holidays in Holiday Table 2.
Then set up one Standard Time Zone for the morning (except Full Holidays) and
another Standard Time Zone for the afternoon (except Full Holidays and Half Holidays).
9-out-of-10 Flex Schedule
Your building has employees who work on four different schedules—they work 9 days
out of every ten weekdays—and therefore have alternate Mondays off or alternate
Fridays off. You can accomplish this by assigning days off that employees on Schedule
#1 have off into Holiday Table 1 and so forth.
 Holidays that all employees have off, normally such as Christmas and
New Years, should go into every table.

Holidays 333
Velocity Version 3.1 Administrator’s Guide

Workstations
When Velocity communicates with Windows 2000, it automatically senses and displays
all computers currently defined as Velocity workstations. This assumes that all
connected computers—including all Velocity servers, database servers, and clients:
 are assigned a common Domain name
 possess proper computer names
 are installed with Velocity software
To view the Velocity workstations on your system:
1. Open the Velocity server as the Administrator or a member of the administrator
role.
2. If not already displayed, open the Administration Window.
3. From the System tree pane, expand the Velocity Configuration folder.
The Workstation folder appears.
4. Click to highlight the Workstations folder.
All currently assigned workstations appear in the Components pane like the
example shown below:

Also, there are occasions when you may need to lock down an existing workstation. To
do this, refer to “Locking Down Workstations,” starting on page 335.
 Multiple workstations are only supported by Velocity 2.0 and later.
Velocity automatically adds any computers it detects on the system that are running
Velocity. No additional configuration is required; however, there are circumstances
under which you may need to add workstations to the system.
For more on this, refer to “Adding Workstations” on page 334.

Adding Workstations
There are three circumstances under which you may need to add workstations to the
system. You need to:
 Add an XML client interface
 Customize Velocity web content for a PDA (such as a Pocket PC or a Palm Pilot)
 Redefine a Velocity workstation that has been accidentally deleted
To add a workstation:
1. At the Administration Window, expand the Velocity Configuration folder.

334 Workstations
 MAN006-0612

The Add New Workstation option appears in the Components pane.

2. Double click the Add New Workstation option.
The Add New Workstation dialog box appears.

3. In the 'Workstation Name' text field, enter the name you want for this workstation.
4. Click to select the radio button that best describes this workstation:

Select: To install:

Microsoft Windows OS A Velocity workstation you accidentally

(Standard computer) deleted from the system.

PDA (Pocket PC/Palm) A wireless computer that contains web

content customized to the Velocity interface.

Authenticated device An XML interface using XML Writers.

connection (XML) For more on this, refer to “XML Writers” on
page 360.

5. Click OK.
The new workstation appears in the components pane.

Locking Down Workstations

There are occasions when an operator may need to lock a workstation, or the person
using the workstation, out of the Velocity system. This occurs when the person using
the workstation has been fired or compromised. To bar access to a specific workstation
until the operator using the machine can be escorted from or leave the building, use
this procedure:
1. At the system tree pane in the Administration window, expand the Velocity
Configuration folder.
2. Click to highlight the Workstations folder.
All currently defined workstations appear in the components pane.
3. Right click on the workstation you want to lock down.
4. From the pop-up option list, select Lock Down.
A prompt appears asking you to confirm your selection.
5. Click Yes.

Workstations 335
Velocity Version 3.1 Administrator’s Guide

A red icon appears in the place of the workstation icon, like the following example:

The workstation is now locked down and no one can use it.
You can also lock down a specific operator by using the Operator Lock Down feature.
See “Locking Down Operators” on page 281.
To release a locked down workstation:
1. Repeat Steps 1 - 3 of the previous instructions.
2. From the pop-up option list, select Enable.
A prompt appears asking you to confirm your selection.
3. Click Yes.
The red icon is replaced by the normal workstation icon.

336 Workstations
 MAN006-0612

Alarm Responses
Operators are frequently in the position of entering a note or explanation for an alarm
(Operator Notes) when it occurs in Alarm Viewer. Since alarms are often repetitive, the
writing of the notes for these alarms is similarly repetitive. In an effort to shorten this
process, Velocity provides a means to create alarm responses which can then be
selected from a list of Alarm Responses.
To create an alarm response:
1. From the Velocity System Tree pane, expand the Velocity Configuration folder to
reveal the Alarm Responses folder.
2. Click to highlight the Alarm Responses folder.
The Add New Alarm Response option appears in the Components pane along with
any previously defined alarm responses.
3. In the Components pane, double click the Add New Alarm Response option.
The Alarm Response dialog box appears like this example:

4. In the 'Name:' field, enter a short name for this response.

5. In the text box, enter the text you want to appear whenever this alarm response is
selected.
This text should be in the form of instructions, a warning, or some other
description. For example, if this alarm response is to be associated with an
intrusion alarm, you might enter “Call 911, alert local security, and trace the exact
source of the alarm through Graphics.”
6. Click OK.
The next time an operator goes into the Alarm Viewer and selects the Add Operator
Note option, the name of each alarm response you defined here appears in the
drop-down pick list.

Alarm Responses 337

Velocity Version 3.1 Administrator’s Guide

Threat Levels
Threat levels — also known as security levels — refer to crisis level situations where a
higher threat level indicates heightened security.
Threat levels range from 0 to 99. Levels are defined by the operator or system
administrator. Use 0 or 1 to indicate normal operation. If threat level is not used, the
threat level stays at 0. If threat level support is used, start at 1 for situation normal and
proceed upward from there.
All credentials can have security levels associated with them. A person with a security
level of 99 will not be inconvenienced by any threat level situation except 99. A person
with a level of 10 can find himself locked out of the system when the threat level
reaches 11 – 99.
Threat levels can also be set controller-wide by a credential, a host command, or
master control zone. MCZs can only set values from 1 to 99. You can’t use a MCZ to
set a threat level at 0.
Threat levels can also be designated reader-by-reader. For example, if dual technology
readers are left in the CCOTZ mode during the day, they can be configured to revert
automatically to dual codes when a particular threat level is reached.
Readers can be configured to turn off automatically above a specific threat level so that
it no longer accepts codes from anyone. Velocity can also send a command to specific
readers to set the threat level.
Threat levels are associated with many features in Velocity including:
 readers
 master control zones
 limits page in credentials
A qualified operator can use a special Set Threat Level credential to set a specified
threat level at a reader/keypad. Once the special card/code is entered at the
keypad/reader, that reader is set at the threat level indicated by the credential. For
more on this, refer to “Special Functions” on page 250.
Threat levels are used by many different components and modules within Velocity
including:
 Set threat levels in master control zones
 Set the threat authority for credentials on the Limits page of credential properties
 Set the threat authority for credential templates on the limits page of credential
templates properties
 Disable readers above this level
 Disable CCOTZ above this level for a reader
 Threat levels are distinct from alarm levels. While threat levels restrict the
function of certain credentials and readers, alarm levels restrict the
acknowledgement of certain alarms by certain operators. For more on
this, refer to “Alarm Levels” on page 698.

338 Threat Levels

 MAN006-0612

Renaming Threat Levels

Threat levels in their default state are identified by numbers. These numbers can have
little meaning for most guards who are not normally in a position to differentiate
between, say, a Level 7 and a Level 23 threat. If you need to rename a threat level,
either to designate a text name like "Highest level" or “Requires immediate action”, do
this:
1. From the System Tree pane of the Administration window, expand the Velocity
Configuration folder.
2. Click to select the Threat Levels folder.
All threat levels are displayed in the Components pane.
3. Right click on the threat level whose name you want change.
4. Select Rename.
The threat level name becomes editable.
5. Change the name as required.
6. Repeat Steps 3 - 5 for each threat level you need to change.

Threat Levels 339

Velocity Version 3.1 Administrator’s Guide

Card Data Mapping

Some installations have thousands of cards outstanding and have no desire to change
MATCH codes to accommodate new readers and Hirsch MATCH boards. These facilities
simply want to use the established codes that are recorded magnetically or optically on
the legacy cards.
The customized card code feature in Card Data Mapping is designed for those security
systems. The feature instructs Velocity to read the current numbers on the card and use
that number as the MATCH number. This code can come from cards as diverse as
credit cards, bank cards, employee magstripe cards, or any other encoded card used by
the present system.
To create a card data map:
1. At the System Tree pane on the Administrator module, expand the Velocity
Configuration folder.
2. Click to select the Card Data Mappings folder.
The Components pane displays a list of existing card maps.
3. From the Components pane, double click the Add New Card Map option.
The Card Data Mapping dialog box appears like this example.

4. In the 'Name' text box, enter the name you want to use for this data map.
5. In the Use Customized Card Codes section, enter the appropriate numbers in the
available 16 boxes.
You can enter numbers 0 – 99 into any of the sixteen boxes. For a full discussion
of customizing, read “Using Customized Card Codes” on page 341.
6. When you're finished, click OK.
Once the card map is created, you can apply it to one or more readers as described in
the next section.

Applying Data Map to Available Reader

To apply a card data map to an available reader:
1. From the DIGI*TRAC Configuration folder, expand and select the reader (either
bundled or unbundled) to which you want to associate a card map.
2. Bring up the properties for that reader or door, then select either the Reader
General page or Door Reader Setup page.
3. At the bottom of this page, select an available card map from the Custom Card
Codes pick list.

340 Card Data Mapping

 MAN006-0612

4. Click OK.
The specified reader will use the customize card code specified in the card map when
processing cards.

Using Customized Card Codes

The feature enables the operator to read the number or any part of the number and
use it either in its original order or in an altered order.
For example, if the card contains the number 123456789 and the facility only utilizes
the last four digits, 6789, then the Velocity operator can specify that only the last four
digits should be read. Specify the first box as 6, the second box as 7, the third box as 8,
and the fourth box as 9 in this way:

For greater security, facilities occasionally use systems that rearrange the numbers read
by the reader, so that, for example, the fifth digit in the sequence is assigned to the first
digit and so on. Velocity's customized card code feature accommodates this strategy by
enabling the Velocity operator to reassign a particular digit to another digit location.
For example, if you have the six-digit number 792365, and you want to shuffle the
numbers so that the first digit (7) takes the third digit and fourth digit positions, and the
original fourth digit (3) takes the first digit position, the resulting number would now be
397765.
The card data mapping you would use to achieve this result would look like this
example:

Card Data Mapping 341

Velocity Version 3.1 Administrator’s Guide

342 Card Data Mapping

 MAN006-0612

Interfaces
Configuration
The Interfaces Configuration folder contains several components handled by Velocity.
These include:
 CCTV
 Serial Port Writers (page 344)
 E-mail Writers (page 348)
 XML Writers (page 360)
 Message Queue Writers (page 356)
 DVR/NVR
 Central Stations (page 365)
 Hirsch Trigger Action Manager (page 1187)
CCTV is addressed in a separate chapter, “CCTV Configuration,” starting on page 657.
DVR/NVR is also handled in a separate chapter, “DVR / NVR Configuration and Usage,”
starting on page 717.
The Hirsch Trigger Action Manager is discussed in “Trigger Action Manager” on page
1187.
The rest of the above topics are discussed in this chapter.

343
Velocity Version 3.1 Administrator’s Guide

Serial Port Writers

Some legacy SAM customers require that their host application provide an RS-232
(serial port) interface. This enables those customers to receive a one-way
communication of alarms and events that would normally be seen in the Alarm and
Event viewers.
The serial port writer is a Velocity server extension that enables a qualified operator to
designate how and when alarms/events are sent to the serial port and in what format.
As alarms and events are received from the server extension, they are filtered based on
time of day, category, and event number, then sent to the serial port.
To write alarms and events to a serial port:
1. From the system tree pane, expand the Interfaces Configuration folder until the
Serial Port Writer folder appears.
2. Click to highlight the Serial Port Writers folder.
The existing serial port designations appear in the components pane along with
the New Serial Port option.
3. From the components pane, double click the Add New Serial Port Writer
option.
The Serial Port Writer property sheet appears. For more on this property sheet,
refer to “ Serial Port Writer Property Sheet” on page 345.
4. Fill out the fields as required.
At a minimum, you must fill out the 'Name', 'Serial port', and 'Active during time
zone' fields.
5. In the For... window, check the event types this serial port applies to.
6. If you only need to include some of the events defined by a selected event type,
click the Select Events button.
The Advanced Event Selection dialog box appears. You can perform these tasks:
• Check all those events you need for this event type. When you're finished,
click OK.
• To create a format description for this event, double click anywhere in the row
and the Format dialog box appears. Include the tokens necessary for this
format. At run-time, all included tokens are substituted for data. When you're
finished, click OK.
7. When you're finished, click OK.
The new serial writer appears in the components pane.

344 Serial Port Writers

 MAN006-0612

Serial Port Writer Property Sheet

The Serial Port Writer property sheet looks like this example:

The fields and windows on this sheet include:

Name: Enter a name for this new serial port writer.

Serial port: From the drop-down option list, select one of the existing serial
ports on this computer. The default is COM1.

Data bits: From the drop-down option list, select the number of data bits
communications on this serial port support. The default is 8.

Bits per From the drop-down option list, select the number of bits per
second: second (bps) communications on this serial port support. This is
the speed at which the port works. Default is 9600.

Stop bits: From the drop-down option list, select the number of stop bits
communications on this serial port support. Default is 1.

Parity: From the drop-down option list, select the parity mode
communications on this serial port support. Default is None.

Start From the drop-down option list, select the start delimiter
delimiter: character used for this port. The default is CR.

Flow control: From the drop-down option list, select the flow control mode this
serial port supports. The default is None.

End From the drop-down option list, select the stop delimiter
delimiter: character used for this port. The default is CR+LF.

Separating From the drop-down option list, select the character used to
delimiter separate terms on this port. The default is a comma.

Serial Port Writers 345

Velocity Version 3.1 Administrator’s Guide

Active during From the drop-down option list, select the time zone during
time zone: which this serial port is active for this purpose. Select from one of
the existing time zones.
To create a new time zone for this purpose, see “Standard Time
Zones: How to Define” on page 314.

For... Check the box for each event or alarm type you want sent to this
port.

Select Events Click this button to define specific event types to be included in
the For... window.
The Advanced Event Selection screen appears (see page 346).
Check the boxes of all events you want the writer to enable. You
can also define the format in which the event is reported.

Enabled Check this box to indicate that the writer port is currently active.

Serial Port Writer: Advanced Event Selection

When you click the Select Events button, the Advanced Event Selection screen
appears. The Advanced Event Selection screen enables the qualified operator to detail
the specific events the serial port writer handles.

This screen includes:

Check this box to select this event. Uncheck it, to deselect. The
default is unchecked.

Type Indicates the event type(s) selected in the Properties For...

window. This is a read-only field.

Event No. The number of this event. This is a read-only field.

Description A brief description of the event. This is a read-only field.

Serial Format The token(s) you use to define the event format.
Double click in the row of the event you need and the Format
dialog box appears (see page 347).

Select All Click this button to check all events listed in the window.

Deselect All Click this button to uncheck all events listed in the window.

346 Serial Port Writers

 MAN006-0612

Serial Port Writer: Format Dialog Box

When this event takes place, the tokens specified in the format dialog box are replaced
by the actual data relevant to the token. For example, if you specify DI Door Index, the
program retrieves the door index for that event whenever encountered.

The buttons, fields, and windows on this screen are:

Format: Either enter a new format name here or select an existing format
from combo box drop-down list.

Contains: This window displays all tokens selected and added from the
'Does not contain' window.

Does not This window lists all currently defined tokens minus any tokens
contain: that have been added to the format definition of this event.

Move a selected token in the 'Contains:' window up one line. The

specified token appears one item to the left in the format order.

<<Add Move the selected token from the 'Does not contain:' window to
the 'Contains:' window. The selected token is now contained in
the format definition.

Remove>> Move the selected token from the 'Contains:' window to the 'Does
not contain:' window. The selected token is removed from the
format definition.

Move a selected token in the 'Contains:' window down one line.

The specified token appears one item to the right in the format
order.

Serial Port Writers 347

Velocity Version 3.1 Administrator’s Guide

E-mail Writers
Velocity enables an operator to notify a guard or administrator of a problem via their
E-mail.
Many guards and operators now carry remotely connected PDAs and handheld
computers that enable them to access their E-mail during their rounds. This feature can
contact those remote locations and leave notice of alarms and events throughout the
system.
To notify an operator by E-mail:
1. From the system tree pane, expand the tree until the Interfaces Configuration
folder is expanded.
The expanded Interfaces Configuration folder appears.
2. Click to highlight the E-mail Writers subfolder.
3. From the components pane, double click the Add New E-mail Writer option.
The E-mail Writer Properties screen appears. For more on this, refer to “E-mail
Writer Properties Dialog Box,” starting on page 348.
4. Enter the information you require on the properties screen.
5. To send a message with the properties, click the Mail Content tab.
6. Enter the message you want to send with this writer.
Use any combination of plain text and HTML to construct your message.
To insert the current event/alarm values into the text, use the <contents> variable.
7. Click OK. You are returned to the main menu.

E-mail Writer Properties Dialog Box

The E-mail Writer dialog box looks like this example:

348 E-mail Writers

 MAN006-0612

This screen includes the following fields and buttons:

Name: Enter the name for this E-mail writer.

Outgoing Enter the E-mail server used to notify the recipients.

mail If the E-mail server already exists on the system, click the combo
(SMTP): box and select the server from the pick list.

SMTP Settings:

Server: Either enter the path and name of the required SMTP (mail) server
or select one of the mail servers that appear in the drop-down list.
Only those mail servers currently recognized by this network
appear in this list.
If no mail server appears in the drop-down list and if you do not
know your mail server's IP address, you can validate the existence
of the mail server by clicking the browse button, . A message
appears indicating where your mail server exists for this network
and what its IP address is. Enter the IP address from this message
in the Server field.

From: Enter the name you want to appear in the From: line for this E-mail.

User name: If this SMTP account requires a user name to access it (most mail
accounts do), enter it here.

Password: If this SMTP account requires a password to access it, enter it here.

Active Select a time zone from the existing time zone pick list during
during time which E-mail writer is active.
zone: To create a new time zone for this purpose, refer to creating new
time zones starting on page 314.

Recipient Enter the addresses of all people you want to receive this E-mail.
list Separate multiple addresses with semicolons (;).

Event Check the box of each event type you want to trigger the issuing of
Selection an E-mail writer. When you check one of these types, all events for
window that type are selected.
To select only some events from the event type, the Select
Events button is activated.

Select Click this button to identify new types of alarms/events to add to

Events the 'For...' list.
For more on this, refer to “E-mail Writer: Advanced Event Selection”
on page 351.

Enabled Check this box to indicate that E-mail writer is currently active.

E-mail Writers 349

Velocity Version 3.1 Administrator’s Guide

The E-mail Content tab page looks like this example:

The E-mail Content tab is used to configure the appearance of the writer. The contents
of the E-mail can be refined to display the same values that appear in the Event viewer
of Velocity. The fields, buttons, and window on this screen are explained below:

Subject: Enter the subject inserted onto the subject line of the E-mail.

Append 'ALARM' Check this box to indicate that you want the word 'ALARM'
in subject during added to the subject line if this E-mail is notifying the
alarm writer recipient of an alarm condition. The word 'ALARM' is added
to the text specified on the 'Subject' text field.

Body: Specify the layout and message of this E-mail. Use either
plain text or HTML tags.
If you use plain text, you can specify variables using angle
brackets, such as <contents>.
If you want to use HTML to format the E-mail, use HTML like
the preceding example.

Send Format: Select one or other of these radio buttons to tell Velocity in
which format you want this E-mail sent.
• Click HTML to indicate that the text in the Body window
should be interpreted according to HTML conventions. This
is the default value.
• Click Plain Text to indicate the body should be sent as plain
text. Any HTML commands or tags in the text are displayed
as is.

Save as New Click this button to save the current text in the 'Body:' window
Default as the default wording and format for all E-mail writers.

350 E-mail Writers

 MAN006-0612

Restore Default Click this button to ignore any changes you have made in the
Body 'Body' window and return to the default settings. For an
example of what the default HTML page looks like, refer to
“E-mail Writer: Design Tips” on page 352.

Design Tips... Click this button to access design tips for creating the text.
For more on design tips, refer to “E-mail Writer: Design Tips”
on page 352.

E-mail Writer: Advanced Event Selection

When you click the Select Events button in the E-mail Writer Properties dialog box, a
screen like this appears:

This screen enables the qualified operator to define those specific events required for
the E-mail Writer. Only those events specified here can be reported by the writer.
 You must save the settings for this writer before you can enter or use this
feature.
This screen includes:

Check this box to select this event. Uncheck it, to deselect.

The default is unchecked.

Type Indicates the event type(s) selected in the Properties For... window.
This is a read-only field.

Event No. The event number for this event. This is a read-only field.

Description A brief description of the event. This is a read-only field.

Select All Click this button to check all events listed in the window.

Deselect Click this button to uncheck all events listed in the window.
All

E-mail Writers 351

Velocity Version 3.1 Administrator’s Guide

While the Serial Port Writer also contains a Select Events button, the screen and fields
that appear include several functions not described here. For more on this screen, refer
to “E-mail Writer: Advanced Event Selection” on page 351.

E-mail Writer: Design Tips

The default HTML settings for E-mail are contained in the 'Body' window on the E-mail
Content tab as shown below:

The result of this code is a form like this:

There are two methods for designing this page we discuss here: the easy way and the
slightly harder way. First the easy way.

Method 1
If you have no prior experience with raw HTML code manipulation and you have a
HTML editor installed on your machine, like Microsoft FrontPage or Macromedia
DreamWeaver, the easiest way is to use the tools in the editor to aid you in customizing
this text. To do this:
1. In the 'Body' window, click and select all the text.
2. Copy the text (Ctrl + C).
3. Open your HTML editor.
It should come up with a new page.
4. Click the HTML or Code tab.
5. Paste the code (Ctrl + V) on this page.

352 E-mail Writers

 MAN006-0612

6. Using both the HTML raw code and design views, manipulate the fields you must
change. The point of using a HTML editor is that you can see how the page will
look by switching between the code and design views.
You can customize these aspects of the form:
• color and font of the title
• color and font of the table heading
• contact E-mail address
• column sizes
• number of columns
Don't change the % delimiters or the text they enclose. These indicate variable
fields that Velocity changes to reflect the information required. For example,
%EVENT_ID% is the placeholder for a specific event ID that Velocity detects and
reports at this position, such as 10001.
7. When the form looks the way you want it, go into code (HTML) view and select
the entire code.
8. Copy the selected code text.
9. Go back into the E-mail Writer 'Body' window and paste the new text over the
existing text.
The form now reflects the changes you've made.

Method 2
HTML code is reasonably simple to create and edit. There are many books available
that can tell you the basics, which should be all you need in order customize the E-mail
writer to your requirements.
The essentials are discussed below:
Step 1
To change the title bar, look at this piece of text near the top:
<div align="left">
<table border="0" width="100%" height="14" cellspacing="0"
cellpadding="0">
<tr>
<td width="100%" height="22" bgcolor="#CC0000"><b><font color="#FFFFFF"
size="2" face="Verdana">&nbsp;Velocity E-mail Writer</font></b></td>
</tr>
<tr>
<td width="100%" height="14" bgcolor="#000000">&nbsp;</td>
</tr>
</table>
</div>

You can change the title by replacing the Velocity E-mail Writer text with text of your
own. Change the font in which it appears by specifying a different face= value.
Change the font color or size by specifying a different font color= or size=
value. The font color attribute uses the same color code as the color properties in
the Designer property pane. All sizes are in picas.
You can change the red bar or the black bar beneath it to another color or another
height. For example, to change the black bar, you would take these lines of code:
<tr>
<td width="100%" height="14" bgcolor="#000000">&nbsp;</td>

E-mail Writers 353

Velocity Version 3.1 Administrator’s Guide

</tr>

and change the td height= to change the bar height and/or the bgcolor= value to
change the color. Alternatively, you could simply delete these three lines to erase the
bar altogether.
 Don't modify either the angle brackets < > or the HTML commands, like
a href or /a. These are required HTML elements without which your
page won't display correctly. Also, in general, you shouldn't have to
change the quotation marks, ", since these indicate that a constant exists
between them.
Step 2
To change the administrator E-mail contact, go down to this text statement:
<a
href="[email protected]">[email protected]</a>

Replace the "[email protected]" and [email protected]

with the E-mail address you want. The href statement tells the browser what E-mail
address to enter and the second instance is the actual display element.
Step 3
To change the table containing the itemized message, refer to this text statement:
<table border="0" height="19" width="750">
<tr>
<td width="164" height="8" bgcolor="#C0C0C0"><font size="2"
face="Verdana">Time</font></td>
<td width="109" height="8" bgcolor="#C0C0C0"><font size="2"
face="Verdana">Event</font></td>
<td width="311" height="8" bgcolor="#C0C0C0"><font size="2"
face="Verdana">Description</font></td>
<td width="135" height="8" bgcolor="#C0C0C0">
<font face="Verdana" size="2">Address</font></td>
<td width="183" height="8" bgcolor="#C0C0C0"><font size="2"
face="Verdana">Type</font></td>
</tr>
<tr>
<td width="164" height="4"><font size="2"
face="Verdana">%DATE%</font></td>
<td width="109" height="4"><font size="2"
face="Verdana">%EVENT_ID%</font></td>
<td width="311" height="4"><font size="2"
face="Verdana">%DESCRIPTION%</font></td>
<td width="135" height="4"><font face="Verdana"
size="2">%ADDRESS%</font></td>
<td width="183" height="4"><font size="2"
face="Verdana">%EVENT_TYPE%</font></t
</body>
</html>
</table>

To change the width of the table, change the td width= value for each row element.
We recommend that you leave the height value as it is. If you change the width of one
or more columns and want to keep the table the same width, you must compensate
for it by changing the width (td width=) of the other columns.
To change column headings characteristics, look at each argument like this:

354 E-mail Writers

 MAN006-0612

<font size="2" face="Verdana">Time</font>

Modify the font size= value to change the font size. Modify the face= value to
place a new font. Change the text between the > and < brackets to change the column
text.
So, for example, if you change these elements:
<font size="3" face="Courier New">Hours</font>

the column heading would be in Courier at a slightly higher size and the text appearing
there would read Hours rather than Time.
If you changed an aspect of the heading, perform the same modifications for the body
column. So, for example, if you changed the td width values for the heading, you must
also change the td width= value for each table row (tr) beneath it.
These are the basic changes you can make. To make wholesale changes, you must be
conversant with HTML or use Method 1.

E-mail Writers 355

Velocity Version 3.1 Administrator’s Guide

Message Queue Writers

A Message Queue Writer takes specified Velocity data and sends it to an encrypted
message queue from where it can be received by a valid message queue target and
adapted in any way the recipient sees fit. Message Queue Writer takes advantage of the
Microsoft Message Queue application that comes as a standard component of
Windows and allows applications to exchange messages among themselves using
queues — outgoing queues for messages waiting to be sent and incoming queues for
messages waiting to be received. Message queues guarantee steady and controlled
flow of information, even if the network is congested or suffers frequent disconnects.

Hint Message Queue Writer functions in the same way as XML Writer except that
Velocity's Message Queue Writer outputs an encrypted data stream that can be
read and interpreted by any Microsoft-compliant Message Queue application.

Message queues are used for such purposes as streaming information and pop-ups
that can display vital Velocity information on any number of wired or wireless networks.
This enables a mobile Velocity operator with the proper qualifications to receive
real-time Velocity updates no matter where he/she is.
 This feature is normally set up by experienced third-party integrators
who have a thorough knowledge of message queuing. For more
information on setting up this feature, consult Hirsch Professional
Services.

Message Queues: Preliminaries

While Windows supports message queues, none are defined for a system by default.
One of two things has to occur before a message queue is present on a computer:
The user or administrator must define each message queue they need manually.
An application requiring a message queue is installed on the computer. In such cases, a
message queue is usually installed automatically during the installation process.
Before you can add a specific message queue, you must first install the Message
Queuing component.
To install Message Queuing:
1. From Windows desktop, select Start > Control Panel.
The Control Panel appears.
2. Open Add or Remove Programs.
The Add or Remove Programs screen appears.
3. From the left pane, click Add/Remove Windows Components.
The Windows Components Wizard appears.
4. Scroll down until the Message Queuing component appears.
5. Check the Message Queuing check box.
6. If you want to change the default set of optional subcomponents that will be
installed, click Details... then do the following:
• If the computer belongs to a domain and you want it to operate in workgroup
mode, clear the Active Directory Integration check box.
• If you do not want to install Message Queuing Triggers, clear the Triggers
check box.

356 Message Queue Writers

 MAN006-0612

• If you intend to send messages by HTTP transport, select the MSMQ HTTP
Support check box.
If you don't need to change the subcomponents simply to the next step.
7. Click Next.
Windows installs and configures Message Queuing.
8. Click Finish.
Now you're ready to define one or more Message Queues.
To define Message Queues:
1. From Windows desktop, select Start > Control Panel.
The Control Panel appears.
2. Double click Administrative Tools.
The Administrative Tools screen appears.
3. Double click Computer Management.
The Computer Management screen appears.
4. From the left tree pane, expand the Services and Applications component.
The Message Queuing component should appear.
5. From the right component pane, right click on Private Queues.
6. Select New > Private Queues from the pop-up option list.
The New Private Queue dialog box appears like this example:

7. In the Queue name field, enter the name of this queue.

This is the name you will supply in the Queue name field on the Message Queue
Writers Properties sheet.
8. Click OK.
The queue is now added. You can also define Outgoing Queues and System Queues
in the same fashion.

Hint Setting up Message Queue and creating one or more queues within that
component is not the same as actually using Message Queue. In order to realize
the potential of this feature, you must know about message queuing and how to
program for it. We recommend that you consult a third-party who specializes in
setting up message queues or Hirsch Professional Services for more on this
feature.

Message Queue Writers 357

Velocity Version 3.1 Administrator’s Guide

Message Queue Writer: How to Define

To create a message queue writer:
1. From the System Tree pane, expand the Interfaces Configuration folder until the
Message Queue Writer appears.
2. If the Message Queue Writer does not appear in this folder, refer to the Server
Extensions Manager for information on installing this feature.
3. Click to highlight the Message Queue Writer.
The Add New Message Queue Writer option appears in the Components pane
along with any Message Queue Writers already defined for this system.
4. In the Components pane, double click the Add New Message Queue Writer option.
If this is the first time you have selected this option, a Feature Activation screen like
this appears:

Activate this product according to the instructions contained in Feature Activation.

If you have already activated this feature, go to the next step.
The Message Queue Writer Properties screen appears.

This screen includes the following fields and buttons:

Name Enter a name for this message queue writer.

358 Message Queue Writers

 MAN006-0612

Queue Enter the name for the message queue to which this writer
sends the events specified in the window below.
For more on defining message queues in Windows, refer to
Message Queues.

Format Select the format in which you want these events written.
The default option is Velocity XML 1.0.

Active From the drop-down option list, select the time zone during
during time which this writer is active.
zone All currently defined time zones appear in this list. If you need
to define a special time zone for this purpose, refer to
defining a time zone.

Event window This window displays all the general event types that you can
send using this writer. When you check one of these types, all
events for that type are selected.
To specify which events within each event type you want to
send, click the Select Events button.

Select Click this button to specify which individual events you want
Events sent using this writer.
The Select Events dialog box appears.

Enabled Uncheck this box to indicate that this message queue writer is
not ready for use. By default, this box is checked (Enabled).

5. Enter information on this screen as needed.

Every field must be supplied; there are no optional fields.
6. When you're finished, click OK.
The new message queue writer appears in the Components pane.

Message Queue Writers 359

Velocity Version 3.1 Administrator’s Guide

XML Writers
Velocity now includes an XML Writers module. This enables Velocity to output Velocity
database information—such as alarms, events and personnel information—in XML
format through a specified port. This XML script can then be exported to another
application. A qualified programmer can create a program that cross-matches the
existing Velocity XML tags to another application's XML tags, thereby formatting the
exported Velocity data for another purpose.

Hint If this sounds familiar, it is: the Serial Port Writer module works on the same
principle, only instead of converting Velocity data into a flat-file format before
outputting it through a designated RS-232 serial port, the XML Writers module
translates the data into XML before sending it through a designated logical port.

For example, Velocity database information can be seamlessly transferred to a Human

Resource application using XML.
In order to transfer information between Velocity and another program using XML, a
small translation program must first be created, as shown in this illustration:

Third-Party
Application

3 rd Party XML
Translator

(created with IDK)

Database

XML
XML
Writer
Velocity

The process of creating a translator program that enables a third-party application to

use Velocity information is handled in one of two ways:
 Purchase the Velocity Interoperability Developers Kit (IDK) from Hirsch. Your
programmer can then write the required program using the APIs and other
information included in the package.
 Hire the Hirsch Custom Programming Division to write the required intermediary
program for you. For more on this, contact Hirsch Electronics.
To install the XML Writer, refer to the next topic.
To configure XML Writer, refer to “Configuring XML Writers” on page 361.

360 XML Writers

 MAN006-0612

Installing XML Writers

The XML Writer extension is included in your Velocity installation but is not added by
default. The reason for this is that, once activated, the XML Writer continuously converts
Velocity data to XML then pumps it through the designated port. This is a
processor-intensive activity that can slow down your computer's operation.
 Do not install or activate this module unless you mean to use it. It can
slow down your computer significantly.
1. From the Velocity menu tool bar, select Add-Ins > Server Extensions...
The Velocity Server Extensions Manager appears like this example:

Notice that by default the DVR, E-mail Writer, Serial Port (RS232) Writer, and Task
Manager are selected; however, the XML Writer extension is not automatically
included.
2. Click Install.
The Find Server Extension dialog box appears. You should see a list of .HEX files
listed in the \Velocity folder, including XMLWriter.HEX.
3. Click to select XMLWriter.HEX and click Open.
A message appears.
4. Click Yes.
The XML Writer extension now appears in the Velocity Server Extensions Manager
window.
5. Click OK.
A message appears telling you that changes to the Enabled property take effect
when the Extension Service is restarted.
6. Click OK.
The XML Writers folder appears under the Interfaces Configuration folder next time you
close and re-open Velocity.
To configure XML Writers, refer to the next topic.

Configuring XML Writers

To configure XML Writer:
1. From the Velocity system tree pane, expand the Interfaces Configuration folder to
reveal the XML Writers folder.
2. Click to select the XML Writers folder.

XML Writers 361

Velocity Version 3.1 Administrator’s Guide

The Add New XML Writer option appears in the components pane along with any
previously defined XML interfaces.
3. In the components pane, double click the Add New XML Writer option.
The XML Interface Properties dialog box appears.

The fields in this dialog box are described below:

Name Enter a name for this XML writer.

Port Enter the port on this computer used for transferring XML
data to another source.

Encryption Check this box to indicate that data should be sent in

encrypted form. Only the password specified below will allow
the recipient to decrypt the XML data.
The 'Password:' field is activated.

Password If you check the 'Encryption' box, this field is activated. Enter
a password in this text box that will allow the recipient to
decrypt the XML data.

Active during Select the time zone during which this writer can be active.
time zone

Alarm/Event The available alarm and event types appear in this window.
window Check one or more of the associated boxes to indicate that
these alarms/events should be translated to XML by this
writer.

362 XML Writers

 MAN006-0612

Select Events This button is activated when you select one or more
Alarms/Events from the above window. The Advanced Event
Selection dialog box appears (see page 364). A list of
available alarms and events for the selected alarm/event
types appears. Check those specific alarms/events you want
filtered.
If you click this button before saving the current writer
properties, a message appears asking you to save now. Click
Yes.
Click Select All to select all the alarms/events in the list.
Click Deselect All to remove the check marks from all
alarms/events in the list.

Enabled Check this box to enable use of this writer. Uncheck this box
to disable this writer.

4. At the 'Name' field, enter the name of the new XML interface.
5. At the 'Port' field, enter the port number used by this writer to transfer XML data to
another source.
This is the port the destination programmer “listens to” in order to collect the XML
data.
6. If required, check the ‘Encryption’ box to indicate you want the data sent in an
encrypted form.
7. If needed, enter a password in the ‘Password’ text box that will enable the recipient
to decrypt the XML data.
8. At the 'Active during time zone' combo box, specify the time zone during which the
transfer can take place.
9. From the window, check all relevant alarms and events that you want translated by
this XML writer and sent to another source.
10. To filter events and alarms by particular event or alarm types:
a. Click Select Events.
b. If you haven't saved this writer yet, you are prompted to save the writer by
clicking Yes.
The Advanced Event Selection dialog box appears. For more on this, refer to
“Advanced Event Selection” on page 364.
c. Check types as required. All events and alarm types are listed in ascending order
by Event Number.
To select all types, click Select All. To deselect all checked types, click Deselect
All.
d. When you're finished, click OK.
You are returned to the XML Interface Properties sheet.
11. If this writer is not yet enabled, uncheck the 'Enabled' box. Leave it checked if the
writer is enabled and ready to go.
12. Click OK.
The writer now appears in the components pane.

XML Writers 363

Velocity Version 3.1 Administrator’s Guide

Advanced Event Selection

When you click the Select Events button, the Advanced Event Selection screen
appears.
The Advanced Event Selection screen enables the qualified operator to detail the
specific events the serial port writer handles.

This screen includes:

Check this box to select this event. Uncheck it, to deselect. The
default is unchecked.

Type Indicates the event type(s) selected in the Properties For...

window. This is a read-only field.

Event No. The number of this event. This is a read-only field.

Description A brief description of the event. This is a read-only field.

Select All Click this button to check all events listed in the window.

Deselect All Click this button to uncheck all events listed in the window.

This screen is similar to the one that appears in the serial writer but lacks the Format
column.

Hint When we talk about events in Velocity we are referring to the superset of
messages and data routed by Velocity -- the umbrella term encompassing all
possibilities. Alarms are one category of events within which are contained several
subcategories, including external, internal, and port alarms.

Velocity can display any of the possible events in the Event Viewer. The program
extracts alarms from events in the Alarm Viewer.

364 XML Writers

 MAN006-0612

Central Stations
The Central Stations option enables qualified Velocity operators to monitor alarms
recorded at one or more alarm panels. In this hierarchy, central station receivers
connect one or more alarm panels. Each alarm panel in turn connects to one or more
command centers which connect to one or more alarm detection points.
The following illustration shows this system and how it ties in to the Velocity host:
Receiver Accounts / Areas Points

Velocity
Command Center
Heat/Motion Detectors
TCP/IP or Serial

Velocity Host
Command Center
TCP/IP or Serial
Alarm Panel Pull Station
TCP/IP or Serial

Command Center

TCP/IP or
Receiver TCP/IP or Serial Serial Voice Evaculation Units

Command Center
TCP/IP or Serial
TCP/IP or Serial

Strobe/Horn Annunciators
Command Center

Control Panel

Local Host Smoke Detector

Command Center

Programming Software

Velocity can neither configure the alarm system nor control (acknowledge or clear)
alarms detected by these receivers; it can only monitor those alarms. The clearing and
acknowledgement of alarms must take place at the local level, either through the
command center or alarm control panel. The configuring of the alarm system is
normally handled by local host PCs using device-specific configuration software.
In order to set up Velocity for the Central Stations function, you must:
1. Connect all devices to command centers/alarm control panels.
2. Connect command centers/alarm control panels to the Receiver.
3. Configure the command centers/alarm control panels and their connected devices
using proprietary configuration software.
4. Configure communications between the Receiver and its connected command
centers and alarm control panels using the receiver’s configuration software.
5. Connect the Velocity host to the receiver using either serial or Ethernet cable.
6. Configure Velocity to accept the receiver input. For more on this, refer to “Central
Stations: Setting Up Velocity,” starting on page 369.

Central Stations 365

Velocity Version 3.1 Administrator’s Guide

Of these operations, only the last one is detailed in this section. The task of connecting
and configuring the receiver, command centers, and alarm control panels is
accomplished using proprietary software applications specific to the connected devices.
For example, a Radionics D6500 Receiver is configured using the D6200 programming
software. The D9124 Fire Alarm panel is programmed using the RPS software.
Individual command centers and control panels are normally configured by a local
laptop PC loaded with the requisite software, like RPS.
Only after the device-specific software has defined the devices making up the alarm
system can Velocity identify those devices using the same values. Amongst the
parameters you must define for the individual devices, these properties are most
important before Velocity can engage the alarm system:
 Receiver address (IP or COM port address) (see page 369)
 Accounts (see page 373)
 Areas (see page 374)
 Points (page 375)
Follow the instructions in the appropriate manufacturer’s setup guide to configure the
connected alarm devices.
For a brief overview of this process, refer to “Alarm Device Configuration Preparation”
on page 366.

Alarm Device Configuration Preparation

The essential steps you must follow in order to prepare Velocity for communication
with alarm systems are:
 Connect the alarm centers/panels to their corresponding detection devices (points)
 Connect the alarm centers/panels to the alarm receiver
 Configure alarm panels (for more on this, refer to “Configuring Alarm Panels” on
page 6-366)
 Configure the alarm receivers (for more on this, refer to “Configuring Alarm
Receivers” on page 6-368)
In all cases, consult your manufacturer's installation and configuration guides for
detailed information.

Configuring Alarm Panels

The normal process by which these intermediate components are configured involves
connecting a PC via Ethernet or serial cable to the required panel or center. Once this is
accomplished, you should run the configuration program appropriate to that device. For
example, in the case of the Radionics D9124 Fire Alarm panel, the RPS software is
used.
The instructions below refer to one manufacturer; however, terms and definitions are
common to many alarm manufacturers and configuration software is similar.
To configure alarm panels:
1. Open RPS on your configuring PC.

366 Central Stations

 MAN006-0612

The RPS screen looks like this with all of the available panels displayed.

click this icon

If the panel you want is not displayed, click the Locate icon on the icon tool bar
and find the panel from the available connected devices.
2. From the window, select the panel you want to configure and click the Open icon
on the icon tool bar.
The Panel View appears like this example:

3. Select each panel item relevant to defining this panel.

Follow your panel guide to select and define each panel.
4. Define the area parameters and associate them with the proper account number
as shown in the previous example.
Make sure all areas you need are enabled and that you provide the correct account
number for each. In many cases, the same account number will apply to every
area.

Central Stations 367

Velocity Version 3.1 Administrator’s Guide

5. Define the point parameters as shown in the following example:

Points are generally sorted by the panel port number to which the corresponding
device is connected. For example, if you have connected an smoke detector to
Port 3, you will define that device as Point 3.
6. Write down the area, account, and point values you have assigned; you will need
them later when you configure Velocity.
7. Save your settings and exit.

Configuring Alarm Receivers

A large number of alarm and command panels can be attached to a single receiver.
Devices can be connected either using serial cable or ethernet. The connection
between the receiver and the Velocity server is generally ethernet.
To configure a receiver:
1. Connect the receiver to a PC installed with proprietary configuration software.
2. Open the configuration software.
The example here shows the Radionics CSR configuration software.
3. Specify the receiver's RS-232 COM port or IP address. In general, an IP address is
more mobile.
For example, you would designate an IP address using CSR software using the
Automation Network Connection tab as shown in this example:

Write down the IP

address for the Velocity
receiver setup.

368 Central Stations

 MAN006-0612

If, however, you use a RS-232 serial connection, you would use one of the
available COM Network Adapter tabs as shown in the following example:

Write down these values,

including the COM port
number, for the Velocity
receiver setup.

4. Provide all required information to define the receiver connection.

The IP address value in enter in the one case is the value you will enter in the
Velocity Receiver Setup IP address field. The values you enter on the COM tab you
select in the second case determines the values you assign (baud rate, data bit,
parity, stop bit, etc.) in the Velocity Receiver Setup Serial Port fields.
5. Write down the IP address or COM port information. You'll need it when you
configure Velocity.
6. Save the settings and exit the program.
Consult your receiver's installation and configuration guide for specific details.

Central Stations: Setting Up Velocity

Use the values you have gathered from configuring the alarm system to populate the
relevant fields in Velocity and prepare Velocity to monitor the alarm system.
In order to do this, you will have to define the following items and learn to perform the
following tasks in Velocity:
 Receiver (see page 369)
 Account (see page 373)
 Area (see page 374)
 Point (see page 375)
 Central Station Roles and Operators (see page 377)
 Using Alarm Viewer (see page 377)
 Placing Alarm Icons in Graphics (see page 378)
Each of these items is discussed on the following pages.

Central Stations: Receiver Setup

Before Velocity can communicate with the alarm receiver, you must define the receiver
address within Velocity. To do this:

Central Stations 369

Velocity Version 3.1 Administrator’s Guide

1. Open Velocity and expand the System Tree until the Central Stations subfolder
under the Interfaces Configuration folder is visible like the following example:

2. Click to select the Alarm Receiver subfolder.

3. In the Components window, double click the Add New Alarm Receiver option.
If this is the first time you have used this option, a feature activation screen like this
appears:

Refer to Feature Activation on page page 411 for instructions on getting the feature
key you need to register this new feature.
If this is not the first time and this feature is already activated, go to the next step.
The Add New Alarm Receiver dialog box appears.

The fields and radio buttons on this form are:

Name Enter a name for this receiver.

Description Enter a brief description of this receiver.

370 Central Stations

 MAN006-0612

Connection Time Out:

Initial Time Out Enter the seconds before an initial timeout occurs if
Velocity is unable to connect the Velocity Server and
the alarm receiver. An error message is sent to the
Alarm Viewer.
Range is 1 – 32676 seconds. The default is 10
seconds.

afterwards Report Enter the number of seconds between time out

Every messages sent to Alarm Viewer. This indicates that
Velocity continues to seek a connection with the
receiver but has so far been incapable of
connecting.
Allowed range is 1 – 32676 seconds. The default is
60 seconds.

Network:

Serial Port Select this radio button if the receiver is connected

to the Velocity server via an RS-232 connection.
The Port Settings section appears below like this
example:

TCP/IP Select this radio button if the receiver is connected

to the Velocity server via ethernet. The IP address
for the receiver must be previously defined.
The Network Settings section appears below like
this example:

Central Stations 371

Velocity Version 3.1 Administrator’s Guide

Network Settings:

IP Address Enter the predefined IP address for the receiver.

IP Port Enter the port number the Velocity server uses to

connect to the receiver. Check with your IP
administrator for the port you should use. 2001 is a
common port assignment.

Max retry attempts: Specify the number of retries allowed to connect

the receiver with the Velocity server before an error
message is issued.

Port Settings:

Baud Rate Specify the baud rate at which the receiver

communicates with the Velocity server.

Port Select the COM port on the Velocity server to which

the receiver is connected.

Data Bits Indicate the data bits. Normally, this is 7.

Parity Select the parity. This is Even.

Stop Bits Select the stop bits. This is 1.

Enable this Receiver Check this box to enable the receiver. This indicates
that the receiver is configured, connected, and read
to go.

Subsequently, if you right click on an existing Alarm Receiver and select the
Properties option, the same screen comes up only with a different title like this
example:
new title

4. Enter the information as required data.

5. Click OK.
The new receiver appears in the Components window.
The next step is to define the account(s) connected to this receiver.

372 Central Stations

 MAN006-0612

Central Stations: Account Setup

Accounts are initially defined for each alarm panel. These predefined accounts are then
used by Velocity to define the alarm systems. An account can contain one or more
areas. In general, an account can be thought of as a building, a campus, a floor, a
company, or some other physical unit that contains several areas within it — each of
which possesses one or more alarm devices (points).
To set up an account in Velocity:
1. Open Velocity and expand the System Tree until the Central Stations subfolder
under the Interfaces Configuration folder is visible like the following example:

2. Click to select the Account Management subfolder.

3. From the Components window, double click the Add New Account option.
The Account Properties dialog box appears like this example:

The fields on this dialog box are:

Account No. Enter the predefined account number. Account

numbers are associated with areas in most alarm
setups.

Account Name Enter a name for this account.

Description Enter a brief description of this account, if required.

Enable this Account Check this box to indicate that the account is
configured, connected, and ready to go.

4. Supply relevant values for these fields.

5. Click OK.

Central Stations 373

Velocity Version 3.1 Administrator’s Guide

The new account appears in the Components window as well as a new branch
under the Account Management subfolder like this example:

6. Repeat Steps 2 - 5 to define other Accounts.

The next step is to define the areas associated with this account.

Central Stations: Area Setup

Accounts contain one or more Areas. Each area defines one or more devices within a
specified location.
To define an area:
1. Open Velocity and expand the System Tree until the Central Stations subfolder
under the Interfaces Configuration folder is visible.
2. Click to expand the Account Management subfolder until the relevant Account
appears like this example:

3. Click to select the relevant account.

4. From the Components window, double click the Add New Area option.
The New Area Properties dialog box appears like the following example:

374 Central Stations

 MAN006-0612

The fields on this dialog box are:

Area No. Enter the predefined area number. Each area

number should correspond to the area number you
assigned for that area during the proprietary
software configuration.
Note: You can only enter numbers in this field, not
letters.

Area Name Enter a name for this area.

Description Enter a brief description of this area.

Enable this Area Check this box if the area is configured, connected,
and ready to go.

5. Fill out the fields as required.

6. Click OK.
The new area appears in both the components window and under the relevant
Account in the System Tree window like this example:

7. Repeat Steps 2 - 6 to define other Areas associated with this Account.

The next step is to define the points associated with this area.

Central Stations: Point Setup

Points are the detectors and other alarm devices that are connected to the alarm
panels and controllers. Each point defines a separate device. Each point must be
predefined using proprietary manufacturer software.
To define one or more points:
1. Open Velocity and expand the System Tree until the Central Stations subfolder
under the Interfaces Configuration folder is visible.
2. Click to expand the Account Management subfolder until the relevant Area
appears like this example:

3. Click to select the relevant area.

4. From the Components window, double click the Add New Point option.

Central Stations 375

Velocity Version 3.1 Administrator’s Guide

The New Point Properties dialog box appears like the following example:

The fields on this dialog box are:

Point No. Enter the predefined point number for this device.

Point Name Enter the name of this point.

Description Enter a brief description of this point.

Enable this Point Check this box to indicate that the point is
configured and connected.

5. Enter the required values for these fields.

6. Click OK.
The point appears in the Components window like the following example:

7. Repeat Steps 2 - 6 to define all the points associated with this area.
Once you have defined all the points for all the defined areas in all the defined
accounts, you have successfully completed the alarm setup.
The next step is to:
 Define the Operators and Roles that can access the central station feature (see
page 377)
 Learn to use the central station feature in Alarm Viewer (see page 377)
 Learn to place and use the alarm icons in Graphics (see page 378)

376 Central Stations

 MAN006-0612

Central Stations: Operator and Roles

Before operators can configure or view central station options, they must first be
qualified for access to these features.
To define a central station operator:
1. Expand the Velocity Configuration folder until the Roles subfolder appears.
2. Do one of these two:
• Double click the New Role option to create a new role for this purpose
• Double click on an existing role to include the new central stations access to
that group
The Role Properties dialog box appears.
3. Click on the Application Permissions tab.
4. In the ‘Name’ pane, click to select each of the available Central Stations
components.
These include:

Central Stations Account Provides access to the Account Setup.

Central Stations Area Provides access to the Area Setup.
Central Stations Point Provides access to the Point Setup.

5. In the ‘Role can...’ pane, check the permissions options as required.

6. From the main Velocity system tree pane, click to select the Operators subfolder.
If you are not going to assign new operators for this task and plan to use existing
operators instead, skip steps 7-8. Go to Step 9.
7. Define new operators as described in “Operators: How to Enroll” on page 275.
8. Do one of these:
• From the new Operator Roles property sheet, click Add... to add the new
Central Station role to the operator’s ‘Member of...’ list.
• Return to the Central Station role property sheet and click Add New
Member... to add the appropriate operators to the Role Members folder (see
page 310).
9. Click OK.
For more on these topics, refer to “Operators” on page 275 and “Roles” on page 285.

Central Stations: Using Alarm Viewer

Once you have configured a alarm system through the Central Stations feature, Velocity
will advise you of all alarms issued by the system through Alarm Viewer.
 You cannot acknowledge or clear alarms. These must be acknowledged
or cleared at the alarm panel/controller.
As with all other alarms, you must have the proper operator permissions or be a
member of a role that has the proper rights in order to view alarms. See “Central
Stations: Operator and Roles” on page 377 for more on this.

Central Stations 377

Velocity Version 3.1 Administrator’s Guide

In Alarm Viewer, alarms have a format similar to most other security alarms, as shown
in the following example:

In the preceding example, both an alarm (Point 1) and a burglary alarm (Point 2) are
issued then subsequently resolved.
Unlike with other Alarm Viewer messages, there is no right click Acknowledge or
Clear option, so all alarms must be resolved at the panel where they were issued.
For a more graphic representation of alarms, place alarm icons on a Velocity map as
detailed in the following section.

Central Stations: Placing Alarm Icons on a Map

Use Velocity Graphics to place alarm icons on drawings or maps. Follow this procedure:
1. Display an existing drawing/map/blue print or create a new one.
2. If not already displayed, bring up the Object Library pane.
3. Enter Design Mode.
4. In the Object Library pane, expand the Topology folder of the system tree until the
Central Stations subfolder under the Interfaces Configuration folder is fully
displayed like the following example:

5. Drag the required receiver(s) from the Object Library to the canvas and drop it at
the required spot.
The alarm receiver icon looks like this example: .
6. From the expanded Account Management folder, drag and drop one or more
Accounts you want to place on the canvas.
The Account icon looks like this example: .
7. From the expanded Account folder, drag and drop one or more Areas to the
required location on the canvas.
The Area icon looks like this example: .
8. From a fully expanded Area object, drag the Point you require from the Object
Library to the canvas.

378 Central Stations

 MAN006-0612

The VIO Selector dialog box prompts you for the type of icon you want displayed
for this object.

9. Select one of the icons you want to represent this particular alarm point and click
OK.
Currently, there are three default alarm icons available:

Icon Option Description

Detector Any detector.

Pull Station A pull station.

Glass Break Any intrusion such as a broken window

or jimmied door.

10. Once all icons are placed in the proper positions, return to Live Mode.
All qualified operators can now bring up this map and monitor the icons on it. For more
on this, refer to “Placing Objects on Drawings” on page 605.

Central Stations 379

Velocity Version 3.1 Administrator’s Guide

380 Central Stations

 MAN006-0612

Import/Export Wizards
Velocity includes a number of import and export wizards enabling administrators and
qualified operators to:
 Export or archive the Velocity database
 Import data from either archived files or another source for inclusion in the Velocity
database
The wizards discussed here are:
 Badge Template Migration Wizard (page 382)
 SAM Database Import Wizard (page 384)
 CCM Import Wizard (page 388)
 Velocity Data Export Wizard (page 390)
 Velocity Data Import Wizard (page 397)
 SNIB2 Import Wizard (page 403)
This chapter details the use of each wizard.

381
Velocity Version 3.1 Administrator’s Guide

Badge Template Migration Wizard

Badge & Graphic Designer is not backward compatible with badges created in Velocity
2.0. To expedite migration of badge templates from the older version to this version,
the installation DVD includes this program.
The Badge Template Migration Wizard automatically reassigns credentials created using
Version 2.0b and converts them to their version 2.5 counterparts.
Run this Wizard as often as necessary to migrate all version 2.0b badge templates to
version 2.5 badge templates; however, once a template is converted, it cannot be
returned to its original version 2.0b format. Only run the wizard on Velocity servers or
standalone systems. Velocity clients do not contain the Velocity database and therefore
have no badge templates to convert.
To run this wizard:
1. Open Windows Explorer.
2. Locate the Program Files\Hirsch Electronics\Velocity\ Unsupported\V2.0b to V25
Support folder.
3. Double click v25BadgeTemplateWizard.exe.
The introduction page appears.
4. Click Next.
The Step 1 - Map Badge Templates screen appears like this example:

This screen enables the operator to map v2.0b badge templates to newly-created
v2.5 badge templates. The left column displays v2.0b badge templates currently
referenced by one or more credentials. The right column displays the v2.5 badge
templates that the credentials should reference in place of the v2.0b templates.
The wizard automatically maps v2.5 templates with the same name (not
case-sensitive) as in the example above. If the wizard cannot find a matching v2.5
template with the same name, the message “<No Mapping>” is displayed. This
means no credentials will be updated at this time.
To manually map a v2.5 template to a v2.0b template:
a. Click the right column cell of the line corresponding to the v2.0b template.

382 Badge Template Migration Wizard

 MAN006-0612

A drop-down option list of defined v2.5 template appears as shown below:

b. Select the template from this list you want to map to the v2.0b template in the
left column.
If there are no credentials in the database that reference v2.0b badge templates,
a message appears. Click OK to continue.
5. Once you’ve completed the template mapping, press Next.
The Finished screen appears.
6. Click Finish.
A final screen appears.
7. Click OK.

Badge Template Migration Wizard 383

Velocity Version 3.1 Administrator’s Guide

SAM Database File Import Wizard

Use the SAM Import Wizard (also known as the Data Import Wizard) to import data
from your current SAM and ID Manager databases to the Velocity database.
SAM Import Wizard leads you through all the steps required to import persons and
their credentials from SAM systems to Velocity.
To use the SAM Import Wizard:
1. Gather your SAM database files from your SAM computer and write them to a CD,
DVD, or floppy disk.
2. Insert the SAM database CD, DVD, or floppy disk into the CD, DVD, or floppy drive
on your Velocity computer.
To save time, copy these files to the C: drive on your computer. Place the files
under the \SAM directory.
3. Open Velocity.
4. From the Velocity menu tool bar, select File > Import/Export > SAM (Import
Only).
The Introduction screen appears.
5. Click Next.
The Choose a Data Source dialog box appears.
6. Locate the directory where the SAM database resides using the 'Drive' combo box
and the 'Directory' selection field.
7. Click to highlight the directory.
The 'Location' text box displays the chosen directory as shown in the following
example:

If these files are still on the CD, DVD, or floppy, specify the drive.
8. Click Next.

384 SAM Database File Import Wizard

 MAN006-0612

The ID Manager Options dialog box appears:

9. Select whether you want to convert ID Manager photographs to the new Velocity
format so they can be loaded into Velocity.
If you pick the No radio button, the Finish button is enabled. Skip to Step 12.
If you pick the Yes radio button, do this:
a. Click Next.
The Locate ID Manager Database dialog box appears.
b. Locate the directory where the ID Manager database resides using the 'Drive'
combo box and the 'Directory' selection field.
c. Select and highlight the required directory. This is the directory where the
IDBadges.mdb file resides.
The 'Table' combo box is populated with the tables in that database. The table that
begins with “SAM” is selected by default.
10. Click Next.
The Locate Photo Directory dialog box appears.
11. Enter the ID Manager Photo Directory in the “Source” text box, or use the
button to locate it.
If you select the browse button, the Find Folder dialog box appears. Select the
proper photo folder where the ID Manager photograph files are kept. If you select
a valid folder, the Next button is activated.
12. Click the Next button.
The Locate ID Manager Photo Directory dialog box reappears.
If you have selected a directory, the 'Source' combo box contains the correct
directory.
13. Click the Next button.
If you select an incorrect directory, a message pops up. The Source text box blanks
out, enabling you to reenter the correct directory.
If you entered the correct photo directory name, the Set Photo Compression Ratio
dialog box appears.
14. Follow the instructions on the form to fine tune the photograph resolutions.
Use the slider bar to specify the compress ratio. The lower the slider's position, the
bigger the compression rate, the smaller the picture size and the lower the quality
of the photograph.
15. Click Finish.

SAM Database File Import Wizard 385

Velocity Version 3.1 Administrator’s Guide

The Data Migration Complete screen appears like the following example:

If the wizard experienced errors while importing the files, a list of errors are
displayed in the window. You have the option to click the Save button to save the
list of import errors to a file named “ImportErrors.log” in a location you specify or
accept the default application path if you don't specify a filename. Use this list to
make manual adjustments and imports as required. You must fix the errors before
you can proceed with the data migration.
16. Click Finish.
The Import In Progress bar appears, showing the progress of the import process.
Once the wizard completes the import process, you will see one of two screens.
If the wizard completed the import without errors, a Congratulations screen
appears.
17. Click Close to exit the Import Wizard.
For additional information on which files the Wizard imports, refer to following
section, 'Fields that SAM Wizard Imports'.

Fields that SAM Wizard Imports

This latest version of the SAM Import Wizard can import SAM database information that
conforms to the following standards.
Person record
Person records should be in this format:
Last_name, First_name, UserDefined Fields 1 - 16
SAM supports up to 16 user-defined fields.
 User_ID in SAM is imported as User Defined field 17 in Velocity.
Whether user-defined fields appear in Velocity depends on how you set up the
user-defined fields format. SAM does not support drop-down lists so you must supply
the options in Velocity. For example, if you set up user_defined_field_1 as a drop-down
list, the options won't show since SAM doesn't have any. You must create your own,
using the instructions in Changing User-Defined Fields.
Credential record
The credential records format is:
KPCodeLength, DuressDigit, KPCode, MatchCode, IDF,
HostCardStamp, Alert, fTagUser

386 SAM Database File Import Wizard

 MAN006-0612

 Neither Card Data nor Card Type are imported. You must specify this
information using the Credentials Template feature and the Enrollment
Manager module.
MATCH code is always imported. As long as a card user has a MATCH code, the
information is imported successfully as credentials.
The wizard can import all users including control users.
The wizard cannot build door groups since SAM does not support them. You must
create door groups in Velocity.

SAM Database File Import Wizard 387

Velocity Version 3.1 Administrator’s Guide

CCM Import Wizard

Use this utility to import the latest version of the CCM firmware and prepare it for
download to the CCMs on each controller connected to this server. The actual task of
downloading the CCM firmware to a controller is handled by the Update CCM
Firmware... button on the Controller dialog box.
To import and prepare the latest CCM firmware:
1. Make sure the latest version of the CCM firmware is located on the server's hard
disk. For best results, copy the .bin file to the \Velocity folder on your server's hard
drive.
For more on this, refer to “CCM Firmware Update Wizard,” starting on page 712.
2. From the Velocity menu tool bar, select File > Import/Export > CCM (Import
Only).
The CCM Import Wizard Welcome screen appears.
3. If you have more than one version of the CCM firmware on your machine and
want to delete the older versions, click the CCM Revisions button to display all
versions of the firmware currently stored on the Velocity server. Follow these steps
to delete the unneeded versions:
a. Click to check any old versions of the firmware displayed in the window you
want to delete.
The Delete button is activated.
b. Click the Delete button.
All checked firmware revisions are erased from the window.
c. Click Close.
You are returned to the first CCM Import Wizard.
If you don't need to delete any older versions of the firmware, proceed to the next
step.
4. Click Next.
The File Selection window appears like this example:

5. Select the CCM file you want to import from the pull-down option or click the
button to open the Open dialog box and browse your hard drive for the file you
need.
The file you want should be stored in the directory to which you copied the
firmware file during the download process.

388 CCM Import Wizard

 MAN006-0612

6. Click Next.
The Proceed to Import dialog box appears.
7. Click Next.
The utility imports the selected file and formats it so that Velocity can download it.
If the CCM already exists in the database, a message appears indicating this.
Indicate either Yes to replace the existing CCM code or No to cancel this operation.
The Finish dialog box appears.
8. Click Finish to complete the import process.

CCM Import Wizard 389

Velocity Version 3.1 Administrator’s Guide

Velocity Data Export Wizard

The Velocity Data Export Wizard enables you to export all personnel data, including
person and credential records, from Velocity into an archived format. The exported file
employs a CSV (comma-separated values) format and can be saved as a .txt file. Later,
the file can be re-imported using the Velocity Data Import Wizard.
To export Velocity personnel data:
1. From the Velocity menu bar, select File > Import/Export > Velocity Data
Export.
The Data Export Wizard is started and the following screen appears:

2. Click Next.
The Choose a Destination screen appears. For more on this, refer to “Velocity Data
Export Wizard: Choose Destination” on page 391.
3. In the 'Type:' combo box, accept the Text File option.
Currently, the text flat file is the only available option.
4. In the 'File name:' text box, enter the name you want to give this exported file.
If you want to substitute this file for an existing file, click the Browse button, .
The Select a destination folder screen appears.
You should also use the Browse button to specify a different folder from the
default Velocity\Export folder where you want the exported file kept.
The Next button is activated.
5. If you need to export user images along with the text, check the 'Export User
Images' box and specify the folder where you want the images stored in the
'Export Images to:' combo box.
6. When you're finished, click Next.
• If you created a new file name, you are prompted to confirm that you want to
create a new file. Click Yes.
• If you are substituting an old file name for this new file, you are prompted to
confirm this. Click Yes.
The Select Destination File Format screen appears. For more on this, refer to
“Select Destination File Format” on page 392.
7. Specify these values for the file format:
• Row delimiter
• Column delimiter
• First row column names
• Export all person data or specify criteria to export partial data

390 Velocity Data Export Wizard

 MAN006-0612

8. Click Next.
One of two things happens:
• If you checked the 'Specify criteria to export partial data' radio button, the Map
Data Fields screen appears. Go to Step 9.
• The Completing the Data Export Wizard screen appears like this example:

The 'Summary:' window on this screen displays the criteria you have specified for
this file. Go to Step 10.
9. Customize the export file as required. When you're finished, click Next.
For instructions on customizing the export file, refer to “Customizing the Export
File” on page 393.
The Completing the Data Export Wizard screen appears.
10. At the Completing the Data Export Wizard screen, click Finish.
The file is exported to the folder. The Data Export Result screen appears.
11. Click Done.

Velocity Data Export Wizard: Choose Destination

The Choose Destination dialog box looks like this example:

This screen includes the following field options:

Type: Specify the type of file Velocity will generate to export this file. At the
current time Text File is the only option.
Text files are flat data files and consist of delimited fields.

Velocity Data Export Wizard 391

Velocity Version 3.1 Administrator’s Guide

File Either enter the drive, directory, and name of the destination file or
name: click the Browse button and locate the correct path and name. If the
file name you select does not yet exist, you are prompted to confirm
your selection.

If you select Yes, the file name you requested is created.

Export Check this box if you want user images exported as well. These can
User be photos and signatures from the Enrollment Manager or graphics
Images from the Badge & Graphic Designer.
If you check this box, the Export Images to: field is activated.

Export Enter the drive and directory where you want the user images stored.
Images To locate the correct folder, click the Browse button and search for
to: the folder you need.

Select Destination File Format

The Select Destination File Format dialog box looks like this example:

This screen contains the following fields and buttons:

Row Delimiter: From the pull-down pick list, select the type of row delimiter
you want to use for this flat file. Select from the following
options:
• {CR}-{LF} — carriage return and line feed (this is the
default).
• {CR} — carriage return only
• {LF} — line feed only

392 Velocity Data Export Wizard

 MAN006-0612

Column From the pull-down pick list, select the type of column
Delimiter: delimiter you want to use for this flat file. Select from the
following options:
• Comma — use a comma to indicate a column
• Semicolon — use a semicolon to indicate a column
• Tab — use a tab to indicate a column

First row has Check this box to indicate that the first row includes the
column names column names. This is the default setting.

Export all Click this radio button to export all user data. The wizard will
person data gather all the user data from Velocity database and export it
into the destination. Once you click Next, the Completing the
Data Export Wizard screen appears.

Specify criteria Click this radio button to customize the data to export. Once
to export you click Next, a screen guides you in choosing which fields
partial data and rows to export.
For more on this, refer to “Customizing the Export File” on
page 393.

Customizing the Export File

If you selected the 'Specify criteria to export partial data' radio button on the Select
Destination File Format screen and clicked Next, the Map Data Fields screen appears
like this example:

Velocity Data Export Wizard 393

Velocity Version 3.1 Administrator’s Guide

Hint By default, one of the source field names the export wizard exports is
TemplateDescription. The default value of this field is the credential template's
description. This column is actually supplied for the use of the import wizard.

If the user does not provide a template ID for export, the import wizard uses the
template specified in the 'Use the following credential template...' combo box for
all records; however, if no template is specified here (the default is no template),
the import wizard cannot import any record.

To circumvent this possibility, the export wizard includes the TemplateDescription

source field which serves as a backup solution. Assuming it retains the credential
template description, the operator can match it with a credential template and use
that template for importing a credential.

To customize the export wizard:

1. Indicate the source field name you need.
Do one of these:
• If you are content with the current source field name, leave the name as it is.
• To change the source field name, click on the row you want and a combo box
down arrow appears, . A drop-down option list like this appears:

Do one of these actions:

• Pick (ignore) from the combo item list (as shown in the figure above) to
remove this source field from consideration.
• Pick another source field name from the list to rearrange the order in which
the data is presented by selecting the source items in the order required.
2. Assign a different column name to any source field name by picking the required
option from the corresponding 'Map To' column.
 This feature only works if you selected the 'First row has column names'
check box on the previous wizard screen. If you didn't choose that option
in the previous step, modifying the 'Map To' names doesn't have any
effect.

394 Velocity Data Export Wizard

 MAN006-0612

Study the example below to see how mapping source field names to other names
or ignoring some field names customizes the export file.

3. Click Next.
The Criteria and Sorting page appears like the following example:

To make changes to the criteria and sorting, uncheck the 'Use Default Criteria and
Sorting' box. The fields beneath it are activated.
4. Assign criteria and sorting guidelines as required.
• For information on using the Criteria subpage, refer to “Criteria Page” on page
1021.
• For information on using the Sorting page, refer to “Sorting Page” on page
1023.
5. When you're finished, click Next.

Velocity Data Export Wizard: Data Export Result

The data export result screen looks like this example:

Velocity Data Export Wizard 395

Velocity Version 3.1 Administrator’s Guide

This screen includes the following fields and buttons:

Export This read-only field displays a summary of the export results. If the
status: export was successful, this field shows the number of rows exported
to the file.

Result This window displays explanations of errors experienced while

window exporting the data. Each error is cataloged by row number, error
number, and error description.

Save to Click this button to save the information in the Result window to a flat
File file from where it can be reviewed or printed for further investigation.
The Save As dialog box appears. Specify the location and name of
the log file you require for this file.

Done Click this button to quit this screen and return to the main Velocity
screen.

396 Velocity Data Export Wizard

 MAN006-0612

Velocity Data Import Wizard

The Velocity Data Import Wizard enables you to import archived data, including person
and credential records, from archived files. The archived files are normally .txt flat files.
To import Velocity personnel data:
1. From the Velocity menu bar, select File > Import/Export > Velocity Data
Import.
The Data Import Wizard is started and the following screen appears:

2. Click Next.
The Choose a Data Source screen appears. For more on this, refer to “Velocity Data
Import Wizard: Data Source” on page 399.
3. In the 'Type:' combo box, accept the Text File option.
Currently, the text flat file is the only available option.
4. In the 'File name:' text box, enter the drive, directory, and name of the file you want
to import.
If you need to look for the location of the file, click the Browse button, . The
Select a source file screen appears.
The Next button is activated.
5. When you're finished, click Next.
The Select File Format screen appears. For more on this, refer to “Velocity Data
Import Wizard: Select File Format” on page 400.
6. Indicate the delimiters and restrictions you want the import engine to exercise on
this flat file. When you're finished, click Next.
The Map Data Fields screen appears. For more on this, refer to “Velocity Data
Import Wizard: Map Data Fields” on page 401.
7. Use the following techniques for mapping data from the source file to the
database:
• Map field names to destination names by dragging fields from the 'Source
Field Names' window and dropping them on an item appearing in the
'Destination Field Names' window. Lines appear linking a source name to a
destination name.
• To undo a map link, select to highlight a source or destination field then press
the Delete key.
• To remove all current links and start over again, click the Remove All
mappings button.

Velocity Data Import Wizard 397

Velocity Version 3.1 Administrator’s Guide

• To link sources and destinations automatically, click the Auto Map button.
This links only those source and destination names that are identical. This
process should be done automatically by the import engine. However, if you
have removed all mappings and need to reimpose the mappings that existed
before, use this button.
• At the 'Select a credential template', choose a credential template you want
the import engine to use in formatting credential information. All credentials
will be imported using the template specified here.
 The import engine assumes that each row imported represents a
different person regardless of their names. So if multiple rows with the
same name appear in the source file, each row will be imported as a
unique person and one credential will be created for each person.
8. Click Next.
The Completing the Data Import Wizard screen appears as shown in the following
example:

The 'Summary:' window on this screen displays the criteria you have specified for
this file.
9. Click Finish.
The file is imported to the current Velocity database and becomes part of the
available data.
The Data Import Result screen appears. For more on this, refer to “Velocity Data
Import Wizard: Data Import Result” on page 399.
10. Click Done to leave the wizard and return to the main Velocity screen.

398 Velocity Data Import Wizard

 MAN006-0612

Velocity Data Import Wizard: Data Import Result

The Data Import Result screen looks like this example:

This screen includes the following fields and buttons:

Import This read-only field displays a summary of the import results. If the
status: import was successful, this field shows the number of persons
imported to the database.

Result This window displays explanations of errors and successes

window experienced while importing the data. Each error is cataloged by row
number, error number (where it exists), and error description.
Green check marks indicate successful imports. Red circles with Xs
indicate errors.

Save to Click this button to save the information in the Result window to a flat
File file from where it can be reviewed or printed for further investigation.
The Save As dialog box appears. Specify the location and name of
the log file you require for this file.

Done Click this button to quit this screen and return to the main Velocity
screen.

Velocity Data Import Wizard: Data Source

The Data Source dialog box looks like this example:

Velocity Data Import Wizard 399

Velocity Version 3.1 Administrator’s Guide

Use this screen to indicate the type and location of the source file.

Source: Select what type of file the source file is. The only choice is Text File.

File Enter the drive, directory, and name of the source file. If the file name
name: you select does not yet exist, you are prompted to select another one.
If you need to look for the location of the file, click the Browse button,
. The Select a source file screen appears. Locate the folder and
select the file then click Open.

Velocity Data Import Wizard: Select File Format

The Select File Format dialog box looks like this example:

This screen contains the following fields and buttons:

Row From the pull-down pick list, select the type of row delimiter this file
Delimiter: uses. Select from the following options:
• {CR}-{LF} — carriage return and line feed (this is the default).
• {CR} — carriage return only
• {LF} — line feed only

Column From the pull-down pick list, select the type of column delimiter this
Delimiter: file employs. Select from the following options:
• Comma — use a comma to indicate a column
• Semicolon — use a semicolon to indicate a column
• Tab — use a tab to indicate a column

Skip Either enter or use the spin control buttons to specify the number of
Rows: rows the import engine should skip before beginning to read the
import file.
For example, if the first sixteen rows are not relevant to the data
(such as titles, credits, and notes), you would specify 16 in this field.

First row Check this box to indicate that the first row includes the column
has names. This is the default setting.
column
names

Preview of This read-only window displays the flat text of the specified import
file: data file. Use this window to review the file, if needed. This window
can also be useful in discerning how many rows to skip.

400 Velocity Data Import Wizard

 MAN006-0612

Velocity Data Import Wizard: Map Data Fields

The Map Data Fields screen looks like this example:

Notice that the import engine automatically takes the contents of the specified source
file and maps it to the Velocity database.
The following windows, fields, and buttons can be used:

Import Person Check this box to import only the person records with
record only attached credentials.
When this box is unchecked, only those people with
credentials are imported. All other people are deleted from
the record.

Source Field This window displays the current column headers found in
Name: the source file as interpreted by the import engine.

Destination Field This window displays the current column headers found in
Name: the Velocity database.

Use the following Check this box to indicate that you want the import engine
credential to map the data fields using the formatting information
template... contained in a specific credential template. If checked, the
combo box below is activated.
From the combo box option list, choose a credential
template you want the import engine to use in formatting
credential information. All credentials will be imported
using the template specified here.
Note: If the TemplateDescription field is mapped, this will
override this checkbox and the selected template. The
TemplateDescription field is included when the file used
was generated from Velocity.

Remove All Click this button to remove all current mapping between
Mappings the Source Field and the Destination Field. The lines
disappear.

Auto Map Click this button to impose automatic mapping between

the Source Field and the Destination Field. Since this is a
function performed automatically by the import engine,
you should only have to use this button if you have
removed all mappings and need to reimpose mapping.

Velocity Data Import Wizard 401

Velocity Version 3.1 Administrator’s Guide

Manual Mapping
You can also perform manual mapping by dragging fields from the 'Source Field
Names' window and dropping them on an item appearing in the 'Destination Field
Names' window. Lines appear linking a source name to a destination name as shown
in the following example:

If the source file provides column names in the first row (and you have specified that
fact by checking the 'First row has column names' box), these names appear in the
'Source Field Names' window as shown above.
If the source file doesn’t include column names as the first row (or you haven't
checked the 'First row has column names' box), then it uses the default names, such
as Col001, to populate the 'Source Field Names' list as shown below:

402 Velocity Data Import Wizard

 MAN006-0612

SNIB2 Import Wizard

Use this utility to import the latest version of the SNIB2 firmware and prepare it for
update.
To import and prepare the latest SNIB2 firmware:
Make sure the firmware file is located on the server's hard disk. For best results, copy
the file to the \Velocity folder on your server's hard drive.
1. From the Velocity menu tool bar, select File > Import/Export > SNIB 2 (Import
Only).
The SNIB2 Import Wizard Welcome screen appears.

Click this button

to bring up the
SNIB2 Revisions
dialog box

2. If required, delete previously-installed versions of the firmware, click the SNIB2

Revisions button to display the SNIB2 Revisions dialog box. The window lists all
versions of the SNIB2 firmware Velocity currently detects.

a. Click to check any old versions of the firmware displayed in the window you
want to delete. The Delete button is activated.
b. Click the Delete button. Each checked firmware revision is erased from the
window. Be careful not to delete the firmware version you just downloaded.
c. Click Close. You are returned to the first SNIB2 Import Wizard.
If you don't need to delete older versions of the firmware, go to the next step.
3. Click Next.
The SNIB2 File Selection window appears.

SNIB2 Import Wizard 403

Velocity Version 3.1 Administrator’s Guide

4. Select the SNIB2 file you want to import from the pull-down option or click the
button to open the Open dialog box and browse your hard drive for the file
you need.
The file you want should be stored in the directory you copied it to during the
download process.
5. Click Next.
The Proceed to Import dialog box appears.

6. Click Next.
The utility imports the selected file and formats it so that Velocity can download it.
If the SNIB2 already exists in the database, a message appears indicating this.
Indicate either Yes to replace the existing SNIB2 code or No to cancel this
operation.
The Finish dialog box appears.
7. Click Finish to complete the import process.
Now it's time to update the firmware you've just imported. For more on this, refer to
“SNIB2 Firmware Update Wizard,” starting on page 715.

404 SNIB2 Import Wizard

 MAN006-0612

Add-Ins
The Add-Ins menu on the Velocity menu bar provides these tools:
 Add-In Manager
 Feature Activation
 Server Extensions
This feature enables the operator to augment Velocity's feature set with new functions
and features as they become available without waiting for upgrades or patches.
Velocity add-ins are published to the Hirsch website as they become available. They are
also available on DVD upon request.

405
Velocity Version 3.1 Administrator’s Guide

Add-In Manager
This feature enables a qualified operator to augment Velocity's feature set with new
Velocity functions without waiting for upgrades or patches. These Velocity Add-Ins are
periodically created by Hirsch programming and are published to the Hirsch website as
they become available. They are also available on DVD upon request.
To add a new module to Velocity:
1. Copy the Velocity Add-In from the DVD or the Hirsch website to the Program
Files\Hirsch Electronics\Velocity\Add-Ins directory on the Velocity server.
2. From the Velocity menu bar, select Add-Ins > Add-In Manager...
The Velocity Add-In Manager screen appears like the following example:

3. Click the Add button.

The Open dialog box with the file type specified as an Add-in file (.inf) appears like
this example:

4. Locate the Velocity add-in inf file you want to include and click to highlight it.
By default, the subdirectory where inf files are located is: Program Files\Hirsch
Electronics\Velocity\Add-Ins. Many Add-In programs are installed in this directory
when you install Velocity.
5. Click Open.

406 Add-In Manager

 MAN006-0612

The new add-in appears in the Velocity Add-In Manager window like the following
example:

6. To activate a displayed Add-In, check the appropriate box in the 'Load On Startup'
column.
This Add-In will now load automatically whenever you start Velocity.
7. Click OK to exit this feature and return to the main menu.
The new add-in appears as an option on the Add-Ins option list in the Velocity menu
tool bar as shown in this example:

The programs shown here are discussed in more detail:

 External Application Launcher (see page 407)
 Remote Desktop (see page 409)
 Tip of the Day (see page 410)
Once you have included the add-in, you only need to select the Add-Ins option to open
it.

Hint It's a good idea not to install and load any more Add-Ins than you are actually
going to need. Each add-in that is loaded is more overhead for the processor to
handle.

External Application Launcher

Many administrators choose to start Velocity at computer startup and do not allow
operators to open or access other programs outside of Velocity.
This add-in enables the qualified operator to open and use applications outside of
Velocity from within the Velocity shell.
To add programs to External Application Launcher:
1. From the main Velocity menu tool bar, select Add-In > External Application
Launcher.

Add-In Manager 407

Velocity Version 3.1 Administrator’s Guide

The External Application Launcher shell appears like this:

The External Application Launcher possesses these buttons:

Add a new application to the External Application Launcher

shell.

Delete a selected application from the External Application

Launcher shell.

Click this icon to show all applications in External Application

Launcher as icons.

Click this icon to list all applications in External Application

Launcher.

Launcher The window in which the added applications appear either as

window individual icons or as a list of programs.

Close Close the External Application Launcher shell.

2. From the icon tool bar, click the Open program icon, .
The Select an EXE program dialog box appears.
3. Navigate to the directory where the program you want resides.
Use the 'Look in:' pick list as well as the icons to its right to help you in finding the
correct directory. If needed, you can filter possible executables using the 'File
name:' combo box along with wild card asterisks.
4. In the main window, click to highlight the executable that will start the program you
want.
5. Click Open.
The program icon appears in the External Application Launcher window.
 To display the program as a list, click the button.
 To display the program as an icon, click the button.
To launch programs from External Application Launcher:
 In the External Application Launcher window, double click the program you want to
open.
The program opens in a separate window. When you close this program, you are
returned to External Application Launcher.

408 Add-In Manager

 MAN006-0612

To delete an existing program from the External Application Launcher:

1. Click the program in the External Application Launcher window you want to delete.
2. Click the button.
You are prompted to confirm the deletion.
3. Click Yes.
The program disappears from the External Application Launcher window.

Remote Desktop
Remote Desktop is a Velocity add-in that enables a qualified operator to access and
use Velocity from a remote computer. This can be particularly helpful to operators who
use wireless tablets or terminals to monitor the system while moving from one location
to another.
For example, a security chief in Boston can use Velocity Remote Desktop to monitor
the security of a warehouse in Des Moines.
Before you can use remote desktop, you must:
 Install Velocity as either a client or standalone on the remote desktop.
 Install Remote Desktop using the Add-In Manager. Find the AI-Remote Desktop in
the \Add-Ins subdirectory.
 Possess a Velocity operator account.
 Make sure both the remote desktop and the destination Velocity machine are
running Velocity.
To run Remote Desktop:
1. From the Velocity menu tool bar on the remote desktop, select Add-Ins >
Remote Desktop.
The Velocity Remote Desktop screen appears.
2. In the 'Select the screen resolution...' pick list, select the resolution at which you
want this remote session to run.
The default resolution is 800 x 600.
3. Click Add.
The Add Remote Security Domain dialog box appears.
4. In the text box, enter either the name or IP address of the Velocity computer to
which you want to connect then click OK.
The computer now appears in the security domain pick list. Consult your
administrator for the name or IP address of the computer.
5. In the 'Select the remote Security Domain...' pick list, select the computer to which
the remote machine wants to connect.
This is often the Velocity server. Only those computers you have already added to
the pick list using Steps 3-4 appear in the list.
If you add a computer name in error, simply click Delete with the domain
selected. A message appears asking you to confirm your deletion. Click Yes. The
security domain is deleted from the pick list.
6. Click Connect...
Velocity connects to the Velocity machine. A log on prompt appears.
7. Enter a valid operator name and password then click OK.

Add-In Manager 409

Velocity Version 3.1 Administrator’s Guide

The main Velocity screen appears.

8. Perform whatever tasks on this machine that you require.
Only those tasks for which the remote operator is qualified can be done on the
destination machine.
9. When you're finished, go back to the Velocity Remote Desktop screen and click
Close.
The session is completed.

Tip of the Day

Select this option to enable the Tip of the Day feature. When enabled, a tip of the day
dialog box appears on Velocity start up like this example:

At this window, you can do these things:

 Click the Close button to close this window and go to Velocity.
 Click Next Tip to go to the next tip.
 Click the ‘Click here for additional information’ link to view additional information on
the displayed tip.
To disable this feature, simply select the Tip of the Day feature again.

410 Add-In Manager

 MAN006-0612

Feature Activation
Hirsch plans to update and add onto Velocity well beyond the launch of any version.
New components and modules will be deployed to enable some new device or
feature. These modules will be made available via download from the Hirsch website
or DVD distribution.
At the current time, the following modules require feature activation:
 Central Station Receiver
 Message Queue Writer
 XML Writer
Once a Velocity add-on component is installed, Velocity detects its presence and will
query you with a Feature Activation screen like this example:

To register an add-on feature:

1. Do one of these:
• Write the Feature Identity number down.
• From this screen, click Copy.
2. Do one of these:
• Call the toll-free number of the Feature Activation screen and repeat the
Feature Identity number to the designated Hirsch Sales executive.
• Create an E-mail, paste the Feature Identity number you just copied into the
body, and send it to the e-mail address on the Feature Activation screen.
The Hirsch account executive will reply with a unique five-part Feature Key.
3. Enter the Feature Key in the 'Feature Key' field.
4. Click the Register button.
A message appears indicating that you have successfully completed registration:

5. Click OK.
The feature you registered now appears on the screen. The Feature Activation screen
does not appear again.

Feature Activation 411

Velocity Version 3.1 Administrator’s Guide

Server Extensions
Server extensions enable the operator to add features to Velocity servers at specific
security installations. Several built-in extensions are either added to the server or
standalone workstation upon installation or are available through Server Extensions:
 Central Stations Alarm Receiver
 E-mail Writer (E-mail Writer)
 Serial Port Writer
 Message Queue Writer
 Scheduling Agent
 American Dynamics Server Extension (DVR Traffic Manager)
Most of these features are automatically installed with Velocity 3.0 and later; however, if
you need to reinstall an extension for any reason or install a new extension, refer to the
directions below.
 If you are upgrading from an earlier version of Velocity where one or
more of these extensions are already installed, the installer
automatically detects the presence of the extension(s) and supplies
them. In such cases, you don't have to install the server extension again.
The extension service is automatically added to your Velocity server or standalone
workstation; however, the extension service is not automatically installed when you
configure your computer as a Velocity client.
More extensions will be available to Velocity customers as need arises. Still other
extensions are developed by Hirsch Engineering for specific clients. These proprietary
extensions are only available through prior arrangement with Hirsch Electronics. For
information on this, refer to “Installing Extension Service on a Client” on page 414.

Installing Server Extensions

Before a server extension can be used within Velocity, it must first be installed.
To install additional server extensions:
1. From the Velocity menu bar, select Add-Ins > Server Extensions...
The Server Extensions dialog box appears like the following example:

412 Server Extensions

 MAN006-0612

This screen includes these elements:

Server This window includes all of the extensions Velocity currently

Extension detects on this system. Three columns are displayed:
window • Enabled – Indicates whether the extension is installed and
enabled. If the box is checked and the word 'True' appears,
this indicates the extension is installed and enabled. If the
box is not checked and the word 'False' appears, it indicates
that the service is installed on the system but that it has not
yet been enabled. If the extension you are seeking is not
displayed in this window, it indicates that it is not yet
installed. See Server Extensions for more on extension
installation.
Note: You cannot open or use any of the extension programs
displayed here, like Velocity Scheduling Agent, until it is
properly installed and enabled.
• Server Extension – The name of the server extension. Each
extension is a module supported by Velocity. For example,
XML Writer is a module found in the Interfaces folder;
however, this module will not appear and cannot be
opened until it has been installed through the Server
Extension Manager.
• Location – Indicates the place on the system where this
extension resides. This can be the Velocity server or one of
the recognized Velocity clients.

Install Click this button to start the extension installation process.

Uninstall Click this button to uninstall a selected extension.

2. Click Install.
The Find Server Extensions dialog box appears like this example:

3. From the 'Look in:' field, locate the Hirsch Electronics\Velocity root directory.
Several HEX files are located here, including:
• EmailWriter.HEX
• HirschSensormaticExt.HEX
• MSMQWriter.HEX
• RS232Writer.HEX
• SchedulingExtension.HEX.
• XMLWriter.HEX

Server Extensions 413

Velocity Version 3.1 Administrator’s Guide

Additional extensions will be added to this group as required.

4. Select the extension you want to install and click Open.
The newly installed extension appears in the Server Extension list in the Velocity
Server Extensions Manager. By default, the extension is enabled (checked) and the
word 'True' appears in the first column.
5. Repeat Steps 2 - 4 to install more extensions.
6. When you're finished, click OK.
A message appears prompting you to restart the Extension Service before the
extension takes effect.
7. Click OK.
8. Right click on the SCM in the Windows tray and do this:
a. Stop the Extension Service.
b. Start the Extension Service.
Before a service extension can take effect, you must stop and restart the SCM.
Once installed and restarted, extension services, such as E-mail Writer and Serial Port
Writer, are displayed in the Interfaces Configuration folder.
Because Velocity clients sometimes need the extension service to perform such tasks
as local report printing or direct access to a local device, Hirsch includes the capability
for installing and configuring the Velocity Extension Service on a client. To add the
Velocity Extension Service to your client, refer to “Installing Extension Service on a
Client” on page 414.

Server Extensions: Uninstalling

There are circumstances, such as restoring a Velocity database to a new computer, that
require you to uninstall existing server extensions. Also, there are times when you will
want to remove an existing server extension from your server or workstation because it
is not being used and is taking up valuable processing time. For either of these reasons,
follow the procedure below.
To uninstall a server extension:
1. From the Velocity menu bar, select Add-Ins > Server Extensions.
The Velocity Server Extensions Manager appears.
2. Click to highlight an existing service extension.
The Uninstall button is activated.
3. Click Uninstall.
The selected extension service is removed from this computer.

Installing Extension Service on a Client

Because Velocity clients sometimes need the extension service to perform such tasks
as local report printing or direct access to a local device, Hirsch includes the capability
for installing and configuring the Velocity Extension Service on a client.
To install Velocity Extension Service on a client:
1. At the Velocity server, open Velocity, and create a new Operator named Velocity
Services.
2. Set the password and options to 'Never Expires'.
Write the password down: you'll need it later on.

414 Server Extensions

 MAN006-0612

3. Go to the Velocity client, open Velocity, and select Add-Ins > Server Extensions
from the menu tool bar.
The Server Extensions Properties dialog box appears.
4. Click Install.
The Find Server Extension dialog box appears with a list of service extensions as
.hex files. If no .hex files appear in this list, or if the service extension you are
looking for isn't displayed here, navigate to the Velocity server and look under
\Velocity subdirectory.
5. Select the service extension(s) you need from the available .hex file options.
6. Click Open.
The server extension(s) appear in the Server Extensions window.
7. From the client machine, open Control Panel.
Switch to Classic View if you are currently in Category View.
8. Double click Administrative Tools.
9. Double click Computer Management.
The Computer Management screen appears.
10. Expand the Local Users and Groups item and right click on the Groups folder.
11. Select New Group... from the pop-up list.
The New Group dialog box appears.
12. In the 'Group name' field, enter Velocity Services.
13. Click the Add... button. The Select Users dialog box appears.
14. Click the Locations... button and navigate to your Velocity server.
15. Select the Velocity Services you created in Steps 1-2.
Click OK twice to return to the New Group dialog box. The Velocity Services
operator appears as part of the local Velocity Services group.
This provides a domain account that can be used to log onto local services as well
as a way to set up a profile for printers when the print report service extension is
specified.
16. From the Windows desktop, select Start > Run to open the Run dialog box.
17. Click Browse... and locate the file in the Program Files\Hirsch
Electronics\Velocity directory.
18. Click Open.
The path and name of this executable should appear in the ‘Open:’ text field.
19. At the end of the text box field enter a space followed by -install in this manner:

20. Click OK.

This installs the service on Windows.
21. Using Control Panel, select Administrative Tools > Services.
The Services screen appears.
22. Double click Velocity Extension Service.
The Velocity Extension Service Properties (Local Computer) screen appears.

Server Extensions 415

Velocity Version 3.1 Administrator’s Guide

23. Click the Log On tab.

The Logon page appears.
24. Select the ‘This account’ radio button.
25. Click the Browse button. The Select User dialog box appears.
26. Click Locations... and navigate to the Velocity server.
27. Select Velocity Services.
28. Click OK twice to return to the Velocity Extension Service Properties screen.
29. In the 'Password:' and 'Confirm password' text boxes, enter the password you
specified in Step 2.
30. Click OK.
You can now start/stop the Velocity Extension Service from the Services window as
required.
 You cannot start or stop the Velocity Extension Service from the Velocity
Service Control Manager on the Velocity client. You must use Windows
Services to do this.

416 Server Extensions

 MAN006-0612

Alarm Viewer
Alarm Viewer is the module in Velocity that enables a qualified operator to view alarms
as they occur, react to them as required, and dispose of them as needed.
This section includes the following topics:
 Opening Alarm Viewer (page 418)
 Alarm Viewer Main Screen (page 419)
 Placing Alarm Viewer on the Velocity desktop (page 435)
 How To Use Alarm Viewer (page 424)
 Acknowledging Alarms (page 424)
 Clearing Alarms (page 425)
 Displaying a Credential (page 425)
 Adding Operator Notes (page 426)
 Viewing a map from Alarm Viewer (page 429)
 Modifying Alarm Viewer Properties (page 430)
These and other topics are discussed in the following section.

417
Velocity Version 3.1 Administrator’s Guide

Starting Alarm Viewer

Use the Alarm Viewer to view and respond to all alarms Velocity detects on this security
system.
To open the Alarm Viewer, do one of these:
 From Velocity, press F8.
 From the Velocity desktop, click the Configuration file in the System Tree window
and select Alarm Viewer from the Component window, .
 From the Velocity menu bar, select Console > Alarm Viewer.
 From the Velocity main menu status line, double click on either the 'Active Alarms'
or 'Ack. Alarms' status field. The status line displays the number of alarms Velocity
currently detects in either the acknowledged or unacknowledged states.
The Alarm Viewer appears.

418 Starting Alarm Viewer

 MAN006-0612

Alarm Viewer Main Screen

The Alarm Viewer screen looks like this example:

This screen is divided into these sections:

Icon bar Click one of these icons to perform a variety of tasks.

For more on this, see “Icon Bar” on page 420.

Unacknowledged This pane shows all the alarms Velocity has detected which
Alarms pane have not yet been acknowledged by an operator. The columns
displayed are defined in “Alarm Viewer Columns” on page
420.
Alarms are listed in order of their priority level. Alarms assigned
the highest priority are shown at the top of the list. Initially, all
alarms have the same level 1 priority. You can change alarm
priority levels through the Customization Manager.
To scroll through the available columns, use the scrollbar at the
bottom of the pane. Like most tables in Velocity you can both
sort the alarms on this list and reorder columns in the table
using Column Management.

Acknowledged This pane shows all the alarms Velocity has detected which
Alarms pane have been acknowledged by an operator. The columns
displayed are defined in “Alarm Viewer Columns” on page
420.
To scroll through the available columns, use the scrollbar at the
bottom of the pane. Like most tables in Velocity you can both
sort the alarms on this list and reorder columns in the table
using Column Management.

Comments pane This pane displays either instructions or notes depending on

which tab is selected. The instructions or notes apply to the
currently-selected alarm.

Instructions When the Instructions tab is selected, it displays any

window instructions specified for this alarm.

Notes window When the Notes tab is selected, the operator can type notes
pertaining to a specific alarm.

This screen is either viewable or hidden from view based on the role assigned to a
specific operator.

Alarm Viewer Main Screen 419

Velocity Version 3.1 Administrator’s Guide

Icon Bar
There are a number of options you can perform either by using the menu bar options
or right clicking your mouse.

Icon Click this icon to:

Acknowledge the currently selected alarm.

Clear the currently selected alarm.

Acknowledge all alarms in the unacknowledged alarms pane.

Clear all alarms in the acknowledged or unacknowledged alarms

pane, depending on which pane was selected when the button
was clicked.

Record a note. When you click this icon, the Operator

Comments dialog box appears. Type your note here.

View the current Alarm Viewer properties sheet. Change these

properties if required.

Refresh the Alarm Viewer. This updates the Alarm Viewer

immediately, adding any alarms that have occurred since the
Alarm Viewer was opened.

View on-line help for this topic.

This bar and buttons on it are either enabled or disabled based on the role assigned to
a specific operator.
For more on acknowledging and clearing alarms, see “How To Use Alarm Viewer” on
page 424.

Alarm Viewer Columns

Unacknowledged Alarms Pane
The Unacknowledged Alarms pane contains columns of information pertaining to each
alarm. These columns are:

This column displays the icon appropriate to the current alarm

status. Available alarm status icons are:
—An unacknowledged, unsecured, active alarm.
—An unacknowledged but secure active alarm.
—An RTN (return to normal): the alarm has returned to normal.

If the alarm generated is caused by or associated with a DVR

camera, this icon appears in the alarm's column. You can either
view the current video or replay stored video from the alarmed
camera as required.
For more on this, refer to Play Video and Get Recorded Video.

420 Alarm Viewer Main Screen

 MAN006-0612

Count If you have accepted the default Alarm Stacking enabled in Alarm
Options Preferences, this column displays all occurrences of alarms
for this device that are still unacknowledged. The earliest alarm is
marked as 1 and each subsequent alarm is incremented.

Controller The current time at the controller site when this alarm occurred.
Time This can be different from the host's time if the controller and host
are in different time zones.

Host Time The current time at the Velocity host site when this alarm occurred.
This can be different from the controller's time if the controller and
host are in different time zones.

Description A brief description of the alarm

Address The specific location where this alarm took place using the standard
address format.
For more on interpreting the address format, refer to “Address
Format” on page 422.

Level Level assigned an alarm. Initially, all alarms have the same level 1
priority.
You can change alarm priority levels through the Customization
Manager (see “How To Use Customization Manager” on page 678).
For more on alarm levels, refer to “Alarm Levels” on page 698.

Alarm ID The ID generated by Velocity for this alarm. Each alarm type has a
different alarm ID.

To include or exclude any of these columns from the pane, refer to the Column
Headers section of the “Alarm Viewer General Property Sheet” on page 431.
Acknowledged Alarms Pane
The Acknowledged Alarms pane contains these columns of information pertaining to
each alarm. These columns are:

This column displays the icon appropriate to the current alarm

status. Available alarm status icons are:
—An unacknowledged, unsecured, active alarm.
—An unacknowledged but secure active alarm.
—An RTN (return to normal): the alarm has returned to
normal.

If the alarm generated is caused by or associated with a DVR

camera, this icon appears in the alarm's column. You can either
view the current video or replay stored video from the alarmed
camera as required.
For more on this, refer to Play Video and Get Recorded Video.

Alarm Viewer Main Screen 421

Velocity Version 3.1 Administrator’s Guide

Count If you have accepted the default Alarm Stacking enabled in

Alarm Options Preferences, this column displays all occurrences
of alarms for this device that are still unacknowledged. The
earliest alarm is marked as 1 and each subsequent alarm is
incremented.

Controller The current time at the controller site when this alarm occurred.
Time This can be different from the host's time if the controller and
host are in different time zones.

Host Time The current time at the Velocity host site when this alarm
occurred. This can be different from the controller's time if the
controller and host are in different time zones.

Acknowledge The date and time when this alarm was acknowledged.
Time

Workstation The unique ID generated by Velocity for the Velocity workstation

acknowledging this alarm.

Description A brief description of the alarm.

Address The specific location where this alarm took place using the
standard address format.
For more on interpreting the address format, refer to “Address
Format” on page 422.

Acknowledged The operator acknowledging the alarm.

By

Level Level assigned an alarm. Initially, all alarms have the same level
1 priority.
You can change alarm priority levels through the Customization
Manager (see “How To Use Customization Manager” on page
678). For more on alarm levels, refer to “Alarm Levels” on page
698.

Alarm ID The ID generated by Velocity for this alarm. Each alarm type has
a different alarm ID.

To include or exclude any of these columns from the pane, refer to the Column
headers section of the “Alarm Viewer General Property Sheet” on page 431.
To sort and manage columns on either pane, refer to “Column Management” on page
31.

Address Format
Throughout Velocity, you will see a standard format for specifying an address. This
address can tell an operator exactly where a system component is located just by
reading it.
The format is:
\\<device class>.<device address>
where:

422 Alarm Viewer Main Screen

 MAN006-0612

<device class> is a string representation of a category of device.

<device address> is a dot-delimited address specific to the type of device
These values are explained below:

Device Address

XNET Format: \\XNET.AAA.BBBB.CCC.DD.EEFF

(XBox/SNIB2) AAA - Security Domain
BBBB - Port
CCC - XBox/SNIB2
DD - Controller
EE - Type Code (BR, BI, XI, XR, DR, SM, RD)
FF - Door
Example: \\XNET.001.0002.003.04.DR05

SNET Format: \\SNET.AAA.BBBB.CC.DDEE

(Hardware/ AAA - Security Domain
Dialup) BBBB - Port
CC - controller
DD - Type Code (BR, BI, XI, XR, DR, SM, RD)
EE - Door
Example: \\SNET.001.0002.03.DR04

DVR Format: \\DVR.AAA.BBB.CCC

AAA - Security Domain
BBB - DVR
CCC - Camera
Example: \\DVR.001.002.003

CCTV Format: \\CCTV.AAA.BBBB.C.DDD

AAA - Security Domain
BBBB - Port
C - Switcher (always address 1)
DDD - Camera
Example: \\CCTV.001.0002.1.004

ALARMPANEL Format: \\ALARMPANEL.AAA.BBBB.C.DDDD.EE.FFFF

AAA - Security Domain
BBBB - Port
C - Receiver (always address 1)
DDDD - Panel
EE - Area/Zone
FFFF - Point
Example: \\ALARMPANEL.001.0002.3.0004.05.0006

Alarm Viewer Main Screen 423

Velocity Version 3.1 Administrator’s Guide

How To Use Alarm Viewer

While you're in Alarm Viewer, you can perform the following tasks:
 Acknowledge an alarm
 Acknowledge all alarms
 Clear an alarm
 Clear all alarms
 Add a note to an alarm
 View instructions for an alarm
 View credential
 Replay sound file
 Copy to clipboard
 Go to the map to see an alarm
 Refresh alarms list
 Play DVR Video
 Replay recorded DVR video
Most of these tasks can be accomplished in one of several ways. For specific
instructions, see the following procedures.

Acknowledging an Alarm
To acknowledge an alarm, do one of these:
 In the Unacknowledged Alarms pane, click to highlight the alarm you want to
acknowledge. Click the Acknowledge icon from the menu bar, .
 In the Unacknowledged Alarms pane, click to highlight the alarm you want to
acknowledge. Right click on the highlighted alarm and select Acknowledge from the
pop-up option list.
The alarm is moved to the Acknowledged Alarms window and the alarm tone for that
alarm is halted.

Acknowledging All Alarms

Use this function to move all alarms currently Unacknowledged to the Acknowledged
Alarms pane.
 Don't use this function unless you have inspected each alarm and are
satisfied that none of them requires comment or special response.
To acknowledge all alarms, do one of these:
 Click the Acknowledge All icon from the menu bar, .
 In the Unacknowledged Alarms pane, right click on one of the alarms you want to
acknowledge and select Acknowledge All from the pop-up option list.
All alarms in the Unacknowledged Alarms pane are moved to the Acknowledged
Alarms pane and the alarm tone for all alarms is halted.
 You can acknowledge any number of alarms up to the maximum
specified in the 'Maximum Alarms to Display on Refresh' setting (see
page 431). If you are trying to acknowledge more than this number of
alarms, you must do it in sections.

424 How To Use Alarm Viewer

 MAN006-0612

Clearing an Alarm
Clearing an alarm removes the alarm from the Acknowledged Alarms pane.
 Before you clear an alarm, you must first acknowledge it. You cannot
clear an alarm from the Unacknowledged Alarms pane unless you have
previously unchecked the ‘Require Acknowledge before Clearing’ box on
the Preferences Alarm Options page (see page 48).
To clear an alarm, do one of these:
 From the Acknowledged Alarms pane, click to highlight the alarm you want to clear.
Click the Clear icon, , from the menu bar.
 From the Acknowledged Alarms pane, click to highlight the alarm you want to clear.
Right click on the highlighted alarm and select Clear from the pop-up option list.
The alarm is erased. A record of it still appears in the Event Viewer.
 Don't use this function unless you have inspected each alarm and are
satisfied that none of them requires comment or special response.

Clearing All Alarms

Clearing all alarms removes all alarms from the Acknowledged Alarms pane.
 Before you clear all alarms, you must first acknowledge all the alarms.
You cannot clear alarms from the Unacknowledged Alarms pane unless
you have previously unchecked the ‘Require Acknowledge before
Clearing’ box on the Preferences Alarm Options page (see page 48).
To clear all alarms in the Acknowledged Alarms pane, do one of these:
 Click the Clear All icon from the menu bar, .
 From the Acknowledged Alarms pane, right click on one of the alarms and select
Clear All from the pop-up option list.
All alarms in the Acknowledged Alarms pane are erased. A record of these alarms are
still kept in the Event Viewer.
 Don't use this function unless you have inspected each alarm and are
satisfied that none of them needs to be retained.

Displaying a Credential
When Alarm Viewer records an alarm involving a credential, such as deny access or
incorrect key entry, a qualifier operator can review the credential from within this
module.
To display a credential:
1. From Alarm Viewer, right click on the alarm in question.
A pop list appears.
2. Select Display Credential from the pop-up list.
The badge template associated with that credential holder appears.
The credential only appears if you have selected a specific badge template under
console preferences. For more on this, refer to “General Page Preferences” on page 45.
Only that information specified by the badge template appears (see page 494).

How To Use Alarm Viewer 425

Velocity Version 3.1 Administrator’s Guide

Copying to Clipboard
Use this feature to paste selected alarm entries from the Alarm Viewer into another
program, such as a text editor or e-mail program.
To copy specified alarms to the clipboard:
1. From either the Unacknowledged or Acknowledged Alarms panes, click to highlight
one or more alarms.
Use Ctrl + click to select a non-contiguous group of entries. Use Shift + click to
select a contiguous range of entries.
2. Right click on the highlighted alarm(s) and select Copy to Clipboard from the
pop-up option list.
3. Open another program that can accept a clipboard entry, such as a text editor,
word processor, or E-mail agent.
4. Paste (Ctrl + V) the alarm text into the program as required.

Operator Notes
When you add a note, it is displayed in the Comments pane on the right side of the
screen. Notes are generally made:
 as a response to a specific deviation from an expected alarm
 as a required response to a particular alarm
 as a description of how a specific alarm was resolved
 To require a note for an alarm on acknowledgement and/or clear, check
the appropriate box on the Preferences Alarm Options page. For more
on this, refer to “Alarm Options Preferences” on page 48.
To add a note to an alarm:
1. From either the Unacknowledged or Acknowledged pane, do one of these:
• Right click on an alarm you want to annotate and select Add Operator Note.
• Click to highlight the alarm you want to note. Click the Add Note icon from the
menu bar, .
The Operator Notes dialog box appears like this example:

 If you have one or more of the appropriate boxes checked on the

Preferences Alarm Options page, the Operator Comments text box
appears automatically when you try to acknowledge and/or clear
alarms.
The Operator Notes dialog box has three windows:
• The top window displays a brief description of the currently selected alarm.
This field is automatically populated by Velocity.

426 How To Use Alarm Viewer

 MAN006-0612

• The 'Select an Alarm Response' combo box provides a list of previously

defined Alarm Responses.
• The bottom window is a text box that provides space for a qualified operator
to enter information about this alarm, when needed.Type the note you need
to make in this text field.
2. If required, click the 'Select an Alarm Response (Optional)...' combo box and select
a previously defined Alarm Response.
This is an optional feature. The text associated with the selected Alarm Response is
attached to the alarm.
3. In the bottom window, enter the text you need to describe this alarm and/or the
nature of its resolution.
4. When you're finished, press Enter or click OK.
Once a note is entered for an alarm, whenever the alarm is selected, the date, time,
operator and note type appear in the upper pane under the Notes tab like the following
example:

No text appears in the lower text box. To view a note you have created for this alarm,
refer to the brief instructions below.
To display the actual note:
1. Click the Notes tab on the Comments pane.
2. Select the alarm with the associated note.
The date, time, and operator appear in the upper window of the pane as shown in
the example above.
3. From the upper window of the Comments pane, click the note you want to display.
The associated note appears in the lower window of the pane like the following
example:

If you have selected an Alarm Response, the text associated with this selection appears
in the lower window.
For more on defining Alarm Responses, refer to “Alarm Responses” on page 337.

How To Use Alarm Viewer 427

Velocity Version 3.1 Administrator’s Guide

Replaying a WAV File

You can replay a WAV (sound) file associated with a particular alarm using the following
option. WAV files are associated with an alarm using the Options column in the
Customization Manager.
To replay a WAV file:
1. In the Unacknowledged Alarms pane, right click the alarm whose sound file you
want to replay.
2. From the pop-up option list, select Replay WAV File.
Through the Alarm Options Preferences property sheet, you can specify that the WAV
associated with a particular alarm is replayed until it is acknowledged. For more on this,
refer to “Alarm Options Preferences” on page 48.

Playing DVR Video

If a video symbol, , appears in the video column for this alarm, you can view video
from the alarmed camera.
To play DVR video:
1. Right click on the selected alarm in either the Acknowledged or Unacknowledged
Alarms panes.
A pop-up list appears.
2. Select DVR Alarm Video > Show Viewer.
The Live Video screen appears showing video from the camera associated with this
alarm for the time specified in the alarm.
Before you can generate an alarm with a point associated with a DVR camera, you
must first define the trigger and action on the Hirsch Trigger Action Manager. For more
on this, refer to “Trigger Action Manager” on page 1187.

Get Recorded Alarm Video

If a video symbol, , appears in the video column for this alarm, you can replay
video stored by the DVR for the alarmed camera. To do this:
1. Right click on the selected alarm in either the Acknowledged or Unacknowledged
Alarms panes.
A pop-up list appears.
2. Select DVR Alarm Video > Get Recorded Alarm Video.
The Recorded Alarm Video screen appears like this example:

All video selections for the time specified in the alarm window appear here.
3. Double click the selection you want.
The selected video plays in the Live Video screen.

428 How To Use Alarm Viewer

 MAN006-0612

Before you can generate an alarm with a point associated with a DVR camera, you
must first define the trigger and action on the Hirsch Trigger Action Manager. For more
on this, refer to “Trigger Action Manager” on page 1187.

Viewing Instructions for an Alarm

Alarms can have instructions associated with them. These instructions tell the operator
how to proceed, what process to use, or who to call for a specific alarm.
Instructions can be associated with specific alarms through the Instructions column on
the Customization Manager. For more on this, refer to “Creating Instructions” on page
698.
To view instructions for an alarm:
1. Click the Instructions tab of the Comments pane.
2. Click on the alarm you want in either the Acknowledged Alarms or
Unacknowledged Alarms panes.
The instructions appear under the Instructions tab on the right side of the screen.

Viewing a Map for an Alarm

Sometimes it's just easier to visualize the location of an alarm if you can see it on a
map. This feature enables the operator to jump from an unacknowledged alarm to an
existing map in order to display the icon representing the currently alarmed
component.
 Before using this feature, you must:
• Create or import a map into the Graphics program
• Link it as required to its submaps
• Populate each map with system icons
To view a map associated with an alarm component:
1. Right click on a selected alarm in the Unacknowledged Alarms panes.
A pop-up option list appears.
2. Select Go to Graphic.
The program jumps to the Graphic module and displays the alarm on the map.
3. Control the alarm with the graphics module using the instructions found in the
Velocity Operator’s Guide under these topics:
• “Controlling Placed Objects,” starting on page 75
• “Access & Control Functions,” starting on page 203
You can have any graphic automatically pop up on alarm by checking the Show
Graphics on Alarm option. For more on this, refer to “Badge & Graphic Designer
Options” on page 601.

Refresh Alarms on the Alarm Viewer

Once the Alarm Viewer appears it only displays the alarms it has trapped up to the time
the Viewer was opened. The Refresh List option clears and repopulates the viewer. The
number of alarms it can grab at one time is specified by the number specified in the
‘Maximum Alarms to Display on Refresh’ field (see page 431).

How To Use Alarm Viewer 429

Velocity Version 3.1 Administrator’s Guide

To add any new alarms that might have occurred while the Alarm Viewer was open,
use this feature.
To refresh the Alarm Viewer:
 Click the Refresh List icon, .
You can also rearrange columns in order to sort information on the page. For more on
this, refer to the “Column Management” on page 34.

Modifying Alarm Viewer Properties

Many of Alarm Viewer's properties can be modified. These include:
 changing the number of alarms that can be displayed at one time
 forcing Alarm Viewer to always use a specific column sorting criteria
 changing the colors Alarm Viewer uses to show various states
 requiring acknowledgement before clearing
 enabling audible alarms
 requiring note entry on acknowledgement
 More Alarm Viewer properties are available under the Alarm Options tab
on the Preferences dialog box.
To view and change Alarm Viewer properties:
1. At the Alarm Viewer menu bar, click the Alarm Viewer Properties icon, .
The Alarm Viewer Properties dialog box appears (see below).
2. Change properties as required.
3. Click OK to confirm your selections and return to the main Alarm Viewer screen.
In addition, use these two procedures to customize Alarm Viewer:
 Customize alarm values displayed here by accessing the Alarms section of the
Customization Manager. For more on this, refer to “Alarms” on page 681.
 Change many Alarm Viewer properties by accessing the Alarm Options tab on the
Preferences dialog box. For more on this, refer to “Alarm Options Preferences” on
page 48.

430 How To Use Alarm Viewer

 MAN006-0612

Alarm Viewer Properties Dialog Box

The Alarm Viewer properties dialog box looks like this example:

The Alarm Viewer Properties dialog box contains to property sheets:

 General (shown above)
 Sorting
Each is discussed here.

Alarm Viewer General Property Sheet

This property sheet contains these values:

Options

Maximum Type in the number of alarms Alarm Viewer you want to display
alarms to in this pane when the Alarm Viewer is first opened. The default
display is 100 alarms. The maximum alarms allowed is 9,999.
(including Enter 0 (zero) to specify display of all alarms. However, if the
both panes): number of alarms goes above the allowed maximum, the oldest
alarms will be hidden. This feature is disabled by alarm stacking
(see page 48).

Hint This setting only applies to the number of alarms displayed

when the viewer is first opened or refreshed. The viewer
will display more than this number as alarms come into the
system. This value is only a starting point. It is provided in
order to accommodate a large influx of alarms if the system
has been idle for a long time and the viewer is then
opened. In such cases, it can take a long time to load all
alarms in the viewer if there are tens of thousands alarms
waiting to be acknowledged; this setting limits the number
grabbed so the qualified operator can deal with them in a
timely fashion. Whether alarms are displayed or not on this
screen, they remain in the alarm stack until they are
acknowledged/cleared.

How To Use Alarm Viewer 431

Velocity Version 3.1 Administrator’s Guide

Restore Alarm Check this box to refresh the Alarm Viewer screen each time a
Viewer on new alarm appears.
New Alarm

Colors

Alarm Viewer This combo box lists all current color settings for the Alarm
Colors Viewer including background color of the panes (BackColor),
font color of the secured and unsecured alarms (Alarm), and
font color of RTNs (Return to Normal).
By default, BackColor is white, Alarm color is red, the Return to
Normal color is green. The icon associated with the text is also
shown in the required color.
To select a new color for one of the attributes:
From the drop-down combo box, select the attribute whose
color you want to change. The current color for that attribute
appears in the color box to the left of the option.
To change this color, click the color box and the color palette
appears.
Click to select one of the available colors on the color palette
and click OK. If you need another color than the select on the
palette, click Define Custom Colors and 'mix' your own color.
The new color is applied to that attribute. Repeat the preceding
procedure for each attribute you want to change.

Column Headers

Pane combo From the combo box's drop-down option list, select the Alarm
box Viewer pane you want to customize. You have the choice of
either the Acknowledged Pane or Unacknowledged Pane.
Once you've selected a pane, the current columns for that pane
are displayed in the Enable Column window below. Next to
each item is a checkbox.

Check an item Check an item to enable that column. Uncheck the item to
to enable the disable the column. When checked, that column appears in the
column designated pane.
For example, if you check Host Time under the
Unacknowledged Pane, the Unacknowledged pane displays a
column showing all current Host Time information for each
alarm appearing in the pane.

Move Up Select a column to move and click this button to move the
column up in the column order. The farther up the list a column
appears the farther left it appears on the designated Alarm
Viewer pane.
For example, if you move the checked item Alarm ID up the
Unacknowledged Pane list until it appears below <Icon>, the
column Alarm ID is displayed in the Unacknowledged pane just
to the right of the alarm icon.
Note: Only checked items appear as columns in the specified pane.

432 How To Use Alarm Viewer

 MAN006-0612

Move Down Select a column to move and click this button to move the
column down in the column order. The farther down the list a
column appears, the farther right it appears on the designated
Alarm Viewer pane.
For example, if you move the checked item Alarm ID down the
Unacknowledged Pane list until it appears last in the list, the
column Alarm ID is displayed to the right of any other checked
items.
Note: Only checked items appear as columns in the specified pane.

 More Alarm Viewer properties are available under the Alarm Options tab
on the Preferences dialog box.

Alarm Viewer Properties Sorting Page

The Alarm Viewer Properties Sorting page looks like this example:

The Sorting properties page includes these fields and buttons:

Force Fixed Check this box to activate the combo boxes below and
Column Sorting enable you to fix the order in which alarms appear in Alarm
Viewer panes.
Ordinarily, sorting order is selectable by clicking on the
required column header. This indicates the primary sorting
column you need.
For more on this refer to “Column Management” on page 34.
Note: This is not to be confused with column ordering, which
determines the order in which columns appear in the panes
and is defined by the Columnheaders section of the General
tab.cell

How To Use Alarm Viewer 433

Velocity Version 3.1 Administrator’s Guide

Unacknowledged Select the order in which alarms are sorted in the

Pane Unacknowledged pane using these options:
Primary Sort Column—from the combo box, select the
column you want to use as the primary sort criteria in the
Unacknowledged pane. Once this is chosen, select either
ASC (ascending) or DESC (descending) as the sorting order
in the next combo box. <None> and ASC are the default
values.
Secondary Sort Column—from the combo box, select the
column you want to use as the secondary sort criteria in the
Unacknowledged pane. Once this is chosen, select either
ASC (ascending) or DESC (descending) as the sorting order
in the next combo box. <None> and ASC are the default
values.

Acknowledged Select the order in which alarms are sorted in the

Pane Acknowledged pane using these options:
Primary Sort Column—from the combo box, select the
column you want to use as the primary sort criteria in the
Acknowledged pane. Once this is chosen, select either ASC
(ascending) or DESC (descending) as the sorting order in
the next combo box. <None> and ASC are the default
values.
Secondary Sort Column—from the combo box, select the
column you want to use as the secondary sort criteria in the
Acknowledged pane. Once this is chosen, select either ASC
(ascending) or DESC (descending) as the sorting order in
the next combo box. <None> and ASC are the default
values.

434 How To Use Alarm Viewer

 MAN006-0612

Placing Alarm Viewer on the Velocity Desktop

If you aren't using a multiple monitor setup for your Velocity workstation, you may have
to arrange Velocity modules so you can see them all on the screen. Velocity enables an
operator to reposition the Alarm Viewer on the Velocity desktop using the docking and
floating features.
To position Alarm Viewer:
1. Resize the Alarm Viewer as you require using the standard window resizing
techniques (such as moving the cursor over the Alarm Viewer corner until the
cursor changes to a two-way arrow then left clicking the mouse key and changing
the window dimensions).
2. Right click anywhere in the Alarm Viewer title bar.
The dock/float options appear.
3. Select the docking or floating attributes you need.
For more on this, refer to “Managing Velocity Windows” on page 33.
This not only resizes the Alarm Viewer screen but imposes the desired limitations of
the screens visibility and movement within the Velocity desktop space.

Placing Alarm Viewer on the Velocity Desktop 435

Velocity Version 3.1 Administrator’s Guide

Closing Alarm Viewer

To close Alarm Viewer, perform one of these actions:
 Click the button in the upper right hand corner of the screen header bar.
 Click the Hirsch symbol in the upper left hand corner of the screen header bar, ,
and select Close from the drop-down list.
 With the Alarm Viewer window selected, press Ctrl + F4.

436 Closing Alarm Viewer

 MAN006-0612

Badge & Graphic Designer

The Badge & Graphic Designer is an easy-to-use design package for creating badges,
floor plans, maps, backdrops, and other graphics you need within the Velocity
environment.
In simplest terms, use Designer to:
 create shapes
 make shapes smart by assigning behavior to them
 drag and drop shapes from the existing shape libraries
 combine those shapes into complex drawings or badges
Use this package to create almost any 2-D design required for your security purpose.
Designer enables you to populate a map or floor plan with icons (smart shapes)
representing specific security devices and monitor those icons for alarm conditions.
Maps and floor plans can either be created with this utility or imported from other files.
Once saved in Designer, components defined for this security system can be dragged
and dropped onto the graphic.
Designer also supports the design and creation of elements, such as logos and designs,
that can be incorporated into badges.
Badge & Graphic Designer is very easy to use, incorporating many standard graphic
design tools, such as drag-and-drop objects, object sizing handles, and right-click
specifications.
Badges created with Designer are designated as Badge Templates and are assigned to
credentials or credential templates which are, in turn, assigned to people in the
Enrollment Manager.
To learn more about Designer, see these topics:

For more on: See:

Opening Badge & Graphic Designer page 438

Setting up a Badge Printer page 439

Fundamentals of Badge and Graphic Designer page 446

Designing a Badge page 494

Designing a Drawing page 497

Designing a Velocity Object page 619

Creating a Drawing page 498

Object Properties page 516

Placing Objects on Drawings page 605

437
Velocity Version 3.1 Administrator’s Guide

Opening Badge & Graphic Designer

There are many methods for opening the Badge & Graphic Designer.
To open Badge & Graphic Designer:
Open Velocity and use one these methods:

Method 1
1. Select the top-level Configuration folder from the Administration window.
The Components window shows the main Velocity programs including Badge &
Graphic Designer.
2. In the Components window, double click:
• the Badge & Graphic Designer icon, , to open Designer in Badge mode
• the Graphics icon, , to open Designer in Graphics mode.

Method 2
 From the Velocity menu bar, select Console > Badge and Graphics Designer.
This open Designer in Badge mode.

Method 3
 From the Velocity icon bar, select the Badge & Graphic Designer icon, . This
opens Designer in Badge mode.
 From the Velocity icon bar, select the Graphics icon, . This opens Designer in
Graphics mode.
The Badge & Graphics screen appears in either Graphics or Badge mode depending on
which icon you selected.

438 Opening Badge & Graphic Designer

 MAN006-0612

Setting Up Badge Printers

Before you can use a badge printer, you must first install it and configure it for Windows
2000 or XP.
 Velocity is designed to work with these badge printers:
• MagiCard© Turbo® badge printer
• MagiCard©Rio® badge printer
• MagiCard© Tango® badge printer
• Eltron badge printers
To set up a badge printer:
1. At the main Windows 2000 desktop, select Start > Settings > Printers.
The Printers dialog box appears.
2. Double click Add Printer, .
The Add Printer Wizard appears.
3. Click Next and follow the instructions to install the new badge printer.
• Make sure you specify whether this printer is connected to this Velocity server
(Local) or is attached to the network at some other point (Network). If the
printer is local and is Plug and Play, the wizard should find it and tell you what
to do. If the printer is networked, you must specify where the printer is
located.
• Insert the Velocity DVD into your DVD drive when the Wizard prompts you
and specify the location of the driver. The driver for the Turbo badge printer is
located in the Velocity\W2K Drivers\MagiCard Turbo subdirectory and is
called W2KTurbo.inf. The driver for the Rio/Tango badge printer is located in
Velocity\W2K Drivers\MagiCard RioTango subdirectory and is called
W2KRio.inf. The driver for the Eltron badge printer is located in Velocity\W2K
Drivers\EltronBadge.info.
Once the printer driver is installed, the Printers dialog box reappears with the
badge printer displayed as a new icon.
Once you have included the printer, you can:
 assign it as the default badge printer by accessing the Printers tab of the
Preferences dialog box and assigning a badge printer as detailed in “Setting Velocity
Preferences,” starting on page 44.
 assign it as the badge printer for a specific badge template by overriding the default
printer as detailed in the following section.

Overriding Default Printers

Before you can use Badge Designer to create badges, you must first configure Badge
Designer to work with the designated badge printer. If this is not done, modules like
Enrollment Manager won't be able to print badges. Also, without knowledge of the
badge sizes supported by a specific printer, Badge Designer pages can't be sized
appropriately to meet those requirements.

Setting Up Badge Printers 439

Velocity Version 3.1 Administrator’s Guide

Ordinarily, this function is performed by accessing the Printers tab of the Preferences
dialog box and assigning the badge printer there as detailed in “Setting Velocity
Preferences,” starting on page 44. However, you can override this default badge printer
and assign a badge printer for the displayed badge template only using the following
procedure.
To override a default printer:
1. Open the Badge & Graphics Designer.
2. At the main Badge Designer screen, select File > Page Setup.
The Page Setup dialog box appears like this example:

3. At the 'Printer:' combo box, select one of the available printers.

Only those printers previously configured for this network appear in the combo list.
4. Assign any other values for this badge printer using this dialog box.
5. When you're finished, click OK.
For a fuller explanation of how to set up and use your badge printer, refer to the
“Installing Printers” section of your Velocity Quick Installation Guide.
 By selecting the badge printer here it replaces the default printer with
the badge printer only for those installations where the Velocity server is
a standalone workstation.
If this Velocity server is networked and/or includes client machines, you must
make the Velocity default printer settings through the Printers tab on the
Preferences dialog box. You can specify a default badge printer on this sheet
as well as a default report printer and alarm/event printer.
For a fuller explanation of how to set up and use your badge printer, refer to the
“Installing Printers” section of your Velocity Quick Installation Guide.

440 Setting Up Badge Printers

 MAN006-0612

Page Setup
Set the attributes for the canvas using the values in the Page Setup option.
 The maximum dimensions allowed for badge drawings are determined
by the type of badge printer used.
To set the page size for drawings and badge templates:
1. Open Designer.
2. From the Badge Designer main screen, select File > Page Setup.
The Page Setup dialog box appears. For more on this, refer to “Page Setup Dialog
Box” on page 441.
3. Fill out the fields as required to specify the print setup for Designer.
4. Click each tab in turn to display the corresponding page and enter the required
information.
5. Click OK. If any values are over the maximum allowed for the printer, an error
message appears.
The canvas area changes to reflect your specifications.
Once you set the drawing using Page Setup, these specifications are used for all future
drawings until you select another page setup. This applies even to drawings created
with a previous page setup. When you open a drawing or badge template designed
with a previous page setup, the current page setup is applied to it.

Page Setup Dialog Box

Four pages are included in the Page Setup dialog box.
 Print Setup
 Page Size
 Drawing Scale
 Page Properties
Each is described below.

Print Setup Page

Page Setup 441

Velocity Version 3.1 Administrator’s Guide

The fields on this page are:

Printer: Use this combo box to select a printer used to print whichever
drawing is currently on the canvas. Click the button to display a
list of printers currently defined for this network and select one.
Normally, Designer uses the printer you specified as the badge
printer on the Printers Preferences page to print all badge
templates; similarly, it uses the printer you specified as the report
printer on the Printers Preferences page to print all drawings and
other graphics. However, if you select another printer here, your
selection overrides the printer selection on the preferences page.
For example, you might want to proof badge templates or drawings
by selecting a color printer here.
Note: Notice that printers are identified with their network and printer
name. This means you can configure a printer connected to
another machine on the network.
For more on this, refer to “Overriding Default Printers,” starting on
page 439.

Paper This indicates the way in which the badge is fed into the badge
Orientation printer. Select either the Portrait or Landscape radio button.
Normally, the badge blank is fed in Landscape.

Page Size Page

The fields on this page are explained below:

Page Size Select only one radio button at a time.

Same as Printer Click this radio button to accept the page size of the paper
Page Size currently loaded into and recognized by the printer you
selected on the Print Setup page.

442 Page Setup

 MAN006-0612

Pre-defined Size Click this radio button to specify the size of the page you
want. The default is Standard Letter (8.5 x 11). To select
another standard size, click the combo boxes under this
radio button and select from the available options. Most
standard page sizes are listed in these pick lists.
This is the default selection.

Custom Size Click this radio button to designate a non-standard size for
this canvas. Once selected, the two text boxes under this
radio button are activated.
Enter the non-standard size you want.
The unit of measurement is determined by the
'Measurement Units' combo box on the Page Properties tab.

Size page for Check this box to indicate that you need Velocity to adjust
Double-sided the page for double-sided (duplex) printing. Before you can
printing specify this, make sure the printer you chose on the Print
Setup page is capable of printing in duplex mode.
For more on this, refer to “Double-Sided Badges” on page
496.

Page Select either Portrait or Landscape as the paper orientation.

Orientation

Drawing Scale Page

This page is used for scaling drawings. Many floor plans and other architectural
drawings are very large and do not fit easily into page formats accepted by standard
printers. Unless you have a large-format printer, capable of printing architectural size
drawings, you might want to use the Scale feature here to shrink the drawing down to
a printable size.
For example, if you are designing or using a floor plan that is 34" x 44", you won't be
able to print the whole drawing out on a standard 8.5 x 11 printer. To accommodate
this drawing onto a single page, you could designate 1/4" = 1".

Page Setup 443

Velocity Version 3.1 Administrator’s Guide

The fields on this page are:

No Scale The default value specifies that the printer is to print the drawing
as created on the canvas, using a straight 1:1 ratio.

Pre-defined Click this radio button to indicate that you need to scale the
Scale drawing. The two combo boxes beneath this radio button are
activated.
In the first combo box, select the type of scaling required. Select
either Architectural or Metric scaling where Architectural is the
default value.
In the second combo box, select the scale factors you require
for the selected type. The scale factors available here depend on
the type of scaling you designated in the previous combo box.

Page Size This read-only field specifies the currently-defined page size as
designated on the Page Size tab in measurement units.
The measurement units are determined by the 'Measurement
Units' combo box on the Page Properties page.

Page Properties

The fields on this page are:

Page Name In this text field, enter the name of the page.

Background Double click this box to bring up the Color dialog box. Indicate
Color the background color you need for this page. Once selected, the
color appears in this box.
Check the ‘Use Backcolor’ box to use whichever color is
specified by the Backcolor property on the property sheet.

444 Page Setup

 MAN006-0612

Measurement From the drop-down option list, select the units used in this
Units dialog box. Currently, you can select either Inches or
Feet/Inches.
For example, if you select a page size of 11 x 8.5 inches on the
Page Size page and feet/inches in this combo box, the page size
is displayed on both the Drawing Scale page and the Page Size
page as .917 ft. x .708 ft.

Grid

Show Grid Check this box to show the grid points in Design Mode when
(Design Mode you toggle Grid on under the View menu option. The grid points
Only) will not show if you toggle Grid off.
Even if this box is not checked, toggling grid on will show the
grid points. The grid points will not show in Live Mode.

Snap to Grid Check this box to enable you to snap objects to the grid as the
(Holding the default. However, if you hold down the Ctrl key while drawing
Ctrl key...) the object, the default settings indicated here is reversed. For
example, if you enable grid snap here, then holding down the
Ctrl key while drawing an object disables grid snap for that
operation only.

Style: Select one of the options from this drop-down list indicating
how the grid points are displayed. Your choices are:
Under Object—the grid is hidden by objects on the canvas.
Above Object—the grid is never hidden by objects on the
canvas.

Spacing: Select one of the options from this drop-down combo box list
indicating how far apart grid points are spaced. The smaller the
fraction, the closer the grid points are. All values are in whatever
units you select in the 'Measurement Units' field above.
The default spacing value is 1/8".

Page Setup 445

Velocity Version 3.1 Administrator’s Guide

Fundamentals
The Badge & Graphic Designer has many aspects and windows.
When you first open Badge Designer, the default badge screen appears like this:

Badge Designer

When you open the Graphics Designer, on the icon tool bar, the default drawing screen
like this appears:

Graphic Designer

This is Live Mode with only some of the panes displayed. The canvas appears initially in
Graphic mode but not in Badge mode. (In order to display the canvas in Badge mode,
you must first import or select an existing badge template from the Directory pane as
shown above.)

446 Fundamentals
 MAN006-0612

If you select all of the pane and windows available in Live Mode, the Badge Designer
screen looks like this example:

Notice that in Live Mode, some of the panes and most of the icons and options are not
active. You must be in Design Mode to use most of the features on this screen. Live
Mode is used almost exclusively for monitoring security devices placed on drawings
such as maps.
When you select Design Mode, the screen changes and more features become active
as shown in the following example:

Fundamentals 447
Velocity Version 3.1 Administrator’s Guide

When all the panes are displayed and active, Graphic Designer can look like this
example:

The Graphic Designer includes these components:

 Canvas
 Icon Tool Bar
 Menu Tool Bar
 Status Line
 Properties pane
 Directory pane
 Alarm Queue pane
 Object Library pane
 Pan and Zoom pane
 Drawing Selection tabs
You can move a pane as required from one location to another by clicking on the title
bar and dragging it to a new location.

Status Line
The status line displays two fields of information like this example:

These two fields are:

 The left most field indicates the current mode Designer is in: LIVE or DESIGN.
 The next field indicates how many alarms are currently active on the map or
backdrop. This field is only applicable in Graphics Mode and Live Mode when alarm
points have been placed on the currently displayed map or backdrop.
If an error occurs during the drawing or formatting process, this line also displays an
error message.

448 Fundamentals
 MAN006-0612

Designer Hot Keys

There are more than twenty hot keys in Badge & Graphic Designer that enable you to
access important features with a single key or key combination.

Functions Hot Keys

File Operations

Save current drawing Ctrl + S

Print current drawing Ctrl + P

Close Badge & Graphic Designer Alt + F4

Modes Operations

Design/Live Mode toggle Ctrl + D

Zoom Operations

Return drawing to original view Ctrl + W

Edit Operations

Undo last modification Ctrl + Z

Redo previous undo Ctrl + Z

Cut selected object(s) Ctrl + X

Copy selected object(s) Ctrl + C

Paste copied object(s) Ctrl + V

Delete selected object(s) Del

Select All objects Ctrl + A

Shape Operations

Bring selected object(s) to front Ctrl + F

Send selected object(s) to back Ctrl + B

Rotate Left Ctrl + L

Rotate Right Ctrl + R

Mirror Vertical Ctrl + J

Mirror Horizontal Ctrl + H

Group Ctrl + G

Ungroup Ctrl + U

Fundamentals 449
Velocity Version 3.1 Administrator’s Guide

Designer Canvas
The canvas is the window in Badge & Graphic Designer where you draw and design the
picture.

It includes several features:

Grid points Display the optional grid points on the canvas and set them to
specific spacing requirements.
For more on this, refer to “Grids” on page 450.

Ruler bars Display this optional feature in order to see the x and y
coordinates (in inches or centimeters) for sizing and positioning
objects.
For more on this, refer to “Ruler Bars” on page 452.

Scrollbars Enable you to view the entire drawing even if the drawing window
is small.

Drawing Display these optional tabs beneath the canvas that enable you to
Selection switch quickly from one drawing to another.
tabs For more on this, refer to “Drawing Selection Tabs” on page 473.

A picture of the canvas in context is shown in Fundamentals.

Grids
A grid provides useful reference points when you are creating drawings which require
accuracy. Use grid points to help orient shapes on the page and, with the help of the
snap-to-grid feature, position and fix shapes on the canvas at precise points.

450 Fundamentals
 MAN006-0612

With the grid off, the screen looks like this example:

With the grid feature on, the screen looks like this example:

 The grid only appears in Design mode. In Live mode, grid points are
hidden.
To show/hide the grid:
1. Select Design mode.
2. Display an existing design or create a new one.
3. From the Designer menu tool bar, select View > Grid, .
If the grid spacing is set too small, you won't be able to see the grid points until you
increase the magnification. To alleviate this, make the setting for grid spacing larger.
The grid can also aid in creating a drawing using the snap-to-grid feature. When
enabled, this feature automatically causes an object proximate to a grid point to stick to
it.
To enable snap-to-grid:
1. From the menu tool bar, select File > Page Setup...
The Page Setup dialog box appears.
2. Click the Page Properties tab.
The Page Properties sheet appears. Refer to “Page Properties” on page 444.
3. Check the 'Snap to Grid' box.
4. Click OK.
It is possible to have grids visible but not snap or have no grids visible but snap in this
way:

Fundamentals 451
Velocity Version 3.1 Administrator’s Guide

 If Snap to Grid is enabled, press the Ctrl key while using the mouse to disable grid
snap for this particular movement. The program ignores the snap-to-grid feature:
the current object can be positioned away from grid points.
 If Snap to Grid is disabled, press the Ctrl key while using the mouse to enable grid
snap for this particular movement. This invokes the snap-to-grid feature for this
drawing operation only. The object snaps to the nearest grid points.

Grid Settings
To change grid settings:
1. From the menu tool bar, select File > Page Setup.
The Page Setup dialog box appears.
2. Click the Page Properties tab.
The Page Properties sheet appears.
3. At the 'Grid' section, check or uncheck the 'Show Grid' box.
This shows/hides the grid points in Design Mode. The default is checked
(enabled).
4. At the 'Snap to Grid' box, check this box to enable you to snap objects to the grid.
Pressing the Ctrl key while drawing, reverses this setting. For example, if you have
enabled grid snap, holding down the Ctrl key while drawing an object disables grid
snap for that operation.
5. At the 'Style:' combo box, select one of the options:
• Under Object—the grid is hidden by objects on the canvas.
• Above Object—the grid is never hidden by objects on the canvas.
6. At the 'Spacing:' combo box, select one of the options.
The smaller the fraction, the closer the grid points are. The default spacing is 1/8".
All values are presented in the units you select in the 'Measurement Units' field
above.
7. Click OK to confirm your settings.

Ruler Bars
Ruler bars are useful in sizing and positioning objects on the canvas.
When displayed, ruler bars appear at the top and left side of the canvas. They can also
be calibrated in either inches or centimeters.

452 Fundamentals
 MAN006-0612

To show/hide ruler bars:

 From the Designer menu tool bar, select View > Rulers, .
To change the ruler background color:
1. From the Designer menu tool bar, select Tools > Options...
The Options dialog box appears. Normally, the ruler bar appears with a yellow
background. For more on this, refer to “Badge & Graphic Designer Options” on
page 601.
2. Click the Defaults tab.
3. Click the Ruler 'BackColor' box.
The Color dialog box appears.
4. Select a color from the available choices.
5. Click OK.
The ruler background color changes.

Menu Tool Bar

The option bar is located just below the title bar at the top of the Designer and contains
a complete list of all actions that can be performed.

To access a menu bar selection:

 Left click the main menu option with the mouse. Select the subtopic you require.
 If three dots follow the subtopic (...), it means a dialog box follows. You must make
additional decisions in order to implement the action.
 If a right arrow appears after a menu item, , a submenu appears. Select from this
additional level before an option is chosen.
 Press the key combination indicated to the right of the option. For example, if you
want to flip a selected object vertically, you can press Ctrl + J.
 While holding down the Alt key, press the underscored letter of the option you
want. For example, if you want to access File, you would press Alt + F.
 If you don't see the underscored letter in any of these options, press the
Alt key and the underscores appear.
To avoid this problem in the future, change that display property on
Windows desktop. To do this:
• At the Windows desktop, right click anywhere on the desktop.
• Select Properties. The display properties dialog box appears.
• Select the Effects tab.
• Uncheck the last box, 'Hide keyboard navigation indicators until I use the
Alt key.'
• Click Apply or OK and the underscores always appear.

Fundamentals 453
Velocity Version 3.1 Administrator’s Guide

The actions are arranged under these listings:

Topics Options Description

File New... Create a new blank canvas on which to draw. Specify

one of the three types of drawings to make.

Drawing - create a graphic, such as a map or floor plan,

that can serve as a background for objects that are
placed on it. This is only active when you select Graphic
Mode.
Badge - create a new badge template that, when
saved, can be used by the Credential or Credential
Template functions as a badge template. This is only
active when you select Badge Mode.
Integrated Object (VIO) - create a Velocity Integrated
Object, such as an icon, that can be placed on a
drawing. This type of object is linked to a device in the
system. Integrated objects can be edited using the
Integration Builder.
Standard Object (VSO) - create a Velocity Standard
Object, such as a custom shape (desk symbol, wall
symbol, etc.), that can be placed on a drawing but is not
linked to a device.

Save Save the current graphic file. You can also use the
standard key combination Ctrl + S. The file is
automatically saved in the native VGF file format.

Import from File... Import a graphic from another file. This enables you to
select a file from another source and add it to the
graphic database.

Export to File... Export the current graphic file to a designated directory

in the prescribed format.

Page Setup... Specify the size and properties of the canvas. The Page
Setup dialog box appears.

Print Preview Shows the print preview window.

Print... Print the current drawing. You can also use the standard
key combination Ctrl + P.

Exit Exit the Designer. You can also use the standard key
combination Alt + F4.

454 Fundamentals
 MAN006-0612

Topics Options Description

Edit Undo Undo the last modification to the drawing. Select this
option repeatedly to undo a series of modifications,
starting with the most recent and working backward. You
can also use the standard key combination Ctrl + Z.

Cut Copies and deletes selected object(s) from its current

location. You can also use the standard key combination
Ctrl + X.

Copy Copies selected object(s). You can also use the

standard key combination Ctrl + C.

Paste Pastes copied or cut object(s) to a new location. You

can also use the standard key combination Ctrl + V.

Delete Deletes selected objects. You can also press the Del
key.

Select All Selects all objects on the canvas. You can also use the
standard key combination Ctrl + A.

View Suspend Alarm Toggles to enable or disable alarm queueing. When

Switching alarm queueing is suspended, Designer does not
automatically jump to the highest priority alarm on the
map. This is also available through the icon on the
icon tool bar.
For more on this, refer to “Suspending Alarm Switching”
on page 79 in the Velocity Operators Guide.

Zoom This submenu appears:

This includes these options:

Last Zoom - Zoom to the previous zoom factor.
Page Width - Zoom the width of the page to the active
window size.
xxx% - Zoom to the percentage listed. 100% is the
actual size of the drawing.

Actual Size Return the drawing back to the original 'unzoomed' size.
Normally, this is 100%.

Whole Page Adjusts the whole drawing to fit in the current viewing
window.

Fundamentals 455
Velocity Version 3.1 Administrator’s Guide

Topics Options Description

View (cont.) Toolbars Display or hide the following icon toolbars:

When displayed, the box is checked. When hidden, the

box is unchecked.

Statusbar Toggles the status line on/off.

Windows Displays/hides the optional windows/panes. This

includes:
Properties - Opens/closes the Properties pane.
Integration Builder - Opens/closes the Integration
Builder. For more on this, refer to “Integration Builder”
on page 623.
Object Library - Opens/closes the Object Library pane.
For more on this, refer to “Object Library” on page 467.
Directory - Opens/closes the Directory pane. For more
on this, refer to “Directory Pane” on page 471.
Pan and Zoom - Opens/closes the Pan and Zoom
pane. For more on this, refer to “ Pan and Zoom Pane”
on page 473.
Alarms - Opens/closes the Alarm Queue pane. For
more on this, refer to “Alarm Queue Pane” on page
465.

Rulers Toggles the Ruler bar on/off.

Grid Toggles the Grid on/off.

Note: If the zoom factor is such that the grid dots are less
than 5 pixels apart, the grid will not show.

Refresh Refreshes the current drawing. Updates the screen and

status of objects placed on displayed maps.

Layer Properties Shows the Layer Properties dialog box. For more on this,
refer to “Layers Properties” on page 654.

Modes Graphic Displays all drawing/map features. The features, files,

and options that only apply to creating badge templates
are hidden.

456 Fundamentals
 MAN006-0612

Topics Options Description

Modes (cont.) Badge Displays all badge template features. The features, files,
and options that only apply to creating graphics are
hidden.

Design Toggles between Design Mode and Live Mode. For

quicker results, press Ctrl + D.

Tools Custom Badge Brings up the Custom Badge Fields dialog box. For more
Fields... on this, refer to “Custom Badge Fields” on page 646.
This option is only active if you are in Badge Mode.

Topology Object Brings up the Topology Object Mapping dialog box. For
Mapping... more on this, refer to “Topology Object Mapping” on
page 647.
This option is only active if you are in Graphics Mode.

UDF Property Brings up the UDF Property Definition dialog box. For
Definitions... more on this, refer to “UDF Property Definitions” on
page 648.
This option is only active in Badge Mode.

Options Brings up the Options dialog box. For more on this, refer
to “Badge & Graphic Designer Options” on page 601.

Action Bring Forward Moves the selected objects forward one position in the
viewing order.

Bring to Front Moves the selected objects to the front. This supersedes
the Bring Forward one option. You can also press the
Ctrl + F key combination.

Send Backward Moves the selected objects one position back in the
viewing order.

Fundamentals 457
Velocity Version 3.1 Administrator’s Guide

Topics Options Description

Send to Back Moves the selected objects to the back of the viewing
order. This supersedes the Send Backward option. You
can also press the Ctrl + B key combination.

Rotate Left Rotates selected objects 90 degrees counterclockwise

based on the objects' center point. You can also press
the Ctrl + L key combination.

Rotate Right Rotates selected objects 90 degrees clockwise based

on the objects' center point. You can also press the Ctrl
+ R key combination.

Mirror Vertical Flips the selected objects on the X axis. You can also
press the Ctrl + J key combination.

Mirror Horizontal Flips the selected objects on the Y axis. You can also
press the Ctrl + H key combination.

Group Group selected objects so they behave as one object.

You can also press the Ctrl + G key combination.

Ungroup Ungroup a selected group so that they revert to

individual objects. You can also press the Ctrl + U key
combination.

Align Align selected objects in one of six orientations. The

following alignment orientations are available.

Help About Badge Display information about this version of Badge

Designer Designer such as version number and release date.

Help with... Bring up online help. You can also press F1.

Designer Icon Tool Bar

The Icon Tool Bar appears below or beside the Menu Tool Bar at the top of Badge
Designer.
In Live Mode, the tool bars looks like this example:

In this mode, most design icons are inactive; only those functions specific to operator
functions, such as monitoring or viewing the page, are active.

458 Fundamentals
 MAN006-0612

In Design Mode, the design icons are active like this example:

As you can see, the icon tool bar actually comprises several rows of tools divided into
groups called toolbars.
Each tool bar can be viewed or hidden using the View > Toolbars menu tool bar
option. The available options are:

The icons associated with each icon group are shown in the following chart. Each
group can also be moved around and repositioned as required.

Standard Toolbar

Create a new drawing. Click the down arrow icon, , to the

right of this icon to select one of the basic formats.

Open a previously-created drawing.

Save the currently-displayed drawing.

Click this icon to import a graphic or drawing into the current

drawing.

Click this icon to export the current drawing or drawing to a

file.

Print the current drawing. Click this button to print the current
drawing to the connected printer.

Displays the Print Preview screen. Click this button to open a

secondary window and view the current drawing as it will
appear when it is printed. You can print the displayed drawing
from this window, if needed.

Cut the currently-selected object(s). See also Cutting an

Object.

Copy the currently-selected object(s). See also Copying a

Shape or Object.

Paste the copied object(s) to the canvas. See also Pasting an

Object.

Fundamentals 459
Velocity Version 3.1 Administrator’s Guide

Draw Toolbar

Click this icon to use the Select and Edit Tool. This default tool
enables you to select one or more objects.

Free Rotation. Click this button to select and rotate an object

using its rotation handles.
For more on this, refer to “Rotating Objects” on page 485.

Click this button to create a line.

For more on this, refer to “Drawing a Line” on page 506.
This icon is one of four line icons you can choose from at this
location. To display and select another line icon, click on the
icon to the right of this icon.

Click this button to create an arc.

For more on this, refer to “Drawing an Arc” on page 503.

Click this button to create a polyline.

For more on this, refer to “Drawing a Polyline” on page 508.

Click this button to create a rectangle. For more on this, refer

to “Drawing a Rectangle” on page 510.
This icon is one of five shape icons you can choose from at
this location. To display and select another shape icon, click
on the icon to the right of this icon.

Click this button to create an ellipse.

For more on this, refer to “Drawing an Ellipse” on page 505.

Click this button to create a sector.

For more on this, refer to “Drawing a Sector” on page 509.

Click this button to create a chord.

For more on this, refer to “Drawing a Chord” on page 504.

Click this button to create a polygon.

For more on this, refer to “Drawing a Polygon” on page 507.

Click this button to enter text on the canvas. A text box

appears. For more on this, refer to “Inserting Text” on page
510.

Click this button to insert an image onto the canvas. This

open a dialog box to select an image from a file then inserts
the image as an object into the top left corner of the canvas.
The user can then move the image to its proper position.
For more on this, refer to “Inserting an Image” on page 511.

Click this button to draw a control zone around a part of the

drawing.
For more this, refer to “Drawing a Control Zone” on page 505.

460 Fundamentals
 MAN006-0612

Zoom Toolbar

Click this icon to increase the size of the object on the canvas
by the amount designated in the percentage combo box.

Click this icon to decrease the size of the object on the canvas
by the amount designated in the percentage combo box.

Click this icon then drag a rectangle on the canvas to specify

the part of the drawing you want to zoom to. Only that area
designated by the rectangle appears in the window.
Another way to do this is using the Pan and Zoom pane.

Select this option box to specify an exact amount you want to

zoom in or out on a drawing. Either select from the
drop-down option list or type in a new percentage value. The
drawing changes perspective. Select more than 100% to
zoom in. Select less than 100% to zoom out.
As you zoom in, the screen shows a smaller and smaller part
of the canvas. To change position within the drawing frame,
use the Pan and Zoom window.

Format Text

Determines what behavior or appearance text objects must

follow. For more on this, refer to “Font Styles” on page 595.

Select a font style from the list of available fonts on your

computer. Click the down arrow to reveal the scrolling list.

Select the font size from the drop-down list or type in a value.
If the value is too small or too large, a message will prompt
you to select another value.

Click this to change the color of the selected text. Click the
button to bring up the color dialog box and assign a new
color. The selected text is filled in this color.

Click the B to bolden the currently selected text.

You can also press Ctrl + B to make the currently-selected text
bold.

Click the I to italicize the selected text.

You can also press Ctrl + I to make the currently-selected text
italic.

Click this icon to underline the currently selected text.

Click this icon to strike through the currently selected text.

Click the icon or select from the option list to justify top,
middle, or bottom the currently selected text.

Click the icon or select from the option list to left justify,
center, or right-justify the currently selected text.

Fundamentals 461
Velocity Version 3.1 Administrator’s Guide

Format Shape

Applies the line width to selected objects when clicked. New

objects will use this setting when added. Size is in specified in
pixels. A size of zero means the line width will always be
drawn 1 pixel wide, no matter what zoom factor is used.

Select the line style option from this combo box indicating the
style of line or boundary you want for the selected object(s).

Select the fill style option from this combo box indicating the
style of fill you want for the selected object(s).

Determines what color of line to draw for new items, or

applies this color to selected items. When you click the
button, the color dialog box appears.
For more on this, refer to “Line Color” on page 586.

Determines the interior color of new items, or applies this fill

color to selected items. This only applies to enclosed objects;
objects like lines cannot be filled. For more on this, refer to
“Fill Color” on page 586.
When you click the button, the color dialog box appears.

Sets the layer that all new objects will be drawn on and
applies this layer to all selected objects when clicked. For
more on this, refer to “ Layers” on page 651.

Opens the layer properties dialogue. You can add, edit, and
delete layers here.

Action

Flips selected objects vertically about their middle.

Flips selected objects horizontally about their centers.

Rotate selected objects 90° clockwise about their centers. For

more on this, refer to “Rotating Objects” on page 485.

Rotate selected objects 90° counterclockwise about their

centers. For more on this, refer to “Rotating Objects” on page
485.

Brings selected objects to the front of the viewing order. For

more on this, refer to “Ordering Objects” on page 486.

Sends selected objects to the back of the viewing order. For

more on this, refer to “Ordering Objects” on page 486.

Groups selected objects. For more on this, refer to “Grouping

Objects” on page 488.

Breaks selected groups into their constituent parts. For more

on this, refer to “Grouping Objects” on page 488.

462 Fundamentals
 MAN006-0612

Determines the alignment of selected objects. Click the icon

to orient selected objects according to the current alignment
selection.
To make another selection, click the button and the
alignment options appear:

Select one of these options and the selected objects are

aligned accordingly.

Windows

(also available through the View > Windows option)

Click this icon to display the Properties pane.

Click this icon to display the Pan and Zoom pane.

Click this icon to display the Directory pane.

Click this icon to display the Object Library pane.

Click this icon to display the Alarm Queue pane.

Click this icon to display the Integration Builder pane.

Navigation

Moves to the FIRST drawing (vgf) file in the drawing list.

Move to the previous drawing in the drawing list.

Select the drawing from the drawing list you want to display
on the canvas. Only those drawings currently in the database
and displayed in the Directory pane appear in this list.

Move to the next drawing in the drawing list.

Move to the last drawing in the drawing list.

Suspend alarm switching.

For more on this, refer to “Suspending Alarm Switching” on
page 79 in the Velocity Operators Guide.

Icon Tool Bar Repositioning

The icon tool bar contains eight icon groups. Each group is initially arranged in a default
order below the menu tool bar. However, each group can be easily repositioned when
required.

Fundamentals 463
Velocity Version 3.1 Administrator’s Guide

To reposition an icon tool group:

1. Click the left mouse key on the parallel lines at the left side of each icon group as
shown below:

2. Drag the bar to a new location. This can be anywhere within the Designer frame.
3. Release the mouse key and the bar stays where it is placed.
Using this procedure, you can move an icon group bar within the icon tool bar or drag
it all the way down to the canvas for easier access.
You can also move the panes as required. Simply click on the title bar of the pane you
want to move and drag it to a new location.

Design/Live Mode
The Designer supports two modes:
 Live mode
 Design mode
Live mode can display drawings and badge templates, but does not allow you to
make changes to drawings. This mode enables qualified operators to:
 move between linked maps
 view points placed on maps
 control points placed on the map
 monitor status of these points through the Alarm Queue
When active, the word LIVE appears in the status window at the bottom left corner.
Design mode enables you to:
 create new drawings
 change existing drawings
 import or export drawings
 place interactive objects on maps
 define the behavior of placed objects
 link maps
in addition to many other activities.
When active, the word DESIGN appears in the status window at the bottom left corner.
To access Live Mode:
 From the keyboard, press Ctrl + D.
 From the menu tool bar, select Modes > Live.
 From the canvas, right click on a specific drawing selection tab and select Live from
the pop-up list.
 From the Directory pane, right click on a specific drawing or object and select Live
from the pop-up list.

464 Fundamentals
 MAN006-0612

To access Design Mode:

 From the keyboard, press Ctrl + D.
 From the menu tool bar, select Modes > Design.
 From the canvas, right click on a specific drawing selection tab and select Design
from the pop-up list.
 From the Directory pane, right click on a specific drawing or object and select
Design from the pop-up list.
If a drawing is on the canvas, toggling the mode applies to that drawing only. If no
drawing appears on the canvas, toggling applies to whichever drawing is selected.
 Only qualified Velocity operators and designers can access Design
Mode. Most operators are restricted to Live Mode. Permissions to access
this mode are awarded by enabling the 'Graphics - Use Design Mode' in
the Role Application Permission definitions (see page 292).

Alarm Queue Pane

Use the Alarm Queue pane to monitor VIOs placed on a drawing. This pane acts similar
to the Alarm Viewer: it indicates alarm types, locations, and addresses.
You can only use the Alarm Queue pane in Live Mode.
To open the Alarm Queue pane:
 At the icon tool bar, click the Alarm Queue icon, .
 From the menu tool bar, select View > Windows > Alarm Queue.
The Alarm Queue pane appears like this example:

This pane consists of two windows:

Device tree This upper window, the device tree window, displays all of the
window currently placed devices on this drawing. Devices are
displayed in a top-down order under the Plotted VOs folder.
Simple expand this folder to see the devices underneath it.

Alarm status This lower window, the alarm status window, displays the
window current alarm status of all placed devices and relevant notes
on alarms. Notes can only be placed here by going into the
Customization Manager and inserting the notes and
instructions you want (see “Creating Instructions” on page
698).

Fundamentals 465
Velocity Version 3.1 Administrator’s Guide

 Notes and instructions are not to be confused with comments which can
be added by right clicking on the alarmed item. For more on this, refer to
“Acknowledging/Clearing Alarms” on page 76 in the Velocity Operator’s
Guide.
This pane also includes an icon tool bar that resembles the one found in the Alarm
Viewer (see “Alarm Viewer,” starting on page 417), including the following icons:

This symbol: Indicates:

Acknowledge the currently selected alarm.

Clear the currently selected alarm.

Acknowledge all alarms in the unacknowledged alarms pane.

Clear all alarms in the acknowledged or unacknowledged alarms

pane, depending on which pane was selected when the button
was clicked.

Record a note. When you click this icon, the Operator Comments
dialog box appears. Type your note here.

When objects on the map experience one of many alarm conditions, the placed object
changes to represent the nature of the alarm and text appears describing the alarm
condition, as shown in the following example:

At the same time, the Alarm Queue pane describes the alarm in more detail, like the
following example:

466 Fundamentals
 MAN006-0612

The font colors and icons all refer to specific states. The symbols that appear before the
explanations are described below:

This symbol: Indicates:

An unacknowledged, unsecured, active alarm.

An unacknowledged but secure active alarm.

An RTN (return to normal): the alarm has returned to normal.

An acknowledged alarm. This symbol next to any other symbol

indicates the alarm has been acknowledged.
For example, a secure alarm that has been acknowledged looks
like this symbol: . An acknowledged RTN looks like this: .

There is a note about this alarm.

For more on creating notes, refer to “Acknowledging/Clearing
Alarms” on page 76 of the Velocity Operator’s Guide.

The text to the right of the symbol elaborates on the exact nature of the alarm. This text
indicates the current state of the device described through varying font colors:

When the text is this color: It indicates:

Red Unacknowledged alarms.

Green Unacknowledged RTNs.

Gray Acknowledged alarms or RTNs.

Acknowledging or clearing alarms that appear in this pane is similar to performing these
tasks in Alarm Viewer. And just as in Alarm Viewer, you can select multiple alarms to
acknowledge or clear in the Alarm Queue pane. For more on this, refer to “How To Use
Alarm Viewer” on page 424.

Object Library
The object library is a pane within Designer that contains drawing shapes on the
canvas.
Initially, the object library is not displayed.
To display the object library pane:
 From the icon tool bar, click the object library button, .
 From the menu tool bar, select View > Windows > Object Library.

Fundamentals 467
Velocity Version 3.1 Administrator’s Guide

The Object Library pane appears like this example:

The Object Library pane contains two windows:

 Object Tree window: The upper window displays a object tree.
 Object Preview window: The lower window remains blank unless you select an
object from either the VIO or VSO folder. When an object is selected, it appears in
this window.
The Object Library pane displays folders selectively, depending on whether you have
selected Badge or Graphic from the Modes option list.
If you select Badge Mode, the Object Library looks like this example:

Notice that only the VDO folder appears in the object tree window since this is the only
object that can be placed on a badge template.

468 Fundamentals
 MAN006-0612

If you select Graphics, the Object Library looks like this example:

Since databound objects are not used in designing graphics such as maps, the VDO
folder is excluded from the object tree window.
The folders that can appear in the Object Tree window are:

VIO (Integrated) Folder

This folder only appears if you select Graphics mode. This folder includes all the basic
icons, such as doors, relays, and inputs that can be placed on a floor plan. These
objects are interactive: that is, they are linked to components monitored by Velocity and
interact with the system.
An example of the expanded folder is shown here:

The VIO folder includes a basic set of component icons that can be used for populating
maps and floor plans. The VIO folder is divided into sub-folders such as Controllers,
Doors, and Inputs that represent all the objects Velocity can recognize.
The top-most folder, the Special folder, contains the Link and Command Set
subfolders as well as the Custom Links subfolder.

For instance, if you place a door on a floor plan, you can associate that object with a
real door connected to a Velocity-controlled controller and can use the object to
monitor the current status of the door as well as perform actions on the door, like
unlock, lock, or mask the alarm for the door.

Fundamentals 469
Velocity Version 3.1 Administrator’s Guide

For more on Links, refer to “Linking Drawings” on page 604. For information on
Command Sets, refer to “Placing Command Sets” on page 612. For more information
on custom links, refer to “Custom Links” on page 613.
 You cannot drag components from this folder to the canvas. In order to
place components on the canvas, drag objects from the Topology folder
to the canvas.

There is one exception to this rule: you can drag objects from the Special
subfolder to the canvas from this folder.
This folder can also include icons you have modified or created. For more on this, refer
to “Designing a Velocity Object” on page 619.

VSO (Standard) Folder

This folder only appears if you select Graphics mode. This folder includes basic shapes
and symbols you use commonly in creating drawings—including desks, walls, and
tables. You can also add basic symbols and shapes to the folder as required.
Unlike the VIO objects, the VSO objects are dumb shapes. They cannot interact with
the system and are only used for graphics.
An example of the expanded folder is shown below:

For more on this, refer to “Designing a Velocity Object” on page 619.

VDO (Databound) Folder

This folder only appears if you select Badge mode. The folder contains all those objects
you can add to a badge template. These objects are linked to fields (such as last name
and first name) frames (such as pictures and signatures) on the Personal Information
form in Enrollment Manager where information about specific people is entered. For
more on variable entry, refer to Inserting Variable Field Names.
For more on variable entry, refer to “Inserting Variable Field Names” on page 582.
When expanded, the folder looks like this:

The objects in this list include:

Text text linked to a database field.

Picture image linked to a database field.

Photo photograph linked to a database field.

470 Fundamentals
 MAN006-0612

Signature signature linked to a database field.

Barcode barcode linked to a database field.

Magstripe magstripe linked to a database field.

 Only use these objects for creating badge templates on the canvas.

Topology Folder
This folder only appears if you select Graphics mode. This folder contains a hierarchical
list of all devices and components currently recognized by the system and is identical
to the information found in the system tree pane as shown in the following example:

Use the information in this folder to place objects on existing floor plans and other
drawings.
While in the Object Library, you can perform these functions:
 create subfolders under the VIO and VSO folders.
 create new VIO and VSO objects.
 import existing objects into the VIO or VSO folders.
 place objects on drawings, such as floor plans and maps, by dragging and dropping
objects from the Topology folder to the canvas.

Directory Pane
The Directory pane is one of the optional windows within the Badge & Graphic
Designer. Depending on which mode you select, the Directory pane either displays a
hierarchical tree of all drawings or badges currently stored in the Velocity database.

Hint Once created or imported by Designer, all graphics and badges are stored in the
Velocity SQL database. Unlike most graphics engines, drawings are not stored as
individual files in one or more directories. This is intentional. Keeping all security
information in a single, encrypted database is both easier to control, it's also
harder for intruders to decrypt.

Initially, the directory pane is not displayed.

To open the directory pane:
 From the menu tool bar, select View > Windows > Directory
 From the icon tool bar, click the Directory button,

Fundamentals 471
Velocity Version 3.1 Administrator’s Guide

Depending on which mode you select (Graphics or Badge), either the Drawings or
Badge Template tree appears like the example below:

Badge Mode Graphics Mode

Notice that the drawing (graphics) version of the pane includes three mode icons at
the top. These icons perform the following tasks:

Icon Mode Description

Canvas Only mode Displays only the currently existing drawings like
this example:

This is the default mode.

Canvas/Plotted Displays the existing drawings with all the points

mode currently placed (plotted) on the canvas listed as
dependencies beneath, like this example:

Plotted/Canvas Displays all points currently placed (plotted) on

mode the available canvases with the drawings on which
they are plotted listed as dependencies beneath,
like this example:

472 Fundamentals
 MAN006-0612

Use the directory pane to open/display any drawings or badges stored in the Velocity
database.
 You can also display drawings by clicking on the respective drawing selection tab.
 The only method for displaying a badge template is through the Directory pane.
 Velocity Objects (including VSOs and VIOs) can only be displayed through the
Object Library pane. For more on this, refer to “Object Library” on page 467.

Drawing Selection Tabs

The drawing selection tabs appear at the bottom of the canvas. The tabs displayed here
change according to the mode selected. For example, if you select Mode > Badge
from the menu tool bar, only those tabs associated with the currently existing badge
templates appear; if you select Mode > Graphic, only those tabs associated with the
current drawings appear.
The drawing selection tabs are selected as default in the Options section. If, for some
reason, you want to disable them, you can do that through this option.
To use the drawing selection tabs, just click on the tab and the associated drawing
appears on the canvas. This is one of the ways of switching between available
drawings.
There are also right click functions available on this tab bar. When you right click on a
tab, a pop-up option list like this appears:

These functions include:

Save Save changes to this badge template or drawing.

Export to Export this drawing or badge template to another place.

File...

Close Close this drawing or badge template.

Delete Delete this drawing or badge template from the database.

Design Toggle between Live and Design Mode.

Pan and Zoom Pane

The pan and zoom pane enables you to move easily from one part of a large drawing
to another while maintaining an overview of the drawing. For example, many floor
plans are too large to fit onto the canvas at a magnification sufficient to see the fine
details. The Pan and Zoom pane provides you with a way of seeing what part of the
larger drawing is currently displayed on the canvas.
To display the Pan and Zoom pane, simply click the pan and zoom icon in the icon tool
bar, .

Fundamentals 473
Velocity Version 3.1 Administrator’s Guide

The pane appears like the following example:

A thumbnail of the entire drawing is displayed with a red frame enclosing that section
of the drawing which is currently displayed on the canvas.
To change the portion of the drawing on the canvas, simply click inside the red cursor
frame and drag the frame to another location. The drawing on the canvas changes as
you drag.

If you increase the magnification of the drawing in the canvas, the size of the red frame
decreases in size, indicating that a smaller portion of the total drawing is currently
displayed. If you decrease the magnification, the red frame increases in size.
You can also redraw the red cursor frame at a particular location on the thumbnail. This
instantly increases or decreases the magnification and location of the canvas image.
To redraw and relocate the cursor frame:
1. On the Pan and Zoom pane, click your mouse at the point on the thumbnail
indicating one corner of the area you want displayed.
2. Drag the mouse to create a rectangle that includes the area of the thumbnail you
want included.
3. Release the mouse button and the new cursor frame appears. The area desired
appears on the canvas.

Properties Pane
The Properties pane displays the properties of the currently selected object on the
canvas. Property sheets appear when you enter Design Mode and specify the
Properties pane. Use property sheets in the Property Sheet pane to fine tune an
object's properties.
Many of the properties appearing on the property sheet can be modified using other
means in Designer; however, the property sheet is the most precise way to change an
object's properties. It is also the only means by which you can assign variables to
certain objects, thereby linking an object to the Velocity database.

474 Fundamentals
 MAN006-0612

 Normally, you'll use Badge Designer bars—such as the menu tool bar,
icon tool bar, and object library bar—to insert objects and modify them.
Once this is done, use property sheets to review all of the current settings
for each object and make fine adjustments where required.
The following objects and their associated properties are defined in Velocity Help:
 Arc properties (page 517)
 Barcode properties (page 520)
 Chord properties (page 527)
 Command Set properties (page 573)
 Control Zone properties (page 529)
 Drawing properties (page 581)
 Ellipse (Circle) properties (page 532)
 Camera properties (page 565)
• Analog Camera properties (page 565)
• Digital Camera properties (page 568)
• CCTV Call Camera to Monitor properties (page 578)
 Group properties (page 535)
 Image properties (page 537)
• Databound Image properties (page 539)
 Layer properties (page 654)
 Line properties (page 542)
 Link properties (page 576)
 Magstripe properties (page 544)
 Polyline properties (page 552)
 Polygon properties (page 550)
 Quick Link Viewer properties (page 570)
 Rectangle properties (page 555)
 Sector properties (page 557)
 Text properties (page 559)
• Databound Text properties (page 562)
In addition, each placed (plotted) object also possesses properties that are displayed in
the Properties pane, including all points placed on the drawing from the Topology
folder (such as ports, controllers, doors, inputs, and CCTV cameras) and 'mouse-click'
objects placed on the drawing from the Special subfolder (such as link objects,
command sets, and custom links).

Fundamentals 475
Velocity Version 3.1 Administrator’s Guide

The properties pane for placed objects different slightly from drawn objects, including
various configuration and link properties like this placed door:

This placed object includes its Object Type and Address property indicating the type of
object it is and where in the system it resides. (The address value always follows the
standard Velocity addressing format.)
Linked objects that are placed on a drawing also include properties that define where
and how the object is linked like this example:

This property pane normally includes a Custom property that when clicked brings up a
dialog box indicating the address or link location for this object.
For more on the property attributes for a specific object, refer to that object's properties
page.

476 Fundamentals
 MAN006-0612

Showing/Hiding the Properties Pane

To show/hide the properties pane:
 At the Icon tool bar, click the properties pane icon, .
 At the Menu tool bar, select View > Properties.
 Press the F4 key.
Each object on the canvas possesses different properties. Whenever you select a
specific object, the property sheet for that object appears in the Property Sheet pane.
As with the System Tree pane, the plus icon, , indicates that the topic possesses a
group of items under it. Click on the plus sign reveal the items (parameters) under the
topic, like the following example:

To hide the items under a group, simply click the icon and the items are hid as
shown in this example:

Fundamentals 477
Velocity Version 3.1 Administrator’s Guide

Some properties possess more parameters and more topics than this, but General,
Appearance, and Position are the minimum topics required to define a specific object.

Editing Properties
Properties are arranged in tables with the property name in the left column and its
current value displayed in the right column. The left column cannot be edited. You can
change values in the right column using one of three methods:
 Text entry: Click in the right column. The cursor appears at the beginning of the
column. Enter a new value for the property. Press Enter or move to another
property line and the object is changed accordingly.
 Dialog box entry: Click in the right column and the icon appears. Click this icon
and a dialog box appears. Make changes to the dialog box as required. Press Enter
or move to another property line and the object is changed accordingly.
 Option selection: Click in the right column and a combo option box appears,
. This indicates that a list of possible options are available. Click the down
arrow, , to the right of the combo box and a drop-down list of options appears.
Select from one of the available options in the drop-down list. Press Enter or move
to another property line and the object is changed accordingly.

Categorizing Properties
You can arrange the properties appearing on a sheet either by categories (the default)
or alphabetically.
To change the order of properties on a sheet:
 Check or uncheck the 'Categorized Properties' box on the Options dialog box.
 Right click on the Properties title bar and check or uncheck the 'Categorized
Properties' option as required.

Closing Badge Designer

To close Badge & Graphic Designer, perform one of these tasks:
 Press Alt + F4
 Click the at the upper right corner of Designer
 From the menu tool bar, select File > Exit

If you haven't already saved the drawing, a prompt appears asking you whether you'd
like to save the current drawing before exiting. Click Yes to save the current drawing or
No to exit without saving changes. You are returned to the main Velocity screen.

478 Fundamentals
 MAN006-0612

Basic Procedures
The following section describes many of the basic procedures you will use to create
badge templates and graphics, using the standard drawing tools.

Selecting an Object
There are basically two methods for selecting an object on the canvas.
To select an object:

Method 1
1. From the icon tool bar, select the Select and Edit tool, .
2. Place the cursor directly over the object you want to select.
3. Click and release the left mouse button.
The object's handles appear.

You can also select an object by dragging the mouse. This is particularly useful
when you need to select two or more objects.

Method 2
1. From the icon tool bar, select the Select and Edit tool, .
2. Position the mouse anywhere outside the object you want to select.
3. Hold down the left mouse button while you drag the cursor across the object.
Notice that a dotted line follows the path of the mouse as you proceed, creating a
dotted box.

4. Completely surround the object with the dotted line box as shown above.

Hint If your mouse goes beyond the current boundaries of the canvas, the drawing
scrolls in the direction of the mouse. In this way you can surround and select
objects even if they are not currently displayed within the drawing frame.

5. Release the left mouse button. The object is selected and the handles are
displayed.
Once selected, you can:

Basic Procedures 479

Velocity Version 3.1 Administrator’s Guide

 Resize or reshape the object (page 483)

 Copy the object (page 481)
 Cut the object (page 482)
 Delete the object (page 482)
 Rotate the object (page 485)
 Move the object (page 488)

Selecting Multiple Objects

There are two methods for selecting multiple objects on a canvas.
To select multiple objects on the canvas:

Method 1
1. From the icon tool bar, select the Select and Edit tool, .
2. Select the first object. The handles on the first object appear.
3. Holding down the Shift key on the keyboard, click on a second object.
The handles change from white to gray.
4. Continue to hold down the Shift key to select more objects. Each additional object
is also highlighted.

Method 2
1. From the icon tool bar, select the Select and Edit tool, .
2. Position the mouse anywhere outside the objects you want to select.
3. Hold down the left mouse button while you drag the cursor across the objects.
Notice that a dotted line follows the path of the mouse as you proceed, creating a
dotted box.
4. Completely surround the objects with the dotted line box.

Hint If your mouse goes beyond the current boundaries of the canvas, the drawing
scrolls in the direction of the mouse. In this way you can surround and select
objects even if they are not currently displayed within the drawing frame.

5. Release the left mouse button. The objects are selected and all relevant handles
are displayed.
 If you drag the mouse outside the current canvas border, the drawing
scrolls to follow the mouse.
To deselect an object, simply click a selected object again. The handles disappear.
When all the objects you require are picked, you can perform a wide range of
operations on them, including:
 Deleting (page 482)
 Grouping (page 488)
 Moving (page 488)
 Copying (page 481)
 Aligning (page 489)
 Change object properties (page 516)
 Coloring (page 586)
 Assigning Layers (page 651)

480 Basic Procedures

 MAN006-0612

Hint If you are copying, deleting, coloring, grouping, or moving objects, it doesn't matter
which one is the primary and which are the secondary; however, if you are aligning
or distributing objects, the primary object serves as the model for all the other
selected objects.

If you want to change the properties of multiple objects, you must select Method 1 for
selection. Method 2 does not display a single property sheet, even for similar objects.

Copying Objects
Once you have placed a shape or object on the canvas, you can reproduce it easily
using one of these methods.
To copy a shape:
1. Select the object you want to copy.
The object's handles are displayed. To select every object on the drawing, press
Ctrl + A.
2. Do one of the following:
• From the menu tool bar, select Edit > Copy.
• From the icon tool bar, click the Copy icon, .
• Press Ctrl + C.
The shape is copied into memory.
3. If you want to copy to another drawing, select the drawing to which you want to
copy these shapes.
4. Do one of the following:
• From the menu tool bar, select Edit > Paste.
• From the icon tool bar, click the Paste icon, .
• Press Ctrl + V.
The copy appears in the upper left corner of the canvas.
5. Move the copy to the position where you want it.
The copy of the shape should move to its new location, leaving the original in its
assigned place.
To copy an entire drawing to a new drawing:
1. Select the drawing you want to copy.
2. Press Ctrl + A. All objects on the drawing are selected.
3. Copy all objects in this way:
• From the menu tool bar, select Edit > Copy.
• From the icon tool bar, click the Copy icon, .
• Press Ctrl + C.
All shapes are copied into memory.
4. Create a new drawing.
A blank canvas appears.
5. Paste the copied objects to the new drawing in this way:
• From the menu tool bar, select Edit > Paste.
• From the icon tool bar, click the Paste icon, .
• Press Ctrl + V.
The copy appears on the new canvas.

Basic Procedures 481

Velocity Version 3.1 Administrator’s Guide

6. Move the copy to the position where you want it.

Cutting Objects
When you cut an object or shape you make a copy of the object then delete it from the
current canvas.
To cut an object:
1. Select the object(s) you want to cut.
The object's handles are displayed.
2. To cut the object, perform one of these tasks:
• Press Ctrl + X.
• From the menu tool bar, select Edit > Cut.
• From the icon tool bar, click the Cut icon, .
The shape is deleted from the current location and copied into memory.
3. To paste the cut object, perform one of these tasks:
• Press Ctrl + V.
• From the menu tool bar, select Edit > Paste.
• From the icon tool bar, click the Paste icon, .
Once cut, you can paste the object to another drawing. You can also hold it in memory
until you need to paste it (as long as you don't store another object in the meantime).

Pasting Objects
To paste one or more objects:
1. Copy or cut the object(s) you need to paste.
2. Select the layer or drawing into which you need to paste the previously-saved
object(s).
3. Perform one of these tasks:
• Press Ctrl + V.
• From the menu tool bar, select Edit > Paste.
• From the icon tool bar, click the Paste icon, .
• Right click the canvas and select Paste from the pop-up option list.
The object appears on the canvas as the selected shape. You can move it as required.

Deleting Objects
To delete objects from the canvas:
1. Select one or more objects you want to delete from the drawing.
2. Perform one of these tasks:
• Press the Delete key on your keyboard.
• From the menu tool bar, select Edit > Delete.
The objects disappear from the drawing. Cutting an object also removes it from the
canvas but reserves the ability to paste it again.
Once deleted, you can always reinstate (undelete) the deleted item using the undo
feature.
To delete an existing Velocity object:
1. Open the Object Library.

482 Basic Procedures

 MAN006-0612

2. Expand the VIO (Integrated) or VSO (Standard) folder to reveal the existing object
you want to delete.
3. Right click on the object.
An option list appears.
4. Select Delete.
A message appears prompting you to confirm your selection.
5. Select Yes.
The object is permanently removed from the database.
To delete an existing Velocity drawing:

Method 1
1. Open the Directory pane.
2. Expand the relevant folder to reveal the existing drawing you want to delete.
3. Right click on the drawing.
An option list appears.
4. Select Delete.
A message appears prompting you to confirm your selection.
5. Select Yes.
The drawing is permanently removed from the database.

Method 2
1. Right click on the drawing selection tab associated with the drawing you want to
delete.
An option list appears.
2. Select Delete.
A message appears prompting you to confirm your selection.
3. Select Yes.
The drawing is permanently removed from the database.

Resizing or Reshaping an Object

Once placed on the canvas, you can change the size or shape of an object by moving
the handles. Handles appear around an object when it is selected.
There are two types of handles on most objects:
 White handles are used to resize an object. This includes re-scaling a shape.
 Yellow handles (also called node points) are used to reshape an object. Only
certain shapes support node points, including arcs, chords, and polylines. Node
points can be added or deleted from objects.

Basic Procedures 483

Velocity Version 3.1 Administrator’s Guide

Here is another example of the node points:

To resize an object:
1. Left click on the object you want to resize.
The object is highlighted and handles appear.
2. Click on a white handle and pull the handle in whichever direction you require.
Notice that the size of the shape increases or decreases as you continue to pull.
The direction of the sizing depends on which of the handles you pull.
• Pull the top or bottom handle to increase or decrease the height of the shape.
The shape is distorted in the direction you pull.
• Pull the right or left handle to increase or decrease the width of the shape.
The shape is distorted in the direction you pull.
• Pull the corner handles to increase or decrease the height and width of the
shape. The shape maintains its scale.
3. Release the handle.
Pulling the top, bottom, right, or left handles will distort the original shape of the object.
For example, to stretch a square transforms it into a rectangle. Stretching a circle
transforms it into an ovoid.
To reshape an object:
1. Double click on the object you want to reshape.
The object is highlighted and yellow handles (node points) appear like this control
zone object:

2. Move the cursor over the node point you want to use.
The cursor changes from an arrow point to crossed arrows.
3. Click on a node point and pull the node in whichever direction you require.

484 Basic Procedures

 MAN006-0612

Notice that the shape of the object changes as you continue to move the node
point.
Node points can only move in certain directions, corresponding to and limited by
the shape of the object.
4. Release the node point. The objects shape is changed.
5. To remove a node point, click on the node and press the Backspace key. The node
point disappears.
This is a good way to remove excess nodes points from an object, reduce the
complexity of a shape, or decrease the number of sides an object possesses.
6. To add a node point, click on the selected line and the cursor changes, click on the
line where you want the new node to go. A new node appears.
The object is reshaped. For example, pulling a shaping handle on an arc can increase or
decrease the degrees of the arc shown from 1º all the way up to a complete circle
(360º).

Rotating Objects
The Designer includes several methods for rotating a selected object. These enable you
to rotate an object around a central point to achieve the placement you require.
Rotation is measured in degrees where 360° is a full rotation in either direction. You
can rotate an object in either a positive (clockwise) direction or a negative
(counterclockwise) direction as shown in the following example:

There are three methods for rotating an object using Designer:

 Use the rotation icon on the icon tool bar—This method enables you to rotate the
object manually.
 Use the rotation options on the menu tool bar—Use this method to rotate the
selected object in increments of 90°.
 Change the 'Rotation' property on the property sheet—Use the third method to fine
tune the rotation.
Each method is described in the following section.

Method 1
1. From the icon tool bar, select the rotation tool, .
2. Click to select the object you want to rotate.

Basic Procedures 485

Velocity Version 3.1 Administrator’s Guide

Notice that the object is now surrounded by several yellow rotation handles like
this example:

A green handle indicates the axis around which the object can rotate.
3. To change the axis, click on the green handle and drag it to a new location. The
object now rotates around that centerpoint.
4. Click on one of the yellow handles and the cursor changes to a rotation icon.
5. Rotate the object as required. Notice that it rotates around the green handle.
6. Release the mouse button and the object appears in its new location.

Method 2
1. With the Select and Edit tool, click to select the object you want to rotate.
2. From the menu tool bar, select one of these:
• To move the selected object 90° to the left, select Action > Rotate Left.
• To move the selected object 90° to the right, select Action > Rotate Left.
Alternatively, use the Ctrl + L key combination to rotate left and Ctrl + R to rotate
right.
3. To move the object more than 90° in either direction, repeat the selection.

Method 3
1. With the Select and Edit tool, click to select the object you want to rotate.
2. If not already displayed, show the Properties pane.
3. Click the 'Rotation' property.
The current value is highlighted.
4. Enter a new value. All numbers are in degrees.
• To rotate counterclockwise, enter a minus quantity. A minus sign is necessary.
• To rotate clockwise, enter a positive quantity. No positive sign is necessary.
5. Press Enter. The selected shape is rotated by the number of degrees entered.

Ordering Objects
When you overlap or stack objects on top of each other, there is usually an order in
which you want them viewed. For example, if you are placing a large square inside a
smaller square, you don't want the larger square to hide the smaller one; you want the
smaller one to be in front of the larger one.

486 Basic Procedures

 MAN006-0612

You can arrange overlapping objects on your canvas so that each object has its own
viewing order in relation to other stacked objects. In this way, a circle, for example,
might conceal a square but is concealed in turn by another square that is one step
forward of it. Or a series of squares might overlap the one just behind it to provide the
effect of paper on a desk.

In order to accomplish ordering, Velocity supports four types of order manipulation:

Bring to Front Move the selected object to the front of the stack. No object can
conceal this object.

Send to Back Move the selected object to the back of the stack. All other
objects in the stack can conceal either part or all of this object.

Bring Move the selected object forward one level. This object cannot
Forward be concealed by an object a level behind (in back of) it, but can
be concealed by objects on levels above (forward of) it.

Send Move the selected object back one level. This object cannot be
Backward concealed by objects a level behind (in back of) it, but can be
concealed by objects on levels above (forward of) it.

To order overlapping objects:

1. Select one or more objects on the canvas.
2. Choose one of these options:
• At the Menu Tool Bar, select Action. Select the appropriate option.
• At the Icon Tool Bar, select the appropriate icon.
• From the keyboard, click the appropriate key combination.
The available options are shown below:

Menu Option Key Combination Icon

Bring to Front Ctrl + F

Send to Back Ctrl + B

Bring Forward — —

Send Backward — —

Basic Procedures 487

Velocity Version 3.1 Administrator’s Guide

Moving Objects
The act of using a mouse or cursor keys to move an object from one place on the
screen to another is often called 'dragging' an object. Both methods are explained here.
To move objects with the mouse:
1. Select one or more object(s) you need to move.
The object handles appear.
2. Position the cursor within the selected area and click the left mouse button.
3. With the left mouse button depressed, drag the object(s) to a new position.

Hint Make sure to click on one of the object's lines. Do not use a handle to move the
object. These change the size and shape of the object.

4. At the new location, release the mouse key and the object is placed.
To move objects with the arrow keys:
1. Select one or more object(s) you need to move. The handles on the object(s)
appear.
2. Press the arrow keys repeatedly in any of the four directions and the selected
objects move.
Certain objects, such as text objects, can actually be moved beyond the set margins.
For more this, refer to “Bleeding Edge Text” on page 596.

Grouping Objects
To group two or more objects on the canvas:
1. Select multiple objects on the canvas.
2. Perform one of these:
• From the menu tool bar, select Action > Group.
• From the icon tool bar, click the group icon, .
• Press Ctrl + G.
The selected objects now appear as a single group entity.
To ungroup objects that are currently grouped:
1. Pick the grouped object.
2. Perform one of these:
• From the menu tool bar, select Action > Ungroup.
• From the icon tool bar, click the ungroup icon, .
• Press Ctrl + U.
The groups objects are broken out of the grouped array and now appear as individual
objects. If a grouped object includes several subgroups, you must ungroup the
subgroups as well in order to get down to individual shapes.
Sometimes it's necessary to ungroup objects to make changes to one or more of the
grouped objects. Once this is done, you can quickly regroup the objects using the
Regroup feature.

488 Basic Procedures

 MAN006-0612

Aligning Objects
Use this function to align two or more selected objects in one of six ways:

The alignment feature is available through the Layout option on the Option Bar or the
Icon Tool Bar.
To align two or more objects:
1. Select two or more objects on the canvas.
2. Do one of these:
• From the Icon Tool Bar, select the down arrow, , to the right of the Align
Edges icon, .
• From the Option Bar, select Action > Align Objects.
3. Select the alignment type you require from the drop-down list.

The previously-selected option is accessed when you click the icon itself.
The objects are aligned in the order specified.

Mirroring Objects
The feature enables you to flip a selected object either vertically or horizontally. In this
way, an object can become its mirror image with either a vertical orientation or a
horizontal orientation as shown in the following examples:

To mirror objects horizontally:

1. Select an object.

Basic Procedures 489

Velocity Version 3.1 Administrator’s Guide

If you want to mirror two or more objects, you must first group the objects then
perform the mirroring.
2. Do one of these:
• From the icon tool bar, click the mirror horizontal icon,
• From the menu tool bar, select Action > Mirror Horizontal
• From the keyboard, press Ctrl + H
The selected object is flipped horizontally.
To mirror objects vertically:
1. Select an object.
If you want to mirror two or more objects, you must first group the objects then
perform the mirroring.
2. Do one of these:
• From the icon tool bar, click the mirror vertical icon,
• From the menu tool bar, select Action > Mirror Vertical
• From the keyboard, press Ctrl + J
The selected object is flipped vertically.

Magnifying the Drawing

It's easy to increase or decrease the magnification of any drawing or badge template on
the canvas.
To increase the magnification of a drawing:
1. Select the drawing you want to magnify.
2. Do one of these:
• From the icon tool bar, click the increase magnification tool, .
• From the icon tool bar, click the magnification combo box, , and
increase the percentage either by entering a new value or selecting a preset
value from the option list.
• From the icon tool bar, click the select magnification tool, , and drag a
window on the canvas you want to see magnified.
• From the menu tool bar, select View > Zoom then the magnification option
you need.
The drawing increases in magnification.
To decrease the magnification of a drawing:
1. Select the drawing you want to magnify.
2. Do one of these:
• From the icon tool bar, click the decrease magnification tool, .
• From the icon tool bar, click the magnification combo box, , and
decrease the percentage either by entering a new value or selecting a preset
value from the option list.
• From the menu tool bar, select View > Zoom then the magnification option
you need.
The drawing decreases in magnification.
To return to the original drawing size (with the entire image shown within the
canvas window):
 Press Ctrl + W.

490 Basic Procedures

 MAN006-0612

 From the menu tool bar, select View > Zoom > 100%.
 From the icon tool bar, click the magnification combo box, , and select
100%.

Panning Drawings
Panning is the act of moving the center of a map or drawing from one spot to another.
Panning is used for maps that are larger than the Graphics window can accommodate.
For example, if the Graphics window is showing the northeast corner of a floor and you
want to see the southeast corner, you can use the Pan function to move the map.
To pan a map:
1. Go to Live Mode.
2. Bring up the drawing you want to pan.
3. Do one of these:
• Right click in the canvas. A hand cursor icon appears. With the right button
pressed, pull the canvas frame in whichever direction you require.
• Open the Pan and Zoom Pane. In the Pan and Zoom pane, use your mouse
to move the drawing around on the canvas.

Switching Between Drawings

Whenever you open Designer you automatically open all drawings. These drawings are
displayed in a stack on the canvas.
 You can tell how many drawings you have by looking either at the
drawing selection tab bar at the bottom of the canvas or in the Directory
pane under the VSO folder.
To switch between drawings:
 At the drawing selection tab, click the tab that corresponds to the drawing you want.
 In the Directory pane, expand the tree until the current drawing appears. Click on
the drawing in the drawing tree.
 On the Navigation Icon Tool Bar, click the button to see the previous drawing in
the drawing list. Click the button to see the next drawing in the drawing list.
The drawing appears in the canvas window.

Undoing an Action
Drawing involves many trials and errors. You may make a change you don't like or
delete an object you decide you need. Designer enables you to do this.

Hint This is one of the most important procedures you can learn.

To undo an action, do one of these:

 Press Ctrl + Z
 From the menu tool bar, select Edit > Undo
Badge & Graphic Designer retains a memory of the last five actions performed. This
means you can undo the last five actions taken on the drawing.

Basic Procedures 491

Velocity Version 3.1 Administrator’s Guide

Saving Drawings
Once you've finished a drawing in Designer, you must save it. What this does is save
the drawing to the Velocity database.

Hint Ideally, you should save the drawing every few minutes. In this way, you don't risk
losing work if something happens.

To save a drawing:
1. Create a drawing as required.
2. When you're finished, do one of the following:
• Press Ctrl + S
• From the Menu Tool Bar, select File > Save
• From the Icon Tool Bar, select the Open icon,
• Close Designer and answer Yes to the Save changes prompt
Once saved, these drawings are stored in the Velocity database. Drawings are not
saved as individual files unless you export them. For more on exporting drawings, refer
to “Exporting Drawings” on page 597.

Renaming Drawings and Objects

To rename drawings and objects in Designer:
1. Open the Directory pane and/or Object Library pane.
2. Do one of these:
• For any drawing or object, in the Directory pane, right click on the drawing or
object you want to rename.
• For objects only (VIOs or VSOs), in the Object Library pane, right click on the
object you want to rename.
A pop-up option list appears.
3. Select Rename from the list.
The current name is selected and a cursor appears at the end of the name.
4. Enter a new name.
5. When you're finished, press Enter or click outside the text box.
The selected drawing or object now has a new name.

Print Preview
You can access the Print Preview screen in several ways:
 From the menu tool bar, select File > Print Preview.
 From the icon tool bar, click the Print Preview icon, .
The Print Preview screen appears like the following example:

492 Basic Procedures

 MAN006-0612

This screen includes a window for displaying the full drawing or badge template as it
will appear to the printer. Velocity communicates with the default printer (or the
currently-designated printer) and displays information about how that printer will
interpret the drawing.
If the drawing in this screen doesn't match the drawing you designed, you should make
appropriate changes.
This screen also includes the following tool bar options:

Move to the FIRST page of the drawing.

Move to the previous page of the drawing.

Read-only field indicates which page is currently displayed.

Move to the next page of the drawing.

Move to the last page of the drawing.

Print the entire drawing immediately.

If this is a drawing, the designated report printer is used.
if this is a badge template, the designated badge printer is used. If you
have specified a different printer in the Print Setup page, that printer is
used.

Show the background.

Printing Badges and Drawings

Before printing a badge or drawing, it's a good idea to preview it to make sure the
printer prints it the way you designed it.
To print the currently displayed drawing, select one of these:
 Press Ctrl + P
 From the Menu Tool Bar, select File > Print...
 From the Icon Tool Bar, click the Print button,
 Select Print Preview and click the Print button,
The drawing or badge is printed to the specified printer. The printer used is determined
by the Printers Preference page: for badge templates, the designated Badge printer is
used; for drawings, the designated Report printer is used. To override these defaults,
refer to the “Setting Up Badge Printers” on page 439.
 Before Badge Designer works properly with the other Velocity
components, such as Enrollment Manager, you must first set up the
badge printer.

Basic Procedures 493

Velocity Version 3.1 Administrator’s Guide

Drawing and Designing

This section provides basic drawing procedures. For more advanced procedures, refer
to “Advanced Procedures,” starting on page 601.

Badge Templates: Creating

Badge templates are the badges you create using Badge Designer. Every badge created
in Designer is detected as a badge template in Enrollment Manager.
To create a badge template:
1. Using Badge Designer, design a badge.
Make sure your badge is the same size as the blank badges you intend to use in
the badge printer.
2. Save the design.
3. Do one of these:
• Add a badge template to a new or existing credential:
a. Open Enrollment Manager.
b. Either create a new credential or modify an existing one.
c. Assign the badge template you created in Badge Designer to the credential
using the General page on the Credential dialog box.
• Assign a badge template to a credential template:
a. Add a new credential template or modify an existing one.
b. Assign the badge template you created in Badge Designer to the credential
template using the General page on the Credential Templates dialog box.
If you need a double-sided badge, design it as such in Designer then assign the
special badge template to the credential you need.

Designing a Basic Badge

These elements are almost always incorporated into a basic badge:
 Place a bitmap for the picture or company logo (see page 512).
 Place a databound photo on the badge (see page 512).
 Place static text on the badge (see page 510).
 Place databound text on the badge (see page 511).
 Specifying a background color for the badge (see page 586).
For a more detailed explanation of how to create a badge template, refer to the next
topic, “Designing a Badge,” starting on page 494.

Designing a Badge
To design a more complex badge with Badge & Graphic Designer:
1. Open Badge & Graphic Designer.
2. From the menu tool bar, select Modes > Badge.
All panes and options relevant to badge template creation appear.
3. Perform one of these:
• From the menu tool bar, select File > New > Badge.
• From the Directory pane, right click the Badge folder and select New from the
pop-up option list.

494 Drawing and Designing

 MAN006-0612

The New Badge Template dialog box appears like this example:

4. Enter a name for this badge template.

5. Click OK.
A new canvas appears for this template. You should be in Design Mode by default.
The word DESIGN appears in the status window. Design Mode must be active
before you can import maps and place components on them.
6. Specify the size of the page you need for this drawing. The canvas changes to
reflect your selection.
For more on this, refer to “Page Setup” on page 441.
7. If this is a double-sided badge template, follow the instructions in “Double-Sided
Badges” on page 496.
8. If needed, show a grid for the canvas. Set grid and guideline values:
• set grid spacing (page 452)
• set and show guidelines (page 443)
• set snap to grid (page 452)
9. Draw any shapes you require on the badge:
• lines (page 506)
• ellipses (page 505)
• rectangles (page 510)
• polylines (page 508)
• polygons (page 507)
• sectors (page 509)
• arcs (page 503)
• chords (page 504)
If you make a mistake, use the undo feature to go back and try over. See “Undoing
an Action” on page 491.
10. Place any standard graphic image on the badge.
These are images that won't change from one badge holder to another. For more
on this, refer to “Inserting a Static Image” on page 512.
11. Place any standard text on the badge.
For more on this, refer to “Inserting Text” on page 510.
12. If required, drag a VDO shape from the Object Library to the canvas.
VDOs are databound objects. These are objects that change from badge holder to
badge holder. They include:
• text (page 511)
• image (page 512)
• magstripes (page 513)
• bar codes (page 514)
13. Select and rearrange drawing objects as required, using these functions:
• move (page 488)
• copy page 481)
• cut (page 482)

Drawing and Designing 495

Velocity Version 3.1 Administrator’s Guide

• paste (page 482)

• delete (page 482)
14. If needed, organize objects using these tools:
• group or ungroup (page 488)
• rotate (page 485)
• align (page 489)
• mirror (page 489)
• resize or reshape (page 483)
• arrange front to back (ordering objects) (page 486)
15. Create color and texture for the objects, if required, with these techniques:
• line coloring (page 586)
• line style (page 591)
• fill coloring (page 586)
• fill style (page 592)
16. To fine-tune position and properties for an object, select the object and use the
corresponding Property Sheet. For more on this, refer to “Object Properties” on
page 516.
Each shape possesses its own distinct property sheet values.
17. If necessary, preview the badge as explained in “Print Preview” on page 492.
18. If necessary, print the badge to see how it looks.
For more on this, refer to “Printing Badges and Drawings” on page 493.
19. If not already done, save the drawing.
For more on this, refer to “Saving Drawings” on page 492.
This makes the drawing available as a badge template for credentials or credential
templates.
20. If necessary, export the file to another format. For more on this, refer to “Exporting
Drawings” on page 597.

Double-Sided Badges
Assuming that your badge printer supports double-sided printing, Velocity makes it easy
to create badge templates for that purpose.
To create a double-sided badge template:
1. Create a new badge.
2. Bring up the Page Setup dialog box.
3. Click the Page Size tab.
The Page Size sheet appears.

496 Drawing and Designing

 MAN006-0612

4. Check the 'Size page for Double-sided printing' box as shown in the example
below:

Check this box

This checkbox is only enabled when the currently displayed canvas is a Badge
mode drawing. A Design mode drawing, VIO, VSO, or other graphic object disables
this box.
5. Click OK.
The width of the canvas is doubled with a dotted line in the middle to divide back
and front.
An example of this canvas is shown below:

6. Design the badge template as required making sure to keep the front badge
design on the left side of the divider and the back badge design on the right side
of the divider.

Designing a Drawing
To design a drawing (including maps and backdrops):
1. From the menu tool bar, select Modes > Graphic.
All panes and options relevant to graphic creation appear.
2. From the icon tool bar, click the Directory button, .
The Directory pane appears.
3. Do one of these:
• Import the required map.
• From the Directory pane, right click the Drawings folder and select New from
the pop-up option list.
• From the menu tool bar, select File > New > Drawing.

Drawing and Designing 497

Velocity Version 3.1 Administrator’s Guide

The canvas displays either the imported graphic (map) or a blank canvas. If a new
graphic is specified, the New Drawing dialog box appears like this example:

4. Enter the name you want for this drawing.

5. Click OK.
A blank canvas appears. The new name appears in the Directory pane under the
Drawing folder.
6. Select Design Mode.
The word DESIGN appears in the status window. Design Mode must be active
before you can import maps and place components on them.
7. Specify the size of the page you need for this drawing. The canvas changes to
reflect your selection.
8. Use the various drawing tools to create or complete the drawing. The tools at your
disposal are:
• Arc
• Chord
• Ellipse
• Line
• Polygon
• Polyline
• Rectangle
• Sector

Hint If you make a mistake, use the Undo feature to go back and try over. For quickest
results, press Ctrl + Z.

9. If needed, use the Control Zone tool to define areas within the drawing where
particular control zones are in effect.
10. Fine tune objects and shapes on the canvas using the Properties pane.
11. From the Object Library, place any standard objects (VSOs) you require onto the
drawing.
12. From the Object Library, place any integrated objects (VIOs) you require onto the
drawing.
13. Group objects into layers as required.
14. Return to Live Mode.
This enables any qualified operators to monitor the system.

Creating a Drawing
Designer can create four types of drawings:
 Badge Templates
 Drawings (including backdrops and floor plans)
 Integrated Objects (VIO)
 Standard Object (VSO)

498 Drawing and Designing

 MAN006-0612

Badge Templates are designs for badges. They are used by the Credential or Credential
Template functions.
Drawings are used for several purposes, including maps and floor plans, backgrounds
and designs for badges (like logos, emblems, and seals), as well as miscellaneous
drawings your security department might need to create for posters, notices, or
bulletins. Drawings often serve as backgrounds for objects that are placed on it.
Integrated Objects (VIO) are icon or symbols that can be placed on a drawing and are
linked to a device (such as a door or expansion relay). When the device changes state,
the icon representing it can change its appearance as well.
Standard Objects (VSO) are custom shapes, such as architectural and design symbols,
that can be placed on a drawing. Velocity provides several of these objects; however,
you may need to produce others. These objects are not linked to real devices.
To create a drawing:
1. At the menu tool bar, select the type of drawing you want from the Modes menu
option.

If you want to create a: Do this:

Badge Template Modes > Badge

Drawing, VIO, or VSO Modes > Graphic

2. At the menu tool bar, select File > New.

Depending on which mode you select, several suboptions appear.
3. Select the appropriate option:

Drawing to create a new drawing (backdrop, floor plan,

map etc.)

Badge Template to create a new badge template

Integrated Object to create a VIO

(VIO)

Standard Object to create a VSO

(VSO)

A dialog box appears prompting you to enter a suitable name for this drawing.
4. Enter a name for this drawing, badge, or object then click OK.
A blank canvas appears for the selected drawing type. If you selected a badge
template, you should be in Design Mode by default. If you selected one of the
drawings, you are in Live Mode by default.
5. Change the page setup as required.
6. Design the badge template, drawing, or object (VIO or VSO) as required.
For more on designing a badge template, refer to “Designing a Badge” on page 494.
For more on designing a drawing, refer to “Designing a Drawing” on page 497. For
more on an object, refer to “Designing a Velocity Object” on page 619.
You can also create a new drawing, VIO, or VSO by going into the Object Library or
Directory panes and right clicking the appropriate drawing type. A pop-up menu
appears. Select New from the list.

Drawing and Designing 499

Velocity Version 3.1 Administrator’s Guide

Displaying a Drawing
Unlike most programs, Designer opens all existing drawings whenever the module is
opened and either the Badge or Graphic mode is selected. You're task is not to open
the drawing, but rather to select it from the drawing list.
In effect, there is no Open function, nor is there a Close function as there is with most
programs.

Hint The reason for this is that all drawings and graphics in Designer are stored in
Velocity's SQL database rather than in separate files. This guarantees that your
graphics and floor plans are stored in the same manner as your personnel data
and cannot be readily accessed by an unwanted user.

To select and display an existing drawing:

1. From the menu tool bar, select Modes > Graphic.
All drawings currently stored in the Velocity database appear on the canvas with
their own drawing tab displayed.
2. Do one of these:
• From the drawing selection tab bar, click the tab that corresponds to the
drawing you want to display.
• From the Directory pane, expand the tree until the Drawings folder until the
drawing you want appears. Double click the drawing you want.
• On the Navigation Icon Tool Bar, click the button to see the previous
drawing in the drawing list. Click the button to see the next drawing in the
drawing list.
The drawing appears in the canvas window.

Closing Drawings
The canvas and Directory pane can become cluttered if too many graphics are open at
the same time. In order to hide some of the drawings, you can use the close function.
To close drawings:
 From the drawing selection tab, right click on the drawing you want to close and
select Close.
 From the Directory pane, right click on the drawing you want to close and select
Close.
The selected drawing is hidden. You can always redisplay the badge or drawing, when
needed.

Displaying a Badge Template

Unlike most programs, Designer opens all existing badge templates when Designer is
opened and the Badge mode is selected. Your task is not to open the template, but
rather to select it. There is no Open function, nor is there a Close function as there is
with most programs.

500 Drawing and Designing

 MAN006-0612

Hint The reason for this is that all drawings and graphics in Designer are stored in
Velocity's SQL database rather than in separate files. This guarantees that your
badge templates are stored in the same manner as your personnel data and
cannot be readily accessed by an unwanted user.

To select and display an existing badge template:

1. From the menu tool bar, select Modes > Badge.
All badges currently stored in the Velocity database appear on the canvas with their
own drawing tab displayed.
2. Do one of these:
• In the Directory pane, expand the Badge Templates folder and double click
the badge template you want to view.
• Click on the drawing selection tab you want.
• On the Navigation Icon Tool Bar, click the button to see the previous
drawing in the drawing list. Click the button to see the next drawing in the
drawing list.
The selected badge template appears in the canvas window.

Importing Drawings
You can import images and other graphic files to Designer using the Import from File...
option. Use this method for importing floor plans, maps, backdrops, and many other
drawings into Designer.
Designer can import the following file formats:
 BMP
 WMF
 EMF
 JPG
 GIF
 DXF (AutoCad)
In addition, you can use the Import from File feature to re-import previously exported
Designer files from archives. These proprietary Velocity formats are supported:
 VBD - Drawings
 VBT - Badge Templates
 VSO - Standard Object Library
 VIO - Integrated Object Library
To import a file to the canvas:
1. Do one of these:
• From the menu tool bar, select File > Import from File...
• From the Directory pane, right click on the folder to which you want the file
imported and select Import from File... from the option list.
• From the Object Library, right click on either the VIO or VSO folder and select
Import from File... from the option list.

Drawing and Designing 501

Velocity Version 3.1 Administrator’s Guide

The Import File dialog box appears like this example:

2. Locate the computer, drive, and directory where the file is stored.
By default, this is the GraphicFiles subdirectory under Hirsch Electronics\Velocity.
3. If necessary, from the 'Files of type:' combo box, select the file type you want
displayed. Only the file type specified appears in the window.
The available options are:

All Supported File Displays all supported file formats in the window. This
Formats is the default option.

Velocity Drawing Displays the native Velocity drawing format in the

Files (*.vbd) window.

Velocity Badge Displays the native Velocity badge template format in

Templates (*.vbt) the window.

Velocity Integrated Displays the native Velocity integrated object format for
Objects (*.vio) the VIO library in the window.

Velocity Standard Displays the native Velocity standard object format for
Objects (*.vso) the VSO library in the window.

Bitmap (*.bmp) Displays the bmp bitmap format in the window. This is
the most common bitmap format available from any
Windows compatible program.

GIF (*.gif) Displays the gif bitmap format in the window. This is
another common bitmap format.

JPEG (*.jpg; *.jpeg) Displays jpg or jpeg files in the window. This is the
most common photograph format.

Metafiles Displays both the wmf and emf metafiles in the

(*.wmf;*.emf) window. Both vector formats are easily modified in
Designer.

AutoCad DXF Files Displays AutoCad DXF files in the window. This vector
(*.dxf) format can be modified in Designer.

4. From the file window, click to select the file you want to import.
5. Click Open.
6. Click OK.
The image is placed on the canvas as a new drawing.
7. Save the drawing.
The drawing is listed in the Object Library under the Drawings folder.

502 Drawing and Designing

 MAN006-0612

8. If you have imported a vector file—such as DXF, EMF, or WMF—you can modify the
drawing within Designer.
9. If required, click on the object in the graphic window you want to modify, then edit
it as you would any drawing object.
10. If needed, place objects on the graphic.
You can also import graphic files from other locations onto badge templates using the
Image tool.

Importing Velocity Objects

To import an existing VIO or VSO object:
1. Open the Object Library.
2. Right click on the VIO (Integrated) or VSO (Standard) folder.
An option list appears:

3. Select Import from File...

The Open dialog box appears with either the VIO or VSO type file designated in the
'File of Type' field.
4. Locate the computer, drive, and directory where the object graphic is stored.
5. Select the object graphic you want to import.
6. Click Open.
The new object graphic appears in the folder.
7. Double click the object in the folder to display it on the canvas.

Drawing an Arc
Arcs are open segments of circles or ovals.

To draw an arc:
1. Select design mode.
2. From the Icon Tool Bar, click the Arc Tool, .
This tool is part of the open object tool suite.
3. Click on the canvas at the point you want to begin the arc.
4. Drag the arc to the point where you want to end the arc.
As you drag the arc, notice that the arc stretches with the cursor.
5. At the end point, release the mouse button.

Drawing and Designing 503

Velocity Version 3.1 Administrator’s Guide

The arc appears with its handles visible as shown in this example:

6. To change the size of the arc, drag the handles to a new location.
7. To change the shape of the arc, drag the node points.
8. If needed, change the line style or the line color.
9. If needed, change the fill color or fill style.
10. To fine tune the arc, adjust the properties through the properties pane.
For more on this, refer to “Arc Properties,” starting on page 517.

Extending Arcs into Semicircles and Larger

Using your mouse and handles, you can transform a selected arc into a semicircle or
even larger, as shown in these three examples:

To increase or decrease an arc object:

1. Select the arc you want to convert. The arc handles appear.
2. Click on a yellow node points and move it.
Notice that as you drag the node point, arc size increases or decreases depending
on the direction in which you drag it.
3. Release the mouse button.
The new arc is set.
 Designer does not allow you to draw an arc section that forms a
complete circle; however, you can get close.

Drawing a Chord
To draw a chord:
1. Select design mode.
2. From the Icon Tool Bar, click the Chord tool, .
This tool is part of the enclosed object tool suite.
3. Click on the canvas at the point you want to begin the chord.
4. Drag the chord to the point where you want to end the chord.
As you drag the chord, notice that the chord stretches with the cursor.
Use the Shift and Ctrl keys to move between restricting and unrestricting the
chord placement to the grid points.
5. At the end point, release the mouse button.

504 Drawing and Designing

 MAN006-0612

The chord appears with its handles visible as shown in this example:

6. Make changes to the chord by either dragging the handles or nodes to a new
location.
7. If needed, change the line style or the line color.
8. If needed, change the fill color or fill style.
9. To fine tune the shape, use the object's properties pane.
For more on this, refer to “Chord Properties,” starting on page 527.

Drawing an Ellipse
An ellipse is an oval or other closed plane curve. A specialized example of an ellipse is
a circle.
To draw an ellipse:
1. Select design mode.
2. From the Icon Tool Bar, click the Ellipse tool, .
This tool is part of the enclosed object tool suite.
3. Click on the canvas at the point you want to begin the ellipse.
The mouse cursor appears as a plus sign, +.
4. Drag the ellipse to the point where you want to end it.
As you drag the ellipse, notice that a gray object stretches with the cursor.
• Hold down the Shift key to restrict the ellipse to a circle.
• Hold down the Ctrl key to snap the ellipse to the grid.
5. At the end point, release the mouse button. The ellipse appears with its handles
visible as shown in this example:

6. Resize the ellipse by dragging the handles to a new location.

7. If needed, change the line style or the line color.
8. If needed, change the fill color or fill style.
9. To fine tune the shape, adjust the properties through the properties pane.
For more on this, refer to “Ellipses Properties,” starting on page 532.

Drawing a Control Zone

Designer enables you to create an area on a drawing and designate it as a control
zone. In general terms, Velocity defines a control zone as the logical group of selected
system resources.

Drawing and Designing 505

Velocity Version 3.1 Administrator’s Guide

 Before you can draw and assign a control zone in Designer, you must
first define the control zone. If you attempt to define a control zone after
placing it in the drawing, Designer will not recognize the points.
A control zone as drawn in Designer is an enclosed polygon that traces the border of
the area you want to designate.
To draw a control zone:
1. Select design mode.
2. From the icon tool bar, select the control zone tool, .
3. Move to the canvas and click your left mouse button at the point where you want
to begin the control zone border.
4. Move the mouse as you trace the border.
To restrict the line path to the grid, hold down the Ctrl key while you are dragging
the object. To create an object with straight lines, hold down the Shift key while
you are dragging.
5. Click the mouse button again to complete a side.
6. Repeat steps 4 - 5 to draw the entire border.
7. At the end point, double click the mouse button.
Ideally, you should finish your trace at the point where you started it. If you have
not finished your trace on the starting point, the program automatically draws a
straight line between the end point and the starting point in order to complete the
enclosure.
8. Edit the borders as required by selecting the Select and Edit tool, clicking on the
new control zone object, and pull the handles as required.
9. Open the Properties pane.
10. In the Properties pane, assign the control zone you want to this enclosure by
selecting it in the 'Control Zone' field of the Control Zone property.
Please define the required control zone in the Administration window before
selecting it in the properties pane or Designer cannot monitor points correctly.
 If, for some reason, you draw a control zone before you define it, you
must define a control zone then return to Designer, reselect the created
control zone object, then select the newly-created CZ in the properties
pane.
11. If needed, change the alarm, secure, masked, and unknown colors in the Control
Zone properties as required.
12. Fine tune the object using the properties pane.
For more on this, refer to “Control Zone Properties,” starting on page 529.
For more on control zones, refer to “Control Zones” on page 109.

Drawing a Line
To draw a straight line:
1. Select design mode.
2. From the icon tool bar, click the straight line icon, .
3. Move to the canvas and click your left mouse button at the point where you want
to begin the line.
The mouse cursor's appearance will change to a plus symbol, +.

506 Drawing and Designing

 MAN006-0612

4. Drag to the position where you want the line to end.

A gray line appears along the drag path with the starting point anchored. This gray
line acts like an elastic band anchored at one end: stretch it, shorten it, move it in
any direction, it still stays straight.
• To restrict the line to increments of 45º, hold down the Shift key while you are
dragging the line.
• To snap the line to a grid, hold down the Ctrl key while dragging.
 To change grid settings, refer to “Grids” on page 450.
5. Release the left mouse button.
6. If needed, use the handles to change the line.
7. If needed, change the line style or the line color as required.
8. If needed, fine the object using the properties pane.
For more on this, refer to “Line Properties,” starting on page 542.
The line is placed.

Drawing a Polygon
A polygon is an object of two or more lines where the endpoints are common.
Polylines are objects consisting of two or more connected lines with two endpoints.
The difference is shown in the following example:

To draw a polygon:
1. Select design mode.
2. From the icon tool bar, select the Polygon tool, .
This tool is part of the enclosed object tool suite.
3. On the canvas, click the left mouse button to indicate the place where you want to
begin the polygon (initial vertex).
4. Move to another location on the canvas and click again to add a new vertex joined
to the previous by a straight line segment, or continue to hold down the left mouse
button while dragging in order to draw free-form shapes.
5. Repeat steps 2 and 3 to draw additional line segments. Each new line segment is
connected to the previous one.
6. To end the polygon, do one of these:
• double click the left mouse button
• press the Enter key to include the last vertex
• press the Esc key to remove the last vertex
The starting vertex and the ending vertex and joined by a line.
To restrict the line segments to increments of 90°, hold down the Shift key while
you are dragging the line. Hold down the Ctrl key while dragging to snap line
segments to the grid.
 For information on setting the grid, refer to “Grids” on page 450.

Drawing and Designing 507

Velocity Version 3.1 Administrator’s Guide

If you double click in the vicinity of the beginning vertex, Designer automatically
joins the start and end points.
An example of the finished polygon looks like this:

7. If needed, modify the size and shape of the selected polyline by manipulating the
handles.
8. If needed, change the line style or the line color.
9. If needed, change the fill color or fill style.
10. Fine tune the object by changing values on the selected object's property sheet.
For more on this, refer to “Polygon Properties,” starting on page 550.

Drawing a Polyline
Polylines are any objects consisting of two or more connected lines with two endpoints.
An object of two or more lines where the endpoints are common is a polygon. The
difference is shown in the following example:

To draw a polyline:
1. Select design mode.
2. From the icon tool bar, select the Polyline tool, .
3. On the canvas, click the left mouse button to indicate the place where you want to
begin the polyline (initial vertex).
The mouse cursor appears as a plus symbol, +.
4. Move to another location on the canvas and click again to add a new vertex joined
to the previous by a straight line segment, or continue to hold down the left mouse
button while dragging in order to draw free-form shapes.
5. Repeat steps 2 and 3 to draw additional line segments. Each new line segment is
connected to the previous one.
6. To end the polyline, double click the left mouse button or press the Enter key (last
vertex will be included) or the Esc key (last vertex will be removed) to complete
the object.
To restrict line segments to increments of 90°, hold down the Shift key while you
are dragging the line. Hold down the Ctrl key while dragging to snap line segments
to the grid.
 To specify grid settings, refer to “Grids” on page 450.

508 Drawing and Designing

 MAN006-0612

An example of the finished polyline looks like this:

7. To change the size of the selected polyline by manipulating the handles.

8. To change the shape of the object, double click the object and node handles
appear. Manipulate the node handles as required.

9. If needed, change the line style or the line color.

10. To fine tune the object, change values on the selected object's property sheet.
For more on this, refer to “Polyline Properties,” starting on page 552.

Drawing a Sector
To draw a sector:
1. Select design mode.
2. From the Icon Tool Bar, click the Sector tool, . This tool is part of the enclosed
object tool suite.
3. Click on the canvas at the point you want to begin the sector.
The mouse cursor appears as a plus sign, +.
4. Drag the sector to the point where you want to end the sector.
As you drag the sector, notice that a gray sector object stretches with the cursor.
5. At the end point, release the mouse button.
The sector appears with its handles and node points visible as shown in this
example:

6. To change the size of the object, drag the handles to a new location.
7. To increase or decrease the sector size, drag the node points.
8. To fine tune the object, change the properties through the properties pane.
Increase or decrease the degrees of the sector by using the yellow handles.
9. If needed, change the line style or the line color.
10. If needed, change the fill color or fill style.
11. If needed, edit other features of the object using the properties pane.
For more on this, refer to “Sector Properties,” starting on page 557.

Drawing and Designing 509

Velocity Version 3.1 Administrator’s Guide

Drawing a Rectangle
To draw a rectangle:
1. Select Design mode.
2. From the icon tool bar, select the Rectangle tool, .
This tool is part of the enclosed object tool suite.
3. On the canvas, click the left mouse button to indicate the place where you want to
begin the rectangle.
The mouse cursor appears as a plus symbol, +.
4. Drag the rectangle to the endpoint. A gray rectangle follows the path.
• To restrict the rectangle to a square (equal sides), hold down the Shift key
while you are dragging the line.
• To snap the rectangle's sides to the grid, hold down the Ctrl key while
dragging.
 To specify grid settings, refer to “Grids” on page 450.
An example of the finished rectangle looks like this:

5. If needed, change the line style or the line color.

6. If needed, change the fill color or fill style.
7. Modify the size and shape of the selected polyline by manipulating the handles.
8. To fine tune the object, change values on the selected object's property sheet.
For more on this, refer to “Rectangle Properties,” starting on page 555.

Inserting Text
If you are creating a badge template, you can place either a static or databound text
object.
Qualified Velocity operators can insert two types of images:
 Static — images that never change from one badge to the next
 Databound — images that change from one badge to the next depending on which
person the badge template is being used by
If you are creating a drawing, only a static text object is allowed.

Inserting Standard Text

To insert a standard text object:
1. Select Design mode.
2. From the Icon Tool Bar, click the text tool, .
3. Move the cursor to the canvas.
4. Left click the mouse at the point where you want the text.
If you want to create a text box for the text, drag the text icon across the canvas
until the text box is large enough for you.

510 Drawing and Designing

 MAN006-0612

When you release the left mouse button, the text cursor appears blinking.
5. With the text selected, type in the new text.
6. When you're finished, click the Select and Edit tool from the icon tool bar, .
7. Click to select the inserted text object.
8. If you need to change the way in which the text is contained by the text box,
change the font style option.
9. To change the font size:
• If you are in bounded or standard mode, change the size of the text using the
handles.
• If you are in multiline mode, use the property sheet or the font size field in the
icon tool bar, .
10. To change the font type, select the font you require from either the icon tool bar's
font type field, , or the property sheet.
11. If you require, change the horizontal and vertical alignment of the text using the
text alignment tools on the icon tool bar.
12. To change the text color, background color, text position, or other aspects of the
text, use the selected text's Property Sheet.

Inserting Databound Text

To insert a databound text object:
1. Display the Object Library pane.
2. Expand the VDO folder until all of the databound objects are displayed.
3. Create a new badge template.
4. From the VDO folder, drag the text object, , to the canvas.
The text object appears on the canvas. The initial text string is <Undefined Text>.
5. Click the Select and Edit tool from the icon tool bar, .
6. Click to select the inserted text object.
7. Change the size of the text using the handles.
8. If you need to change the way in which the text is contained by the text box,
change the font style option.
9. If you need to change the horizontal and vertical text alignment, use the text
alignment tools on the icon tool bar.
10. Display the Properties pane.
11. Click the 'Data Field' property, and specify the variable to which it is linked.
12. To assign UDF properties, select a UDF option from the 'UDF' field.
13. To change the text color, background color, text position, font, size, or other aspects
of the text, use the selected text's Property Sheet.

Inserting an Image
Designer supports the insertion of a wide variety of images onto badge templates
including photographs, signatures, and logos.
Qualified Velocity operators can insert two types of images:
 Static — images that never change from one badge to the next (see page 512)
 Databound — images that change from one badge to the next depending on which
person the badge template is being used by (see page 512)

Drawing and Designing 511

Velocity Version 3.1 Administrator’s Guide

Inserting a Static Image

To insert an image:
1. Select Design mode.
2. From the icon tool bar, select the Image Insertion tool, .
The Add Image dialog box appears like this example:

3. From the 'Look in:' field, select the drive, directory, and folder where the static
image is located.
The 'Files of type:' field should display All Supported File Formats. Designer
supports these image types (formats):
• Bitmaps (bmp, ico, pcx, or dib)
• Windows Metafiles (wmf or emf)
• JPEG (jpg or jpeg)
• Vector (gif, eps, tiff)
The image should appear in the window.
4. Click to select the image.
The image's file name appears in the 'File name:' field.
5. Click Open.
The static image appears on the canvas.
6. Move the image to the proper position on the canvas.
If required, resize the image using the handles.
7. Use the static image's property sheet to fine tune the object's appearance.
For more on this, refer to “Image Properties,” starting on page 537.

Inserting a Databound Image

When you are designing a badge template and need to insert images particular to each
employee enrolled, you must link the image frame on the badge template to a variable
entered on the Personal Information Form in Enrollment Manager.
In such circumstances, you will want to substitute a variable field name for the picture
itself. Variables (identified by a percentage sign before and after the entry) link the
badge directly to Enrollment Manager which oversees the actual capture of the photo
or signature for each person.

512 Drawing and Designing

 MAN006-0612

To insert a databound image:

1. Create a new badge template.
2. Open the Object Library pane.
3. Expand the VDO (Databound) folder to reveal the available databound images.
These should include databound text, pictures, signatures, barcode, and magstripe.
4. Drag the databound picture from the Object Library pane to the canvas, .
5. Choose from one of three image types:

Picture Any image without reference to aspect ratio. The frame that first
appears is square.

Photo A photo whose frame is sized to the exact aspect ratio of

photographs in the Enrollment Manager. While you can resize
these frames, the photograph that goes in it cannot be skewed or
distorted. It fits as best it can, leaving space either horizontally or
vertically as required.

Signature An image whose frame is sized to the specifications of the

Enrollment Manager signature box. While you can resize these
frames, the signature that goes in it cannot be skewed or
distorted. It fits as best it can, leaving space either horizontally or
vertically as required.

An empty frame appears on the canvas. The proportions of the frame depend on
the type of image you have selected.
6. If required, resize the frame using the handles.
7. With the image selected, go to the Databound Image properties list and click on
the 'Data Field'.
For more on this, refer to “Databound Image Properties,” starting on page 539.
8. From the combo box option list, select one of these variable values:
• For pictures, select Photo.
• For signatures, select Signature.
9. Select or enter any additional values from the properties list as required.
10. Save the badge template in which the databound image appears.
The image is automatically linked to the capture or import engine in Enrollment
Manager. When an image is captured or imported for a photo or signature during the
enrollment process, it is automatically placed in the position on the badge currently
held by the image placeholder.
 This feature cannot work properly unless the badge template possessing
the variable image is assigned to a specific credential.
For more on variable fields, refer to “Inserting Variable Field Names” on page 582.

Inserting Magstripes
A feature often found on badges is a magstripe. The magstripe is not 'printed' onto a
badge; it is present on a blank card. The data specified by the badge template is
encoded onto the magstripe by the badge printer.

Drawing and Designing 513

Velocity Version 3.1 Administrator’s Guide

The person responsible for designing a magstripe badge must take into account the
position of the magstripe on the card so that no other text or image is printed at the
same location.
Because some badge printers contain a magstripe encoder, the Designer provides the
capability to encode a card using either constants specified within this program or
variables dependent on values entered at the Personal Information Form in Enrollment
Manager; however, this capability cannot be used successfully unless the badge printer
possesses an encoder.
To insert a magstripe:
1. From the menu tool bar, select Modes > Badge.
2. Select Design mode.
3. Display the Object Library pane.
4. From the Object Library, expand the VDO folder.
The Magstripe object appears.
5. Create a new badge template or display an existing badge template.
6. Click to select the magstripe object, , and drag it to the badge template
canvas.
The words Magstripe Information appears on the canvas.
7. Resize the magstripe object using the handles.
8. If not already open, display the Properties pane.
9. Click on the new magstripe object.
The magstripe's properties appear in the properties pane. For more on this, refer to
“Magstripe Properties,” starting on page 544.
10. At the magstripe's property sheet, enter values for the magstripe's properties as
required.
For more on this, refer to “Magstripe Properties,” starting on page 544. Values you
can specify include:
• Appearance
• Position
• Data (Tracks 1 & 3)
• Magstripe encoding
These properties help position the magstripe properly and set up the protocol the
blank cards use. Make sure you have the correct settings for the blanks you have.
Enrollment Manager and the badge printer cannot encode a stripe correctly unless
Badge Designer tells it where the stripe is on the card.
If you specify a variable value for the data, code or ID fields, the magstripe encodes
a value as specified by the User Defined Setup dialog box in Enrollment Manager.
This capability cannot be utilized unless the badge printer includes an encoder.
11. If required, resize or reshape the magstripe using the handles.

Inserting Barcodes
Badges can have bar codes that enable the badge holder to scan it through any
conventional scanning device.
To insert a barcode:
1. From the menu tool bar, select Modes > Badge.
2. Select Design mode.

514 Drawing and Designing

 MAN006-0612

3. Display the Object Library pane.

4. From the Object Library, expand the VDO folder. The Barcode object appears.
5. Create a new badge template or display an existing badge template.
6. Click to select the barcode object, , and drag it to the badge template
canvas.
The default barcode appears in the badge template.
7. Display the Properties pane.
8. Click on the new barcode object.
The barcode's properties appear in the properties pane.
9. Resize the barcode as required using the barcode's property sheet.
While you can resize the barcode using the handles, the resizing is not permanent.
The only way to resize the barcode permanently, is through the property sheet.
10. At the barcode's property sheet, enter values for the barcode properties as
required.
For more on this, refer to “Barcode Properties,” starting on page 520.

Drawing and Designing 515

Velocity Version 3.1 Administrator’s Guide

Object Properties
Use the property sheets associated with each object to fine tune line, fill, color, rotation,
and other graphic aspects of the object. In addition, you can use the property sheets to
link Velocity functions to specific objects.

Categorizing Properties
You can arrange the properties appearing on a sheet either by categories (the default)
or alphabetically.
To change the order of properties on a sheet:
 Check or uncheck the 'Categorized Properties' box on the Options dialog box.
 Right click on the Properties title bar and check or uncheck the 'Categorized
Properties' option as required.

Editing Properties
Properties are arranged in tables with the property name in the left column and its
current value displayed in the right column. The left column cannot be edited. You can
change values in the right column using one of three methods:
 Text entry: Click in the right column. The cursor appears at the beginning of the
column. Enter a new value for the property. Press Enter or move to another
property line and the object is changed accordingly.
 Dialog box entry: Click in the right column and the icon appears. Click this icon
and a dialog box appears. Make changes to the dialog box as required. Press Enter
or move to another property line and the object is changed accordingly.
 Option selection: Click in the right column and a combo option box appears,
. This indicates that a list of possible options are available. Click the
down arrow, , to the right of the combo box and a drop-down list of options
appears. Select from one of the available options in the drop-down list. Press Enter
or move to another property line and the object is changed accordingly.
Each of these objects and their associated properties are defined:

Properties Go to page

Arc 517

Barcode 520

Cameras 565

Chord 527

Command Set 573

Control Zone 529

Databound Image 539

Databound Text 562

Drawing (General) 562

516 Object Properties

 MAN006-0612

Properties Go to page

Ellipse 532

Group 535

Image 537

Line 542

Link 576

Magstripe 544

Polygon 550

Polyline 552

Quick Link Viewer 570

Rectangle 555

Sector 557

Text 559

Arc Properties
An example of the arc property sheet is displayed below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Arc followed by a number. You can edit this
name as required.

Object Type This is a read-only field indicating the type of object this is.

Object Properties 517

Velocity Version 3.1 Administrator’s Guide

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge Mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

518 Object Properties

 MAN006-0612

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Object Properties 519

Velocity Version 3.1 Administrator’s Guide

Barcode Properties
An example of the barcode property sheet is displayed below:

The properties defining a barcode object are:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Databound. You can edit this name as
required.

Object Type This is a read-only field indicating the type of object this is. This
is Databound Barcode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Appearance

Barcode Font The font used for the text bordering the barcode. Click this cell
then click the button and the font dialog box appears. Select
the font used for the text.
The default is Arial.

Barcode Font Click this cell to change the color of the object's border text.
Color Click the button and the color dialog box appears. Select the
line color you need from the dialog box. The default value is
Black.

Barcode Indicate whether this barcode has a background (True) or not

Background (False).
Style The default is False which means the background is white.

520 Object Properties

 MAN006-0612

Barcode

Barcode Click this property and select from the option list the type of bar
Symbology code symbol system used for this bar code. This symbol system
must be compatible with the barcode reader you are using, or
the bar code will not be read successfully.
The bar code symbol options include:
• Code 39 (Normal)
• Code 39 (Full ASCII)
• UPC-A (12 digit)
• UPC-E (6 digit)
• EAN-8
• EAN-13
• BookLan
• Interleaved 2 Of 5
• CodaBar
• Code 93
• Code 128
• EAN/UCC 128
• POSTNET
Code 39 (Normal) is the default selection.
For more on this, refer to “Bar Codes & Bar Code Symbologies”
on page 524.

Barcode Data Type the text or number representing the code for this barcode
or select an available variable field option from the drop-down
option list. The bar code changes to represent the text entered.
Select a variable field from the available drop-down list. The bar
code is then linked to a field specified in the Enrollment
Manager. Each of these user-defined fields are then associated
with fields placed on a badge through in the User Defined Setup
dialog box in Enrollment Manager.
In addition to the UDF variable fields, you can also choose a
custom badge field, such as @LastFirst, from the variable data
field option list. For more on this, refer to “Inserting Variable Field
Names,” starting on page 582.

Barcode If required, either enter a line of text for the comment or select
Comment from the available variable field options. For more on this, refer
to the ‘Bar Code Data’ field.
If the Comment on Top property value is True, the text appears
above the bar code.

Barcode Returns and/or sets the barcode's supplemental characters.

Supplemental Either enter a line of text or select an available variable field
option from the drop-down option list. For more on this, refer to
the ‘Bar Code Data’ field.

Narrow Bar Type a value here which increases or decreases the width of the
Width narrowest bar code. The default is 13 pixels.

Object Properties 521

Velocity Version 3.1 Administrator’s Guide

Reduction/ Click this property and select a value from the option list
Gain indicating the reduction or gain for this bar code in percentage
and millimeters (mils).
The default is 00% (0.00 mils).

Barcode Enter the height of this bar code in inches. The default height is
Height 1 inch.

Narrow to Click this property and select a value from the available options
Wide Ratio that expresses the ratio between the narrowest and widest bars
of the code, measured in pixels. The larger the ratio, the greater
the variation in size between the narrowest and widest bars.
The range is 2.0 to 3.0 and the default is 2.5 pixels.

Comment on Accept the default value, True, to allow a comment line above
Top the bar code. To allow a comment line below the bar code,
select False.
If you choose to display the text above the barcode, you cannot
display the comment above as well. You must either change the
Text On Top value to False or change the Comment on Top
value.

Include Text Accept the default value, True, to display the text. This enables
you to print not only the barcode but the text it represents.
To hide the text, select False.

Text On Top Click this property and select True to show the text for this bar
code on the top. Text is normally displayed below the barcode.
The default is False.
If you choose to display the text above the barcode, you cannot
also display the comment above. You must change the
Comment On Top value to False.

Show Quiet Click this property and select True to show quiet zones for this
Zones bar code.
The default is False.

Show Bearer Click this property and select True to show bearer bars for this
Bars bar code.
The default is False.

Show Check Click this property and select True to show a check character for
Characters this bar code.
The default is False.

522 Object Properties

 MAN006-0612

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Object Properties 523

Velocity Version 3.1 Administrator’s Guide

Bar Codes & Bar Code Symbologies

There are many different types of bar code symbology systems; however, each type is
limited to a particular industry and group of readers. To help you in choosing which bar
code symbology you should select, here is a chart:

Barcode Type Character Set Length Checksum Applications &

Comments

EAN-13 Linear Numbers Only 12 data digits Required Retail product

and 1 check marking
digit; 2 or 5 world-wide
digit
supplement
optional

EAN-8 Linear Numbers Only Required Retail product

marking
world-wide;
compressed code
for products with
limited label space

EAN Linear Numbers Only Required Special use of the

Bookland EAN-13 symbol to
encode ISBN
number on books

UPC-A Linear Numbers Only 11 data digits Required Retail product

and 1 check marking in USA
digit; 2 or 5 and Canada
digit
supplemental
optional

UPC-E Linear Numbers Only Required Retail product in

USA and Canada;
compressed code
for products with
limited label space

UPC Linear Numbers Only 13 data digits Required Special use of the
Shipping and 1 check Interleaved 2 of 5
Container digit code to mark
Code shipping cartons
(ITF-14) containing UPC
encoded products

UCC/EAN Linear Numbers Only 13 digits and 1 Required Special use of

Shipping check digit Code 128 to mark
Container shipping cartons
Code containing UPC
(SCC-14) encoded products

Code 11 Linear Numbers Only Variable 1 Required;

2
Recomn’d

Bar Code Comparison Chart

524 Object Properties

 MAN006-0612

Barcode Type Character Set Length Checksum Applications &

Comments

Interleaved 2 Linear Numbers Only Variable Optional Very compact

of 5 encodes digits in
pairs so total
length must be
even number of
digits

Industrial 2 Linear Numbers Only Variable None Older type of code

of 5 defined

Standard 2 Linear Numbers Only Variable None Older type of code

of 5 defined

Codabar Linear Numbers; Variable None Older code; often

(USD-4, Symbols: - : . $ / defined used in libraries
NW-7, 2 of + and blood banks
7) Start/Stop
Characters: A, B,
C, D, E, *, N, or T

Plessey Linear Numbers Only Variable Required Grocery store shelf

tags

MSI (MSI Linear Numbers Only Variable Required Grocery store shelf
Plessey) tags

OPC Linear Numbers Only 9 data digits Required Special use of

(Optical and 1 check Interleaved 2 of 5
Industry digit for marking retail
Association) optical products

Postnet Bar Numbers Only 5, 9, or 11 Required USA postal code

Height digits and 1 (ZIP code)
Encoding check digit

Code 39 Linear Uppercase letters Variable Optional In very wide use

A-Z; for many types of
Numbers 0-9; applications
Space - . $ / +
%

Code 93 Linear Uppercase letters Variable Optional A more compact

A-Z; cousin of Code
Numbers 0-9; 39, not as widely
Space - . $ / + in use
%

Extended Linear All ASCII Variable Optional Uses pairs of

Code 39 characters and characters to
control codes encode
non-standard
symbols; wastes
space

Code 128 Linear All ASCII Variable Required Widely used;

characters and excellent for many
control codes applications

Bar Code Comparison Chart (Continued)

Object Properties 525

Velocity Version 3.1 Administrator’s Guide

Barcode Type Character Set Length Checksum Applications &

Comments

UCC/EAN-1 Linear All ASCII Variable Required Special use of

28 characters and Code 128 which
control codes defines data
formats for
commerce

LOGMARS Linear Uppercase letters Variable Optional Same as Code 39;

A-Z; US government
Numbers 0-9; specification
Space - . $ / +
%

PDF-417 2-D All ASCII Variable, up to Error

characters about 1850 correction
ASCII or 2725
numeric
characters

DataMatrix 2-D All ASCII Variable, up to Error

characters 2335 ASCII correction
characters

Maxicode 2-D All ASCII 93 ASCII Error Developed by the

characters characters correction United Parcel
Service for
encoding parcel
destination
information for
auto-sorting

QR Code 2-D All ASCII Variable, up to Error

characters about 1520 correction
ASCII or 2509
numeric
characters

Bar Code Comparison Chart (Continued)

526 Object Properties

 MAN006-0612

Chord Properties
An example of the chord property sheet is displayed below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the name of
the object is Chord followed by a number. You can edit this name as
required.

Object This is a read-only field indicating the type of object this is.
Type

UDF Click this cell and select from the drop-down list the UDF you want to
link to this object. Once linked based on its User Defined Field
Property Definitions, this object changes attributes according to which
option is selected for that UDF in Enrollment Manager.
Note: This property only appears if you are in Badge Mode.

Layer Click this cell to assign the object to a layer of this drawing. An option
list appears. Only those layers currently defined for the drawing appear
in the option list. The default value is Default.

Position

Top Specifies the units from the top where this object begins as measured
by the ruler. To change this value, enter a new one. The larger the
value, the farther from the top of the margin this object begins/ends;
the smaller the value, the nearer the top of the margin.
If the value you specify is outside the available range—that is, outside
the canvas margins as specified by page size setup—an error message
appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one. The
larger this value, the closer to the bottom of the margin this object is
placed; the smaller this number, the farther from the bottom margin.
If the value you specify is outside the available range—that is, outside
the canvas margins as specified by page size setup—an error message
appears.

Object Properties 527

Velocity Version 3.1 Administrator’s Guide

Left Specify the position of the left most point of this object on the canvas
as measured by the ruler. Use this property to move, shorten, or
lengthen the object as required. The larger the value, the farther from
the left margin; the smaller the value, the closer to the left margin.
If the value you specify exceeds the available range—that is, outside
the canvas margins as specified by page size setup—an error message
appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the value, the
nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is, outside
the canvas margins as specified by page size setup—an error message
appears.

Rotation Specify how many degrees you need to rotate this object where 0° is
the current position. All positive degrees are clockwise; all negative
degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The default
value is True.

Line Click this cell and enter a value to change the thickness of the object's
Width border. Select the option you need from the list where 0 = thinnest
and 5 = thickest. The default value is 1.

Line Click this cell then click the button to change the color of the
Color object's border. The color dialog box appears. Select the line color you
need from the dialog box. The default value is Black.

Line Click this cell to change the texture of the object's border. A line style
Style option list appears. Select the option you need from the list. The
default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color you
need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill style
option list appears. Select the option you need from the list. The
default value is Solid.

Back Click this cell then click the button to change the color of the
Color object's background. The color dialog box appears. Select the back
color you need from the dialog box.
The default value is gray.

528 Object Properties

 MAN006-0612

Back Click this cell to change the texture of the object's background. A back
Style style option list appears. Select the option you need from the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Control Zone Properties

This property sheet is only available in Graphics Mode.
When you select a control zone object, the property sheet pane displays a list like this
example:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the name
of the object is Control Zone followed by a number. You can edit
this name as required.

Object This is a read-only field indicating the type of object this is.
Type

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Control Zone Info

Controller Click this cell and a pick list appears. Select the controller this
control zone applies to.
Only those controllers currently defined for this system appear in
this list. By default, this cell is blank.

Object Properties 529

Velocity Version 3.1 Administrator’s Guide

Control Click this cell and a pick list appears. Select from the list the control
Zone zone this object represents on the canvas.
Only those control zones currently defined for this system appear
in the list. Once selected, the control zone is linked to the object.

Alarm Click this cell to change the fill color of this object, indicating when
Color any point in the linked control zone is in alarm. The color dialog box
appears. Select the color you require. The default value is Red.

Secure Click this cell to change the fill color of this object, indicating when
Color all points in the linked control zone are known and secure. The
color dialog box appears. Select the color you require. The default
value is Green.

Masked Click this cell to change the fill color of this object, indicating when
Color at least one point in the linked control zone is masked. The color
dialog box appears. Select the color you require. The default value
is Yellow.

Unknown Click this cell to change the fill color of this object, indicating when
Color no points within the linked zone are in alarm or are masked and at
least one point is unknown. The color dialog box appears. Select
the color you require. The default value is Gray.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one. The
larger the value, the farther from the top of the margin this object
begins/ends; the smaller the value, the nearer the top of the
margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one. The
larger this value, the closer to the bottom of the margin this object
is placed; the smaller this number, the farther from the bottom
margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer to
the left margin.
If the value you specify exceeds the available range—that is, outside
the canvas margins as specified by page size setup—an error
message appears.

530 Object Properties

 MAN006-0612

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the value,
the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where 0°
is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False).
The default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0 =
thinnest and 5 = thickest.
The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line color
you need from the dialog box.
The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box.
The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill style
option list appears. Select the option you need from the list.
The default value is Solid.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Object Properties 531

Velocity Version 3.1 Administrator’s Guide

Ellipses Properties
An example of the ellipses property sheet is displayed below:

All circles, ovals, and ellipses created within Badge Designer share these properties.
The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Ellipse followed by a number. You can edit
this name as required.

Object Type This is a read-only field indicating the type of object this is.

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge Mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

532 Object Properties

 MAN006-0612

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest.
The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box.
The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Object Properties 533

Velocity Version 3.1 Administrator’s Guide

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box.
The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

534 Object Properties

 MAN006-0612

Group Properties
Once you have grouped objects, the group is assigned a container property. You can
manipulate aspects of that container through the container property sheet.
Grouped objects have a property sheet that is similar to a normal property sheet. Only
those properties common to all groups objects are displayed. For example, if you group
two rectangles and an ellipse, the property sheet looks like this:

Notice that only those properties that are common to all three objects are displayed.
The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Container followed by a number. You can
edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Object Properties 535

Velocity Version 3.1 Administrator’s Guide

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

536 Object Properties

 MAN006-0612

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Image Properties
An example of the Static Image property sheet is shown below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Image followed by a number. You can edit
this name as required.

Object Type This is a read-only field indicating the type of object this is.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Appearance

Transparency Enter a value from 0 - 255 indicating the transparency of the

image where 0 = invisible and 255 = opaque. An intermediate
value indicates that an object, such as a watermark or text, and be
seen beneath the image.
The default is 255 (opaque).

Object Properties 537

Velocity Version 3.1 Administrator’s Guide

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line color
you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Opaque.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

538 Object Properties

 MAN006-0612

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Databound Image Properties

An example of the Databound Image property sheet is shown below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Databound Image followed by a number.
You can edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

Object Properties 539

Velocity Version 3.1 Administrator’s Guide

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Data

Data Field Click in this field and select from the drop-down list the variable
image you want to substitute for this text in the finished badge.
Select from one of three options:
• None
• Photo
• Signature
The default is None.

Appearance

Transparency Enter a value from 0 - 255 indicating the transparency of the

image where 0 = invisible and 255 = opaque. An intermediate
value indicates that an object, such as a watermark or text, and
be seen beneath the image.
The default is 255 (opaque).

Visible Click this cell and specify whether this object is visible during
Live mode (True) or is not visible during Live mode (False).
The default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest.
The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box.
The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box.
The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

540 Object Properties

 MAN006-0612

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Object Properties 541

Velocity Version 3.1 Administrator’s Guide

Line Properties
An example of the Line property sheet is shown below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Line followed by a number. You can edit
this name as required.

Object Type This is a read-only field indicating the type of object this is.

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge Mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

542 Object Properties

 MAN006-0612

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Object Properties 543

Velocity Version 3.1 Administrator’s Guide

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Magstripe Properties
An example of the Magstripe property sheet is shown below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Databound Magstripe followed by a
number. You can edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

Text Enter text for this magstripe then press Enter. This is the text that
appears in the box representing the magstripe on the badge
template.
The default is Magstripe Information.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

544 Object Properties

 MAN006-0612

Font

Font Click this cell then select the font style you require from the
combo box list. Only those fonts currently defined for this
system appear in this list.
This is the font in which the text appears on the badge
template.

Font Color Click this cell then click the button to change the color of
the magstripe text appearing on the badge template. The color
dialog box appears. Select the line color you need from the
dialog box.
The default value is Black.

Magstripe

Magstripe Click the button and select one of the existing variable data
Data field values or custom badge field options from the drop-down
option list. There are three magstripe data formats supported:
• @Magstripe - Card Data in Magicard Format
• @Magstripe - Card Data in Fargo Format
• @Magstripe - Card Data in Eltron Format
where @Magstripe - Card Data in Magicard Format is the
default value.
Each of these user-defined or custom badge fields are
associated with fields placed on a badge in Enrollment
Manager.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Object Properties 545

Velocity Version 3.1 Administrator’s Guide

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during
Live mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where
0 = thinnest and 5 = thickest. The default value is 1.

Line Color Click this cell then click the button to change the color of
the object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the
list. The default value is Solid.

Fill Color Click this cell then click the button to change the color of
the object's interior. The color dialog box appears. Select the fill
color you need from the dialog box. The default value is no
color.

546 Object Properties

 MAN006-0612

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the
list. The default value is Solid.

Back Color Click this cell then click the button to change the color of
the object's background. The color dialog box appears. Select
the back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background.
A back style option list appears. Select the option you need
from the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Placed Object Properties

When you place a previously defined object, such as a door or camera, on a graphic,
the selected object displays a property sheet like the following example:

The properties in this list are defined below:

General

Name The read-only name of this object previously assigned to this

object when it was defined.

Object Type This is a read-only field indicating the type of object this is. In
this case, a Velocity integrated object.

Address The address of this object within the Velocity system. This
follows the Velocity naming conventions.

Object Properties 547

Velocity Version 3.1 Administrator’s Guide

Primary This read-only property indicates that if this object is placed on

several maps, this is the map to which Velocity will
automatically go if the object goes into alarm. The only value is
True.

Left Mouse Indicates the access and/or control function that the qualified
Click Operator can perform by left mouse clicking on this placed
object in Live mode. Only one function can be left clicked. This
is a quick way to perform a single, vital function on a specified
object using the left mouse button.
None is the default value. Right click options remain unaffected.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Font

Font Click this cell then select the font style you require from the
combo box list. Only those fonts currently defined for this
system appear in this list.
This is the font in which the text appears on the badge
template.

Font Color Click this cell then click the button to change the color of
the magstripe text appearing on the badge template. The color
dialog box appears. Select the line color you need from the
dialog box.
The default value is Black.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

548 Object Properties

 MAN006-0612

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during
Live mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where
0 = thinnest and 5 = thickest. The default value is 1.

Line Color Click this cell then click the button to change the color of
the object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the
list. The default value is Solid.

Fill Color Click this cell then click the button to change the color of
the object's interior. The color dialog box appears. Select the fill
color you need from the dialog box. The default value is no
color.

Object Properties 549

Velocity Version 3.1 Administrator’s Guide

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the
list. The default value is Solid.

Back Color Click this cell then click the button to change the color of
the object's background. The color dialog box appears. Select
the back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background.
A back style option list appears. Select the option you need
from the list.
The default value is Transparent.

Polygon Properties
An example of the Polygon property sheet is shown below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Polygon followed by a number. You can
edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

550 Object Properties

 MAN006-0612

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 1.

Object Properties 551

Velocity Version 3.1 Administrator’s Guide

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Polyline Properties
An example of the Polyline property sheet is shown below:

552 Object Properties

 MAN006-0612

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Polyline followed by a number. You can
edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin. If the value you specify is outside the available
range—that is, outside the canvas margins as specified by page
size setup—an error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin. If the value you specify is outside the available
range—that is, outside the canvas margins as specified by page
size setup—an error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin. If the value you specify exceeds the available
range—that is, outside the canvas margins as specified by page
size setup—an error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Object Properties 553

Velocity Version 3.1 Administrator’s Guide

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

554 Object Properties

 MAN006-0612

Rectangle Properties
An example of the Rectangle property sheet is shown below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Rectangle followed by a number. You can
edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin. If the value you specify is outside the available
range—that is, outside the canvas margins as specified by page
size setup—an error message appears.

Object Properties 555

Velocity Version 3.1 Administrator’s Guide

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin. If the value you specify is outside the available
range—that is, outside the canvas margins as specified by page
size setup—an error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

556 Object Properties

 MAN006-0612

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Sector Properties
An example of the Sector property sheet is shown below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Sector followed by a number. You can edit
this name as required.

Object Type This is a read-only field indicating the type of object this is.

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Object Properties 557

Velocity Version 3.1 Administrator’s Guide

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin. If the value you specify is outside the available
range—that is, outside the canvas margins as specified by page
size setup—an error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin. If the value you specify is outside the available
range—that is, outside the canvas margins as specified by page
size setup—an error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

558 Object Properties

 MAN006-0612

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Text Properties
An example of the static text property sheet is shown below:

 This applies to static or unlinked text. For databound text properties, refer
to “Databound Text Properties” on page 562.

Object Properties 559

Velocity Version 3.1 Administrator’s Guide

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Text followed by a number. You can edit
this name as required.

Object Type This is a read-only field indicating the type of object this is.

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Font

Font Click this cell and select from the combo box list the font style in
which you want the selected text to appear. Only those fonts
currently installed in this computer appear in this list.

Font Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the font
color you need from the dialog box. The default value is black.

Font Style Click this cell and select from the combo box list the font style in
which you want the selected text to appear.
For more on this, refer to “Font Styles” on page 595.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

560 Object Properties

 MAN006-0612

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Object Properties 561

Velocity Version 3.1 Administrator’s Guide

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Many of the functions performed by this property sheet can also be accomplished
using either the menu tool bar or icon tool bar.

Databound Text Properties

Databound text is that text which is linked to some value entered in Enrollment
Manager. This type of text can only be placed on a badge template. An example of the
databound text property sheet is shown below:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Text followed by a number. You can edit
this name as required.

Object Type This is a read-only field indicating the type of object this is.

Text Click in this cell and enter the text you want to appear as a
placeholder in this badge template text box.
The default is <Undefined Text>. This is not the text that will
appear on the printed badge, only the badge template.

562 Object Properties

 MAN006-0612

UDF Click this cell and select from the drop-down list the UDF you
want to link to this object. Once linked based on its User Defined
Field Property Definitions, this object changes attributes
according to which option is selected for that UDF in Enrollment
Manager.
Note: This property only appears if you are in Badge mode.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Data

Data Field Click in this field and select from the drop-down list the variable
field you want to substitute for this text in the finished badge. All
currently defined user-defined fields from the Enrollment
Manager and custom badge fields from the Designer appear in
this list.
The default is <None>.

Font

Font Click this cell and select from the combo box list the font style in
which you want the selected text to appear. Only those fonts
currently installed in this computer appear in this list.

Font Color Click this cell then click the button to change the color of the
text.
The color dialog box appears. Select the font color you need
from the dialog box. The default value is black.

Font Style Click this cell and select from the combo box list the font style in
which you want the selected text to appear.
For more on this, refer to “Font Styles” on page 595.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Object Properties 563

Velocity Version 3.1 Administrator’s Guide

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

564 Object Properties

 MAN006-0612

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Camera Properties
Velocity supports two types of cameras:
 Analog cameras
 Digital cameras
Analog cameras must be connected to Velocity through a switcher and are configured
using Velocity's CCTV configuration options.
Digital cameras are connected directly to the network. They are configured and viewed
through a browser. Once defined, they are placed on a Designer drawing using Custom
Links. For more on this, refer to “Custom Links” on page 613.

Analog Camera Properties

When you place an analog camera on a drawing with the Properties pane open, a
sheet like this appears.

Object Properties 565

Velocity Version 3.1 Administrator’s Guide

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Camera followed by a number. You can
edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

Address This cell indicates the address of the CCTV camera. This is
automatically assigned by Velocity based on the current camera
definition. For more on this, refer to “Address Format” on page
422.

Primary Indicates whether this camera is set as primary by right clicking

on the camera object. If set as primary, this is True. The default is
False.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

566 Object Properties

 MAN006-0612

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Object Properties 567

Velocity Version 3.1 Administrator’s Guide

Digital Camera Properties

When you place an digital camera on a drawing with the Properties pane open, a sheet
like example this appears:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Camera followed by a number. You can
edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

Custom This cell indicates the IP address of the digital camera. This is
assigned through the internet using the arp command.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Font

Font Click this cell and select from the combo box list the font style in
which you want the selected text to appear. Only those fonts
currently installed in this computer appear in this list.

Font Color Click this cell then click the button to change the color of the
text.
The color dialog box appears. Select the font color you need
from the dialog box. The default value is black.

Font Style Click this cell and select from the combo box list the font style in
which you want the selected text to appear.
For more on this, refer to “Font Styles” on page 595.

568 Object Properties

 MAN006-0612

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Object Properties 569

Velocity Version 3.1 Administrator’s Guide

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Quick Link Viewer Properties

When you drag a Quick Link Viewer object to the canvas with the Properties pane
displayed, a property sheet like this appears:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Quick Link Viewer followed by a
number. You can edit this name as required.

570 Object Properties

 MAN006-0612

Object Type This is a read-only field indicating the type of object this is.

Custom Click this cell and then click . The Quick Link Viewer
Properties page appears. In the 'Page' field, enter the web
address for the page you want to link. The address must follow
this format:
http://computername/pagename.html
For example: http://bralston/index.html or
http://www.hirschelectronics.com.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Font

Font Click this cell and select from the combo box list the font style in
which you want the selected text to appear. Only those fonts
currently installed in this computer appear in this list.

Font Color Click this cell then click the button to change the color of the
text.
The color dialog box appears. Select the font color you need
from the dialog box. The default value is black.

Font Style Click this cell and select from the combo box list the font style in
which you want the selected text to appear.
For more on this, refer to “Font Styles” on page 595.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Object Properties 571

Velocity Version 3.1 Administrator’s Guide

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

572 Object Properties

 MAN006-0612

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Command Set Properties

When you drag a Command Set object to the canvas in Graphics Mode with the
Properties pane displayed, a property sheet like this appears:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Command Set followed by a number. You
can edit this name as required.

Object Type This is a read-only field indicating the type of object this is.

Text Click in this cell and enter the text you want to appear as a
placeholder in this badge template text box.
The default is <Command Set>.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Data

Command Click in this field and select one of the available command sets
Set from the drop-down list. All currently defined command sets
appear in this list.
The default is <None>.

Object Properties 573

Velocity Version 3.1 Administrator’s Guide

Font

Font Click this cell and select from the combo box list the font style in
which you want the selected text to appear. Only those fonts
currently installed in this computer appear in this list.

Font Color Click this cell then click the button to change the color of the
text.
The color dialog box appears. Select the font color you need
from the dialog box. The default value is black.

Font Style Click this cell and select from the combo box list the font style in
which you want the selected text to appear.
For more on this, refer to “Font Styles” on page 595.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

574 Object Properties

 MAN006-0612

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

Object Properties 575

Velocity Version 3.1 Administrator’s Guide

Link Properties
When you drag a link object to the canvas in Graphics Mode then select it with the
Properties pane display, the Link Properties sheet appears like this example:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is Link followed by a number. You can edit
this name as required.

Object Type This is a read-only field indicating the type of object this is.

Text Click in this cell and enter the text you want to appear as a
placeholder in this badge template text box.
The default is <Link Object>.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Data

Link Click in this field and select one of the available drawings from
the drop-down list. All currently defined drawings appear in this
list.
The default is <None>.

Font

Font Click this cell and select from the combo box list the font style in
which you want the selected text to appear. Only those fonts
currently installed in this computer appear in this list.

Font Color Click this cell then click the button to change the color of the
text.
The color dialog box appears. Select the font color you need
from the dialog box. The default value is black.

576 Object Properties

 MAN006-0612

Font Style Click this cell and select from the combo box list the font style in
which you want the selected text to appear.
For more on this, refer to “Font Styles” on page 595.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Object Properties 577

Velocity Version 3.1 Administrator’s Guide

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

CCTV Call To Monitor Properties

The property sheet that appears when a CCTV Call Camera to Monitor custom link is
selected on a drawing, looks like this:

The properties in this list are defined below:

General

Name Click this cell to enter the name of this object. By default, the
name of the object is CCTV Call Camera to Monitor followed
by a number. Edit this name as required.

578 Object Properties

 MAN006-0612

Object Type This is a read-only field indicating the type of object this is.

Custom Click this cell and then click . The CCTV Call Camera to
Monitor page appears. For more on this, refer to “CCTV Call
Camera to Monitor” on page 614.
Fill out this form to indicate which switcher, camera, and monitor
is activated when the operator clicks this custom link.

Text This property only appears if the Link Template value is <None>.
Indicate the name displayed on the drawing for this custom link.
Edit this text as required.

Link Click this cell and then click to display a drop-down list of
Template available VSOs. Only those VSOs currently defined appear in this
list.
Select the VSO you want to appear instead of text for this linked
object. If you select a VSO here, the Text property is hidden. The
default is <None>.

Layer Click this cell to assign the object to a layer of this drawing. An
option list appears. Only those layers currently defined for the
drawing appear in the option list. The default value is Default.

Font

Font Click this cell and select from the combo box list the font style in
which you want the selected text to appear. Only those fonts
currently installed in this computer appear in this list.

Font Color Click this cell then click the button to change the color of the
text.
The color dialog box appears. Select the font color you need
from the dialog box. The default value is black.

Font Style Click this cell and select from the combo box list the font style in
which you want the selected text to appear.
For more on this, refer to “Font Styles” on page 595.

Position

Top Specifies the units from the top where this object begins as
measured by the ruler. To change this value, enter a new one.
The larger the value, the farther from the top of the margin this
object begins/ends; the smaller the value, the nearer the top of
the margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Object Properties 579

Velocity Version 3.1 Administrator’s Guide

Bottom Specifies the units from the bottom where this object begins, as
measured by the ruler. To change this value, enter a new one.
The larger this value, the closer to the bottom of the margin this
object is placed; the smaller this number, the farther from the
bottom margin.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Left Specify the position of the left most point of this object on the
canvas as measured by the ruler. Use this property to move,
shorten, or lengthen the object as required. The larger the value,
the farther from the left margin; the smaller the value, the closer
to the left margin.
If the value you specify exceeds the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Right Specify the distance from the right side of the canvas where this
object begins/ends as measured by the ruler. The larger the
value, the nearer to the right margin this object is placed.
If the value you specify is outside the available range—that is,
outside the canvas margins as specified by page size setup—an
error message appears.

Rotation Specify how many degrees you need to rotate this object where
0° is the current position. All positive degrees are clockwise; all
negative degrees are counterclockwise.
This attribute can also be specified using the Rotate Angle icon,
, on the Icon Tool Bar.

Appearance

Visible Click this cell and specify whether this object is visible during Live
mode (True) or is not visible during Live mode (False). The
default value is True.

Line Width Click this cell and enter a value to change the thickness of the
object's border. Select the option you need from the list where 0
= thinnest and 5 = thickest. The default value is 0 (zero).

Line Color Click this cell then click the button to change the color of the
object's border. The color dialog box appears. Select the line
color you need from the dialog box. The default value is Black.

Line Style Click this cell to change the texture of the object's border. A line
style option list appears. Select the option you need from the list.
The default value is Solid.

Fill Color Click this cell then click the button to change the color of the
object's interior. The color dialog box appears. Select the fill color
you need from the dialog box. The default value is no color.

580 Object Properties

 MAN006-0612

Fill Style Click this cell to change the texture of the object's interior. A fill
style option list appears. Select the option you need from the list.
The default value is Solid.

Back Color Click this cell then click the button to change the color of the
object's background. The color dialog box appears. Select the
back color you need from the dialog box.
The default value is gray.

Back Style Click this cell to change the texture of the object's background. A
back style option list appears. Select the option you need from
the list.
The default value is Transparent.

General Drawing Properties

In Graphics mode, each object on the canvas has its own set of properties. In addition,
each map or drawing also possesses general properties. These properties appear in the
Properties pane whenever you click on a specific map's tab at the bottom of the
canvas.
The general properties for a drawing look like this example:

There are three properties each drawing or map possesses.

General

Name Indicates the current name of the drawing.

To change the current name, click in the value field and rename
the drawing.

Default Specifies the drawing that is displayed when Designer is first

Canvas opened. Values are True or False.
If this canvas is currently default, the True value is grayed out. To
change the value of a drawing that is not currently default, click in
the value field and select the True value. The previously default
canvas is now set to False.

Object Properties 581

Velocity Version 3.1 Administrator’s Guide

Load On Start Indicates whether this canvas automatically loads into memory
when Graphics is started. Two values are available: True or
False.
If set to False, this canvas will be loaded the first time the user
or the Alarm Queue requests it. In other words, even if it does
not appear when Designer first opens, Velocity brings it up if an
object on the unloaded drawing goes into alarm.
Use this property to keep unnecessary drawings from loading
automatically. This is particularly useful if you have many
drawings currently displayed on the canvas. A drawing is set at a
True value by default.
To reset the value, click in the value field and select one of the
two available values.

Inserting Variable Field Names

There are two types of fields you can enter while specifying properties for objects in
Badge Designer:
 Standard (or constant) fields
 Variable fields
Standard fields are those fields which do not change, no matter how many badges or
drawings are produced. These include such properties as the company name and logo,
the company address, and various badge designs. Velocity simply takes the information
the qualified operator or designer specifies in the badge template and prints it onto the
card as entered.
Variable fields are those fields which change from person to person depending on the
value entered in the Personal Information Form in Enrollment Manager. These are
fields—such as the employee's name, address, title, and physical features—that change
for each employee. When Velocity spots a variable field on the badge template
assigned to this credential, it searches for the current value of the variable field as
entered on the Personal Information Form for the person assigned this credential.
Think of this process as matching variable fields on the badge template to entered
fields on the Personal Information form.

582 Object Properties

 MAN006-0612

This process is illustrated below:

Object Properties 583

Velocity Version 3.1 Administrator’s Guide

Four databound objects in Designer can employ variable properties:

Field(s) Accepting Variable Values (as determined by the Personal

Object
Variables Information form)

Text Data Field <None>

@LastFirst – last and first name fields
Picture Data Field
@TFMLS – Title, first, middle, last, and suffix fields
Photo Data Field @FirstLast – First and last name fields
@Magstripe - Card Data in Fargo Format – magstripe in the Fargo
Signature Data Field format
@Magstripe - Card Data in Eltron Format – magstripe in the Eltron
Magstripes Magstripe Data
format
Barcodes Barcode Data @Magstripe - Card Data in Magicard Format – magstripe in the
Barcode Supplement Magicard format
Barcode Comment Title – title (Mr., Mrs., and so on) as specified in the first pick list
field
FirstName – first name as specified in the second pick list field
MiddleName – middle name as specified in the third pick list field
LastName – last name as specified by the fourth pick list field
Suffix – suffix for the name (Jr. or Sr.) as specified by the fifth pick
list field
Host Activation Date – date specified in the 'Activate' fields on the
General page of the assigned credential
Host Expiration Date – date specified in the 'Expire' fields on the
General page of the assigned credential
Host Expiration Used – whether the 'Expire' box was checked on
the General page of the assigned credential
Host Description – the 'Description' text box on the General page
of the assigned credential is filled
Host Issue Number - the number in the 'Host Issue Number' field
on the Options page of the assigned credential (obsolete)
Print Control Count - the 'Count' number specified in the Print
Control section on the Options page of the assigned credential
Issue Control Count - the 'Count' number specified in the Issue
Control section on the Options page of the assigned credential
Credential ID – number specified in the 'ID' field on the General
page of the assigned credential
Card Data – number specified in the 'Data' field on the General
page of the assigned credential
MATCH – number specified in the 'MATCH' field on the General
page of the assigned credential
UDF01 - UDF36 – includes all user defined fields currently
defined in Enrollment Manager

The first six variable values, all prefixed by @, are predefined custom badge fields that
Velocity installs automatically. Qualified operators can create more of these custom
badge field s using Custom Badge Fields.
User-Defined fields link to the Personal Information form in the Enrollment Manager.
These fields can be changed to specify almost any quantifiable parameter through the
User Defined Setup dialog box.

584 Object Properties

 MAN006-0612

Before variable fields can take effect the badge template where they appear must first
be assigned to a credential through either the Credential dialog box or the Credential
Template dialog box, then that credential or credential template must be assigned to a
person.

Add Image Dialog Box

Use this dialog box to select an image for the current drawing on the canvas.

If you select the Image tool in the icon tool bar, it brings up this dialog box.
The Add Image dialog box includes these buttons and fields:

Look in: Select the directory where the image exists. By default, the program
looks in the Velocity\Images subdirectory.

Click this button to go to the last folder visited. This icon is grayed out
if this folder is the first visited.

Click this button to go up one level in the file structure.

Click this button to create a new folder at the point in the file structure
indicated by the window.

Click this button to select another option for viewing the following
window. The options include: Large icons, Small icons, List, Details,
and Thumbnails.

File This window displays the files and folders existing in the Look in:
window folder. Select the image you want from this window and it appears in
the File name combo box.

File Either enter the name of the file you want or click to select the file
Name: from the window above.

Open Click this button to open the image and display it on the canvas.

Files of Select from the drop-down option list the file format you are looking
Type: for. The Add Image dialog box supports these formats:
• JPEG (jpg)
• Bitmap (bmp)
• Metafiles (wmf or eps)
• AutoCad DXF files (dxf)

This is essentially the same dialog box as the Export File or Import File dialog boxes.

Object Properties 585

Velocity Version 3.1 Administrator’s Guide

Adding Color
In Badge & Graphic Designer, there are two ways to add color to an object on the
canvas:

Line Color a border or line.

Color

Fill Color Fill the insides of an object with color. This only applies to closed
objects like polygons, rectangles, circles, and text boxes. Lines and
polylines have no need for fill properties.

To change colors:
 Select the object, then from the Icon Tool Bar, select the Fill Color, , or Line
Color, , icons and specify the color you need.
 Select the object, open the properties pane, then use the 'Line Color', 'Fill Color', or
‘Back Color’ properties on the property sheet for the selected object and specify the
color you need.

Line Color
To color a line or border:
1. Select one or more objects to color.
2. Do one of these:
• From the icon tool bar, click the ForeColor icon, . To accept the currently
selected color, click the left part of the icon. To select a different color, click the
down arrow, .
• From the object's property sheet, click the ForeColor property field.
The color palette appears.

For more on this, refer to “Color Palette” on page 588.

3. Select the color you need from the color palette.
The border or line is changed to the selected object(s).

Fill Color
This fill feature enables you to color a closed object inside its lines, as shown in this
example:

When you fill an object with color, the line color is unaffected.

586 Object Properties

 MAN006-0612

 Only closed objects—including rectangles, polygons, ellipses, sectors, and

chords—can be filled. Lines, arcs, and polylines cannot be filled.
To fill an object:
1. Select a closed object to fill.
You can select several objects at once, if needed.
2. Do one of these:
• From the icon tool bar, click the Fill Color pull-down list, .
• From the selected object's property sheet, click the 'Fill Color' property then
click the button.
The color palette appears. For more on this, refer to “Color Palette” on page 588.
3. Select the color you need.
If the color you need is not included in this group, select More Colors... An
extended color dialog box appears.
The object is filled with the required color.

Back Color
This provides background color for a closed object, as shown in this example:

Back Color only becomes obvious when:

 the Back style is set to Opaque
 the Fill Style is NOT set to Solid
When these two conditions are met, the selected objects use Back Color as the fill
color. If a qualified operator has assigned a Fill Style of Solid, neither Back Color nor
Back Style come into play.
This property is true for all objects other than text. If you have a text object and that text
object is Multi-lined or Boxed, then Fill Style and Back style possess just the opposite
properties: Back Style will be drawn on TOP of Fill Style.
To assign color to an object's background:
1. Select a closed object.
You can select several objects at once, if needed.
2. From the selected object's property sheet, click the 'Back Color' property then click
the button.
The color palette appears.
3. Select the color you need.
4. If the color you need is not included in this group, select More Colors... An
extended color dialog box appears.
The object background is given the required color.

Object Properties 587

Velocity Version 3.1 Administrator’s Guide

Color Palette
The color palette appears whenever you request a change of color for a background,
line/border, or fill (insides) of an object in the Badge & Graphic Designer. It also
appears when you want to reassign colors for the Event Viewer.

This palette is also available to customize the looks of both the Event and Alarm
viewers.
To use the palette:
1. Bring up the color palette.
• Click on the ForeColor or BackColor property on the Property Sheet
• Click the BackColor or ForeColor icons on the Tool Bar
2. Click on one of the primary colors appearing on the palette. The palette
disappears. The specified color appears on the line or as fill on the chosen object.
• If you select Automatic, Badge & Graphic Designer selects the default color:
black for lines and white for fill.
• If none of the colors displayed fits your needs, proceed to step 3.
3. For additional color selections, click More Colors...
The Color dialog box like this example appears. For more on the Color dialog box,
refer to “Color Dialog Box” on page 588.
4. Modify colors as required using the Color dialog box.

Color Dialog Box

The color dialog box enables you to fine tune the color for your fill or line color.

This palette is available to customize the looks of the Badge Designer, as well as the
Event and Alarm viewers.

588 Object Properties

 MAN006-0612

This screen includes these fields and areas:

Basic colors: palette This displays a spectrum of basic colors available as

default on the color palette.

Custom colors: palette This presents colors that you mix using the area on the
right.

Define Custom This button is not currently active.

Colors>>

Color Chart Use this to select a color.

Color Slide Use this slide to fine tune the range of color.

Color | Solid This window displays an example of the color you are
mixing.

HSL (HSB) Color Model

Hue: Specify the hue value of the color where 0 is the least
and 160 is the greatest.

Sat: Specify the saturation value of the color expressed in

percentage where 0% is the least saturated and 100% is
completely saturated.

Lum: Specify the luminosity value of the color where 0 is no

luminosity.

RGB Color Model

Red: Specify the red component of the RGB color with 0 being
the lightest and 255 the darkest.

Green: Specify the green component of the RGB color with 0

being the lightest and 255 the darkest.

Blue: Specify the blue component of the RGB color with 0

being the lightest and 255 the darkest.

Add to Custom Click this button to add the custom color to the Custom
Colors colors palette.

 Use either Hue, Saturation, and Luminosity (HSB) or Red, Green, and
Blue (RGB) to select a color, but not both. This is because they are based
on different color models.
To customize a color:
1. At the color dialog box, move your mouse to the Color Chart.
Notice that the cursor icon changes to this, .
2. Go down the chart until you find the color you want.
An approximation will do if you don't see the exact color.
3. Click on the color. The color's value appears in both the HSL and RGB fields below
the chart.
The Color|Solid window displays an example of the color.

Object Properties 589

Velocity Version 3.1 Administrator’s Guide

4. Fine tune the color using the color slide to the left of the color chart.
a. Click on the arrow to the right of the slide.
b. Move the slide up or down. As you proceed, the values change and the
Color|Solid window displays the new color.
5. Fine tune the color still further by changing the values in the HSL or RGB fields.
6. When you're satisfied, click the Add to Custom Colors button. The new color
appears on the Custom colors palette.
7. Add other colors as required using steps 1 - 6. Each new color is added to the
Custom Colors palette.
8. From the Custom Colors palette, click on the new color you want to use.
9. Press OK.
The new color appears on the canvas.
To change a color on the Custom colors palette:
1. Click the color cell on the Custom colors palette you want to change.
2. Using the color chart, slide, and RGB/HSL value fields, create a new color.
The new color appears in the select cell on the Custom colors palette.

Color Models
There are many different color models that define colors, for example, HSB (also called
HSL), RGB, CMYK, and CIE Lab color models. The HSB and RGB models are supported
by Velocity and Badge & Graphic Designer.

HSB model
Without any light, objects all around us are colorless. Color only occurs in our minds
after our visual sensory system has seen the wavelengths that give objects their color.
Based on how people perceive color, the HSB color model endows every color with
three properties:

Hue (H) The name we give a color in everyday language. Hues form the
Color Wheel. The hue of a lemon is yellow; a strawberry's hue is
red.

Saturation (S) Refers to vividness of the color or how much color

concentration the object contains. For example, an unripe
banana possesses a less saturated yellow than a ripe one.

Brightness (B) Refers to adding or removing whiteness from a color. For

example, lemon chiffon is brighter and lighter in color than a
fully ripe lemon.

RGB model
The millions of colors your monitor produces can all be described as amounts of red,
green, and blue. These three color components form the basis for the RGB (Red,
Green, and Blue) color model. Each of the three colors is assigned a numeric value
between 0 and 255.

590 Object Properties

 MAN006-0612

The RGB model is based on colors of light, and higher RGB values correspond to the
presence of greater quantities of white light. Consequently, higher RGB values result in
lighter colors. When all three color components are at the maximum value, the
resulting color is white light. Because the RGB model creates colors by adding light, it is
called an additive color model. Monitors and scanners can employ the additive color
model because they emit light. They emit particles of red, green, and blue light and
create the illusion of millions of different colors.
One of the limitations of the RGB model is that it is device-dependent. This means that
not only are there color variations between monitors and scanners by different
manufacturers but there are color variations between identical devices from the same
manufacturer. All monitors drift over time and display colors differently making it
imperative to regularly calibrate your monitor and the other electronic devices you use
to create your projects. The RGB model cannot be a color standard because its color
results are not 100 percent repeatable.

Line Style
Line style is the texture you impart to a line. This is different from the Line Color which
fills the enclosed area of an object with a specified color.
The available line styles are shown below:

To impose a line style on object(s):

1. Select the object you want.
2. Do one of these:
• At the Property Sheet, click the 'Line Style' property.
• At the Icon Tool Bar, click the Fill Style tool, .
3. Click the button. The options list appears.
4. Select from the available options as shown in the following table:

Type Description

<None> The line is not displayed.

Solid The line is solid.

Dash The line consists of dashes.

Dot The line consists of dots.

Dash-Dot The line consists of a dash-dot pattern.

Dash-Dot-Dot The line consists of a dash-dot-dot pattern.

Inside The line is solid.

The selected line(s) assume the requested pattern.

Object Properties 591

Velocity Version 3.1 Administrator’s Guide

Fill Style
Fill style is the texture you impart to an object's fill. This is different from the Fill Color
which fills the enclosed area of an object with a specified color.
The available fill styles are shown below:

 Only closed objects—including rectangles, polygons, ellipses, sectors, and

chords—can have fill styles. Lines, arcs, and polylines cannot.
To assign a fill style on object(s):
1. Select the object(s) you want.
2. Select a fill color.
If you leave the object as white or blank, no texture appears.
3. Do one of these:
• At the Property Sheet, click the 'Fill Style' property then click the down arrow
button, .
• At the Icon Tool Bar, click the Fill Style tool, , then click the
button.
The options list appears.
4. Select from the available options as shown in this example:

All of these textures are either parallel lines or cross-hatching. These include:

Type Description Example

<None> No style. The fill is transparent. Any

object under it will show through.

Solid The fill is solid. Any object under it

will not show.

Horizontal (===) Hatching (lines) on the horizontal.

Vertical (|||) Hatching (lines) in the vertical

direction.

Diagonal Back (\\\) Diagonal lines

592 Object Properties

 MAN006-0612

Type Description Example

Diagonal Forward Diagonal lines in the opposite

(///) direction.

Cross (+++) Cross-hatching at right angles.

Diagonal Cross Cross-hatching rotated 45°.

(XXX)

The selected object(s) are filled with the requested pattern.

Editing Text
To edit text on the canvas:

Method 1
1. Enter Design Mode.
2. With the Select and Edit tool selected, click the text you want to edit. The text is
selected.
3. Do one of these:
• Right click on the text and select the Edit Text... option. The Edit Text dialog
box appears.
• Go to the text property pane and locate the 'Text' field. The current text
appears in the cell.
4. Click in the text field and make changes to the text as required.
If this is the Edit Text dialog box, you can also insert symbols as required.
5. When you're finished, do one of these:
• If this is the Edit Text dialog box, press Update.
• If this is the Text property sheet, press Enter.
The text is changed.

Method 2
1. With the Select and Edit tool selected, double click the text you want to edit.
The text cursor appears at the end of the text string.
2. Using the cursor keys, move the cursor to the location where you want the text
changed.
3. Press the Delete or Backspace keys to erase the current text.
4. Enter the new text as required.
The text is changed.

Object Properties 593

Velocity Version 3.1 Administrator’s Guide

Edit Text Dialog Box

The Edit Text dialog box looks like this:

To use the Edit Text dialog box:

1. Click to select a symbol from the symbol window and it appears in the upper text
window at the cursor point.
2. Click Update.

Changing Text Characteristics

You can change text characteristics using either the Properties pane or the Icon Tool
Bar.
To change text characteristics for one or more text objects:

Method 1
1. Select one or more text object(s) on your drawing.
2. Open the Properties pane.
The text property sheet appears.
3. Select the 'Font' property and click on the button.
The Font dialog box appears. For more on this dialog box, refer to “Font Dialog Box”
on page 594.
4. Change the font, font style, and font size as required then click OK.

Method 2
1. Select one or more text object(s) on your drawing.
2. From the Icon Tool Bar, perform one or more of these options:
• Select a new font type from the drop-down option list in the Font combo box.
• Select a new font size from the drop-down option list in the Font Size combo
box.
• Select a new font style from the drop-down Font Style option list.
• Bolden, italicize, underline, or strike through text by clicking the relevant icon.
The text properties for all the selected text objects are changed.
 When you insert new text, it automatically adopts the text characteristics
currently displayed on the icon tool bar.

Font Dialog Box

Use the font dialog box to change characteristics, such as font and size, of selected text.
This box only appears if you change font characteristics from the Properties pane.

594 Object Properties

 MAN006-0612

 Text in both text and text frame areas are effected by this dialog box.
The font dialog box looks like the following example:

When you select the Font dialog box, these fields appear:

Font: Scroll through the list of available fonts and click on one. It appears in
the 'Font:' text field. You can also type the name of the font in this field.
Once selected, a sample of the font appears in the 'Sample' field.
Note: Only those fonts currently installed on the host computer are available
for selection, and of those, only the ones that Velocity deems safe for
use with your badge printer are displayed. All other fonts are filtered
out. To import additional fonts, use the Fonts settings feature in Control
Panel.

Font Select one of the available choices from the list. These include:
style: Regular, Italic, Bold, Bold Italic.
Note: Certain fonts may not support all variations of a font style.

Size: Select one of the available sizes from the list, or type in another size.
All sizes are in points.

Sample This non-interactive field demonstrates the font type, font size, and
font style currently selected.

Script: Select the script type you need. The default is Western. No other script
type is currently available.

After you've specified the font you need, click OK and the font characteristics specified
here are reflected in the drawing.

Font Styles
This options determines how text printed in text boxes behaves. This font styles combo
box appears on icon tool bar, .

Object Properties 595

Velocity Version 3.1 Administrator’s Guide

The available options are:

Standard Font size is determined by the height of the text box. To increase
font size, pull the text box handles. Text only takes up the space
needed.
There are no line or fill properties associated with this style.

Bounded Font size and text spacing are determined by the dimensions of
the text box.
• To increase the font size, increase the height of the text box. To
decrease the font size, decrease the height of the text box.
• To increase the text spacing, increase the width of the drawn
box. To decrease the text spacing, decrease the width of the
drawn box. The text compresses or expands to fill the available
area.
Use the text box handles to increase or decrease the text box size.
The text cannot go beyond box borders. If the text box width is too
small to accommodate the text, it squeezes the text.
There are no line or fill properties associated with this style.

Multiline Font size is determined by the 'Font Size' combo box. Text can
word-wrap within the text box. Carriage returns can be added by
editing existing text. If there is too much text for the text box, the
text box increases in height to accommodate it. Use the text box
handles to increase the size of the area for text; the font size stays
the same.
This is one of two styles that enables you to assign fill color or fill
patterns to the text box. The other one is Boxed.

Boxed Font size is determined by the ‘Font Size’ combo box. Text has a
croppable border around it. By decreasing the size of the text box,
you hide (crop) all text that is beyond the text box. This style does
not allow multiline text.
This is one of two styles that enables you to assign fill color or fill
patterns to the text box. The other one is Multiline.

You can only use this option in Design mode.

Bleeding Edge Text

Most of the time, you will want to keep text within the margins set by the grid settings.
However, there are several badge printers which allow you to print to the very edge of
the badge, overstepping the margins as required. This process of going to the very
edge of the badge is called 'bleeding' and is supported by the Badge Designer module.
To move text to the absolute edge of a badge:
1. Insert the text object as required.
2. Move the text object to the margin.
3. Turn off the 'Snap to Grip' option.
4. In the text property sheet, change the position value as required.

596 Object Properties

 MAN006-0612

Exporting Drawings
You can export badge templates, drawings, and other objects from Designer to other
formats using the Export to File... option. This enables you to take graphics and badges
from the Velocity database and export them as individual files in a number of different
formats.
Designer can export Velocity graphics and badges as the following file formats:
 BMP
 WMF
 EMF
 JPG
 DXF (AutoCad)
In addition, the Export from File feature can store files in the following proprietary
Velocity formats:
 VBD (Velocity drawing Files)
 VBT (Velocity Badge Templates)
 VIO (Velocity Integrated Objects)
 VSO (Velocity Standard Objects)
To export a file:
1. Display the drawing, badge template, or object you want to export on the canvas.
2. Do one of these:
• From the menu tool bar, select File > Export to File...
• Right click on the Drawing Selection Tab of the drawing you want to export
and select Export to File... from the option list.
• From the Directory pane, right click on the drawing you want to export and
select Export to File... from the option list.
• From the Object Library, right click on the drawing you want to export from
either the VIO or VSO folder and select Export to File... from the option list.
The Export File dialog box appears like this example.

The current name of the drawing appears in the 'File name:' field.
3. Designate the computer, drive, and directory where you want the drawing stored.
By default, Velocity exports drawings to the GraphicFiles subdirectory under Hirsch
Electronics\Velocity.
4. In the 'File name:' field, either accept the current name or enter a new name for
this drawing.
If you specify Metafiles in the 'Save as type' combo box, you can designate
whether you want this file saved as .emf or .wmf by entering an extension.

Object Properties 597

Velocity Version 3.1 Administrator’s Guide

5. In the 'Save as type:' field, specify the file format in which you want this drawing
stored.
By default, drawings are saved as vbd files while badges are saved as vbt files. You
can save files in the following file formats:

Velocity Drawing Files Saves in vbd format that can be read directly by any
(*.vbd) Velocity system. This is the default export for all
drawings.

Velocity Badge Saves in vbt format that can be read directly by any
Templates (*.vbt) Velocity system. This is the default export for all
badge templates.

Velocity Integrated Saves in vio format that can be read directly by any
Objects (*.vio) Velocity system. This is the default export for all
integrated objects.

Velocity Standard Saves in vso format that can be read directly by any
Objects (*.vso) Velocity system. This is the default export for all
standard objects.

JPEG (*.jpg) Saves in jpg format that can be imported by almost

any program. This standard file format is good for
photographs.

Bitmap (*.bmp) Saves in bmp format that can be imported by

almost any program.

Metafiles Saves in either wmf or emf format that can be

(*.wmf;*.emf) imported by many programs. This provides vector
drawing format for many drawing programs. If you
don't specify an extension in the 'File Name' field,
the file is saved as wmf. To specify emf, enter the
.emf file extension on the File name.

AutoCad (*.dxf) Saves in dxf format that can be read by any

AutoCad compliant program. This provides fine
detail for all blue prints and drawings.

6. Click Save.
The image is exported to the designated location.
 The proprietary Hirsch drawing format (.hir) used in Version 2.0 is no
longer supported in Version 2.5 and later.

Support for AutoCad

Velocity's Badge & Graphic Designer supports both the import of AutoCad files in the
DXF format and the export of Velocity drawings to the DXF format. However, certain
limitations and conditions apply to the import and export of these files.

598 Object Properties

 MAN006-0612

AutoCad File Import

Designer supports the reading of 2-d DXF files as generated by AutoCad versions 10
through 14. The Designer import utility recognizes the following DXF record types:

• point • line • rectangle • polyline

• arc vertex • arc • circle • ellipse

• text • mtext • solid • xline

• ray • lwpolyline • insert (block)

However, Designer does not support the following records:

 Trace
 Dimension lines
Velocity recognizes the following DXF object attributes:
 Line Width
 Color
 Angle
 Extended Data (XDATA is represented as object tags)
However, Line Type is not supported.
Designer also imports using the following rules:
 All text primitives are converted into text objects of the appropriate size using the
default font name setting.
 Text attributes (font, bold, italic, underline) are recognized only for MTEXT records.
 Point objects are interpreted as Line objects where the starting and ending points
are the same.
 Polylines are converted into a set of lines and arcs.
 Straight line segments will be converted to standard PolyLines objects.
 Curved lines will be converted to arcs.
 Polygons are treated as Closed PolyLines.
 All objects are recognized as Transparent (HATCH records are not supported).
 All objects are represented as a single layer. Multi-layer environment is not
supported. Frozen Layers are not supported.

DXF File Export

The Designer file export utility provides two modes of DXF export support:
 “Draft” DXF files - These are basic DXF files compatible with most versions of
AutoCAD. But objects in such DXF files can lose some attributes.
 “Enhanced” DXF files - Compatible with AutoCAD version 14 only. In this mode
Designer makes use some of the newer features of DXF format to preserve the
image as created in Designer to the maximum extent possible.
Both Draft and Enhanced modes have the following limitations:
 All Designer objects (except Polyline and Polygon) have the same line width - 1
pixel;
 The Line Style for all Designer objects (except Polyline and Polygon) is always
SOLID (DASH and DOTTED styles are not supported).

Object Properties 599

Velocity Version 3.1 Administrator’s Guide

 Designer objects have no fill and are represented as TRANSPARENT (except

Polygon);
 Designer does not support multiple layers in DXF file, so all objects are presented in
one layer.
 Grouping of objects (container definitions) are not preserved from the Designer
picture to DXF output. All Designer containers will be ungrouped while exporting.
 Colors of Designer objects will be approximated to a nearest color in predefined
color table (8 standard colors).
 Bitmaps are ignored (they will be excluded from the saved file)
 Links are converted to polyline objects (the nature of automatic link is not
preserved)
 HotSpot information is not preserved on Export to DXF format, nor are
ObjVisible nor ObjURL properties.
The following features are available in the enhanced export mode only:
 Filling of a polygon can be stored to a DXF file (solid colors only). In DXF file it is
represented as a HATCH object;
 Line width and style (DOTTED and DASHED) of a polygon/polyline can be stored in
a DXF file;
 The following text object attributes are stored in MTEXT record: FontName,
FontBold, FontItalic, FontUnderlined. In Draft mode, Designer only stores text size
and rotation angle for text objects. All other text attributes (font names, bold, italic)
will be lost.
 All text objects will be stored as multi-line text (stored with their boundaries). In
draft mode all MultiLine text objects will be converted to single line text objects in
DXF format.

600 Object Properties

 MAN006-0612

Advanced Procedures
This sections covers in detail the more advanced procedures Designer can perform.

Badge & Graphic Designer Options

When you select Tools > Options from the Designer menu tool bar, the General page
of the options dialog box appears like this example:

The General page fields are:

Show Canvas Check this box to indicate that the canvas tabs appear at the
Tabs bottom of the canvas. This is the default setting.

Categorized Check this box to categorize properties in the Property pane. This
Properties means that properties appear in the pane under their respective
category: Appearance, Misc, Position, and so on. This is the
default setting.

Show Check this box to display automatically any object in alarm within
Graphics on its graphic. If an object, such as a door or reader, that has been
Alarm placed on a graphic (see page 605), issues an alarm, checking
this box enables Velocity to pop up the graphic with the alarmed
object on it.

Ignore State Check this box to ignore state changes registered by the Graphics
Changes module.
When enabled, this provides better performance while using
Graphics (or any other Velocity module that happens to be open
at the moment) by eliminating delays when clicking on different
maps. This essentially turns the Graphics module into an
alarm-only annunciator with no state change events displayed on
doors, inputs, readers, and relays. The VIOs still flash alarms and
all the usual right click functionality is still there, but the speed of
the drawing package is greatly increased.

Advanced Procedures 601

Velocity Version 3.1 Administrator’s Guide

The Defaults page looks like this example:

The Defaults page controls the colors that appear on the canvas for these items:

Ruler Color

BackColor: Defines the background color for the ruler. To change it, click the
color box and the color dialog box appears. Select another color as
required.
The default color is gray.

Control Zone Defaults

Alarm: Defines the color shown when the control zone is in alarm. To
change it, click the color box and the color dialog box appears.
Select another color as required.
The default color is red.

Secure: Defines the color shown when the control zone is secure. To
change it, click the color box and the color dialog box appears.
Select another color as required.
The default color is green.

Masked: Defines the color shown when the control zone is masked. To
change it, click the color box and the color dialog box appears.
Select another color as required.
The default color is yellow.

602 Advanced Procedures

 MAN006-0612

Unknown: Defines the color shown when the control zone is unknown. To
change it, click the color box and the color dialog box appears.
Select another color as required.
The default color is gray.

Default Font

Defines the font used throughout the Designer unless otherwise

specified in individual properties. Click this button and the Font
dialog box appears. Select the default font.
The selected font appears in the window. The default font is Times
New Roman.

Map Hierarchies
Maps and other graphics in the Graphics module can be ordered in such a way as to
create dependencies. In this way, the top-level map can comprise several second-level
maps which, in turn, can consist of several third-level maps and so on.
The purpose of this hierarchy is to enable the operator to drill down from a top-level
map to increasingly greater detail as shown in the following example:

As shown in this example, the hierarchy for this company has been divided into four
levels, where:
 the top level is the Site map, consisting of two buildings
 the second level maps consist of the general floor layouts for both buildings
 the third level maps show individual floors for each building

Advanced Procedures 603

Velocity Version 3.1 Administrator’s Guide

 the fourth level maps divide each floor into its constituent rooms and areas
In this way, an operator reacting to an alarm can quickly and easily drill down from the
site map to a room map showing the exact place where the alarm is taking place. This
ensures that no matter how large or intricate the secured area is, the specific source of
an alarm can be isolated in a matter of seconds.

Linking Drawings
This technique is particularly useful for linking maps and floor plans.
Once you've imported or created the drawings you need, you can link them so that the
operator can drill down to the needed level, or drill up from a lower level to a higher
level.
To link maps:
1. Display the top-level map on the canvas.
2. Display the Object Library pane.
3. Enter Design Mode.
4. From the Object Library pane, expand the VIO folder.
The Special subfolder appears.
5. Expand the Special folder.
The Link object appears like this:

Link object

6. Drag the Link object, , from the Object Library pane to the canvas.
Place the Link object wherever you think it belongs. By default, the object appears
on the canvas as a blue underlined text string.
The linked object looks like this example:

7. If needed, change the position as required using either the mouse or the cursor
keys.
8. Click on the new link object. The properties page for the link object appear like this
example:
9. With the link object still selected, display the Properties pane.
The Link Properties appears. For more on link properties, refer to “Link Properties”
on page 576.
10. Click the 'Link Data' field and a combo box appears.
11. Select the drawing to which you want this primary drawing linked from the combo
box drop-down list.
Only those graphics currently existing as drawings in the Velocity database appear
in this list.
12. If required, click in the 'Text' row and enter a new name for this link.

604 Advanced Procedures

 MAN006-0612

It's a good idea to provide some short description of the map/graphic to which this
object is linked, like 'Basement' or 'Level 6'.
13. Change other properties on this sheet as required.
14. When you're finished, save the changes you've made to this drawing.
The two drawings are now linked.
Test your link before proceeding.
Once you return to Live mode, you can click on the specified area and the program
takes you to the linked map.

Testing Links
Once you have linked maps, you can test the links by doing this:
1. Go to the Live mode.
2. Move to one of the link objects, .
The cursor arrow should change to a finger icon.
3. Click on the object. It should jump to the linked graphic.

Placing Objects on Drawings

Once you have created or imported the required drawing, you can place objects on
drawings (normally, maps) as required.
 You cannot populate maps with objects unless there are components
already defined for the system; if nothing has yet been defined, nothing
appears in the Object Library pane under the Topology folder.
To place objects on a drawing:
1. Display the drawing you want to populate.
2. If not already done, click the icon on the Icon Toolbar to open the Object
Library pane.
3. Go into Design Mode.
4. Expand the Topology folder within the Object Library.
All the components currently defined for this system are shown in the underlying
tree structure like this example:

5. Expand the device folders until the components (objects) you need to place are
displayed.
For example, if you want to place a door on the drawing, expand the Doors
subfolder.
If you have a CCTV system installed and configured, you can also place cameras
on a map. For more on this, refer to “Placing Cameras” on page 607.

Advanced Procedures 605

Velocity Version 3.1 Administrator’s Guide

6. Drag the required component from the selected folder to the drawing and position
carefully where you want it.

Hint To position the icon correctly, move your cursor so that the cursor arrow points at
the exact spot where the icon will be. The icon symbol attached to the arrow
doesn't indicate the exact place where the icon is placed: the end of the arrow is
the correct spot.

7. Release the mouse button.

If there is more than one symbol available for this type of device, the VIO Selector
dialog box appears asking you what type of VIO symbol you want placed like this
example:

8. From the option box, select the Object Type you want.
If you always want this component plotted as the designated object type, check
the 'Always plot this VIO for this Object Type' box. Once you've done this, the only
way to show the VIO Selector screen again is by choosing 'Query?' from the
Topology Object Mapping feature.
You can train a VIO to display one icon, present the VIO Selector screen, or
perform some other action through the Topology Object Mapping feature.
9. Click OK.
The appropriate icon is anchored at the position you specified.
10. Click to select the new object and use the handles to resize the object to fit your
drawing.
11. Reposition the object, as needed, using either the mouse or cursor keys.
12. For fine tuning aspects of the object, open the Properties pane and change values
on the Velocity Integrated Object property sheet as required.
For more on this, refer to “Placed Object Properties” on page 547.
13. If needed, you can change other aspects of the object by right clicking on the
object.

606 Advanced Procedures

 MAN006-0612

An option list appears like this example:

14. Select from the pop-up option list:

Delete Delete the selected object.

Set As Since one device can be placed on several maps, this indicates
Primary the map to which Velocity will automatically go if the object
goes into alarm.
For example, if you place Door 1 on three different maps, you
can set Map 1 as the primary. Then, if Door 1 detects an illegal
entry, Map 1 automatically appears on the canvas with the
Door 1 alarm icon displayed.

Configure Select this option to bring up the corresponding configure

Device... screen for that device. Use this option to jump to the
corresponding property sheet for this object and enable that
function.
For example, if you select this option for a reader, the Reader
Properties screen for that reader appears.
Note: In order for an input to display state changes on the drawing,
you must first enable state change reporting for that object.
See Step 13.

Enable state change reporting for the inputs specified. To do this:

a. Bring up the State Change Reporting page of each input, expansion input, or
door input you want placed on this map.
b. On the State Change Reporting page, check the box of each contact or mask
state for which you want state change reporting.
c. When you're finished, click OK.
15. Repeat Steps 5 - 13 for each additional point you want to place on the map.
16. Save changes to the map.
17. Select Live Mode to return to real-time monitoring.

Placing Cameras
One of the objects you can place on a drawing is a camera. However, there are three
types of cameras:
 Analog CCTV cameras
 Digital network cameras
Each type requires a different placement method.

Advanced Procedures 607

Velocity Version 3.1 Administrator’s Guide

 Before you can place cameras on a map, you must first define a CCTV or
DVR subsystem. For more on this, refer to “CCTV Configuration,” starting
on page 657 or “DVR / NVR Configuration and Usage,” starting on page
717.

Placing Analog Cameras

To place analog cameras on a drawing:
1. Display the drawing you want to populate.
2. If not already done, click the icon on the Icon Toolbar to open the Object
Library pane.
3. Go into Design Mode.
4. Expand the Object Library folder.
5. Expand the Topology folder until the Interfaces Configuration folder appears.
6. Expand the Interfaces Configuration folder until cameras appear like this example:

No components will appear under the Interfaces Configuration folder unless you
have previously defined a CCTV system for Velocity including CCTV port, switcher,
and cameras, or a DVR subsystem.
7. Drag the camera you need from the Object Library pane to the drawing and
position where you want it.
8. Release the mouse button.
The VIO Selector dialog box appears like this example:

9. From the option box, select the camera type you need:
• If this is a dome CCTV camera, select CCTV Dome Camera
• If this is a fixed CCTV camera, select CCTV Fixed Camera
• If this is a fixed DVR camera, select DVR Fixed Camera
• If this is a domed DVR camera, select DVR Dome Camera
Only those options specific to the camera type appear in the pull-down list.
10. Click OK. The appropriate camera icon is placed on the drawing.
11. Click to select the new camera and use the handles to resize the object to fit your
drawing.
12. Reposition the object, as needed, using either the mouse or cursor keys.

608 Advanced Procedures

 MAN006-0612

13. For fine tuning aspects of the object, open the Properties pane and change
Camera Properties sheet as required.
14. If needed, you can change other aspects of the object by right clicking on the
object.
An option list appears like this example:

15. Select from the pop-up option list:

Delete Delete the selected object.

Set As Since you can place the same camera on several maps, this tells
Primary Velocity which map to show if the camera is activated.

Configure Select this option to bring up the corresponding configure

Device... screen for that camera. Use this option to jump to the
corresponding property sheet for this camera and enable that
function.
For example, if you select this option for a camera, the CCTV
Camera Properties screen for that camera appears.

16. Repeat Steps 6 - 15 for each additional point you want to place on the map.
17. Save changes to the map.
18. Select Live Mode to return to real-time monitoring.

Placing Digital Cameras

Currently, Hirsch supports several types of Axis Network Digital cameras.
To place digital network cameras on a drawing:
1. Open Velocity.
2. Open Graphics.
3. Create a new drawing, import an existing drawing, or display an existing drawing.
4. Open the Object Library and expand the VIO folder until the Custom Links
subfolder appears.
5. Right click the Custom Links subfolder and select the Custom Link Manager
option.
For more on custom links, refer to “Custom Links” on page 613.

Advanced Procedures 609

Velocity Version 3.1 Administrator’s Guide

The Custom Link Component Manager screen appears like this example:

6. Click Install.
The Find Custom Link Component appears like this example:

7. Locate and select the AXISLink.CLO file in the GraphicsFiles subdirectory.

8. Click Open.
The new custom link appears in the Custom Link Component Manager like this
example:

9. Close the Custom Link Component Manager.

The Custom Links folder in the Object Library should now contain a new
component, AXIS Digital Camera Viewer, like this example:

Notice the new AXIS Digital

Camera Viewer custom link is
added to the Custom Links
folder.

610 Advanced Procedures

 MAN006-0612

 Make sure you are in Design Mode (press Ctrl + D) or the custom link
won’t show.
10. Drag the AXIS Digital Camera Viewer to the required spot on the map or drawing.
The link appears on the drawing like the following example:

The custom link

appears in its
default form like
this.

11. Click on the link then open the Properties window, if it isn’t already open.
The Properties page looks like this example:

Click in the Custom cell and

specify the IP address of the
camera.

12. In the ‘Name’ field, change the camera name as required.

13. In the ‘Custom’ field, click the button and the AXIS Digital Camera Properties
dialog box appears like this:

14. In the ‘Address’ field, enter the IP address of the camera without the http:\ prefix.
15. If required, in the ‘Caption’ field, enter the text you want to appear in the viewer
title bar.
16. Click OK.
17. Make any other changes to the properties sheet as required.

Advanced Procedures 611

Velocity Version 3.1 Administrator’s Guide

18. When you’re finished, save the drawing.

19. Switch to Live Mode (Ctrl + D again).
20. Click on the camera link.
The camera viewer appears like this example:

Placing Command Sets

You can place command sets on maps and other drawings in the same way you place
objects and components. Once placed, you can execute a command set by clicking on
the command set object.
To place command sets:
1. If not already done, define the required command sets.
2. In Designer, either display an existing graphic or create a new graphic.
3. Go into Design Mode.
4. Open the Object Library.
5. Expand the VIO folder.
The Special folder appears.
6. Expand the Special folder.
The Link and Command Set objects should appear.
7. Drag the Command Set object, , to the canvas and place it where you
need it.
8. Reposition the object as required.
9. Open the Properties pane associated with this object.
All the Command Set properties currently assigned to this object appear.
10. Click the 'Command Set' field and select a previously-defined command set from
the drop-down option list.
11. Click the 'Text' field and enter a name for this command set.
12. Fill in any other property fields as required.
13. Press Enter.
Once this is done, you can return to Live Mode and execute a command set from the
placed object on the drawing whenever you require.

612 Advanced Procedures

 MAN006-0612

Custom Links
A custom link enables you to incorporate special devices, such as digital cameras and
specialty equipment into a Velocity system. This feature enables the qualified operator
to place, configure, monitor, and control these devices, no matter what communication
protocols they use. Think of it as an extension of command sets, where the commands
used are specific to the device, not DIGI*TRAC or Velocity.
The Custom Links must be loaded onto the Designer before they can be placed.
To install a custom device:
1. Copy a file with the CLO (custom link object) extension to a directory on your hard
drive.
Some CLO files are offered by the device companies. Other files must be written
by the programmer. These files include instructions for addressing the device and
making it perform one or more operations.
2. Go to the Object Library and expand the VIO folder to display the Special subfolder.
3. Expand the Special subfolder to reveal the Custom Links subfolder like this
example:

4. Right click on the Custom Links subfolder. A pop-up option list appears.
5. Select Manage Custom Link Components.
The Custom Link Manager appears. For more on this, refer to “Custom Link
Manager” on page 618.
All currently-defined custom components appear in the window.
6. Click Install.
The Find Custom Link Component dialog box appears like the following example:

7. Locate the directory to which you copied the desired CLO and select it.
8. Click Open.
The new component is added to the window.
9. Click OK again.
The custom link component now appears under the Custom Links subfolder.

Advanced Procedures 613

Velocity Version 3.1 Administrator’s Guide

CCTV Call Camera to Monitor

This custom link enables a qualified operator to place an icon on a drawing that, when
clicked, directs the attached CCTV system to display a specific camera view on a
specific monitor. This provides a quick way to direct attention to an area where an
alarm has been issued.
To place (plot) and set up a CCTV Call Camera to Monitor custom link:
1. Open Velocity.
2. Open Graphics.
3. Create a new drawing, import an existing drawing, or display an existing drawing.
4. Open the Object Library and expand the VIO folder until the Custom Links
subfolder appears.
5. Right click the Custom Links subfolder and select the Custom Link Manager
option.
The Custom Link Component Manager screen appears. For more on this, refer to
“Custom Link Manager” on page 618.
6. Click Install.
The Find Custom Link Component screen appears like this example:

7. Locate and select the CCTVCallToMonitorLink.CLO file in the Custom Links

subdirectory.
8. Click Open.
The new custom link appears in the Custom Link Manager.
9. Close the Custom Link Manager.
The Custom Links folder in the Object Library should now contain a new
component, CCTV Call Camera to Monitor, like this example:

Make sure you are in Design Mode (press Ctrl + D) or the custom link won’t
show.
10. Drag the CCTV Call Camera to Monitor object to the required spot on the map or
drawing.

614 Advanced Procedures

 MAN006-0612

The link appears on the drawing like this example:

11. Click on the link to view the Properties pane.

The CCTV Call Camera to Monitor properties appear. For more on this, refer to
“CCTV Call To Monitor Properties” on page 578.
12. Make changes to the various properties as required
13. In the ‘Custom’ field, click the button and the CCTV Call to Monitor page
appears like this example:

The screen includes these fields:

Switcher Select the CCTV Switcher attached to the camera you

want to use.
Only those CCTV switchers currently configured for this
system appear in this list.

Camera Select the CCTV camera connected to the designated

switcher you want to view.
Only those CCTV cameras currently configured for this
switcher appear in this list.

Monitor Select the monitor on which you want to view the

selected camera's video.
Only those monitors currently configured for this CCTV
system and switcher appear in this list.

Default Click Behavior

Advanced Procedures 615

Velocity Version 3.1 Administrator’s Guide

Automatically Click this radio button to indicate that when the operator
call the camera clicks on this custom link, the designated monitor
to monitor automatically switches to the designated camera's view.
This is the default selection.

Prompt the user Click this radio button to indicate that before the operator
for the is allowed to view the camera video on the designated
camera/monitor monitor that a prompt is issued. The operator must select
each time the proper camera and monitor before the video actually
appears.

14. Assign the CCTV switcher, camera, and monitor you require.
15. Click OK.
16. Make any other changes to the properties sheet as required.
17. When you’re finished, save the drawing (Ctrl + S).
18. Switch to Live Mode (Ctrl + D again).
19. Click on the CCTV camera link.
The specified CCTV monitor now displays the video coming from the designated CCTV
camera.

Quick Link Viewer

The Quick Link Viewer enables qualified operators to view video from any source on
the network.
To place and set up a quick link viewer object:
1. Open Velocity.
2. Open Graphics.
3. Create a new drawing, import an existing drawing, or display an existing drawing.
4. Open the Object Library and expand the VIO folder until the Custom Links
subfolder appears.
5. Right click the Custom Links subfolder and select the Custom Link Manager option.
The Custom Link Manager screen appears. For more on this, refer to “Custom Link
Manager” on page 618.
6. Click Install.
The Find Custom Link Component appears.
7. Locate and select the QuickLink.CLO file in the GraphicsFiles subdirectory.
8. Click Open.
9. Close the Custom Link Component Manager.
The Custom Links folder in the Object Library should now contain the new Quick
Link Viewer component.
Make sure you are in Design Mode (press Ctrl + D) or the custom link won’t
show.
10. Drag the Quick Link Viewer to the required spot on the map or drawing.
11. Click on the link then open the Properties pane, if it isn’t already open.

616 Advanced Procedures

 MAN006-0612

The Quick Link Viewer Properties page appears.

12. In the ‘Name’ field, change the viewer as required.

13. In the ‘Custom’ field, click the button.
The Quick Link Viewer Properties sheet appears like this example:

14. In the 'Page' field, enter the page you want to link then click OK.
The web page address must follow this format:
http://computername/pagename.html
For example: http://bralston/index.html or http://www.hirschelectronics.com.
Cite any page you require, whether internet or intranet, as long as your system
allows access. Local instruction pages are often saved to the Hirsch WebRoot
subdirectory from where they can be referenced as required.

Hint The easiest way to insert the web page name you want is to use your browser to
navigate to the page you need then copy the address from the address field in the
browser to the 'Page' field.

15. Click OK.

16. Make any other changes to the properties sheet as required.
17. When you’re finished, save the drawing (Ctrl + S).
18. Switch to Live Mode (Ctrl + D again).
19. Click on the viewer link.

Advanced Procedures 617

Velocity Version 3.1 Administrator’s Guide

Custom Link Manager

The Custom Link Manager looks like this example:

This screen incorporates these features:

Custom Link This window displays all of the currently installed custom link
Component components. Three columns appear:
window Custom Link Component — the name of the component
Description — a brief description of the component's purpose
Location — the current workstation where this component
resides
To install and display additional components in this window,
click the Install button.

Install Click this button to bring up the Find Custom Link Component
screen like this example:

Use this screen to select and import the custom link

component you want to use. Once installed, the component
appears in the Custom Link Component window.
The preceding screen shows the three custom link
components (CLO) currently installed by Velocity. They
include:
• AXIS camera link
• CCTV Call-to-Monitor link
• Quick link viewer

618 Advanced Procedures

 MAN006-0612

Uninstall Click this button after selecting a component in the Custom

Link Component window to remove that component from the
window. You are prompted to confirm you selection. If you
select Yes, this component is automatically uninstalled.

Close Click this button to close the Custom Link Manager screen and
return to the Graphics module.

Designing a Velocity Object

While Velocity comes with an assortment of Velocity objects. These objects are of two
types:
 Velocity Integrated Objects (VIO)
 Velocity Standard Objects (VSO)
All members of the third Velocity object, the Velocity Databound Object (VSO), are
fixed objects and cannot be added to or changed.

Adding VSOs to the Object Library

While there are several shapes included in the VSO folder under the Object Library, you
can draw and add more using this procedure.
To add a new VSO:
1. Open Designer in Graphics Mode.
Make sure the Object Library pane is displayed.
2. From the Object Library pane, right click the VSO Folder and select New > Object.
The New VSO dialog box appears like this example:

3. Name the VSO as required in the text field then click OK.
A new canvas appears on the drawing board. This canvas is small, 0.535 x 0.535
inches. If you need to change the size of this canvas, refer to the Page Size page in
Page Setup on page 442.
4. Design and draw the shape you want to add on this canvas.
5. Save the object.
A new VSO is listed under the VSO folder.
You can also create new folders to hold VSOs.

Adding VIOs to the Object Library

To add a new VIO:
1. From the menu tool bar, select Modes > Graphic.
2. Display the Object Library pane.
3. Right click on the VIO (Integrated) folder in the Object Library pane.

Advanced Procedures 619

Velocity Version 3.1 Administrator’s Guide

An option list appears:

4. Select New > Object.

The New VIO dialog box appears like this example:

5. Enter a new name for this VIO object.

6. Click OK.
A new object appears under the VIO folder like this example:

A blank drawing frame appears on the canvas. Notice that this canvas is much
smaller than most Badge or Graphic frames, 0.525 x 0.525, because Velocity
objects are normally icons or small shapes.
7. If not already done, display the Properties pane.
8. From the Object Library, select the new VIO. A property sheet like this example
appears in the Property pane:

9. From the Properties pane, specify the VO Type this object resembled.
For example, if this is a turnstile, you would designate the object as a door, since a
turnstile is a type of door.

10. Enter Design Mode.

620 Advanced Procedures

 MAN006-0612

11. Draw the new object using the Designer drawing tools much as you would a new
drawing.
 Often, you can save time by selecting an existing VIO icon, then make
the required changes to it, then saving it as a new icon. Also, you can
save your eyes by zooming in on the canvas.
12. Draw a bounding rectangle or circle around the object you've created.
This object is required if you created permutations of this object with the
Integration Builder. Velocity uses this bounding object to maintain its aspect ratio.
 Name each shape you create with an appropriate title, such as 'spoke',
'door', or 'contact'. These names can prove useful when defining
behavior for the object later on.
13. From the Properties pane, fine tune changes to each component of the new VIO
as needed.
If you are intending to provide the bounding object (mentioned in Step 8) with the
ability to flash, you must supply the value AlarmFlash in the 'Name' field. The
AlarmFlash value tells Designer that a specified change in state causes this part of
the VIO to flash. For more on this, refer to “Using the Integration Builder” on page
628.
14. Save the object.
The object now appears in the Object Library under the VIO folder.
15. If needed, drag and drop the object into one of the Object Library subfolders.
16. From the Object Library, click on the new object.
The general properties for the object appear in the Properties pane like this
example:

This is different from the properties you see while designing the object on the
canvas in design mode. This indicates the properties for this interactive object as it
applies to system components.
17. At the 'Name' field, enter a name for this object.
18. At the 'VO Type' field, select an option from the drop-down option list that indicates
the type of device this object will be associated with.
For example, if you have designed a symbol that represents some kind of door (for
example, a turnstile or elevator door), you would select Door from the 'VO Type'
drop-down option list. Each device type is included in this list.
19. Customize the behavior of this object using the Integration Builder.
This is a process by which you can change aspects of the original symbol (shape,
color, etc.) in order to represent different states that might exist with the associated
device. Integration Builder then instructs Velocity to display this modification on the
drawing as the state of the associated device changes.
20. Save the new object.

Advanced Procedures 621

Velocity Version 3.1 Administrator’s Guide

The object appears in the Object Library.

Adding New Folders to the Object Library

Both the VIO and VSO folders enable qualified operators to add new subfolders to the
Object Library pane.
To add a subfolder to the Object Library:
1. Open Designer in Graphics Mode.
Make sure the Object Library pane is displayed.
2. From the Object Library pane, right click either the VIO or VSO folder and select
New > Folder.
A new folder appears under the selected folder with its default text, New Folder,
highlighted as shown in the following example:

3. Change the name of this folder as required then click outside the highlighted area.
The new subfolder now appears under the main VIO or VSO folder like this example:

 The Topology folder in the Object Library pane does not support the
addition of folders. Folders must be added to this hierarchy through the
Administration System Tree pane.

Editing Velocity Objects

Two types of Velocity objects are available for editing:
 VIOs
 VSOs
 This is only available through Graphics mode.
A third type of Velocity object, the databound object (VDO), cannot be edited and is
not presented here. It is only available in Badge mode.
To edit an existing VIO:
1. From the menu tool bar, select Modes > Graphic.
Only those functions associated with the creation and modification of drawings are
displayed.
2. Open the Object Library.

622 Advanced Procedures

 MAN006-0612

3. Expand the VIO (Integrated) folder to reveal the existing object you want to modify.
4. Click to select the VIO you want to edit.
5. If necessary, open the Properties pane.
6. In the Properties pane, edit the Name and/or VO Type as required.
7. If required, right click on the object you want to modify.
An option list appears with the Edit option activated.
8. Select Edit.
The object appears on the canvas along with the Integration Builder.
9. Modify the object's behavior as required using the Designer drawing tools and the
Integration Builder.
10. Save the modified object.
To edit an existing VSO:
1. From the menu tool bar, select Modes > Graphic.
Only those functions associated with the creation and modification of drawings are
displayed.
2. Open the Object Library.
3. Expand the VSO (Standard) folder to reveal the existing object you want to modify.
4. Click to select the object you want to edit.
5. If necessary, open the Properties pane.
6. In the Properties pane, edit the properties as required.
7. If required, right click on the VSO you want to modify.
An option list appears with the Edit option activated.
8. Select Edit.
The object appears on the canvas.
9. Modify the object as required using the Designer drawing tools.
10. Save the modified object.

Integration Builder
The Integration Builder (IB) enables a qualified operator to:
 create new integrated objects (VIOs) and define their behaviors
 change behaviors for existing integrated objects
The IB enables you to set up cause-and-effect mechanisms for each icon you draw:
when a cause happens, an effect takes place.
For example, say we want to turn our Door red when a Forced Entry occurs at it. Within
our Door VISO, we have 3 different sub-objects (the two sides of the door jamb and
the door itself). We could attach a Cause that specifies an Event ID of 5001(Forced
Entry at Input%).
We don't need a Check, so we ignore that for now (the Check is discussed later). For
the Effect, all we need is a valid sub-object, and an action to perform on it. In this case,
we would pick the door sub-object, and pick the ChangeFillColor Action with a red
parameter.
Now, whenever a Forced entry happens at this door, the door will turn red. Obviously
this is only half of the functionality, because we need to change the door back to white
at some point, or the door will always stay red once the first Forced Entry happens.
 One Cause can have multiple Effects.

Advanced Procedures 623

Velocity Version 3.1 Administrator’s Guide

There are two methods for opening Integration Builder. Use the first method to work
on master VIOs; use the second method to edit an individual VIO once it has been
dropped on the canvas.
If you work on individual VIOs, changes to their properties won't be propagated to the
other VIOs of the same type. If you work on a master VIO, any modifications made to
this VIO effect all other VIOs of the same type.
To open integration builder:
1. From Badge Designer, display the Object Library pane.
2. Expand the VIO folder until the object you want to edit appears.
3. Right click on the object you want to edit and select Edit.
4. Do one of these:
• From the icon tool bar, click the icon. This icon is located in the Windows
Toolbar section.
• From the menu tool bar, select View > Windows > Integration Builder.
The Integration Builder appears with the properties for the selected object
displayed. The object itself appears on the canvas.
For more on the integration builder screen, refer to “Integration Builder Screen” on
page 625.
5. From the Integration Builder tree pane, expand the Master folder to reveal the
various states this object supports.
Under each state, the component shapes making up each state appear. An
example of this screen is shown below:

Notice that the VIO represented by the Door Open VIO appears on the canvas as
shown above.
6. Select and make changes to the VIO of your choice.
For more on using the integration builder, refer to “Using the Integration Builder” on
page 628.

624 Advanced Procedures

 MAN006-0612

Integration Builder Screen

The Integration Builder screen looks like this example:

The Integration Builder includes three main areas:

Icon Tool Bar This tool bar include six buttons:

— Add the current cause for this icon to the database.
— Add the current effect for this icon to the database.
— Update changes made to the cause for this icon.
— Update changes made to the effect for this icon.
— Move the currently selected icon one step up in the VIO
tree pane list.
— Move the currently selected icon one step down in the
VIO tree pane list.

Cause & Select causes and/or effects for the currently selected icon. This
Effect pane pane is divided into three sections:
• Causes indicates the name, type, and value of the cause that
makes this icon display.
• Effect describes the specific nature of the effect on the icon.
• Effect Values indicates the exact nature of the effect for those
effects requiring elaboration. This section only appears if Text,
Visibility, or Flash is selected in the Effect section.
For more on this pane, refer to “Cause and Effect Pane” on page
626.

Advanced Procedures 625

Velocity Version 3.1 Administrator’s Guide

VIO Tree pane This pane displays all states for the selected icon. If no icon is
selected, this lists all icons currently defined by the system.
The tree is divided into three folders and four levels:
• The General folder applies to any object regardless of type.
• The Master folder applies to the specific type of icon. All items
within the Master folder depict the variety of states available for
the specific type. In most circumstances, you will be using this
level, since you are applying behaviors to a device type (e.g.
Expansion Relays or Doors).

Cause and Effect Pane

The Cause and Effect pane looks like this example:

It includes these sections and variables:

Cause

Cause Name Cause Name

Cause Type Select from the drop-down list, the event type required. Choose
from these options:
1 - Specific Event – When you select this option, all currently
defined events are displayed in the Cause Value drop-down pick
list. This includes all currently defined events from every available
event type.
2 - Event Type – When you select this option, all currently define
event types are displayed in the Cause Value drop-down pick list.
3 - Click – When you select this option, it indicates that the cause
of this action is a mouse click on the specified object. This
provides a button effect for the selected VIO.
The Cause Value row is hidden.
4 - Basic Device States – When you select this option, all basic
device states are displayed in the Cause Value drop-down pick list.
These include: door closed, door open, RQE active, tamper active,
and so on.

626 Advanced Procedures

 MAN006-0612

Cause Value This indicates the options that are available for the cause specified
in the Cause Type row. For example, if you selected Event Type in
the Cause Type row, then only event types appear in this
drop-down pick list.
This row does not appear if you selected Click.

Effect

Position Indicates that the selected shape(s) change position during a

specific cause.

Fill Color Indicates that the selected shape(s) change fill color during a
specific cause.

Fill Style Indicates that the selected shape(s) change fill style during a
specific cause.

Line Color Indicates that the selected shape(s) change line color during a
specific cause.

Line Style Indicates that the selected shape(s) change line style during a
specific cause.

Line Width Indicates that the selected shape(s) change line width during a
specific cause.

Text Indicates that text for the selected object changes or appears
during a specific cause.
If this box is checked, the Effect Values section appears.

Text Color Indicates that the selected text changes color during a specific
cause.

Visibility Indicates that the selected shape(s) or text changes visibility

(becomes visible or invisible) during a specific cause.
If this box is checked, the Effect Values section appears.

Flash Indicates that the selected shape(s) or text flashes during a

specific cause.
If this box is checked, the Effect Values section appears with two
possible values: Flash Duration and Flash Frequency.

Effect Values

Visibility Specifies whether this object is visible (True) or hidden (False).

Text Enter the text that appears when this cause occurs.
The default is blank.

Flash If shown, select the duration of the flash. The range is -1 -

Duration Indefinitely to 60 - 65 Seconds where the default value is -1 -
Indefinitely. 0 - Stop turns this effect off.
This field is only available when Flash is checked in the Effect
section.

Advanced Procedures 627

Velocity Version 3.1 Administrator’s Guide

Flash If shown, enter the frequency, in milliseconds, at which this object

Frequency flashes. The default value is 500 ms.
This field is only available when Flash is checked in the Effect
section.

Lower This window displays a short definition of the selected row and
window field.

Using the Integration Builder

Most of the behaviors you will need to identify with VIOs are already included when
you install Velocity; however, there are circumstances when you may need to define
more VIOs to describe additional device states or modify existing VIOs.
In general, the strategy for defining VIO behaviors follows this pattern:
1. Create the object.
2. Define the behavior of the object in its normal state.
The cause, therefore, is defined by its normal state so that the effect is the normal
appearance of the VIO. Every shape within the VIO which undergoes modification
during an alarm state, must first be defined in its original or resting state.
For example, if you create an escalator icon that turns red and flashes when it
stops unexpectedly, you must first define the icon when it is white and not flashing.
3. Define the behavior of the VIO in its alarmed state.
The cause is defined by its alarmed state (door open, tamper alarm, etc.) and the
effect is some modification of the VIO's appearance.
In order to do this, you modify the VIO's aspect in the required way (such as make
a shape within the VIO red or change the position of a shape). Once this is done,
you indicate the part of the VIO undergoing the change and the type of change
that it is.
The following instructions describe this process in more detail.
To create behaviors for a new VIO:
1. Create and design the VIO as required.
2. Open the Integration Builder as explained in “Integration Builder” on page 623.
3. With the VIO selected in the Object Library, click in the Integration Builder's 'Cause
Name' field and specify a cause name for this icon.
For example, if you need an icon to express a Door Off Normal condition, you
could enter 'Door Off Normal' here.
4. Click in the 'Cause Type' field and select from the drop-down list the type of cause
this is.
There are five cause types available:

Specific Event A specific event causes this icon to display the specified
effect(s). The 'Cause Value' field displays a list of every
event (by event number) the system currently recognizes.

Event Type A specific event type causes this icon to display the
specified effect(s). The 'Cause Value' field changes to
display a list of all currently available event types.

628 Advanced Procedures

 MAN006-0612

Click If you click on this object, it causes the icon to apply the
specified effect(s).

Basic Device An activity or state associated with a basic device, such as

States Door Closed or Input Masked, causes this icon to display
the specified effect(s). The 'Cause Value' field changes to
display a list of relevant device conditions.
Note: Only those conditions relevant to the device specified in
the 'VO Type' field on the VIO property sheet appear in this
list.

 Define the normal state and behavior before changing the shape and
defining all possible versions of its alarmed behavior.
5. Click the 'Cause Value' field and either enter a value or select an option from the
available list. The value you enter here depends on the Cause Type you selected
above.

Hint Normally, you should define the normal state and its attendant effects before
defining various alarm states and their corresponding effects.

6. From the icon tool bar, click the Add Cause button, .
The newly defined cause is added to the list in the Integration Builder's tree pane.
The cause appears in the appropriate folder with a lit firecracker symbol, ,
before it.
7. Define additional causes by repeating Steps 3 - 6.
The newly defined causes are added to the list in the Integration Builder's tree
pane. The causes appear in the appropriate folder with a lit firecracker symbol,
, before it.

Hint It's often easier to create all the causes you'll need at the same time. For example,
if you want to create a man-trap icon that can indicate four states—Closed, Open,
Open-Too-Long, and Unknown—you would create four causes.

8. In the tree pane, click to highlight the first or normal cause you created.
9. Define one or more effects for this cause.
This can include the position, color, style, text, visibility, and/or flash attributes that
depict the appearance of the VIO in a normal state.

Hint Keep in mind the ways in which you want the icon to change in order to signify a
specific change of state. For example, if you want Rectangle4 within the VIO to
flash red when alarmed, you will want the program to observe both the flash and
fill color attributes for that shape.

In order to do this, follow these steps:

a. On the canvas, click on the shape(s) within the VIO that undergo a particular
change.
Remember, you can only select components of a VIO in Design Mode.
b. In the Effect section of Integration Builder, check the attribute(s) the selected
shape(s) will undergo once it is changed.

Advanced Procedures 629

Velocity Version 3.1 Administrator’s Guide

For example, if the Rectangle4's fill color turns red during alarm, check the Fill
Color box. Do not change the color yet. In its resting state, the fill color is still
white.
You can specify more than one modification per selected shape.
10. From Integration Builder's icon tool bar, click the Add Effect button, .
The normal effect appears below the normal cause in the Integration Builder's tree
pane. The effect appears under the associated cause with an exploding firecracker
symbol, , before it.
11. If you need additional effects, repeat Steps 9 - 10.
For example, if you want the rectangle bordering the VIO to turn red during the
same alarm that turns Rectangle4 red and flashes it, you would select the
bounding rectangle then check the Line Color attribute. If you want text to appear,
you would select the text then check both the Text and Visibility attributes.
Once all the effects for the normal cause are defined, it's time to define the effects
for the off-normal states.
 You can assign any number of causes to a VIO; however, each cause you
define must possess the same number effects and those effects must be
associated with the same shapes. If you have defined three effects for a
cause affecting three shapes, then all other causes defined for the VIO
must also have three effects for those three shapes.
12. From Integration Builder's tree pane, click to select the next cause.
13. On the canvas, select one of the shapes within the VIO you need to modify to
represent the change of state described by the cause.
14. Make changes to the shape as required.
For instance, if Rectangle4 turns red during this cause, change its fill color to red.
15. From the Effect section, check each box to indicate the effect you must applied to
this cause.
These values are described briefly below:

Position Indicates that the selected shape(s) change position during a

specific cause.

Fill Color Indicates that the selected shape(s) change fill color during a
specific cause.

Fill Style Indicates that the selected shape(s) change fill style during a
specific cause.

Line Color Indicates that the selected shape(s) change line color during a
specific cause.

Line Style Indicates that the selected shape(s) change line style during a
specific cause.

Line Width Indicates that the selected shape(s) change line width during a
specific cause.

Text Indicates that the selected text changes or appears during a

specific cause. If this box is checked, the Effect Values section
appears.

630 Advanced Procedures

 MAN006-0612

Text Color Indicates that the selected text changes color during a specific
cause.

Visibility Indicates that the selected shape(s) or text changes visibility

(becomes visible or invisible) during a specific cause. If this
box is checked, the Effect Values section appears.

Flash Indicates that the selected shape(s) or text flashes during a

specific cause. If this box is checked, the Effect Values section
appears.

For example, if you changed Rectangle4's fill color to red, you would check Fill
Color in the Effect section.
If an effect occurs during an alarmed or off-normal cause, it must also be
documented during its normal cause. For example, you cannot indicate that when
a Relay is ON, the bounding rectangle flashes red unless you have already defined
the same Relay's bounding rectangle as black and unflashing when the Relay is
OFF.

Hint When checked, each box in the Effect section indicates that the program must pay
attention to the aspect you have modified in the icon. In certain cases, the Effect
Values section explains the exact nature of that property. For example, if you check
Visibility, the Velocity knows enough to pay attention to the visibility of the VIO;
however, you must indicate whether it needs that property to be visible or invisible
by indicating True (the object is invisible) or False (the object is visible) in the
Effect Values section.

If you have checked the Text, Visibility, or Flash boxes, the Effect Values section
appears.
16. Specify the value of this effect in the Effect Values section. These values are
described briefly below:

Text Enter the text you want to appear if the above cause occurs.

Visibility Indicate whether the object is invisible (False) or visible (True).

Flash Indicate how long the object flashes. Indefinitely (-1) indicates
Duration that the object continues to flash. 0 - Stop turns this effect off.
The range is 1 - Indefinitely to 60 - 65 seconds.
The default is -1 - Indefinitely.

Flash If Flash Duration is -1, designate the frequency of the flash.

Frequency Enter the number indicating how many milliseconds each flash
lasts.
The default is 500 msec.

17. From the icon tool bar, click the Add Effect button, .
The newly defined effect is added to the list in the Integration Builder's tree pane.
The effect appears under the associated cause with an exploding firecracker
symbol, , before it.

Advanced Procedures 631

Velocity Version 3.1 Administrator’s Guide

An example of this hierarchy is shown below:

To add more than one effect per cause, either combine several actions into one
effect or create a series of effects (with each effect representing individual actions).
For example, you can define the first effect for an open door as the door going to
the open position (a position effect) then specify that this is followed by the
displaying of the text OPEN (text effect), you can express this as one effect with
two actions or two effects with one action each. This doesn't change the way in
which the effects appear on the screen: whether you define one effect with
multiple actions or multiple effects with one action each, the results are the same.
To delete an unwanted effect, simply right click on it and select Delete.
18. Repeat Steps 13 - 17 to identify additional modifications of the VIO.
Often there will be two or more effects for each cause as shown in the following
example:

Notice in this example, there are two shapes within the Turnstile VIO that undergo
change: the Spoke and the bounding rectangle which we have called AlarmFlash
here. Each of these changes must be documented in both the normal (or closed)
state and the open state.
In order to have a shape flash during an alarm state, you must assign the shape a
special AlarmFlash property. For more on this, refer to “AlarmFlash Property” on
page 645.
19. Return the custom VIO to its deactivated or neutral state, then save it.
20. Click OK to exit the Integration Builder.

Hint It's a good idea to return your VIO to its original (normal or unalarmed) state
before saving it for a final time. Designer displays the last saved image from the
canvas to the Object Library and places the image on the canvas in that
configuration.

For more on this, see “VIO Example” on page 637.

To test the cause and effect mechanism, go into Live Mode and click on the individual
cause and effects in the Integration tree pane. As you click on a new cause, the object
on the canvas should change.

632 Advanced Procedures

 MAN006-0612

Edit Behavior for VIO Group

To add/update behavior for a group of VIOs:
1. From the icon tool bar, click the Integration tool, .
The Integration Builder screen appears. In the tree pane, the available VIOs appear
under the General and Master folders.
2. From the tree pane, select a cause you want to change.
You can choose more than one by pressing the Shift or Ctrl key while clicking.
3. In the cause section, make changes that you want applied to all the selected group
of VIOs.
4. When you're finished, click Update Cause button, . The cause is updated.
5. From the tree pane, click on the effect under the cause you need changed.
6. If needed, make any changes to the VIO you require.
7. In the effect section, make changes as required for a cause.
8. Click the Update Effect button, .
9. Save your changes.
10. Exit Integration Builder.
The same cause/effect is changed/modified for each selected VIO.

Edit VIO Behavior

To modify the behavior of an existing VIO:
1. From the menu tool bar, select Modes > Graphic.
2. Display the Object Library and expand the VIO folder.
3. Open Design Mode.
4. Right click on the VIO whose behavior you want to change.
An option list appears.
5. Select Edit.
The Integration Builder screen appears.
6. Make changes to the selected object as required by changing/adding causes or
effects.
7. Once you've changed/added causes or effect, do one or more of these:

After you: Click the: Button

Change a cause Update Cause button

Change an effect Update Effect button

Add a cause Add Cause button

Add an effect Add Effect button

8. Click OK to exit the Integration Builder.

You can also add/update cause and effects for a group of objects.

Advanced Procedures 633

Velocity Version 3.1 Administrator’s Guide

VIOs Made Simple

Creating your own VIOs appears to be difficult, but it doesn't have to be. If you follow
this method, you can made the production of these eye-catching icons easy.
1. Define the reason/objective for building this VIO.
Why do you want to create this new VIO? What purpose must this object serve?
While Hirsch supplies more than twenty VIOs, your company may need to define
objects for other devices, such as a turnstile (as shown in the VIO Behavior
Example starting on page 637), a smart reader, an escalator, or a medical cabinet.
2. Review all states this VIO must represent.
In most security environments, it isn't just a question of alarmed or normal. Most
VIO icons must illustrate several causes. For example, if you want to represent
specific events, you have literally hundreds of possibilities. And remember: a cause
or state is represented in Velocity as a pair of conditions -- what happens when the
condition occurs and what happens when the condition stops occurring.
3. Make a rough sketch of the VIO you want to create.
A sketch can really help you in designing the VIO you need, like this example:

Notice that the designer of this VIO has worked out every object needed to make
this object comprehensive and usable.
4. Build a spreadsheet/worksheet representing the causes (states), object
changes, and effects you envision.
This helps to sort out causes and effects. The table or spreadsheet doesn't have to
be complicated; in fact, it should be simple and straightforward, like this example:

634 Advanced Procedures

 MAN006-0612

VIO Requirements Worksheet

VIO Name: Stoplight - Input

VIO Type: Input

Cause Name Cause Type Cause Value Effect Name Effect Object Effect Action
Alarm Basic Device State Door Open Fill color Red Light Red
Alarm Reset Basic Device State Door Closed Fill color Red Light Black
Tamper Basic Device State Tamper Fill color Yellow Light Yellow
Tamper Reset Basic Device State Tamper Secure Fill color Yellow Light Black
Mask Basic Device State Input Masked Fill color Green Light Green
Unmask Basic Device State Input Unmasked Fill color Green Light Black
Line Fault - Noisy Specific Event Type 5012 Input Noise Line Color Outline Orange
Line Fault - Shorted Specific Event Type 5013 Input Shorted Line Color Outline Orange
Line Fault - Out-of-spec Specific Event Type 5017 Input Out-of-spec Line Color Outline Orange
Line Fault - Open Specific Event Type 5018 Input Open Line Color Outline Orange
Line Fault - Clear Specific Event Type 4011 Line Fault Clear - Input Secure Line Color Outline Black

For a blank worksheet based on this model, see page 1284.

5. Create the VIO.
In Velocity Designer at the Object Library pane, right click on the VIO folder and
select New > Object.
The New VIO dialog box appears. At the new VIO dialog box, name the object, like
this example:

Click OK and a new canvas appears on the drawing board. At the Object Library
pane, click on the new VIO object. At the Properties pane, assign the new object a
VO Type, like this example:

Pick from a list of available VO types. Each type of object has its own integration
possibilities that are listed in the Integration Builder.
For easier use, use the Zoom icon bar to increase the size of the canvas.

Advanced Procedures 635

Velocity Version 3.1 Administrator’s Guide

6. Draw the VIO.

In Velocity Designer, draw the icon. This is done in the same way you would design
a Velocity object or create a drawing. Include all the elements in this drawing you
will use to represent the differing states.
For example, you want to create a reader icon that turns red in one state (say,
tamper) and tilts to the right to indicate another alarm state (say, stolen card
detected). You would draw both the tilted version and the straight version of the
icon on the same drawing board. You would also fill the straight version with red.
Any object included in the drawing that is not used for a specific effect can always
be turned off (made invisible) in the property sheet.
7. Define all causes.
In Integration Builder, add all the causes to your tree pane first. Remember that
causes come in pairs: for every open there is a closed; for every locked there is an
unlocked. You must define each pair of causes you require: no odd-numbered
causes are allowed.
The essential process is this:
a. Click on the appropriate VIO folder in the VIO tree pane.
b. Identify the cause name, cause type, and cause value in the Cause pane.
c. Click the button.
The new cause appears under the designated VIO folder in the VIO tree pane.
8. Define the effects for each cause.
Now go to Integration Builder and associate the selected object(s) with the
relevant effect. For each selected object, determine whether you want to display
one or more attributes for an effect. For example, transparent = true and fill = red.
Remember, you must define any changes in the color, position, or other value of
an element on your drawing board.
The essential process is this:
a. Click on the cause in the VIO tree pane for which you want to specify one or
more effects.
b. Go to the drawing board and click on the object(s) within the drawing that will
change color, visibility, position, or some other value when this cause occurs.
c. Define the type of effect(s) the selected objects will undergo in the Effect pane.
d. Click the button.
The new effect appears under the designated cause in the VIO tree pane. The
effect is identified by the name of the element you selected on the drawing board.
(This is the name you entered in the Name field of the Properties sheet when you
created the element.)
Here as in causes, you must 'pair' your effects: for every effect that occurs under a
cause, such as Door Open, you must create a counterbalancing effect in the
resolving cause, such as Door Closed. In the following example, the cause Turnstile
Closed affects both the Spokes element and the Spokes Turning element (one
becomes visible while the other becomes invisible).

636 Advanced Procedures

 MAN006-0612

Since two effects are identified in the Turnstile Closed cause, the same two effects
must be addressed in the Turnstile Open cause (where the visibility of the
elements are reversed).

While this example represents a change of visibility and is inherently more

complicated than most VIOs you will create, you can see that the underlying logic
is straightforward.
When you're finished, click the Integration Builder OK button to save your work.
 If you try to save your work before saving your cause and effect
definitions, all of your hard work vanishes. You must click the OK button
in Integration Builder to save the definitions.

VIO Example
Using Integration Builder is one of the more complex aspects of Designer; it is also one
of the most powerful. It enables you to create a smart icon that can:
 change shape, color, or thickness
 display text
 display or hide shapes or text
 flash
in response to a change in state by the system device with which it is associated.

Preparation
 Before beginning this process, you might want to refer to the VIOs Made
Simple. This will help you arrange the process in the most logical order.
In the following example, we're going to create a symbol for a turnstile, then modify it
to represent several possible alarm states, including Open and Tampered.

Advanced Procedures 637

Velocity Version 3.1 Administrator’s Guide

The following illustration helps show what we want to achieve:

Locked & Secure

(not in use)

Unlocked & Secure

(in use)

Tamper
(flashing box)

As shown above, in its normal (locked) and secure (untampered) state, the turnstile
VIO is represented as twin spokes. Once the turnstile is unlocked, however, the icon
spokes rotate 45 degrees. If the tamper alarm is detected, a red box (alarm border)
around the turnstile flashes. The alarm border can flash whether the turnstile is in a
locked or unlocked state.
In order to represent these different states, we'll use a table like the one in “VIOs Made
Simple” (see page 634) to show all the possible states and how each state affects the
object's elements.
VIO Requirements Worksheet

VIO Name: Turnstile

VIO Type: Door

Cause Name Cause Type Cause Value Effect Name Effect Object Effect Action
Turnstile Locked Basic Device State 3-Door Locked Visibility Spokes TRUE
Basic Device State 4-Door Unlocked Visibility SpokesTurning FALSE
Turnstile Unlocked Basic Device State 3-Door Locked Visibility Spokes FALSE
Basic Device State 4-Door Unlocked Visibility SpokesTurning TRUE
Turnstile Secure Basic Device State 5-Tamper Secure Visibility AlarmBorder FALSE
Turnstile Tampered Basic Device State 6-Tamper Active Visibility AlarmBorder TRUE
Flash AlarmBorder 500 and -1

638 Advanced Procedures

 MAN006-0612

Notice that we don't have to include those elements of the VIO that don't change from
state to state, like the bounding circle or the central hub. These appear in all
permutations of the drawing. However, any element that changes in some way in
response to a change in state must be defined for each of the required causes. So, in
the preceding drawing, the Spokes, SpokesTurning, and AlarmBorder elements must be
defined.
Also remember that causes come in pairs: for every locked there is an unlocked; for
every tampered there is a secured. Effects must also balance: every element that
changes in response to a cause, must be represented in both its active and quiescent
states. So, in the preceding example, the AlarmBorder element must be included in
both parts of the Secure and Tampered cause pair.

Creating the VIO

Now that we know what we want to represent, let's start the VIO drawing.
To design and implement this turnstile VIO:
1. From the menu tool bar, select Modes > Graphic.
The Graphic Mode is enabled.
2. Open the Object Library.
The VIO, VSO, and Topology folders appear there.
3. Expand the VIO (Integrated) folder in the Object Library until the Doors folder
appears.
4. Right click on the Doors folder and select New > Object from the pop-up list.
The New VIO dialog box appears.
5. Enter the name Turnstile and click OK.
A new drawing called Turnstile appears under the Doors folder in the Object
Library.
A blank canvas appears.
6. From the Object Library, click to highlight the new Turnstile object and, if you
haven't already, open the Properties pane.
The object's properties appear in the Properties pane. There are only two
properties: Name, which has already been supplied, and VO Type.
7. Click in the 'VO Type' field and select Door from the drop-down option list as
shown above and press Enter.
The 'VO Type' option list includes all of the device types Velocity recognizes. Since
a turnstile is a type of door, we select that one.
8. Go to Design Mode.
9. From the icon tool bar, click the Zoom In button several times to increase the
size of the canvas.
It's hard to draw a Velocity object, particularly a VIO, in its default 0.55 x 0.55 size,
so we recommend increasing the canvas size 200% - 400% for easier viewing.

Hint You can easily increase the default size of the complete object if you like to 1 x 1
by accessing the Page Size tab of the Page Setup dialog box (see page 442).

If the Zoom In button doesn’t appear, select View > Zoom from the menu tool
bar.
10. Select the tool and draw a circle.

Advanced Procedures 639

Velocity Version 3.1 Administrator’s Guide

11. Select the tool and draw a long, thin rectangle.

Hint If you have the Snap to Grid feature enabled, you might need to override it by
pressing the Ctrl key while drawing in order to get your rectangles and other
shapes right.

12. Copy this rectangle, select the copy, then click the button to rotate this 90º to
the left.
13. Move the copied and rotated rectangle until it intersects with the first rectangle to
form a cross.
14. Move the new cross inside the circle.
15. Select both rectangles and the circle then click both the and buttons to
perfectly align them.
The turnstile icon should now look something like this:

The icon is shown at three times normal size for clarity.

16. Select the two intersecting rectangles at the center of the icon and group them.
The property sheet renames the group objects 'Container1'.
17. At the property sheet, rename the grouped object Spokes and press Enter.
18. Still in the property sheet, go to the 'Fill Color' property and select some shade of
orange.
19. Select the tool and draw a smaller circle.
20. Center this circle over the intersection of the cross and align it as required.
This represents the centerpost of the turnstile.
21. At the property sheet, rename the object Centerpost.
22. Now, select the tool once again and draw a rectangle as a boundary line
around the entire object.
This boundary line is needed in order to help Velocity maintain the proper scale
when manipulating the icon.
If the Snap to Grid feature is enabled, the rectangle will snap to the nearest grid
points. To disable this feature for this object, press Ctrl while drawing. If the Snap
to Grid feature is disabled, press Ctrl while drawing to enable the snap to grid
feature for this object.
23. With the bounding rectangle selected, click on the Send to Back icon, .
The other objects now appear in front of the rectangle.
24. In the Properties pane, rename the bounding rectangle AlarmBorder.

Hint Remember that you must first select the Select and Edit tool, , before you can
select any shape you have created. You cannot, for example, select a line with the
Line tool; the Line tool only creates a line, it cannot select it.

25. While still in the property sheet for Alarm Border, click on the 'AlarmFlash' property
and select True.

640 Advanced Procedures

 MAN006-0612

This tells Designer that once this shape is assigned the Flash attribute in Integration
Builder and the icon is placed, this part of it will flash once the door associated with
the icon goes into alarm. The frequency and duration of the flashing depends on
the values you enter later on the Integration Builder screen. For more on the
AlarmFlash property, refer to “AlarmFlash Property” on page 645.
26. Click outside of the objects on the canvas to deselect any shapes and save the
object.
If you look at the object under the Object Library, you'll see that the basic turnstile
VIO is now ready.
27. Click to select the Spokes element and copy it.
28. Using the rotation tools, rotate the copied Spokes element 45°.
29. In the Properties pane, rename the element SpokesTurning.
30. Using the align tools, center and align the all of the elements you have created so
far and move the CenterPost element to the front.
The object should now look like this example:

All of the elements that will appear are now present. However, several of these
elements should only appear in alarmed states and should therefore be hidden
until they are required.
31. With the SpokesTurning element selected, go to the Properties pane. At the
'Visible' property, select False.
This indicates that under normal conditions, this element will not appear.
32. Select the AlarmBorder element.
33. Go to the 'Visible' property and select False, since you also want this element to
remain hidden in the normal state.
To repeat, these elements should now be represented by these values:

Element Important Properties

Spokes Visible = True, Fill Color = (some shade of orange)

SpokesTurning Visible = False, Fill Color = (some shade of orange)

AlarmBorder Visible = False

The other two elements in this object, Center Post and Ellipse1, never change so
they are by default always visible.
Notice that in both the Pan and Zoom pane and under the Object Library pane,
that the default object now looks like this:

Advanced Procedures 641

Velocity Version 3.1 Administrator’s Guide

Now it's time to start assigning some conditions to the elements in this object.
First, we create the causes we want to track.
34. With your new Turnstile VIO displayed on the drawing board and Design Mode
selected, open the Integration Builder.
The Integration Builder screen appears.
35. Click to highlight the Master folder in the Integration Builder.
This tells Integration Builder that the causes we are about to create should be
installed under this folder.
36. Click at the 'Cause Name' field and enter Turnstile Locked.
You must set the VO Type as Door, as explained in Step 7, before this option is
available.
37. At the 'Cause Type' field, select 4 - Basic Device States from the drop-down list.
38. At the 'Cause Value' field, select 10 - Door Locked from the drop-down list.
39. Click on the Add Cause button, .
The new Turnstile Locked cause appears in the right pane under the Master
(Turnstile) folder.
40. Repeat Steps 35 - 38 to create the other three causes using the values shown in
the following table:

Cause Name Cause Type Cause Value

Turnstile Unlocked 4 - Basic Device States 9 - Door Unlocked

Turnstile Secure 4 - Basic Device States 5 - Tamper Secure

Turnstile Tampered 4 - Basic Device States 6 - Tamper Active

After each cause, click the Add Cause button.

The four causes we defined are now listed in the Master (Turnstile) folder like this:

Hint In this example we only want to define this VIO in one alarmed state. Often a
device can experience many different types of alarm or event states. It's always a
good idea to define your causes first then add effects to each one in turn.

642 Advanced Procedures

 MAN006-0612

Now it's time to add effects to the causes. This is the part of the process where we
associate some of the elements we've created on the drawing board with actual
effects. Go back to the chart we created at the beginning of this exercise and see
which elements change in response to a specific cause.
41. In the Integration Builder's right tree pane, click to select the Turnstile Locked
cause.
We want to represent what the turnstile VIO will look like when the Turnstile is
locked and secure.
42. With Design Mode still selected, click on the Spokes element (remember the
original crossed rectangles?).
43. In Integration Builder's Effect section, check the Visibility box.
44. In the Effect Values section, make sure the value is True.
This means that when the cause or condition is Turnstile Locked, the Spokes
element will be visible.
45. Click the Add Effect button.
The Spokes effect appears under the Turnstile Locked cause. However, in defining
what the Spokes element is doing during this condition, we still haven't defined
what the SpokesTurning element is doing, and we must, since during the Turnstile
Unlocked condition, the visibility of the Spokes and SpokesTurning will reverse.
46. Click on the SpokesTurning element in our drawing.
47. In Integration Builder's Effect section, check the Visibility box.
48. In the Effect Values section, make sure the value is False.
This means that when the cause or condition is Turnstile Locked, the
SpokesTurning element will be invisible.
49. Click the Add Effect button.
The Bounding Rectangle effect appears below the Spoke Effect under the Turnstile
Closed cause.
50. Click to select the Turnstile Unlocked cause and using Steps 41 - 48 repeat the
effect definition process, only this time, visibility will be reversed as shown in the
following table:

Effect Name Effect Type Effect Value

Spokes Visibility False

SpokesTurning Visibility True

After each effect is defined, click the Add Effect button.

Notice now that when the Turnstile Unlocked condition occurs, that the
SpokesTurning element is visible and the Spokes element is invisible — just the
reverse of the Turnstile Locked condition.
Now it's time to define the Turnstile Secure and Turnstile Tampered conditions we
defined. As you remember, we're going to use the Alarm Border element to
indicate this.
51. At the drawing board, click to select the AlarmBorder element.
52. In Integration Builder, click the Turnstile Secure cause.
53. In the Effect section, check the Visibility box.
54. In the Effect Values section, specify False.
55. Click the Add Effect button.

Advanced Procedures 643

Velocity Version 3.1 Administrator’s Guide

This indicates that during the Turnstile Secure condition, that the Alarm Border
element is not visible.
56. With the Alarm Border element still selected, in Integration Builder, click the
Turnstile Tampered cause.
57. In the Effect section, check both the Visibility and Flash box.
58. In the Effect Values section, specify True and leave the Flash Duration and Flash
Frequency values at their defaults: -1 and 500.
59. Click the Add Effect button.
This indicates that when the turnstile detects a tamper condition, that the Alarm
Border will appear and flash at the defined frequency (500 times per minute) for
as long as the condition persists (the value -1 indicates always).
The full cause and effect list in Integration Builder should now look like this
example:

Notice that everything is balanced: for every Locked there is an Unlocked, for every
Secure there is a Tampered, if an element appears in one cause, it must appear in
its countervailing cause.
60. Click OK in the Integration Builder to save the Cause and Effect definitions you
have created and exit Integration Builder.
61. Save changes to the drawing.
 If you try to save your work before saving your cause and effect
definitions, all your hard work will vanish. You must click the OK button
in Integration Builder to save the definitions, then save your drawing.

Testing the VIO

Test the new VIO in a working environment in this way:
1. Design or import a map.
2. Place the VIO on the map. In brief:
a. Press Ctrl + D to enter Design Mode.
b. In the Object Library, expand the Topology folder until the Doors folder is
displayed.
c. Select an door from folder and drag it to the map.
The VIO Select dialog box appears.

644 Advanced Procedures

 MAN006-0612

d. Select the VIO you created from the combo box option list. In this case, you
would select Turnstile and click OK.
Notice that all the elements in the VIO appear in Design Mode. You must toggle
into Live Mode in order to see the view of the object the way it will appear to
operators.
3. Press Ctrl + D again to enter Live Mode.
4. Right click on the new icon and select Access Functions > Momentary Access
from the pop-up list.
While the door is unlocked, the icon should change to indicate the change of state.
Once the turnstile locks again, the icon should return to its normal position.

AlarmFlash Property
During an alarm state only those shapes that have been assigned the AlarmFlash
property are enabled to flash.
To assign the AlarmFlash property:
1. Follow the instructions for using the Integration Builder.
2. Select the shape within the VIO you want flash during an alarm state.
3. If not already open, display the Properties pane.
4. Go down to the General section and click in the AlarmFlash property.
5. Select True.
This tells Velocity that this object is enabled for flashing during an alarm state.

Show Credential Information

This feature enables a qualified operator to automatically display the name,
photograph, and signature of the person who has just entered/exited a door.
Before qualified operators can use this feature, a door must be enabled to use this
function.
To enable this feature within Graphics:
1. Open a graphic that is populated with one or more door objects.
2. Right click on the door for which you want to show credential information.
A pop-up list appears.
3. Select Show Credential Information.
From now on, this door is enabled for automatic display of credential information
whenever a credential is used on that door.
When a credential is used on the enabled door, the credential pop-up appears. This
pop-up information can include name, ID, and photograph as well as the time and date
when the credential associated with this person was last used.
Before you can use this feature, you must:
 Enroll the required people in Enrollment Manager as described in “Enrolling a New
Person” on page 800.
 Assign the new person a credential as described in “Assigning a Credential to a
Person” on page 804.
 Assign photographs through the Personal Information form as described in
“Capturing a Photo” on page 835.

Advanced Procedures 645

Velocity Version 3.1 Administrator’s Guide

From that point on, when any person enters or exits this door, a window is displayed on
the screen. If no photo is selected for the person in question, only the default
credential information appears.

Custom Badge Fields

During the process of creating a badge template for use in Enrollment Manager, you
may find that you need to customize one or more of the variable fields you want to
place on the badge. In order to facilitate this process, Badge Designer provides the
Custom Badge Fields feature.
Designer provides a large library of variables, enabling the program to insert onto the
badge whatever value is entered on the Personal Information Form in Enrollment
Manager; however, some clients may need to combine or alter these variables to fulfill
their badge requirements. To customize badge variable fields:
1. Enter Design Mode in the Badge Designer.
2. From the menu tool bar, select Tools > Custom Badge Fields...
The Custom Badge Fields screen appears like this example:

This screen is divided into three panes:

• the top pane lists all currently defined custom fields. Notice that fields are
already supplied for your use, including LastFirst, which generates a name,
surname first, and FirstLast, which generates a name, first name first.
• the middle pane lists all variable data fields currently defined by the system.
These are the building blocks you'll use to create your own custom variables.
• the bottom pane shows the custom field and serves as the work area. When
you click on a currently defined custom field, its components appear in this
pane.
3. Double click the ‘Add New Custom Badge’ field in the top pane.
A new variable field named @NewItem appears at the bottom of the top pane list.
4. To rename this item, right click on the new item and select Rename.
The new item is highlighted with the cursor at the last character.
5. Edit the name as needed.
6. To add existing variable components, click a selection from the middle pane. The
variable selection appears in the bottom pane.
For example, if you click %<Host Activation Date>% in the middle pane, the item
%<Host Activation Date>% appears in the bottom pane.

646 Advanced Procedures

 MAN006-0612

7. If required, click to add more variable components.

For example, if you click %<Host Activation Date>% then click %<Host Expiration
Date>%, then the two components appear in the bottom pane like this:
%<Host Activation Date>%%<Host Expiration Date>%
8. If required, click in the bottom pane and add any text or punctuation you need to
complete the custom variable.
For example, you can insert a hyphen and spaces between the middle percentage
signs and precede the two variables with the phrase ‘Valid Period:’. The result
would look like this:
Valid Period: %<Host Activation Date>% - %<Host Expiration
Date>%
If you insert this custom variable on the finished badge, the result might look
something like this:
Valid Period: 10/2/03 - 11/15/03
9. Click OK to confirm your modifications.

Topology Object Mapping

The Topology Object Mapping feature enables you to define the way in which Velocity
responds to the placement of databound objects on drawings. This feature enables you
to configure objects so that they respond in particular ways.
For example, some devices, like doors, can be represented by several different objects.
Should Velocity query the operator before positioning the object about which symbol
he/she wants there, or does the program arbitrarily select one symbol? What type of
colors are used to represent different states?
To display and use Topology Object Mapping:
1. Select Graphics Mode.
2. At the menu tool bar, select Tools > Topology Object Mapping...
The Topology Object Mapping screen appears:

3. Click on the object type you want to change.

A combo box appears.
4. Click the button and a list of options appears.
5. Select the option you need from the drop-down list.

Advanced Procedures 647

Velocity Version 3.1 Administrator’s Guide

The options include:

Ask Me which one to plot Whenever the operator places an object of

this type, prompt them to specify which
symbol to use.

Always plot [Options] Select the selected object as the default VIO.

6. Click OK.

UDF Property Definitions

This function determines how a drop-down list option selected from a User-Defined
Field (UDF) is represented on a Designer badge template. This enables the qualified
operator to change the appearance of a badge field depending on the option selected
for it.
Changes that can be made to appearance include:
 Background color and texture
 Line color and texture
 Line width
For example, if a UDF is created for Department in Enrollment Manager, you might
specify in Designer that the fill color of a rectangle (background) on the badge
template changes depending on which department is specified. For example, if the
badge is printed for a member of Research & Development the background rectangle
could be green while a member of the Advanced Concepts group appears in orange.
This can prove to be an extremely helpful visual aid for many companies, enabling
security staff to identify some aspect of a badge holder more easily, as shown in the
illustration below:

In this badge, UDF properties are set

to display a green background
whenever a cardholder is in R&D.

In this badge, UDF properties are set

to display an orange background
whenever a cardholder is in Advanced
Concepts.

Before you can use this tool, you must:

1. Open Enrollment Manager.
2. Define one or more UDFs in Enrollment Manager.
• In the 'Field Type' column, define each UDF to appear in Designer as
Drop-down List.
• In the 'Default List Values' column, enter a list of options that can be selected
for this UDF.

648 Advanced Procedures

 MAN006-0612

Only those UDFs defined as drop-down lists and possessing an option list can be
utilized by this function.
To assign UDF properties:
1. Create a badge template.
2. Place one or more objects on the badge template that can be linked to an existing
UDF.
The objects that can be placed for this purpose are:
• Open shapes (lines, arcs, etc.)
• Closed shapes (rectangles, ellipses, etc.)
• Text objects
• Databound Text objects
3. Open the Properties pane.
4. Select the object you want to be affected by the UDF property.
The UDF property appears in the pane under the General section like this
example:

The UDF property won't appear unless you are in Badge mode.
5. At the UDF properties, click to pick one of the UDFs that appears in the drop-down
list.
6. Save the badge template.
7. From the menu tool bar, select Tools > UDF Property Definitions...
The UDF Property Definitions screen appears like the following example:

Only those UDFs previously defined in Enrollment Manager as drop-down lists in

the Type column appear in the left pane.
8. Expand the UDF folder to reveal a list of the options previously assigned to this
drop-down list.

Advanced Procedures 649

Velocity Version 3.1 Administrator’s Guide

Click on the first option whose properties you want to modify. The properties for
that option appear in the right top pane like this example:

9. From the top right pane, change these properties as required.

The available properties are:

Back Color Indicates the background color assigned to the UDF-linked

object if this option is selected. This is the effect used for
printing this option.

Back Style Indicates the background style assigned to the UDF-linked

object if this option is selected. This is the effect used for
printing this option.

Fill Color Indicates the color of the background assigned to the

UDF-linked object if this option is selected. This is the effect
used for printing this option.

Fill Style Indicates the texture of the background assigned to the

UDF-linked object if this option is selected. This is the effect
used for printing this option.

Line Color Indicates the line color assigned to the UDF-linked object if this
option is selected. This is the effect used for printing this option.

Line Style Indicates the line style assigned to the UDF-linked object is
selected. This is the effect used for printing this option.

Line Indicates the thickness of the line assigned to the UDF-linked

Width object if this option is selected. This is the effect used for
printing this option.
Options range between 0 = thinnest and 5 = thickest.

Visible Indicates whether this property is visible or is hidden. True =

visible; False = hidden. The default is visible (True).

The visual appearance of the selected option is displayed in the lower right pane.

Hint Obviously, only those properties that effect the currently-assigned object are
displayed on the badge. For example, if you specify a line style or line color, these
won't apply to a text object, only geometric shapes.

10. When you're finished, click OK.

You are returned to the main Designer screen.

650 Advanced Procedures

 MAN006-0612

Layers
One of the more advanced features in Designer, is the creation and use of layers. This
section provides detailed information about this feature.
There are many different strategies designers and illustrators use to make drawing and
layout easier. One of the most common is creating drawing layers. When you 'layer' a
drawing, you group objects on a drawing and assign a level or layer number to them.
This enables you to superimpose one layer of objects on top of another layer. It also
helps expedite the drawing process in a number of different ways.
Using layers you can:
 show, hide, or lock shapes on specific layers so you can edit certain layers without
viewing or affecting other layers
 temporarily change the display color of all shapes on a layer to make them easier to
identify
 create layouts or maps where layers display co-existing systems on the same floor
or different floors in the same building
 expedite the task of moving shapes around on a page

For example, all objects have been assigned to either Layer 1 or Layer 2. All objects
appear while in Design Mode.

Since we have defined Layer 2 properties as appearing in red, all objects currently
associated with Layer 2 show in red. We have also designated that all Layer 2
properties are invisible once we go into Live Mode, and, in fact, when we switch to Live
Mode, the drawing now looks like this:

Advanced Procedures 651

Velocity Version 3.1 Administrator’s Guide

Notice that only those objects associated with Layer 1 now appear. When you switch
back to Design Mode, the Layer 2 objects reappear.
One popular use of this feature is in the design of floor layouts where several discrete
systems are included. In such designs, you can create a layer just for the electrical
system, a second for the plumbing, and a third showing the furniture and partitioning.
Later you can vary the drawing by hiding some layers while showing others.
You can also utilize layers when creating badge templates. For instance, if you need
several variants on a badge layout, you can incorporate the common elements into one
layer that is always visible, then turn on/off visibility of the variant layers as required for
each badge.

Creating Layers
To create a layer:
1. Do one of these tasks:
• From the menu tool bar, select View > Layers Properties...
• From the icon tool bar, click the Layers Sheet icon, .
The Layer Properties dialog box appears.
2. Click New...
The New Layer dialog box appears.
3. Enter a name for the layer and click OK.
4. Check or uncheck the Visible, Lock, and Color properties for this layer as required
by clicking in the appropriate cell.
5. When you're finished, click Close.
A new layer is added to the layer option list. This list is selectable through either the
'Layer' property on the object's Properties pane or the layer window on the icon tool
bar.
The next step is to assign one or more objects to the defined layer.

Editing Layers
Once you have created a layer, you can edit it easily using this method.
To edit a layer:
1. Do one of these:
• From the menu tool bar, select View > Layer Properties...
• From the icon tool bar, click the Layers Sheet icon, .
The Layer Properties dialog box appears.
2. Do any of these:
• Rename the layer by selecting the layer in the window then clicking the
Rename... button. Supply a new name and click OK.
• Check/uncheck the 'Visible' checkbox to show/hide this layer in Live Mode.
• Check/uncheck the 'Lock' checkbox to lock/unlock this layer so that no
additional items can be added to it.
• Change the color in which objects associated with this layer are shown in
Design Mode.
3. Click OK to confirm the changes and leave the Layer Properties dialog box.

652 Advanced Procedures

 MAN006-0612

Assigning Objects to Layers

After you have created one or more layers, you can assign objects to it.
Use one of two methods:
 Method 1 is best for assigning many objects to a particular layer.
 Method 2 is best for reassigning a particular object to another layer.

Method 1
1. Using the Select and Edit tool, select one or more objects you want included in this
layer.
2. From the Layer combo box on the icon tool bar, , select the
existing layer to apply to the selected objects.
The selected objects are assigned to the designated layer. Notice that the 'Layer'
property on each object's property sheet displays the new layer assignment.

Method 2
1. Using the Select and Edit tool, select the object you want to assign to a layer.
2. From the object's property sheet, click on the 'Layer' property and select the layer
you want from the drop-down list.
The selected object is assigned to the designated layer.

Deleting Layers
To delete a layer:
1. Do one of these:
• From the menu tool bar, select View > Layer Properties...
• From the icon tool bar, click the Layer icon, .
The Layer Properties Sheet appears.
2. From the layer window, click on the layer you want to delete.
3. Click Remove.
 You cannot delete the Default layer. If you attempt to remove this layer,
an error message appears.
If objects are currently associated with this layer, a message like this example
appears:

4. Click Yes to reassign the deleted layer's objects to the Default layer.
The selected layer is deleted.

Advanced Procedures 653

Velocity Version 3.1 Administrator’s Guide

Layers Properties
The Layers Sheet enables you to add, modify, order, view/hide, lock, or delete layers
used for a drawing.

The Layer Properties dialog box includes these fields and buttons:

Layer Window

Name The current name of the layer. You can change this through the
Rename... button.

Visible Indicates whether the layer is visible or invisible during Live

Mode. Click to check; click again to uncheck.

Lock Indicates whether the layer can have more objects added to it.
Click to check; click again to uncheck.

Color The color in which this layer is displayed. To change the color,
click on this cell and select Choose Color... from the pop-up
option list. The default is no color.
Note: The color assigned to the layer overrides the color assigned to
the specific object.

New... Click this button and the New Layer dialog box appears.

Enter the new layer name in the text field and click OK.
A new layer name appears in the Layer Properties window.

Remove Click this button to delete the currently selected layer.

Note: You cannot remove the default layer.

Rename... Click this button and the Rename Layer dialog box appears like
this example:

Enter a new name for the selected layer and click OK.

654 Advanced Procedures

 MAN006-0612

Remove Check this box to indicate that any layer not associated with at
Unreferenced least one object should be deleted from the Velocity database.
Layers By default, this box is left unchecked.

Close Click this button to close this dialog box and return to the
Designer.

Advanced Procedures 655

Velocity Version 3.1 Administrator’s Guide

656 Advanced Procedures

 MAN006-0612

CCTV Configuration
This chapter describes how to configure Velocity for use with a variety of CCTV systems.
Velocity supports the use of many CCTV cameras and monitors through CCTV
switchers. It currently supports these CCTV switchers:
 American Dynamics 2150
 Burle LTC8000 series
 Burle LTC8300 series
 Burle LTC8900 series
 Panasonic WJ-SX550
 Pelco Switchers (6700, 6800, and 9700)
 Vicon VPS series
 Vicon VPS 1344
 Vicon VPS 1466
In order for Velocity to monitor and control CCTV systems, the Velocity server must be
connected to the CCTV switcher in two ways:
 Serial connection for controlling attached cameras remotely
 Coaxial connection for routing video to Velocity CCTV Viewer.
Once configured, use the built-in Velocity CCTV Viewer to perform any function of
which the camera is capable. This includes:
 Pan
 Tilt
 Zoom
 Focus
 Brighten/Darken
The CCTV feature is also capable of memorizing and using presets as well as switch
between cameras.
Before you can use Velocity with a CCTV subsystem, you must:
1. Set up, connect, and configure all necessary CCTV cameras, monitors, and
switchers using the procedure described in their respective manuals.
2. Install a FlashBus video capture card into the designated Velocity workstation.
3. Connect the CCTV switcher to the Velocity workstation via one of the coax ports on
the FlashBus card as described in the Velocity Quick Installation Guide. This
enables the workstation to view video through the CCTV Viewer.
4. Connect the serial port on the switcher to the serial port on a Velocity workstation.
This provides the control signals between the Velocity system and the CCTV
system.
5. Configure Velocity by defining these elements:
• CCTV port(s) — refer to page 660
• CCTV switcher(s) — refer to page 664
• CCTV camera(s) — refer to page 667
6. Use the Velocity CCTV Viewer to move and manipulate CCTV images as required.
See page 671.

657
Velocity Version 3.1 Administrator’s Guide

A complete CCTV system often requires many connections to many different devices,
as shown in the following example of a Pelco CM6700 switcher and attached devices:

Notice that the switcher would be connected to the Velocity server via an RS-232 serial
connection while coaxial connections enable video to be routed to monitors. When
used with Velocity, one of these coax connections can be routed through a switcher
video output port to a coax port (BNC) on the video capture card installed in the
Velocity server or workstation.
While the control signal must be routed to the Velocity server, the video signal from the
CCTV cameras can be routed to either the Velocity server or an attached Velocity client,
as long as they have an installed video capture board. You can even split the video
signal, sending one video feed to two Velocity workstations. For best results, use a
distribution amplifier to split the signal.
Once a control signal is routed from the switcher to the Velocity server, any Velocity
client or workstation can issue control commands; however, only those computers with
video links via installed video capture cards can view the results.
For detailed instructions on defining a CCTV system, see “CCTV: How to Define a
System” on page 659. For instructions on viewing and manipulating video input from
CCTV cameras in Velocity, see CCTV Viewer and CCTV Control Functions.
 While you can install both video capture (for badge photography) and
CCTV on the same Velocity server (even use the same FlashBus video
capture card to connect both feeds), you cannot run both concurrently.
Run one or the other.
For example, if you are monitoring your site over CCTV using the Velocity
CCTV Viewer, do not try to use the photo capture utility within Enrollment
Manager. Conversely, if you are capturing photos in Enrollment
Manager, do not try to monitor CCTV using the CCTV Viewer.
If you aren’t currently using CCTV, you can save processing time by setting the Port
Manager to manual. To do this, refer to “Port Manager,” starting on page 663.

658
 MAN006-0612

CCTV: How to Define a System

To define a CCTV system:
1. Start the Velocity CCTV Service by selecting the Start CCTV Service option from the
Velocity Service Control Manager (SCM).
For more on the SCM, refer to “Service Control Manager (SCM),” starting on page
1073.
2. Define one or more CCTV ports used for connecting the CCTV system to this
Velocity workstation.
 Before you can define a port, you must install a FlashBus video capture
card and connect the coax port on this card to one of the output ports on
the CCTV switcher.
3. Define one or more CCTV switchers connected via these ports.
4. Define one or more CCTV cameras connected to each switcher.
5. Use the CCTV Viewer to control and monitor the CCTV system from your Velocity
workstation.
6. Select properties as required for this CCTV system on the Preferences CCTV page.
 The first time you bring up Windows with the CCTV subsystem enabled,
you may have to stop then restart the CCTV Services from the Velocity
Service Control Manager before proceeding. This procedure should not
have to be repeated once the subsystem is up and running.

CCTV: How to Define a System 659

Velocity Version 3.1 Administrator’s Guide

CCTV: Port Configuration

The first step in configuring a CCTV system for this facility is configuring the Velocity
server port to communicate with the attached CCTV switcher. Control signals are
passed between the CCTV system and Velocity through a serial connection linking the
switcher to a Velocity computer.
Video to Velocity requires connection to a coax port on the installed FlashBus video
card. The coax port is used to connect to one of the output ports on the switcher.
To configure a CCTV port for use with Velocity:
1. At the System Tree window, click and expand the Configuration system folder to
reveal the Interface Configuration folder.
2. Expand the Interface Configuration folder to reveal the CCTV folder.
3. Select the CCTV folder.
In the component window appears the Add New CCTV Port option as shown in
the following example:

If a CCTV port has been previously defined, this also appears in both the
components window and on the system tree.
4. From the Components window, double click on the Add New CCTV Port option.
The CCTV Port Configuration dialog box appears. For more on this, refer to “Port
Properties Dialog Box” on page 660.
5. Complete the form as required.
6. Click OK to accept the definition.
The new port designation appears in both the system tree and components window.

Port Properties Dialog Box

Use this dialog box to define the port used to connect the CCTV Switcher to the
Velocity workstation.

660 CCTV: Port Configuration

 MAN006-0612

If you indicate that the port is serial, a screen like this example appears:

If you indicate that the port is TCP/IP, a screen like this example appears:

The Port Properties dialog box contains the following fields:

Name Type in a new name for this CCTV port. The name can be up
to 40 characters in length.

Network Type Accept the default, CCTV.

Serial Port Click the radio button indicating the type of port the Velocity
TCP/IP workstation is using to communicate with the CCTV Switcher:
Serial Port—the CCTV switcher is connected directly to this
computer
TCP/IP—the CCTV switcher is connected this computer
through the network
The default setting is Serial Port. If no serial port is detected by
the computer, the program defaults to TCP/IP.

CCTV: Port Configuration 661

Velocity Version 3.1 Administrator’s Guide

Serial Settings If Serial Port is selected above.

Baud rate: Specify the baud rate used to communicate with the CCTV
system. These speeds are available:
• 2400 baud
• 9600 baud
• 19,200 baud
• 38,400 baud
The default baud rate is 9600.

Port: Select from one of the available serial ports. As shown in the
example, the port designation includes the computer name.
This enables you to specify a port on a remote networked
computer. This should be the port used by the video capture
card. Make sure that there are no conflicts. Default is COM1.

Data Bits: Select from the combo box pick list the number of data bits
this port uses to communicate with the CCTV switcher.
The default is 8.

Parity: Select from the combo box pick list the kind of parity this port
uses to communicate with the CCTV switcher.
The default is N (no parity).

Stop Bits: Select from the combo box pick list the number of stop bits
this port uses to communicate with the CCTV switcher.
The default is 1.

Network Settings If TCP/IP is selected.

IP Address: Enter the IP address for the Velocity workstation or Lantronix

device server connected to the switcher.
If you don't know this IP address, consult your system
administrator.

IP Port: Enter the IP port address for this CCTV port.

All network ports possess a 4-digit address, such as 3001,
used to identify the NIC's physical port address within the host
PC's addressing system.
For this address, consult your system administrator.

Max retry Either enter a number, or use the and spin buttons
attempts: to indicate the number of retries this computer will attempt
between it and the XBox before it times out and stops trying.
The default is 10 retries.

Enable this Port Check this box to indicate that the port is currently connected
to the CCTV switcher and is functioning properly.
Deselect the box if the port is not yet functional.

Advanced Click this button to reveal the Advanced Port Settings dialog
box (refer to “Advanced Port Settings,” starting on page 66).

662 CCTV: Port Configuration

 MAN006-0612

Port Manager
If you are not currently using CCTV, you should switch the Hirsch Port Manager Service
to a manual setting. This not only saves processing time but also prevents several
problems that may occur with Velocity logging and reporting functions.
 Skip this procedure if you are using CCTV. Velocity requires the Port
Manager to work automatically when a CCTV switcher is attached to the
host PC.
To switch the Hirsch Port Manager Service to manual:
1. At the Windows desktop, right click on the My Computer icon.
2. Select Manage.
The Computer Management screen appears.
3. From the Services and Applications directory, select Services.
4. Select Hirsch Port Manager Services.
5. Double click the Hirsch Port Manager Services option.
A property sheet appears.
6. At the 'Startup type' combo box, change the option from Automatic to Manual.
7. Click OK.
The Computer Management screen reappears with Hirsch Port Manager Services
shown as manual.

CCTV: Port Configuration 663

Velocity Version 3.1 Administrator’s Guide

CCTV: Switcher Configuration

Velocity 3.1 currently supports several switchers:
 American Dynamics 2150
 Burle LTC8000 series
 Burle LTC8300 series
 Panasonic WJ-SX550
 Pelco 6700, 6800, and 9700
 Vicon VPS 1344
 Vicon VPS 1466 series
Once the CCTV Switcher is physically connected to the Velocity server/workstation
according to instructions in the individual switcher manual, perform this procedure to
add and configure the switcher.
To define a CCTV Switcher:
1. At the System Tree window, click and expand the Configuration system folder to
reveal the Interface Configuration folder.
2. Expand the Interface Configuration folder to reveal the CCTV folder.
3. Expand the CCTV folder to reveal the currently-defined ports.
4. Click to highlight the port to which the new switcher is connected.
The Add New CCTV Switcher option appears in the components window.
5. From the components window, double click the Add New CCTV Switcher option.
The Switcher Properties dialog box appears with the General page displayed. For
more on this, refer to “Switcher Properties Dialog Box,” starting on page 665.
6. Fill out this dialog box as required.
7. If you are adding triggers and actions to this switcher, click the Triggers/Actions
tab.
The Triggers/Actions page appears.
8. Click Apply. This saves all changes.
9. Click Close to close the screen and return to the main menu.
The newly-defined CCTV switcher appears in both the system tree under the port file
and in the components window.

664 CCTV: Switcher Configuration

 MAN006-0612

Switcher Properties Dialog Box

The Switcher Properties general page looks like this:

The fields on this dialog box are specified below:

Name: Enter a name for this switcher. There is a maximum of 40

characters.

Description: Enter a description for this switcher. There is a maximum of 40

characters.

Type: From the combo box, select the type of CCTV switcher
connected to the port. All currently-supported switchers are
displayed in this list.

Index: Unique number issued for each switcher added. This number
is automatically generated but can be changed if required by
selecting another index number from the pull-down list. 99
index numbers are available.

CCTV: Switcher Configuration 665

Velocity Version 3.1 Administrator’s Guide

Inputs/Outputs

Total number Enter the number of video inputs available for this switcher.
of Video This indicates the number of cameras that can be connected
Inputs: to this switcher. The default is 2 video inputs.

Total Outputs: Enter the number of video outputs available for this switcher.
This indicates the number of CCTV monitors that can be
connected to this switcher. The default is 2 outputs.

Monitor Indicates which switcher monitor is assigned to which Velocity

Outputs workstation.
Assigned to This window contains a list of each Velocity workstation
Velocity currently defined for the system. By default no monitors are
Workstations: assigned to workstation viewers and <None> appears in the
Monitor column for each.
The operator can assign an available monitor output to a
workstation in this manner:
1. Click the cell in the Monitor column for a given workstation.
A list of monitors not yet assigned appears as shown
below:

2. Select the monitor number you want to associate with the

workstation.
3. Click OK to confirm the mapping.

666 CCTV: Switcher Configuration

 MAN006-0612

CCTV: Camera Configuration

To configure each CCTV camera for use with Velocity:
1. At the Velocity System Tree window, click and expand the Configuration system
folder to reveal the Interface Configuration folder.
2. Expand the Interface Configuration folder to reveal the Switcher folder for the
connected camera(s) you need to define.
The Camera folder should appear.
3. Select the Camera folder.
In the component window, all currently available cameras for this switcher appears.
This reflects the number of inputs you specified in the Video Inputs text box on the
Switcher Property sheet.
4. Right click one of the cameras and select Properties from the pop-up option list.
The Camera Properties dialog box appears. For more on this, refer to “Camera
Properties Dialog Box” on page 667.
5. Define the new camera as required.
6. Click the Presets tab and assign the presets that can be used with this camera.
7. When you're finished, click OK.
Repeat these instructions for every camera connected to the specified switcher.

Camera Properties Dialog Box

Use the Camera Properties page to define the basic characteristics of this specific CCTV
camera.
An example of this screen is shown below:

CCTV: Camera Configuration 667

Velocity Version 3.1 Administrator’s Guide

There are four fields on this property sheet:

Name Enter the name for this camera.

Description Enter a brief description for this camera, such as its position.
There is a maximum of 40 characters.

Video Input Enter the number of the Video Input port on the switcher used to
on Switcher connect this camera to the switcher.
For example, if you connected this camera to Video Input 1, you
would enter '1' here.

Enable Check this box to display the camera name and address on the
Display of CCTV Viewer title bar. This name and address is generated by
Camera Velocity, not the native switcher.
Name... If left unchecked, no Velocity-generated camera name or address
appears on the title bar. If there is a “real” CCTV keyboard also
controlling the switcher, Velocity has no way of knowing when a
camera/monitor switch occurs. Ideally the switcher overlays the
camera name on the video itself, thereby eliminating the need for
the Viewer to identify the camera.
The default is enabled.

Once you have completed this page, you can click on the Presets tab to select the
Presets page. For more on this, refer to “Presets Page” on page 668.

Presets Page
Velocity supports camera presets through the Presets tab on the Camera Properties
dialog box:

Using this screen you can associate presets with a specific camera. Initially, presets are
defined by the switcher to which the camera is connected. These presets are then
available to the switcher and its keyboard; however, Velocity cannot be used to
mediate this process until you associate the presets with the camera using this screen.
For more on this, see “Using Presets” on page 669.

668 CCTV: Camera Configuration

 MAN006-0612

Using Presets
Presets are memorized camera viewing positions and actions. For example, you can set
a camera to focus on a particular part of the room whenever this preset is selected. If
the camera supports pan and tilt features, you can also set a camera to pan across a
room at a particular speed and through a specific number of degrees each time a
preset is chosen.
While Velocity does not enable an operator to define a preset from within Velocity, it
can identify and call a preset once it is defined by the switcher that controls the
camera. Use the following instructions enable the operator to configure presets for
activation from within Velocity.
To assign a preset:
1. Define a preset through your switcher software.
Give each preset routine a preset number. Each switcher defines its presets in
slightly different ways. For more on defining presets for your switcher, refer to your
switcher's user guide.
2. Open Velocity and at the system tree pane, expand the tree to reveal the available
cameras under the Interfaces Configuration folder.
3. Right click on the camera whose preset(s) you want to identify.
4. From the pop-up list, select Properties.
The Camera Properties dialog box appears (see page 667).
5. Click the Presets tab.
The Presets property sheet appears (see page 668).
6. Click the Preset column cell you want to name. Initially, it should display <New>.
7. Enter or select the preset number.
This number should correspond to the number assigned this preset when it was
defined on the switcher.
8. Click the 'Name' cell to the right of the 'Preset' number.
9. Enter the preset name you want to use for this preset.
This is the name that will appear each time you call up this preset in the CCTV
Viewer.
An example of this appears below:

10. Click Apply.

CCTV: Camera Configuration 669

Velocity Version 3.1 Administrator’s Guide

11. Repeat Steps 3 - 10 to identify other presets, or click OK to leave the Camera
properties pages.
12. To trigger a preset through some predefined action, refer to “Using Trigger Action
Manager” on page 1187.
13. Enter the CCTV Viewer and specify the preset you want to go to.

670 CCTV: Camera Configuration

 MAN006-0612

CCTV Viewer
The CCTV Viewer is accessed through either of these procedures:
 From a Graphics map, right click the appropriate camera icon and select View...
from the pop-up option list.
 From System Tree window, click on the Cameras folder then right click on the
appropriate camera icon in the Components pane and select View from the
pop-up option list.
The CCTV Viewer like the following example appears:

 The first image you view after bringing up Velocity may be slightly
distorted. Click to another image then click back and the problem is
resolved.
Use this screen to control the movement and actions of the camera.
This viewer contains the following controls:

From the Menu Bar:

File Two choices are available:

Open Picture...—click this option and the Open dialog box
appears. Select from the available snapshots (captured using the
Grab option) to display in the screen. This is a good way to
review footage.
Close Picture—click this option to close the Viewer.

CCTV Viewer 671

Velocity Version 3.1 Administrator’s Guide

Command

Presets Select from one of two options:

• Go to Preset...—The Go to Preset dialog box appears. Select
the preset number you need from the drop-down combo box
list or enter a new number in the text field and press OK. This
selects a pre-defined camera and position from the available
preset options. The preset is determined by the Preset
property sheet on the Camera Properties page. For more on
this, refer to “Using Presets” on page 669.
• Set as Preset...—The Set as Preset dialog box appears. Select
a preset number from the drop-down combo box list or enter
a new number in the text field and press OK. This sets the
current camera and position based as a preset number. The
preset is determined by the Preset property sheet on the
Camera Properties page. For more on this, refer to “Using
Presets” on page 669.

Tour Initiate a series of shots that take you to every camera in the
system. The shots are preset by the switcher. Select from one of
two options:
• Start Tour...—The Start Tour dialog box appears. Enter the tour
number in the text field and press Enter. The switcher begins
sending video based on the pre-defined tour. Only switchers
that support tours can be activated by this option.
• End Tour Mode—End the tour.

Call Camera Selecting this menu item displays the Call Camera to Monitor
to Monitor... dialog like this:

Enter the camera and monitor numbers in their respective fields,

then click OK. The specified camera output is displayed on the
selected monitor number.
If you map the monitor to the Viewer, is the same as if you
selected the 'Select Camera…' field. The Viewer displays the new
camera in the current monitor.

Grab Select to take a snapshot of the currently displayed view. This

snapshot is stored as a JPG file in a designated specified file. The
default folder is \Photos.
You can then review the picture using File > Open Picture.

672 CCTV Viewer

 MAN006-0612

View Select this option to change the size of the Viewer. There are
three options:
• Small—3" x 3.75" (the default size)
• Medium—4.25" x 5.5"
• Large—5.5" x 7.5"
This menu option also includes the toggle option Status. When
selected, the status bar appears at the bottom of the CCTV
Viewer. The default is selected.

From the Tool Bar: (these functions are dependent on the capabilities of the
switcher)

Pan-Tilt: Click this button to pan or tilt.

Zoom: Click this button to zoom in or out.

Focus: Click this button to focus on the currently displayed image.

Iris: Click this button to iris the image.

Auto Pan: Click this button to initiate an automatic pan of the area
within the selected camera's view.

CCTV Camera Configuration: Click this button to display the CCTV

Camera Configuration dialog box.

Lock the Viewer so that no one can access another picture until
the operator has unlocked it.
The default is unlocked. Click to toggle locked/unlocked.
This feature is only functional when enabled on the CCTV
Preferences page.

From the Keyboard:

Insert Focus in.

Delete Focus out.

Home Zoom in.

End Zoom out.

CCTV Viewer 673

Velocity Version 3.1 Administrator’s Guide

CCTV Viewer Control Functions

Use the CCTV Viewer to perform the following functions:
 Only one of the following functions can be active at a time. Also, these
functions only work if the camera and attached switcher support the
function. For example, if you are trying to pan/tilt a fixed camera, the
command is ignored and an error message appears.
The Zoom and Focus functions also support keyboard shortcuts, as noted.

Pan-Tilt
1. Click the Pan/Tilt icon on the Viewer tool bar, .
2. Left click on the image in the CCTV Viewer.
3. Drag the mouse in any vertical, horizontal, or diagonal direction. The farther you
drag, the faster the Pan-Tilt happens.
4. Let go to stop. This works even if dragged outside the viewer.

Zoom Mode
1. Click the Zoom icon on the Viewer tool bar, .
2. Perform one of the following:
• Left click and hold on the image in the Viewer to zoom in.
• Right click and hold on the image in the Viewer to zoom out.

Hint Keyboard Shortcuts:

Press the Home key to Zoom In
Press the End key to Zoom Out.

Focus Mode
1. Click the Focus icon on the Viewer tool bar, .
2. Perform one of the following:
• Left click and hold on the image in the Viewer to focus near.
• Right click and hold on the image in the Viewer to focus far.

Hint Keyboard Shortcuts:

Press the Insert key to Focus In
Press the Delete key to Focus Out.

Iris Mode
1. Click the Iris icon on the Viewer tool bar, .
2. Perform one of the following:
• Left click and hold on the image in the Viewer to open up the iris
• Right click and hold on the image in the Viewer to close down iris.

Auto Pan
Click the Toggle Auto Pan button, , on the Viewer tool bar.
 Click this button once and the selected camera begins to pan automatically.
 Click the button again and the camera stops panning.

674 CCTV Viewer

 MAN006-0612

The automatic pan characteristics for a specified camera are determined by the
switcher and the camera.

CCTV Camera Properties

Click the CCTV Camera Properties button on the Viewer tool bar, , to bring up the
Camera Properties dialog box for the currently selected camera.
For more on the Camera Properties dialog box, refer to “Camera Properties Dialog Box”
on page 667.

Triggering CCTV Actions

You can trigger CCTV cameras to perform specific actions when a specified Event
occurs. To learn more about this, refer to “Trigger Action Manager,” starting on page
1187.

CCTV Viewer 675

Velocity Version 3.1 Administrator’s Guide

676 CCTV Viewer

 MAN006-0612

Customization
Manager
Use Customization Manager to customize text appearing on menus and dialog boxes
throughout the Velocity program. This includes the following modules and windows:
 DIGI*TRAC Network
• Alarms
• Return to Normal Events
• Events
• Software
 Components
 Integrated Devices
• Integrated Alarms
• Integrated Events
This means you can change the default values for many fields and options available on
Velocity. This is very useful when you need to customize Velocity to accord with the
terminology used in a particular company or a particular operator—even if that
customization involves changing the language displayed.
For example, say half of your company's operators are Spanish-speaking while the
other half speak English. Using Customization Manager, you can create a version of
Velocity that can be read easily by either the Spanish- or English-speaking operators.
The Customization manager can also be used for creating and maintaining ToolTipText.
For details on using the Customization Manager, refer to “How To Use Customization
Manager,” starting on page 678.

677
Velocity Version 3.1 Administrator’s Guide

How To Use Customization Manager

Before you can use this module:
 the operator must first be a member of a role that can use this module (see page
285).
 the 'Access and Enable Customized Values for Components in Customization
Manager' box on the General page of Velocity Preferences must be checked (see
page 44).
To use Customization Manager:
1. To open Customization Manager, do one of the following:
• At the Velocity Administration main screen, click the top-level Configuration
file. The major Velocity modules appear in the Components window, amongst
which is Customization Manager.
• From the Velocity menu toolbar, select Console > Customization.
The Customization Manager main screen appears. For more on this, refer to
“Customization Manager Main Screen” on page 679.
2. From the Element Tree pane, select the type of information you want to customize.
• Expand DIGI*TRAC Network to display Alarms, Events, and Software
• Expand or select Components to display customizable components
The appropriate matrix appears in the customize pane.
3. Customize each DIGI*TRAC Network element as required. Select from:
• Alarms (see “Alarms” on page 681)
• Components (“Components” on page 687)
• Events (see “Events” on page 683)
• Return to Normal Events (see “Return to Normal Events” on page 684)
• Software (see “Software” on page 685)
• Integrated Alarms (see “Integrated Alarms” on page 690)
• Integrated Events (see “Integrated Events” on page 692)
When you click in a matrix column—whether alarms, events, or software—you find
either a read-only value (you can't change these), pull-down option lists (select
from one of these), or type-in fields (type whatever you require in these). For more
on these, refer to the specific matrix type.
4. Customize each component element as required.
Enter new values for field names, captions, or ToolTipTexts that accompany it.
Default values for captions and fields are provided in the Default Value column.
Foreign languages, such as Japanese and Chinese, are also acceptable.
5. When you're finished, select View > Refresh.
The screen is refreshed and the new values are displayed.
If you want to remove your customized settings and return to the factory defaults,
you can use the Reset Customized Values feature.
6. To leave Customization Manager, select File > Close.
Once Velocity is customized, configure Velocity in this way:
If this is a Velocity Server or Standalone Workstation:
1. Right click the SCM icon.
2. Select Settings from the pop-up option list.

678 How To Use Customization Manager

 MAN006-0612

3. Select Database.
4. Check the 'Broadcast Customized Values for Alarms & Events' box.
If this is a Velocity Client:
1. Open Velocity.
2. From the Velocity main menu, select Console > Preferences.
3. Click the General tab.
4. Check the 'Access and Enable Customized Values...' box.
Finally, if you have made changes to events or alarms in Customization Manager, these
changes don't take effect until you have restarted Security Domain Service.
 If you have performed point-level customization, you don’t need to do
this procedure.
To do this:
1. Exit Velocity.
2. Stop Security Domain Service through Service Control Manager (see page 1073).
3. Restart Security Domain Service through Service Control Manager.
4. Restart Velocity.

Customization Manager Main Screen

The main Customization Manager screen looks like this example:

The toolbar, fields, and panes on this screen are defined below:

Option Toolbar Use this toolbar to select options for this manager.
This toolbar includes the following options:
File – Restore Factory Defaults - abandon all customized
settings and return to original default settings (see
“Resetting to Default” on page 693)
Close - close Customization Manager.
View – Refresh - refresh settings displayed on the screen.
Help – Help Topics - Bring up this help file.

How To Use Customization Manager 679

Velocity Version 3.1 Administrator’s Guide

Font: Use this field to change the font of all text displayed for the
selected component.
This does not alter individual controls or text within the
component. All text inside the component shown in the CM
will have the same font as specified, except for message boxes.
Message boxes use the system default font and cannot be
changed; however, users can use CM to customize the text
found in the message.

Size: Use this field to change the size of all text displayed for the
selected component.
This does not alter individual controls or text within the
component. All text inside the component shown in the CM
will have the same size as specified, except for message boxes.
Message boxes use the system default size and cannot be
changed; however, users can use CM to customize the text
found in the message.

New Value: Use this field to change the default text value. Once this is
done, the element appears in the Customize Pane column and
displays in Velocity as the customized value.
Use the wildcard percent character, %, to indicate that the
required variable is inserted here. For example, using the value
'Input % Shorted' specifies that the number of the input is
inserted at the point where the % character appears. Thus, the
phrase would become 'Input 3 Shorted' or whichever input is
currently involved.
You are limited to 127 characters, including whatever value the
% wildcard takes. Foreign language characters are acceptable.

Element Tree This pane displays the element tree. Expand or contract this
Pane tree as you would for any system tree in Velocity.
The main elements displayed on this pane are: DIGI*TRAC
Network and Components.

Customize Pane This pane displays the matrix for the element you selected in
the Element Tree pane.
Use this pane to customize the values as required.
Scroll through the list of available columns using the scrollbar at
the bottom of this pane.
Like most tables in Velocity, you can sort the element and
reorder the columns as required. Refer to “Column
Management,” starting on page 34.

680 How To Use Customization Manager

 MAN006-0612

Alarms
When you select the Alarms folder from the Tree pane, a table like this appears:

The columns on this table are defined below:

EventID This is the event number Velocity assigns to the alarm. You
can't change this.

Point Click in this column then click the button to bring up the
Customization Point Customization screen.
For more on this, refer to “Point Customization” on page 694.
The default value is [Off].

Visibility This indicates the Velocity modules where this alarm is active
and displayed.
To change this value, click in this column and select from one
of the available options in the drop-down list:
Broadcast Only—this alarm is used within all Velocity
modules, but does not write to the SQL log
Broadcast & SQL Log—this alarm is used in Velocity and is
also logged in the SQL database. This is the default setting.
SQL Log Only—this alarm is logged in the SQL Server
database but does not display in any Velocity modules
Ignore—this alarm is not used by either Velocity or the SQL
database

How To Use Customization Manager 681

Velocity Version 3.1 Administrator’s Guide

Options This enables you to associate a WAV sound file with this alarm
and can be played every time this alarm appears in the Alarm
Viewer.
Click this column. The ellipsis button appears, .
Click the ellipsis button and the Advanced Options dialog box
appears. Use this dialog box to select an audio file (such as
WAV files). For more on this dialog box, refer to page 696.
Once you've associated a WAV file with a specific event, a
hand sign appears every time you mouse across the event in
either Customization Manager or Alarm Viewer. When this
hand sign appears, simply click to listen to the selected file
(providing you have your speakers turned on). If you select
[None], the hand sign does not appear when you mouse over
the event.

Default Value This is the default title of the alarm. If you need to change it,
do so in the Customized Value column.

Customized To change the default value, click here and type in a new value
Value in the New Value field above the column.
For instance, as shown in the matrix above, the title of
'Memory Battery Bad' has been changed to 'Memory Cell
Poor.' This new value is displayed in place of the default value
whenever this alarm appears.
Foreign language characters can be input if the required fonts
are available.

Level Indicates the alarm level of this alarm.

Click in this column and select from the drop-down list the
priority level you need for this alarm. When this alarm is
activated, only those operators with levels above this number
can acknowledge it. The available values are 1 – 99 where 1 is
the lowest possible level (default) and 99 is the highest level.
This alarm level will be observed at every reader on this
DIGI*TRAC network. In order to specify that this alarm level will
only apply to selected readers, use the correct DIGI*TRAC
command in the Diagnostic Window.
For more on alarm levels, refer to “Alarm Levels” on page 698.

Instructions Specifies instructions the operator will see on the display when
this alarm occurs.
To customize instructions, refer to “Creating Instructions” on
page 698.
Once instructions are specified, [On] appears in the column as
shown in the example above. If no instructions are specified
for an alarm (the default condition), the word [Empty]
appears in this cell.
If an alarm of this type occurs, a prompt appears on the Alarm
Viewer under the Instruction tab, telling the operator how to
proceed.

682 How To Use Customization Manager

 MAN006-0612

Events
When you select the Events folder from the Tree pane, a table like this example
appears:

The columns on this matrix are defined below:

Event ID This is the number Velocity assigns to the event. You can't
change this.

Point Click in this column then click the button to bring up the
Customization Point Customization screen.
For more on this, refer to “Point Customization” on page 694.
The default value is [Off].

Visibility This indicates the Velocity modules where this event is active
and displayed.
To change this value, click in this column and select from one
of the available options in the drop-down list:
Broadcast Only - this event is used within all Velocity
modules, but does not write to the SQL log
Broadcast & SQL Log - this event is both used in Velocity and
logged in the database. This is the default setting.
SQL Log Only - this event is logged in the SQL Server
database but does not display in any Velocity modules
Ignore - this event is not used by either Velocity or the SQL
database

Default Value This is the default title of the event. If you need to change it, do
so in the Customized Value column.

Customized To change the default value, click in the appropriate cell and
Value type in a new title for this event in the New Value field above
the column. This new value is displayed in place of the default
value whenever this event appears.
Foreign language characters can be input if the required fonts
are available.

How To Use Customization Manager 683

Velocity Version 3.1 Administrator’s Guide

Return to Normal Events

When you select the Return to Normal Events folder from the Tree pane, a table like
this appears:

The columns on this matrix are defined below:

EventID This is the number Velocity assigns to the RTN event. You can't
change this.

Point Click in this column then click the button to bring up the
Customization Point Customization screen.
For more on this, refer to “Point Customization” on page 694.
The default value is [Off].

Visibility This indicates the modules where this RTN event is active and
displayed. Click in this column and select from one of the
available options in the drop-down list:
Broadcast Only - this RTN event is used within all Velocity
modules, but does not write to the SQL log
Broadcast & SQL Log - this RTN event is both used in Velocity
and logged in the SQL database. This is the default setting.
SQL Log Only - this RTN event is logged in the SQL database
but does not display in any Velocity modules.
Ignore - this RTN event is not used by either Velocity or the
SQL database.

Options This specifies a sound effect (WAV file) that is triggered when
the RTN occurs.
Highlight this cell and click the browse button to specify an
advanced option for this RTN event. The Advanced Options
dialog box appears.

Default Value This is the default title of the RTN event. If you need to change
it, do so in the Customized Value column.
A percent character, %, indicates that a variable is inserted here.
For example, the value Input % Shorted here is replaced by the
number of the input at the point where the % character
appears.

684 How To Use Customization Manager

 MAN006-0612

Customized To change the default value, click here and type in a new title
Value for this RTN event in the New Value field appearing above this
column. This new value is displayed in place of the default
value whenever this RTN event appears.
Use the wildcard percent character, %, to indicate that the
required variable is inserted here. For example, using the value
Input % Shorted specifies that the number of the input is
inserted at the point where the % character appears. Thus, the
phrase would become Input 3 Shorted or whichever input is
currently involved.
You are limited to 127 characters, including whatever value the
% wildcard takes. Foreign language characters can be input if
the required fonts are available. For more on this, refer to
“Foreign Language Text” on page 699.

Level Indicates the alarm level of this RTN.

Click in this column and select from the drop-down list the
priority level you need for this RTN. When this RTN is activated,
only those operators with levels above this number can
acknowledge it. The available values are 1 - 99 where 1 is the
lowest possible level (default) and 99 is the highest level. The
default is 1.
For more on alarm levels, refer to “Alarm Levels” on page 698.

Software
When you select Software from the Tree pane, a matrix like this appears:

Velocity uses these to report software module events such as port activation, polling
engine failures, DIGI*TRAC engine start-up and shutdown.

How To Use Customization Manager 685

Velocity Version 3.1 Administrator’s Guide

The columns on this matrix are defined below:

EventID This is the event number Velocity assigns to the software event.
You can't change this.

Visibility This indicates the modules where this software event is active and
displayed. Click in this column and select from one of the available
options in the drop-down list:
Broadcast Only - this software event is used within all Velocity
modules, but does not write to the SQL log
Broadcast & SQL Log - this software event is both used in
Velocity and logged in the database. This is the default setting.
SQL Log Only - this software event is logged in the SQL Server
database but does not display in any Velocity modules
Ignore - this software event is not used by either Velocity or the
SQL database

Default This is the default value of the software event. If you need to
Value change it, do so in the Customized Value column.
The % sign indicates that this is a variable dependent on the
component selected.

Customized To change the default value, click here and type in a new title for
Value this software event in the New Value field appearing above this
column. This new value is displayed in place of the default value
whenever this software appears as shown in the above example.
Use the wildcard percent character, %, to indicate that the
required variable is inserted here. For example, using the value
'Input % Shorted' specifies that the number of the input is
inserted at the point where the % character appears. For example,
if you were investigating Input 3, the number 3 would be
substituted for the % sign and the phrase would become 'Input 3
Shorted.' You are limited to 127 characters including whatever
value the % wildcard takes. Foreign language characters can be
input if the required fonts are available.

686 How To Use Customization Manager

 MAN006-0612

Components
When you select any component type from the Element Tree pane, a matrix like the
following example appears:

At the top of the list are two general-purpose categories:

 <Service Messages>
 <Shared System Resource Strings>
<Service Messages> is a list of all messages that can currently be displayed by Velocity
during the course of operation. The default string for each message is provided and
you have the option to change the message, if required.
<Shared System Resource Strings> are certain text elements, like Message Box or
Operator action messages, Velocity uses throughout its program. The default values for
these strings can be changed, if required.
The rest of the available components include text and widgets associated with dialog
boxes pertaining to every currently-configured Velocity system components.
Only those components which you have previously configured are represented in this
list. For example, if you have unbundled one or more doors and configured the inputs
and relays for those unbundled doors, both inputs and relays would appear in the
Components tree.
 Only <Service Messages> and <Shared System Resource Strings>
appear in this list, unless you have previously check the 'Access and
Enable Customized Values for Components in Customization Manager'
box on the General Preferences page. After you do this, each Velocity
component you open is instantly registered and displayed on
Customization Manager under the Components folder.
Notice that after each of these components there appears a number. This number is
the version number of the component module. For example, in the example above,
the Velocity component is followed by the number 1.0.210. This is the version of the
Velocity component you currently have installed on this Velocity server.

How To Use Customization Manager 687

Velocity Version 3.1 Administrator’s Guide

Hint This is a good way to keep track of which version you have for each component. If
you ever need Technical Support, they may ask you to open the Customization
Manager so that they can find out whether your components are up-to-date. You
can also keep track of the latest version of each component by accessing the
Hirsch website.

The Velocity component is a compilation of all buttons and features common to the
Velocity program interface, such as the main menu option bar selections (File, Printer
Setup, Graphics, and so on).
The columns that appear in a component's matrix are common to all components as
defined in the following table.

Item The type of text, combo box, or button specified. You can't change this.
The available items include:
Checkboxes - Text that appears next to checkboxes.
CommandButton - Text that appears on or next to command buttons,
such as Enter or Next.
CoolBars - Text associated with a group of toolbars.
Form - Text appearing in the title above a form.
Frames - Text that appears next to combo boxes.
GridColumnHeading - Text appearing in the heading of a column.
Labels - Text that appears before a text box, such as 'Input Name:'.
Menus - Text that appears on a drop-down, pop-up, or combo box
such as you would find on a menu bar.
MessageBox - Text that appears in a message box. The font combo
box is disabled for these items because the dialog box is created by
Windows, not Velocity which simply passes the text to display. The font
is determined by the Windows system font.
Network Failure Dialog Caption - text appearing in a caption above
a message indicating network failure.
OptionButtons - Text of options that appear when you select a combo
box with a drop-down option list.
Operator Action - Text appearing on the screen indicating an action
the operator is taking.
Service Text - Text appearing in a service message.
SSTabs - Text that appears on a tab.
ToolBars - Text associated with a group of icons or tools.
Other items associated with the Velocity interface are also represented.

688 How To Use Customization Manager

 MAN006-0612

Element Specify the kind of text this is. There are several choices:
Text - A string of text appearing on the screen, normally associated with
a field or message.
Caption - This is the text appearing on the screen when you display a
particular dialog box.
Form Caption - Text appearing in the caption (heading) above a form.
ToolTipText - This is the balloon text that appears when your cursor
touches the text. To type the tool tip text you want, click in the Default
Value or Customized Value cell for that element and type in the value
you want in the New Value field. For more on this, refer to “Mouse
Rollover” on page 689.

Default This is the default title of the item. If one of the letters is underlined (a
Value hot key), the letter is preceded by an ampersand (&). For example,
&File indicates that the F is underlined for quick access: File. You can
access this option by pressing Alt + f (for the main menu option bar).
If you need to change it, do so in the Customized Value column.

Customized Click here and type in a new value at the New Value field above. This
Value new value is displayed in place of the default value whenever this item
appears for the specific component. Place an ampersand (&) before
the letter you want underlined and designated as a hot key. To enter a
real ampersand, repeat the ampersand twice like this: &&.
For example, if you type Ad&ministration, the m will be underlined
like this: Administration. You can then access this option by pressing
m while the option is displayed or Alt + m if Administration appears on
the main menu option bar.
Foreign language characters can be input if the required fonts are
available. For more on this, refer to “Foreign Language Text” on page
699.

If you need to remove any customized settings you've made to either the <Service
Messages> or <Shared System Resource Strings> element and return to the factory
defaults, you can use the Reset Customized Values feature.

Mouse Rollover
For the operator of Velocity, one of the most potentially useful functions is the mouse
rollover. This feature enables the operator to view information about a specific field or
word simply by mousing over the top of it. A yellow message appears, providing
valuable information about the field required.
For example, while the operator is in Enrollment Manager entering information about a
new employee, she encounters a field called 'Confirmation Number'. What, she asks
herself, is a confirmation number? Which confirmation number? She rolls the mouse
over the field and a definition appears "the number HR provided". She asks the new
employee what number HR gave her and the number is entered.
To create one or more mouseover notes:
1. From the Element Tree pane in Customization Manager, expand the Components
element.

How To Use Customization Manager 689

Velocity Version 3.1 Administrator’s Guide

2. Click the highlight the Velocity module for which you want to create mouse rollover
comments.
 Only <Service Messages> and <Shared System Resource Strings>
appear in this list, unless you have previously checked the 'Access and
Enable Customized Values for Components in Customization Manager'
box on the General Preferences page. After you do this, each Velocity
component you open is instantly registered and displayed on
Customization Manager under the Components folder.
3. Select the caption for which you want to add mouse rollover text and click in the
ToolTipText row under either the Default Value or Customized Value column.
4. Enter the text you want to see in the New Value field.
5. Press Enter.
The new mouse rollover text appears in the Customized Value column.
The next time you enter the specified component and mouse over the designated
field, the text you entered here appears in a pop-up message.

Integrated Devices
Customization Manager supports changes to event and alarm messages that originate
from Velocity's integrated devices. These integrated devices include:
 Alarm Receiver (Central Stations)
 DVR
Two classifications are provided in the expanded system tree:
 Integrated Alarms
 Integrated Events
Both are discussed in this section.

Integrated Alarms
The Alarms folder of the Integrated Devices folder looks like this example:

690 How To Use Customization Manager

 MAN006-0612

The matrix shown here provides the qualified operator with these opportunities for
customization:

Device Class A read-only column indicating the type of integrated device

originating the alarm. Both Alarm Receiver and DVR are
represented in the Device Class.

EventID This is the event number Velocity assigns to the alarm. You
can't change this.

Point Click in this column then click the button to bring up the
Customization Point Customization screen.
For more on this, refer to “Point Customization” on page 694.
The default value is [Off].

Visibility This indicates the integrated device where this alarm is active
and displayed.
To change this value, click in this column and select from one
of the available options in the drop-down list:
Broadcast Only—this alarm is used within all Velocity
modules, but does not write to the SQL log
Broadcast & SQL Log—this alarm is used in Velocity and is
also logged in the SQL database. This is the default setting.
SQL Log Only—this alarm is logged in the SQL Server
database but does not display in any Velocity modules
Ignore—this alarm is not used by either Velocity or the SQL
database

Options This enables you to associate a WAV sound file with this alarm
and can be played every time this alarm appears in the Alarm
Viewer.
Click this column. The ellipsis button appears, .
Click the ellipsis button and the Advanced Options dialog box
appears. Use this dialog box to select an audio file (such as
WAV files). For more on this dialog box, refer to page 696.
Once you've associated a WAV file with a specific event, a
hand sign appears every time you mouse across the event in
either Customization Manager or Alarm Viewer. When this
hand sign appears, simply click to listen to the selected file
(providing you have your speakers turned on). If you select
[None], the hand sign does not appear when you mouse over
the event.

Default Value This is the default title of the alarm. If you need to change it,
do so in the Customized Value column.

How To Use Customization Manager 691

Velocity Version 3.1 Administrator’s Guide

Customized To change the default value, click here and type in a new
Value value in the New Value field above the column.
For instance, as shown in the matrix above, the title of
'Memory Battery Bad' has been changed to 'Memory Cell
Poor.' This new value is displayed in place of the default value
whenever this alarm appears.
Foreign language characters can be input if the required fonts
are available. For more on this, refer to “Foreign Language
Text” on page 699.

Level Indicates the alarm level of this alarm.

Click in this column and select from the drop-down list the
priority level you need for this alarm. When this alarm is
activated, only those operators with levels above this number
can acknowledge it. The available values are 1 - 99 where 1 is
the lowest possible level (default) and 99 is the highest level.
For more on this, refer to “Alarm Levels” on page 698.

Instructions Specifies instructions the operator will see on the display

when this alarm occurs.
To custom instructions, refer to “Creating Instructions” on page
698.
Once instructions are specified, [On] appears in the column as
shown in the example above. If no instructions are specified
for an alarm (the default condition), the word [Empty]
appears in this cell.
If an alarm of this type occurs, a prompt appears on the Alarm
Viewer under the Instruction tab, telling the operator how to
proceed.

Integrated Events
The Events folder of the Integrated Devices folder looks like this example:

692 How To Use Customization Manager

 MAN006-0612

The matrix shown here provides the qualified operator with these opportunities for
customization:

Event ID This is the number Velocity assigns to the integrated device

event. You can't change this.

Point Click in this column then click the button to bring up the
Customization Point Customization screen.
For more on this, refer to “Point Customization” on page 694.
The default value is [Off].

Visibility This indicates the Velocity modules where this event is active
and displayed.
To change this value, click in this column and select from one
of the available options in the drop-down list:
Broadcast Only - this event is used within all Velocity
modules, but does not write to the SQL log
Broadcast & SQL Log - this event is both used in Velocity and
logged in the database. This is the default setting.
SQL Log Only - this event is logged in the SQL Server
database but does not display in any Velocity modules
Ignore - this event is not used by either Velocity or the SQL
database

Default Value This is the default title of the event. If you need to change it, do
so in the Customized Value column.

Customized To change the default value, click in the appropriate cell and
Value type in a new title for this event in the New Value field above
the column. This new value is displayed in place of the default
value whenever this event appears.
Foreign language characters can be input if the required fonts
are available. For more on this, refer to “Foreign Language Text”
on page 699.

Resetting to Default
You may encounter situations which require you to remove the customized settings
from one or more of your CM folders. This is easily accomplished using the Reset to
Default feature.
To reset to factory defaults for a specific folder:
1. From the Element Tree pane, right click the folder you want to reset.
The Alarms, Events, Return to Normal Events, and Software folders all have this
capability.
You can also right click on either the <Service Messages> or <Shared System
Resource Strings> element under the Components folder.
2. Right click on the folder or element.
A pop-up menu appears.
3. Select Reset Customized Values.

How To Use Customization Manager 693

Velocity Version 3.1 Administrator’s Guide

All customized values for that folder or element are automatically reset to their factory
defaults.
To reset all customized values to their default values:
 From the menu tool bar, select File > Restore Factory Defaults.
This deletes ALL customizations including components, alarms, events, and software.

Point Customization
This function enables the qualified operator to customize each point within the Velocity
system. Points, in this context, are defined as devices connected to the system that are
associated with a specific event. Any of these event classes can involve point
customization:
 alarm
 RTN
 event
 integrated alarms
 integrated events
When you click on a specific event in the Point Customization column, a browse button
appears.
Click on this button and the Point Customization screen for that event appears like this
example:

Only those points that apply to the specific event appear in the left tree pane. For
example in the dialog box above, only readers appear since the event selected is 5009,
Physical tamper at Reader %.

694 How To Use Customization Manager

 MAN006-0612

From the left tree pane, double click on the point you want to customize. A line
appears in the right pane, indicating the current values assigned to this point for this
specific event like this example:

The columns and fields on this page are described below:

Event ID Read-only field indicating the Event ID you selected from

the main Customization Manager window.

New Value The field into which you enter a new value in order to
change the 'Customized Value' entry.

Point Matrix

Name The name of the point. This is a read-only field.

Address The location of the point in the new address format. This
is a read-only field.

Options Click in this column and click the browse button to access
the Advanced Options dialog box. If required, enable an
audio response and indicate the audio .wav file you need.

Customized The current description of this point.

Value To change it, click in the New Value: field above the point
matrix and enter a new value.

Level Click and select from the drop-down list the alarm level of
this point event.
The available values are 1 - 99 where 1 is the lowest
possible level (default) and 99 is the highest level.
For more on alarm levels, refer to “Alarm Levels” on page
698.

How To Use Customization Manager 695

Velocity Version 3.1 Administrator’s Guide

Instructions Specifies instructions the operator will see on the display

when this alarm point occurs.
To customize instructions, refer to “Creating Instructions”
on page 698.
Once instructions are specified, [On] appears in the
column as shown in the example above. If no instructions
are specified for an alarm (the default condition), the
word [Empty] appears in this cell.
If an alarm of this type occurs, a prompt appears on the
Alarm Viewer under the Instruction tab, telling the
operator how to proceed.

Escalation Select from the drop-down list the person group to which
this alarm will be sent if the original operator(s) does not
respond within a specified period of time.
Certain alarms and events are too important to be
ignored and this feature enables the qualified
administrator to assign a more senior member of the
Velocity staff to receive an alarm or event if it is not
quickly attended by its initial operator. The event/alarm
appears on their alarm/event viewer where it will remain
until acknowledged. However, escalation does not imply
repetition: the event/alarm will be escalated to the
specified person group only once.
For more on this, refer to “Escalation” on page 696.
The default is [None].

Escalation
Escalation is the technique for routing an alarm or event up a chain of authority until it
is acknowledged. This method is defined on a event by event basis using Point
Customization in Customization Manager. When you enable an event for escalation,
you specify a role to which that event is routed if it is ignored for an amount of time
specified on the Advanced page of the Velocity Settings screen (see page 1081).
For example, a system is set up to send alarms to members of the Role “Guards Shift
A”. After hours, when the regular shift guards go home, alarms would not get
acknowledged. A late shift guard that normally does not get the alarms for the vault
room can be assigned to a Role that can get those alarms even though his Role
normally would not. In CM select the alarms to escalate and assign them a Role the
late shift guard is in. Now, when he’s sitting there eating donuts at 2:00 am, if an alarm
comes in for that point and has not been acknowledged in n (seconds or minutes),
Velocity will escalate the alarm to the Role the late shift guard is in.

Advanced Options Dialog Box

The advanced options dialog box appears when you click in the Options column for
any event in Alarms, Integrated Alarms, or RTNs.

696 How To Use Customization Manager

 MAN006-0612

This dialog box enables you to specify an audio file (using the WAV format) to play
whenever a particular alarm or event occurs. For example, if you want Velocity to play a
ringing bell whenever someone sets off a particular motion detector, you could define
a WAV file with a ringing bell sound whenever the input connected to that motion
detector is activated at the controller.

Hint We recommend that you use this feature sparingly. Hearing the same notes or
words every time a specific alarm sounds can become taxing after a while. On the
other hand, if this alarm is particularly crucial, a sound file might help to focus the
operator's attention.

To enable and define an audio file:

1. At the Advanced Options dialog box, click the 'Enable Audio Response' checkbox.
The currently assigned WAV file for this event appears below this checkbox like this
example:

If no sound file is currently assigned for this alarm, then the word [None] appears
instead.
Notice that when you mouse over the file or [None] option in this Advanced
Options dialog box, the cursor arrow changes to a pointing hand.
2. Click to select one of these files or click the Setup button to find a new file.
The Locate a WAVE File to Play dialog box appears:

3. Search for the audio file you want.

Hint Ideally, you should have these stored on your hard disk under a dedicated
subdirectory. For quickest access, copy all of your WAV files over to the Program
Files\Hirsch Electronics\Velocity\ Multimedia subdirectory.

4. Select the file you want and click Open.

The file appears under the 'Enable Audio Response' checkbox.
5. Click OK.

How To Use Customization Manager 697

Velocity Version 3.1 Administrator’s Guide

The selection in the Options column now displays [On] as shown in the following
example:

Enabled WAV file

Once you've associated a WAV file with a specific event, a hand sign appears every time
you mouse across the specified event in the Alarm Viewer. When this hand sign
appears, you can click to listen to the selected file (providing you have your speakers
turned on). If you select [None], the hand sign does not appear when you mouse over
the event.

Alarm Levels
Alarm levels match alarms to those operators qualified to acknowledge them. Alarm
levels range from a value of 1 to 99. Use 1 to indicate normal operation.
For example, if an operator is defined as being able to acknowledge alarms up to level
45, then any alarm that is defined in Customization Manager as having a level of 50
cannot be acknowledged by this operator.
 This presupposes that the operator is a member of a role that can
actually view or acknowledge alarms the Alarm Viewer. Without the
necessary role, no such operation is possible.
Alarm Levels are used by a number of different components and modules within
Velocity including:
 Set levels for alarms in Customization Manager
 Set levels for RTNs in Customization Manager
 Set levels for points in Customization Manager
 Acknowledge alarms up to level for individual operators
Alarm levels are different from threat levels, which are responsible for disabling
credentials and readers at certain levels.

Hint Throughout Velocity, alarm levels are a way of routing certain alarms to specific
operators. This technique is used in concert with roles to create a system with
immense granularity. An operator or administrator thoroughly familiar with the
Velocity system should be able to restrict almost any alarms that occur within the
system to the view of only authorized personnel.

Creating Instructions
When alarms appear in the Alarm Viewer, they do not by default display a list of
instructions. However, instructions can be specified for a specific alarm through the
Customization Manager.
To insert new instructions:
1. Open Customization Manager.
2. In the element tree pane, click to highlight the Alarms folder.
All currently defined alarms appear in the customize window.
3. In the customize window, select the alarm whose instructions you want to
customize and scroll to the right until the Instructions column appears.

698 How To Use Customization Manager

 MAN006-0612

4. Click the cell that intersects the row of the alarm you want to customize with the
Instructions column.
An ellipsis button appears, .
5. Click the ellipsis button and the Instructions dialog box appears.

6. Enter the instructions you want the operator to see in the 'Operator will see...'
window.
Most of the time, these are instructions on what to do if this alarm occurs. Foreign
language characters can be input if the required fonts are available.
7. When you're finished, click OK.
Once instructions are specified, [On] appears in the column.
If no instructions are specified for an alarm (the default condition), the word [Empty]
appears in this cell.

Foreign Language Text

When a component is first registered in Customization Manager, the module detects
the local computer's regional and language setting and sets the locale in CM to the
same language as the default input language on the local computer. The 'Font' combo
box also displays the name of the locale registered for that component.
The font combo box pick list should be loaded with fonts available for that locale. If the
component's design time font can be found within the list, that font is chosen;
otherwise, another commonly used font is selected. For example, Japanese uses MS UI
Gothic while simplified Chinese uses SimSun, and so on.
If these fonts are not found within the list, the first available font is chosen. If you need
a more appropriate font for this text, click on the globe icon to the right of the 'Font'
combo box and select from the list that appears. The globe button provides access to a
large selection of international fonts. Normally, you shouldn't have to use this button.
Your computer should already be set to the language you want to use and the font
combo box should list all the fonts available for that language and locale on the local
machine.
 You need to know what you are doing in order to change the locale or
language setting. The safest procedure is to leave it as it is, unless the
location is not set to the same language as the local computer's default
input language. For most purposes, we assume that the user machines'
regional and language settings are set to whatever language they want
to customize to.

How To Use Customization Manager 699

Velocity Version 3.1 Administrator’s Guide

Customization Import/Export Wizard

Use the Customization Import/Export Wizard to create and export custom templates
(.cst files). These templates can later be imported and imposed upon another version
of Velocity to quickly and easily replace the existing Velocity template with the
customized template.
To export the template:
If you haven't already, use Customization Manager to customize Velocity as required.
When you're finished, exit Customization Manager and return to the main Velocity
screen.
1. From the Velocity menu tool bar, select File > Import/Export >
Customizations.
The Welcome screen appears.
2. Click Next.
The Function Selection screen appears.

3. Click Export.
The Export Customizations screen appears.
4. Click Next.
If a cst file already exists, a warning box appears asking to confirm overwriting it
with a new one.
a. Select Yes.
The Finish screen appears.
b. Click Finish to close the utility.
If no cst file is currently resident, the Import Customizations screen appears.
Make sure the customization.cst file you want is copied to the \Velocity
subdirectory on your hard drive.
5. Click Next.
The Importing Files dialog box appears.
6. Click Next to import the cst file to the current version of Velocity.
A progress bar is displayed while the import process completes. The
Customizations.cst file is placed automatically in the \Velocity subdirectory.
Once the import is completed, the Finish window appears with instructions on
what to do next.

700 Customization Import/Export Wizard

 MAN006-0612

7. Click Finish.
8. Distribute the new Customizations.cst file to the \Velocity directory of any new or
existing Velocity workstation requiring this update.
For instructions on importing the custom template, refer to the following instructions.
To import an existing custom template:
1. Copy the exported Customizations.cst file to the \Velocity directory of the new
or existing Velocity workstation requiring this update.
2. From the Velocity menu tool bar, select File > Import/Export >
Customizations.
Alternatively, use Windows Explorer or Run, locate the \Velocity directory, and start
the file CusManImportUtility.exe.
The Welcome screen appears.
3. Click Next.
The Function Selection screen appears.

4. Pick Import.
The Import Customizations screen appears.
If not already accomplished, copy the customization.cst file you want to the
...\Hirsch Electronics\Velocity subdirectory on your hard drive.
5. Click Next.
The Importing Files dialog box appears.
6. Click Next to import the cst file to the current version of Velocity.
A progress bar is displayed while the import process completes.
Once the import is completed, the Finish window appears with instructions on
what to do next.
7. Click Finish.

Customization Import/Export Wizard 701

Velocity Version 3.1 Administrator’s Guide

702 Customization Import/Export Wizard

 MAN006-0612

Diagnostic Window
This chapter details the operation and function of the Velocity’s Diagnostic Window
feature.
The topics discussed in this chapter include:
 Using the Diagnostic Window
 Generating Reports with the Diagnostic Window

703
Velocity Version 3.1 Administrator’s Guide

Using the Diagnostic Window

Use the Diagnostic Window to aid you in diagnosing problems with a connected
controller, use the Velocity Diagnostic window.
To use the Diagnostic Window:
1. From the Velocity menu bar, select Help > Diagnostic Window.
2. At the 'Controller:' combo box, select one of the currently installed controllers. This
is the controller you are going to run diagnostics on.
3. Perform one of the following procedures:
• At the ‘Execute Command Set’ combo box, select one of the existing
command sets.
• At the ‘Diagnostics Commands’ combo box, select one of the diagnostic test
commands. These include all the basic 88 Commands.
• At the ‘DIGI*TRAC Commands’ combo box, type in one of the DIGI*TRAC
commands.
 For a full list of all commands supported by DCL, refer to Chapters 3 and
4 in the DIGI*TRAC Design and Install Guide.
4. If needed, check the 'Clear window before executing' box.
This clears all information currently displayed in the window.
5. If needed, check the 'Show server diagnostics' box.
This splits the window into upper and lower panes, with the upper pane displaying
those commands the server issues and the lower pane displaying all results of
those commands returned by the specified controllers.
6. If needed, filter results by a specific address in this way:
a. Click one of the tabs in the results window.
A pick list appears.
b. Select the controller address whose results you want to see.
c. Repeat Steps a - b for each additional tab to specify other controller addresses,
as required.
You can specify up to four controller addresses in this way.
This step is particularly useful for filtering data reported from several different
controller addresses. You must, of course, have more than one controller defined
for this system.
7. Click the corresponding ellipsis button, .
The command is executed.

704 Using the Diagnostic Window

 MAN006-0612

A screen of data like the following example appears:

Notice that the current operation is explained in the top status window while the
results of the queries are displayed in the large data window.
For more on this screen, refer to “Diagnostic Screen” on page 706.
8. If you need to stop the data from scrolling off the window, click the Diagnostic
Stream at the top of the page. This halts the stream of information.
To resume scrolling, click the Diagnostic Stream again. You can tell which mode
you're in by looking at the top status window.
9. If you need to copy the information currently displayed on the screen to a text file,
click the Copy to Clipboard.
From here, you can paste the information to any Windows text editor, such as
WordPad or MS Word, that can handle RTF format. Notepad cannot be used.
10. If you want to generate a report from the data you just captured, click the Create
Report button.
For more on this, “Generating Reports” on page 709.
 If no action occurs in the Diagnostic Window for one minute, a message
like this appears:

Click Yes to continue receiving diagnostic data. Click No to turn off the
stream.

Using the Diagnostic Window 705

Velocity Version 3.1 Administrator’s Guide

Diagnostic Screen
The diagnostic window looks like this example:

The fields on this screen are defined briefly here:

Icon bar For information on this, refer to “Icon Tool Bar” on page 707.

Tabbed results This window displays the results of any command set or
window command that is run for specified controller(s). Click the tab
and a drop-down list appears displaying all currently defined
controllers. Specify the controller you want like this example:

The default on the first tabbed page is <All Systems>.

If required, you can execute a command/command set on
up to four controllers using the four tabbed pages.

Execute Select an existing command set, then click the execute

Command Set: button to the right.

Run reports & execute commands:

Controller: Select a controller to diagnose. Either select from the

drop-down combo box list or click the Browse button to
search for the correct controller.

706 Using the Diagnostic Window

 MAN006-0612

Diagnostics: Select from the drop-down combo box list one of the
available diagnostic commands, then click the execute
button to the right.
These constitute the 88 commands and indicate current
Velocity settings.

DIGI*TRAC: Either enter a DIGI*TRAC command or select from a

previously entered DIGI*TRAC command, then click the
execute button to the right.
All DIGI*TRAC commands described in Chapter 4 of the
DIGI*TRAC Design and Installation Guide are supported.
Note: DIGI*TRAC commands that are particularly useful of
diagnostic and troubleshooting purposes are the 88, 98,
and 188 commands.
If this command has been previously entered, it appears in
the combo box list.

Options:

Clear window Check this box to clear the window of all previous data
before executing before displaying data from the new command.

Show server Check this box to display an upper window in which the
diagnostics various commands issued by the Velocity server appear like
this example:

This enables you to corollate more easily the results with the
command(s) issued.
By default this window is hidden (not selected).

Click this button to execute the selected command.

Icon Tool Bar

The menu tool bar looks like this example:

Using the Diagnostic Window 707

Velocity Version 3.1 Administrator’s Guide

The Diagnostic Window menu bar provides six options:

Diagnostic Start or stop the stream of response from the diagnosed

Stream controller using this button.
— A green button indicates that the stream is not running
(OFF). Click to start the stream.
— A red button indicates that the stream is running (ON).
Click to stop the stream.
The stream must be ON before data will appear in the bottom
window.

Copy to Select this option to copy all of the information currently in the
Clipboard lower diagnostic pane to the clipboard from where it can be
pasted to many different programs including Notebook, a
spreadsheet, or a word processor.

Preview Click this icon to transfer the information displayed in the lower
Report diagnostic pane to the Reports screen. From here you can
review the report then print it, as required.
For more on this, refer to “Generating Reports,” starting on page
709.

Clear Window Select this option to clear both diagnostic panes. All information
currently displayed in these panes are erased.

Performance Select this option to display the Windows Performance Monitor.

This monitor enables you to track the current activity of the host
PC's CPU. This can be useful when you are trying to ascertain
how much traffic the CPU must process and can help in
determining the proper polling rate for this system.

SNIB2 Select this option to find and configure one or more SNIB2s
Configuration connected to this system.
When you click this icon, the SNIB2 Browser appears like this
example:

Double click on the SNIB2 you want to configure. For more on

this, refer to “Configuring SNIB2” on page 208.

Help Display the help file for Diagnostic Window.

708 Using the Diagnostic Window

 MAN006-0612

Generating Reports
There is an easy and effective way to create a report based on the information you
retrieve from a diagnostic run on the Diagnostic Window.
To generate a Diagnostic Window report:
1. At the Diagnostic Window, run a Diagnostics or DIGI*TRAC command.
The window looks like the following example:

2. With data on the screen, select Preview Report from the Diagnostic Window
menu tool bar.
A Report screen like the following example is generated from the results:

3. Review the report as required.

If necessary, use the scrollbars to move up or down, left or right, through the
report.
4. Click the Print button to print this report.
For more on creating and customizing reports, refer to the “Report Manager,” starting
on page 1005.

Generating Reports 709

Velocity Version 3.1 Administrator’s Guide

710 Generating Reports

 MAN006-0612

Updating Firmware Revisions

Velocity provides everything you need to download and update the latest version of the
Hirsch firmware from the Hirsch site.
The update programs are:
 CCM Firmware Update Wizard (page 712)
 SNIB2 Firmware Update Wizard (page 715)
These topics are covered in this chapter.

711
Velocity Version 3.1 Administrator’s Guide

CCM Firmware Update Wizard

Hirsch periodically issues updates of its CCM firmware. These updates help Velocity run
more efficiently and add new features.
This procedure is different from downloading controller
information (page 133). Use the firmware download
procedure only to download firmware revisions to specific
controller CCMs.
Another warning: if the CCM firmware download is somehow
interrupted, it may damage the CCM. You might have to
remove the damaged CCM and replace it with a new one,
then try this procedure again. For this reason, it's a good idea
to keep a few spare CCMs on hand.
The update process happens in three steps:
1. Acquire the latest CCM firmware version.
2. Download the new version using the Import Wizard.
3. Update the CCM Firmware using the CCM Firmware Wizard.
Each step is explained below.

Acquire Firmware
Acquire the correct CCM firmware revision in one of two ways:
 Download the latest version from the Hirsch website
 Contact Hirsch and have them mail you the latest version on either a DVD or floppy
diskette
The first method is the easiest, particularly if you have a reasonably fast internet
connection.
To download the firmware from the Hirsch website:
1. Open your web browser.
2. Go to this location: http:\\www.hirschelectronics.com.
3. Click Technical Support.
4. Click Downloads and Documents.
5. Select the latest CCM firmware download appropriate to the version of Velocity you
are running.
For example, if you are running Velocity 2.5, look under the Velocity 2.5 section of
this page and select the Download CCM 7.2.x option. The File Download dialog box
appears.
6. Click Save.
The Save As dialog box appears.
7. Select the directory where you want this file downloaded and click Save.
The executable file is downloaded to the specified directory. Once this is done, use the
following instructions to update your CCMs using the downloaded firmware revision.

712 CCM Firmware Update Wizard

 MAN006-0612

Import Firmware
To import CCMs:
 Follow the instructions in the CCM Import Wizard to access and convert the
firmware revision. For more on this, refer to “CCM Import Wizard,” starting on page
388.
If you downloaded the latest version from the Hirsch website, then navigate to the
directory where you copied the file. If you have a Hirsch DVD or floppy diskette with the
latest version on it, indicate the DVD or floppy drive. The CCM Import Wizard converts
the firmware to a downloadable form.

Update Firmware
To update the imported firmware:
1. From the system tree window, expand the tree until the controller you want is
displayed.
2. Right click the controller to which you want to download firmware.
3. Select the Properties option from the pop-up option list.
The Controller dialog box appears with the General property sheet displayed.
4. Click the Update CCM Firmware... button under the Firmware Revision section.
A warning appears like this:

This warning indicates that you should not interrupt this process or stop any
services while the download is in progress. An interruption at this point can
seriously damage the CCM and may require CCM replacement.
5. Click Yes to continue.
A second warning screen appears like this:

Read this screen carefully before continuing. It contains notes and warnings about
the download process and can help you avoid some pitfalls of the firmware
download process.
6. At the 'Select firmware version to update' pick list box, select the firmware version
you want to download to the selected controller.

CCM Firmware Update Wizard 713

Velocity Version 3.1 Administrator’s Guide

In most cases, you should select the latest version appearing at the bottom of the
option list. All versions of the firmware you have previously copied to your Velocity
server/workstation using CCM Import Wizard are displayed in this option list.
Versions are listed alphabetically.
If Velocity doesn't find any new CCM firmware versions, the message 'No firmware
binaries available' appears in the combo box instead. Click the Cancel button to
abort the update process.
7. Click Download.
The download begins.
8. Open the Status Viewer and follow the progress of the download on the Event
Viewer main screen.
The Status Viewer indicates when the download is complete. For more on the
Status Viewer, refer to “Status Viewer,” starting on page 1173.
9. Repeat Steps 1 - 8 for each CCM you need to update.
 Downloading firmware to a CCM can take 40 minutes or more. When
you are downloading two or more controllers, plan on more time.
Schedule this activity for a time when security activity is normally low.

714 CCM Firmware Update Wizard

 MAN006-0612

SNIB2 Firmware Update Wizard

Hirsch periodically issues updates of its SNIB2 firmware.
The update process happens in three steps:
1. Acquire the latest SNIB2 firmware version.
2. Download the new version using the SNIB2 Download Wizard.
3. Update the SNIB2 firmware using the SNIB2 Update Firmware Wizard.
Each step is explained below.

Acquire SNIB2 Firmware

Acquire the latest SNIB2 firmware in one of two ways:
 Download the latest version from the Hirsch website
 Contact Hirsch and have them mail you the latest version on either a CD or floppy
diskette
The first method is the easiest, particularly if you have a reasonably fast internet
connection.
To download the firmware from the Hirsch website:
1. Open your web browser.
2. Go to http:\\www.hirschelectronics.com.
3. Click Technical Support.
4. Click Downloads & Documents.
The latest SNIB2 Firmware file should appear on this page.
5. Click to select the latest SNIB2 firmware.
The File Download dialog box appears.
6. Click Save.
The Save As dialog box appears.
7. Select the directory where you want this file downloaded and click Save.
The executable file is downloaded to the specified directory. Once this is done, use the
following instructions to update your SNIB2s using the downloaded firmware revision.

Import SNIB2 Firmware

Use the SNIB2 Import Wizard to access and convert the firmware revision. For more on
this, refer to “SNIB2 Import Wizard,” starting on page 403.
If you downloaded the latest version from the Hirsch website, then navigate to the
directory where you copied the file. If you have a Hirsch CD or floppy diskette with the
latest version on it, indicate the CD or floppy drive. The SNIB2 Import Wizard converts
the firmware to a downloadable form.

Update SNIB2 Firmware

The update process takes place in stages:
 For each multi-dropped SNIB2 chain, update your master SNIB2.
 Once the master SNIB2s are updated, update the 'slave' SNIB2s downstream from
the master.

SNIB2 Firmware Update Wizard 715

Velocity Version 3.1 Administrator’s Guide

To update a SNIB2:
1. From the system tree window, expand the tree until the controller containing the
master SNIB2 is displayed.
2. Right click the master SNIB2-installed controller.
3. Select the Properties option from the pop-up option list.
The Controller dialog box appears with the General property sheet displayed.
4. Click the Update SNIB2 Firmware... button under the Firmware Revision section.
A warning appears, indicating that this update is not for setups and should only be
used for updating new firmware.
5. Click Yes to continue.
A second warning screen appears. Read this screen carefully before continuing. It
contains notes and warnings about the download process and can help you avoid
some pitfalls of the flash download procedure.
6. At the 'Select firmware version to update' pick list, select the firmware version you
want to download to the controller. In most cases, you should select the latest
version appearing at the bottom of the option list.
All versions of the firmware you have previously copied to your Velocity
server/workstation using the SNIB2 Import Wizard (and not deleted) are displayed
in this option list. Versions are listed alphabetically.
7. Click Download.
The download begins. You can follow the course of the update from the Alarm
Viewer.
8. Open the Status Viewer and follow the progress of the download on the Status
Viewer main screen.
The Status Viewer indicates when the download is complete. For more on the
Status Viewer, refer to “Status Viewer,” starting on page 1173.
9. Once the master SNIB2 update is completed, repeat Steps 1-8 to initiate updates
for each downstream 'slave' SNIB2.
Unlike the master SNIB2, you don't have to wait for each downstream controller to
finish updating before beginning the next. Do them one after another. As each
SNIB2 completes updating, its status is displayed in the Event Viewer window like
this example:

 Each SNIB2 update can take three minutes or more. When updating two
or more SNIB2s at the same time, the figure on three minutes per
controller. Plan this activity for a time when security activity is normally
low.

716 SNIB2 Firmware Update Wizard

 MAN006-0612

DVR / NVR Configuration

and Usage
Velocity now includes functionality for Digital Video Recorders (DVRs) and Network
Video Recorders (NVRs). As more companies migrate to digital video cameras for their
surveillance, they can now replace traditional forms of data capture, particularly VCRs
using analog video tape, with DVRs that store images on hard disks.
For the security professional, DVRs offer the advantages of:
 Simultaneous video capture from one or more cameras at a central location
 Video storage in a space-saving, easily transferable file formats
 Longer storage life for videos
 Instant review and indexing of captured video
 Easier editing of captured video
 Perfect duplication of video for distribution or legal presentation
 Network accessibility
So, for example, a guard can review a suspicious incident by keying in the exact time
and date without having to review hours of tape. A felonious act caught on video can
then be sent instantaneously via internet to the proper authorities. Since the video is
digital, copying it does not degrade the image.
Because all DVRs and NVRs also incorporate Ethernet connections, video is easily
transferable across LANs or the internet. This means, for example, that an operator in
New York or Los Angeles can almost instantly access and review video from a DVR or
NVR located in Paris or Dhakar.
Velocity now incorporates several interfaces for using DVRs and NVRs including Live
Video and Video Explorer. These interfaces enable qualified operators to view, review,
edit, duplicate, and export video stored by one or more DVR/NVRs.
 DVRs currently supported are American Dynamics, Pelco, and Bosch.
NVR currently supported is American Dynamics VideoEdge. In addition,
Mate pattern recognition software, Behavior Watch, is supported on
American Dynamics DVRs.
Many other types of DVRs (including the Axis DVR) can complement Velocity
surveillance, but they all use their own interfaces and programs.
The process followed for using an attached DVR/NVR involves these steps:
1. DVR or NVR Installation
2. Velocity Configuration (see “Configuring the DVR/NVR” on page 719)
3. Operation through Velocity (see “Operating the DVR or NVR” on page 726)
The first step, DVR or NVR installation, is discussed in the appropriate DVR or NVR users
manual. Essentially, it involves attaching digital cameras to the DVR or NVR and
connecting the DVR or NVR to the internet.
The Velocity DVR/NVR suite also includes two management tools that help you search
out video events and manage trigger actions:

717
Velocity Version 3.1 Administrator’s Guide

 Camera Control Console (see page 746)

 All Video Events (see page 753)
 Event History Viewer (see page 756)
 Trigger Action Manager (see page 759)

718
 MAN006-0612

Configuring the DVR/NVR

To configure your DVR or NVR to work within Velocity:
1. Within the System Tree pane of the Administration window, expand the Interfaces
Configuration folder to reveal the DVR/NVR folder.
2. Click to highlight the DVR/NVR folder.
The Add New DVR/NVR option appears in the Components pane.
3. Double click the Add New DVR/NVR option.
The Add DVR/NVR Unit dialog box appears. For more on this, refer to “Add
DVR/NVR Unit Properties” on page 720.
4. Fill out the Add Unit dialog box as required.
5. When you're finished, click OK.
A message appears asking whether you want to add this DVR/NVR.
6. Click Yes.
A message appears telling you that the DVR/NVR has been successfully added. It
also reminds you that you will have to restart Velocity and the Velocity Extension
Service before this new DVR/NVR can be used by Velocity.
7. Click OK.
8. Right click on the SCM and stop the Velocity Extension Service.
9. Click on the SCM again and restart the service.
10. Restart Velocity.
Once you bring up Velocity again, the newly defined DVR/NVR appears under the
DVR/NVR subfolder as well as in the components pane like the following example:

Once you have set up your DVR/NVR, you can right click on the DVR/NVR folder and
operate it.
For more on this, refer to “Operating the DVR or NVR” on page 726.

Hint If you are running a American Dynamics DVR/NVR, install the American Dynamics
Server Extension to speed up the acquisition of video traffic. This extension acts as
a traffic control, enabling Velocity to more effectively queue requests on a
first-come-first-served basis. For more on this, refer to “Server Extensions” on page
412.

Notice that the DVR/NVR folder also contains two utilities:

 All Video Events (page 753)

Configuring the DVR/NVR 719

Velocity Version 3.1 Administrator’s Guide

 Event Viewer (page 756)

These are useful for listing and controlling DVR/NVR video events.

Add DVR/NVR Unit Properties

The Add DVR/NVR Unit Properties dialog box includes three pages:
 General
 Unit Status
 Unit Info
The DVR Unit Status and DVR Unit Info pages are both read-only and cannot be
changed. These two pages only appear when you have connected successfully to the
specified DVR.

General Page
Depending on which vendor you select in the DVR/NVR 'Vendor' field, the General tab
page looks like one of these examples:

720 Configuring the DVR/NVR

 MAN006-0612

The General tab page includes these fields:

Name Enter the name that will show in the System Tree. It's best to
make this something descriptive of the DVR's location or
function.
This is a required field.

Description Enter a brief description of this DVR.

Vendor Select from correct vendor of this DVR/NVR from the list of
DVR/NVR manufacturers that are supported. Currently the
vendors listed are:
• American Dynamics
• Pelco
• Mate
• American Dynamics VideoEdge
• Bosch
This is a required field. The VideoEdge is an NVR; the other
options are DVRs.

IP Enter the TCP/IP address of this DVR unit. Since the DVR is
networked through its Ethernet connection, a computer can
access it no matter where it is on the network.
This is a required field.

IP Port (Control) Enter the port number of DVR/NVR command channel.

Normally, you can accept the default.
The default for American Dynamics is 5000, for Bosch 18772,
for Pelco 9002, and for Mate 1979.

IP Port (Live Enter the port number for DVR/NVR live video. Normally, you
Video) can accept the default.
The default for American Dynamics is 5001, for Bosch 18772,
and for Pelco 9002. There is no IP Port (Live Video) value for
Mate.

Server Name Select from a list of the names of all control servers that host
the DVR/NVR Server Service.
The default value is the Velocity server name.

Port (Listen) Enter the port number this Velocity workstation will use to
communicate with the DVR control server. This number
should be above 1000 and unique. We recommend 4001 or
6001 or higher.

Hint If you aren't certain about the port number, consult your IT
administrator.

This is a required field.

Time Zone If required, select a time zone from the available list during
which this DVR is enabled.

Configuring the DVR/NVR 721

Velocity Version 3.1 Administrator’s Guide

File Path If you specified Mate in the DVR/NVR Vendor field, either
enter the location where you want the Mate Behavior Watch
data to be placed, or use the button to locate the folder
where you want this data to be placed. You can specify a
network location, if required.

I.P. Port (Event) This field only appears if you have selected American
Dynamics. Enter the port number this DVR/NVR will use to
issue an event.
The default value is 5003.

User Name If you selected VideoEdge, or Bosch in the 'DVR Vendor'

field, this field appears. Enter the correct user name for this
DVR unit.
To get the correct value for this field, consult your DVR unit
documentation.

Password If you selected VideoEdge, or Bosch in the 'DVR Vendor'

field, this field appears. Enter the correct password for this
DVR unit.
To get the correct value for this field, consult your DVR unit
documentation.

Enabled Check this box to enable the DVR/NVR. Uncheck this box to
disable the unit.
The default is checked.

Event Check this box to enable event notification. Uncheck this box
Notification to disable this feature. When enabled, this feature allows
Enabled events issued from the DVR/NVR to be logged and reported
in the Event Viewer.
The default is checked.

Video Record Select the rate (in images per second) you require this DVR
Rate to record video from attached cameras. The default is 15 ips
NTSC.
This field does not appear on the Add DVR Unit dialog box.

Alarm Duration Enter the duration (in seconds) that a DVR alarm lasts. The
default is 5 seconds.
This field does not appear on the Add DVR Unit dialog box.

Alarm Record Select the rate (in images per second) you require this DVR
Rate to record video from attached cameras during an alarm. The
default is 60 ips NTSC.
This field does not appear on the Add DVR Unit dialog box.

722 Configuring the DVR/NVR

 MAN006-0612

Time Specify the interval between automatic time synchronizations.

Synchronization This synchronizes the host computer time with the DVR time.
To perform a manual synchronization, refer to DVR - Time
Synchronization. Check the Time Sync Enabled box to enable
this function.
The default interval is every 24 hrs.

Restore Viewer When you select Mate from the 'DVR/NVR Vendor' list, check
on New Alarm this box to indicate that the MATE viewer reappears and is
automatically refreshed each time the Mate software detects
a deviation from expected patterns and sends an alarm to
Velocity.

Auto connect at When you select Mate from the 'DVR/NVR Vendor' list, check
start up this box to instruct Velocity to automatically connect to the
Mate-governed DVR/NVR each time the Velocity server
is started.

DVR/NVR Unit Status page

The DVR/NVR Unit Status page includes these read-only fields:

Remaining The number of images this DVR/NVR can store in the unused
Images portion of its hard disk at the current record rate.

Mode The broadcast mode this DVR/NVR is using to record video.

The default is the broadcast standard NTSC.

Number of The number of cameras currently attached to this DVR/NVR.

Cameras

Record Rate The current rate (in images per second) this DVR/NVR uses
to record incoming video.

Record Mode The current mode used by this DVR/NVR to record incoming
video. The default is Linear Mode.

Schedule Mode The current mode used by this DVR/NVR to schedule video
recording.

Configuring the DVR/NVR 723

Velocity Version 3.1 Administrator’s Guide

Time Span The elapsed time in hours, minutes, and seconds this
DVR/NVR has been recording video.

Total Images The number of images this DVR/NVR currently stores on its
hard disk.

Version The current version of firmware used by this DVR/NVR.

Is Recording The current status of recording on the DVR/NVR.

Quality The current quality of recording used by this DVR/NVR.

Sensitivity The sensitivity of recording used by this DVR/NVR.

Camera Mode The status of cameras attached to this DVR/NVR: are they set
to issue alarms or not.

Camera The current operational status of cameras attached to this

Stopped DVR/NVR: are they stopped or not.

Camera The status of the connection between cameras and

Connected DVR/NVR.

PreAlarm Time The number of seconds specified between detection of an

alarm at the DVR/NVR and the issuing of an alarm.

DVR/NVR Unit Info Page

The DVR/NVR Unit Info page includes these read-only fields:

Unit Type The type of DVR/NVR unit installed.

Unit Status The unit status number.

Unit Version The version of DVR/NVR installed.

License Version The version of the license for this DVR/NVR.

License License information for this DVR/NVR.

Information

724 Configuring the DVR/NVR

 MAN006-0612

Connection The connection name assigned to this DVR/NVR. If an IP

Name address was specified, this address appears here.

Connection The current status of the connection.

Status

Video The current status of video terminal for this DVR/NVR.

Termination

Number of The current number of video outputs for this DVR/NVR.

Video

Video Cam The number of video camera controls specified for this
Control DVR/NVR.

Text Name Name of text, if any.

Text ID Text ID, if any.

Number of Text Text number, if any.

Text Video Text video, if any

Camera 1 - Current name assigned to each attached camera. If a camera

Camera 16 connection is not available, the value is grayed out. If a
connection is available, it is either marked as Local or
Remote.

Configuring the DVR/NVR 725

Velocity Version 3.1 Administrator’s Guide

Operating the DVR or NVR

Velocity operators can use a DVR or NVR to perform many tasks, either through the
DVR or through one of the cameras attached to the DVR. Both of these approaches are
discussed below.

Addressing the DVR/NVR and Attached Cameras

Using this technique, you can operate any of the cameras attached to the DVR/NVR.
To operate your DVR or NVR:
1. From the System Tree pane, expand the Interfaces Configuration folder until the
DVR/NVR folder appears.
2. Expand the DVR/NVR folder to reveal all currently-configured DVR/NVRs.
3. Right click on the DVR/NVR you want to operate.
Available functions appear in the pop-up list.
4. Select from these available options:

View Cameras Connect to the selected DVR/NVR and monitor a live

feed from all cameras presently connected to this
DVR/NVR.

Generate/Stop Generate or stop an alarm from Velocity to DVR/NVR

Host Alarm unit.

Get Alarm List Get the recorded alarm list from the American Dynamics
From DVR/NVR DVR/NVR unit.
Note: This option only applies to American Dynamics
DVR/NVRs.

Search & Search for and retrieve recorded video from the
Retrieve designated DVR/NVR to your local hard drive for later
Recorded Video play, analysis, and formatting. Normally, you retrieve one
or more video segments from the DVR/NVR then play
the video (Play Local Video).
Note: This option only applies to American Dynamics
DVR/NVRs.
For more on this, refer to “Search & Retrieve Recorded
Video” on page 733.

Play Local Video Play back video recorded on this computer and export it,
if required, in a number of formats.
Note: This only applies to American Dynamics DVR/NVRs.
For more on this, refer to “Play & Export Local Video” on
page 734.

Time Synchronize DVR unit time clock with Velocity. For more
Synchronization on this, refer to “Time Synchronization” on page 744.

Diagnostics Display the menus for diagnostic purpose. These are

programmer functions and should not be used by
operators.

726 Operating the DVR or NVR

 MAN006-0612

Delete Remove this DVR/NVR from the Velocity. Select this

option and a message appears. Click OK and the
selected DVR/NVR is deleted.

Rename Rename this DVR/NVR. Select this option and the

DVR/NVR name is highlighted with a cursor at the first
position. Enter a new name.

Properties Display and/or set up the properties of the

currently-selected DVR/NVR.

Addressing a DVR/NVR Camera Directly

You can address only one of the NVR- or DVR-attached cameras and operate that
specific camera.
To operate a specific DVR- or NVR-attached camera:
1. From the System Tree pane, expand the Interfaces Configuration folder until the
DVR/NVR folder appears.
2. Expand the DVR/NVR folder to reveal all currently-configured DVR/NVRs.
3. Click to highlight the DVR/NVR connected to the camera you want to operate.
All currently attached cameras appear in the Components pane.
4. In the Components pane, right click on the camera you want to operate.
Available options appear in the pop-up list.
Select from these available options:

View Camera Connect to the selected camera and monitor a live feed
from it.

Generate/Stop Generate or stop an alarm from Velocity to this camera.

Host Alarm

Camera Control Control the function of the currently-selected camera. For

more on this, refer to “DVR/NVR Camera Control” on
page 746.
Note: This applies to American Dynamics DVR/NVRs only.

Get Alarm List Get the recorded alarm list from the selected camera.
From DVR/NVR

Properties Display and/or set up the properties of the currently

selected camera (see page 720).

Viewing DVR/NVR Video From Attached Cameras

There are several different ways to view video from cameras connected to a DVR/NVR
through Velocity.
You can review live video feed using these techniques:
 DVR/NVR cameras (American Dynamics only)
 Live View (American Dynamics only)
 Video Explorer (any supported DVR/NVR)

Operating the DVR or NVR 727

Velocity Version 3.1 Administrator’s Guide

Recorded video can be reviewed by retrieving the video from the DVR/NVR and playing
it.

Viewing DVR/NVR Camera Video

You can view live feeds from one of the cameras connected to an existing DVR/NVR
using the View Camera option.
To view video from a specified camera:
1. From the system tree pane, expand Interfaces Configuration until DVR/NVR folder
is expanded.
2. Click to highlight the DVR/NVR whose camera you want to view.
All the available cameras appear in the Components pane.
3. In the Components pane, right click the camera you want to view.
A pop-up list appears.
4. Select View Camera.
A Live Video screen appears displaying the live video feed from the specified
camera.
5. Use this screen as required.
6. When you're finished, click either or Velocity Administration to return to the
main Velocity menu.

Live View
When you use Live View, it enables you to access and view all of the live feeds
currently coming to a specific DVR/NVR from its attached cameras.
 In order to see camera video coming from multiple DVR/NVRs, you must
use the Video Explorer.
To access Live View:
1. Expand the DVR/NVR folder in the System Tree to reveal the DVR/NVR you want to
view.
2. Do one of these:
• Right click the required DVR/NVR in the system tree pane.
• Right click one of the cameras that appears in the components pane.
A pop-up list appears.
3. Select View Cameras.
The Live Video window pops up.

728 Operating the DVR or NVR

 MAN006-0612

4. Click any pane on the screen to enlarge that video to full screen like this example:

You can also access this screen as a right click option from a specific camera. For
more on this, refer to “Viewing DVR/NVR Camera Video” on page 728.
If you select a camera that has PTZ capabilities, the Dome icon, , or Camera
Control console automatically appears.
5. Manipulate this screen as described in Live View Screen.
If this camera has PTZ capabilities, use the Camera Control console to move the
camera as required.
6. To return to the Velocity Administration window, click the Velocity
Administration button.
7. When you're finished, click to close the window. You are returned to the main
Administration screen.
You can also access Live View from an individual camera. For more on this, refer to
“Viewing DVR/NVR Camera Video” on page 728.

Live Video Screen

The Live Video screen supports live video feed for a single camera or multiple cameras.
It looks like this American Dynamics Home example:

Operating the DVR or NVR 729

Velocity Version 3.1 Administrator’s Guide

This screen includes these options:

Menu Tool Bar This tool bar includes these options:

File — Close option.
Console — Includes these options:
• Administration - Return to the Velocity Administration
window. This can also be accomplished by clicking the
Velocity Administration button.
• Generate / Stop Host Alarm - This displays two
suboptions: Generate Host Alarm — generate a host
alarm at this camera. The Velocity host registers this alarm.
Override/Stop Host Alarm — stops a host alarm
generated by the specified camera.
• Get Alarm List from DVR/NVR - Generates a list of
alarms generated by the currently selected camera.
• Search & Retrieve Recorded Video - Enables a qualified
operator to find and retrieve video recorded by the
DVR/NVR for the selected camera.
• Play Local Video - Play video retrieved from the specified
camera.
• Camera Control - Display the camera PTZ camera control
console.
• Properties - Display the DVR/NVR properties sheet (see
page 720).
Settings — Includes the Display Size suboptions: small,
medium, large.
Help — Includes Help Topics and Version which provides
the DVR/NVR version number.

Magnifier/ Click the minus button to decrease the size of the video
Demagnifier displayed in the currently selected frame.
Click the plus button to magnify the video displayed in the
currently selected frame.

Camera/View If you selected View Cameras from the DVR/NVR, all

Selector currently active cameras are represented by active buttons.
Click an active button to display an active view.
You can also drag a camera button from the button to the
screen.

Velocity Click this button to return to the main Velocity Administration

Administration module view.

730 Operating the DVR or NVR

 MAN006-0612

Select Pane This area includes four options:

Selector • One camera frame,
• Four camera frames,
• Nine camera frames,
• Sixteen camera frames,
Once the frames are available you can drag and drop camera
views into these frames as required.

Camera Sequence Click the Sequence button to display each camera in turn on
Selector the screen.
The 'Delay (Seconds)' text box designates the delay time
between camera switches.

Camera Name These overlays are determined by the DVR/NVR

fields programming and can be either hidden or displayed
according to the DVR/NVR administrator's preferences.

This icon appears only if the designated camera is equipped

for Pan Tilt Zoom (PTZ) use. Click this icon and the PTZ
controls appear.
For more on this, refer to PTZ Camera Controls.

Video Explorer
Video Explorer provides a quick view of up to sixteen preset cameras on one screen.
These cameras can be a mix of cameras from one or more DVR/NVR units.
 The Video Explorer cannot display CCTV camera views. To display digital
CCTV camera views, use the camera frame placement in the Graphics.
To open and use Video Explorer:
 From the icon tool bar, click the Video Explorer icon, .
 From the menu tool bar, select Console > Camera Viewer.
The Video Explorer appears like the following example:

Icon Toolbar Video Group Selector

Menu Toolbar

Camera View
Selector

System Tree
pane

Operating the DVR or NVR 731

Velocity Version 3.1 Administrator’s Guide

The sections of this screen are explained below:

Menu Tool Bar This tool bar includes two options, File and Help. The
File option includes several suboptions:
New... — Select this option to create a new view group.
This can also be achieved by clicking the icon in the
icon tool bar.
Save — Save the current view group configuration. This
can also be achieved by clicking the icon in the icon
tool bar.
Save As — Save the current view group configuration as
another name.
Exit — Exit Video Explorer and return to the main Velocity
screen.

Camera Views Specifies the number of frames displayed in the main

Selector window.
This area includes four options:

Once the frames are available you can drag and drop
camera views as required.

Icon Tool Bar Note: Provides four functions including:

— Create a new blank screen.
— Save the currently displayed screen.
— Delete the currently displayed view from the
screen.
— Bring up the Search Recorded Video screen for the
currently selected video frame.

View Groups After a view group has been saved, select an existing
Selector view group from the combo box.
For information on creating and modifying view groups,
refer to View Groups starting on page 745.

System Tree pane This pane displays a system tree view of attached
DVR/NVRs and cameras.
Drag camera objects from this pane into the view
window and drop them in the required frame.

732 Operating the DVR or NVR

 MAN006-0612

Search & Retrieve Recorded Video

Before you can review video stored on the DVR/NVR, you should retrieve it and copy it
to your local hard disk. Because the DVR/NVR saves all video in a digital format,
duplication to your local hard drive does not affect the quality of the video.
 These instructions apply to American Dynamics DVR/NVRs only.
To retrieve recorded video:
1. From the expanded DVR/NVR folder, right click on the DVR/NVR whose video you
want to retrieve.
A pop-up menu appears.
2. Select Search & Retrieve Recorded Video.
The Search Recorded Video screen appears like this example:

3. Indicate the beginning and end time for your search in the 'Start Time:' and 'End
Time:' fields.
Click the button to the right of the date field to display a calendar from which
you can select the starting and ending dates for this search. Click the spin buttons
to the right of the time fields to specify the exact starting and ending time. You can
also enter the dates and times with your keyboard, if you prefer.
4. Check the camera(s) from which you want to retrieve video.
Click the All button to check all the camera boxes. Check the None button to
remove check marks from the boxes.
5. Click the Get Video button.
The program removes the required video segments from the camera files stored
on the DVR/NVR. Those video segments are then copied to your local hard disk. A
list of all video segments copied to your hard disk appear in the lower left pane. As
the editing and duplication process continues, the status of it appears on the status
line at the bottom of the screen.

Operating the DVR or NVR 733

Velocity Version 3.1 Administrator’s Guide

Once all selected video is copied to your hard drive, the message 'All Video
Downloaded' appears on the screen. All segments transferred are displayed in the
lower left pane like this example:

6. If needed, you can review a segment in this way:

a. From the lower left pane, click to highlight the segment you want to review.
The first frame of the segment appears in the lower right pane.
b. Double click the segment you want to review in full and the Play Video screen
appears with the selected segment displayed.
c. Review the segment as required using the navigation tools on the screen.
d. When you're finished, close the screen. You are returned to the Search
Recorded Video screen.
7. Click Close to exit the Search Recorded Video screen.
To review and export retrieved video, refer to “Play & Export Local Video” on page 734.

Play & Export Local Video

Once you have retrieved the video you need from the designated DVR/NVR, use this
feature to play back the video now stored on this computer's hard disk. Using this
option you can also export the video you need to different formats.
To play local video:
1. From the expanded DVR/NVR folder, right click on the DVR/NVR whose recorded
video you want to play.
A pop-up menu appears.
2. Select Play Local Video.
The Play Local Video screen appears.
The location of the current video path is displayed in the top field. You can change
this directory, if needed, using the button to search for the correct directory.
3. From the file list window, click to highlight any row in the list.
Each item in this list is a video segment stored by the DVR/NVR and indexed by
many attributes including start time, duration, camera, and file name.

734 Operating the DVR or NVR

 MAN006-0612

The lower preview pane will show the first frame of that file like this example:

4. Click the Play button to play the segment.

The Play Video window appears and plays the selected recorded video. This
window remains open during this process. For more on this window, refer to “Play
Video Window” on page 735.
5. Use the video navigation tools at the bottom of this screen to move through the
video segment. You can also use the slide button to perform rough positioning.
6. If you need to review more than one segment, repeat steps 3 - 4.
7. When you're finished, click Close.

Play Video Window

For American Dynamics, the Play Video window looks like this example:

This window includes the following features.

Operating the DVR or NVR 735

Velocity Version 3.1 Administrator’s Guide

Menu Tool Bar

File Includes these options:
Play — includes two suboptions:
• From Date Time -- When you select this option, the Play from
Date and Time dialog box appears. Enter the date and time from
which you want the current video to start playing and click OK.
• From Image Number -- When you select this option, the Image
Number dialog box appears. Enter the image number you need
and click OK. The selected video plays from the specified image
number.
Open — Open another video file.
Exit — Exit this video file and return to the previous screen.

Console Select another Velocity module from the available list. These are the
same Console selections available for the Live Video screen (page
729).

Settings Player Size — Choose from three options that control the size of the
video frame appearing on your monitor: Small, Medium, and
Large.

Export Includes these options:

File — Select this option to export the entire video segment to AVI
format. The Export Video dialog box appears. For more on this, refer
to “Export DVR/NVR Video” on page 740.
Image Number — Select this option to export that portion of the
video specified by an image number range. For more on this, refer to
“Export DVR/NVR Video” on page 740.
Date Time — Select this option to export that portion of the video
specified by a date and time range. For more on this, refer to “Export
DVR/NVR Video” on page 740.

Location Indicators

For American Dynamics DVR/NVRs, use the left slider to forward or rewind the video.
For American Dynamics DVRs, the right slider only shows the progress of the video as it
plays. You cannot use the volume control slider on this screen; volume is controlled by
the PC.

Control Buttons & Speed Slider

This component only applies to the American Dynamics DVR/NVRs.

Play the video.

Stop/Pause the video.

736 Operating the DVR or NVR

 MAN006-0612

Increase or decrease the speed of play. Slide to the right to increase

the play speed. Slide to the left to slow the play speed.

Return to first frame of the video.

Go to last frame of the video.

Click to fill entire monitor screen. Press Esc to return to normal

mode.

Click to bring up the Image Tools screen. For more on this, refer to
“Image Tools” on page 738.

Start & End Time Fields

To crop the video file to a definite time range, enter the start and end dates and times.
When you click the Play button, only that time range is played.

Operating the DVR or NVR 737

Velocity Version 3.1 Administrator’s Guide

Navigation Buttons
Play Play the video segment.

Stop Stop playing the video segment.

Prev Frame Show the previous frame of the video segment. The video must be
stopped before this function works.

Next Frame Show the next frame of the video segment. The video must be
stopped before this function works.

First Frame Show the first frame of the video segment. The video must be
stopped before this function works.

Last Frame Show the last frame of the video segment. The video must be
stopped before this function works.

Clear Clear the currently displayed screen. The video must be stopped
Display before this function works.

Image Print, save, zoom, color and perform other actions on the current
Tools frame. This option also exports video frames as JPG files.
For more on this, refer to “Image Tools” on page 738.
This only applies to the American Dynamics DVR/NVR.

Image Tools
When you click the Image Tools button in the Play Video window, the Image Tools
window appears like the following example:

This screen enables a qualified operator or administrator to enhance an image

captured by a DVR/NVR camera. It does not allow the operator to edit the screen in any
way that would compromise the image.

738 Operating the DVR or NVR

 MAN006-0612

This screen includes the following buttons and fields:

Zoom 1:1

Zoom In Select this radio button then click in the frame. The mouse icon turns to
a magnifying glass. Click within the frame and the picture zooms in,
using the current mouse cursor as the zoom center.

Zoom Out Select this radio button then click in the frame. The picture zooms out.

Move Select this radio button then click and drag within the picture frame. The
picture center moves if you are currently zoomed in. This is the method
for moving a close-up from one area of interest to another.

Enhance/ Check one or both of these boxes to enhance and/or sharpen the
Sharpen captured video frame.
Uncheck the box to return the picture to its original clarity.

1:1 Click this button and the picture returns to its original viewing size.

Tools

Bright/ Click this button and a Brightness and Contrast slider appears at the
Contrast bottom of this screen. Use these sliders to increase or decrease the
brightness and/or contrast of the displayed image.
When you’re satisfied, click OK. The image is adjusted. Click Cancel to
ignore any changes and return to the unadjusted image.

Color/Light Click this button and Hue/Saturation/Lightness sliders appear at the

bottom of the screen. Use these sliders to enhance the color or light of
the image.
When you’re satisfied, click OK. The image is adjusted. Click Cancel to
ignore any changes and return to the unadjusted image.

Apply Click this button to apply the enhancements.

Undo Click this button to remove the enhancements and return to the original
image.

Brightness Check this box to display a brightness chart in the image frame. This can
Chart aid in enhancing the brightness of the image.

Buttons

Full Screen Click this button to increase the size of the image to full screen size.

Load Click this button to open another image you have already saved.

Save Click this button to display the Save dialog box. Name the image and
place it in the appropriate directory. It is saved as a JPG file.

Print Click this button to print the image to the specified printer.

Restore Click this button to restore the image to its original, unenhanced form.

Close Close the Image Tools screen.

Operating the DVR or NVR 739

Velocity Version 3.1 Administrator’s Guide

Export DVR/NVR Video

One of the most important benefits of using a DVR/NVR to record your video output is
the ability to export the video to another source. This enables the qualified operator to
transfer video to:
 Expert sites
 Law Enforcement Agents
 Lawyers
 Company officials
In an increasingly litigious world, incontestable visual evidence is worth a great deal.
To export video:
1. Retrieve the video you need from the DVR/NVR.
2. Play the video locally until you have isolated the relevant video segment.
3. From the Play Video screen's menu tool bar, select Export.
4. Select the method by which you want to crop the video:
• Entire File
• Edit by Image Number
• Edit by Date and Time
The export dialog box appears.
5. At the 'Export To:' text box, enter the path and file name you want for this exported
file.
If necessary, use the button to find the path and file name you want.
6. At the Export File Format section, indicate the type of file format you require for this
export:
• AVI—Industry standard video format for audio visual files. This is the default
selection.
• IMG—Proprietary American Dynamics video format.
7. At the Text Overlay section, indicate whether you need to show text in one of the
screen's four corners. The default is None.
8. If you selected either Image Number or Date Time, indicate the section of the
currently-displayed video file you want to be exported.
• If you specified Image Number, indicate the beginning and ending image
number of the required segment.
• If you specified Date Time, indicate the starting and ending dates and times
of the required segment.
If you selected File, ignore this step. Go to Step 9.
9. Click Export.
The status indicator above the button shows the progress of the export.
10. When the export is completed, click Done to return to the previous screen.

Generate and Stop Host Alarm

Qualified operators may need to generate an alarm if they view an infraction on their
video. This 'bookmarks' the video event and enables the operator or another authority
to return later to that exact spot and retrieve the video.
 This procedure applies to American Dynamics DVR/NVRs only.

740 Operating the DVR or NVR

 MAN006-0612

To generate a host alarm:

1. From the expanded DVR/NVR folder, right click on the DVR/NVR where you want
to generate a host alarm.
A pop-up menu appears.
2. Select Generate/Stop Host Alarm > Generate Host Alarm.
The Generate Alarm dialog box appears.
3. Select the camera where you want to generate the host alarm, the alarm rate, and
the alarm duration. Click OK.
The Generate Alarm Configuration message appears.
4. Click OK.
Once an alarm is issued at the camera, it continues for the duration indicated in the
'Alarm Duration' text box.
To stop an alarm at the designated camera before it is set to expire:
1. From the expanded DVR/NVR folder, right click on the DVR/NVR where you want
to stop the alarm.
A pop-up menu appears.
2. Select Generate/Stop Host Alarm > Override/Stop Host Alarm.
The Override or Stop Host Alarm dialog box appears.
3. Select the camera whose alarm you need to override.
4. Do one of these:
• Click Override Alarm to override the present alarm. This enables the
operator to continue the current alarm process until the Stop button is
clicked.
• Click Stop to stop the alarm. This stops the current alarm in process.
You are returned to the Velocity main menu.

Get Alarm List

Use this feature to display and review a list of all video stored by the DVR/NVR that is
associated with alarmed states detected at their attached cameras.
 This procedure applies to American Dynamics DVR/NVRs only.
To get an alarm list:
1. From the expanded DVR/NVR folder, right click on the DVR/NVR whose alarm list
you want to get.
A pop-up menu appears.
2. Select Get Alarm List from DVR/NVR.

Operating the DVR or NVR 741

Velocity Version 3.1 Administrator’s Guide

The Get Alarm List window appears like the following example:

This screen includes these features:

Start Time: Enter a date and time representing the beginning of the period
for which you want to display alarms.

End Time: Enter a date and time representing the end of the period for
which you want to display alarms.

Get Alarms Click to execute the command.

Close Click to close this window.

Cameras Check up to 16 check boxes indicating the cameras from

which you want alarm lists retrieved.

None Click this button to uncheck all camera boxes.

All Click this button to check all camera boxes.

Pre-Alarm A text box that shows the pre-alarm duration in seconds

Length required to retrieve the recorded alarm video.

Total Alarms A text box showing the total number of alarms in the list below.

Post-Alarm A text box that shows the post-alarm duration in seconds

Length required to retrieve the recorded alarm video.

Maximum A text box that shows the total number of seconds required to
Length retrieve the recorded alarm video.

Alarm List Once you click the Get Alarms button, this window lists all
window alarms for the time duration and cameras specified.
Each alarm is listed by index, camera, duration, start time,
frame, and alarm type. To review video from one of these
alarms, double click the alarm.

Status Line Indicates the current status of the Alarm List search including
result data.

742 Operating the DVR or NVR

 MAN006-0612

3. At the 'Start Time' fields, indicate the start date and time.
4. At the 'End Time' fields, indicate the end date and time.
5. In the 'Cameras' section, check the cameras for which you want to retrieve alarm
information.
6. Click the Get Alarms button.
The Alarm List window displays a list of all appropriate alarms.
7. In the Alarm List window, double click the alarm you want to review.
The Play Video window appears and plays that particular alarm video after it
downloads the data from the DVR/NVR unit.
8. Play and review the local video as required.
While you are in this window, you can right click the window’s frame to display a
pop-up option list like this example:

Right Click
options

The options included in this list enable the qualified operator to:
• Access properties for the currently selected DVR/NVR (page 720)
• Return to the Velocity Administration screen
• Generate/Stop a Host Alarm (page 740)
• Get an Alarm List from the DVR/NVR (page 741)
• Search & Retrieve Recorded Video (page 733)
• Play Local Video (page 734)
• Camera Control (page 746)
These are many of the same options displayed in the Console option list for the
Live Video screen (page 729).
These tasks can be run concurrently: the present video continues to play while you
perform another task. In this way, you can search, retrieve, and play several videos
at the same time.
9. When you're finished, select either File > Exit from the Play Video menu tool bar
or click in the upper right corner to close the Play Video window.
10. Either select another alarm video to play or close the Alarm List window by clicking
the Close button.

Operating the DVR or NVR 743

Velocity Version 3.1 Administrator’s Guide

Time Synchronization
Use this feature to manually synchronize the Velocity host system clock with the
DVR/NVR unit. The default, as specified by the DVR/NVR Properties sheet, requires
synchronizing every 24 hours.
To manually synchronize a DVR/NVR with this host system clock:
1. From the expanded DVR/NVR folder, right click on the DVR/NVR you want to
synchronize.
A pop-up menu appears.
2. Select Time Synchronization.
The Time Synchronization dialog box appears.
3. Click Yes.

Drag & Drop DVR/NVR Camera Views

The Velocity DVR/NVR module enables a qualified operator to drag and drop camera
views in one of two ways:
 From a Live View screen (page 744)
 From a Video Explorer screen (page 745)
Each is explained below.

Drag & Drop with Live View

To drag and drop video in Live View:
1. Expand the Interfaces Configuration folder in the System Tree pane until the
individual DVR/NVRs appear.
2. Click to select the DVR/NVR you want.
All available cameras appear in the Components pane.
3. Access the Live Video screen in one of two ways:
• From the System Tree pane, right click the DVR/NVR and select View
Camera.
• From the Components pane, right click on the designated camera and select
View Camera.
The Live Video screen appears.
4. From the Camera\View Selector, select a camera view button.
Initially, the default camera view for this button appears on the screen. For
example, if you selected button 4, camera 4 for the specified DVR/NVR appears. If
you selected an individual camera in Step 3, then this camera's video automatically
appears.
5. From the Select Pane selector, select the number of frames you want displayed.
6. Click the Velocity Administration button to bring the Administration module into
view.
Arrange the two windows on the screen so that both the Live Video screen and the
Administration window are showing.
7. Drag one or more cameras from the Administration module to an available frame
on the Live Video screen.
The video feed represented by this camera now appears in the frame.

744 Operating the DVR or NVR

 MAN006-0612

Using this approach, you can drag camera views from different DVR/NVRs, if
needed.
You can also drag a camera button to an available camera view to populate the screen
with views from the same DVR/NVR.
When this is done, clicking the selected camera view number now displays all the
selected cameras in the designated frames as in this example:

Button 2 is
selected

Notice that in this example selecting button 2 displays four specified views.

Drag & Drop with Video Explorer

To drag and drop video in Video Explorer:
1. Open Video Explorer.
2. Select an existing view group or create a new view group.
3. From the Video Explorer's system tree pane, drag a camera object to an available
frame.
The video generated by this camera appears in this frame. If a different camera view
already exists in this frame, the new video takes its place.

DVR/NVR View Groups

A View Group is a programmed arrangement of frames in Video Explorer presenting up
to sixteen different camera views.
To create a view group:
1. Open the Video Explorer.
2. At the menu tool bar, select File > New... or press Ctrl + N.
You are prompted to confirm the creation of a new view group.
3. Click OK.
The Enter new view group name dialog box appears.
4. Enter the name of the new view group then click OK.
The new view group name appears in the View Group combo box at the top of the
screen.
5. From the Camera Views Selector, specify the number of frames you want to
include in this view group.

Operating the DVR or NVR 745

Velocity Version 3.1 Administrator’s Guide

Select one, four, nine, or sixteen frames.

6. From the System Tree pane on the left, expand the tree to display all of the
cameras associated with DVR/NVRs you have defined for this system.
7. Drag a camera from the System Tree pane to an available frame in the view
window.
The video output associated with the camera is displayed in the frame.
8. Repeat Steps 4-7 for each camera you want placed in an available frame.
9. Press Ctrl + S or from the menu tool bar, select File > Save to save the current
view group settings.
The new view group appears in the View Group combo box.
To edit an existing view group to create a new view group:
1. From the View Groups combo box, select an existing view group.
Video Explorer populates the view window with those frames and camera views
previously defined.
2. Modify this existing group as required by:
• substituting existing video for other views
• increasing / decreasing the number of frames and populating them as
required
3. Once you have modified this view group as you require, from the menu tool bar,
select File > Save As.
The Enter new view group menu dialog box appears.
4. Enter the name of this new view group and click OK.
A new view group appears in the View Group combo box.

DVR/NVR Camera Control

If this Velocity system is configured for use with a American Dynamics DVR/NVR, you
can control the movement of the cameras attached to the DVR/NVR through Velocity.
 Only those cameras that support movement, such as pan, tilt, zoom, and
focus, are affected by this feature.
To control DVR/NVR-attached cameras:
1. From the System Tree pane, expand the Interfaces Configuration folder until the
DVR/NVR folder appears.
2. Expand the DVR/NVR folder to reveal all currently-configured DVR/NVRs.
3. Click to highlight the DVR/NVR connected to the camera you want to operate.
All currently attached cameras appear in the Components pane.
4. In the Components pane, right click on the camera you want to operate.
Available options appear in the pop-up list.
5. Select Camera Control.

746 Operating the DVR or NVR

 MAN006-0612

The Camera Control console appears. The American Dynamics Camera Control
console looks like this example:

The fields and buttons on this console are:

Camera Control Selection

Radio Select the camera control protocol you want enabled for this
buttons camera. Select one of these radio buttons:
• Intellex
• Local Control (default)

Begin Click this button to start the session. By default, this button is
Session already selected.

End Session Click this button to end a protocol and go to another option.

Camera Controls

Click the appropriate buttons to move the designated camera

in the manner you require. Possible controls include:
—Pan to upper left limit
—Pan up
—Pan to upper right limit
—Pan left
—Focus in or out
—Pan right
—Pan to lower left limit
—Pan down
—Pan to lower right limit

Operating the DVR or NVR 747

Velocity Version 3.1 Administrator’s Guide

Focus – focus on the nearest object in the view.

– focus on the farthest object in the view.

Track — track to the left from the current location

— track to the right from the current location

Zoom — zoom out to widest angle

— zoom in on the tightest angle

Iris — open camera iris to largest radius

— close camera iris to smallest allowed radius
— set camera iris to adapt automatically

Speed Adjust the speed dial to increase or decrease the speed with
which the camera performs its PTZ operations (page 749).

Show Check this box to show the camera control PTZ readout (page
Camera 749) on the screen. Uncheck this box to hide the readout from
Control the live view screen.

Camera Use this pick list window to select another camera for control.
Only those cameras that allow camera control appear in this
list.

Patterns (This section is only active for American Dynamics DVR/NVRs)

Pattern pick Select one of the patterns options from the drop-down list.
list There are three patterns available. For recording patterns, refer
to “Programming Camera Patterns” on page 751.

Run If movements have been programmed for this camera, indicate

the program you want this camera to run.
Follow this procedure:
1. Enter the program number in the pick list.
2. Click the Run button.

Set Click this box to start programming a pattern for the currently
selected pattern in the pattern pick list. For more on
programming patterns, refer to “Programming Camera
Patterns” on page 751.

Repeat Click this button to repeat the run the number of times
Pattern specified in the text box to the right.

Quick Views (This section is only active for American Dynamics DVR/NVRs)

Quick View Select one of the available options from the drop-down list.
pick list There are 99 views available. For creating quick views, refer to
“Camera Quick Views” on page 750.

748 Operating the DVR or NVR

 MAN006-0612

Go To Specify the view you want this camera to assume.

To specify the preset you want this camera to assume:
1. Enter the quick view in the combo box.
2. Click Go To.
To program a new quick view, refer “Camera Quick Views” on
page 750.

Set Click this box to memorize this currently displayed view and
associate it with the currently displayed option in the 'Quick
View' pick list. For more on this, refer to “Camera Quick Views”
on page 750.

6. Control the camera using the buttons and fields on this console.
The selected camera can only respond to those controls that it supports. All other
commands are ignored.
7. When you're finished, click the button in the upper right corner to exit this
screen and return to the main Velocity screen.
Cameras can also be controlled using the PTZ camera control icon as described in
DVR/NVR - PTZ Camera Controls. This icon can be shown/hidden through the console.
If you view a camera that is configured for PTZ effects, the camera control console
appears automatically.

PTZ Camera Controls

If a camera attached to a DVR/NVR is configured for Pan-Tilt-Zoom control, an icon like
this appears in the lower right corner of the screen.
Click this icon and an bank of controls like this example appears:

The controls shown here are:

+ = Focus In
– = Focus Out

+ = Zoom In
– = Zoom Out

Click on a specific position and the camera pans to that location.

There are eight pan locations available.

+ = Tilt Up
– = Tilt Down

Rotate a full circle.

Operating the DVR or NVR 749

Velocity Version 3.1 Administrator’s Guide

Click this icon and a pick list appears. Select one of the presets
already programmed into this camera from the DVR/NVR and
the camera executes the motion.
Select another preset from the pick list or click to return to
the camera controls.

Click this icon and the camera controls disappear. The initial PTZ
icon appears.

Click this icon and a pick list appears. Select one of the existing
tours already programmed into this camera from the DVR/NVR
and the camera performs the tour.
Select another tour from the pick list or click to return to the
camera controls.

Camera Quick Views

The American Dynamics DVR/NVR allows Velocity to record and replay specific camera
positions, called quick views.
To record a camera view:
1. From the DVR/NVR folder, open the DVR/NVR Live Video.
2. From the menu tool bar, select Console > Camera Control.
The Camera Control Console appears. The PTZ camera control pattern is
superimposed on the frame displaying the camera view currently specified in the
'Camera' pick list.
3. If not already selected, check the Show Camera Control box.
4. Select the camera on which you want to use this pattern from the Camera pick list.
Only those cameras that are capable of camera control appear in this list.
5. From the ‘Quick View’ pick list, select one of the 99 available quick view options.
6. Using the PTZ camera controls, move the selected camera to the view you want.
7. From the Camera Control Console 'Quick View' section, click Set.
A Save Quick View Name dialog box like this example appears:

8. Enter the name of the quick view you want then click OK.
A prompt appears like this:

9. Click Yes.
You are returned to the Live Video screen.

750 Operating the DVR or NVR

 MAN006-0612

The new quick view and name appears now in the Patterns pick list. To test this quick
view, select the quick view name from the Quick View pick list and click Run. The
camera should move to the requested position.
You can use Quick Views and Camera Patterns as actions in the Trigger Action Manager.
For more on this, refer to “Action Page” on page 1191.

Programming Camera Patterns

The American Dynamics DVR/NVR allows Velocity to record and replay camera
movements.
To record a camera movement:
1. From the DVR/NVR folder, open the DVR/NVR Live Video.
2. From the menu tool bar, select Console > Camera Control.
The Camera Control Console appears. The PTZ camera control pattern is
superimposed on the frame displaying the camera view currently specified in the
'Camera' pick list.
3. If not already selected, check the Show Camera Control box.
4. If not already done, select the camera on which you want to use this pattern from
the ‘Camera’ pick list.
Only those cameras that are capable of camera control appear in this list.
5. From the ‘Patterns’ pick list, select one of the three pattern options.
Three patterns are currently available for programming.
6. Click Set.
The Camera Preset dialog box like this appears:

7. Click New Pattern.

A Save Pattern Name dialog box like this appears:

8. Enter the name of the pattern you are about to program then click OK.
You are returned to the Live Video screen.
9. Using the PTZ camera controls in the selected camera view, move the camera in
the pattern you want to program.
10. When you're finished, click End.
A prompt appears like this:

Operating the DVR or NVR 751

Velocity Version 3.1 Administrator’s Guide

11. Click Yes.

The new pattern and name appears now in the Patterns pick list. To test this pattern,
select the new pattern from the 'Patterns' pick list and click Run. The camera should
perform the requested pattern.
You can use Quick Views and Camera Patterns as actions in the Trigger Action Manager.
For more on this, refer to “Action Page” on page 1191.

752 Operating the DVR or NVR

 MAN006-0612

All Video Events

This feature displays all specified video events recorded by Velocity-connected
DVR/NVRs. This is a list of all video captured by the DVR/NVR during a specified time
period.
To open and use the All Video Events screen:
1. From the system tree pane, expand the Interfaces Configuration folder until the
DVR/NVR folder appears.
2. Click to highlight the DVR/NVR folder.
The All Video Events option appears in the components pane.
3. In the components pane, double click the All Video Events option,
.
The All Video Events screen appears like this example:

This screen includes these options, fields, and windows:

Menu Bar This bar includes two options:

• File – This has one option, Close.
• Help – This enables you to view Velocity help.

Start Time Designates the beginning of the interval after which you
want recorded video displayed in the Recorded Video
window.
Click the button to display a calendar. Locate the start
date. You can also enter the date directly.
Use the spin control buttons to increment or
decrement the start time. You can also enter the time
directly.

All Video Events 753

Velocity Version 3.1 Administrator’s Guide

End Time Designates the end of the interval before which you want
recorded video displayed in the Recorded Video window.
Click the button to display a calendar. Locate the end
date. You can also enter the date directly.
Use the spin control buttons to increment or
decrement the end time. You can also enter the time
directly.

History Check this box to display the entire list of all video currently
stored in all cameras of all DVR/NVRs.
The number of video events recorded by the DVR/NVR for
the specified period are displayed in parenthesis.

Search Click this button to search for all video meeting the criteria
you have specified.
The results of the search are displayed in the Recorded
Video window.

DVR/NVR Unit Select the DVR/NVR unit whose video events you want to
search. All DVR/NVR units currently defined for this system
appear in this list. The default is All.

Camera Select the DVR/NVR camera from the specified DVR/NVR

unit whose video events you want to search. All DVR/NVR
cameras currently defined for this DVR/NVR appear in this
list. The default is All.

Events From... If events appear in the Recorded Video window, you can
To enter a starting and ending index number (shown in the
Index column) to filter the video you see.

Recorded Video All events meeting the search criteria specified above
window appear in this window.
To select an item to play, double click it.

4. Do one of these:
• Check the History box on the right to display the entire list of all video
currently stored in all cameras of all DVR/NVRs. This can result in a very long
(and unhelpful) list. Skip to Step 8.
• Use the fields on the left to narrow your search as described in Steps 5 - 7.
5. Using the 'Start Time:' and 'End Time:' fields, specify the date and time range
during which you want the program to search.
• Click the button to display a calendar. Locate the start and end dates. You
can also enter the date directly.
• Use the spin control buttons to increment or decrement the start and end
times. You can also enter the time directly.
6. At the 'DVR/NVR Unit' pick list, select the DVR/NVR unit whose video events you
want to search.
The default is All.
7. At the 'Camera' pick list, select the camera from the specified DVR/NVR unit whose
video events you want to search.
8. Click Search.

754 All Video Events

 MAN006-0612

The video events for the specified range appear in the bottom window.
9. To retrieve a recorded video, double click one of the video event selections in the
window.
The Search & Retrieve Recorded Video screen appears.
10. Retrieve the video then play it on the Play Local Video screen.
For more on this, refer to “Search & Retrieve Recorded Video” on page 733 and
“Play & Export Local Video” on page 734.

All Video Events 755

Velocity Version 3.1 Administrator’s Guide

Event History Viewer

The Event History Viewer enables a qualified Velocity operator to track and report
events that are specific to the DVR/NVR subsystem.
To open the Event History Viewer:
1. From the system tree pane, expand the Interfaces Configuration folder until the
DVR/NVR folder appears.
2. Click to highlight the DVR/NVR folder.
The Event Viewer option appears in the components pane.
3. In the components pane, double click the Event Viewer option, .
The DVR/NVR Event History Viewer appears like this example:

The Event History Viewer looks and feels like the Velocity Report Manager. In fact, it
shares many features with the Report Manager except that it is dedicated to DVR/NVR
history logs.
These logs include:
 Active Alarms by Date
 Active Alarms by Date with Comments
 Alarm Log by Date
 Alarm Log by Date with Comments
 All Events Log by Category
 All Events Log by Date
For more on how to generate a DVR/NVR report, refer to “Generating History Logs” on
page 756.

Generating History Logs

To generate a DVR/NVR history log:
1. In the Event Viewer history log tree pane, expand the History Logs folder to reveal
one of the available logs.
2. Click to highlight the log you want to generate.
3. Select one of these options:
• To generate a log with the default criteria as defined by the default report,
leave the 'Use Event Viewer Default Criteria and Sorting' box checked.

756 Event History Viewer

 MAN006-0612

• To customize your log—including or excluding components and fields as well

as defining precise criteria for this report—uncheck 'Use Report Default Criteria
and Sorting' then customize the report.
For more on this, refer to “Customizing DVR/NVR Logs” on page 757.
4. When you're finished, click the Search Events button.
The events corresponding to the criteria specified appear in the lower window.

Once you have generated the event list you need, you can use this list to:
 Play video
 Copy video to the clipboard
 Send results to the printer
 Procure properties
For more on this, refer to “DVR/NVR Event List Functions” on page 759.

Customizing DVR/NVR Logs

If you uncheck the 'Use Event Viewer Default Criteria and Sorting' box, use the steps
below to customize the list of events that eventually appear in the lower pane:
1. From the 'Field' combo box, select the field you want to serve as a filter.
The available data fields correspond to the history log you selected.
2. In the 'Function' combo boxes, click and select appropriate values in the one or
more fields that now appear.
Additional fields and boxes appear depending on the field and arguments
specified:
• In the first pick list, select either is or is not.
• In the second pick list, select one of the available arguments: equal to, less
than, greater than, between, starting with, or like. Only some of these
options apply to a specific field value.

Event History Viewer 757

Velocity Version 3.1 Administrator’s Guide

• An additional checkbox, or equal to, appears on the same line if you select
either less than or greater than. Check this box to indicate that the
argument includes an equal to clause, such as 'greater than or equal to'.
• A text box appears if you select like, starting with, less than or greater
than. Enter a value that places your qualifiers in the correct context.
• If you specify the starting with or like argument, enter the value you
want the report to start with or be like.
• If you specify greater than or less than, enter the value this criterion will
be greater than or less than. If it is also equal to, check the previous box.
• If you specify the equal to argument, the variable window expands to
become a pick list from which you select one or more values. Select one or
more options from this list. If this report supports a range of values, you can
click the beginning value then hold down the Shift key and click the last value
in the range. To select non-contiguous values, hold down the Ctrl key while
clicking.
For more on the criteria page, refer to the Report Manager “Criteria Page” on page
1021.
3. When you're finished with this specific criterion, click the Add button.
The criterion is displayed in the middle pane.
4. Repeat Steps 1 - 3 to add more criteria to this report.
5. If you need to add sorting elements to your report specifications, click the Sorting
tab.
The Sorting page appears.
6. From the 'Field' combo box, select the item (field) by which you want to sort.
The values appearing on the combo box list depend on the type of report you
have selected.
7. From the 'Direction' combo box, select either Ascending or Descending.
This indicates in which direction the selected field is used to sort: from least to
greatest value or vice versa.
For example, if you select 'Input Index' as the sorting point and indicate it should
be used as an Ascending sorting feature, then the Report Manager sorts the report
according to the Input Index, starting from the smallest value and proceeding down
the list to the highest value.
8. Click Add and the Sort Field function is added to the middle pane.
9. If there are any other sorting criteria you need to add, repeat steps 6 - 8.
10. Go to the lower pane and click any line (criterion) you need to edit. Do this:
• To nest the line as an expression, click in the specific line's open parenthesis
column. A combo box appears. Select the number of parentheses you need
for this expression. To close the nested expression, click in the closed
parenthesis column of the specific line and another combo box appears.
Select the number of closed parentheses you need to satisfy this expression.
• To add an AND argument to include or an OR argument to exclude this part of
the expression, click in the AND/OR column of this line and a combo box
appears. Select either AND or OR.
• To remove a line, select it and press Delete.
11. Continue to edit lines to create boolean expressions as required.
12. When you're finished, click the Criteria tab and then click the Search Events
button. The required events appear in the lower pane.

758 Event History Viewer

 MAN006-0612

DVR/NVR Event List Functions

Once you have generated a DVR/NVR history event list, you manipulate that list in a
number of ways.
1. Generate an event list as detailed in “Generating History Logs” on page 756.
A list of events appears in the lower pane. This list is determined by the criteria you
selected in the Event History Viewer.
2. From the lower pane of the Event History Viewer, right click on an event.
A pop-up list appears.
3. Select one of these items:
• Play Video—Play the associated video for this event. The Search & Retrieve
Recorded Video screen appears as shown in “Search & Retrieve Recorded
Video” on page 733. Retrieve the video then play it on the Play Local Video
screen as shown in “Play Video Window” on page 735.
• Copy to Clipboard—Copy the contents of the selected event to the clipboard
for pasting to another source.
• Properties...—Show the properties of the selected event.

Triggering DVR/NVR Actions

You can trigger DVR/NVR devices to perform specific actions when a specified Event
occurs. To learn more about this, refer to “Trigger Action Manager,” starting on page
1187.

Event History Viewer 759

Velocity Version 3.1 Administrator’s Guide

760 Event History Viewer

 MAN006-0612

Enrollment Manager
Use the Enrollment Manager to add card and code credentials to the system.
Essentially this process involves combining a credential and personal information with a
photograph and/or signature to create an access privilege for a unique user.
The result of the enrollment process is:
 a card (such as a badge) that can be used to gain access to the facility via a reader.
 a code that can be used to gain access to the facility via a keypad.
 both a code and card that gains access to the facility via reader/keypad.
To find basic information on using Enrollment Manager:

Topics See page:

Badge Printer Configuration 762

Opening Enrollment Manager 763

Changing User-Defined Fields 776

Enrolling a New Person 800

Finding a Person 809

Person Groups 823

Previewing a Badge 859

Printing a Badge 861

Creating a Credential 863

Preferences 896

761
Velocity Version 3.1 Administrator’s Guide

Badge Printer Configuration

Before you can print a badge in either Enrollment Manager or Designer, you must first
define a badge printer for this purpose.
To configure a badge printer:
1. Connect the badge printer to your system as explained in your badge printer's
installation guide.
2. Install the required printer drivers as detailed in your badge printer's installation
guide.
3. At the Windows desktop, select Start > Settings > Printers.
The Printers dialog box appears.
4. Double click Add Printer.
The Add Printer Wizard appears.
5. Follow the instructions given by the Add Printer Wizard to select and configure the
badge printer connected to this workstation.
6. Start Velocity.
7. From the Velocity menu tool bar, select Console > Preferences.
The Preferences screen appears.
8. Click the Printers tab and the Printers preference sheet appears.
For more on this sheet, refer to “Printers Preferences” on page 50.
9. At the 'Badge' combo box, select the badge printer you just configured.
10. Click OK.
For more detailed information, see “Setting Up Badge Printers” on page 439.
Most badge printers have detailed instructions for installing the necessary printer
drivers. For more on this, refer to your badge printer installation guide.

762 Badge Printer Configuration

 MAN006-0612

Opening Enrollment Manager

To start Enrollment Manager:

Method 1
1. Open Velocity.
The Velocity screen appears.
2. Do one of these:
• From the Velocity icon tool bar, click the Enrollment Manager icon, .
• From the Velocity system tree window, select the top level folder,
Configuration. Move to the Components window and double click Enrollment
Manager, .
The main Enrollment Manager screen appears.

Method 2
1. Open Velocity.
The Velocity main screen appears.
2. From the menu bar, select Console > Enrollment Manager.
The main Enrollment Manager screen appears.

Method 3
1. Open Velocity.
The Velocity main screen appears.
2. Press F3.
The main Enrollment Manager screen appears.

Opening Enrollment Manager 763

Velocity Version 3.1 Administrator’s Guide

Enrollment Manager Main Screen

The Enrollment Manager screen looks like this example when you first bring it up:

This screen involves these panes and fields:

Menu bar This menu bar provides many options for features within the
Enrollment Manager. For more on this, refer to “Enrollment
Manager Menu Bar” on page 766.

Tool bar This bar includes two items:

• Search (see page 809)
• Explore (see page 823)

Person The pane in which person groups are created, modified, and
Group pane displayed.
The Everyone person group can not be deleted or added to.

People Tree This pane initially possesses four elements: the Add New Person
pane option, the Add Person from Template option, and the
Unassigned Credentials directory.
Once you have assigned persons to the system, each person also
appears.
For more on this, refer to “People Tree Pane” on page 768.

Quick Find Use this field to perform limited searches of people within the
field system by last name only.
For more on this, refer to “Quick Find” on page 816.

764 Enrollment Manager Main Screen

 MAN006-0612

Credential This pane lists all credentials currently assigned to this person. In
pane addition, both the Add New Credential and Add New
Credential from Template options appear in this area as shown
in this example:

You can perform several tasks from this window by right clicking a
credential after it has been assigned.
The Credentials pane also contains a scrollbar at the bottom which
can be used to scroll through all of the available columns. To
arrange the columns or credential list, refer to “Column
Management” on page 34.

Personal This pane displays all currently defined information for whichever
Information person is selected. For more on this, refer to “Personal Information
pane Pane” on page 769.

Form tabs The Personal Information form consists of up to 13 tabs: one

general page, 10 pages of UDFs, one page of Person Groups, and
one page of Additional Images. For more on this, refer to “Personal
Information Pane” on page 769.

Photo Click this button to bring up the video capture screen.

capture For more on this, refer to “Capturing a Photo” on page 835.
button
Once a picture occupies this frame, you can either email the image
or save it to another location by right clicking on the image. For
more on these topics, refer to “E-mailing a Photo” on page 844
and “Saving a Photo to Another Source” on page 845.

Signature Click this button to bring up the signature capture screen.

capture For more on this, refer to “Capturing a Signature” on page 833.
button

Enrollment Manager Main Screen 765

Velocity Version 3.1 Administrator’s Guide

Selection Click on one or more of these buttons to:

buttons • Add a new credential (see page 864)
• Assign an existing credential (page 804)
• Preview a badge (page 859)
• Print a badge (page 861)
In the row below this, there are three possible buttons:
Apply — click this button to move information entered in the
Personal Information Form to the Velocity database.
Undo — click this button to undo the most recent personnel
entries. All fields are blanked.
Scan — click this button to start the attached scanner , RUU, or PIV
reader and populate the current Personal Information Form
automatically with the detected information. This button only
appears if it has been enabled through one of the Scanners or PIV
Reader page on the Device Configuration screen (page 783).
For more on this feature, refer to “Scanning Enrollment Data” on
page 846.

Status field This field displays information about the current employee
database including:
• Number of People currently enrolled
• Number of Credentials currently assigned
• Number of Credentials currently unassigned
• Number of Guest Credentials currently defined

Enrollment Manager Menu Bar

The Enrollment Manager has a menu bar with these options:

Each option is discussed on the following pages.

Two of these options display other menu options:

Option Sub-Option

File Batch Enroll Credentials—this enables you to enroll a large number

of people at the same time using batch enrollment methods.
For more on this, refer to “Batch Enroll Card Credentials” on page 826.
Close—Exit Enrollment Manager and return to the main Velocity screen.

766 Enrollment Manager Main Screen

 MAN006-0612

Option Sub-Option

View Show Last Access for Credentials – displays the date and time in
the credential pane's 'Last Access' and 'Last Door' columns for all
credentials. This is a toggle option.
By default, this is unchecked and the column is not shown. The 'Last
Door' column shows the door name.
Show UDF Field Summary – when checked, this option displays data
entered for the first 14 UDFs in the People Tree pane. (You must scroll
to the right in the People Tree pane in order to see these additional
User Defined columns.) This is a toggle option. By default, this is
unchecked. When this option is unchecked, the load time for several
thousand users is reduced from minutes to a few seconds.
Note: Neither of these options takes effect until you have refreshed the screen,
either by pressing the F5 key or performing some other task.

Tools Find Person...—this enables you to find a specific person in the

database.
For more on this, refer to “Finding a Person” on page 809.
Find Credential...—this enables you to find a specific credential in the
database.
For more on this, refer to “Finding a Card Credential” on page 813.
Report Manager...—this enables you to open Report Manager without
leaving Enrollment Manager.
For more on this topic, refer to the chapter, “Report Manager,” starting
on page 1005.
Badge Designer...—this enables you to open Badge Designer without
leaving Enrollment Manager.
For more on this topic, refer to the chapter, “Badge & Graphic Designer,”
starting on page 437.
Person Filters...—this enables you to limit a search for employees
using previously defined Person Filters.
For more on this, refer to “Person Filters” on page 815.
User Defined Fields...—this enables you to modify a user-defined
field. For more on this, refer to “Changing User-Defined Fields” on page
776.
Device Configuration...–this enables you to configure credential
enrollment stations, signature capture devices, card and passport
scanners, and PIV readers for use with Velocity. For more on this, see
“Device Configuration” on page 783.
Preferences...–this enables you to change the defaults in Enrollment
Manager for print control, quick find, and credential shortcuts. For more
on this, see “Preferences” on page 896.

Help Consult the help file for information on using Velocity.

Enrollment Manager Main Screen 767

Velocity Version 3.1 Administrator’s Guide

People Tree Pane

The People Tree Pane looks like this example:

The pane includes the following elements and options:

 Click the Add Person option to bring up a new Personal Information form. For
more on this, refer to “Enrolling a New Person” on page 800.
 Click the Add Person from Template option to bring up the Select Person
Template dialog box. When you select a Person Template from this list, you create a
new Personal Information form with fields already populated with the values
specified in the selected person template. For more on Person Templates, refer to
“Person Templates” on page 283. For more on using Person Templates in
Enrollment Manager, refer to “Person Templates” on page 802.
 Click the Unassigned Credentials option to view all currently existing unassigned
credentials in the Credentials pane. These include all credentials that were once
assigned to another user but have since expired or have been de-assigned for
some reason.
 By default, all enrolled people appear in this pane. If you select a specific Person
Group (other than Everyone) from the Person Group pane, the people belonging
to that group appear in this pane. For more on Person Groups, refer to “Person
Groups” on page 823.
 The scrollbar at the bottom of this pane enables you to scroll through all of the
available columns of information from this pane. While you can't see most of these
fields without scrolling, they are there. Initially, there should be four columns in this
pane corresponding to the basic four possible fields at the top of the Personal
Information form on the General tab. The more UDFs you define, the more
columns can appear. To rearrange the people in this list or to reorder the columns,
refer to Column Management. However, if you select View > Show UDF Field
Summary from the Option Bar, up to 18 columns appear in this pane
corresponding to the 18 fields that appear on the General tab. To suppress these
fields, simply deselect the Show UDF Field Summary option.

Hint Under normal circumstances, you won't need to display all these columns of
information in this narrow pane. However, when you are looking for a specific
person in a long list of people, having access to this much information can prove
extremely useful in finding the right one.

768 Enrollment Manager Main Screen

 MAN006-0612

Person Group Subfolders

Some person groups can become very large indeed and include members that are
diverse enough to be categorized into subgroups. Velocity offers a method for creating
subgroups by creating subfolders under person groups.
To create a subfolder within a person group:
1. Display the Person Group pane.
All person groups this operator has permission to view will appear in the pane. The
Everybody person group is a special group and can neither be deleted nor have
subfolders added on to it.
2. Right click on the person group to which you want to add subfolders.
A pop-up option list appears.
3. Select Add Subfolder.
You are prompted to enter a name for this folder.

4. In the text box, enter a name for this subfolder and click OK.
The new folder appears under the selected person group.
Just as with person groups, you can:
 add members to this folder (see page 824)
 edit persons within this folder (see page 801)
 create a sub-subfolder under this folder
 rename this folder
 delete this folder
 search the folder (see page 810)
 use a person filter to search the folder (see page 815)

Personal Information Pane

There are three tabbed property sheets shown on this dialog box:
 General property sheet
 Tab1 — Tab10 property sheets
 Person Groups property sheet
 Additional Images property sheet

Enrollment Manager Main Screen 769

Velocity Version 3.1 Administrator’s Guide

General Property Sheet

The general page of the Personal Information pane looks like this example:

Basic information is supplied on this page:

ID This is a read-only field generated by Velocity. Each new person

has a unique ID.

Record Last This is a read-only field generated by Velocity indicating the date
Updated (MM/DD/YYYY) when this record was last updated.
Windows Control Panel determines the date format.

Name—This is a group of required fields that appear near the top of the panel. All
the other fields are replaceable.

Prefix Select a prefix for this person from the pull-down option list.
Options include: Mr., Mrs., and Ms.

First Name This is a required field. Type a first name for this person.

Middle Name Type a middle name or initial for this person.

Last Name This is a required field. Type a last name for this person.

Suffix Select a suffix for this person from the pull-down option list.
Options include: Sr. and Jr.

User Defined Type or select in each field. You can specify what each field
Fields means using the User Defined Setup option. Using this option
you can also assign UDFs to one of the additional UDF tabs.
For more on this, refer to “Changing User-Defined Fields” on
page 776.
Each of these fields can be linked to a databound text object
placed on a badge template in the Badge & Graphic Designer.
For more on this, refer to “Inserting Databound Text” on page
511.

770 Enrollment Manager Main Screen

 MAN006-0612

Add New Click this button to bring up the Credential dialog box. Make
Credential changes as required to this form. The credential is associated
with that person.
If you want to apply an existing Credential Template to this
person, double click the Add New Credential from Template
option in the Credentials pane above this panel.

Assign Click this button to assign an existing credential to this person. A

Credential list of currently available credentials appears. Select one of these
and the Credential dialog box for that credential appears. That
credential is now assigned to that person.

Preview Click this button and the person's badge appears. This only
Badge happens if you have already assigned a badge template on the
Credential dialog box.
For more on creating badge layouts, refer to “Designing a
Badge,” starting on page 494.

Print Badge Click the Print button to print the badge. For more on this, refer
to “Printing a Badge,” starting on page 861.

Double click this button to capture or acquire the user's

photograph. The Image Preview dialog box (see page 841)
appears.
The image defined here can be linked to a databound image
object placed on a badge template in the Badge & Graphic
Designer. For more on this, refer to “Inserting a Databound
Image” on page 512.
If you need to define additional images, select the Additional
Images tab.

Double click this button to capture or acquire the user's

signature. The Image Preview dialog box appears (see page
840).
The signature defined here can be linked to a databound image
object placed on a badge template in the Badge & Graphic
Designer.

Enrollment Manager Main Screen 771

Velocity Version 3.1 Administrator’s Guide

TAB1 - TAB10 Property Sheets

A TAB page of the personal information form looks like this example:

TAB 1 - By default, Tab 1 displays UDF 15 - 32; however, you can

TAB 10 increase this number as needed. While you can display up to
999 UDFs on the Tab 1 page, you can also assign fields to any
of the additional Tab pages as required through the User
Defined Setup option (see page 778).
Each field here can be linked to a databound text object placed
on a badge template in Badge & Graphic Designer (see page
511).

Groups Property Sheet

This tab enables a qualified operator to add this person to one or more person groups.

The Groups tab of the Personal Information form appears between the TAB 10 tab and
the Additional Images tab. It includes all the person groups currently defined by
Enrollment Manager.
To add a person to a person group from this tab:
1. Click this tab.

772 Enrollment Manager Main Screen

 MAN006-0612

A page like this appears:

2. Check each person group or person group subfolder to which you want to add this
person.
If you made a change by checking or unchecking on the person groups or
subfolders, the Apply button is activated.
3. Click Apply.
The next time you open one of the modified person groups, the person is included in
that group's list.

Additional Images Property Sheet

This sheet only appears after you have defined a new person and clicked Apply, or
selected an existing person from the People Tree pane.
The Additional Images tab provides an image that looks like this example:

This page includes the following fields and buttons:

Image A window listing all the image placeholders currently defined by

Placeholders the Additional Images page of the User Defined Setup screen.
When you select a placeholder from this list, the Update
Image... button is activated.
For more on this, refer to “Defining Additional Images” on page
781.

Enrollment Manager Main Screen 773

Velocity Version 3.1 Administrator’s Guide

Update Click this button to import or capture an image. The process is

Image... identical to that used to capture/import the main photograph on
the General page.
The image defined here can be linked to a databound image
object placed on a badge template in the Badge & Graphic
Designer.
For more on this, refer to “Inserting a Databound Image” on
page 512.

Remove Click this button to remove the selected image from the Current
Image Image frame.

Current Image This window displays the captured or imported image. If you
need to remove it, click the Remove Image button.

Description: A text box where you can enter a title or other information about
the added image.

For more on this, refer to “Additional Images” on page 843.

If you need to customize the look of this form, use Design Mode. For more on using
Design mode in Enrollment Manager, refer to “Customizing the Personal Information
Form” on page 798.

774 Enrollment Manager Main Screen

 MAN006-0612

Personal Information Form

The personal information form appears in the Enrollment Manager's Personal
Information pane whenever you select a pre-existing credential or create a new user.
Initially the form appears in the Enrollment Manager like this example:

The form includes vital security information about the new user such as name, address,
telephone number, employee number, social security number, and so on.
Fields can be customized and changed using the User Defined Fields tool.
In addition to the General tab, the form also includes two other tabs:
 TAB 1 - TAB 10 tabs—By default, TAB 1 displays UDF 15 – 32; however, you can
increase this number as needed. While you can display an infinite number of UDFs
on the TAB 1 page, you can also assign fields to any of the additional TAB pages as
required.
These pages are only populated if you have defined more than fifteen user-defined
fields using the User Defined Fields... tool. TAB 2 – 15 remain blank unless a
qualified operator assigns UDFs to them. A tab can only be opened, if the operator
currently viewing this screen has permission to open it. In this way, a valuable piece
of information, such as a person's social security number, can be isolated on a UDF
tab which can be made inaccessible to most operators.
 Groups tab — This tab enables you to add this enrolled person to one or more
existing person groups. For more on this, see “Groups Property Sheet” on page 772.
 Additional Images tab—this tab enables you to add other images to a person's
profile, such as side views, hand views, etc. For more on this, refer to “Additional
Images” on page 843. If you need to customize the look of this form, refer to
“Customizing the Personal Information Form” on page 798.

Enrollment Manager Main Screen 775

Velocity Version 3.1 Administrator’s Guide

Changing User-Defined Fields

Most of the fields displayed on the Personal Information form are initially displayed as
User Defined fields. This is easily changed: you have the ability to customize an almost
infinite number of fields using the eleven tabbed pages of this form. (The Personal
Information form initially displays 36 UDFs—14 on the General tab and 22 more on
TAB 1—but you can always define more using the following procedure.)
You can also define additional images through the Additional Images page.
These activities are explained below.
 You cannot customize the Name or ID number fields. These are both
mandatory. The ID number is a read-only field and is generated
automatically by Enrollment Manager.
To customize user-defined fields on the Personal Information form:
1. Open Enrollment Manager.
The Enrollment Manager screen appears.
2. At the Enrollment Manager menu bar, select Tools > User Defined Fields...
The User Defined Setup dialog box appears.
For more on this, refer to “User-Defined Setup” on page 778.
All of the currently defined fields are included in this list with the exception of the
Name fields which are mandatory. If this is a new system, no fields are defined.
3. Click in the 'Caption' column of the field name you want to change.
A cursor appears in this cell.
4. Enter the name you want to give this field.
This is the text that will actually appear in the Personal Information Form in place of
the original User Defined field text.

Hint Don't make the field caption name too long. You can overrun the Personal
Information Form's capacity to accommodate the caption. For best results, keep
the character length within the provided Caption columns (16 characters or less).

5. Click in the 'Color' column.

The row becomes a combo box.
6. Click the and select one of the available colors from the drop-down list.
7. Click in the 'Type' column.
The Type specifies what type of field appears in this location on the Personal
Information form.
8. Click the and select one of the choices from the drop-down list.
The available options are:

Text A simple text box where you type information. This is the
default value.

Dropdown A combo box that allows you to either select from the available
options in the drop-down list or enter another value as you
would in a text box.

776 Changing User-Defined Fields

 MAN006-0612

Dropdown A combo box that provides you with a list of options. You must
List select one of these options; you are not allowed to enter a
value in this combo box.

Dropdown A combo box that allows you to either select from the available
(ASC) options in the drop-down list or enter another value as you
would in a text box. Options are always listed in ascending
order.

Dropdown A combo box that allows you to either select from the available
(DSC) options in the drop-down list or enter another value as you
would in a text box. Options are always listed in descending
order.

Dropdown A combo box that provides you with a list of options. You must
List (ASC) select one of these options; you are not allowed to enter a
value in this combo box. Options are listed in ascending order.

Dropdown A combo box that provides you with a list of options. You must
List (DSC) select one of these options; you are not allowed to enter a
value in this combo box. Options are always listed in
descending order.

Date This text field must always contain a date. If you attempt to
enter any other value, a UDF validation screen appears
indicating that the value you entered is not a valid date. The
accepted format for date is either MM/DD/YYYY or
MM/DD/YY.

Number A text field requiring one or more numbers. No letters or special

characters are allowed. This is one of the types you can use for
concatenating a UDF.

Unique A text field requiring a unique number. This means that only a
Number number not used for another person is allowed in this field.
This is one of the types you can use for concatenating a UDF.

Auto- A program-generated text field that must contain a unique

unique number. The number of length are determined by the program.
This is one of the types you can use for concatenating a UDF.

Auto- A text field that automatically increments for each new user
sequential added. The number of digits and initial value of the UDF field
are determined by the value entered for the first user. This is
one of the types you can use for concatenating a UDF.

Unique A text field containing a unique sequence of text that does not
Text appear for another person. If the text appearing in this field is
redundant, a UDF error message appears.

9. If you have specified either Dropdown or Dropdown List, click in the 'Default'
column.
If you specified Text Box in Step 8, go to Step 12.
10. Type the possible options in this list. After each option, press Ctrl + Enter to go to
the next line and type the next option.

Changing User-Defined Fields 777

Velocity Version 3.1 Administrator’s Guide

11. Press Enter to end the option list.

12. If you need to move the field from its currently assigned tabbed page, click in the
'Tab' column.
13. Click the and select one of the available TAB pages from the drop-down list.
 You cannot reassign UDFs 1 - 14 from the General page. You can only
assign UDFs 15 and above.
14. Repeat steps 5 - 13 for each line you want to change.
15. When you're finished, click OK.
The changes you made are displayed on the Personal Information form. These changes
stay in effect for each new user until you decide to change the form again.
Notice that the ‘UDF’ column in the User Defined Setup dialog box cannot be changed.
You can map these numbers to a badge by inserting variable field names in the Badge
& Graphic Designer.

User-Defined Setup
When you select Tools > User-Defined Fields, the User Defined Setup screen
appears. This screen contains two tabbed pages.
The Additional page shows a complete list of available User Defined fields as shown in
this example:

Using the table, you can define the elements of each user defined field you need.

Number of Enter the number of UDFs you need for the Personal Information
UDFs form. 999 UDFs are available. Once you've entered the new
number, click Apply. The UDF list increases or decreases in length
depending on the number you enter here.
Note: Using a large number of UDFs causes the system to take longer
saving people.
The default is 36 UDFs.

Apply Click this button to confirm the number entered in the text box.
If you entered a number less than the previous number of UDFs,
you are prompted to confirm this reduction since doing this will
delete all existing data for higher UDFs.

778 Changing User-Defined Fields

 MAN006-0612

UDF A read-only column of UDFs by number. It should match the

number entered in the 'Number of UDFs' text box.

Caption Click in a cell intersecting this column and the row of the UDF
whose name you want to change. A text cursor appears. Type the
name you want to appear on the Personal Information form for this
field.
The default name is User Defined x where x is the row number.

Req Check the box of this user defined field to indicate that the required
information must be entered in this field before Enrollment
Manager allows the person to be saved.
If the operator tries to save this person without entering information
in this field, a message appears.

Color Click in a cell intersecting this column and the field you want to
change. Select one of the available colors from the drop-down list.

Type Click in a cell intersecting this column and the field you want to
change. Select one of the available options from the drop-down
combo box list. The options are:
Text—A simple text box where you type in information. This is the
default value.
Dropdown—A combo box that allows you to either select from the
available options in the drop-down list or enter another value as
you would in a text box. All options appear in the order they are
entered in the Default column.
Dropdown List—A combo box that provides you with a list of
options. You must select one of these options; you are not allowed
to enter a value in this combo box. All options appear in the order
they are entered in the Default column.
Dropdown (ASC)—A combo box that allows you to either select
from the available options in the drop-down list or enter another
value as you would in a text box. Options are always listed in
ascending order.
Dropdown (DSC)—A combo box that allows you to either select
from the available options in the drop-down list or enter another
value as you would in a text box. Options are always listed in
descending order.
Dropdown List (ASC)—A combo box that provides you with a list
of options. You must select one of these options; you are not
allowed to enter a value in this combo box. Options are listed in
ascending order.
Dropdown List (DSC)—A combo box that provides you with a list
of options. You must select one of these options; you are not
allowed to enter a value in this combo box. Options are always
listed in descending order.

Changing User-Defined Fields 779

Velocity Version 3.1 Administrator’s Guide

Date—This text field must always contain a date. If you attempt to

enter any other value, a UDF validation screen appears indicating
that the value you entered is not a valid date. The accepted format
for date is MM/DD/YYYY.
Number—A text field requiring one or more numbers. No letters or
special characters are allowed. This is one of the types you can use
for concatenating a UDF.
Unique Number—A text field requiring a unique number. This
means that only a number not used anywhere else in the Velocity
database is allowed in this field. This is one of the types you can
use for concatenating a UDF.
Auto-unique—A program-generated text field that must contain a
unique number. The number of length are determined by the
program. This is one of the types you can use for concatenating a
UDF.

Auto-sequential—A text field that automatically increments for

each new user added. The number of digits and initial value of the
UDF field are determined by the value entered for the first user.
This is one of the types you can use for concatenating a UDF.
Unique Text—A text field containing a unique sequence of text that
does not appear anywhere else in the Velocity database. If the text
appearing in this field is redundant, a UDF error message appears.
This is one of the types you can use for concatenating a UDF.

Default If you select either Dropdown or Dropdown List from the 'Field
Type', click in the cell that intersects this column and the row of the
field you want to change. A blank list appears. Enter all possible
options that will appear in this field.
After each option, press Ctrl + Enter to go to the next line and type
the next option. Press Enter to end the option list.
Once you've entered options in this field, the word [List] appears.
The default is [None].

Tab Click in this cell and select one of the available pages from the
option list. The UDF specified here is placed on the designated
page.
For example, if you select TAB 3, this UDF appears on the page
selected by clicking TAB 3.
Note: You cannot reassign UDFs 1 — 14 from the General page. You can
only assign UDFs 15 and above.

780 Changing User-Defined Fields

 MAN006-0612

When you click the Additional Images tab, a page like this appears:

Use this screen to assign image placeholders. These are used on the Additional Images
page of the Personal Information form.
To add image placeholders:
1. At the ‘Image Placeholder Caption:’ text box, enter a name for this placeholder.
2. Click the Add button.
The new placeholder caption appears in the lower window.
3. Repeat Steps 1 - 2 to create more placeholders.
4. Click OK.
For more on this, refer to “Additional Images” on page 843 and “Defining Additional
Images” on page 781.

Defining Additional Images

In addition to defining fields on the Personal Information form, qualified operators can
also define additional images. These images can supplement the photo and signature
capture placeholders Velocity defines by default, enabling an operator to, for example,
add a side view of an employee, or a second signature.
To define additional images:
1. Open Enrollment Manager.
The Enrollment Manager screen appears.
2. At the Enrollment Manager menu bar, select Tools > User Defined Fields...
The User Defined Setup dialog box appears.
All of the currently defined fields are included in this list with the exception of the
Name fields which are mandatory. If this is a new system, no fields are defined.
3. Click the Additional Images tab.
The Additional Images page appears.
4. At the 'Image Placeholder Caption:' text box, enter a name for this placeholder.
5. Click the Add button.
The new placeholder caption appears in the lower window.
6. Repeat Steps 4 – 5 to create more placeholders.
7. Click OK.

Changing User-Defined Fields 781

Velocity Version 3.1 Administrator’s Guide

For more on this, refer to “Additional Images” on page 843.

The changes you made are displayed on the Personal Information form. These changes
stay in effect for each new person until you decide to change the form again.
If you need to reshape or resize fields or text that appears on the Personal Information
form, use Design Mode (see page 798).

782 Changing User-Defined Fields

 MAN006-0612

Device Configuration
Use this feature to specify connections for these devices:
 Credential Enrollment Stations
 Signature Capture Pads
 License Scanners
 PIV (Government-Approved Smart Card) Readers
 RUU Verification Station for PIV (RUU-201 only)
This feature enables you to bypass or expand upon the options provided on the
Preferences Enrollment option page.
 Before an operator can use this feature, you must first check the
'Enrollment Manager - Device Configuration' permission on the Operator
Permissions Property sheet.
To activate any of these devices:
1. Open Enrollment Manager.
2. At the menu tool bar, select Tools > Device Configuration.
The Device Configuration screen appears like this example:

As the example shows, there are five tabbed pages with the Credential Enrollment
page uppermost.
3. Click the appropriate tab(s) to configure the device(s) you require.
For more on each device, refer to the following pages:
• Enrollment Station—see page 784
• Signature Capture—see page 786
• Scanners—see page 787
• PIV Readers—see page 792
• RUU Verification Station—see page 792
4. When you're finished, click OK.
 If you have enabled both an Enrollment Station and Signature Capture
device and specified the same port for both, a message appears
informing you that you can use the same serial port for both of these
devices as long as they are not used at the same time. Click Yes.

Device Configuration 783

Velocity Version 3.1 Administrator’s Guide

Since enrollment station and signature capture devices are typically not used
at the same time, you can assign the same serial port to both of them as
long as an A/B switch intervenes.
You are prompted to close Enrollment Manager and restart it before your changes
will take effect.
5. Click OK.
6. Close and restart Enrollment Manager.

Enrollment Station Configuration

The credential enrollment property sheet of the Device Configuration screen enables
the qualified operator to specify the port to which the enrollment station is attached.
To configure the enrollment station:
1. Click the Credential Enrollment page of the Device Configuration screen as
described in Device Configuration.
When you open the Device Configuration screen, this page appears by default. The
following fields appear.

Serial Port Select the port used by this device. If the port is not listed
here, ensure that it has not been assigned to another
device. If no enrollment station is currently installed on the
system, select not installed.
• If the attached host PC is the Velocity server, select the
COM port the enrollment station is connected to.
• If the attached host PC is a Velocity client, the COM
address includes the client designation like this,
\\client2\\Com1.
• If the enrollment station is connected to the host PC via
a USB-to-RS232 converter, the converter should assign
the next available COM port number to the PC. For
example, if this host PC already has a COM1 and COM2
port, then the converter would assign this connection
COM3.

Custom Card Choose the card mapping you wish to use with this
Mapping enrollment station. Card mapping is sometimes used
when enabling Hex Pass-through. Hex Pass-through
appends two zeros to a card code which can be removed
from Velocity through custom card mapping. For
instructions on creating and using custom card mapping,
see “Card Data Mapping” on page 340.

784 Device Configuration

 MAN006-0612

Enable Hex Check this box to enable the use of card formats that use
Pass-through more than 48 bits, such as DESFire and MIFARE cards at
this enrollment station. This setting allows the enrollment
station to store Hex Pass-through credentials in the
system. Unchecking this box will limit the enrollment
station to accepting a maximum of 48-bit cards, read in an
octal format.

Special This option enables a multi-tech enrollment reader to pass

Handling through Wiegand data to specially customize FASCN data
from PIV cards. Options available are:
• None – not applicable to this reader
• 200-bit FASCN bypass
• 75-bit (14 digits) FASCN bypass
• 75-bit (16 digits) FASCN bypass
• 64-bit FASCN bypass
When pass-through data is sent from the MATCH2 to
DIGI*TRAC, the most important digits are the trailing
(least-significant, rightmost) ones. This option enables you
to specify how this reader handles that type of data.

2. Enter the values you require for this page.

3. Click OK to close the Device Configuration screen.
If you have enabled both an Enrollment Station and Signature Capture device and
specified the same port for both, a message appears informing you that you can
use the same serial port for both of these devices as long as they are not used at
the same time. Click Yes.
Since enrollment station and signature capture devices are typically not used at the
same time, you can assign the same serial port to both of them as long as an A/B
switch intervenes.
You are prompted to close Enrollment Manager and restart it before your changes
will take effect.
4. Click OK.
5. Close Enrollment Manager and restart it.
You are returned to the Enrollment Manager main screen.
6. From the File menu, click Select Batch Enroll Credentials.
The Batch Enroll Card Credential dialog box appears. For more on this screen, refer
to “Batch Enroll Card Credentials,” starting on page 826.
7. Select the Manual Enroll radio button.
Look at the 'Station Status' field which indicates whether the enrollment station is
detected. One of these icons appears:
• . This green icon appears if the station is properly connected and detected
by Velocity.
• . This red icon appears if Velocity does not detect an enrollment station
even though the COM port is set in Preferences and the selected IDF requires
a MATCH. Use the test procedure below to diagnose the problem.

Device Configuration 785

Velocity Version 3.1 Administrator’s Guide

• . If the enrollment station has not been configured with the proper COM
port in Preferences or you have selected an IDF that does not require a
MATCH.
The credential enrollment property sheet of the Device Configuration screen enables
the qualified operator to specify the port to which the enrollment station is attached.

Signature Capture Pad Configuration

The Signature Capture property sheet of the Device Configuration screen enables the
qualified operator to specify both the port to which the signature capture device is
attached and the type of signature capture device being used.
 Passport signatures are not supported by the current signature capture
devices. The signature capture device supports only licenses and IDs.
To configure a signature capture device for use with the Enrollment Manager:
1. Click the Signature Capture page of the Device Configuration screen as
described in Device Configuration.
An example of this page is shown below:

786 Device Configuration

 MAN006-0612

2. Select the appropriate values from the following pick lists:

Device Type: Select one of the Hirsch-approved signature

capture terminals. These include:
• TL462-HSB LCD Signature Capture
Terminal
• TT1500 LCD Signature Capture Terminal
• TT3100 LCD Signature Capture Terminal
New devices may be added to this list as they are
tested and approved by Hirsch.

Serial Port: Select from one of the available port options.

These include:
• Not installed—no such device is currently
installed on this system)
• All COM ports detected by the computer and
currently unused by another serial device except
Enrollment Station
• USB device

3. When finished, click OK to close the Device Configuration screen.

 If you have enabled both an Enrollment Station and Signature Capture
device and specified the same port for both, a message appears
informing you that you can use the same serial port for both of these
devices as long as they are not used at the same time. Click Yes.
Since enrollment station and signature capture devices are typically not used
at the same time, you can assign the same serial port to both of them as
long as an A/B switch intervenes.
You are prompted to close Enrollment Manager and restart it before your changes
will take effect.
4. Click OK.
5. Close and restart Enrollment Manager.

Scanners Configuration
The Scanners property sheet of the Device Configuration screen enables the qualified
operator to specify these aspects of the scanner:
 the type of scanner attached to this computer
 the default document type being scanned (license, business card, passport)
 the method of scanning and photo acceptance to be provided by default
 the fields to which scanned material should be matched in Enrollment Manager
To do this:
1. Click the Scanners page of the Device Configuration screen as described in
Device Configuration.

Device Configuration 787

Velocity Version 3.1 Administrator’s Guide

An example of this page is shown below:

The buttons and fields on this page include:

Installed Scanners This window displays the scanners that have been
window added to the current Velocity configuration. To select a
scanner, use the Add... button.

Add... Click this button to bring up the Add New Scanner

screen and select a scanner. Once selected, the
scanner will appear in the Installed Scanners window.

Edit... Click this button after selecting a previously added

scanner in the Installed Scanners window to bring up
the Scanner properties page for that scanner and
modify existing settings for that scanner like this
example.

For information on the fields and buttons on this

page, refer to Step 3.

Delete Click this button after selecting a previously added

scanner in the Installed Scanners window to delete
that scanner.

788 Device Configuration

 MAN006-0612

Map UDF Fields... Click this button to bring up the Map UDF Fields
screen and map scanned data to the corresponding
fields within Enrollment Manager.
For more on this, refer to “Mapping UDF Fields” on
page 795.

2. Click Add... to add a new scanner.

The Add New Scanner properties sheet appears like this example:

3. Select the appropriate values using the following fields and buttons:

Model: Select the Hirsch-approved scanner. At the current

time, the options are:
• ScanShell 800
• ScanShell 1000
• Intelli-Check DCM
The ScanShell 1000 and ScanShell 800 can scan
business cards and licenses; they cannot scan
passports.
Note: Passport signatures are not supported by the
current signature capture devices. The signature
capture devices support only licenses and IDs.
New scanning devices may be added to this list as
they are tested and approved by Hirsch. If there is
no scanner attached to this system, leave the
default option, Not Installed.

Port If this scanner is connected to a port on the

Velocity workstation, select the port from the
drop-down list.

Enable Check this box to indicate that the scanner is

attached and ready to go.

Enrollment Settings

Device Configuration 789

Velocity Version 3.1 Administrator’s Guide

Auto launch on Check this box to indicate that the scanner begins
paper detect scanning the document once it senses that the
document is entering the scanner front. Otherwise,
you must start the scanner manually from the
relevant Verify Scanner Data page.
Note: Only the ScanShell 800 supports this feature. The
ScanShell 1000 does not support automatic
paper detection.
This box is checked by default.

Auto accept Check this box to indicate that the data read by the
scanned data scanner is automatically accepted and written into
the database. This bypasses the review process
(Step 6 of the Scanning instructions). Scanned
data populates the displayed Personal Information
Form.
If this box is not checked, the scanner software
presents a copy of the scanned data for your
acceptance and modification on the Verify Scanner
Data page.
Generally, it is good policy to test your scanner for
accuracy before enabling this feature. If the
scanner has demonstrated a high degree of
success in scanning documents correctly, you may
decide to check this box. The default is unchecked.

Capture photo if Check this box to instruct the scanner to scan any
available picture included on the document. If left
unchecked, any photos detected by the scanner
are ignored and only text data is collected. The
default is unchecked.

Capture signature if Check this box to instruct the scanner to scan any
available signature included on the document. If left
unchecked, any signatures detected by the
scanner are ignored and only text data is collected.
The default is unchecked.

Maintenance... Click this button to bring up the Scanner

Maintenance screen which can be used to test,
clean, or calibrate the attached scanner.
For more on this, refer to “Scanner Maintenance”
on page 791.

790 Device Configuration

 MAN006-0612

Default Document Indicate the default type of media you will be

Type: scanning with this scanner. Select from one of
these available document types:
• Business Cards
• License/ID (OCR)
• License/ID (Bar Code)
• Passport
The type you select indicates how the scanner
orders the scanned data and into which fields the
data is placed. It also determines the fields that
populate the 'Document Field' window on the Map
UDF Fields screen (see page 795).

4. When finished, click OK to close the Device Configuration screen.

You are prompted to close Enrollment Manager and restart it before your changes
will take effect.
5. Click OK.
6. Close Enrollment Manager and restart it.
Once you restart Enrollment Manager, a Scan button will appear at the bottom of the
Personal Information form whenever you select a person or create a new person.

Scanner Maintenance
When you click the Maintenance... button on the Scanners page of the Device
Configuration screen, a Scanner Maintenance screen like this example appears:

Device Configuration 791

Velocity Version 3.1 Administrator’s Guide

This screen contains the following buttons and fields:

Test Scan Click this button to test the currently attached scanner. If
a scanner is in fact correctly attached, the SDK Version
number is returned, as shown in the example. The
window to the right also displays relevant scanner
revision number and diagnostic information.

Clean Scanner Click this button to clean the scanner. This sets in motion
the scanner's self-cleaning process. You are notified
when the procedure is complete.

Calibrate Click this button to recalibrate the scanner. The scanner

checks its tracking and focusing processes. When the
calibration is complete, the “Calibration: OK” appears in
the Status window (as shown in the example above)
along with other relevant information in the right
window.

Status This section provides information about the current

status of the scanner, such as its SDK version number
and calibration status.

Close Click this button to close the Scanner Maintenance

window and return to the Scanners page.

PIV Reader Configuration

Personal Identification Verification (PIV) readers are SmartCard readers that conform to
the U.S. Government's FIPS 201 standard for federal employees and contractors.

Hint Most SmartCard readers that use DESFire and conform to the FIPS201 standard
are supported by this feature. Since this is a prevailing standard, observed by many
manufacturers, you should have a choice of many readers that can use this
function.

The PIV Reader property sheet of the Device Configuration screen enables the qualified
operator to match the fields read by the PIV reader to UDF fields on the Enrollment
Manager Personal Information Form.
To do this:
1. Click the PIV Reader tab of the Device Configuration screen as described in
Device Configuration.

792 Device Configuration

 MAN006-0612

An example of this page is shown below:

2. Select the appropriate values from the following pick lists:

Enable PIV Check this box to indicate that the reader(s) are
reader(s) attached and ready to go.
Velocity finds the PIV reader matching the card
type specified below.

Default Card Type: Select the Hirsch-approved default card type for
this PIV reader.
At the current time, these options are listed:
• DESFire FIPS201
• FIPS 201 - Contactless
• FIPS 201 - Contacted
• DoD (Legacy) CAC
The default selection is DESFire FIPS201. New
reader card types will be added to this option list
as they are tested and approved by Hirsch.
If no reader is attached to this system, leave the
Enable PIV reader(s) box unchecked.

UDF Field Mapping

Map UDF Fields... Click this button to bring up the Map UDF Fields
screen and map received data from the PIV reader
to the corresponding fields within Enrollment
Manager.
Note: Field mappings are global to all workstations.
For more on this, refer to “Mapping UDF Fields” on
page 795.

3. When finished, click OK to close the Device Configuration screen.

You are prompted to close Enrollment Manager and restart it. You must do this,
before the Scan button appears.

Device Configuration 793

Velocity Version 3.1 Administrator’s Guide

4. Click OK.
5. Close Enrollment Manager, then restart it.
When you restart Enrollment Manager, a Scan button will appear at the bottom of the
Personal Information form whenever you select a person or create a new person.

Device Configuration for RUU Station

The PIV version of the Hirsch RUU-201 Verification Station (RUU-201) can be used as
an enrollment station.
 At this time, neither the CAC version (RUU-CAC) nor the General Purpose
version (RUU-GEN) are supported by this feature. Only the PIV version
(RUU-201) is currently supported.
When you select the RUU tab from the Device Configuration screen, the RUU page
appears, like this example:

The fields and buttons on this page are described below:

Enable RUU reader Check this box to indicate that the reader(s) are
attached and ready to go.
Velocity finds the PIV reader matching the card
type specified below.

Default Card Type: Select the Hirsch-approved default card type for
this RUU reader. At the current time, there is only
one option listed:
• FIPS 201 - Contact
New reader card types will be added to this option
list as they are tested and approved by Hirsch.
If no reader is attached to this system, leave the
Enable RUU reader box unchecked.

IP Settings

794 Device Configuration

 MAN006-0612

RUU IP: Enter the IP address of the RUU station as

specified in Step 2 of the Add Device wizard. For
more on this, refer to the Verification Station
Configuration Guide.

RUU Port Enter the port number of the RUU as specified in

Step 2 of the Add Device wizard. For more on this,
refer to the Verification Station Configuration
Guide.
The default value is 2000.

Listen Port Enter the listen port number for this RUU as
specified in Step 2 of the Add Device wizard. For
more on this, refer to the Verification Station
Configuration Guide.
The default value is 2001.

Options

Auto accept on Check this box to indicate that the data read by the
Verify scanner is automatically accepted and written into
the database.
This bypasses the review process (Step 6 of the
scanning instructions). Scanned data populates the
displayed Personal Information Form.
If this box is not checked, the station presents a
copy of the scanned data for your acceptance and
modification on the Verify Scanner Data page.

UDF Field Mapping

Map UDF Fields... Click this button to bring up the Map UDF Fields
screen and map received data from the RUU
reader to the corresponding fields within
Enrollment Manager.
Note: Field mappings are global to all workstations.
For more on this, refer to “Mapping UDF Fields” on
page 795.

When finished, click OK and you are prompted to close and reopen Enrollment
Manager. You must do this, before the Scan button appears.
When you restart Enrollment Manager, a Scan button will appear at the bottom of the
Personal Information form whenever you select a person or create a new person.

Mapping UDF Fields

This function enables the qualified operator to map data collected from either a
scanner or PIV reader to corresponding UDF fields within the Enrollment Manager
Personal Information Form.

Device Configuration 795

Velocity Version 3.1 Administrator’s Guide

For example, an operator needs to enroll a visitor. He does this by inserting the visitor's
business card into the card scanner (such as the ScanShell 800). The scanner
successfully reads data off the business card and identifies the name (first and last),
address, company, and telephone number. This data is placed into the corresponding
fields on the Personal Information Form in Enrollment Manager. Simple, enough,
except that this data does not automatically find its way to the correct UDF fields unless
the supervisor, configurator, or qualified operator matches those pieces of data to the
corresponding UDF fields in advance. This feature enables you to do this.
To map scanned or read data to UDF fields:
1. Open the Device Configuration screen and click the Scanners, RUU, or PIV
Reader tab.
The Scanners, RUU, or PIV Reader page appears.
2. Fill out the required forms.
• For the Scanners page, specify the Scanner Type and the Default Document
Type.
• For the RUU page, specify the Default Card Type.
• For the PIV Reader page, specify the Reader Type.
3. Click the Map UDF Fields... button.
The Map UDF Fields dialog box appears like this example:

4. In the 'Fields for' pick list, select the type of document this mapping applies to.
• For Scanners, the available mapping configurations are: Business Card,
License/ID (OCR), License/ID (Bar Code), or Passport.
• For PIV Reader, the only current selection is DESFire FIPS201, a popular
standard for contactless smart cards.
Each of these configurations populates the Document Field window with different
field options.
5. Map fields in the Document Field window to fields in the UDF Field window in one
of two ways:
• Click Auto Map. All identically named fields are automatically matched,
indicated by a network of match lines.
• Manually map fields by dragging a field from the Document Field window to
the corresponding field in the UDF Field window. Notice that as you drag, an
icon and line follow the cursor until the intended field is identified. A match
line then form between the document field item and the UDF field item.

796 Device Configuration

 MAN006-0612

Hint Normally, you will use a combination of auto and manual mapping techniques to
completely map all the fields you need.

The matched fields are joined by match lines as shown in the following example:

If you've made a mistake and need to remap a particular item, right click on either
the Document Field item or the UDF Field item and the match line connecting the
two items disappears. Now you can remap the item as required.
If you need to start over, simply click Remove All Mappings and begin again.
6. Click Apply.
7. Click Close.
The Device Configuration screen reappears.

Device Configuration 797

Velocity Version 3.1 Administrator’s Guide

Customizing the Personal Information Form

There are occasions on which you might need to redesign the default Personal
Information Form. This can happen because you have defined text for a user-defined
field that exceeds the number of characters that can be comfortably accommodated by
the current form, or you have defined a field that will require more characters than the
current field can handle.
In the following example, text has been defined for a field that exceeds the default
length:

In order to accommodate the increased length of the text on the right, the window on
the left must be shortened and the text moved.
Velocity provides you with an easy way to customize any text or fields that appear in the
personal information form: Design Mode.
To use Design Mode:
1. Go to the Preferences screen and make sure you have checked the 'Access and
Enable Customized Values for Components in Customization Manager' box on the
General page.
For more on this, refer to “General Page Preferences” on page 45.
2. Make sure the operator in question has been assigned the ‘Design Mode - Access’
permission.
For more on this, refer to the instructions in “Roles: How To Define” on page 287.
3. Open Enrollment Manager.
If you open Enrollment Manager before changing the preferences and permissions
required in Steps 1 - 2, close Enrollment Manager and reopen it before proceeding
to the next step.
4. Click on the icon in the upper left hand corner of the Enrollment Manager screen,
.
In addition to the normal Windows options, you will see an additional option at the
bottom of the list:

5. Select Enter Design Mode.

The words Design Mode appear in the Enrollment Manager title bar.
6. Access the Personal Information form either by opening an existing person's form
or creating a form for a new person.

798 Customizing the Personal Information Form

 MAN006-0612

7. To change the position or length of text to the left of an existing field:

a. Click on the text. Black handles appear around the text.
b. Pull the handles to define the new position and/or area of the text.
8. To change the size or position of a field:
a. Click within the field. Black handles appear around the field like this example:

b. Pull the handles to define the new position and/or area of this field.
9. Continue this process until you have defined the requirements for this new form.
10. Click on the upper left hand icon again.
An option list like this appears:

11. Select Exit Design Mode.

If you have made any changes to the form, a message like this appears:

12. Click Yes.

A second message appears like this:

13. Click Yes. The changes are saved.

This method works for the fields, windows, and text that appear on all three pages of
the form.
For more on design mode, refer to “Design Mode,” starting on page 15. You can also
make changes to text using Customization Manager.

Customizing the Personal Information Form 799

Velocity Version 3.1 Administrator’s Guide

Enrolling a New Person

Velocity uses the generic term ‘Persons’ to refer to all people who must access a facility,
including employees (part-time and full-time), contractors, and personnel working for
companies that supply services.
To enroll (add) a new person:
1. Open Enrollment Manager as detailed in “Opening Enrollment Manager” on page
763.
The Enrollment Manager screen appears.
2. From the People Tree pane, click Add New Person.
A blank Personal Information form appears in the Personal Information pane.
3. Supply information to the existing fields as required.
At a minimum, you must type in the new person's first and last name.
4. Enter the required information to any fields listed on this page.
To customize a user-defined field, refer to “Changing User-Defined Fields” on page
776.
5. If you need to fill out more fields than can be accommodated on the General
page, click the TAB 1 — TAB 10 as required.
6. Enter values for any user-defined fields appearing on these additional pages.
7. Click the Apply button.
Notice that several folders appear in the Credentials pane.
8. Double click the photograph frame to import or capture a photograph.
The Image Preview dialog box appears. For more on capturing or importing a
photograph, refer to “Image Preview” on page 840.
9. To capture or import a signature, double click the signature frame, ,
located below the photo frame.
The Image Preview dialog box appears. For more on capturing or importing a
signature, refer to “Image Preview” on page 840.
10. If you need to add or capture any additional images, click the Additional Images
tab.
The Additional Images page appears.
11. Select any placeholders you need from this page then import or capture these
additional images as needed. The import and/or capture process is identical to the
one used on the General page.
 Before you can include additional images, you must first define the
requisite placeholders using the User Defined Fields option. For more on
this, refer to “Changing User-Defined Fields” on page 776.
12. Assign a credential to the new person or create a new credential for this person,
using one of these procedures:

To assign: Do this:

A new credential Double click the Add New Credential button on the
form, or double click the Add New Credential folder
in the Credentials pane.

800 Enrolling a New Person

 MAN006-0612

To assign: Do this:

A credential template Click the Add New Credential from Template

to a new credential folder in the Credentials pane.
The Select Credential Template dialog box appears.
Select the template you want to use and click OK.

An existing, Click the Assign Credential button on the form.

unassigned credential

The Credential dialog box appears.

13. Fill out or change the Credential dialog box property sheets as required. At a
minimum you must:
• if you specify a keypad (code) IDF, assign a valid PIN
• if you specify a card IDF, assign a valid MATCH code
• assign a valid door group or function group
14. When you're finished, click OK.
You are returned to the Personal Information form. The newly-assigned credential
appears in the Credential pane.
15. Perform required tasks in the Credential pane.
16. If you are creating a badge for this person, click the Preview Badge button to
view the way the final badge will look.
 In order for this feature to work, you must have assigned a Badge
Template on the Credential dialog box.
17. Click the Print Badge button to create a badge for this person.
 In order for this feature to work, you must have a badge printer
connected to and configured for this Velocity workstation.
If you need to create a new badge for a new credential, you can access the Badge
Designer through the Tools menu option. You can also access the Report Manager
through the Tools menu option.
To import an existing user database from the Hirsch program SAM, use the SAM
Database File Import Wizard as detailed in “SAM Database File Import Wizard,” starting
on page 384.

Editing Multiple Persons

This feature enables the qualified operator to change one or more values on a person's
Personal Information Form for multiple people.
To edit multiple persons:
1. Select multiple people from the People Tree pane.
2. Right click within the highlighted area.
3. Select Edit Persons.

Enrolling a New Person 801

Velocity Version 3.1 Administrator’s Guide

The Multiple Person Edit form appears like the example below:

This screen includes most of the elements of the Personal Information Form,
including the UDF values. In addition, notice that a note appears below UDF fields
indicating the number of people currently selected for changes.
4. Check each box to the left of each field you need to change for all selected
persons, then supply a new value in the text or pick list.
5. Click Apply or OK.
The value in each checked field is changed for those people selected.
For example, if you want to move three people from Research and Development to
Administration, you would check the Division field and select Administration from the
pick list. When you click Apply or OK, Velocity automatically reassigns the selected
people to the Administration division.

Person Templates
Use Person Templates to expedite the task of assigning information to people being
enrolled. Simply apply an existing person template to a new person and the field values
assigned to the person template populate the relevant fields for that person.
To use a person template to enroll a new person:
1. From the Enrollment Manager's Person Tree pane, double click the Add Person
from Template option.
The Select Person Template appears like this example:

Only those person templates currently defined for this system appear in the
window.
2. In the person template window, click to select the template you want to apply to
this new person.

802 Enrolling a New Person

 MAN006-0612

3. Click OK.
A new Personal Information Form appears. Fields on that form are populated with
values taken from the selected person template.
For example, if you defined a person template like this example:

then selected that person template when enrolling a new person like this:

those values entered in the selected person template are used to automatically
populate the Personal Information form for the new person, like this:

Enrolling a New Person 803

Velocity Version 3.1 Administrator’s Guide

Assigning a Credential to a Person

To assign a credential to a person:

To assign: Refer to:

An existing credential to a person “Assigning an Existing Credential to a Person”

on page 804.

A new credential to a person “Assigning a New Credential to a Person” on

page 806.

A credential template to a new “Assigning a Credential Template to a Person”

credential on page 807.

A person to an unassigned “Assigning a Person to an Existing Credential”

credential on page 806.

Once a person has been assigned one or more credentials, the credentials appear in
the Credential window above the Personal Information form, like this example:

You can perform a number of tasks from this window by right clicking the credential.
Once you've assigned one or more credentials to this person, capture a photograph or
signature as required.
For more on creating credentials, refer to “Credentials” on page 863.

Assigning an Existing Credential to a Person

To assign an existing credential to a person:
1. From the Enrollment Manager screen, select the person to whom you want to
assign an existing, unassigned credential.
2. From the Personal Information form, click the Assign Credential button on the
form.
The Assign Credential to Person dialog box appears like this example:

804 Enrolling a New Person

 MAN006-0612

3. Search for a specific credential by selecting one of these radio buttons:

Card Stamp If you select this radio button, enter the card stamp
Number: number of the credential you are looking for in the text box
to the right of this radio button.
Once you click Find, the credential associated with this
card stamp number appears in the lower window.

MATCH Code: If you select this radio button, enter the MATCH code of the
credential you are looking for in the text box to the right of
this radio button, or swipe the card associated with this
credential at the Enrollment Station.
Once you click Find, the credential bearing this MATCH
code appears in the lower window.

PIN If you select this radio button, enter the PIN number for
which you are searching in the active text box.
Once you click Find, the credential bearing this PIN code
appears in the lower window.

Show all If you select this radio button, all unassigned credentials
Unassigned are displayed in the lower window.
Credentials Once you click Find, all unassigned credentials are
displayed in the lower window.

4. Click Find.
All credentials matching the search criteria are displayed in the lower window, like
this example:

If you need to see when an unassigned credential was last used, scroll over to the
'Last Access' column in the Credentials window. If this time and date does not
appear, select the View > Show Last Access for Unassigned Credentials
toggle option from the menu tool bar.
5. From the dialog box's lower window, click to select the unassigned credential you
want to assign to this person.
Double click on a selection to edit the credential. The credential properties dialog
box for that credential appears. Edit the credential as required. When you're
finished, click OK to return to the Assign Credential to Person dialog box.
6. Click Assign.

Enrolling a New Person 805

Velocity Version 3.1 Administrator’s Guide

The credential is assigned to the person whose name appears in the title bar of
this dialog box.
The existing credential is assigned to the designated person.

Assigning a Person to an Existing Credential

To assign an unassigned credential to a person:
1. From the Enrollment Manager screen, select Unassigned Credentials from the tree
pane.
All currently unassigned credentials appear in the credential pane like the following
example:

2. From the credential pane, right click on the unassigned credential you want to
assign to a person.
A drop-down option list appears.
3. Select Assign from the drop-down option list.
The Assign Person to Credential dialog box appears with a list of all currently
defined people.

4. Select the person to whom you want to assign the selected credential.
5. Click OK.
The credential is now assigned to the selected person.

Assigning a New Credential to a Person

To assign a new credential to a person:
1. From the Enrollment Manager screen, select the person to whom you want to
assign the new credential.
2. From the Personal Information form:
• click the Add New Credential button on the form or
• double click the Add New Credential folder in the Credentials pane.
The Credential dialog box appears.
3. Fill out the dialog box property sheets as required. At a minimum:
• if you specify a keypad (code) IDF, assign a valid PIN

806 Enrolling a New Person

 MAN006-0612

• if you specify a card IDF, assign a valid MATCH code

• assign a valid door group or function group
4. When you're finished, click OK.
You are returned to the Personal Information form.

Assigning a Credential Template to a Person

To assign an existing Credential Template to a Person:
1. From the Enrollment Manager screen, select the person to whom you want to
assign the new credential.
2. From the Credential pane on the Personal Information form, double click the Add
New Credential from Template folder in the Credentials pane.
The Select Credential Template dialog box appears like this example:

3. Select the template you want to use and click OK.

The Credential dialog box for that template appears.
4. Add and change the dialog box property sheets as required. At a minimum:
• if you specify a keypad (code) IDF, assign a valid PIN
• if you specify a card IDF, assign a valid MATCH code
• assign a valid door group or function group
5. When you're finished, click OK.
You are returned to the Personal Information form.

Unassigning Credentials
To unassign a credential currently associated with a person:
1. From the Enrollment Manager screen, select a person from the tree pane.
All currently assigned credentials appear in the credential pane.
2. From the credential pane, right click on the credential you want to unassign. An
option list pops up.
3. Select Unassign from the drop-down option list.
The credential disappears from the person's credential pane and is moved to the
Unassigned Credentials file.
 Unassigning a credential does not change the function of the credential.

Downloading Credentials
Before new or modified credentials can take effect, they must be downloaded to their
controller(s). This is routinely performed whenever you click OK on a credential form
after changing one or more values; however, you can force a download using the
following technique.
To force a download of one or more credentials:

Enrolling a New Person 807

Velocity Version 3.1 Administrator’s Guide

1. From the people tree pane, select the person whose credential(s) you want to
download.
The person's statistics appear on the Personal Information form and all credentials
currently assigned to this person appear in the credential pane.
2. Right click the credential you want to force download.
A list of options appear.
3. Select Force Download.
The selected credential is immediately downloaded to the relevant controllers.
To force the downloading of multiple credentials, refer to “Downloading Multiple
Credentials” on page 808.

Downloading Multiple Credentials

This is a shortcut for downloading all current credentials to their respective controllers.
To download all credentials:
1. From the people tree pane, select all the people whose credentials you want to
download.
To select a range of people, use the Shift + click combination; to select a
non-contiguous group of people, use the Ctrl + click combination.
2. From the people tree pane, right click the highlighted group. Options pop up.
3. Select Display Credentials...
The Credentials - Multiple People window appears like the following example:

4. Select one or more of these credentials.

5. Right click the highlighted group. A group of options pop up.
6. Select Force Download.
7. Click Close to close this window and return to the main Enrollment Manager
screen.

808 Enrolling a New Person

 MAN006-0612

Finding a Person
It can be difficult to find a specific person in the Enrollment Manager once you have a
few hundred employees, contractors, and part-timers to keep track of. To help you find
a person quickly, Enrollment Manager includes a quick find feature.
To find a person:
1. Open Enrollment Manager.
The Enrollment Manager screen appears.
2. Do one of these:
• From the menu bar, select Tools > Find Person in All Groups...
• From the icon tool bar, click the Search icon, .
The Search All Groups dialog box appears. For more on this screen, refer to
“Search Groups Screen” on page 811.
3. Click the 'Field' pick list and select the field you want to use for data in this search.
All fields currently defined on the Personal Information form appear in this list.
4. Click in the first 'Function' pick list and select the first term of the argument.
This is a simple 'is' or 'is not' term.
5. Click in the second 'Function' pick list and select the second term of the argument.
If you select is greater than or less than as a search argument, a check box
appears.
6. If appropriate, check the 'or equal to' box to extend the range of the argument.
7. Click in the Value field and enter an appropriate value for the argument you
specified.
If you are specifying an exact match using the equal to argument, a list of all data
equivalents for the specified field appear. Select one or more of these.
For example, if you specified Last Name in the 'Field' pick list and is equal to in the
'Function' pick lists, all relevant last names appear in the 'Value' field.
If you specified a Like condition and are trying to find a variation of the value you
entered in the 'Value' pick list, you can use one of several wildcards including %, _,
[ ], and [^].
8. Click Add.
The full argument appears in the Search window.
9. Click Search.
Enrollment Manager searches for and finds all persons matching the criteria you
specified.
10. In the Person Groups pane, click the Search Results icon, .
The results of the search appear in the People Tree pane.
11. To return to Enrollment Manager, click Cancel.
To help you find a last name quickly, Enrollment Manager also includes a quick find
feature. For more on the Quick Find feature, refer to “Quick Find” on page 816.

Finding a Person 809

Velocity Version 3.1 Administrator’s Guide

Search Groups
This feature enables the qualified operator to search through one or more selected
groups using a specified search term for resulting matches.
To search a single group:
1. At the Person Group pane, right click the group you want to search.
A pop-up list appears.
2. Select Search Group.
The Search Group screen appears.

This dialog box is exactly the same as the Search All Groups screen and acts
identically. For more on this, refer to “Search Groups Screen” on page 811.
3. Create one or more arguments as required.
4. Click Search.
5. In the Person Group pane, click to highlight the icon.
A list of all relevant search results appears in the Person Tree pane. These results apply
only to the currently selected Person Group.
To search all existing groups:
1. At the Person Group pane, right click the top-level (root) of the tree.
For example, in the following example, you would right click on the HIRSCHTEST
root.

A pop-up list appears.

810 Finding a Person

 MAN006-0612

2. Select Search All Groups.

The Search All Groups screen appears.

For more on this, refer to “Search Groups Screen” on page 811.

3. Create one or more arguments as required.
4. Click Search.
5. In the Person Group pane, click to highlight the icon.
A list of all relevant search results appears in the Person Tree pane. These results apply
only to the currently selected Person Group.

Search Groups Screen

The Search Groups and Search All Groups screens appear when you select the Search
Groups or Search All Groups right click option from the root item of the person
group pane.
This screen looks like this example:

Finding a Person 811

Velocity Version 3.1 Administrator’s Guide

This screen includes the following fields and buttons:

Field Description

Field: Select the field you want to use for this search. Choose from any of
the available fields, default or UDF.
All fields currently displayed on the Personal Information form
appear in this list.
For example, if you wanted to search the person database by the
last name, you would select the Last Name option from the ‘Field’
pick list.

Function: Supply the first and second elements of the search argument you
want to use for searching this person list.
The two possible values for the first element appear in this pick list:
is – The person you are searching for is the second element.
is not – The person you are searching for is not the second
element.
The possible values for the second element appear in this pick list:
equal to – The person you are searching for has a value that is
identical to the selected field value.
less than – The person you are searching for has a value less than
that you specified in the 'Value' field.
greater than – The person you are searching for has a value
greater than that you specified in the 'Value' field.
starting with – The person you are searching for has a value that
starts with that you specify in the 'Value' field.
like – The person you are searching for has a value that is similar to
the selected field value.
For example, if you specified a value of 'Smith%' in the 'Value' field,
Enrollment Manager searches for a value like 'Smith' such as
'Smithon' or 'Smithers'.
If you don't use wildcard characters in the Like condition, it behaves
like the equal to condition.
If you select either less than or greater than as a second search
argument, a check box appears to the right of the 2nd search
argument pick list.
or equal to – If you select either less than or greater than, this
check box appears. Check this box to indicate that the search term is
actually less than or equal to, or greater than or equal to.
between – If you select a UDF that is defined as a date type, you
can use this term. Two combo boxes appear into which you can
enter the range of dates between which you want to search.
within – If you select a UDF that is defined as a date type, you can
use this term. Three combo boxes appear: two boxes enabling you
to determine the range of your search and a box specifying the
period (e.g. an hour, 12 hours, a year) for which you are searching.

812 Finding a Person

 MAN006-0612

Field Description

Value field Enter a value for this search in this text window. The functions you
selected above apply to this.
If you selected is equal to as an argument, all values relevant to this
'Field' appear in this window as shown in the following example:

For example, if you specified Last Name in the 'Field' pick list and is
equal to in the 'Function' pick lists, all relevant last names appear in
this field. Click to select one or more values relevant to your present
search.
If you selected either between or within as your 2nd search
argument, two new pick lists appear like this example:

Click on the right arrow to reveal a calendar in order to refine your

search dates.
If you specified an is... like condition and are trying to find a
variation of the value you entered in the 'Value' field, use any of
several wildcards including %, _, [ ], and [^].

Add Click this button to add this element. If you change the argument
once it is added, the button changes to Update.

Search All added arguments are displayed in this window. If more than one
window argument appears here, then additional conditions, like AND or OR
are added here.

Save... Click this button to save this argument as a search filter.

For more on search filters, refer to “Search Filters” on page 815.

Search Click this button to begin the search on the specified group. The
results are displayed in the folder.

Close Close this screen and return to Enrollment Manager.

Finding a Card Credential

In large facilities with many people and credentials, it is often difficult to find who has
been assigned a particular credential. In order to expedite the search, use Velocity's
Find Card feature. You can search by either Card Reference Number or MATCH code.
This enables you to cross-reference a card with a person and is particularly useful in the
event that a card is recovered.
To find a card credential:
1. Open Enrollment Manager.
The Enrollment Manager screen appears.
2. From the Enrollment Manager menu bar, select Tools > Find Card Credential...

Finding a Person 813

Velocity Version 3.1 Administrator’s Guide

The Find Card dialog box appears like this example:

The buttons and fields on this screen include:

Credential Id Click to select this radio button, then enter credential

ID in the activated text field.

Card Stamp Click to select this radio button, then enter card stamp
Number number in the activated text field.

MATCH Code Click to select this radio button, then either enter the
MATCH code in activated text field or double click the
Enrollment Station icon, , and swipe the credential
through it; the number appears in the activated field.

PIN Code Click to select this radio button, then enter PIN code in
the activated text field.

Find Click this button to search the database for the

specified credential.

Edit Select the credential displayed in the Search results

window and click this button to bring up the credential
properties sheet for that credential. Make modifications
as required.

Search results The search results appear in this window, including all
window relevant credential information. To view complete
columns, scroll right.

3. Perform one of the following operations:

• Click the Credential Id radio button and type in a credential ID number.
• Click the Card Stamp Number radio button and type in the card stamp
number.
• Click the MATCH Code radio button and either enter the code number in the
text field or swipe the credential through the enrollment station. You can only
swipe a card successfully if the enrollment station icon is green, indicating that
the station is functional. If the icon is red, like the above example, double click
this icon and the Enrollment Station Diagnostics dialog box appears (see page
831). Check the connection with the enrollment station.

814 Finding a Person

 MAN006-0612

 You cannot swipe a card through an enrollment station unless one is

connected to your system and properly configured.
• Click the PIN Code radio button and type in a PIN code.
4. Click Find.
The results of the search appear in the Search results window.
If no card credential matching the criterion is found, a message appears indicating
that. Click OK.
5. To return to Enrollment Manager, click Close.

Search Filters
Creating a search filter is time-consuming, involving the formulation of a search criteria
using the Velocity-specific query language. If you have enrolled a large number of
employees for this system, you may want to define several search filters you can use
repeatedly without having to invoke the Search Group dialog box each time.
To create a search filter:
1. At Enrollment Manager, invoke the Search Group or Search All Group option.
The Search Group or Search All Groups dialog box appears.
2. Create a search criteria.
3. Click Save...
If this search criteria has not already been created, a dialog box like this appears:

The text that appears here initially represents the first line of the search criteria
appearing in the Argument window.
4. Either accept this name by click OK or enter a new name and click OK.
The new filter is added to the Person Filters index and appears when you bring up
the Person Filters dialog box.
To execute or edit person filters, refer to “Person Filters” on page 815.

Person Filters
Use this feature to find a specific person by matching a selected person group to an
available search filter.
To use a person filter:
1. From the Person Group pane, click to highlight a person group.
Only one person group at a time can be selected. Only those person groups
currently defined for this system appear in this pane.
2. Do one of these:
• From the menu bar on the Enrollment Manager main screen, select Tools >
Person Filters...
• Right click on person group(s) you want to search and select Execute Saved
Filter on Group...

Finding a Person 815

Velocity Version 3.1 Administrator’s Guide

The Person Filters screen appears like this example:

Any previously-defined person filters appear in the window.

3. Click to highlight the Person Filter you want to use.
4. Do one of these:
• Click Execute to initiate a search on the currently selected person group.
• Click Edit to bring up the Search Group screen associated with the selected
Person Filter. Modify the search arguments as required then save the results.
• Click Delete to delete the currently selected person filter. Click Yes to confirm
your decision.
5. When you're finished, click Close to exit this dialog box and return to the
Enrollment Manager.

Quick Find
The Quick Find field appears between the People Group pane and the People Tree
pane. It enables you to search for a person in the People Tree pane by last name only.
To use the Quick Find feature:
1. Using the Persons Group and People Tree pane, display the list of people from
which you are trying to find a specific person.
2. Click in the ‘Quick Find’ text box and start typing.
Each keystroke you enter initiates a search. If results are returned, the Quick Find
text box becomes a drop-down list and all relevant results appear like this example:

If you enter a group of letters for which there is no corresponding last name, the
drop-down list disappears like this example:

3. When a list of probable matches appear in the drop-down list, cursor down the list
to the name you're looking for and press Enter.
The Personal Information Form for the selected person appears in the Personal
Information pane.

816 Finding a Person

 MAN006-0612

Wildcard Symbols
Several types of wildcard symbols are supported in Enrollment Manager. They are
shown in the table below:

Wildcard Description Example

character

% Any string of characters. If you are filtering for specific

The percentage sign (%) license plates, this value:
indicates that the value %XYZ%
entered in the Value field finds all people with license
is only part of the value plates that contain XYZ in
needed. them, such as 12XYZK,
XYZ123, 2XYZ78Y.

_ Any single character. If you are filtering for a first

(underscore) name, this value:
_ean
finds all four-letter names that
end with ean such as Dean,
Sean, and Jean.

[] Any single character within If you are looking for a last

(square brackets) the specified range ([a-f]) name, this value:
or set ([abcdef]). [C-P]arsen
Square brackets indicate a finds persons with last names
range or set of possible ending with arsen and
letters. beginning with any single
character between C and P,
for example Carsen, Larsen,
and Karsen.

[^] Any single character not If you are looking for a last
(caret) within the specified range name, this value:
([^a-f]) or set ([^abcdef]). de[^l]%
The caret indicates a value finds all persons with last
that excludes the specified names beginning with de
letters. where the next letter is not l.
Acceptable names might be
Degualle, Demille, or
Dequino.

Finding a Person 817

Velocity Version 3.1 Administrator’s Guide

Multiple People Selection

Velocity supports the selection of multiple people and enables the qualified operator to
perform a number of tasks on those selected. These features are particularly useful for
Velocity systems containing large numbers of employees, expediting the printing and
changing of credentials as well as the editing of personal information.
To select more than one person:
1. If needed, From the Person Group pane, click the Person Group you want to be
displayed in the Person Tree pane.
2. From the Person Tree pane, do one of these:
• hold down the Ctrl key and click each person in the list in you want to select.
• click the first person in the list you want to select then hold down the Shift key
and click the last person in the sequence you want to select. All person in
between the first and last selections are selected as well.
3. With the selected people highlighted, right click anywhere within the highlighted
space.
A screen like this example appears:

Three options appear in the drop-down list:

Edit Persons This option enables the qualified operator to edit field
values for more than one person at a time. The
multiple person edit screen appears.

Display This option enables the qualified operator to display

Credentials... credentials for more than one person at a time. You
can then apply credential tasks to multiple credentials,
if required.

Delete from This option enables the qualified operator to delete

system more than one person from the system.

Displaying Credentials for Multiple Persons

This feature enables the qualified operator to display two or more credentials for
multiple persons. Once displayed, these credentials can be manipulated using
credentials tasks.

818 Multiple People Selection

 MAN006-0612

To display multiple credentials:

1. Select multiple people from the People Tree pane.
2. Right click within the highlighted area.
3. Select Display Credentials...
The Credentials - Multiple People form appears like the example below:

This screen includes information on each credential associated with the selected
persons, include credential ID, Person ID, and other relevant credential values.
4. Select one or more credentials you want to view:
• Click to highlight a single credential
• Hold down the Ctrl key while you click each line you want to include in this
credential task
• Click the first line then hold down the Shift key and click the last line you
want to include. All lines in between are selected.
5. Right click in the highlighted area.
A list of options appears in the drop-down list like this example:

6. Select one of these tasks as required.

For more on this, refer to “Credential Tasks” on page 887.
7. When you're finished, click Close to return to the Enrollment Manager.

Multiple People Selection 819

Velocity Version 3.1 Administrator’s Guide

Modifying an Existing Person

To modify the credential or personal information for an existing person:
1. From the People Tree pane, click to select the person whose profile you want to
change.
The appropriate Personal Information form appears in the Personal Information
pane with all of the current values displayed.

Hint If you can't see the person, you can search for him/her using the Finding Person
feature. See “Finding a Person,” starting on page 809.

2. Change information to the existing fields as required.

3. If you need to change the person's current credential or create a new credential for
this person, use one of these procedures:

To change: Do this:

the current credential Double click the credential you want to change in the
Credentials pane.

add a new credential Click the Add New Credential from Template
using a credential option in the Credentials pane.
template The Select Credential Template dialog box appears.
Select the template you want to use and click OK.

an existing, Click the Assign Existing button on the form.

unassigned credential

The Credential properties dialog box appears (see page 864).

4. Fill out or change the dialog box property sheets as required. At a minimum you
must:
• if you specify a keypad (code) IDF, assign a valid PIN
• if you specify a card IDF, assign a valid MATCH code
• assign a valid door group or function group
5. When you're finished, click OK. You are returned to the Personal Information form.
6. Double click the photograph frame to import or capture a new photograph.
The Image Preview dialog box appears. For more on capturing or importing a
photograph, refer to “Image Preview” on page 840.
7. To capture or import a new signature, double click the signature frame, ,
located below the photo frame.
The Image Preview dialog box appears. For more on capturing or importing a
signature, refer to “Image Preview” on page 840.
8. If you are creating a new badge for this person, click the Preview Badge button to
view the way the final badge will look.
 In order for this feature to work, you must have assigned a Badge
Template on the Credential dialog box.
9. Click the Print Badge button to create a new badge for this person.
 In order for this feature to work, you must have a badge printer
connected to and configured for this Velocity workstation.

820 Modifying an Existing Person

 MAN006-0612

If you need to change the fields appearing on the form, refer to “User-Defined Setup”
on page 778.

Modifying Existing Credentials for a Person

To modify a currently-assigned credential:
1. From the Enrollment Manager screen, select the person whose credential you
want to modify.
2. From the Credentials pane, double click the currently assigned credential,
or right click the credential then select Properties... from the pop-up option list.
The current credential appears below the Add New Credential selections, preceded
by this symbol, .
The Credential dialog box looks like this example.

3. Modify the fields on the dialog box property sheets as required. At a minimum you
must:
• assign a valid PIN, if you specify a keypad (code) IDF
• assign a valid MATCH code, if you specify a card IDF
• assign a valid door group or function group
4. When you're finished, click OK.
You are returned to the Personal Information form.

Deleting Persons
You can delete one or more people from Enrollment Manager using one of these
methods.

Method 1
To delete one person from the system:
1. In the People Tree pane, right click on the person you want to delete from the
system.
An option appears.
2. Select Delete from system.
You are prompted with a message asking you to confirm you selection.
3. Click Yes.

Modifying an Existing Person 821

Velocity Version 3.1 Administrator’s Guide

The person and all their currently assigned credentials will be removed from the
system.

Method 2
To delete more than one person from the system:
1. In the People Tree pane, select multiple people.
2. Right click on the highlighted area.
An option appears.
3. Select Delete from system.
You are prompted with a message asking you to confirm you selection.
4. Click Yes.
All persons and their currently assigned credentials will be removed from the system.

822 Modifying an Existing Person

 MAN006-0612

Person Groups
Use Enrollment Manager to group people into logical units called person groups.
Person groups (partitioned groups) enables people to be placed in different
role-controlled views. These views determine which persons a specific operator can
see in Enrollment Manager based on the operator’s role.

Hint This feature is first and foremost a powerful partitioning tool that enables system
configurators to define roles that enable operators to view only specific person
groups.

For example, a mixed use building provides headquarters for two companies. Security
for Company A does not want to oversee employees for Company B nor does
Company B want to view employees for Company A. In order to keep these views
separate, the system configurator sets up one or more person groups for Company A
and one or more for Company B. When the configurator defines roles for the various
operators that will be overseeing security for the two companies, he/she checks only
those person groups relevant to that specific company. Thus, when an operator is hired
for Company B, he is assigned a role that excludes from view all person groups
previously defined for Company A while checking off each person group for Company
B. As a result, when this operator opens Enrollment Manager, he can see all required
person groups for his company but none of the person groups for Company A.
For more on this, refer to “Partitioning” on page 285.
To create a person group:
1. At the main Enrollment Manager screen, click the icon to reveal the Person
Group pane like this example:

This pane provides a tree of person groups by workstations.

All currently defined person groups appear below the workstation. By default, the
all-inclusive Person Group, Everyone, appears in the tree.
2. In the Person Group pane, right click on the workstation icon.
An option list appears.
3. Select Add Person Group.

Person Groups 823

Velocity Version 3.1 Administrator’s Guide

A dialog box like this appears:

4. In the text box, enter a new person group name and click OK.
The new person group appears in the Person Group pane.
Once you have created a person group, you can move existing people to this new
group or use one of these right click options:

Add Person Enroll a new person in this group. For more on this, refer to
“Adding People to Person Groups” on page 824.

Add Person from Enroll a new person in this group using a person template.
Template For more on this, refer to “Adding People to Person Groups”
on page 824.
This option can only work if the person template has this
person group checked on the groups tab.

Edit Persons Edit the record of an existing person in this group. For more
on this, refer to “Editing Multiple Persons” on page 801.
This edits all persons in the selected person group.

Add Subfolder Add a subfolder to this group. For more on this, refer to
“Person Group Subfolders” on page 769.

Rename Bring up a text box and enter a new name for the selected
group.

Delete Delete the selected group. Confirm by clicking Yes.

Search Group Search for members within this group. For more on this, refer
to “Finding a Person” on page 809.

Execute Saved Use a Search Filter (see page 815) to find members of this
Filter on Group... group. When you select this option, the Person Filters dialog
box appears (page 815). Select the person filter you need
then click Execute.

You can also add members to a group through the Groups tab of the Personal
Information Form.

Adding People to Person Groups

There are three methods for adding people to an existing person group:

Method 1
This method moves existing persons from another group to this group, by dragging and
dropping.

824 Person Groups

 MAN006-0612

To drag and drop people from one group to another:

1. In the Person Group pane, click on the group from which you want to take people.
The members of this group appear in the People Tree pane below. This is the
source group.
2. From the People Tree pane, click to select one or more persons to add to the
target person group.
3. With the left mouse key depressed, drag the selected people from the People Tree
pane to the specified Person Group pane and drop them (release the left mouse
key) into the target person group.
4. Do one of these:
• If you select a person from the default Everyone group, a message like this
appears:

Click Yes to move a copy of the selected person(s) into the new group. These
persons still appear in the Everyone group.
• If you select a person from a previously created person group, a prompt like
this appears:

Click Move to move the selected person(s) from the source person group to
the target person group. Click Copy to move a copy of the selected person(s)
from the source person group to the target person group.
The target group now includes the people you selected.

Method 2
This creates a new person for this group, using one of the right click options.
To enroll a person in a person group:
1. In the Person Group pane, right click on the group to which you want to add a
person.
A pop-up option list appears.
2. Select Add Person.
A new Personal Information Form appears in the personal information pane.
3. Supply values to these fields, as required, and click Apply.
The new person appears in the Person Tree pane.
4. Assign one or more credentials to this person, as required.
The new person is now enrolled in this person group.

Person Groups 825

Velocity Version 3.1 Administrator’s Guide

Method 3
This creates a new person from an existing person template for this group, using one of
the right click options.
To enroll a person in a person group from an existing person template:
1. In the Person Group pane, right click on the group to which you want to add a
person.
A pop-up option list appears.
2. Select Add Person from Template.
The Select Person Template appears.

A list of currently defined person templates appears in this window.

 The person group must be included in the person template you want to
add.
3. Click to highlight the person template that describes the new person.
4. Click OK.
A new Personal Information Form appears in the personal information pane with
the values relevant to the selected template already filled in.
5. Supply other values to these fields, as required, and click Apply.
The new person appears in the Person Tree pane.
6. Assign one or more credentials to this person, as required.
The new person is now enrolled in this person group.

Batch Enroll Card Credentials

This feature enables you to enroll a number of card credentials at the same time. ID
numbers are generated sequentially: for example, if you are doing fifteen cards starting
with ID number 6, the last card will be assigned ID number 21.
Before you batch enroll cards, you must create a credential template for IDF2 - Card.
To batch enroll card credentials:
1. Open Enrollment Manager.
The Enrollment Manager screen appears.
2. From the menu bar, select File > Batch Enroll Credentials.
The Batch Enroll Card Credentials dialog box appears. For more on this, refer to
“Batch Enroll Card Credential Screen” on page 828.
3. In field 1, 'Number of cards to enroll,' type the number of cards you need to enroll.

826 Person Groups

 MAN006-0612

4. In field 2, 'Credential Template,' select the credential template you require from the
drop-down option list.
Only those credential templates designated as using IDF 2 (Card) appear in this
list.
5. In field 3, 'Type of batch enroll to perform,' specify whether you want to
automatically enroll these cards or perform the enrollment manually.
• If you click the Auto Enroll radio button (the default), perform these tasks:
a. In the 'Select Card Format' combo box, select the format of the cards you are
using to enroll this batch. Standard 26-Bit Wiegand is the default.
b. At the 'Enter Starting Card Data Number', enter the Facility or Site Code
Number followed by a dash (-) or comma (,) followed by the card stamp
number on the first card to be enrolled. (Before starting the batch auto
enroll, make sure the cards are numbered sequentially.)
For example, 27-116225, where 27 is the Facility or Site Code Number, the
dash is the separator, and 116225 is the number on the first card to be
enrolled.
c. Skip to Step 7.
• If you click the Manual Enroll radio button:
a. Specify the card format for these cards.
b. Enter the stamp code or other identifying number/name for each card in
the batch.
c. Go to Step 6.
 You can only perform manual enroll of cards if you have an enrollment
station connected to this system.
6. Check the Station Status. If there is a diagonal red line across the front of the icon,
it means that Velocity does not currently detect an enrollment station attached to
the Velocity workstation.
Click this icon to bring up the Enrollment station dialog box and configure the
connection correctly.
7. Click the Start button. The batch process begins.
If you specified Auto Enroll, Enrollment Manager automatically generates the
requested number of credentials. The progress of the generation are displayed in
the window to the right of the Start button.
If you specified Manual Enroll, follow the instructions appearing in the Status
window to the right of the Start button. Coordinate your card swipes through the
enrollment station with Enrollment Manager's recording of each entry until the
requested number of credentials have been completed.
Once the enrollment process is completed, a message displays a confirmation like
this: Successfully added Credential with User ID # and records processed.
A message pops up confirming that the batch enrollment was complete.
8. Click OK.
9. When you're finished, click Close. You are returned to Enrollment Manager.
The newly-created credentials appear in the Credentials pane under Unassigned
Credentials.

Person Groups 827

Velocity Version 3.1 Administrator’s Guide

Batch Enroll Card Credential Screen

The Batch Enroll Card Credential screen looks like this example:

This screen includes the following fields and buttons:

Number of cards Enter the number of cards you need to enroll.

to enroll: Only those credentials you are designating as IDF2 - Card
on the credential general properties page should be enrolled
using this method.

Credential Select an existing credential template from the drop-down

Template list.
Only those credential templates designated as IDF2 - Card
on the credential general properties page appear in this list.

Type of batch enroll to perform:

Auto Enroll Click to select this radio button to activate the 'Select Card
Format' and 'Enter Starting Card Data Number' windows.

Select Card If you select 'Auto Enroll', from the drop-down list select the
Format format of the cards you are enrolling.

Enter Starting If you select 'Auto Enroll', enter the Facility or Site Code
Card Data Number followed by a dash (-) or comma (,) followed by the
Number card stamp number on the first card to be enrolled. Each
new card you enroll after this is incremented until the last
card is enrolled.

Manual Enroll Click to select this radio button to enroll cards manually.
As you slide each card through the enrollment station, its
card format and number are automatically detected.

Station Status: Double click this button to reveal the Enrollment Station
Diagnostics dialog box (see page 831).
Use this button to troubleshoot problems with the
enrollment station.

828 Person Groups

 MAN006-0612

Start Enrollment:

Start Click this button to start enrolling cards. After you click this
button, do one of two things:
• If you selected Auto Enroll, Velocity automatically creates
the required number of credentials, starting from the data
number you specified and using the card format
designated.
• If you selected Manual Enroll, feed each new card into
the enrollment station. Follow the instructions in the
window to the right. Do not feed a new card into the
enrollment station until notified by the instructions in this
window.

Status window This window displays the current status of the batch
enrollment process. If you select manual enroll, this window
displays instructions that walk you through the enrollment
process. Don't feed a new card into the enrollment station
until notified by a message in this window.

Close Click this button when you're finished. The screen is replaced
by the main Enrollment Manager screen.

Status tray This tray displays the current status of the enrollment
process: the number of records (cards) enrolled, the number
of errors detected, and the current status of the enrollment
station.

Enrollment Station
The Hirsch enrollment station is a device containing an RS-232 connector, a power
transformer, and, depending on the version, one of several readers. It is used to enroll
one or more cards by reading the card number and sending that information to an
attached computer from where the information can be stored, along with other
credential information, in the Velocity database.
Hirsch currently offers three types of enrollment stations suitable for use with Velocity:
 SMES-H which includes an HID prox reader
 SMES-M which includes a magstripe reader
 SMES-U which provides the connection and power but allows the customer to
insert their own reader, such as biometric, into the box.
An example of the SMES-M is shown below.

The essentials of connecting, configuring, and testing an enrollment station are

explained below.

Person Groups 829

Velocity Version 3.1 Administrator’s Guide

Connecting Enrollment Stations

To connect the enrollment station:
1. Connect a cable to the host PC.
The host PC can be either a client or server.
Two types of configurations are supported:
• Attach a USB-to-RS232 converter (provided by Belkin and other companies)
to an available USB port on the PC or an attached USB hub.
• Attached a serial cable to an available COM (RS-232) port on the host PC
2. Connect the serial cable enrollment to the RS-232 connector on the enrollment
station.
3. Connect the power transformer to the enrollment station, then plug it into an
available power socket.

Configuring Enrollment Stations

To configure the enrollment station:
1. At the host PC connected to the enrollment station, start Velocity.
The Velocity main menu appears.
2. Open Enrollment Manager.
3. At the Enrollment Manager menu bar, select Tools > Device Configuration.
The Device Configuration form appears with the Credential Enrollment page
displayed (see page 784).
4. At the 'Serial Port' combo box, select the port to which the enrollment station is
connected.
• If the attached host PC is the Velocity server, simply select the COM port the
enrollment station is connected to.
• If the attached host PC is a Velocity client, the COM address includes the client
designation like this, \\client2\\Com1.
• If the enrollment station is connected to the host PC via a USB-to-RS232
converter, the converter should assign the next available COM port number to
the PC. For example, if this host PC already has a COM1 and COM2 port, then
the converter would assign this connection COM3.
5. Click OK.
You are returned to the Enrollment Manager main screen.
6. From the menu tool bar, select File > Select Batch Enroll Credentials...
The Batch Enroll Card Credential dialog box appears.
7. Select the Manual Enroll radio button.
Look at the 'Station Status' field which indicates whether the enrollment station is
detected. One of these icons appears:

This green icon appears if the station is properly connected and

detected by Velocity.

This red icon appears if Velocity does not detect an enrollment

station even though the COM port is set in Preferences and the
selected IDF requires a MATCH. Use the test procedure below to
diagnose the problem.

830 Person Groups

 MAN006-0612

If the enrollment station has not been configured with the proper
COM port in Preferences or you have selected an IDF that does not
require a MATCH.

Testing Enrollment Stations

To test or detect the enrollment station:
1. Double click the red enrollment station icon.
The Enrollment Station Diagnostics dialog box appears. For more on this, refer to
“Enrollment Station Diagnostics Dialog Box” on page 831.
2. Click the Start Station button.
• If the station is connected, the Status field displays the Connected message.
• If the station is not connected, try changing the Comport setting.
• If the station is working correctly, you should see data in the MATCH code field
every time a card is enrolled.
Look in the Diagnostic Output field to see any messages concerning throughput.
3. Click in the upper right hand corner to return to the Batch Enroll Card
Credential screen.
The enrollment station icon changes to reflect that the station has been started, .
 The enrollment station only works if it has previously been defined
through the Preferences option in the main Velocity module.

Enrollment Station Diagnostics Dialog Box

Use this dialog box to determine whether an enrollment station is connected to this
Velocity system.

The following fields and buttons appear on this dialog box:

Comport Enter a number corresponding to the COM port to which the

enrollment station is connected. The enrollment station can be
connected to either a Velocity server or client. Also, through a
USB-to-serial port converter, you can create a new serial port
designation.

Person Groups 831

Velocity Version 3.1 Administrator’s Guide

Status A read-only field displaying the current status of the connection

between the port and enrollment station.
If the enrollment station is connected correctly to the port and the
port is working properly, then the message 'Waiting for Card Swipe'
appears in this field.
If the port and the enrollment station are not working properly,
then the message 'Port Closed' or ‘No Response, Trying to Logon...’
appears here.

MATCH A read-only field displaying the MATCH code of the last card
Code swiped through the enrollment station. If the station is working
properly, this code is displayed in this field.
This code does not persist in memory. Once the dialog box closes,
this code is deleted.

Diagnostic A read-only field displaying the exact disposition of the station. The
Output output is in hexadecimal and can be interpreted by Hirsch test
personnel as an indication of any problem that might exist.

Start Click this button to start the enrollment station.

Station If this is a diagnostic, click this button to ascertain whether the
enrollment station is correctly connected and configured to this
system.

Stop Click this button to stop the enrollment station. The enrollment
Station station will not record cards until the station is started again.

832 Person Groups

 MAN006-0612

Capturing a Signature
This feature only works if you have attached a signature tablet to your Velocity server.
For more information on installing and configuring your signature tablet, refer to the
Velocity Quick Installation Guide or your manufacturer's installation guide.
To capture a signature:
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. From the person tree pane, either select an existing person or enroll a new person.
The appropriate Personal Information form appears in the Personal Information
pane.
3. In the Personal Information pane, double click the signature box, .
This is the box displayed just below the photo capture box.
The Image Preview dialog box appears.
4. Click to select the Signature radio button.
5. Click Acquire.
The Signature Capture dialog box appears like the following example:

The fields and buttons appearing on this screen are:

Pen Width Select the option you require from this pick list. The available
options are:
Fine — the pen width is fine.
Medium — the pen width is slightly broader.
Broad — the pen width is broad.

Click this icon and the color dialog box appears. Select the
color for the signature.

Click this icon and the color dialog box appears. Select the
color you want for the signature background.

Clear Click this button to clear the signature and start over.

Signature The signature appears in this window as it is entered on the

Entry window attached signature pad.

If a signature is currently in the signature window, click Clear to remove it.

6. Use the attached signature tablet or pad to enter the correct signature.
As the enrollee enters their signature, it appears in the Signature Capture window.
7. If required, modify the pen width, pen color, or background color.

Capturing a Signature 833

Velocity Version 3.1 Administrator’s Guide

By using these additional effects, you can make the signature look like the
following example:

8. Click Close.
The Image Preview dialog box reappears with the new signature displayed like this
example:

For more on this, refer to “Image Preview Dialog Box” on page 841.
9. If required, click the button to increase the size of the signature appearing in
the Preview window. Click the button to decrease the size of the signature in
the window.
10. Click Save.
The main Enrollment Manager screen appears with the new signature displayed below
the picture frame on the Personal Information Form.

834 Capturing a Signature

 MAN006-0612

Capturing a Photo
You can capture photos for either the General tab or the Additional Images tab. Both
procedures are detailed below.
To capture a photograph:
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. Enroll a new person or select an existing person.
The appropriate Personal Information form appears.
3. In the Personal Information pane, double click the photo box.
The Image Preview dialog box appears (see page 841).
4. Select the source for this photo.
You have a choice of three image options:

Option Meaning Refer to:

Video Acquire the image from an “Video Capture” on page

attached camera system. 836

Twain Acquire the image from an “TWAIN Capture” on page

attached TWAIN device. 838

File Acquire the photo from a file “File Capture” on page 840
(JPEG, BMP, etc.)

5. Click Acquire.
Occasionally, you might have to click Acquire twice before it takes effect.
The rest of the procedure depends on which source you choose. For more on this,
refer to the topics starting on page 836.
 While you can install both video capture (for badge photography) and
CCTV on the same Velocity server (even use the same FlashBus video
capture card to connect both feeds), you cannot run both
simultaneously. Run one process or the other.
For example, if you are monitoring your site over CCTV using the Velocity
CCTV Viewer, do not try to capture photos using the FlashBus video card
connection. Conversely, if you are capturing photos, do not try to monitor
CCTV at the same time using the CCTV Viewer.
You can e-mail or save these images to another source as required using the
instructions in “E-mailing a Photo” on page 844 or “Saving a Photo to Another Source”
on page 845.
To capture a photograph for the Additional Images tab:
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. Enroll a new person or select an existing person.
The appropriate Personal Information form appears.
3. From the Personal Information form, click the Additional Images tab.
The Additional Images page appears.

Capturing a Photo 835

Velocity Version 3.1 Administrator’s Guide

4. From the ‘Image Placeholders’ window, click to highlight the placeholder you
require.
To define additional image placeholders, refer to “User-Defined Setup” on page
778.
5. In the Current Image section, click the Update Image... button.
The Image Preview screen appears.
6. Select the source for this photo. You have a choice of three sources:
• Video
• TWAIN
• File
7. Click Acquire.
Occasionally, you might have to click Acquire twice before it takes effect.
The rest of the procedure depends on which source you choose. For more on this,
refer to the following subsections.

Video Capture
If you selected Video as the source, follow this procedure:
1. Click Acquire.
The Video dialog box appears. For more this, refer to “Video Dialog Box” on page
837.
2. Make changes as required to the settings.
3. When you've positioned the person as required, click Freeze.
4. Click Close.
The Image Preview dialog box reappears. See page 841.
5. With the image displayed in the Preview window, move the cropping box with your
mouse and/or cursor keys. This enables you to frame the image exactly.

6. If needed, use the and buttons to increase or decrease the size of the
captured picture.
7. Click Save.
The photo you cropped appears in the photo frame.

836 Capturing a Photo

 MAN006-0612

Video Dialog Box

An example of the Video dialog box is shown below:

This screen contains these settings:

Signal This determines the signal standard for this video capture device.
The default is NTSC.
This setting is previously configured during setup.

Input Type This determines the type of port used to connect the video capture
device to the Velocity workstation.
This setting is previously configured during setup.

Reset Click this button to return the Signal, Input Type, and to their original
values.

Brightness Move the slidebars to brighten or darken the image.

The best way to determine how these controls affect an image is to
test them yourself.

Contrast Move the slidebars to increase or decrease the contrast between

the objects captured.
The best way to determine how these controls affect an image is to
test them yourself.

Hue Move the slidebars to brighten or darken the image.

The best way to determine how these controls affect an image is to
test them yourself.

Saturation Move the slidebars to increase or decrease the density of the

individual colors.
The best way to determine how these controls affect an image is to
test them yourself.

Sharpness Move the slidebars to change the color hues.

The best way to determine how these controls affect an image is to
test them yourself.

Freeze Click this button to freeze the image.

Close Click this button to return to the Image Preview dialog box.

Capturing a Photo 837

Velocity Version 3.1 Administrator’s Guide

TWAIN Capture
If you selected TWAIN as your source, follow this procedure:
1. Click Acquire.
The Select Source dialog box appears like this selection.

2. Click and highlight the source you want then click Select.
The TWAIN setup screen appears. For more on this, refer to “TWAIN Setup Dialog
Box” on page 838.
3. Make changes as required.
4. Click Capture.
The Image Preview dialog box reappears. See page 841.
5. With the image displayed in the Preview window, move the cropping box with your
mouse and/or cursor keys. This enables you to frame the image exactly.

6. If needed, use the zoom in/zoom out buttons to increase or decrease the size of
the captured picture.
7. Click Save.
The photo you cropped appears in the photo frame.

TWAIN Setup Dialog Box

An example of the TWAIN Setup dialog box is shown below:

838 Capturing a Photo

 MAN006-0612

The FlashBus TWAIN32 Setup dialog box includes these features:

Keep Aspect Check this box to maintain the aspect ratio for this picture. The
width and height are maintained in the same ratio as the original
photograph.

Scale Check this box to change the aspect ratio. Use the Width and
Height slidebars to change the height and width of the
photograph as required.

Remote Grab Check this box to activate the remote grab feature. This feature is
currently not implemented.

Monochrome Check this box to convert color images into black and white
images.

Grab Specifies the type of grab allowed by the capture program. Your
choices are:
Align Even - align even grabbed objects
Align Odd - align odd grabbed objects
Align Any - align all grabbed objects

Adjustments Move the slidebars to adjust the captured image:

Brightness - brighten or darken the image
Contrast - increase or decrease the contrast between the
objects captured
Saturation - increase or decrease the density of the individual
colors
Hue - change the color hues
The best way to determine how these controls affect an image is
to test them yourself.

Defaults Click this button to return all adjustment values to their original
value.

Video Center the image by their X and Y coordinates. For example,

increasing the X center moves the image to the right.

Full Size Click this button to make the image fill the window.

Flash This determines what type of flash this TWAIN device has. The
default is None. Other options include:
• Universal
• Strobe
• AutoSync
Check with your TWAIN device to ascertain whether it has a flash
attachment and, if so, what type it is.

Field Delay If the flash attachment requires the device to delay before
capturing the image, use the slider to specify that delay in
seconds.

Capturing a Photo 839

Velocity Version 3.1 Administrator’s Guide

Input Type This determines what type of input is used to connect this TWAIN
device to the Velocity workstation. Options are:
• RGE
• Composite
• SVideo
• RS170
• Green Sync
Check with your TWAIN device manual to make sure of the
connection type.

Standard This determines the standard used by this TWAIN device to

capture the photograph. There are two options:
• NTSC
• PAL
Check with your TWAIN device manual for the correct setting.

Capture Click this button to capture the image and return to the Image
Preview dialog box.

File Capture
If you selected File as your source, follow this procedure:
1. Click Acquire.
The Open a File dialog box appears.
2. Browse for the video file you need.
3. Select the file you need and click Open.
The Image Preview dialog box reappears. See page 841.
4. With the image displayed in the Preview window, move the cropping box with your
mouse and/or cursor keys. This enables you to frame the image exactly.

5. If needed, use the zoom in/zoom out buttons to increase or decrease the size of
the captured picture.
6. Click Save.
The photo you cropped appears in the photo frame.

Image Preview
The Image Preview dialog box enables you to:
 capture a video image using photo capture software, or
 find an existing image

840 Capturing a Photo

 MAN006-0612

To capture an photograph using photo capture software:

1. At the Image Preview dialog box, select the image source you require.
2. Click Acquire.
• If you specified Video or TWAIN, an image appears in the Preview window to
the right.
• If you specified File, the Open A File dialog box appears. Select the image you
want to import to the badge.
3. With the image displayed in the Preview window, move the cropping box with your
mouse and/or cursor keys. This enables you to frame the image exactly.

4. Click Save.
The image is imported to the photograph window in the Personal Information
pane like this example:

Image Preview Dialog Box

The Image Preview dialog box looks like this example:

Capturing a Photo 841

Velocity Version 3.1 Administrator’s Guide

The Image Preview dialog box includes these buttons and fields:

Image Source

Video Click this radio button to indicate that Velocity is connected to a

video system.
When you click Acquire, the FlashBus photo capture dialog box
appears. Take the picture.

TWAIN Click this radio button to indicate that Velocity is connected to a

photo capture system or scanner using the TWAIN protocol.
When you click Acquire, the TWAIN Setup dialog box appears like this
example.
Select the TWAIN device from which this picture will be taken.
Velocity takes the image associated with this system and imports it.

File Click this radio button to indicate the image is available either on
your hard disk or on a diskette. When you click Acquire, Velocity
prompts you with the Open a File dialog box. Find the specified file
and import it.
The image can be in one of 21 accepted image formats including
JPG, GIF, TIF, PCX, TGA, and WMF.

Signature Click this radio button to capture a signature.

When you click Acquire, the Signature Capture screen appears.

Acquire... Click this button to either take a picture using the photo capture
equipment or, if file is selected, search for an existing image using
the Open a File dialog box.
If you selected the Signature radio button, clicking this button takes
you to the Signature Capture screen.

Save Click this button to save the image and send it to the badge.

Help Click this button to see this screen.

Close Click this button to ignore the image and return to the previous
screen.

Preview This window displays the results of the image or signature

acquisition. You can manipulate the size of the image by using the
magnifying glass buttons to the right of this window. You can crop
and frame the image using the cropping box.

Click this button to increase (zoom in) the image size. Each time you
click this button it increases the image size by 20%. The percentage
of magnification (relative to the original 100%) of the image is
displayed above this button.

Click this button to decrease (zoom out) the image size. Each time
you click this button it decreases the image size by 20%. The
percentage of magnification (relative to the original 100%) of the
image is displayed above this button.

842 Capturing a Photo

 MAN006-0612

Additional Images
This page displays images added to the Personal Information form. This enables
qualified operators to enroll persons and include more than one image identifying
them. This image can show side views or additional front views of the employee as
well as other identifying images.
Before you can access images, you must first define the person placeholders in the
User-Defined Fields option.
Once you have created the required placeholders, do the following:
1. At the Personal Information pane, click on the Additional Images tab.
The Additional Images page appears like this example:

2. From the 'Image Placeholders' window, click to select the first image you want.
3. Click the Update Image... button.
The Image Preview dialog box appears. See page 841.
4. Capture the image as you would the photo on the General page.
The image appears in the 'Current Image' frame like this example:

5. If needed, click in the 'Description' field and enter a title or description of the image
you just captured.
To remove the currently displayed image, simply click the Remove Image button. The
image disappears.

Capturing a Photo 843

Velocity Version 3.1 Administrator’s Guide

E-mailing a Photo
Security occasionally requires a suspicious employee to be tracked by members of the
security staff or some outside agency. To expedite this, Enrollment Manager includes
the ability to e-mail an image of the employee database to one or more individuals or
organizations.
To e-mail a photo:
1. From Enrollment Manager, bring up the employee in question.
The designated person's personal information form appears with a picture of the
person in question.
2. Right click on the image you want to send.
A pop-up option list appears like this example:

3. Select Email Picture...

A dialog box like this appears:
4. Select the size you want to send.

Make all pictures Click this radio button to make the image smaller.
smaller

Keep the original Click this radio button to retain the original size.
sizes

Show more Click this link and select one of the predetermined
options... sizes from the available additional options.

When you're finished, you can click the Show

fewer options... link to toggle to the smaller
dialog box.

5. Once you've chosen the size of the image you want to send, click OK.

844 Capturing a Photo

 MAN006-0612

An email form appears like this example:

6. Fill out the form as required.

7. When you're finished, click Send.

Saving a Photo to Another Source

You can save photos captured within the Velocity security system and copy them to
another source using this feature.
To save a photo to another source:
1. From Enrollment Manager, bring up the employee in question.
The designated person's personal information form appears with a picture of the
person in question.
2. Right click on the image you want to save.
A pop-up option list appears like this example:

3. Select Save Picture As...

The Save As... dialog box appears.
4. Use the fields to navigate to the required destination drive and directory.
If required, rename the image.
5. Click Save.
The image is saved to the specified directory with the given name.

Capturing a Photo 845

Velocity Version 3.1 Administrator’s Guide

Scanning Enrollment Data

Use the Scan button to populate the Personal Information Form with relevant
information from either a scanner or a PIV reader.
 Before you can use this function, you must have a scanner or PIV reader
configured for use with this Velocity computer.
You can use this procedure to:
 Insert information from some other source, such as a business card or license, into
pre-mapped UDF fields on the Personal Information Form.
 Add pictures to the Additional images tab of the Personal Information Form.
 Add a signature to the Personal Information Form.
 Import data from a smart PIV card via PIV reader or RUU-201 Verification Station to
appropriate fields on the Personal Information Form.
To import data from a scanner:
1. Open Enrollment Manager.
2. Enroll a new person or click a name in the People Tree Pane to display information
on an existing person.
The Personal Information Form for that person appears.
3. Click the Scan button.
The Verify Scanner Data screen appears.

For more on this screen, refer to “Verify Scanner Data” on page 848.
With the 'Auto launch on paper detect' feature enabled, the ScanShell 800 can
start scanning automatically when paper is detected in the paper tray. (This does
not apply to the ScanShell 1000 that cannot auto-detect paper.) Once scanned,
the Verify Scanner Data screen will appear with the results displayed. Go to Step 6.
With all other devices, you must click the Scan button before scanning begins.
4. From the Document Type: pick list, select the type of card you want to scan.
There are several possible options:
• Business Card
• License/ID (OCR)
• License/ID (Bar Code)
• Passport
5. If you select the License/ID (OCR) option, the License Settings section appears.
Select the Region, Country, and State specific to the license or ID you are scanning.
6. Click Scan Document to begin the scanning/reading process.

846 Capturing a Photo

 MAN006-0612

7. Review the gathered data to make sure it is properly sorted.

If you have enabled 'Auto accept scanned data' for either the ScanShell 800 or
1000, Step 6 is bypassed. Results are automatically accepted.
8. When you're satisfied with the results, click Accept.
The information populates the Personal Information Form.
To import data from a PIV reader:
1. Open Enrollment Manager.
2. Enroll a new person or click a name in the People Tree Pane to display information
on an existing person.
The Personal Information Form for that person appears.
3. Click the Scan button.
The Verify Scanner Data screen appears.

For more on this screen, refer to “Verify Scanner Data” on page 848.
4. Click the PIV Reader tab if it is not already selected.
5. From the Type: pick list, select the PIV card type you want to read. There are
several possible options:
• DESFire FIPS201
• FIPS201 Contactless
• FIPS201 Contact
• DoD (legacy) CAC
6. Click Read PIV Card to begin the scanning/reading process.
7. Review the gathered data in the Output Window.
8. When you're satisfied with the results, click Accept.
The information populates the Personal Information Form. Data is mapped from the
relevant PIV fields to the selected UDF fields.
To import data from an RUU-201 PIV Verification Station:
1. Open Enrollment Manager.
2. Enroll a new person or click a name in the People Tree Pane to display information
on an existing person.
The Personal Information Form for that person appears.
3. Click Scan.
The Verify Scanner Data screen appears.
4. Click the RUU tab, if it is not already selected.

Capturing a Photo 847

Velocity Version 3.1 Administrator’s Guide

Make sure the status field is green and displays 'Online'. There is only one option
at present for this device: FIPS201 Contact.
5. Insert the PIV card whose information you want to scan into the RUU-201.
6. Click Connect to begin the scanning/reading process.
The RUU-201 reads the relevant information on the inserted card and dumps that
information into the Output window.
7. Review the gathered data in the Output window.
8. When you're satisfied with the results, click Accept.
The information populates the Personal Information Form. Data is mapped from the
relevant PIV fields to the selected UDF fields.

Verify Scanner Data

The Verify Scanner Data screen appears when you click the Scan button below the
Enrollment Manager Personal Information Form. The scanning process is explained in
Scanning.
The appearance of the Verify Scanner screen depends on the document or PIV reader
type option you specify. These options include:
 Business Card (page 848)
 License (OCR) (page 849)
 License (Bar Code) (page 850)
 Passport (page 851)
 PIV Reader (page 852)
 RUU Reader (page 853)
Each page provides a button that initiates the scan and displays the data scanned or
read using the specified device.

Scanning Business Cards

If you select the Business Card option, the Verify Scanner Data screen looks like this
example:

848 Capturing a Photo

 MAN006-0612

The fields and buttons on this page are described briefly below:

Scan Click this button to start scanning data on the business card currently
Document in the tray.
As data on this card is scanned, the scanner converts it to a
text-editable format. All text recognized by the scanner software is
separated and placed in the appropriate rows of the Value column.

Tray Status: This read-only field indicates whether the card is in the scanner tray
or not.

Field The Field Caption column displays all fields defined by the scanner
Caption & software.
Value table The Value column contains the results of the scanning. If successful,
the scanner will have recognized the individual elements on the
business card and assigned them to the correct row opposite the
proper field caption.
Check the values in this table to make sure they are correct.

Accept Click this button to transfer the data entered in the Value column to
Enrollment Manager. If the field caption values and Enrollment
Manager UDF values are cross-matched using the Map UDF Field
feature, the Personal Information Form is automatically populated
with that data.

Scanning OCR Licenses

If you select the License/ID (OCR) option, the Verify Scanner Data screen looks like
this example:

The fields and buttons on this page are described briefly below:

Scan Click this button to start scanning data on the business card currently
Document in the tray.
As data on this card is scanned, the scanner converts it to a
text-editable format. All text recognized by the scanner software is
separated and placed in the appropriate rows of the Value column.

Tray Status: This read-only field indicates whether the card is in the scanner tray
or not.

Capturing a Photo 849

Velocity Version 3.1 Administrator’s Guide

Field The Field Caption column displays all fields defined by the scanner
Caption & software.
Value table The Value column contains the results of the scanning. If successful,
the scanner will have recognized the individual elements on the
business card and assigned them to the correct row opposite the
proper field caption.
Check the values in this table to make sure they are correct.

Accept Click this button to transfer the data entered in the Value column to
Enrollment Manager. If the field caption values and Enrollment
Manager UDF values are cross-matched using the Map UDF Field
feature, the Personal Information Form is automatically populated
with that data.

Scanning Bar Code Licenses

The License (Bar Code) page of the Verify Scanner Data screen looks like this example:

The fields and buttons on this page are described briefly below:

Scan Click this button to start scanning the bar code on the license
Document currently in the tray.
As data on this card is scanned, the scanner converts it to a
text-editable format. All text recognized by the scanner software is
separated and placed in the appropriate rows of the Value column.

Tray status: This read-only field indicates whether the license is in the scanner
tray or not.

850 Capturing a Photo

 MAN006-0612

Field The Field Caption column displays all fields defined by the scanner
Caption & software.
Value table The Value column contains the results of the scanning. If successful,
the scanner will have recognized the individual elements on the
license's bar code and assigned the results to the correct row
opposite the proper field caption.
Check the values in this table to make sure they are correct.

Accept Click this button to transfer the data entered in the Value column to
Enrollment Manager. If the field caption values and Enrollment
Manager UDF values are cross-matched using the Map UDF Field
feature, the Personal Information Form is automatically populated
with that data.

Scanning Passports
The Passport page of the Verify Scanner Data screen looks like this example:

The fields and buttons on this page are described briefly below:

Scan Click this button to start scanning data on the passport currently in
Document the tray.
As data on this passport is scanned, the scanner converts it to a
text-editable format. All text recognized by the scanner software is
separated and placed in the appropriate rows of the Value column.

Tray status: This read-only field indicates whether the passport is in the scanner
tray or not.

Field The Field Caption column displays all fields defined by the scanner
Caption & software.
Value table The Value column contains the results of the scanning. If successful,
the scanner will have recognized the individual elements on the
passport and assigned them to the correct row opposite the proper
field caption.
Check the values in this table to make sure they are correct.

Capturing a Photo 851

Velocity Version 3.1 Administrator’s Guide

Accept Click this button to transfer the data entered in the Value column to
Enrollment Manager. If the field caption values and Enrollment
Manager UDF values are cross-matched using the Map UDF Field
feature, the Personal Information Form is automatically populated
with that data.

Reading PIV Cards

The PIV Reader page of the Verify Scanner Data screen looks like this example:

The fields and buttons on this page are described briefly below:

Read PIV Click this button to start reading the PIV card currently placed in the
Card PIV reader. As the data encoded on this card is read, it appears in the
Output Window. All data that is identified by the PIV reader software
is placed in the Value column matched to its proper field.

Type: Select the PIV reader type you are reading. Select from these
options:
• DESFire FIPS201
• FIPS201 Contactless
• FIPS201 Contact
• DoD (legacy) CAC

Field The Field Caption column displays all fields defined by the reader
Caption & type and software.
Value table The Value column contains the results of the reading process. If
successful, the reader will have recognized the individual elements
on the PIV card and assigned them to the correct row opposite the
proper field caption.
Check the values in this table to make sure they are correct.

Clear If one or more of the values placed in the Value column are
incorrect, click this button to clear the values from the column and
the output window. Then read the PIV card again.

Output The raw data read from the PIV card appears in this window. If
Window: needed, you can cut and paste data from this window to the Value
column above.

852 Capturing a Photo

 MAN006-0612

Accept Click this button to transfer the data entered in the Value column to
Enrollment Manager. If the field caption values and Enrollment
Manager UDF values are cross-matched using the Map UDF Field
feature, the Personal Information Form is automatically populated
with that data.

Read RUU Verification Station

An RUU-201 PIV verification station decodes data off a smart card, uses some of that
data to verify that the cardholder is correct, and presents it to the Velocity database.
Only those cards that the RUU-201 has verified can dispense data. If the reader detects
that the cardholder is unauthorized, no information is passed and an alarm is issued.

Hint The great advantage of a smart card is how much more data it can hold. Smart
cards can contain such biometric data as voice recognition, iris patterns, fingerprint
parameters, and facial coordinates, in addition to PIN code and data number
information. Because of this, the smart card reader can exercise far more stringent
tests before granting entry, making it that much more difficult for the wrong people
to get in.

To use the RUU-201 as an enrollment station, first configure an RUU-201 PIV reader.
When you click the Scan button, the Verify Scanner Data appears like this example:

When you click Connect, the RUU is connected to the Enrollment Manager database
and the values supported by the default FIPS 201 Contact reader appear.
The fields and buttons on this page are described briefly below:

Connect Click this button to start reading the PIV card currently placed in the
RUU-201 verification station.
As the data encoded on this card is read, it appears in the 'Output
Window'. All data that is identified by the RUU-201 software is
placed in the 'Value' column matched to its proper field.

Type: Currently, there is only one available option for this reader: FIPS201
Contact.

Capturing a Photo 853

Velocity Version 3.1 Administrator’s Guide

Reader This field displays the current connection status of the RUU-201. If
Status the verification station is properly connected and configured, the field
is green and the word 'Online' appears. If Velocity cannot detect the
RUU-201, the field is read and the word 'Offline' appears instead.

Field The Field Caption column displays all fields defined by the reader
Caption & type and software.
Value table The Value column contains the results of the reading process. If
successful, the reader will have recognized the individual elements
on the PIV card and assigned them to the correct row opposite the
proper field caption.
Check the values in this table to make sure they are correct.

Clear If one or more of the values placed in the Value column are
incorrect, click this button to clear the values from the column and
the output window. Then read the PIV card again.

Output The raw data read from the PIV card appears in this window. If
Window: needed, you can cut and paste data from this window to the Value
column above.

Accept Click this button to transfer the data entered in the Value column to
Enrollment Manager. If the field caption values and Enrollment
Manager UDF values are cross-matched using the Map UDF Field
feature, the Personal Information Form is automatically populated
with that data.

For more on configuring PIV readers for Velocity refer to “Configuring PIV Readers in
Velocity” on page 854.

Configuring PIV Readers in Velocity

Velocity supports many types of PIV readers. In general, this is the procedure to use for
installing and configuring PIV readers on a Velocity system:
1. Install and connect the reader and card printer.
Currently, the following reader protocols are supported:
• DESFire FIPS 201
• FIPS 201 Contactless
• FIPS 201 Contact
These protocols are represented by these products:
• Card Scanning Solutions
• GemPlus
• Integrated Engineering
• Topaz Systems
2. In Velocity, go to the Preferences General page.
3. Check the 'Access and Enable Customized Values for Components in
Customization Manager' box.
4. Go to the User Defined Setup page.

854 Capturing a Photo

 MAN006-0612

5. Select the 'Caption' field and enter a new name for the reader fields you need to
read from the PIV readers as shown in this example:

In general:
• Order will make mapping easier.
• Concatenated fields for MATCH must be numeric fields.
• Place the new field under a specific TAB will secure the field by Role.
6. Go to Device Configuration and click the 'Enable PIV readers' box on the PIV
Reader page as shown in the following example:

7. Click the Map UDF Fields button.

A screen like the following example appears:

Capturing a Photo 855

Velocity Version 3.1 Administrator’s Guide

When the name fields are identical, the system auto-maps. If this does not occur
automatically, click the Auto Map button.
A screen like this appears:

8. Go to the Enrollment Manager main screen and enroll a new person.

This usually entails only adding a first and last name, a photo, and any relevant
information like this example:

9. Click the Scan button.

The Verify Scanner Data appears like the following example:

856 Capturing a Photo

 MAN006-0612

10. Check the 'Read Printed Information' box as shown in the previous figure.
This will necessitate a PIN number to access the information. Make sure you have
the proper PIN number to complete this operation.
11. Click the PIV Card button.
The Card PIN dialog box appears like the following example:

12. Enter the PIN for this PIV card then click OK.
The output for this card appears in the Output Window like the example below:

13. Click Accept.

This message appears:

14. Click Yes.

Capturing a Photo 857

Velocity Version 3.1 Administrator’s Guide

The data on the card is used to populate the person's personal information form as
shown in the following example:

Notice that the fields defined in Steps 5 - 7 are now populated with data.
15. Add a credential to the user profile.
In general, you should provide this information:
a. Supply a description in the Description field to identify which template is being
used.
b. From the 'Badge Template' combo box, select a previously designed PIV card
Badge Template.
c. At the IDF field, select the option you require for this reader.
The option you select here is determined by the type of readers at doors
overseen by the PIV reader.
d. At the Card Type field, select the type of card that will be used for this reader.
This allows the PIV reader to pass data to Velocity.
e. Click the UDF button to concatenate any numeric UDFs in the order desired
then, at the Concatenate UDF dialog box, click OK.
The 'Data' and 'MATCH' fields are automatically populated.
f. Set the activation and expiration date in the 'Activation/Expiration' section.
g. Click the Auto button next to the 'PIN' field to automatically create a PIN.
h. On the Function property sheet, define the function for this credential.
i. On the Limits property sheet, select limits.
j. On the Options property sheet, select print controls.
k. If needed, make any other changes to this credential.
16. When you're finished, click OK to confirm this credential.
17. Preview and print the badge.

858 Capturing a Photo

 MAN006-0612

Previewing a Badge
While you can immediately print a badge from Enrollment Manager, it's often a good
idea to preview it before you do.
To preview a badge:

Method 1
1. Enroll the new person.
2. Assign a person to a new or unassigned credential.
3. Complete the credential and close it.
4. Do one of these:
• In the credential pane, right click the credential whose badge template you
want to print and select Badge > Preview... from the pop-up list, or
• Select and highlight the credential you want to use then click the Preview
Badge button below the Personal Information form.
The Print Preview screen appears with the final badge layout incorporating all the
field information as well as the photograph and signature (if supplied). If you have
defined a double-sided badge for this credential, both dialog boxes appear (one
on top of the other). For more on the Print Preview screen, refer to “Print Preview
Screen” on page 859.
5. Click the Print button.
If the Velocity workstation is connected to a Badge Printer and is correctly configured,
the badge is printed.

Method 2
This option enables you to preview a badge without closing the credential dialog box.
1. Enroll the new person.
2. Assign a person to a new or unassigned credential.
3. Complete the credential.
4. On the general page of the credential dialog box, click the Print Badge button,
.
The Print Preview screen appears with the final badge layout incorporating all the
field information as well as the photograph and signature (if supplied). If you have
defined a double-sided badge for this credential, both dialog boxes appear (one
on top of the other).
5. Click the Print button.
If the Velocity workstation is connected to a Badge Printer and is correctly configured,
the badge is printed.

Print Preview Screen

To access the Print Preview screen, do one of these procedures:
 Right click the appropriate credential, select Badge > Preview... from the pop-up
option list.
 Select and highlight the appropriate credential then click the Preview Badge
button in the Personal Information pane.

Previewing a Badge 859

Velocity Version 3.1 Administrator’s Guide

A screen like the following example appears:

Use the Print Preview screen to:

 inspect the badge before printing
 print the badge
This screen includes these buttons:

If you are printing multiple badges, click this button to bring up the
first badge in the group.

If you are printing multiple badges, click this button to preview the
previous badge in the group.

If you are printing multiple badges, click this button to preview the
next badge in the group.

If you are printing multiple badges, click this button to bring up the
last badge in the group.

Click this button to print the displayed badge.

Click to toggle between the front and back of the badge for this
badge template.
For more on double-sided badge printing, refer to “Double-Sided
Badge Printing” on page 862.

Close Click this button to close the Print Preview screen and return to the
User Configuration dialog box.

860 Previewing a Badge

 MAN006-0612

Printing a Badge
To print a badge:

Method 1
1. Enroll the new person.
2. Assign a person to a new or unassigned credential.
3. Complete and assign the credential you need.
4. Do one of these:
• In the credential pane, right click the assigned credential and select Badge >
Print... from the pop-up list, or
• Select and highlight the credential you want to use then click the Print Badge
button, , below the Personal Information form.
If the Velocity workstation is connected to a Badge Printer and is correctly
configured, the badge is printed.
The Badge Print Status dialog box (page 861) appears indicating whether the
badge printed successfully or not. It also indicates how many other badges were
printed using this credential.
5. Click Close to continue.
6.

Method 2
This option enables you to print a badge without closing the credential dialog box.
1. Enroll the new person.
2. Assign a person to a new or unassigned credential.
3. Complete the credential.
4. On the general page of the credential dialog box, click the Print Badge button,
.
You can also print directly from the Print Preview screen.
The Badge Print Status dialog box (page 861) appears indicating whether the
badge printed successfully or not.
5. Click Close to continue.

Badge Print Status

The Badge Print Status displays the current status of a badge print.

This dialog box shows the credential ID that was printed, the type of badge template
that was using, and to whom the badge was assigned.

Printing a Badge 861

Velocity Version 3.1 Administrator’s Guide

If you have selected multiple credentials to print, a dialog box like this example appears,
indicating that multiple badges were printed:

Double-Sided Badge Printing

Before you can print double-sided badges from Enrollment Manager, perform these
two tasks:
 Make sure your printer is capable of duplex printing. Many badge printers do allow
double-sided printing; however, check your printer documentation to make sure.
 Make sure the badge template selected for this person’s credential is defined as
double-sided. The ‘Size page for Double-sided printing’ box must be checked on
the Page Size tab of the Page Setup dialog box in the Badge Designer before this
will work. For more on this, refer to “Page Size Page,” starting on page 442.
To print both sides to the same orientation:
1. Click the Print button on the Print Preview screen or select Print Badge from the
main Enrollment Manager screen as specified above.
The standard Windows Print dialog box appears.
2. Next to the badge printer name designation, click the Properties button.
The Printer Properties dialog box appears.
3. Set the printer properties to invert the back 180 degrees for portrait badges.
For more on configuring a Velocity system for a badge printer, see the Printers
Preferences page.

862 Printing a Badge

 MAN006-0612

Credentials
A credential is a compilation of vital security information that can be applied to a
particular card or code holder. The completed credential is a security profile unique to
that person. A credential serves the purpose of a card, a code, or a code and card.
You can assign more than one credential to an individual.
Credential information can include these values:
 Description
 Badge template
 IDF
 Card information (type, stamp number, data number, MATCH code)
 Activation and expiration dates
 Code length
 PIN
 Duress digit
 Door group
 Function category and function type
 Function group
 Day/Use/Absentee Limits
 2-Person rule specifications
 Threat authority
 Tag, Alert, and Disable
 Passback override
 Global credential management
 Auto-delete credentials
 Special Needs
 Maximum print and issue counts
 Fingerprint information
Of course, not all credentials possess all this information. Some credentials only define
card holders while other credentials apply to code holders.
 A credential is unique. It can only be used by one person at a time.
Once assigned, a credential cannot be shared with another person. Think of it as a
physical card: when a person has that card, it cannot be shared by persons; each
person has his/her own.
When a person leaves a company, the credential is returned to security and is
unassigned. Once unassigned, the credential can be reassigned to another person.
 This does not mean that an unassigned credential is disabled.
Particularly in the case of PIN code-only credentials, an unassigned
credential can still be used unless it is disabled.
In order to simplify and speed up the task of creating and assigning a credential,
Velocity includes the Credential Template feature. A credential template includes most
of the values listed above, but without such unique qualifiers as a PIN, duress digit, or
MATCH code that are added on a per-person basis. This enables you to assign a
credential template to a person’s credential then customize that credential.

Credentials 863
Velocity Version 3.1 Administrator’s Guide

How to Define Credentials

It's always a good idea to create as many credential templates as you think you'll need
before enrolling persons. Before creating credential templates, you should first create
badge templates, function groups, and doors groups.
To define a credential for a person:
1. At the main menu, open Enrollment Manager.
2. From the Enrollment Manager screen, select the person to whom you want to
assign the new credential or add a new person.
3. From the Personal Information form, click the Add New Credential button or
double click the Add New Credential folder in the Credentials pane as shown in
the following example:

The Credential dialog box appears. For more on this, refer to “Credential Properties
Dialog Box” on page 864.
4. Fill out the dialog box property sheets as required. At a minimum,
• if you specify a keypad (code) IDF, assign a valid PIN
• if you specify a card IDF, assign a valid MATCH code
• assign a valid door group or function group
5. When you're finished, click OK. You are returned to the Personal Information form.

Credential Properties Dialog Box

The Credential Properties dialog box consists of four pages:
 General property sheet (see page 865)
 Function property sheet (see page 869)
 Limits property sheet (see page 870)
 Options property sheet (see page 873)
 Biometrics property sheet (see page 877)
Each page is discussed in the following subsections.
The Credential Properties dialog box is similar to the Credential Template Properties
dialog box. For more on credential templates, refer to “Credential Templates,” starting
on page 228.

864 Credentials
 MAN006-0612

General Property Sheet

The General property sheet looks like this example:

The fields on this page are:

ID: This is a read-only field. Velocity generates an ID number for each

credential created.
When you first add a credential, the value (new) appears. This is
replaced by a generated number when the credential is created
by clicking OK.

Link to: Check this box to link this credential to the credential specified in
the pick list. This means that if this credential template is
changed, the credentials associated with this template also
change.
For more on this, refer to Credentials - “Credentials: Link to
Template” on page 883.
If this box is not checked, this credential is independent of any
credential template.

Description Type a brief description of this credential.

Badge From the drop-down list, select the badge template you need. If
Template you need a double-sided badge, make sure to select a badge
template designed specifically for double-sided printing.
Only those badge templates already defined are displayed in this
combo box list. Badge templates are created using the Badge &
Graphics Designer. For more on the Designer, refer to the
chapter, “Badge & Graphic Designer,” starting on page 437.
For more on printing double-sided badges, refer to
“Double-Sided Badge Printing,” starting on page 862.

Click this button to preview an example of the badge selected in

the 'Badge Template' combo box above.
Use this operation to review a badge template before assigning it
to a person.

Credentials 865
Velocity Version 3.1 Administrator’s Guide

IDF Select one of the available IDF options from this combo box.
Options are:
• 0 - Badge Only
• 1 - Keypad
• 2 - Card
• 3 - Dual
• 4 - Card + Dual
• 5 - Keypad + Dual
• 6 - Keypad + Card
• 7 - Keypad/Card/Dual
The default is 1 - Keypad.
For more on this, refer to “ID Formats (IDF)” on page 880.

Card If you select any card option—including card, dual, or card +

code—from the IDF field, this section is activated.

Type: Select from the drop-down list the type of card this is. Select from
these options:
• Std 26-Bit Wiegand
• Std 27-Bit Wiegand
• Std 28-Bit Wiegand
• Std 29-Bit Wiegand
• One-Field ABA
• Special 1 - 36
• Passthru
The default is Std 26-Bit Wiegand.
For more on card types, refer to “Card Types” on page 234.
Note: If you are using an enrollment station, you don’t have to specify
the type. The enrollment station automatically detects the card
type and supplies it in this field.

Stamp # This optional field is most often used for record-keeping. Enter
the hot stamp number appearing on this card. This is the number
that is already imprinted on this card (normally on the back).

Data Type the data appearing on this card. This number is often the
same as the hot stamp number (though not on Hirsch cards).
If this workstation is connected to an enrollment station, simply
slide the new card through the enrollment reader; the number
automatically appears in the 'MATCH' field.

866 Credentials
 MAN006-0612

UDF... Click this button to concatenate currently selected UDF fields and
populate the 'Data' and 'MATCH' fields with the result. The
Concatenate UDFs screen appears.
This is generally only used when the Passthru option is selected
for the Card Type.
Note: Only UDFs that are a numeric type are selectable for
concatenation.
This button is only active when you select an IDF that specifies a
Card. If you select IDFs 0 (Badge Only) or 1 (Code Only), this
button is not active.

MATCH Do one of the following:

• Enter numbers in the 'Data' field and Velocity automatically
generates a number for this field.
• Type in the MATCH number from the cross-reference list
provided by Hirsch for all cards (except PVC cards used for
photo badging).
• Enroll the new card through the attached enrollment station.
This field is automatically populated.
This is an 8 - 16 digit number.
Note: If you enter a MATCH code that has already been used, the
program will prompt you. If the system has been enabled for
override, a message appears asking you whether you want to
override and reuse the code. If you have the proper permission,
you can override and reuse the code; however, you cannot
override an existing code unless the original has been deleted.

Enrollment This icon indicates whether the enrollment station is working

Station Status properly or not.
If the station is connected and working correctly, you will see a
normal black and white icon with a green dot, .
If Velocity does not detect an enrollment station, you see black
and white icon with a red dot, .
To test the enrollment station, double click this button. The
Enrollment Station Diagnostics dialog box appears (see page
831).

Credentials 867
Velocity Version 3.1 Administrator’s Guide

Activation/Expiration Date

Activate: The date and time when this credential becomes valid.
At the date field, use the down arrow, , to the right of this
combo box to display a calendar. Select the month and day on
which this card/code is activated. You can click the and
buttons to go from month to month. Use the up and down
cursor keys to change the date. The current time is automatically
supplied. To change this, click in the time fields and enter new
values as required.
Alternatively, in the combo box to the right, select from a list of
common date ranges, such as 1 day, 1 week, 1 month, etc. This
automatically enters a value in the preceding field. Modify the
values to the left combo box as required.

Expire: The date and time when this credential is no longer valid. If the
person possessing this credential attempts to use this credential
after the expiration date, Velocity refuses the attempt.
If you want to activate this feature and change the date that
appears in this field:
1. Check the 'Expire' box to the left of the field.
2. To the right of the field, click the browse button, .
The Set Expiration Date dialog box appears. Refer to
“Credentials: Set Expiration Date” on page 882.
3. Specify the date you want to use, either a specific date or a
UDF date.
4. Click OK.

On This field is activated when the 'Expire On' checkbox is selected.

Expiration: Three options are available:
• Disable - click this radio button to indicate that this card/code
is disabled on expiration. The card/code is stored in the
database and cannot be reused.
• Delete from Controllers - click this radio button to indicate
that this card/code is deleted from all controller memories.
The card/code is stored in the database and cannot be reused.
• Disable and Unassign - click this radio button to indicate
that this card/code is disabled and unassigned at expiration.
The card/code is stored in the database and can be reused by
selecting the credential from unassigned, assigning the
unassigned credential to a person, then reactivating it.

Code If you select any code option—including code, dual, or card and
code—from the IDF field, this section is activated.

Length: Use the spin control buttons, , to specify how many digits
long this code can be.
The range is 3 - 15 digits. The default is 4 digits.

868 Credentials
 MAN006-0612

PIN Either type in a new PIN code in the field or click Auto to
automatically generate a number.
Note: If you enter a PIN that has already been used, the program will
prompt you. If the system has been enabled for override, a
message appears asking you whether you want to override and
reuse this PIN. If you have the proper permission, you can
override and reuse the PIN.

Auto Click this button to automatically generate a new PIN code.

Duress Digit: Use the spin control buttons to specify a duress digit for this
credential. Available duress digits are 1 - 9.
The default is 0 indicating that no duress digit is required for this
code.
For on this, refer to “Duress Digits” on page 881.

Function Property Sheet

The Function property sheet looks like this example:

Use this property sheet to define one or more actions that should be performed when
this code/card is presented.

Function When you click the Function(s) radio button, this window is
window activated. This window contains a list of all access or control
functions defined for this credential. While more than one function
can appear in these windows, two or more functions (whether
access or control) cannot be listed for the same controller.
Note: A credential can only define a single function per controller.
For more on functions, refer to “Functions” on page 241.

Add... Click this button to add a function to this credential. The Define
Function dialog box appears. Select the function you require and it
is displayed in either the Access or Control Function window.
For more on the Define Function dialog box, see “Define Function
Dialog Box,” starting on page 875.

Credentials 869
Velocity Version 3.1 Administrator’s Guide

Edit... Click this button after selecting a function from either the Access
Function or Control Function window to edit the function. The
Define Function dialog box appears. Modify the function as needed.

Delete Click this button after selecting a function from either the Access
Function or Control Function window to remove that function from
the window.

Limits Property Sheet

The Limits property sheet looks like this example:

Use this property sheet to enable a variety of limits on this credential including global
person (credential) management, day/use/absentee limits, and two-person rule.
The options available on this screen are:

Apply Click this box to indicate that the credential management limits
Credential specified here are shared amongst all controllers connected to
Management the same XBox. Before this feature can be applied, you must first
Globally check the 'Enable global credential management' box on the
Controller Properties Setup page (see page 870) for each
affected controller.
For example, if a person using this credential exceeds the use
limit at one door, that information is shared with all other
controllers on the same XBox. This makes it impossible for the
credential to be used at another door even if it is controlled by
another controller.
For more on this, refer to “Global Credential (User)
Management” on page 895.

870 Credentials
 MAN006-0612

Threat Use the spin control buttons to increase or decrease the threat
Authority level for this credential. At the specified threat level, the
credential is no longer honored and access is no longer allowed.
The default, 0, indicates that no threat level has been set for this
credential.
For more on threat levels, refer to “Threat Levels” on page 338.

Day/Use/Absentee Limits

No Limit Click this radio button to indicate that there are no limits for this
credential.
This is the default value for a credential.

Day Limiting Click this radio button to specify that this credential expires after a
specified number of days. The 'Day/Use/Absentee Count' spin
control field is activated.
Specify the limit in the 'Day/Use/Absentee Count' field to the
right.
For more on this, refer to “Day Limiting” on page 890.

Use Limiting Click this radio button to specify that this credential expires after a
specified number of uses. The 'Day/Use/Absentee Count' spin
control field is activated.
Specify the limit in the 'Day/Use/Absentee Count' field to the
right.
For more on this, refer to “Use Limiting” on page 890.

Absentee Click this radio button to specify that this credential expires after a
Limiting specified number of recorded days absent (days this card and/or
code were not used). The 'Day/Use/Absentee Count' spin
control field is activated.
Specify the limit in the 'Day/Use/Absentee Count' field to the
right.
For more on this, refer to “Display Credential Information” on
page 889.

Day/Use/ Use the spin control buttons to increase or decrease the number
Absentee of days, uses, or absences this credential is allowed before it
Count expires. The units specified here depend on the limiting radio
button:
• if you select Day Limiting, the count is in days
• if you select Use Limiting, the count is in uses
• if you select Absentee Limiting, the count is in days absent
The allowed range is 1 - 254 days, uses, or absences. The default
value is 0, no limit.

Credentials 871
Velocity Version 3.1 Administrator’s Guide

Auto-Delete Click this box to indicate that when the limit is reached as defined
Credential by the fields above, this credential is automatically deleted from
the controller's memory.
If you have checked the 'Apply Credential Management Globally'
box, all instances of this credential on all attached controllers are
deleted.
Note: If this option is not checked, when the limit is exceeded, the
credential is disabled.
For more on this feature, see “Auto-Delete” on page 892.

2-Person Rule This section specifies how the 2-person rule is applied to this
credential. Doors are enabled for 2-Person Rule using the Door
General Properties page.
Timers and time zone disable parameters are specified on the
Controller Passback property sheet.
For more on this, refer to “Two-Person Rule,” starting on page
106.

Normal Click this radio button to indicate that the normal 2-person rule
applies to this credential. This person can access a 2-Person
Rule-enabled door with any other person possessing a Normal,
A/B Rule “A”, or A/B Rule “B” designation.

A/B Rule A Two-Person “A/B” Rule. If one person has an A/B Rule “A”
specified in the limits for their credential, they need to find
someone with an A/B Rule “B” or a 'Normal' designation in order
to unlock a 2-Person Rule-enabled door.
This is particularly useful for supervisor/trainee access privileges.
For more on this, refer to “Rule Variations” on page 108.

A/B Rule B Two-Person “A/B” Rule. If one person has an A/B Rule 'B'
selected in the limits for their credential, they need to find
someone with an A/B Rule “A” or a 'Normal' designation in order
to unlock a 2-person rule-enabled door.
This is particularly useful for supervisor/trainee access privileges.
For more on this, refer to “Rule Variations” on page 108.

Executive Two-Person Executive Override. This allows the holder of this

Override credential to override the two-man rule. It only takes this
credential to unlock the door even if the door normally requires
two people.
For more on this, refer to “Executive Passback Override” on page
891.

872 Credentials
 MAN006-0612

Options Property Sheet

The Options property sheet looks like this example:

This page controls a variety of options influencing the way Velocity responds to a
specific credential.

Actions

Tag Click this box to indicate the credential is tagged. For more on
this, refer to “Tagging” on page 892.

Alert Click this box to indicate the credential causes an alert. For more
on this, refer to “Alert” on page 892.

Disable Click this box to disable all actions while this credential is being
used.

Passback

Executive Click this box to designate that this credential allows executive
Override override. For more on this, refer to “Executive Passback Override”
on page 891.

Special Needs

Special Click this box to designate that this credential allows an unlock
Needs extension beyond the normal unlock interval for special needs,
Access Time such as wheelchair access or partial delivery.
Extension

Credentials 873
Velocity Version 3.1 Administrator’s Guide

Current Issue Enables an operator to document the current status of this

Status credential. This is particularly helpful if the credential has been
lost, destroyed, or stolen for some reason.
Either enter an issue into this combo box or select one of the
status options from the drop-down list. The default issue list
options include:
• Lost
• Stolen
• Destroyed
This is an information field and does not disable the credential.

Print Control

Enable Print Check this box to enable print control. Print control is a feature
Control that restricts the number of badges that can be printed using this
credential.
If this credential is not associated with a badge template, this
section has no relevance. A qualified operator can enable Print
Control globally using Enrollment Manager Preferences (see
“Preferences” on page 896).

Attempts: A read-only field indicating the number of attempts that were

made to print the badge based on this credential.
This count and the Confirmed count will be identical unless you
check the Display print confirmation box below.

Confirmed: A read-only field indicating the number of badges based on this

credential that were actually printed. This number cannot exceed
the prescribed Max field.
This count and the Attempts count will be identical unless you
check the Display print confirmation box below.

Max: Enter the maximum number of badges that can be printed for
this credential. Velocity will not allow either the Attempts or
Confirmed counts to exceed the value entered here unless the
operator printing the badge is assigned to a role that allows
overriding of print control (see “Role Properties: Application
Permissions” on page 292).
A qualified operator can specify a maximum value globally using
Enrollment Manager Preferences (see “Preferences” on page
896)

874 Credentials
 MAN006-0612

Display Print Check this box to enable confirmation when a badge bsed on
Confirmation this credential attempts to print. This means that whenever an
operator prints a badge based on this credential, Velocity
prompts the operator to indicate whether the badge printed
correctly. If the operator indicates that the badge did print
properly, both the Attempts and Confirmed fields are
incremented by one. If the operator indicates that the badge did
not print properly, only the Attempts field is incremented.
A qualified operator can enable this feature globally using
Enrollment Manager Preferences (see “Preferences” on page
896)

Issue Control

Enable Issue Check this box to enable issue control.

Control

Count: A read-only field indicating the number of times this credential

has been issued. This figure cannot exceed the Max count you
enter.

Max: Enter the maximum number of times this credential can be

issued. Velocity will not allow the Count field to exceed the value
entered here.

Reissue Click this button to reissue this credential.

For more on this, refer to “Credentials: Reissue” on page 886.

Issue A list of issues appears in this table. The first issue indicates the
Comment initial issue of the card. Subsequent entries indicate that the
Table credential was reissued.
Each issue is identified by its issue number, the reason for its
issue, and the date of its issuance. To review or edit an entry in
this table, double click on the entry and the Reissue Credential
dialog box appears (see “Credentials: Reissue” on page 886).

Define Function Dialog Box

The Define Function dialog box looks like this example:

Credentials 875
Velocity Version 3.1 Administrator’s Guide

The combo boxes on this screen are:

Function From the pull-down option list, select the type of function you
Category: need performed. These include:
• Access
• Relay
• Alarm
• Password
• Special
• Function Group
The combo boxes in the bottom half of the screen change
depending on which category you select.

Function: Depending on which function category is selected in the

'Function Category' combo box, select from a list of available
functions in this option list.
For more on this, see “Functions” on page 241.

Door Group: If you select Access, Password, or Special (Alarm Cancel, Watch
Log, and Time Log only) from the 'Function Category' combo
box, this combo box appears. Select a door group from the
available options. All currently-defined door groups appear in
this list.
To create a new door group for this purpose, select <New>. The
Door Group Configuration dialog box appears.
For more on this, refer to “Door Groups” on page 257.

Controller: If you select Relay or Alarm from the 'Function Category' combo
box, this combo box appears. Select the controller that the
specified control zone affects.

Control Zone: If you select Relay or Alarm from the 'Function Category' combo
box, this combo box appears. Specify the control zone that
specifies the relay(s) or input(s) and its behavior. Both Standard
and Master control zones are included in this list.
Before a control zone can be effective, you must first define it.
For more on control zones, refer to “Control Zones” on page
109.

Function If you select Function Group from the 'Function Category' pick
Group: list, this pick list appears. Select an existing function group from
the list, or select <New> to define a new function group.

Add If you select Relay or Alarm from the 'Function Category' combo
box, this button appears. Click this button to add the currently
displayed controller and control zone to the list in the window
below.

Remove If you select Relay or Alarm from the 'Function Category' combo
box, this button appears. Click this button to remove a selected
function from the function list in the window below.

876 Credentials
 MAN006-0612

Credential Biometrics Properties Sheet

When you click the Biometrics tab, a page like this appears:

The fields and buttons on this page include:

SC Readers From the drop down list, select the smart card reader that
will be used to enroll (encode) the MIFARE or DESFire
smart cards. These smart cards are used to store both the
user information and biometrics after initial enrollment.

GUID Specifies the global unique identifier (GUID) for the card
associated with this credential. The GUID is normally
provided automatically when the card is read during
enrollment; however, if no GUID appears here and you
require a GUID for this credential, click the Generate
button to create one.

Click this button to automatically populate the GUID field

with a GUID number.

First Name This field displays the first name of the person associated
with this credential.

Last Name This field displays the last name of the person associated
with this credential.

Panel ID Enter the Panel ID for this card.

This ID is a sub-identifier or subset of the Site ID and is
used to match encoded user smart cards to any number of
field readers. The Panel ID is loaded into Cogent readers
(such as the Hirsch RUU-GEN and SmartGate) using the
reader's configuration software. The Panel ID itself is
assigned by an administrator or other qualified operator
during that configuration process. The Panel ID is
subsequently used to specify subgroups of readers and
cards for a given area or panel within the site.
A match of both Site ID and Panel ID is required before the
encoded user smart card can work on a given Cogent
biometric reader.

Credentials 877
Velocity Version 3.1 Administrator’s Guide

Site ID Enter the Site ID for this card.

This ID is used to match a given encoded user smart card
with any number of Cogent smart readers (such as the
Hirsch RUU-GEN and SmartGate). The Site ID is
programmed into the readers using the reader's
configuration software. The Site ID itself is assigned by an
administrator or other qualified operator during that
configuration process. A match of Site ID value between
the card and reader is required before the reader allows the
card to be read. This feature is like the Facility Code used
for access control credentials that tie the card to a given
site. The Site ID identifies the overall site relationship of the
biometric cards and readers.
A match of both Site ID and Panel ID is required before the
encoded user smart card can work on a given Cogent
biometric reader.

PIN Enter the PIN for this card. This PIN need not be the same
as the PIN entered on the General page.

Issued Specify the day and date on which this card was issued.

Expires Specify the day and date on which this card expires.

CSN This is a read-only field. The Card Stamp Number is hard

coded on a CAC card and automatically populates this field
when the card is read during enrollment.

Left Hand Click the appropriate box to indicate the finger on the left
hand you want to scan. The box turns green. Click Enroll
Template 1 button. For more on this, see “Writing
Fingerprint Data to a Credential” on page 878.

Click this button to start the finger scan on the selected

finger.

Right Hand Click the appropriate box to indicate the finger on the right
hand you want to scan. The box turns green. Click Enroll
Template 2 button. For more on this, see “Writing
Fingerprint Data to a Credential” on page 878.

Click this button to start the finger scan on the selected

finger.

Writing Fingerprint Data to a Credential

With the advent of smart cards, it is now possible to write biometric information,
specifically fingerprint data, to a card. The amount of fingerprint information you can
write depends on the memory capacity of the card. In general, 1 MB cards allow you to
write one finger print, whereas 2 MB and 4 MB cards enable you to write two
fingerprints to a given card.
To write a fingerprint to a card:

878 Credentials
 MAN006-0612

1. Connect a fingerprint reader (sensor) to the Velocity server or workstation via a

USB connection.
As a USB device, the fingerprint reader should self-configure and be automatically
recognized by the operating system once it is plugged in. If the operating system
has any problems recognizing the reader, consult your fingerprint reader
installation guide for information.
2. Launch Velocity.
3. Open the Enrollment Manager.
The Enrollment Manager main page appears.
4. Double click the name of the person whose fingerprints you want to attach to their
credential.
5. From the credential pane, either click an existing credential or click Add New
Credential to create a new credential.
The Credential Properties screen appears. If you are creating a new credential, fill
out the appropriate information for the first four pages as you would normally do.
6. Click on the Biometrics tab.
The Biometrics page appears.
7. From the 'SC Readers' pick list, select the fingerprint reader you want to use to
scan the fingerprints.
Only fingerprint readers previously attached to and configured for this Velocity
computer appear in this list.
8. Fill out the required fields, including these:
• Panel ID
• Site ID
• PIN
9. In the Left Hand section, click to select the finger whose print you want to take.
The selected box turns green.
10. Click the button.
A screen like this appears:

11. Follow the instructions above the window. Normally, these instructions follow this
order:
• Place finger on sensor...
• Remove finger from sensor...
Generally it takes two passes before the sensor can fully capture a fingerprint. As
the scanning is completed, the finger print appears in the window.

Credentials 879
Velocity Version 3.1 Administrator’s Guide

 Make sure you are scanning the finger you specified. If you have trouble
reading a fingerprint, rub the finger you are using next to your nose or
some other part of your face where there is some oil, then place your
finger on the sensor again.
The Finger Enrollment dialog box disappears and the Biometric page reappears like
this example:

12. To enroll a right hand fingerprint, repeat Steps 9 - 10 using the Right Hand section
and click the button.
13. Once you have captured the fingerprint(s) you require, place the card to which you
want to write the biometric credential on an attached card reader/writer.
14. Click Write.
The fingerprint and associated credential data is written to the selected card. When
the card reader has finished writing data to the selected card, a message like this
appears:
15. Click OK.
16. Click OK again to return to the Enrollment Manager main screen.

ID Formats (IDF)
Hirsch has created seven different ID formats (IDFs) each of which qualifies the person
for a different access level and, depending on the door encountered (Card only, Code
only, or Dual Technology), requires a different series of steps to enter or exit.
Each IDF is defined in the following table, indicating how each IDF would respond to a
specific door configuration:

ID Format Dual Reader Dual Reader ScramblePad Card Reader

(IDF) (Normal (Card + Code Only Only
Operation) only)

IDF 1: Keypad Enter PIN Enter PIN Enter PIN N/A

Only

IDF 2: Card Present card Present card N/A Present card

Only

IDF 3: Dual Present card, Present card, N/A N/A

enter PIN enter PIN

880 Credentials
 MAN006-0612

ID Format Dual Reader Dual Reader ScramblePad Card Reader

(IDF) (Normal (Card + Code Only Only
Operation) only)

IDF 4: Card + Present card, Present card N/A Present card

Dual enter PIN

IDF 5: Keypad Present card, Enter PIN Enter PIN N/A

+ Dual enter PIN or
code only

IDF 6: Keypad Present card or Present card or Enter PIN Present card
+ Card enter PIN enter PIN

IDF 7: Present card, Present card or Enter PIN Present card

Keypad/Card/D enter PIN enter PIN
ual

At a dual-technology reader—a device possessing both a card reader and a

keypad—qualified individuals with both keypad-only and card-only access can be
served in addition to people with Dual Code (Card + Code) access.
People using dual codes must swipe their cards through a reader then enter their PIN
at the keypad before access can be given.
During times of high traffic volume, Hirsch has created a Card or Code Only Time Zone
(CCOTZ) feature. This means that at certain dual readers for specific times of the day,
the controller will allow either Code Only or Card Only access to those persons enrolled
for that feature.
To use this feature, a person must be enrolled as either Card Only or Code Only and
Dual Access; then during a predefined time zone (CCOTZ) the qualified person can use
just the one code or card to enter even though at other times, both card and code are
required to enter. At the same time, even while in CCOTZ mode, persons enrolled as
Dual, Card Only, or Code Only, will still have access using their normal access methods.
In Velocity, all IDFs generate only one record. Velocity can support very large user
numbers.

Duress Digits
If a qualified person is being forced to open a door against his/her will, the person can
indicate this coercion by entering an extra ‘duress’ digit. By entering this digit, the
controller permits access while issuing a silent alarm, immediately alerting the Velocity
operator to the situation.
In order to use a duress digit, the controller must first be enabled for this feature and a
duress digit must be specified.
 Only use this feature if an operator will be monitoring the system.
Duress digits are entered at the keypad immediately after the qualified person’s PIN
code. For example, a person at a ScramblePad might enter this code:
START 184059 #
where 18405 is the person’s normal PIN number and 9 is the duress digit.

Setting Up Duress Digits

To set up duress digits:

Credentials 881
Velocity Version 3.1 Administrator’s Guide

1. In the system tree pane, reveal the controller and right click.
2. Select Properties.
3. Select the Setup tab.
4. Under ‘Options’, check the ‘Enable Duress Alarm Mode’ box.
5. Select OK to save.
6. Open the Enrollment Manager.
7. Double click Add New Credential.
8. In the ‘Code’ section, select a Duress Digit.
9. Save the credential.

Using Duress Digits With Code Extension Digits

If you have enabled a person for a duress digit as well as qualified them for a function
group, the duress digit comes after the user code while the function group extension
digits come after the asterisk.
For example, if a person with the PIN 111 is defined for a duress digit of 9, this person
would enter a duress code like this example:
1119
However, if the person wants to express a duress digit while also specifying function
group controls (1 in this case), he/she would enter the duress digit, the asterisk, then
the extension digit like this:
1119*1
For information on using extension digits, refer to “Defining Code Extensions” on page
270.

Credentials: Set Expiration Date

The Set Expiration Date dialog box looks like this example:

The Set Expiration Date dialog box includes these fields:

Expire on Click to select this radio button if you want this credential to
Date: expire on a specific date at a specific time. The date and time
field to the right is activated.
This radio button cannot be deselected unless a UDF date type
field is available.

882 Credentials
 MAN006-0612

At the date field, use the down arrow, , to the right of this
combo box to display a calendar. Select the month and day on
which this card/code is activated. You can use the arrow keys to
go side to side or up and down for values.
The current time is automatically supplied. To change this, click
in the time fields and enter new values as required.
Alternatively, in the combo box to the right, select from a list of
common date ranges, such as 1 Day, 1 Week, 1 Month, and
so on. This automatically enters a value in the preceding field.
You can then modify the values in the left combo box as
required.

Expire on UDF Click to select this radio button if you want this credential to
Data: expire on a date specified by a value in a UDF field. The time
when the expiration takes place is always the end of the last
minute before midnight (11:59 PM) on the date designated by
the UDF.
For example, if you have defined a UDF for ‘Anniversary’, this
indicates that anyone given this credential will have it expire on
the last second of 11:59 PM on the employee's anniversary.
This field is only activated if one or more UDFs with a type 'Date'
are defined in Enrollment Manager.

At the pick list field, use the down arrow, , to display a list of
all currently-defined UDFs with a type ‘Date’. Select the UDF with
the type 'Date' you want to serve as the expiration date.

Click OK when you're finished to return to the Credential Properties General page. The
expiration date you specified now appears in the 'Expire' field.

Credentials: Link to Template

When the 'Link to:' field is checked and a pre-existing Credential Template is selected
on either the Credential Templates Option Properties page or the Credential Option
Properties page, certain fields on an individual credential can be changed when the
credential template to which it is linked changes.
An example of this field in its context appears below.

Credentials 883
Velocity Version 3.1 Administrator’s Guide

If the 'Link to:' box is checked, all fields associated with the specified Linked Template
will be disabled (read-only) on the Credential Properties Option sheet. Unchecking the
'Link to:' box from Linked Template option activates these read-only fields allowing
qualified operators to override the template settings. When the OK button is pressed, a
dialog asking for confirmation of the override is displayed.
This enables a qualified operator to change values of associated credential retroactively
just by changing the credential template to which these credentials are linked.
Only certain fields on the Credential Properties sheet are affected by the 'Link to:'
feature. These are:
 Activate/Expiration Date fields on the General tab
 Access and Control function sections on the Function tab
 Day/Use/Absentee Limits section on the Limits tab
 Print / Issue Control sections on the Options tab
All other fields and sections are user-specific and cannot be changed by changing the
underlying credential template.
For example, say you want to change the expiration date for all credentials associated
with a specific template. The old way required you to go through each credential
separately and make the change to the affected expiration fields. Using the 'Link to:'
feature, however, you can change the expiration date in the linked credential template
and the new expiration date ripples down through all linked credentials.
If the 'Link to:' checkbox is cleared, a confirmation message box appears, asking you to
confirm the clearing of the box. If you confirm the change, the credential is unlinked
from the template and the credential fields may be edited; however there is no further
connection to the template the credential was linked to.
If you change the name of the credential template in the 'Link to:' pick list, a message
appears asking you to confirm this selection. If you confirm the change of template, the
credential fields associated with the old template are changed to reflect the new values
from the new template.
If a qualified operator edits a template that has existing credentials linked to it then
presses OK, a confirmation dialog appears listing all credentials linked to the template.
If you confirm this change, all linked credentials are changed according to the new
values in the template.

Credentials: Executing Function Groups

A qualified administrator or operator can map a credential/credential template to
execute a specified function group. In effect, this can trigger one or more functions
simply by entering a predefined card and/or code. So, whatever you can define for a
function group, you can execute using a designated credential or credential template.
This enables you to use a Function Group in two different ways:
1. From a ScramblePad keypad, you can enter the designated pin code and extension
digit that executes the specified function group, or
2. From any access reader or keypad, you can execute the function group whenever
the code or card associated with that credential is granted.
To set up a credential or credential template to execute a function group:
1. Define a credential or credential template.
2. At the Function page, select Add...

884 Credentials
 MAN006-0612

The Define Function property sheet appears.

3. At the Function Category pick list field, select Function Group.
The Execute Function Group option appears automatically in the Function pick list
field. The Function Group pick list field appears below like this example:

4. At the Function Group pick list field, do one of these:

• Select one of the existing Function Groups. This presupposes that you have
one or more Function Groups already defined.
• Create a new Function Group by selecting the <New> option. The New
Function Group property sheet appears.
5. When you've selected the function group you need, click OK.
Complete the Credential Properties dialog box or Credential Template Properties dialog
box sheets as required.

Credentials: Concatenating UDFs

You have several possibilities for entering data in the Credential 'Data' and 'MATCH'
fields:
 You can enter specific numbers taken from the blank card
 You can create and enter a number of your own
 You can generate numbers automatically composed of UDFs
Steps for using this third approach are discussed here.
To concatenate a value for both the 'Data' and 'MATCH' fields:
1. Make sure you have one or more UDFs already defined through the User Defined
Setup feature.
Each UDF must be one of these qualifying types: Number, Auto-unique,
Unique, or Auto-sequential.
2. Create a new or edit an existing credential or credential template.
3. At the General page of the Credential Properties sheet, select an IDF that includes
a card.
The UDF... button is activated.
4. Click the UDF... button.

Credentials 885
Velocity Version 3.1 Administrator’s Guide

The Concatenate UDFs dialog box appears. All currently defined UDFs appear in
the window.

5. Check each UDF you want to use to concatenate a value.

6. Using the Move Up and Move Down buttons, list the available UDFs as you
require. This determines the order in which the values are hashed to make the
relevant Data and MATCH values.
7. Click OK.
From now on, each person assigned this credential will have the values entered for the
specified UDFs combined to generate a unique 'Data' and 'MATCH' field value. The
'Data' field value is preceded by <UDF> to indicate that this value is a concatenation. A
concatenated value only appears once values for the required fields are supplied.

Credentials: Reissue
Click the Reissue button on the Credential Options properties sheet to indicate the
current credential has been reissued for some reason. The Reissue Credential dialog
box appears like this example:

The fields on this dialog box include:

Date A read-only field that indicates the current date.

Issue # A read-only field indicating the issue number. This increments by

one each time a new issue is entered.

Reason Select from the available options in the drop-down list. These
include:
• Lost
• Stolen
• Destroyed

Comment Enter commentary on reasons for the reissue.

886 Credentials
 MAN006-0612

Click OK when you're finished. The new reissue appears in the issue table as shown in
the example below:

Credential Tasks
Use the Credential pane in the Enrollment Manager to perform several tasks on one or
more specified credentials.
To perform credential tasks:
1. From the people tree pane, select the person(s) on whose credential(s) you want
to perform a task.
To select multiple persons, either use the Shift + click combination to select a
contiguous group, or Ctrl + click to pick multiple people.
If you have only selected one person, that person's Personal Information form
appears with all associated credentials displayed in the credentials pane. Go to
Step 5.
If you have selected multiple people, proceed to Step 2.
2. If you have selected multiple people, right click on the highlighted group. An option
list appears.
3. Select Display Credentials...
The Credentials – Multiple People window appears like this example:

4. Select one or more credentials.

5. Do one of these:
• If this is a single person, right click a credential displayed in the Credential
pane.
• If this is multiple credentials, right click the selected credentials in the
Credentials – Multiple People window.

Credentials 887
Velocity Version 3.1 Administrator’s Guide

A drop-down option list appears like this example.

6. Select one of the options from this list:

Badge Select this option to display several sub-options that apply to

the display and modification of the badge. Three options are
available:
Preview... to display the Badge Preview dialog box.
Print to print the current badge associated with this
credential.
Edit... to start Badge Designer and display the currently
assigned Badge Template for this credential. If more than one
credential is selected, this option is inactive.

Tag Select this option to tag the specified credential. A check

mark appears before the option. It can be deactivated at any
time by re-selecting the checked option.
For more on this, refer to “Tagging” on page 892.

Alert Select this option to alert the specified credential. A check

mark appears before the option. It can be deactivated at any
time by re-selecting the checked option.
For more on this, refer to “Alert” on page 892.

Disable Select this option to disable the specified credential. The

credential is temporarily disabled and a check mark appears
before the option. It can be reactivated at any time by
re-selecting the checked option.

Forgive Select this option to forgive any passback violation for this
Passback credential. The event appears in the Event Viewer.
This option is particularly useful in an emergency, when a
passback violation must be forgiven in order to get people
out of a passback area as quickly as possible.
For more on this, refer to “Forgiving Passback” on page 891.

888 Credentials
 MAN006-0612

Override Select this option to override any code tamper alarm

Code Tamper associated with this credential. The event appears in the
Event Viewer.
This allows a credential that has been disabled because of
code tamper to be reused after an operator confirms that an
authorized user made a mistake.

Reset Limit Select this option to reset the limit count for this credential to
Count the default value. The event appears in the Event Viewer.
This essentially awards an extension to the credential holder.

Force Select this option to force an immediate download of this

Download credential's information to the relevant controllers.
For more on this, refer to “Downloading Credentials” on page
807 or “Downloading Multiple Credentials” on page 808.

Unassign Select this option to unassign this credential from the current
person. The credential disappears from the Credential pane
and is added to the Unassigned Credentials queue in the
Enrollment Manager's Credential Tree pane.
For more on this, see “Unassigning Credentials” on page
807.

Delete Select this option to delete the credential from the Velocity
database. A prompt appears asking you to confirm your
choice. Click Yes and the credential is permanently removed
from the database.

Properties... Select this option to display the Credential Properties dialog

box for this credential. See “Credential Properties Dialog Box”
on page 864.
If more than one credential is selected, this option is inactive

Display Credential Information

Credential information can be displayed manually, through the Display Credential
option in either Alarm Viewer or Event Viewer, or automatically through the Show
Credential Information options in Graphics. Auto display credentials can also be
enabled for all doors through the Auto Display Credentials option under the Door
General Properties sheet.
The credential information window pops up whenever a person enters or exits a
designated door. When a door is enabled for this feature, the Credential window pops
up automatically, displaying information relevant information on the person holding the
credential. To display a photo of the person at the door, a qualified operator must first
assign a badge template that includes a photograph placeholder in either general door
properties or general preferences.
This window can appear whenever Velocity issues either an Access Grant or Access
Denied within the following modules:
 Alarm Viewer
 Event Viewer
 Graphics

Credentials 889
Velocity Version 3.1 Administrator’s Guide

There is one pop-up window allowed per door on a drawing board in Graphics. If more
than one credential window is displayed on a graphic drawing board at the same time
(for multiple doors), the windows will arrange themselves so as to be visible at the
same time.
The credential pop-up only shows the last action performed on the door.
You can restrict the use of this feature by enabling or disabling the 'Default Display
Credential' permission on the Graphics Role page.

Absentee Limiting
Absentee Limiting, also called Absentee Rule, sets the maximum number of
consecutive days a person may be absent – and therefore not use their ID to enter a
secure area or perform a control function – before the credential(s) used by that
person is disabled or deleted from the database.
A person can possess more than one credential each of which may specify a different
absentee limit.
For example, if Rachel Smith is only allowed six absences from work when her badge
(credential) is issued and Velocity detects that she has been absent seven times in a
row, her credential is disabled and she can no longer use that card to gain admittance
to the specified area (door group). If Rachel Smith uses her badge before the absentee
limit is reached, the count is reset.
Absentee Limiting is enabled and the number of absences are specified through the
Limits property sheet on either the Credential dialog box or the Credential Template
dialog box.
For an example of absentee limiting, refer to “Example: Absentee Rules” on page 927.

Use Limiting
Use limiting, also referred to as use count, sets a maximum number of uses an
authorized credential can perform in order to enter a secure area or perform a control
function.
Velocity allows up to a maximum of 255 uses. Once the use count expires the person
is disabled or optionally deleted.
For example, Mr. Brown is a temporary employee who has been assigned a credential
that gives him access to the research lab. Since Mr. Brown's contract calls for him to
finish his job within thirty days, his credential entitles him to only sixty accesses (one
entry and one exit per day) before the credential is invalidated. (If Mr. Brown is a
smoker, ratchet up the use count.) After thirty working days (assuming he doesn't miss
any days due to injury or illness), Mr. Brown's card no longer allows him to enter the
lab.
For an example of use limiting, refer to “Example: Use Count” on page 930.

Day Limiting
Day limiting sets a maximum number of days an authorized credential can access an
assigned area before access privileges are withdrawn.
Up to a maximum of 255 days can be allowed. Once the day limit expires the
credential is disabled or optionally deleted.

890 Credentials
 MAN006-0612

For example, Mr. Brown is a temporary employee who has been assigned a credential
that gives him access to the research lab. Since Mr. Brown's contract calls for him to
finish his job within thirty days, his credential entitles him to only thirty days before the
credential is invalidated. After thirty calendar days, Mr. Brown's card no longer allows
him to enter the lab.
 Day Limiting covers the same territory as Temporary Days.
For example of day limiting, refer to “Example: Day Limiting” on page 929.

Executive Passback Override

When a person is granted executive passback override privileges it means passback
limitations don't apply to this credential or person. No passback violation messages will
be issued and an access-grant always works.
For example, John has two-way access to his office and to the Lobby main door. But if
he tailgates behind someone into the lobby, he can't get into his office. If an operator
awards him (or anyone else) with the Executive Override option, his tail-gating or any
other passback infringements are automatically forgiven; access is granted.
Executive override of passback is accomplished through the Options property sheet of
either the Credential dialog box or the Credential Template dialog box.
For an example of executive passback override, refer to “Example: Executive Override”
on page 948.

Forgiving Passback
There are times when it is necessary to forgive passback, such as when an emergency
requires that everyone leave the building immediately. If passback is enabled for an
area or a credential, Velocity normally records this emergency access as a validation
and may not let the person back into the area once the emergency is over. To avoid
this situation, the operator can forgive passback, either for an individual credential, as
shown below, or for an entire area, as explained in Forgive Users.
To forgive passback for a person:
1. Open Enrollment Manager.
2. Select the person whose passback you want to forgive.
3. From the Credential pane, right click on the credential with the passback enabled.
4. Select Forgive from the pop-up option list.
The passback is forgiven for this time only. For an example of forgiving passback, refer
to “Example: Forgive Passback” on page 946.

Forgiving Users
There are emergencies, such as fire or earthquake, when you must effect a rapid
evacuation of a facility no matter what access privileges the persons inside hold. To
perform a rapid evacuation, Velocity provides the Forgive Users features. This instructs
controllers to overlook all current passback and occupancy restrictions in the interests
of a speedy exit from the endangered area.
This function can be accomplished in two ways:
 By a qualified operator from a Velocity workstation
 By a qualified operator or person from a specific reader/keypad

Credentials 891
Velocity Version 3.1 Administrator’s Guide

To forgive all persons from a Velocity workstation:

1. From the System Tree pane, expand the DIGI*TRAC Configuration folder until the
effected controller appears.
2. Right click the controller.
A list of options appears.
3. Select Download > Forgive Users from the list.
The instructions are immediately downloaded to the specific controller. No access is
denied to evacuating personnel, no matter the current state of their credentials.
To forgive all persons from a specific reader/keypad:
1. From the Enrollment Manager, create a credential or credential template that
includes the Special Function Indexed Command - Forgive All Users.
2. Assign this credential or credential template to a qualified person.
3. After an emergency, one of the people possessing this special credential enters a
code or card at the reader guarding the entrance/exit to the evacuated area
(passback zone).
All violations recorded during the evacuation from this passback zone are forgiven.
To forgive credentials from the Who’s Inside module, refer to “Who's Inside: Forgiving
Credentials” on page 1219.

Alert
When Alert is enabled, a special audio alert sounds at the keypad where a person
enters a code/card that is specified as an alerted credential. This audio alert can also
occur when the code triggers a control zone that is alerted.
Alert is disabled (unchecked) as the default state.
Use Alerts for messaging in order to notify a person or group of people that some
special condition exists as they use their code. For example, a message is waiting for
them or an unscheduled meeting is taking place. The alert is a series of four “beeps”
and a flashing LED on the ScramblePad where the transaction takes place.
Alerts only sound at the keypad where the code is entered.

Tagging
When you enable tagging, it automatically sends a special Tag Alarm to the Alarm
Viewer each time the person with this credential uses the code/card, regardless of
whether access was granted or denied. This alarm can also be issued when the
card/code triggers a tagged control zone.
When tagging is checked it is enabled. When tagging is unchecked it is disabled.
Disabled is the default.
Tagging can be enabled for controllers, credentials, control zones, master control zones,
door groups, and master door groups.

Auto-Delete
Use this feature to automatically delete a credential from the database whenever it
reaches one of these user limits:
 use limit
 absentee limit

892 Credentials
 MAN006-0612

 day limit
This keeps the maximum amount of memory available for adding new people;
however, this can also prevent a person from being identified when he/she attempts
access after they have been disabled by reaching a pre-defined user limit.
Normally, a credential is disabled.
The auto-delete credential setting is selected by checking the Auto-Delete Credential
check box on the Limits property sheet of either the Credential dialog box or the
Credential Template dialog box.
A similar feature is Expire on: which enables the operator to specify a day and time
when the credential expires. At that time, this feature allows the operator to disable the
credential, unassign the credential, or delete it from the relevant controller. The feature
is available through the General page on either the Credential dialog box or the
Credential Template dialog box.

Credentials 893
Velocity Version 3.1 Administrator’s Guide

Credential (User) Management

Credential Management is the name Hirsch gives to a collection of features, including:

Day Limiting where a credential's code record automatically expires after a

certain number of days.
For more on this, refer to page 890.

Use Count where a credential's code record automatically expires after a

certain number of uses.
For more on this, refer to “Use Limiting” on page 890.

Absentee Rule where a credential's code record expires if it's not used for a
certain number of days. This is also called Absentee Limiting.
For more on this, refer to “Display Credential Information” on
page 889.

Auto-Delete on where a credential's record is deleted on expiration.

Expiration For more on this, refer to “Auto-Delete” on page 892.

Passback where a credential must enter and exit an access point before
they can request entrance at another access point.
For more on this, refer to “Passback Control” on page 104.

Occupancy where Velocity counts the number of credentials entering and

Count exiting a secure area and keeps a running total.
For more on this, refer to “Occupancy Count” on page 106.
One aspect of occupancy count is called ‘Who’s Inside.’ This is
explained more fully in “Who’s Inside,” starting on page 1215.

2-Person Rule this rule provides a high level of security access control for
specialized areas by requiring two authorized persons to be
present to enter or exit the secure area.
For more on this, refer to “Two-Person Rule” on page 106.

Essentially, credential management means that Velocity can perform a different action
the second time a person possessing a particular credential goes through an access
point than was performed the first time the credential goes through.
For example, if a credential is defined to have only three uses of Door 2 and he has just
exited the room for the third time, then his entry/exit privileges are revoked and any
attempt on this credential's part to enter Door 2 for the fourth time will be ignored and
will cause an alarm to be issued.
These features are controlled at two distinct levels:
 on a controller through the Controller Passback property sheet (see page 99)
 on an individual credential through the Credential Limits property sheet in
Enrollment Manager (see page 870)
The controller level manages the way in which the controller responds to a limit
violation as it applies to Passback, 2-Person Rule, and Occupancy Count.
The credential level indicates what the actual limits are for a given credential.

894 Credential (User) Management

 MAN006-0612

Global Credential (User) Management

By default, Velocity configures each controller to act as a separate entity: it monitors
each credential as if the credential only interacted with that controller alone. However,
most systems include more than one controller and each credential normally interacts
with more than one controller during the course of a working day. For this reason,
Velocity includes the ability to share information amongst connected controllers so that
a credential can be followed from controller to controller, keeping track of its use and
limits. This practice is known as globalizing.
Globalizing is the process of setting up two or more controllers connected to the same
XBox in order to share credential information amongst all connected controllers.
 Globalizing can only be performed by controllers connected to the same
XBox. Controllers using different XBoxes cannot share information.

For example, if a front door is monitored by a controller that is connected

to Velocity via XBox 1 and the back door is monitored by a controller that
connects to Velocity via XBox 2, the front and back doors cannot share
information.
For example, a Velocity operator has assigned a contract employee a credential that is
configured for twelve accesses (entries and exits) to a large research area controlled by
four controllers. Controller 1 records the twelfth and final access of this credential to the
area through Door 1. The person later attempts to exit the area through Door 3 which
is controller by Controller 3; however, Controllers 1 and 3 are enabled for global user
management and have shared their information about the credential with the other
two controllers. Because of this, Controller 3 denies exit to the person in question while
issuing an alarm because the contract employee has used up all their available uses.
Though the person attempts to exit the area through other doors, he gets the same
response: no controller in this group will allow entry to this credential.
The preceding example illustrates how user count can be globalized. Global credential
(user) management can apply to the following functions:
 passback
 occupancy count
 auto-delete
 absentee limiting
 day use (temporary days)
 two-person rule
In order to globalize any of these functions, you must:
 enable global usage at the controller. To do this, use the Controller Passback Page.
Once defined, enable global user management for a controller by checking the
'Enable Global User Management' box on the Controller Setup page (page 88).
 enable global user management for a specific credential or credential template. To
do this, use the Limits property sheet on either the Credential dialog box (page
870) or the Credential Template dialog box (page 236).
You can also globalize a master control zone using the 'Global MCZ' option which is
enabled in the Options section on the Controller Setup page and specified using the
Global ID on the master control zone property sheet.

Credential (User) Management 895

Velocity Version 3.1 Administrator’s Guide

Preferences
When you select Tools > Preferences... from the Enrollment Manager menu bar, a
screen like this appears:

This screen includes the following fields and buttons:

Print Control Defaults

Enable Print Check this box to enable print control. When this option is
Control enabled, the Enable Print Control option on all Credential
Options or Credential Template Options properties pages is
automatically checked for all credentials.
If this box is not checked, an individual operator must enable
the Enable Print Control option at the credential level. This
does not override an individual Credential or Credential
template setting; it only creates a default setting for that
option.

Max Enter a maximum number of prints that can be attempted for

any credential or credential template. This does not override
the setting an operator makes at the Max text box for an
individual Credential Options or Credential Template Options
properties page for an individual credential; it only creates a
default setting.
The default setting is 0.

Display Print Check this box to display a print confirmation prompt every
Confirmation time an operator prints a badge associated with a credential.
The Display print confirmation box on both the Credential
Options and Credential Template Options properties pages
are automatically checked.
This does not override an individual Credential or Credential
template setting; it only creates a default setting for that
option.

896 Preferences
 MAN006-0612

Quick Find Default

Query Size Enter the number of items to display in the Quick Find
drop-down list.
The range is 5 - 50. The default is 10.

Credential Templates - Relative Activation/Expiration Shortcuts

Credential This window displays the currently defined options listed in

Templates both the right drop-down 'Activate' field in the
window 'Activation/Expiration Date' section of the Credential General
page or Credential Template General page and the right
drop-down field of the Expiration on Date of the Set Expiration
Date dialog box.

The columns available in this window are:

• Interval – the indicated duration
• Offset – the specific time or number of intervals
• Display – the name that appears in the option list
To edit one of the existing options, click to highlight the
shortcut you want to edit then click the Edit... button.
To delete one of the existing options, click to highlight the
shortcut you want to delete then click the Delete button.

Use these two buttons to move a selected shortcut up or

down in the list displayed in this window.

Add... Click this button to bring up the Relative Time Shortcut dialog
box (see page 897).

Edit... Click this button to bring up the Relative Time Shortcut dialog
box (see page 897) for the currently selected shortcut. Make
changes as required then click OK.

Delete Click this button to delete the currently selected shortcut.

Relative Time Shortcut

Use this dialog box to specify additional options for the units drop-down list that
appears under the Activation/Expiration Date section of the Credential General or
Credential Template General page.

Preferences 897
Velocity Version 3.1 Administrator’s Guide

This screen looks like this example:

The fields on this screen include:

Interval From the drop-down list, select the interval you require.
Choose from these options:
• Today
• Day
• Week
• Month
• Year
The Offset and Display fields change to reflect the choice you
make. For example, if you select Today, spin buttons appear in
the 'Offset' field.

Offset Indicates the exact time on which this option takes effect.
Either enter the offset value or, if you selected Day as the
Interval option, use the spin buttons to increment/decrement
the value designating the exact time at which this option takes
effect.

Display Enter the name that will appear in the option list.

898 Preferences
 MAN006-0612

Event Viewer
Use the Event Viewer to view all activities Velocity detects on this system—such as, an
open door, a tripped alarm, a module opening or closing, a CCTV activated.
Once Event Viewer is opened, the operator may be called upon to perform these
activities:
 Scroll through events to check what has happened
 Customize the screen's appearance
 Suspend scrolling
 View only a single event type
 Change basic Event Viewer setups
 Copy events to the Windows clipboard
 Customize the filter of events

899
Velocity Version 3.1 Administrator’s Guide

How To Use Event Viewer

To use the Event Viewer:
1. To open the Event Viewer, do one of these tasks:
• From Velocity, press F7.
• From the Velocity desktop, click the Configuration file in the System Tree
window and select Event Viewer from the Component window, .
• From the Velocity icon bar, click the Events module, .
• From the Velocity menu bar, select Console > Event Viewer.
The Event Viewer appears. For a description of the viewer, refer to “Event Viewer
Main Screen” on page 900.
2. Scroll through the list of events as required.
3. Customize the appearance of the Viewer as required.
4. Filter the events you see in two different ways:
• Select a filter (filter group) to limit the event types appearing on the screen.
Create additional filter groups as required. For more on this, refer to “Creating
Filter Groups” on page 905.
• Filter events by a specific event type.
5. If needed, copy selected events to the Windows clipboard and paste them in other
applications.
If you don't need the Event Viewer visible at this time, remove it by clicking the X icon,
, at the upper left corner of the viewer screen.

Event Viewer Main Screen

The Event Viewer is a read-only screen displaying all events detected by Velocity as
they occur throughout the monitored system.
A typical Event Viewer screen looks like this example:

Notice that there is a vertical scroll bar enabling you to scroll up or down through a list
of all currently recorded events. A horizontal scroll bar also appears if there are more
columns defined for this screen than can be displayed in the current Event Viewer area;
this enables you to scroll right or left through the available columns.
The Event Viewer normally docks below the Administration window and remains there
unless relocated to another part of the screen.
Events are color-coded by type and can be sorted as required. For more on this, refer to
“Event Viewer Properties” on page 907.

900 How To Use Event Viewer

 MAN006-0612

The columns that describe each event are briefly defined below:

Controller This column must be selected from the Event Viewer Properties. It
Time is not a default setting.
The date and time this event occurred as recorded by the
controller experiencing the event. This value will be different from
the Host Time only if the controller is located in a different time
zone or if there is a delay between the time the event occurs on
the controller and the time when it is uploaded to the Velocity
host.

Host Time The date and time this event occurred as recorded by the Velocity
server or workstation. This column appears as the default.

Description A brief description of the event. This should supply a message

indicating what the event was. This column appears as the default.

Address The unique address Velocity assigns to this event. This indicates
the exact point where the event took place. This column appears
as the default.
For more on interpreting the address format, refer to “Address
Format” on page 422.

Event Type The type of event that occurred.

Many different types of events are tracked by Velocity including
DIGI*TRAC External, DIGI*TRAC Internal, Software,
Communications, Port, Controller, and so on. This column appears
as the default. For more on this, refer to “Event Types” on page
911.

Event ID The ID number Velocity assigned to this event. This column

appears as the default.

Like most tables in Velocity you can both sort the events on this list and reorder
columns in the table using Column Management.

Customizing the Event Viewer's Appearance

You can perform these functions to change the Viewer's appearance:
 Change the order in which you see these columns in one of two ways:
• Click a column header and drag it to a new location. For example, click the
Host Time column header and drag it to the left; when you release the mouse
button, Host Time should precede Controller Time.
• Go to the Column Headers section on the Event Viewer Properties General
page and make changes in order there.
 Change the colors that each alarm type displays using the Colors section on the
Event Viewer Properties General page.
 Change the number of lines that appear on this Viewer using the General page on
the Event Viewer Properties dialog box.
 Order the events on the screen by clicking the column header:
• Click the Host Time header to arrange events by host time.
• Click the Description header to arrange events alphabetically.
• Click the Address header to arrange events by address.

How To Use Event Viewer 901

Velocity Version 3.1 Administrator’s Guide

• Click the Event Type to arrange events alphabetically by their type.

• Click Event ID to arrange numerically by ID.
In each case, click once to order from the top-down; click again to order from the
bottom-up.

Event Viewer: Suspend Scrolling

On occasion, you may need to temporarily suspend scrolling. This freezes the Event
Viewer at the current spot and stops Velocity from displaying new events. There are
several good reasons for doing this:
 More events are coming in than the operator can monitor
 An important event occurs and the operator wants to freeze the screen at that point
To suspend scrolling:
1. Right click anywhere within the Event Viewer screen.
A pop-up list appears.
2. Select Suspend Scrolling from the option list.
The background color on the screen changes (unless the normal and suspend
color values are the same) and the Viewer stops displaying new events.
To resume scrolling:
1. Right click anywhere within the Event Viewer screen.
A pop-up list appears with the Suspend Scrolling option checked.
2. Select Suspend Scrolling again from the option list.
The background color on the screen changes (unless the normal and suspend
color values are the same) and the Viewer starts displaying new events again.
 Events are not lost during a suspended state. The event viewer caches
any new events in a queue and when scrolling resumes these cached
events are added to the event viewer at a very rapid rate.

Event Viewer: Displaying a Credential

When Event Viewer records an event involving a credential, such as granting or denying
access, a qualifier operator can review the credential from within this module.
To display a credential:
1. From Event Viewer, right click on the event in question.
2. Select Display Credential from the pop-up list.
The badge template associated with the credential holder appears.
The credential only appears if you have selected a badge template under console
preferences.

Event Viewer: Showing Statistics

If Event Viewer scrolling is paused, events that would otherwise be displayed are
instead saved to a buffer. The number of events in the buffer will continue to increase
until scrolling is resumed. Once you resume scrolling, all the events are released into
the event viewer simultaneously and appear on the screen.

902 How To Use Event Viewer

 MAN006-0612

To display the event queue statistics:

1. Right click on an event in the Event Viewer.
A list of options pops up.
2. Select to check Show Statistics.
The Buffer Count and Events Last Second statistics appear beneath the Event
Viewer as shown in the following example:

This dialog box includes these fields:

Buffer Count While Suspend Scrolling is checked, the events that

would be displayed in the Event Viewer are instead
saved in the buffer. As more events arrive while
scrolling is suspended, the Buffer Count continues to
increase in this field until Suspend Scrolling is
unchecked. At that point, all events are dumped into
the Event Viewer and normal activity is resumed.

Events Last Second This indicates how many events are sent to the Event
Viewer grid in the last second. This statistic includes
both real-time and buffered events.

3. If you no longer want to view this information, uncheck Show Statistics from the
pop-up option list.

Event Viewer: Changing Event Colors

Events appearing in the Event Viewer appear in predefined colors. For example, Alarms
are red and Port events are green. You can change the colors these events display as
well as the colors of the Event Viewer itself using the Colors property sheet on the
Event Viewer Properties dialog box.
To change colors of both events and the viewer:
1. Right click anywhere within the Event Viewer screen. A pop-up option list appears.
2. Select Properties from this option list.
The Event Viewer Properties dialog box appears.
3. Locate the Colors section on the Event Viewer Properties General page.
4. To change the appearance of the Event Viewer itself:
a. From the 'Event Viewer Colors' combo box, select the Viewer attribute whose
color you want to change. Select from BackColor (Viewer background),
ForeColor (the Viewer foreground), and the SuspendBackColor (the color the
Viewer's background becomes when Suspend Scrolling is imposed). The current
color assigned to this attribute appears in the color cell to the left of the combo
box.

How To Use Event Viewer 903

Velocity Version 3.1 Administrator’s Guide

b. Click the color cell and the Color dialog box appears. For more on this, refer to
“Color Dialog Box” on page 588.
c. Assign a different color to this attribute by clicking the color cell you want.
d. To define a custom color, click the Define Custom Colors button and the Color
Palette appears (see page 588). Create a color as required. When you're
finished, click OK. The new color is applied to the selected attribute.
5. To change the color of an event type:
a. From the 'Event Colors' combo box, select the event type whose letter color you
want to change.
Select from any of these event types: Alarm, External, Internal, Misc, Port,
Programming, Software Transaction, System Transaction, or XBox. The color
currently assigned to that event type appears in the color cell to the left of the
combo box.
b. Click the color cell and the Color dialog box appears.
c. Assign a different color to this type by clicking the color cell you want.
d. To define a custom color, click the Define Custom Colors button and the Color
Palette appears. Create a color as required. When you're finished, click OK. The
new color is applied to the selected event type.
6. Change as many color attributes as you require using steps 4 and 5.
7. When you're finished, click OK to return to the Event Viewer.

Event Viewer: Copying to Clipboard

Use this feature to paste selected event entries from the Event Viewer into another
program, such as a text editor or e-mail program.
To copy specified events to the clipboard:
1. Right click on one or more events.
Use Ctrl + click to select a non-contiguous group of entries. Use Shift + click to
select a contiguous range of entries.
2. From the pop-up options list, select Copy to Clipboard.
3. Open another program that can accept a clipboard entry, such as a text editor,
word processor, or E-mail agent.
4. Paste (Ctrl + V) the event text into the program as required.

904 How To Use Event Viewer

 MAN006-0612

Filter Groups
Filter groups are predefined combinations Event Viewer can use to sort what events are
actually shown. Filter groups can sort by one or more system components. Only
specified components or event types are displayed on the Event Viewer.

Creating Filter Groups

To create filter groups:
1. Right click anywhere on the Event Viewer screen.
A pop-up option list appears.
2. Select Custom Filter... from the list.
The Event Viewer Properties sheet appears.
3. Click on the Filters tab.
The Filters properties page appears.
4. At the 'Filter Group' field, select <New> from the drop-down option list.
The Filter Builder section is activated.
5. In the 'Filter Group' text field, enter a new name for this filter group.
6. Click either the ‘Limit the Display to only the following’ or the ‘Exclude from the
Display the following’ radio buttons.
This determines whether the elements you are about to define in the Filter Builder
window are displayed or are excluded from display.
7. In the Filter Builder window, select the components/elements you need to either
include or exclude (depending upon your selection in Step 5).
8. Click Add.
The new filter appears in the Filters window like the example below:

9. To add more filters, repeat steps 6 - 8.

10. When you're finished, click Save and the criteria for the new filter are saved.
11. To create more filter groups, repeat Steps 5 - 10.
12. When you're finished, click OK.

Editing Filter Groups

Once a filter group exists, you can edit its current settings using this procedure.
To edit a filter group:

Filter Groups 905

Velocity Version 3.1 Administrator’s Guide

1. Right click anywhere on the Event Viewer screen.

A pop-up option list appears.
2. Select Custom Filter... from the list.
The Filters property sheet appears.
3. Click the Filters tab.
The Filters properties page appears.
4. From the 'Filter Group' combo box, select the predefined filter group you need.
The filtering criteria for that filter group appear in the Selected Filters window.
5. Edit the existing values as required.
6. When you're finished, click Save.
7. Click OK to return to Event Viewer.

Selecting a Filter Group

Once you have defined one or more filter groups, you can select one to filter the
events displayed in the Viewer.
To select a filter group:
1. Right click anywhere on the Event Viewer screen.
A pop-up option list appears.
2. Select Custom Filter... from the list.
The Event Viewer property sheet appears with the Filters page displayed (page
910).
3. From the 'Filter Group' combo box, select the predefined filter group you need.
The filtering criteria for that filter group appear in the Selected Filters window.
4. Click OK to confirm your selection and return to Event Viewer.
Event Viewer uses the filter group to display only those events you require.

Filtering Events by Type

Sometimes an operator only wants to see a particular type of event on the screen. For
example, if you only want to view programming events, you can filter events on the
Event Viewer screen using this feature.
For more complex filtering criteria, refer to “Creating Filter Groups” on page 905.
To filter by a single event type:
1. Right click anywhere within the Event Viewer screen.
A pop-up option list appears.
2. Select Filter Events By Type.
A sublist appears to the right of this.
3. Select a specific event type from the list.
All other event types disappear from the screen.
To see all events, simply specify All in the sublist.
You can be still more specific about which events are displayed, by defining and
assigning Filter Groups.

906 Filter Groups

 MAN006-0612

Event Viewer Properties

You can change many aspects of Event Viewer's appearance and function using the
Event Viewer Properties dialog box.
To do this:
1. Right click anywhere within the Event Viewer screen.
A pop-up option list appears.
2. Select Properties... from this list.
The Event Viewer Properties dialog box appears as described in “Event Viewer
Properties Dialog Box” on page 907.
3. Make changes to these property sheets as required.
To change:
• the column order, go to the Column Headers section on the General page.
• the colors that each alarm type displays, go to the Colors section on the
General page.
• the number of lines that appear on this Viewer, go to the Options section on
the General page.
• the redraw rate used by the Event Viewer
• filtering properties, go to the Filters page.
4. When you're finished, click OK to confirm your changes and return to the Event
Viewer.

Event Viewer Properties Dialog Box

The Event Viewer Properties dialog box consists of four tabbed property sheets:
 General
 Filters
Each is described below.
The bottom of both pages have these buttons:

Help Click this button to bring up the relevant Velocity help page.

Restore Click this button to return to factory defaults. This includes:

• New events listed at top of list with maximum lines reverting to
100
• Filter Groups set back to <None>
• Colors revert to Velocity defaults
• Column headers and order revert to Velocity defaults
You must close Event Viewer and reopen it again before the factory
defaults appear.

OK Click this button to save any changes you've made and return to the
Event Viewer screen.

Cancel Click this button to ignore any changes and return to the Event Viewer
screen.

Event Viewer Properties 907

Velocity Version 3.1 Administrator’s Guide

General Property Sheet

The General property sheet looks like this example:

The General property sheet displays these fields:

Options

Maximum Enter the maximum number of lines Event Viewer can display
lines to display at any given time. When Event Viewer reaches the maximum
number, the newest event overwrites the oldest event.
The maximum is 1500 lines.

Redraw Rate in Enter the number of milliseconds required to redraw the

ms. screen.
The event viewer waits the number of milliseconds specified to
redraw itself as events come in. If set to a low number, such as
1 ms., the event viewer redraws the screen in real time,
instantly entering each new event as it comes in. If you set this
number to something larger, such as 1000 ms. (one second),
the event viewer only redraws itself once a second. This means
that no matter how many events are polled in that interval,
Event Viewer redraws every second; if 234 events are
registered in that second, all 234 events would appear in the
event viewer.
This feature was made for sites with a high number of
events/second and slower computers. For systems that have
relatively few events per second coming in or fast computers,
this number is essentially meaningless.
The default is 40 ms.

908 Event Viewer Properties

 MAN006-0612

Load cached Check this box to populate Event Viewer with the number of
events on start lines specified in the “Maximum lines to display” value, when
Event Viewer starts up. If the “Maximum lines to display” value
is large, it can take a while for Event Viewer to start up.
If this checkbox is not checked, Event Viewer is not
pre-populated on load and you will only see new events as
they occur while Event Viewer is open.

Display new Check this box to see the new events at the top of the list. If
events at top cleared, Event Viewer displays new events at the bottom of the
of list list.

Colors

Event Viewer This combo box lists all current color settings for the Event
Colors Viewer including background color (BackColor), foreground
color (ForeColor), and suspend background. The suspend
background color appears only when you suspend scrolling.
When you select one of these attributes from the drop-down
list, the current color for that attribute appears in the color box
to the left of the option. To change this, click the color box and
the color palette appears. Select one of the available colors.

Event Colors This combo box lists all current color settings for each event
type recognized by Event Viewer.
When you select one of these attributes from the drop-down
list, the current color for that attribute appears in the color box
to the left of the option. To change this, click the color box and
the color palette appears. Select one of the available colors.
For more on this, see Changing Event Colors.

Columnheaders

Check an item Check one or more of the items in this window to display the
to enable that selected column(s) in the Event Viewer. If unchecked, that
column column will not appear when the Event Viewer is opened.
Available items include:
• Host Time
• Description
• Address
• Event Type
• Event ID
• Controller Time

Move Up Press this button to move the selected column up one position
in the list. This effectively moves the selected column one
position to the left in the Event Viewer.

Move Down Press this button to move the selected column down one
position in the list. This effectively moves the selected column
one position to the right in the Event Viewer.

Event Viewer Properties 909

Velocity Version 3.1 Administrator’s Guide

Filters Property Sheet

The Filters tab on the Event Viewer properties sheet looks like this example:

The Filters property sheet is also displayed by selecting the Custom Filters... option
from the pop-up menu.
The fields and values seen on this page are:

Filter Group Click in this combo box and either select one of the currently
defined groups or enter the name of a new filter group.
The default is <None>. The create a new one, select
<New>.

Limit the Click this radio button to limit the display for this Filter Group
Display to only to the filter elements selected below.
the following:

Exclude from Click this radio button to exclude from display for this Filter
the Display the Group all the filter elements selected below.
following:

Save Click this button to save the currently displayed Filter Group
with the filters.

Delete Click this button to delete the currently displayed Filter Group.
This group will be erased.

910 Event Viewer Properties

 MAN006-0612

Filter Builder Use the seven combo boxes in this section to define those
elements which the displayed Filter Group uses to filter
information. The filter types are:
• Security Domain—the domain on which this system is
running
• Port—the Velocity port to which the system is connected
• XBox—the XBox Event Viewer should use to filter
• DIGI*TRAC—the controller Event Viewer should filter
• Event—the event type Event Viewer should use to filter
Use one or more of these fields (up to a maximum of seven
fields) as filtering elements. Simply click in the combo box and
select an element from the pull-down list. Each element must
be previously defined.
If you select the default, <Any>, the Filter Group can accept
any value of this type.

Add Click this button to include the selected elements into the
definition for the displayed Filter Group.
The filtering elements appear in the Select Filters window.

Selected Filters When you click the Add button, a description of the new Filter
window Group is displayed in this window.

Delete Click this button to delete a selected filter description from the
Selected Filters window.

Event Types
The types of events generated by the DIGI*TRAC/Velocity engine:

Event Type Event ID Range Description

Software 1001 - 1099 An event generated by software.

The Customization Manager contains a
complete list of software events
recognized by Velocity.

Transaction 2001 - 3999 An event that occurs when someone

uses an attached reader.
The Customization Manager contains a
complete list of transaction events
recognized by Velocity.

External 4001 - 4099 An event recorded at the attached

device. (Many of these are RTNs.)
The Customization Manager contains a
complete list of external events
recognized by Velocity.

Event Viewer Properties 911

Velocity Version 3.1 Administrator’s Guide

Event Type Event ID Range Description

Alarm 5001 - 5999 An event that triggers an alarm, such as a

DOTL or entry delay error.
The Customization Manager contains a
complete list of alarm events recognized
by Velocity.

Communication 7001 - 7099 An event that involves a connection

between a connected peripheral device
(such as an XBox, controller, or modem)
and the Velocity server.
The Customization Manager contains a
complete list of communication events
recognized by Velocity.

Miscellaneous 8001 - 8499 An event that does not fit into any other
category.
The Customization Manager contains a
complete list of miscellaneous events
recognized by Velocity.

Port 8501 - 8599 Events specific to the port, such as a

socket or port offline error.
The Customization Manager contains a
complete list of port events recognized
by Velocity.

Internal 9001 - 9099 An event recorded within the device,

such as a time zone change or a
database correction.
The Customization Manager contains a
complete list of internal events
recognized by Velocity.

A full list of events recognized by Velocity can be found in the Customization Manager.
For more on this, refer to “How To Use Customization Manager,” starting on page 678.

912 Event Viewer Properties

 MAN006-0612

Examples
Velocity is designed to take advantage of the complete Hirsch DIGI*TRAC feature set.
The following examples show you how to incorporate advanced security features into
your Velocity configuration.
Examples and discussions are liberally borrowed from the lectures and teachings of
C.D. Boston Baden, Hirsch's resident firmware wizard and the uncontested Master of
DIGI*TRAC.
In order to run these examples, first create the basic configuration as detailed in “Basic
Example” on page 914.

913
Velocity Version 3.1 Administrator’s Guide

Basic Example
For our tests, we have an M2 (set to address 1) and an M8 (set to address 2)
hardwired to an XBox. We have DTLMs or MELMs with switches for door, tamper, and
alarm. These can be either wired to each door or wired to plugs that plug into each
door.
Basic Setup: Step 1 - Controllers
1. In the system tree pane, open Configuration.
2. In the system tree pane, open DIGI*TRAC Configuration.
3. Select the XNET folder.
4. In the components pane, double-click Add New XNet Port.
The Port Properties screen appears.
5. In the Port Properties window, enter Port in the 'Port Name' text box.
6. In the 'Port Settings' box, select the correct COM port for your XBox.
We use COM 1.
7. Make sure your baud rate is correct. We use 38400.
8. Click OK.
9. In the system tree pane, select Port.
10. In the components pane, double-click Add New XBox.
An untitled XBox Properties screen appears.
11. In the XBox Properties window, rename New XBox to XBox in the 'XBox Name' text
box.
12. Click OK.
13. In the system tree pane, select XBox.
14. In the components pane, double-click Add New Controller.
An untitled Controller Properties screen appears.
15. On the 'Controller Name' text box, type M2.
16. In the 'Address' box, leave the selection at <next available> or select 1.
17. Select M2 from the 'Model' combo box option list.
18. Click OK.
19. In the component pane, double-click Add New Controller.
An untitled Controller Properties screen appears.
20. In the 'Controller Name' text box, type M8.
21. In the 'Address' box, leave the selection at <next available> or select 2.
22. Select M8 from the 'Model' combo box option list.
23. Click OK.
Basic Setup: Step 2 - Standard Control Zones
1. Display the M8 controller in the system tree pane.
2. Right click M8.
3. Select Properties.
The Controller Property sheet is displayed.
4. Click the Control Zones tab.
The Control Zones page is displayed.
5. Click Edit Control Zones.
The Control Zones Properties screen appears.

914 Basic Example

 MAN006-0612

6. Click the SCZ#1 - Time Zone cell. A down arrow appears.

7. Click the down arrow.
8. Select <Always>.
The following columns are relays.
9. Click to check boxes 1 through 8.
An x appears in each box.
10. Click OK.
11. Click OK.
Basic Setup: Step 3 - Doors and Readers
1. Display the M2 in the system tree pane.
2. Expand M2 to reveal the components including Doors.
3. Double click Doors.
All the currently defined doors appear in the components pane.
4. Double click Door 1.
Be careful not to click in the box to the left which will unbundle the door. The Door
Properties screen appears.
5. On the General page, select the Entry & Exit Readers option.
6. Click the Input tab to display the Input page.
7. In the 'Line Module' drop-down window, select DTLM3.
8. Click OK.
9. Repeat steps 4 - 8 for Door 2 on the M2.
10. Repeat steps 1 - 8 for Doors 1- 8 on the M8.
Basic Setup: Step 4 - Door Groups
1. In the system tree pane, expand the tree to reveal the Velocity Configuration folder.
2. Expand to reveal the Door Groups folder. All currently defined door groups appear
in the components pane.
3. In the component pane, double click Add New Door Group.
The Door Group Properties screen appears.
4. In the 'Door Group Name' text box, enter All.
5. From the Time Zone combo box, select <Always>.
6. In the system tree window, expand until the M2 controller appears:
• Double click XNET.
• Double click Port.
• Double click XBox.
• Double click M2.
All the currently defined doors appear in the right pane.
7. In the right pane, click to check the box associated with each door you want to
select. We are selecting all of them so click the Select All button.
8. Click the Add button.
All selected doors appear in the lower window.
9. In the system tree pane, expand until the M8 controller appears.
10. In the right pane, check each door associated with this controller. We are selecting
all of them so click the Select All button.
11. Select the Add button.
All selected doors appear in the lower window.

Basic Example 915

Velocity Version 3.1 Administrator’s Guide

12. Click OK.

Basic Setup: Step 5 - Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. In the left pane, click Add New Person.
The Personal Information form appears.
3. In the Name text box, enter Mike Conner.
4. Click Apply.
5. From the credentials pane above the Personal Information form, double click Add
New Credential.
The Credential dialog box appears.
6. In the 'PIN' text box, enter 1111.
7. In the 'Duress Digit' box, select 9.
8. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
9. Click Add...
The Define Function dialog box appears.
10. From the 'Function Category' combo box, select Access.
11. From the 'Function' combo box, select Momentary.
12. From the 'Door Group' combo box, select All.
13. Click OK.
14. Repeat steps 2 - 12 for Rose Sayer.
Assign her PIN 2222.
15. Repeat steps 2 - 12 for these other users:

Credential
Add New
General Tab Function Tab
Person
IDF PIN Duress MATCH Door Group
Digit Code

Edith Bunker 1 111 9 Deny duress

Marian 1 222 9 Deny duress

Cunningham

Emily 3 333 19000527 Code tamper disables

Baldwin

Kris Munroe 3 444 18934991 Code tamper disables

Jamie 2 03984631 Custom card

Summers

Mike Conner 1 1111 9 Door Group

Rose Sayer 1 2222 9 Door Group

16. Exit the Enrollment Manager.

916 Basic Example

 MAN006-0612

List of Examples
Once you’ve completed this, continue with these specific examples:

Example Refer to:

Absentee Rules page 927

Access Per Reader page 918

Alarm Functions page 920

Code Tamper Disables Credential page 990

Code Tamper Disables User page 990

Control Zone Triggers on Secure page 925

Credential (User) Management Options page 927

Custom Card Codes page 932

Deny Under Duress page 987

Enroll a PIV smart card page 936

Enroll a DoD CAC smart card page 940

Duress without Access page 987

Extended Access page 951

Global User Management page 931

Globalized Master Control Zones page 956

Holidays page 962

Latch Monitor Feature page 972

Long PINs page 974

Man Trap page 976

Passback page 943

Print ACBs Not At Default page 983

Quarter-Second Relay Times page 984

ScramblePad Options page 986

Silent Code Tamper page 987

Threat Levels page 997

Two-Person Rule page 980

Who’s Inside page 999

Another example is described in “VIO Example” on page 637.

Basic Example 917

Velocity Version 3.1 Administrator’s Guide

Example: Access Per Reader

This example shows how to set up a door that is always accessible on one side and
accessible only during certain hours on the other side. This is particularly useful when a
door needs to be entered only during business hours but it can be exited at any time.
The following tests will not work without the Basic Setup.
Step 1 - Time Zone
1. In the system tree pane, expand the Velocity Configuration until the Time Zones
folder appears.
2. Click to highlight the Time Zones folder.
The available time zone folders appear in the Components pane.
3. In the Components pane, double click the Standard Time Zones folder.
The Standard Time Zone property sheet appears.
4. Click the icon, press Ctrl + N, or select File > New from the Time Zone
Properties menu tool bar.
The Choose Name dialog box appears.
5. In the 'Choose Name' text box, enter Access Zones per Reader.
6. Click OK.
7. In the 'Start' column, highlight the hour (00).
8. Enter 12.
9. In the 'End' column, highlight the hour (00).
10. Enter 14.
11. Place a check in each column day column: M, T, W, T, F, S, S.
12. Click the Save icon, .
13. Close the Standard Time Zones window.
Step 2 - Door Group
1. In the system tree pane, select Door Groups.
2. In the component pane, double click Add New Door Group.
The Door Group Properties dialog box appears.
3. In the 'Door Group Name' text box, enter Access Zones per Reader.
4. In the 'Doors' combo box in the 'Time Zones' section, click on the down arrow.
5. Select Access Zones per Reader.
6. In the system tree window that appears below the 'Time Zones' section, expand
the XNET folder to the controller level: XNET > Ports > XBox > M8.
7. Double click M8.
8. Check 1 Door 01-Entry.
9. Click Add.
10. In the 'Doors' combo box in the 'Time Zone' section, click on the down arrow.
11. Select <Always>.
12. Check 9 Door 01-Exit so the person can exit at any time.
13. Click Add.
14. Click OK.
Step 3 - User
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.

918 Example: Access Per Reader

 MAN006-0612

2. From the left pane, select Add New Person.

The Personal Information form appears.
3. In the 'Name' fields, enter Jessica Medlicott.
4. Click Apply.
5. In the credentials pane, double click Add New Credential.
The credentials properties dialog box appears.
6. In the 'PIN' text box, enter 1445.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Access.
10. In the 'Function' combo box, select Momentary.
11. In the 'Door Group' combo box, select Access Zones per Reader.
12. Click OK in the Define Function window.
You are returned to the Function page.
13. Click OK to close the Credential properties.
14. Close the Enrollment Manager window.
Step 4 - Test
1. At Reader 9 on the M8, enter PIN 1445.
Access is granted.
2. At Reader 1 on the M8, enter PIN 1445.
If it is between the hours of 12 and 2, access is granted. If it is not between the hours
of 12 and 2, Access is denied: Access Zone.

Example: Access Per Reader 919

Velocity Version 3.1 Administrator’s Guide

Examples: Alarm Functions

The three following alarm functions are available to credentials. The last two are also
now available in Master Control Zones.

Pre-Arm Status Upon entering a 'Pre-Arm Status Code' or PIN code with a
(Test if Secure) 'Pre-Arm Status' function group extension, a ScramblePad:
Flashes Green LED twice if ALL inputs in Standard Control Zone
(SCZ) are secure.
Flashes Red LED and beeps if ANY inputs in the SCZ are active,
generating one flash/beep for each input active.
For more on this, refer to “Example: Pre-Arm Status” on page
922.

Conditional Unmasking will occur if and only if ALL specified inputs are
Unmask secure.
For more on this, refer to “Example: Conditional Unmask” on
page 922.

Partial Unmasking will occur for ANY specified inputs that are secure.
Unmask When entered as a 'Partial Unmask' Code or PIN Code with
'Partial Unmask' function group extension on a ScramblePad,
the ScramblePad flashes both its red and green LEDs if some
inputs are secure and some are not.
For more on this, refer to “Example: Partial Unmask” on page
923.

These functions work with all ID formats (IDFs). One advantage of using a
ScramblePad as described above would be to use these features via a Function Group
code extension. But you could just as easily program a card-only user to do one of
these functions.
Before you can use any of these examples, perform Basic Setups. The Alarm Panel
features have some setups in common. We will set those up before proceeding to the
individual tests. Once the basic setups are completed, perform these steps:
Step 1 - Hardware
If you do not have DTLM/MELMs set up, go to “Basic Setup: Step 3 - Doors and
Readers” on page 915.
1. Make sure that you have at least one alarm input attached to the M8 at Door 1.
2. Make sure that you have at least one alarm input attached to the M8 at Door 2.
Step 2 - Users
1. Open the Enrollment Manager.
The Enrollment Manager main screen appears.
2. Click Add New Person in the left pane.
The Personal Information form appears in the lower right.
3. In the 'Name' fields, enter Christine Drayton.
4. Click Apply.
5. In the Credentials window above the Personal Information pane, double-click Add
New Credential.

920 Examples: Alarm Functions

 MAN006-0612

The Credential Properties dialog box appears with the General property sheet
displayed.
6. In the 'PIN' text box, enter 1412.
7. Select the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. From the 'Function Category' combo box, select Alarm.
10. From the 'Function' combo box, select Mask.
11. From the 'Controller' combo box, select M8.
12. From the 'Control Zone' combo box, select SCZ 6.
13. Click the Add button.
14. Click OK in the Define Function dialog box.
You are returned to the Function property sheet.
15. Click OK again to close Credential properties.
16. In the Credentials window, double click Add New Credential.
17. In the 'PIN' text box, type 1413.
18. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
19. Click Add...
The Define Function dialog box appears.
20. From the 'Function Category' combo box, select Alarm.
21. From the 'Function' combo box, select Unmask.
22. From the 'Controller' combo box, select M8.
23. From the 'Control Zone' combo box, select SCZ 6.
24. Click the Add button.
25. Click OK in the Define Function dialog box.
You are returned to the Function property sheet.
26. Click OK again to close Credential properties.
27. Close Enrollment Manager.
Step 3 - Control Zone
1. From the system tree window, open the DIGI*TRAC Configuration to the controller
level.
2. Right click M8.
3. Select Properties.
4. Select the Control Zones tab.
5. Click Edit Control Zones.
6. Click the cell that intersects row the SCZ#6 row with the Time Zone column.
A down arrow appears.
7. Select <Always>.
8. Click in associated relays 1 and 2.
An x appears in each box you click.
9. Click OK.
10. Click OK again.

Examples: Alarm Functions 921

Velocity Version 3.1 Administrator’s Guide

Example: Pre-Arm Status

Step 1 - Users
If you haven't already defined the user Christine Drayton, go to Alarm Features, Step 2
- Users.
1. Open Enrollment Manager.
The Enrollment main screen appears.
2. In the left pane, select Christine Drayton.
3. In the credentials pane, double click Add New Credential.
The Credentials dialog box appears with the general property sheet displayed.
4. In the 'PIN' text box, enter 1414.
5. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
6. Click Add...
The Define Function dialog box appears.
7. From the 'Function Category' combo box, select Alarm.
8. From the 'Function' combo box, select Pre-Arm Status.
9. From the 'Controller' combo box, select M8.
10. From the 'Control Zone' combo box, select SCZ 6.
11. Click the Add button.
12. Click OK at the Define Function dialog box.
You are returned to the Function property sheet.
13. Click OK again to close Credentials properties.
14. Close Enrollment Manager.
Step 2 - Test
Make sure the door switches are in the closed position.
1. At Reader 1 on the M8, enter PIN 1414.
A Pre-Arm Status is granted. The green LED on the ScramblePad flashes. All the
alarms in SCZ 6 are secure.
2. Open Door 1.
Velocity reports a forced door.
3. At Alarm Viewer, acknowledge the alarm.
4. At Reader 1, enter PIN 1414.
Pre-Arm Status is denied. The green and red LEDs on the ScramblePad flash.
Alarm 1 is active.
5. Close Door 1.

Example: Conditional Unmask

Step 1 - Users
If you haven't already defined the user Christine Drayton, go to Alarm Functions, “Step
2 - Users” on page 920.
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. From the left pane, select Christine Drayton.

922 Examples: Alarm Functions

 MAN006-0612

3. Double click Add New Credential in the credentials pane.

The Credential Properties dialog box appears with the general property sheet
showing.
4. In the 'PIN' text box, enter 1415.
5. Select the Function tab.
The function property sheet appears with the Function(s) radio button selected.
6. Click Add...
The Define Function dialog box appears.
7. From the 'Function Category' combo box, select Alarm.
8. From the 'Function' combo box, select Conditional Unmask.
9. From the 'Controller' combo box, select M8.
10. From the 'Control Zone' combo box, select SCZ 6.
11. Click the Add button.
12. Click OK at the Define Function dialog box.
You are returned to the Function property sheet.
13. Click OK again to close Credentials properties.
14. Close Enrollment Manager.
Step 2 - Test
1. Open and close Door 1 on the M8.
The alarm will go off, indicating that forced entry has been attempted at Door 1.
2. In Alarm Viewer, acknowledge the alarm.
3. At Reader 1, enter PIN 1412.
Doors 1 & 2 are now masked.
4. Open Door 1.
Velocity does not report entries at a masked door.
5. At Reader 1, enter PIN 1415.
The green and red LEDs on the ScramblePad flash. Conditional Unmask is denied.
Alarm 1 is active.
6. Close Door 1.
7. Enter PIN 1415 at Reader 1.
The green LED on the ScramblePad flashes. Conditional Unmask is granted. All the
alarms in SCZ 6 are secure.
8. Open and close Door 1.
The alarm will go off, indicating that forced entry has been attempted at Door 1. Use
the blue check mark, , to silence the alarm.

Example: Partial Unmask

Step 1 - Users
If you don't already have the user Christine Drayton defined, go to Alarm Features, Step
2 - Users on page 920.
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. From the left pane, select Christine Drayton.
3. In the credentials pane, double click Add New Credential.

Examples: Alarm Functions 923

Velocity Version 3.1 Administrator’s Guide

The Credentials dialog box appears with the general property sheet displayed.
4. In the 'PIN' text box, enter 1416.
5. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
6. Click Add...
The Define Function dialog box appears.
7. From the 'Function Category' combo box, select Alarm.
8. From the 'Function' combo box, select Partial Unmask.
9. From the 'Controller' combo box, select M8.
10. From the 'Control Zone' combo box, select SCZ 6.
11. Click the Add button.
12. Click OK at the Define Function dialog box.
You are returned to the Function property sheet.
13. Click OK again to close Credentials properties.
14. Close Enrollment Manager.
Step 2 - Test
1. Open and close Door 1 on the M8.
The alarm will go off, indicating that forced entry has been attempted at Door 1.
2. In Alarm Viewer, acknowledge the alarm.
3. At Reader 1, enter PIN 1412.
Doors 1 & 2 are now masked.
4. Open Door 1.
Velocity does not report entries at the masked door.
5. At Reader 1, enter PIN 1416.
The green and red LEDs on the reader flash because alarm 1 is active. Partial
Unmask is granted.
6. Close and open Door 1.
Door 1 is still masked, and Velocity does not report entries at the masked doors.
7. Open and close Door 2.
The alarm sounds indicating that forced entry has been attempted at Door 2.
8. At the Alarm Viewer, acknowledge the alarm.
9. Close the Door 1.
10. At Door 1, enter PIN 1416 to partially unmask Door 1 and 2.
The green LED flashes. Partial Unmask is granted.

924 Examples: Alarm Functions

 MAN006-0612

Example: Control Zone Triggers on Secure

Step 1 - Hardware
If your controller does not have a box tamper switch plugged into it, get a paper clip.
Bend it into a U-shape.
Step 2 - Control Zone
1. In the system tree pane, open DIGI*TRAC Configuration tree to the controller level.
If anything up to this point is not set up, go to the setup instructions for Controller.
2. Right click M8.
3. Select Properties.
The M8 Properties sheet appears.
4. Click the Control Zones tab.
The Control Zones property sheet appears.
5. Select Edit Control Zones.
The Control Zone Properties screen appears.
If Control Zone 1 is not yet define, go to the setup instructions for Standard Control
Zones.
6. On the Standard Control Zones property sheet, click the cell that intersects the
SCZ#9 row with the time zone column.
A down arrow will appear.
7. Click the down arrow.
8. Select <Always>.
The next columns with numbers along the top are the relays.
9. Click in relay box 1, 3, 5, and 7.
An x will appear in each box that you click.
10. Click OK.
11. Click OK.
Step 3 - Alarm Actions
1. Right click M8.
2. Select Properties.
The M8 Controller Properties screen appears.
3. Select the Alarm Actions tab.
The Alarm Actions page appears.
On the left side of the window is a column of ACB numbers. On the right side of
the window is a scrollbar.
4. Scroll down to ACB 76 - Enclosure Tamper.
At the bottom of the window is another scrollbar.
5. Scroll right until you can see TriggerCZ and CZOff at the top of the columns.
6. Click on the cell that intersects column TriggerCZ and row ACB 76.
A down arrow will appear.
7. Click the down arrow.
8. Scroll down and select 9 SCZ9.
9. Click on the cell that intersects column CZOff and row ACB 76.

Example: Control Zone Triggers on Secure 925

Velocity Version 3.1 Administrator’s Guide

A down arrow will appear.

10. Click the down arrow.
11. Scroll down and select 1 SCZ1.
12. Click OK.
Step 4 - Test
If you have a box tamper switch on your controller, toggle it. If you don't have a box
tamper switch, you will be using a bent paper clip. Touch the two ends of the bent
paper clip to the two right Box Tamper plug posts located above the printer plug on the
M8.
When Velocity reports Enclosure Tamper, Relays 1, 3, 5 and 7 on the M8 will turn on
for 6 seconds.
When Velocity reports Enclosure Secure, Relays 1-8 on the M8 will turn on for 6
seconds.

926 Example: Control Zone Triggers on Secure

 MAN006-0612

Examples: Credential (User) Management

 While DIGI*TRAC refers to this feature as User Management, Velocity
uses the term Credential Management.
Velocity supports four types of credential management:

Absentee If the user has not been granted access within the absence
Rule tolerance limit, the user's access privileges will be expired. The
range is 1 - 255 days.
For more on this, refer to “Example: Absentee Rules” on page
927. For still more, refer to Absentee Limiting.

Day Limiting The user's access privileges expires when the temporary days
limit is reached. The range is 1 - 255 days.
For more on this, refer to “Example: Day Limiting” on page 929.

Use Count The user's access privileges expires when the use limit is
reached. The range is 1 - 255 uses.
For more on this, refer to “Example: Use Count” on page 930.

Global User The Absentee Rule, Temporary Days, and Use Count Limits can
Management be applied globally to all controllers connected to the same XBox,
and it can be applied on a per user (credential) basis. Only one
of the three limits can be used per user (credential). This feature
is made available as a result of the Common User Number
implementation.
Global user management requires XBox Version 3.07 or later.
There is a setting on the controller to allow the controllers and
XBox to globalize when the host is disconnected from the
network. There is also a setting per user for globalization.
For more on this, refer to “Example: Global User Management”
on page 931.

Example: Absentee Rules

The smallest meaningful setting for Absentee Rule is 2 days. A setting of 2 means that
if you use the code on Monday, it'll work on Tuesday. If you don't use it on Monday, it
won't work on the second day after midnight.
The following tests will not work without the Basic Setup.
Step 1 - Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. From the left pane, click Add New Person.
The Personal Information form appears.
3. At the 'Name' fields, enter Chip Hardesty.
4. Click Apply.
5. In the credentials pane, double click Add New Credential.
The credentials dialog box appears with the general page displayed.

Examples: Credential (User) Management 927

Velocity Version 3.1 Administrator’s Guide

6. In the 'PIN' text box, enter 1421.

7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Access.
10. In the 'Function' combo box, select Momentary.
11. In the 'Door Group' combo box, select All.
If you don't have the All door group defined, go to “Basic Setup: Step 4 - Door
Groups” on page 915.
12. Click the Limits tab.
The limits page appears.
13. In the 'Day/Use/Absentee Limits' box, check 'Absentee Limiting'.
14. In the 'Day/Use/Absentee Count' field, select 1.
15. Click OK.
16. Close the Enrollment Manager window.
Step 2 - Test
1. At Reader 1 on M8, enter PIN 1421. Access is granted.
2. Change the date and time on your computer.
The date must be 2 days from the current date, so that the person is absent for
one day. The time must be just before midnight, because that's when the
controller updates the use limits. One way to do this is:
a. Right click on the time in the right hand corner of your desktop tray.
b. Select Adjust Date/Time. The Date/Time Properties window appears.
Today's date is highlighted on the calendar in the date box.
c. Click on the date two days in the future.
For example, if today is the 10th, click on the 12th.
d. In the time box below the clock, highlight and type 11 over the hour.
e. Highlight and type 58 over the minutes.
f. Close the Adjust Date/Time window.
3. Download the time to the controllers.
A simple way to do this is:
a. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
If the controller is not yet configured, go to “Basic Setup: Step 1 - Controllers”
on page 914.
b. Right click M2.
c. Select Download.
d. Select Date/Time.
e. Right-click M8.
f. Select Download.
g. Select Date/Time.
Wait for the time to change to the next day. All current users will be updated.
4. At Reader 1 on M8, enter PIN 1421.

928 Examples: Credential (User) Management

 MAN006-0612

Alarm Viewer should read: 'Access Denied: Absentee Rule'.

5. Change the date and time back, then download the correct settings.

Example: Day Limiting

Step 1 - Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. At the left pane, click Add New Person.
The Personal Information form appears.
3. In the 'Name' fields, enter Violet Venable.
4. Click Apply.
5. In the credentials pane, double click Add New Credential.
The credentials dialog box appears with the general page displayed.
6. In the 'PIN' text box, enter 1422.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Access.
10. In the 'Function' combo box, select Momentary.
11. In the 'Door Group' combo box, select All.
If you don't have the door group All set up yet, go to “Basic Setup: Step 4 - Door
Groups” on page 915.
12. Click the Limits tab.
The Limits page appears.
13. In the 'Day/Use/Absentee Limits' box, check 'Day Limiting'.
14. In the 'Day/Use/Absentee Count' field, use to select 1.
15. Click OK.
16. Close Enrollment Manager.
Step 2 - Test
1. At Reader 1 on M8, enter PIN 1422. Access is granted.
2. Change the date and time on your computer. The date must be one day after the
current date, so that the temp day we set up has expired. The time must be just
before midnight, because that's when the controller updates the use limits. One
way to do this is:
a. Right click on the time in the right hand corner of your desktop tray.
b. Select Adjust Date/Time.
The Date/Time Properties window appears.
Today's date is highlighted on the calendar in the date box.
c. Click on the date one day in the future. For example, if today is the 10th, click on
the 11th.
d. In the time box below the clock, highlight and type 11 over the hour.
e. Highlight and type 58 over the minutes.
The time should now indicate 11:58 pm.

Examples: Credential (User) Management 929

Velocity Version 3.1 Administrator’s Guide

f. Close the Adjust Date/Time window.

3. Download the time to the controllers. A simple way to do this is:
a. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
If the controller is not yet configured, go to “Basic Setup: Step 1 - Controllers”
on page 914.
b. Right click M2.
c. Select Download.
d. Select Date/Time.
e. Right-click M8.
f. Select Download.
g. Select Date/Time.
Wait for the time to change to the next day. All current users will be updated.
4. At Reader 1 on M8, enter PIN 1422.
Alarm Viewer should read: 'Access Denied: Temp Days'.
5. Change the date and time back, then download the correct settings.

Example: Use Count

Step 1 - Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. At the left pane, click Add New Person.
A new Personal Information form appears.
3. In the 'Name' fields, enter Linus Rawlings.
4. Click Apply.
5. In the credentials pane, double click Add New Credential.
A new credentials dialog box appears with the general page displayed.
6. In the 'PIN' text box, enter 1423.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Access.
10. In the 'Function' combo box, select Momentary.
11. In the 'Door Group' combo box, select All.
If you don't have door group All defined, go to “Basic Setup: Step 4 - Door
Groups” on page 915.
12. Click the Limits tab.
The Limits page appears.
13. In the 'Day/Use/Absentee Limits' box, check the 'Use Limiting' box.
14. In the 'Day/Use/Absentee Count' field, use to select 2.
15. Click OK.
16. Close the Enrollment Manager.
Step 2 - Test

930 Examples: Credential (User) Management

 MAN006-0612

1. At Reader 1 on the M8, enter PIN 1423. Access is granted.

2. At Reader 1 on M8, enter PIN 1423. Access is granted again.
3. At Reader 1 on M8, enter PIN 1423. Alarm Viewer reads: 'Access Denied. Use
Count Expired'.
Step 3 - Reset Limit Count
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. At the left pane, click Linus Rawlings.
Rawlings' Personal Information form appears.
3. In the credentials pane, right click on the 1-Keypad credential. A pop-up list
appears.
4. Select Reset Limit Count.
5. Close Enrollment Manager.
6. Repeat the test in Step 2 - Test above.

Example: Global User Management

Step 1 - Users
Use Linus Rawlings who we defined in Use Count, Step 1 - Users.
Step 2 - Pretest
1. At Reader 1 on the M8, enter PIN 1423 until Linus Rawlings' Use Count is expired.
2. At Reader 1 on the M2, enter PIN 1423. Access is granted.
Step 3 - Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. From the left pane, select Linus Rawlings.
Rawlings' personal information form appears.
3. In the credentials pane, double click the 1-Keypad credential previously defined
for Rawlings.
4. Click the Limits tab.
The limits page appears.
5. Check the 'Apply Credential Management Globally' box.
6. Click OK.
7. In the credentials pane, right click on the 1-Keypad credential.
A pop-up option list appears.
8. Select Reset Limit Count.
9. Close the Enrollment Manager.
Step 4 - Test
1. At Reader 1 on the M8, enter PIN 1423. Access is granted.
2. At Reader 1 on the M8, enter PIN 1423. Access is granted.
3. At Reader 1 on the M8, enter PIN 1423. Access Denied: Use Count.
4. At Reader 1 on the M2, enter PIN 1423. Access Denied: Use Count.

Examples: Credential (User) Management 931

Velocity Version 3.1 Administrator’s Guide

Examples: Custom Card Codes

A keypad-only credential (IDF 1) has a PIN code. A card-only credential (IDF 2) has a
Card Code (normally a MATCH code embedded in the card itself). A dual technology
credential (IDF 3) has a card code and a PIN which together are considered a dual
code (dual technology).
A standard MATCH or MATCH 2 board takes all the data from any kind of card reader
output and creates an arbitrary 8-digit MATCH code. This is then enrolled with the
credential as the user's Card Number.
Occasionally a customer will want to use a particular sequence of digits found on the
raw card as the card code, such as a credit card number or civil service employee card.
The operator can configure Velocity to recognize this raw code and convert it into the
required MATCH access code.

Example 1: Custom Card Codes

This custom card code can be 8 - 16 digits long with all digits significant.
Step 1 - Card Code Mapping
1. At the Velocity Administration window, expand the Velocity Configuration folder.
2. Select the Card Data Mappings folder.
3. In the components pane, double click the Add New Card Map option.
4. Enter the name Custom Card Code 1 in the 'Name' text box.
5. In the 'Use Customized Card Codes' section, set the numbers in the box to these
values:

Enter these numbers

6. Click OK.
7. In the components pane, double click the Add New Card Map option.
8. Enter the name Custom Card Code 2 in the 'Name' text box.
9. In the 'Use Customized Card Codes' section, set the numbers in the box to these
values:

Enter these numbers

932 Examples: Custom Card Codes

 MAN006-0612

10. Click OK.

Step 2 - Setup
1. At the Velocity Administration window, expand the DIGI*TRAC Configuration folder
until the controllers appear (XNET > Port > XBox > Controller).
2. Expand the Controller folder then the Doors subfolder to reveal Door 3.
3. Right click on Door 3 and select Properties.
4. Click the Entry Reader tab.
5. If not already selected, click on the Setup tab.
6. At the 'Custom Card Codes' box, select Custom Card Code 1 from the pick list.
7. Click OK.
8. Right click on Door 4 and select Properties.
9. Click the Entry Reader tab.
10. If not already selected, click on the Setup tab.
11. At the 'Custom Card Codes' box, select Custom Card Code 2 from the pick list.
12. Click OK.
13. Open Enrollment Manager.
14. Double click Add New Person.
15. Fill out the name and other required information.
16. Click Apply.
17. Double click Add New Credential from either the credential pane or at the
button at the bottom of the Personal Information screen.
The Credential dialog box for the new person appears.
18. From the IDF combo box, select IDF 2.
19. At the MATCH field, specify the last 8 numbers on one of your credit cards.
20. Fill out all other required information and press OK.
21. Repeat steps 18 through 21 to create a second IDF 2 credential. This time,
however, at the MATCH field, enter all the numbers of the same credit card in
reverse order.
22. Go to the MATCH board that will be handling Doors 3 and 4. Turn on DIP switch 7
as well as specifying the correct reader address (door 3 or 4) on your MATCH
reader.
 This procedure only works with readers connected to a MATCH board.
You cannot use this procedure with a MATCH-installed keypad.
Step 3 - Test
 Run your credit card through the mag stripe reader. You should be able to gain
access.

Example 2: Custom Card Codes – Long Card Codes

Velocity and CCM 7.0 allows up to 16 digits to be selected in any order from the raw
data on the card. This makes it even easier to retrofit and upgrade an existing access
control system to Hirsch. For instance, magnetic stripe cards that use a Social Security
Number for the User (credential) number can now readily be enrolled.
 This feature requires the MATCH2 (Revision K board, date coded 010327
or higher) which has been shipping since April 1, 2001.

Examples: Custom Card Codes 933

Velocity Version 3.1 Administrator’s Guide

The controller can be configured to treat all card readers the same way, or it can be set
up to have some card readers different than the others. At a particular card reader, the
same digit positions will be used for every card. For example the reader can be
configured to read the first 8 digits of an ordinary credit card, and use that as the “card
code.”
The following tests will not work without the Basic Setup. A card-only credential has a
Card Code, which will usually be a MATCH code. A MATCH board will take all the data
from any kind of card reader output and create an arbitrary 8-digit MATCH code.
In Version 7.0, we can configure the MATCH2 board and the controller's card reader
setups so that the raw card data is passed through to the DIGI*TRAC, and the CCM
creates a card code. This card code can be from 8 to 16 digits long, in any order, and all
the digits are significant.
Step 1 - Additional Hardware
 Get a standard credit card. Credit cards have a magnetic strip with numbers
embedded in them. The first 16 numbers encoded on the strip are normally the
numbers printed on the card.
 Connect a MATCH 2 with a mag stripe reader to address 10 of the M8. The MATCH
should have DIP switch 7 turned ON as well as the address. All DIP switches in the
second bank must be turned OFF.
Step 2 - Card Code Mapping
1. At the Velocity Administration window, expand the Velocity Configuration folder.
2. Select the Card Data Mappings folder.
3. In the components pane, double click the Add New Card Map option.
4. Enter the name Custom Card Code 3 in the 'Name' text box.
5. In the 'Use Customized Card Codes' section, set the numbers in the box to these
values:

Enter these numbers

6. Click OK.
Step 3 - User
1. Open Enrollment Manager.
2. From the left pane, click Add New Person.
The Personal Information form appears.
3. At the 'Name' fields, enter Scottie Ferguson.
4. Click Apply.
5. From the credentials pane, double click Add New Credential.
The Credentials dialog box appears with the general page displayed.
6. In the 'IDF' combo box, select 2-Card.

934 Examples: Custom Card Codes

 MAN006-0612

The fields in the 'Card' section is activated.

7. In the 'MATCH' text box, enter digits 1, 2, 3, 4, 5, 6, 7, 8, 15, and 16 of your credit
card.
For example, if your card number is 3865296100037048, you will enter
3865296148.
8. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
9. Click Add...
The Define Function dialog box appears.
10. In the 'Function Category' combo box, select Access.
11. In the 'Function' combo box, select Momentary.
12. In the 'Door Group' combo box, select All.
If the door group All is not yet defined, go to “Basic Setup: Step 4 - Door Groups”
on page 915.
13. Click OK.
14. Close Enrollment Manager.
Step 4 - Door
1. In the system tree pane expand the DIGI*TRAC Configuration folder to show the
controller level.
2. If the controllers are not yet defined, go to “Basic Setup: Step 1 - Controllers” on
page 914.
3. Double click M8.
All dependent components appear.
4. Click Doors.
All currently defined doors appear in the component pane.
5. In the components pane, double click Door 2.
6. Click the Exit Reader tab.
The Exit Reader Properties dialog box appears.
7. Click the Setup tab.
The setup page appears.
8. Click the 'Use Customized Card Codes' pick list and select Custom Card Code 3
from the drop-down list.
9. Click OK.
Step 5 - Test
 Run your credit card through the mag strip reader. The access is granted.
If you're having trouble with this test, double-check the DIP switches on your MATCH
board. They should be: Bank 1, SW1, 3, and 7 are ON. All other switches are OFF. Bank
2 should be all OFF.

Examples: Custom Card Codes 935

Velocity Version 3.1 Administrator’s Guide

Examples: Setting Up Smart Cards

This section discusses the enrollment of two smart card types: PIV cards and DoD CAC
cards.

Example: Enrolling PIV Cards into Velocity

To enroll a PIV card using Velocity, you must create and manage the required
user-defined fields. To do this:
Step 1: Create Enrollment Manager UDFs for PIV Cards
1. Open Velocity Enrollment Manager.
2. From the menu bar, select Tools > User Defined Fields…
3. At 'Number of UDFs' field, change the value from 36 to 50 fields then click Apply.
Fields 1 – 14 remain on the General Tab and fields 15 – 50 can be placed on a
separate TAB.
The following fields should be created:
• Name field (in Enrollment Manager under Tools > Preferences, the UDF
name parsing allows for the Name field from PIV cards to be directed to the
First and Last Name fields in Velocity)
• Employee Affiliation line 1
• Employee affiliation line 2
• Expiration Date Printed
• Agency Serial Number
• Issuer Identification
• Agency code – Change type to number
• System Code – Change type to number
• Credential Number – Change type to number
• Credential Series – Change type to number
• Individual Credential Issue – Change type to number
• Person Identifier
• Organizational Category
• Organization Identifier
• Person Organization Association Category
• Expiration Date – Change type to date
• Agency Code CHUID
• Organization Identification CHUID
Step 2: Configure Enrollment Manager Device Configuration to read PIV Card
1. From the Enrollment Manager menu tool bar, select Tools > Device
Configuration.

936 Examples: Setting Up Smart Cards

 MAN006-0612

2. Check 'Enable PIV readers(s)'.

3. From the ‘Default card type’ pick list, select FIPS 201 Contact.
4. Click the Map UDF Fields... button.
Each field to be read from card needs to be mapped to the associated field in
Enrollment Manager as shown in this example:

5. Click Apply then Close, then restart Enrollment Manager.

PIV card data can now be read right directly into Velocity as described in Step 3.
Step 3: Read PIV Card Data into Velocity
Opening Enrollment Manager produces a SCAN button to read data from the card
using a PIV-compliant Smart Card reader.
1. Click Add Person.
2. Click SCAN.
A Verify Scanner Data screen like this appears:

3. Check 'Read locked information (requires PIN)' box.

4. Click the Read PIV Card button.
Wait for the card to read. When it is completed, the data appears in the Output
window.
5. Click Accept to accept into Enrollment Manager UDF Fields.
6. Click Apply to accept into the database.
Step 4: Create a Credential that allows you to use a PIV card in Velocity
1. At the credential pane, double click Add New Credential.
The Credential properties screen appears.

Examples: Setting Up Smart Cards 937

Velocity Version 3.1 Administrator’s Guide

2. At Description field type, select PIV Access Credential.

3. Change the IDF to 2-Card.
4. Change the Card Type to Passthru.
5. Click the UDF… button.
The Concatenate UDF dialog box appears.
6. Select the number fields from which to concatenate a MATCH number and click
OK.
For a 3-digit FASCN use:
• Agency Code
• System Code
• Credential Number

For a 5-digit FASCN use:

• the above 3-digit FASCN fields, plus
• Check 'Credential Number' and 'Credential Status' boxes from the UDF fields
to produce the MATCH code
A unique MATCH number is produced.
7. Select the 'Expire' check box and click the button.
8. Choose the 'Expire on UDF Date' field and select the UDF previously established
from the PIV card.

9. From the 'On Expiration' pick list, select the desired action.
10. At the Function page, select Momentary Access and the required door group.
11. At the Limits and Options pages, supply any values you require.
Now the PIV card may be used on DS47-L-SSP-HID Readers to open doors.

938 Examples: Setting Up Smart Cards

 MAN006-0612

The PIV UDF fields in Enrollment Manager appear on a separate PIV FIPS201 tab
as shown in the following example:

12. Under Velocity Configuration, select Custom Data Mappings.

A screen like this example appears:

This displays the system setups for use with the PIV cards that are used at the door
reader setup property window as shown below:

GSA 75-bit is selected by default. You need to blank out digit 15 and 16 and then apply
the custom card code to the door properties window.
Once established, the door reader with a MATCH 061030 and the dip switch settings
set to Custom 18, 20 or 21, will now read the PIV card and allow access.

Examples: Setting Up Smart Cards 939

Velocity Version 3.1 Administrator’s Guide

Example: Enrolling DoD CAC Cards

To enroll a CAC card using Velocity, you must create and manage the required
user-defined fields. To do this:
Step 1: Create Enrollment Manager UDFs for CAC Cards
1. Open Velocity Enrollment Manager.
2. From the menu bar, select Tools > User Defined Fields…
3. At 'Number of UDFs' field, change the value from 36 to 50 fields then click Apply.
Fields 1 – 14 remain on the General Tab and fields 15 – 50 can be placed on a
separate TAB.
The following fields should be created:
• First Name
• Middle Name
• Last Name
• Cadency Name
• Person Identifier
• Date Of Birth
• Sex Category Code
• Person Identifier Type Code
• Blood Type Code
• DoD EDI Person Identifier – Change Type to Number
• Organ Donor
• ID Card Issue Date
• ID Card Expiration Date
• Date Data Load
• Date Data Expires
• Card Instance Identifier
• Card Serial Number_Octal – Change Type to Number
• Agency Code – Change Type to Number
• System Code – Change Type to Number
• Credential Number – Change Type to Number
• Credential Series
• Individual Credential Issue
• Person Identifier
• Organizational Category
• Organization identifier
• Person Organization Association Category
• Expiration Date
• Agency Code CHUID
• Organization Identifier CHUID
• DUNS
• GUID

940 Examples: Setting Up Smart Cards

 MAN006-0612

Step 2: Configure Enrollment Manager Device Configuration to read CAC Card

1. From the Enrollment Manager menu tool bar, select Tools > Device
Configuration.

2. Check 'Enable PIV readers(s)'.

3. Select the DoD CAC as the default card type.
4. Click the Map UDF Fields button.
Each field to be read from card needs to be mapped to the associated field in
Enrollment Manager as shown in this example:

5. Click Apply then Close, then restart Enrollment Manager.

CAC card data can now be read right directly into Velocity as described in Step 3.
Step 3: Read DoD CAC card data into Velocity
Opening Enrollment Manager produces a SCAN button to read data from CAC cards
(through any attached Smart Card reader that can read CAC PIV cards).
1. Click Add Person.
2. Click SCAN.
A Verify Scanner Data screen appears.
3. Check 'Read locked information (requires PIN)' box.
4. Click Read PIV Card button.
Wait for the card to read. When it is completed, the data appears in the Output
window.
5. Click Accept to accept into Enrollment Manager UDF Fields.
6. Click Apply to accept into the database.
Step 4: Create a Credential that allows you to use a CAC card in Velocity
1. At the credential pane, double click Add New Credential.
The Credential properties screen appears.
2. At Description field type, select DoD CAC Access Credential.

Examples: Setting Up Smart Cards 941

Velocity Version 3.1 Administrator’s Guide

3. Change the IDF to 2-Card.

4. Change the Card Type to Octal passthru.
5. Click the UDF… button.
The Concatenate UDF dialog box appears.
6. Select the number fields from which to concatenate a MATCH number and click
OK.
A unique MATCH number is produced.

Hint There are several types of CAC cards, including legacy CAC, CAC NG, and
PIV-compliant CAC. For most CAC cards, select the Person ID as the
number concatenated for the MATCH.

7. Select the 'Expire' check box and click the button.

8. Choose the 'Expire on UDF Date' field and select the UDF previously established
from the CAC card.

9. From the 'On Expiration' pick list, select the desired action.
10. At the Function page, select Momentary Access and the required door group.
11. At the Limits and Options pages, supply any values you require.
Now the CAC card may be used on any CAC PIV-compliant readers to open doors.
The CAC UDF fields in Enrollment Manager appear on a separate tab as shown in
the following example:

942 Examples: Setting Up Smart Cards

 MAN006-0612

Examples: Passback
There are five examples of passback provided:

Zoned There are now 63 Passback Zones supported. Zone 1 is reserved

Passback for 'outside' and Zones 2 through 63 are used for 'inside'. These
zones can be configured in any arrangement including nested
(zone within a zone) and shared zone layouts. This approach
requires that the entry and exit readers be assigned different zone
numbers.
Passback restrictions may be applied in either direction. Even
doors using only an entry reader can participate in Zoned Passback
when used in conjunction with other Passback controlled doors.

Zoned The new Passback Zones are used to enhance occupancy controls.
Occupancy Occupancy controls such as Min and Max Inside values are
Control available for each Passback Zone.
If Two-Person Rule Disable is applied to two adjoining Passback
Zones, each with the same threshold value, then each area has to
exceed the threshold to disable Two-Person Rule in either
direction.

Forgive Anti-Passback violations may be forgiven to one or more users

Passback (credentials) or to all users via a host PC command.
A reader can be set up as an “auto-forgive” reader, which will allow
a credential to be reset to a known Passback Zone condition.

Global When the XBox Version 3.07 (Rev E board) or later is used,
Passback Anti-Passback is available to globalize occupancy counts on a
Passback Zone basis and to share Passback Zones between
controllers.
Globalization requires a particular flag to be set per controller to
enable the XBox to continue passing messages between
controllers when the Host is not actively connected to the network.

Executive Select users (credentials) may be assigned an auto-forgive type

Override function which can be used as an executive override of selected
Passback rules which remain in place for all others.

Example: Zoned Passback

To set up Zoned Passback:
Step 1 - Users
If you don't have users Mike Conner and Rose Sayer set up, go to “Basic Setup: Step
5 - Users” on page 916.
Step 2 - Controller Properties
1. In the left pane of the Administration Window, open Configuration.
2. Open the DIGI*TRAC Configuration, to the controller level.
3. Right-click M8.
4. Select Properties.

Examples: Passback 943

Velocity Version 3.1 Administrator’s Guide

5. Select the Setup tab.

6. In the Options section, check Enable Global Credential Management.
7. Check 'Enable Global MCZ'.
8. Select the Passback tab.
9. In the 'On Passback Violation' box in the upper left, check 'Report'.
10. Check 'Deny Access'.
Optionally, you may check 'Generate Alarm'.
Notice the Passback Options box in the center of the page enables you to disable
passback during certain time zones.
11. Click OK.
Step 3 - Doors
1. In the left pane of the Administration window, open M8.
2. Select Doors.
3. Double-click Door 4.
4. Select the Entry Reader tab.
5. Select the Logic tab.
6. In the 'Passback Zones' section in the 'From Zone' combo box, select Zone 1 -
Outside.
7. In the 'To Zone' combo box, select Zone 2 - Inside.
8. Select the Exit Reader tab.
9. Select the Logic tab.
10. In the 'Passback Zone' box in the 'From Zone' window, pick Zone 2 - Inside.
11. In the 'To Zone' window, pick Zone 1 - Outside.
12. Click OK.
13. Double-click Door 5.
14. Select the Entry Reader tab.
15. Select the Logic tab.
16. In the 'Passback Zones' section in the 'From Zone' combo box, select Zone 2 -
Inside.
17. In the 'To Zone' combo box, select Zone 1 - Outside.
18. Select the Exit Reader tab.
19. Select the Logic tab.
20. In the 'Passback Zone' section in the 'From Zone' combo box, select Zone 1 -
Outside.
21. In the 'To Zone' combo box, select Zone 2 - Inside.
22. Click OK.
Step 4 - Test
1. Enter PIN 1111 at Door 4 on the M8. Entry access granted from zone 1 to zone 2.
2. Enter PIN 1111 at Door 4. Entry access denied: Passback.
3. Enter PIN 1111 at Door 5. Entry access granted from zone 2 to zone 1.
4. Enter PIN 1111 at Door 4. Entry access granted from zone 1 to zone 2.

Example: Zoned Occupancy Control

Step 1 - Users
If you have done any previous tests involving passback, you may need to forgive the
passback of the users.

944 Examples: Passback

 MAN006-0612

1. Go to the Controller level of DIGI*TRAC Configuration.

2. Right-click M8.
3. Select Download.
4. Select Forgive Users.
Once this is done, configure a new person for Zoned Occupancy.
5. In the Administration Window, select Configuration in the left pane.
6. Double-click Enrollment Manager in the Components pane.
If you haven't defined the users Mike Conner and Rose Sayer yet, go to “Basic
Setup: Step 5 - Users” on page 916.
7. Double click Add New Person in the left pane.
8. Type Ben McKenna in the name box of the Personal Information pane on the
lower right side.
9. Click Apply.
10. Double-click on Add New Credential in the upper right pane.
The Credential dialog box appears.
11. On the General tab in the 'PIN Code' text box, type 1419.
12. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
13. Click Add...
The Define Function dialog box appears.
14. In the 'Function Category' drop-down window, select Access.
15. In the 'Function' drop-down window, select Momentary.
16. In the 'Door Group' drop-down window, select All.
 If you don't have Door Group All set up, define the group now.
17. Click OK.
18. Select Add New Person in the left pane of the Enrollment Window.
19. Type Ethel Thayer in the name box of the Personal Information pane on the
lower right side.
20. Click Apply.
21. Double-click on Add New Credential in the upper right pane.
22. On the General tab in the 'PIN Code' box, type 1420.
23. Select the Function tab.
The function property sheet appears with the Function(s) radio button selected.
24. Click Add...
The Define Function dialog box appears.
25. In the 'Function Category' drop-down window, select Access.
26. In the 'Function' drop-down window, select Momentary.
27. In the 'Door Group' drop-down window, select All.
28. Click OK.
29. Close the Enrollment Manager window.
Step 2 - Controller Properties
1. Right-click M8.
2. Select Properties.
3. Select the Passback tab.

Examples: Passback 945

Velocity Version 3.1 Administrator’s Guide

4. On the left side of the window, in the 'On Passback Violation' section, check
'Report'.
5. On the right side of the window, check 'Report All Occupancy Violations in all
Zones'.
6. In the 'Occupancy Options Apply to this Zone' combo box, select 3.
Below Occupancy Options, there are two text boxes marked ‘Min’ and ‘Max’.
7. In the 'Max' text box, type 3.
8. At the '...Is at Maximum -1' combo box, select SCZ 1.
Optionally, you may select additional choices. For example, you could set up 'Goes
From 1 to 0' combo box to trigger SCZ2. Remember to set up additional control
zones to react to the additional choices.
9. Click OK.
Step 3 - Control Zones
If you don't have Standard Control Zone 1 set up, go to “Basic Setup: Step 2 -
Standard Control Zones” on page 914.
Step 4 - Doors
1. Double-click Door 6.
2. Select the Entry Reader tab.
3. Select the Logic tab.
4. At the 'From Zone' combo box, select Zone 2 - Inside.
5. At the 'To Zone' combo box, select Zone 3 - Inside.
6. Select the Exit Reader tab.
7. Select the Logic tab.
8. At the 'From Zone' combo box, select Zone 3 - Inside.
9. At the 'To Zone' window, select Zone 2 - Inside.
10. Click OK.

Step 5 - Test
1. Enter PIN 1111 at Reader 6. Internal Access Granted.
2. Enter PIN 2222 at Reader 6. Internal Access Granted. All the relays on the M8
come on, because the maximum occupancy is 3, and standard control zone 1 is
set to turn on when the room reaches maximum occupancy minus one, which is
2.
3. Enter PIN 1420 at Reader 6. Internal Access Granted.
4. Enter PIN 1419 at Reader 6. Internal Access Denied. Override by Max User Count.

Example: Forgive Passback

This test forgives passback for an individual user.
Step 1 - User
If you don't have user Mike Conner set up, go to “Basic Setup: Step 5 - Users” on
page 916.
Step 2 - Controller Properties
Set up Zoned Passback, Step 2 - Controller Properties on page 943.
Step 3 - Doors

946 Examples: Passback

 MAN006-0612

If you have completed the other tests, use the doors that are already set up. Otherwise:
1. In the left pane of the Administration Window, open Configuration.
2. Open DIGI*TRAC Configuration to the controller level.
3. Double click M8.
4. Double click Doors.
5. Double click Door 4.
The Door 4 Properties sheet appears.
6. Select the Entry Reader tab.
The Entry Reader properties sheet appears.
7. Select the Logic tab.
The Logic sub-sheet appears.
8. In the 'From Zone' combo box, select Zone 1 - Outside.
9. In the 'To Zone' combo box, select Zone 2 - Inside.
10. Select the Exit Reader tab.
11. Select the Logic tab.
12. In the 'From Zone' combo box, select Zone 2 - Inside.
13. In the 'To Zone' combo box, select Zone 1 - Outside.
14. Click OK.
15. Double-click Door 6.
The Door 6 Properties appear.
16. Select the Entry Reader tab.
17. Select the Logic tab.
18. In the 'From Zone' combo box, select Zone 2 - Inside.
19. In the 'To Zone' combo box, select Zone 3 - Inside.
20. Select the Exit Reader tab.
21. Select the Logic tab.
22. In the 'From Zone' combo box, select Zone 3 - Inside.
23. In the 'To Zone' combo box, select Zone 2 - Inside.
24. Click OK.
Step 4 - Test
1. At Reader 14, enter PIN 1111. Access grant.
2. At Reader 14, enter PIN 1111. Access denied. Passback.
3. Open Enrollment Manager.
4. In the left pane, click Mike Conner.
5. In the credentials pane, right click his Keypad credential.
6. Select Forgive Passback.
7. Close the Enrollment Manager window.
8. At Reader 14, enter PIN 1111. Access is granted.
Step 5 - Test Forgive Passback to All Users
If you haven't already tried forgiving passback to all users in one controller, here are the
steps to take:
1. Go to the Controller level of DIGI*TRAC Configuration folder.
2. Right click M8.
3. Select Download.
4. Select Forgive Users.

Examples: Passback 947

Velocity Version 3.1 Administrator’s Guide

Example: Executive Override

Step 1 - Users
If you have Ethel Thayer enrolled from the basic setup - add users, skip to step 12 in
this section, otherwise:
1. Open Enrollment Manager.
2. Select Add New Person in the left pane.
3. Type Ethel Thayer in the name box of the Personal Information pane on the
lower right side.
4. Select Apply.
5. Double-click on Add New Credential in the upper right pane.
6. On the General Tab, in the 'PIN Code' box, type 1420.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Access.
10. In the 'Function' combo box, select Momentary.
11. In the 'Door Group' combo box, select All.
If you don't have Door Group All set up, go to “Basic Setup: Step 4 - Door
Groups” on page 915.
12. Click the Options tab.
13. In the 'Passback' section, check 'Executive Override'.
14. Click OK.
15. Close Enrollment Manager.
Step 2 - Controller Properties
Set up Zoned Passback, Step 2 - Controller Properties on page 943.
Step 3 - Doors
Set up Forgive Passback, Step 3 - Doors on page 946.
Step 4 - Test
1. Enter PIN 1420 at Reader 14. Access granted.
2. Enter PIN 1420 at Reader 14. Access granted.
3. Enter PIN 1420 at Reader 14. Access granted.

Example: Global Passback

Step 1 - Users
If you have done any previous tests involving passback, you may need to forgive the
passback of the users.
1. Go to the Controller level of DIGI*TRAC Configuration.
2. Right-click M8.
3. Select Download.
4. Select Forgive Users.
Set up the users as described in “Zoned Occupancy Control, Step 1 - Users” on
page 944.

948 Examples: Passback

 MAN006-0612

This should enroll the user Ben McKenna.

We are now going to modify his credential.
5. In the Administration Window, select Configuration in the left pane.
6. Double-click Enrollment Manager in the right pane.
7. Select Ben McKenna in the left pane.
His credentials will appear in the upper right pane.
8. Double-click his keypad credential.
9. Click the Limits tab.
10. Check the 'Apply Credential Management Globally' box.
11. Click OK.
12. Close the Enrollment Manager window.
Step 2 - Controller Properties - M2
1. In the left pane of the Administration Window, open Configuration.
2. Go to the controller level of DIGI*TRAC Configuration.
 If anything up to this point is not set up, go to “Basic Setup: Step 1 -
Controllers” on page 914.
3. Right-click M2.
4. Select Properties.
5. Click the Setup tab.
6. In the Options section, check 'Enable Global Credential Management'.
7. Check 'Enable Global MCZ'.
8. Click the Passback tab.
9. In the 'On Passback Violation' section, check 'Report'.
10. Check 'Deny Access'.
Optionally, you may check 'Generate Alarm'.
Notice the 'Passback Options' box allows you to disable passback during certain
time zones.
11. Click OK.
Step 3 - Controller Properties - M8
Set up the controller as described in Zoned Passback, Step 2 - Controller Properties on
page 943.
Step 4 - Doors - M2
1. In the left pane of the Administration window, double-click M2.
2. Double-click Doors.
3. Double-click Door 1.
The Door 1 Properties sheet appears.
4. Click the Entry Reader tab.
5. Click the Logic tab.
6. In the 'From Zone' combo box, select Zone 2 - Inside.
7. In the 'To Zone' combo box, select Zone 4 - Inside.
8. Select the Exit Reader tab.
9. Select the Logic tab.
10. In the 'From Zone' combo box, select Zone 4 - Inside.
11. In the 'To Zone' combo box, select Zone 2 - Inside.

Examples: Passback 949

Velocity Version 3.1 Administrator’s Guide

12. Click OK.

13. Double-click Door 2.
14. Click the Entry Reader tab.
15. Click the Logic tab.
16. In the 'From Zone' combo box, select Zone 4 - Inside.
17. In the 'To Zone' combo box, select Zone 5 - Inside.
18. Click the Exit Reader tab.
19. Click the Logic tab.
20. In the 'From Zone' combo box, select Zone 5 - Inside.
21. In the 'To Zone' combo box, select Zone 4 - Inside.
22. Click OK.
Step 5 - Doors - M8
Set up the doors as described in Zoned Passback, Step 3 - Doors. on page 944
If you have done those tests, then Door 4 should already be set up on the M8.
Step 6 - Test
1. Enter PIN 1419 at Reader 1 on the M2. Access granted zone 2 to zone 4.
If you look at the address column in the Events Viewer you will see this message it
address \\01.01.01.001.01.SM01. The 5th set of numbers is the controller's
address: 01 (if you have your M2 set to address 1).
2. Enter PIN 1419 at Reader 12 on the M8. Access denied Passback.
The address (\\01.01.01.001.02.SM12) of the controller is 02 (if you have your
M8 set to address 2.
3. Enter PIN 1419 at Reader 9 on the M2. Access granted zone 4 to zone 2.
4. Enter PIN 1419 at Reader 12 on the M8. Access granted zone 2 to zone 1. Ben
may now leave.
Step 7 - Restore - M2
1. In the left pane of the Administration Window, open Configuration.
2. Go to the controller level of DIGI*TRAC Configuration.
3. Right-click M2.
4. Select Properties.
5. Click the Passback tab.
6. In the 'On Passback Violation' box, uncheck 'Deny Access'.
7. Uncheck 'Report'.
8. Click OK.

950 Examples: Passback

 MAN006-0612

Examples: Extended Access

This feature enables a qualified person (usually an operator) to specify how many
minutes a door can remain open. A credential must be enrolled with 'Extended Access'
as its user type instead of the normal 'Access' function.
Each door can be configured to allow this feature and the maximum time extension
per door is 1440 minutes.
When a person with extended access credentials enters their PIN at a ScramblePad,
they can add the number of minutes they require for the door to remain open. For
example, if the person's PIN is 1234, entering 1234*56# would result in the door
remaining open for 56 minutes. When the time is up, or if a subsequent entry of 0 is
specified (1234*0#), the door reverts to its normal timers.
The default Door Mode time is 6 seconds; the default Door Open Too Long time is 12
seconds.
A 'warning time' can also be specified on a per-door basis up to a maximum of 15
minutes. This causes the ScramblePad to beep a warning and, optionally, trigger an
ACB from the warning event.
 The number of minutes remaining can be displayed on many
ScramblePads. The current DS47s support this feature.
Two examples are shown:

Example 1
Step 1 - Setup
1. Open Enrollment Manager.
 Rather than follow steps 2 - 6, you can instead select Marian
Cunningham, who you created earlier; she already possesses a
credential with a PIN of 222. Proceed to step 7.
2. Double click Add New Person.
3. Fill out the name and other required information.
4. Double click Add New Credential from either the credential pane or at the
button at the bottom of the Personal Information screen.
The Credential dialog box for the new person appears.
5. From the IDF combo box, select IDF 1.
6. Change the Code Length from 4 to 3.
7. Enter a PIN of 222.
8. Select the Function tab.
The function property sheet appears with the Function(s) radio button selected.
9. Click Add...
The Define Function dialog box appears.
10. At the 'Function Category' combo box, select Access.
11. At the 'Function' combo box, select Extended.
12. At the 'Door Group' combo box, select All.
13. Fill out any other required information and press OK.
14. At the Velocity Administration window, click on the DIGI*TRAC Configuration folder.

Examples: Extended Access 951

Velocity Version 3.1 Administrator’s Guide

15. Expand the folder to reveal the M8 Controller folder and its subfolders including
the Doors folder.
16. Right click on Door 1 and select Properties.
The Doors General page appears.
17. Click the Entry Reader tab.
The Entry Reader dialog box appears.
18. Click the ScramblePad Options subtab.
The ScramblePad Options dialog box appears.
19. Check the 'Use keypad numeric LEDs as annunciator' box.
20. Click the General tab. The Doors General page reappears.
21. At the Extended Access Timers section, specify these values:
• Extended Access Override Time: 15 minutes
• Extended Access Warning Time: 2 minutes
22. Click OK.
Step 2 - Test
1. Go to Door 1.
2. Enter PIN 222.
You should gain access under normal delay timer conditions.
3. Now punch in this new PIN at the same door: 222*5.
You should now have extended access. A five-minute countdown begins and is
displayed on the keypad. At the top of each minute, the keypad refreshes the
countdown minutes. At the two minute mark, the keypad beeps a warning.

Example 2
Step 1 - Hardware
A DS47, date code 990618 or later, is needed for this test. (If you don't know the date
code of your keypad, hold down the “*” and the “#” keys simultaneously. The date
code will be displayed.
Address the DS47 to Reader 8.
Step 2 - User
1. Open Enrollment Manager.
2. From the person tree pane, select Add New Person.
The personal information form appears.
3. In the 'Name' text boxes, enter Jefferson Smith.
4. Click Apply.
5. In the credential pane, double click on Add New Credential.
The general page of the credential dialog box appears.
6. In the 'PIN' text box, enter 1405.
7. Select the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' drop-down combo box, select Access.
10. In the 'Function' drop-down combo box, select Extended.

952 Examples: Extended Access

 MAN006-0612

11. In the 'Door group' drop-down combo box, select All.

If All is not a choice, go to “Basic Setup: Step 4 - Door Groups” on page 915.
12. Click OK.
13. Close Enrollment Manager.
Step 3 - Door
1. In the system tree pane of the Administration Window, expand the DIGI*TRAC
Configuration to the controller level.
If anything up to this point is not set up, go to “Basic Setup: Step 1 - Controllers”
on page 914.
2. Expand M8.
3. Click to highlight the Doors folder.
All currently defined doors appear in the components pane.
4. In the components pane, double click Door 8.
The general page of the Doors Properties sheet appears.
5. In the 'Extended Access Override Time' spin control field under the 'Extended
Access Timers (minutes)' section, enter or use the spin buttons to select 15
(minutes).
6. In the 'Extended Access Warning Time' spin control field, enter or use the spin
buttons to select 2 (minutes).
7. Select the Entry Reader tab.
The Entry Reader page appears.
8. Select the ScramblePad Options tab.
The ScramblePad Options subpage appears.
9. Check the 'Use Keypad numeric LEDs as annunciator' box.
10. Click OK.
Step 4 - Test
 Enter PIN 1405 at Reader 8. You get an Extended Access grant of 0 minutes and
the relay for Door 8 will fire.
 Enter PIN 1405*4 at Reader 8. You get an Extended Access grant of 4 minutes. The
relay for Door 8 will fire.
Reader 8 (provided it is a DS47 with date code of 990618 or later) displays 004 to
indicate 4 minutes on the timer. At three minutes, the DS47 will change to a display of
003 to indicate 3 minutes remaining. At two minutes, the DS47 display changes, and
the two-minute warning beeps. At one minute, the DS47 display changes, and the
one-minute warning beeps. At zero minutes, the DS47 display clears, the warning timer
beeps, and the relay turns off after 6 seconds.
 Enter PIN 1405*5 at Reader 8. The display will be 005, and the relay will fire.
 Enter PIN 1405*0 at Reader 8. The display will shut off, and the relay will shut off.

Examples: Extended Access 953

Velocity Version 3.1 Administrator’s Guide

Example: Function Groups

Function Groups enable you to utilize extension digits (0 - 9 and 00 - 99) at the end of
a PIN code for a variety of features. Function Groups are used by entering a PIN Code,
followed by an asterisk (*), followed by the extension digits, and closed with a pound
sign (#).
Our function group example consists of a momentary access and two standard control
zones.
If you haven't performed the Basic Setup for our tests in Velocity, do it now. The
following tests will not work without the Basic Setup.
Step 1 - User
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. Double click Add New Person in the left pane.
The Personal Information pane appears.
3. In the Name text box, enter Bunny Watson.
4. Click Apply.
5. Double click on Add New Credential in the upper right pane.
The Credential dialog box appears.
6. On the General property sheet, in the 'PIN:' text box, enter 1408.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click the Function Group radio button on the left side.
9. In the 'Function Group' combo box, select <New>.
The Function Group Properties dialog box appears.
Alternately, exit Enrollment Manager and select Function Groups from Velocity
Configuration.
10. In the 'Name' text box, enter Relays.
11. Click the Add button.
12. Leave the 'Extension Digits' text box blank.
13. In the 'Function Category' combo box, select Access.
14. In the 'Function' combo box, select Momentary.
15. In the 'Door Group' combo box, select All.
If All is not currently defined, go to the basic setup instructions on door groups.
16. Click OK.
The Define Extensions dialog box reappears.
17. Click OK again.
The New Function Group Properties screen reappears.
18. Click Add.
19. In the 'Extension Digits' text box, enter 1.
20. In the 'Function Category' combo box, select Relay.
21. In the 'Function' combo box, select Force On.
22. In the 'Controller' combo box, select M8.
If M8 is not a choice, go to the basic setup instructions on controllers.

954 Example: Function Groups

 MAN006-0612

23. In the 'Control Zone' combo box, select SCZ 3.

24. Click Add.
25. Click OK.
The Define Extensions dialog box reappears.
26. Click OK again.
The New Function Group Properties screen reappears.
27. Click the Add button.
28. In the Extension Digits text box, enter 2.
29. Click Add.
30. In the 'Function Category' combo box, select Relay.
31. In the 'Function' combo box, select Force On Release.
32. In the 'Controller' combo box, select M8.
33. In the 'Control Zone' combo box, select SCZ 4.
34. Click Add.
35. Click OK.
36. Click OK.
37. Click OK.
38. Close the Enrollment window.
Step 2 - Control Zones
1. In the system tree pane expand the DIGI*TRAC Configuration to the controller
level.
If anything up to this point is not set up, go to the basic instructions on controllers.
2. Right click on M8.
3. Select Properties.
4. Click the Control Zones tab.
5. Select the Edit Control Zones button.
The Control Zones dialog box appears.
6. Click in the cell that intersects row SCZ# 3 and column 'Time Zone'.
<Never> appears there as the default value. A down arrow, , also appears.
7. Click the down arrow, .
8. Select <Always>.
9. Click in the cell that intersects column 1 with row SCZ #3.
An X appears in the cell.
10. Click in each of the 2–8 columns, so that cells 1-8 in the SCZ #3 row have an X in
each cell.
11. Repeat steps 6 - 10 for SCZ# 4 row.
12. Click OK.
13. Click OK.
Step 3 - Test
1. Enter PIN 1408 at a reader on the M8. You will receive an access grant.
2. Enter PIN 1408*1 at the reader. All eight relays on the M8 will turn on.
3. Enter PIN 1408*2 at the reader. All eight relays on the M8 will turn off.

Example: Function Groups 955

Velocity Version 3.1 Administrator’s Guide

Example: Globalized Master Control Zones

 This feature requires XBox Version 3.07 or later.
You have the option to 'globalize' any Master Control Zone by giving it a Global ID
Number (1 to 255).
A Global MCZ has an option to 'Broadcast Globally'. When the XBox receives a Global
MCZ broadcast, it retransmits the Globalized MCZ to all controllers connected to that
XBox. All MCZs with a Global ID will receive information from other MCZs with the
same Global ID.
Two or more controllers may have MCZs linked in this fashion as long as they are
connected to the same XBox.
For this reason, an event that occurs in one controller can trigger its MCZ which is
globalized to the XBox for transmission to many other controllers which in turn trigger
remote MCZs on those controllers as long as they have the same Global ID.
There is a per controller option to enable MCZ Globalization via the XBox even if the
host is disconnected or if the network is otherwise inactive. This option must be set as
well as the appropriate fields in the MCZ in order to get the full benefit of this feature.
We offer two examples in this section.

Example 1
The following tests will not work without the Basic Setup (refer to page 914).
Step 1 - Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. In the left pane, double click Add New Person.
The Personal Information form appears.
3. In the 'Name' fields, enter Tom Jeffords.
4. Click Apply.
5. In the credentials pane above the Personal Information form, click Add New
Credential.
The Credentials dialog box appears with the general property sheet displayed.
6. In the 'PIN' text box, enter 1417.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Relay.
10. In the 'Function' combo box, select Trigger.
11. In the 'Controller' combo box, select M2.
12. In the 'Control Zone' combo box, select MCZ 192.
13. Click the Add button.
14. In the 'Controller' combo box, select M8.
15. In the 'Control Zone' combo box, select MCZ 194.
16. Click the Add button.

956 Example: Globalized Master Control Zones

 MAN006-0612

17. Click OK.

18. Click OK again to exit the Credential Properties Sheet.
19. In the left pane of the Enrollment Manager screen, click Add New Person.
A new Personal Information form appears.
20. In the 'Name' fields, enter Amanda Wingfield.
21. Click Apply.
22. From the credentials pane above the Personal Information form, double click Add
New Credential.
The Credentials dialog box appears with the general property sheet displayed.
23. In the 'PIN' text box, enter 1418.
24. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
25. Click Add...
The Define Function dialog box appears.
26. In the 'Function Category' combo box, select Relay.
27. In the 'Function' combo box, select Trigger.
28. In the 'Controller' combo box, select M2.
29. In the 'Control Zone' combo box, select MCZ 193.
30. Click the Add button.
31. In the 'Controller' combo box, select M8.
32. In the 'Control Zone' combo box, select MCZ 195.
33. Click the Add button.
34. Click OK.
35. Click OK again to exit and download the credential.
36. Close Enrollment Manager.
Step 2 - Controller Properties - M2
If the M2 controller is not yet defined, go to “Basic Setup - Controllers” as described
starting on page 914.
1. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
2. Right click M2.
3. Select Properties.
The Controller Properties dialog box appears.
4. Click the Setup tab.
The setup property sheet appears.
5. In the Options section, check the 'Enable Global MCZ' box.
Step 3 - Standard Control Zones - M2
1. Click the Control Zones tab.
The Control Zones property sheet appears.
2. Click the Edit Control Zones button.
The Control Zones Properties dialog box appears with the Standard Control Zones
page displayed.
3. On the Standard Control Zones tab, click on the cell intersecting row SCZ 10 with
the Time Zone column.

Example: Globalized Master Control Zones 957

Velocity Version 3.1 Administrator’s Guide

A down arrow appears.

4. Click the down arrow, .
5. Select <Always>.
6. Click the four cells that follow, 1 - 4, in the SCZ 10 row.
An X appears in each box.
7. Click the cell intersecting the Time Zone column with SCZ 11.
A down arrow appears.
8. Click the down arrow, .
9. Select <Always>.
10. Click the four boxes that follow, 1 - 4, in the SCZ 11 row.
An X will appear in each box.
Step 4 - Master Control Zones - M2
1. Select the Master Control Zones tab.
The Master Control Zones page appears.
2. In the 'MCZ#' combo box, select 192.
This is the default value.
3. In the 'Time Zone' combo box, select <Always>.
4. In the 'Map to Global ID' combo box, type or select 1.
5. Check the 'Broadcast Globally' box.
6. In the bottom matrix, click the cell intersecting the Force On row with the Control
Zone column.
A down arrow will appear.
7. Click the down arrow, .
8. Select CZ10-SCZ10.
Standard Control Zone 10's selected relays (1-4) will be marked with X's.
9. Go back to the top of the Master Control Zones page.
10. In the 'MCZ#' combo box, select 193.
All the previously populated fields are cleared.
11. In the 'Time Zone' combo box, select <Always>.
12. In the 'Map to Global ID' combo box, type or select 2.
13. Check the 'Broadcast Globally' box.
14. In the bottom matrix, click the cell intersecting the Force On Release row with the
Control Zone column.
A down arrow appears.
15. Click the down arrow, .
16. Select CZ11-SCZ11.
Standard Control Zone 11's selected relays (1-4) will be marked with X's.
17. Click OK to exit the Control Zones page.
18. Click OK to exit the M2 properties sheet.
Step 5 - Controller Properties - M8
1. Right click M8.
2. Select Properties.
The M8's Properties sheet appears.
3. Click the Setup tab.

958 Example: Globalized Master Control Zones

 MAN006-0612

The setup page appears.

4. In the Options box, click the 'Enable Global MCZ' check box.
Step 6 - Standard Control Zones - M8
1. Select the Control Zones tab.
The Control Zones page appears.
2. Click the Edit Control Zones button.
The Standard Control Zones page appears.
3. Click the cell intersecting the SCZ 12 row and the Time Zone column.
A down arrow will appear.
4. Click the down arrow, .
5. Select <Always> from the pick list.
6. Click the eight boxes that follow, 1 - 8, in SCZ 12.
An X appears in each box.
7. Click the cell intersecting the SCZ 13 row and the Time Zone column.
A down arrow will appear.
8. Click the down arrow, .
9. Select <Always> from the pick list.
10. Click in the eight boxes that follow, 1 - 8, in SCZ 13.
An X will appear in each box.
Step 7 - Master Control Zones - M8
1. Select the Master Control Zones tab.
The Master Control Zones page appears.
2. In the 'MCZ#' combo box, select 194.
3. In the 'Time Zone' combo box, select <Always>.
4. In the 'Map to Global ID' combo box, type or select 1.
5. Click the 'Broadcast Globally' check box.
6. In the bottom matrix, click the cell intersecting the Force On row and the Control
Zone column.
A down arrow will appear.
7. Click the down arrow. .
8. Select CZ12-SCZ12 from the pick list.
Standard Control Zone 12's selected relays (1-8) will be marked with X's.
9. Go back to the top of the Master Control Zones page.
10. In the 'MCZ#' combo box, select 195.
All the populated fields on the form are cleared.
11. In the 'Time Zone' combo box, select <Always>.
12. In the 'Map to Global ID' combo box, type or select 2.
13. Click the 'Broadcast Globally' check box.
14. In the bottom matrix, click the cell intersecting the Force On Release row and the
Control Zone column.
A down arrow will appear.
15. Click the down arrow, .
16. Select CZ13-SCZ13 from the pick list.
Standard Control Zone 13's selected relays (1-8) will be marked with X's.

Example: Globalized Master Control Zones 959

Velocity Version 3.1 Administrator’s Guide

17. Click OK to exit the Control Zones page.

18. Click OK to exit the M8 properties.
Step 8 - Test
1. At Reader 1 on the M2, enter PIN 1417.
All four relays on the M2 come on, then all eight relays on the M8 come on.
2. At Reader 1 on the M2, enter PIN 1418.
All relays turn off.
3. At Reader 1 on the M8, enter PIN 1417.
All eight relays on the M8 come on, then all four relays on the M2 come on.
4. At Reader 1 on the M8, enter PIN 1418.
All relays turn off.
5. At Reader 1 on the M2, enter PIN 1417.
All the relays turn on.
6. At Reader 1 on the M8, enter PIN 1418.
All the relays turn off.
 You don't need to use the same controller to turn off the relays that you
used to turn them on. Once you've configured the system in the
preceding way, you can turn off the relays using M2 that you turned on
with M8.

Example 2
In this example, when an alarm is triggered on the M16 Expansion Input 1, it triggers a
Global Master Control Zone on an MSP-8R using MCZ 192.
Step 1 - Setting Up
1. Right click on your M16 controller and select Properties.
2. Select the Setups tab and check the Enable Global MCZ box.
3. Select the Control Zones tab, click on Edit Control Zones, select the Master
Control Zones tab.
4. At the 'MCZ#' pick list, select 192.
5. At 'Name' enter: MCZ192 Global ID 1.
6. Click the 'Map to Global ID' pick list and select 1.
7. Check the Broadcast Globally box.
Leave the time zone and function matrix at their default.
8. Click OK twice to exit the M16 properties.
9. Right click on the M16's Expansion Input 1 and select Properties.
10. Click the Logic tab.
11. At the 'Trigger Relays in Control Zone' combo box, select MCZ 192 Global ID 1
and click OK.
12. Right click on your MSP-8R controller and select Properties.
13. Click the Setups tab and check the Enable Global MCZ box.

960 Example: Globalized Master Control Zones

 MAN006-0612

14. Click the Control Zones tab, click Edit Control Zones, then create a SCZ 9 for
expansion relays 1 - 8 as shown in the following example:

15. Click the Master Control Zones tab and setup MCZ 192.
Name is MCZ 192 MSP-Trigger CZ9.
16. At the 'Map to Global ID' pick list, select 1.
Do not check the 'Broadcast Globally' box.
17. From the ‘Time Zone’ combo box, select <Always>.
18. Under the Trigger and Mask actions, select SCZ9 then click OK twice to exit.
The following illustration shows these steps:

Step 2 - Test
Create an alarm on the Exp. Input 1 on the M16 panel, notice the expansion relays on
the MSP-8R panel. They activate for about 6 seconds.

Example: Globalized Master Control Zones 961

Velocity Version 3.1 Administrator’s Guide

Examples: Holidays
There are four holiday schedules, each with two years of 366 days each and a pair of
daylight savings time change dates. These four schedules allow for:

Multiple For employees who share common readers but recognize different
Tenants holidays for religious, national, or other reasons.
For example, US tenants recognize July 4, whereas Canadian
tenants recognize July 1; however, both tenants use a common
lobby entrance.
For more on this, refer to “Example: Multiple Tenants Holidays” on
page 962.

Half-day Employees are provided with partial-day holidays.

Holidays For more on this, refer to “Example: Half-Day Holidays” on page
965.

Flex For employees who alternate 5-day and 4-day work weeks
Schedules (9-out-of-10).
For more on this, refer to “Example: Flex Schedules” on page 968.

Unplanned Unplanned or emergency holidays such as snow days, fuel

Days curtailment days, or severe weather alerts.
For more on this, refer to “Example: Unplanned Holidays” on page
970.

All Holidays for the previous year are deleted at year's end. If the holiday tables are
changed (including host PC changes), the current day's holiday status is updated
immediately along with the rest of the table. A qualified operator can set or clear
manual holidays on a per schedule basis using a credential.
 The following tests won't work unless you have created the definition
found in the Basic Setup.

Example: Multiple Tenants Holidays

This example demonstrates how Canadian and a US tenants can share a lobby door
without sharing holidays. The Canadian tenants access the lobby door Monday -
Sunday, 24 hours a day, except on July 1, Canada Day. The US tenants access the
lobby door Monday - Sunday, 24 hours a day, except on July 4, Independence Day.
Step 1 - Users
We will set up two users and take a shortcut through the Enrollment Manager to set up
Door Groups and Time Zones. These can also be set up under Velocity Configuration
before you enter the Enrollment Manager.
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. In the left pane, select Add New Person.
The Personal Information form appears.
3. In the 'Name' fields, enter Jane Hudson.
4. Click Apply.

962 Examples: Holidays

 MAN006-0612

5. In the credentials pane, double click Add New Credential.

The credential dialog box appears with the General page displayed.
6. In the 'PIN' text box, enter 1424.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Access.
10. In the 'Function' combo box, select Momentary.
11. In the 'Door Group' combo box, select <New Door Group>.
The Door Group Properties dialog box opens.
12. In the 'Door Group Name' text box, enter US Tenant.
13. In the 'Time Zone' combo box, use the down arrow to select <New>.
The Standard Time Zone Properties page opens.
14. Click the Create New Time Zone button, , on the upper right.
15. In the 'Choose Name' text box, enter US Tenant.
16. Click OK.
The US Tenant STZ appears in the STZ dialog box.
17. In the 'End' column of US Tenant, highlight the hour and type 24.
18. Check each day box that follows: M, T, W, T, F, S, S.
19. Uncheck the 1 column cell to deselect Holiday Schedule 1.
20. Check the 2 column cell to select Holiday Schedule 2.
21. Click the Create New Time Zone button, .
We will create the other time zone we need while we're here.
22. In the 'Choose Name' text box, type Canadian Tenant.
23. Click OK.
The Canadian Tenant STZ appears in the STZ dialog box.
24. In the 'End' column of Canadian Tenant, highlight the hour field and type 24.
25. Check each day box that follows: M, T, W, T, F, S, S.
26. Make sure that the 1 box is selected (Holiday Schedule 1).
27. Press Ctrl + S.
The two time zones are saved.
The Door Group Properties dialog box reappears with the US Tenant displayed in
the 'Time Zone' window.
28. In the Doors system tree window, double click XNET.
29. Expand the XNET folder until the controller M2 is displayed.
30. Click M2 to highlight it.
All currently defined doors for M2 appear in the Index/Doors window on the right.
31. Check the Door 2 and Door 10 boxes.
32. Click the Add button.
33. Click OK.
34. Click OK.
35. Click OK.
36. In the left pane of the Enrollment Manager window, select Add New Person.
A new Personal Information form appears.

Examples: Holidays 963

Velocity Version 3.1 Administrator’s Guide

37. In the 'Name' text boxes, enter Terri Randall.

38. Click Apply.
39. In the credentials pane, double click Add New Credential.
A new credentials properties dialog box appears with the general page displayed.
40. In the PIN text box, enter 1425.
41. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
42. Click Add...
The Define Function dialog box appears.
43. In the 'Function Category; combo box, select Access.
44. In the 'Function' combo box, select Momentary.
45. In the 'Door Group' combo box, select <New>.
The Door Group Properties window opens.
46. In the 'Door Group Name' text box, enter Canadian Tenant.
47. In the 'Time Zone' combo box, select Canadian Tenant.
48. In the Doors system tree window, double click XNET.
49. Expand this folder to reveal controller M2.
50. Click to highlight the M2 folder.
The Index/Doors window on the right displays all currently defined doors.
51. In the Index/Doors window, check the Door 2 and Door 10 boxes.
52. Click the Add button.
53. Click OK.
54. Click OK.
55. Click OK.
56. Close the Enrollment Manager window.
Step 2 - Holidays
1. In the system tree pane of the Administration window, expand the Velocity
Configuration folder to reveal the Holidays folder.
2. Click to highlight the Holidays folder.
The component pane displays all currently defined holidays.
3. In the components pane, double click Add New Holiday.
The Holiday Properties dialog box appears.
4. In the 'Name' text box, enter Canada Day.
5. In the 'Date' combo box, click the down arrow.
A calendar pops up.
6. Use the right arrow, , to page through the calendar months until you get to July.
7. Click 1 for July 1.
The exact date appears in the 'Date' combo box.
8. In the Holiday Schedules box, check 1 indicating that this holiday will be applied to
Schedule 1.
9. Click OK.
You are returned to the main Velocity screen.
10. In the components pane of the Administration window, double click Add New
Holiday.
11. In the 'Name' text box, enter Independence Day.

964 Examples: Holidays

 MAN006-0612

12. In the Date combo box, select the down arrow, .

A calendar pops up.
13. Use the right arrow to page through the calendar months until you get to July.
14. Click 4 for July 4.
The exact date appears in the 'Date' combo box.
15. In the Holiday Schedules box, check 2.
16. Click OK.
Step 3 - Test
1. At Reader 2 on the M2, enter PIN 1424. Access is granted.
2. At Reader 2 on the M2, enter PIN 1425. Access is again granted.
3. Change the date and time on your computer to 11:58 pm, June 30. One way to
do this is:
a. Right click on the time in the lower right corner of your Windows desktop.
b. Select Adjust Date/Time.
The Date/Time Properties window opens. Today's date is highlighted on the
calendar in the date box.
c. Use the arrows to change the month to June 30.
d. In the time box below the clock, highlight and type 11 over the hour field.
e. Click to highlight the minutes field and type 58.
f. Click Apply and close the Adjust Date/Time window.
4. Download the time to the controllers in this way.
a. In the system tree pane of the Administration Window, expand the DIGI*TRAC
Configuration to the controller level.
If any controllers are not set, go to “Basic Setup: Step 1 - Controllers” on page
914.
b. Right click M2.
c. Select Download > Date/Time.
d. Right click M8.
e. Select Download > Date/Time.
Wait for the time to change to the next day. It is important for the date and time to
roll over at midnight since this is the time at which the controller updates users.
5. At Reader 2 on the M2, enter PIN 1424. Access is granted.
6. At Reader 2 on the M2, enter PIN 1425. Access Denied: Access Zone.
You can repeat the test to change the date to July 3 (and let the time roll over to
July 4). You will find that 1424 is denied access, while 1425 is granted access.
7. Change the date and time back to the current settings.

Example: Half-Day Holidays

We will modify the US tenant that we set up in Multiple Tenants to be closed (no
access to the lobby door) at noon on July 3, as well as being closed all day on July 4.
Step 1 - Users
Use Jane Hudson and Terri Randall defined in Multiple Tenants - Step 1 - Users starting
on page 962.

Examples: Holidays 965

Velocity Version 3.1 Administrator’s Guide

Step 2 - Time Zones

1. In the system tree pane of the Administration window, open the Velocity
Configuration folder.
2. Click the Time Zones folder.
3. In the components pane, double click Standard Time Zones.
The Standard Time Zones Properties sheet appears.
4. Double click the US Tenant STZ.
The Choose Name window appears.
5. Enter US Tenant - Mornings to change the name.
6. Click OK.
The message “The time zone name has been successfully updated” appears.
7. Click OK.
8. In the 'End' column of US Tenant - Mornings, highlight the hour field and type 12.
9. Click the Create New Time Zone button on the upper right, .
The Choose Name dialog box appears.
10. In the ‘Choose Name’ text box, enter US Tenant - Evenings.
11. Click OK.
The new STZ appears on the property sheet.
12. In the 'Start' column of US Tenant - Evenings, highlight the hour field and type 12.
13. In the 'End' column of US Tenant - Evenings, highlight the hour field and type 24.
14. Check each day box that follow: M, T, W, T, F, S, S.
15. Uncheck the 1 box to deselect Holiday Schedule 1.
16. Check the 2 and 3 boxes to select Holiday Schedules 2 and 3.
These are the US Tenant morning and evening schedules.
17. Select the Save icon in the upper right corner, .
This saves the new STZ definitions.
Step 3 - Master Time Zone
1. From the Time Zone properties sheet, click the Master Time Zone tab.
The Master Time Zone properties sheet appears.
2. Click the Create New Time Zone button on the upper right, .
The Choose Name dialog box appears.
3. In the text field, enter a name for the time zone window: US Tenant.
4. Click OK.
The US Tenant MTZ appears.
5. Click on the top cell that intersects the Standard Time Zone column and the US
Tenant row.
A down arrow appears.
6. Click the down arrow, .
7. Select US Tenant - evenings from the pick list.
8. Click on the second cell of the Standard Time Zone column.
A down arrow appears.
9. Click the down arrow, .
10. Select US Tenant - mornings from the pick list.
11. Click the Save icon, , in the upper right corner.

966 Examples: Holidays

 MAN006-0612

12. Close the Master Time Zone Properties window.

13. Close the Standard Time Zone Properties window.
Step 4 - Holidays
1. In the system tree pane of the Administration window, highlight the Holidays
folder.
2. In the components pane, double click Add New Holiday.
The Holiday Properties dialog box appears.
3. In the 'Name' text field, enter Independence Eve.
4. In the 'Date' combo box, click the down arrow, , to open the calendar.
5. Use the right arrow to move to July.
6. Click 3 for July 3rd.
7. Check the 3 box under Holiday Schedules.
8. Click OK.
Step 5 - Door Groups
1. In the system tree pane, expand the Velocity Configuration folder to reveal the
Door Groups folder.
2. Highlight the Door Groups folder.
3. In the components pane, double click US Tenant.
The properties for US Tenant appear.
4. In the bottom pane, highlight Door 2.
5. Click Remove.
6. In the bottom pane, highlight Door 10.
7. Click Remove.
8. At the Time Zone combo box, select US Tenant.
9. In the Index/Doors window, check Door 2.
10. Click Add.
11. Click OK.
Step 6 - Test
1. Change the date and time on your computer to 11:58 pm, July 2. One way to do
this is:
a. Right click on the time in the your Windows desktop tray.
b. Select Adjust Date/Time.
The Date/Time Properties window appears. Today's date is highlighted on the
calendar in the date box.
c. Use the arrows to change the month to July and select the 2nd.
d. In the time box below the clock, highlight and type 11 over the hour.
e. Highlight and type 58 over the minutes.
f. Make sure that pm is selected.
g. Click Apply and close the Adjust Date/Time window.
2. Download the time to the controllers. One way to do this is:
a. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
If any controllers are not yet defined, go to “Basic Setup: Step 1 - Controllers”
on page 914.
b. Right click M2.

Examples: Holidays 967

Velocity Version 3.1 Administrator’s Guide

c. Select Download > Date/Time.

d. Right click M8.
e. Select Download > Date/Time.
Wait for the time to change to the next day. The controllers will be updated. It is
now July 3rd. The US Tenant will close at noon.
3. At Reader 2 on the M2, enter PIN 1424. Access is granted.
4. At Reader 2 on the M2, enter PIN 1425. Access is again granted.
5. Change the time to 11:58 am of the same day using Step 1.
6. Download the Time/Date to the M2 and M8 controllers using Step 2.
Wait for the time to roll past noon, so the controllers will update the access zones.
7. At Reader 2 on the M2, enter PIN 1424. Access Denied: Access Zone.
8. At Reader 2 on the M2, enter PIN 1425. Access is granted.
9. Change the date and time back to current.

Example: Flex Schedules

We will modify our Canadian tenant to have two groups of users, with each group
taking every other Friday off. We'll set up their holidays for January 2004.
Part 1 - Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. From the left pane, click Add New Person.
The Personal Information form appears.
3. At the 'Name' fields, enter Philip Stevens.
4. Click Apply.
5. In the credentials pane, double click Add New Credential.
6. In the 'PIN' text box, enter 1426.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Access.
10. In the 'Function' combo box, select Momentary.
11. In the 'Door Group' combo box, select <New Door Group>.
The Door Group Properties window will open.
12. In the 'Door Group Name' text box, enter Canadian Tenant.
13. In the 'Time Zone' combo box, select <New>.
The Standard Time Zone Properties window appears.
14. Click the Create New Time Zone button, , in the upper right corner.
The Choose Name dialog box appears.
15. In the text box, enter Canadian Tenant.
16. Click OK.
The Standard Time Zone properties window appears with the STZ “Canadian
Tenant” displayed.
17. In the 'End' column of Canadian Tenant - Group 2, highlight the hour field and type
24.

968 Examples: Holidays

 MAN006-0612

18. Check each day box that follows: M, T, W, T, F, S, S.

19. Uncheck the 1 box to deselect Holiday Schedule 1.
20. Check the 4 box to select Holiday Schedule 4.
21. Press Ctrl + S or click to save the current definitions.
The Door Group Properties window reappears.
22. In the Doors system tree window, expand the Xnet folder until the M2 controller
appears.
23. Highlight M2.
All doors currently associated with that controller appear in the Index/Doors
window on the right.
24. In the Index/Doors window, check the ‘Door 2’ and ‘Door 10’ boxes.
25. Click the Add button.
26. Click OK.
27. Click OK.
28. Click OK.
29. Exit the Enrollment Manager.
For this example, we will also use Terri Randall from Multiple Tenants - Step 1 - Users
starting on page 962.
Step 2 - Time Zones
1. In the system tree pane of the Administration window, expand Velocity
Configuration.
2. Highlight the Time Zones folder.
3. In the components pane, double click Standard Time Zones.
The Standard Time Zones Properties sheet appears.
4. Double click Canadian Tenant.
The Choose Name window appears.
5. Enter Canadian Tenant - Group 1 to change the name.
6. Click OK.
The message “Time Zone name has been successfully updated” appears.
7. Click OK.
The Standard Time Zones Properties sheet reappears.
8. Select the Save icon in the upper right corner, .
9. Close the Standard Time Zones Properties window.
Step 3 - Holidays
1. In the system tree pane, highlight the Holidays folder.
2. In the components pane, double click Add New Holiday.
The Holiday Properties dialog box appears.
3. In the 'Name' text box, enter Group 1 - 01/04/04.
4. In the 'Date' combo box, click the down arrow to open the calendar.
5. Click the right arrow to move to the January 2004.
6. Click 4 for January 4th.
7. Check the 1 box under Holiday Schedules.
8. Click OK.

Examples: Holidays 969

Velocity Version 3.1 Administrator’s Guide

9. Repeat Steps 2 - 8 for these additional Holiday definitions:

Holiday
Name Date
Schedule

Group 2 - 01/11/04 January 11, 2004 4

Group 1 - 01/18/04 January 18, 2004 1

Group 2 - 01/25/04 January 25, 2004 4

10. Click OK.

Step 4 - Door Groups
1. In the system tree pane, highlight the Door Groups folder.
2. In the components pane, double click Canadian Tenant.
The Canadian Tenant's property sheet appears.
3. In the 'Door Group Name' text box, add - Group 1 to the end of the name.
It should now read Canadian Tenant - Group 1.
4. Click OK.
Step 5 - Test
1. Change the date on your computer to Thursday, January 3 at 11:58 pm.
2. Download the time and configuration to the controllers in this fashion:
a. In the system tree pane, expand DIGI*TRAC Configuration to the controller level.
If the M2 and M8 controllers have not yet been defined, go to Basic Setup -
Controllers.
b. Right click M2.
c. Select Download > Date/Time.
d. Right click M8.
e. Select Download > Date/Time.
Let the date roll over to January 4.
3. At Reader 2 of the M2, enter PIN 1425. Denied Access Zone.
4. At Reader 2 of the M2, enter PIN 1426. Granted Access.
5. Change the date on your computer to Thursday, January 10 at 11.58 pm.
6. Download the Time/Date to the controllers as described in Step 2.
Let the date roll over to January 11.
7. At Reader 2 of the M2, enter PIN 1425. Granted Access.
8. At Reader 2 of the M2, enter PIN 1426. Denied Access Zone.
Experimentation will show that Group 1 is closed on the 1st and 3rd Fridays while
Group 2 is closed on the 2nd and 4th Fridays.

Example: Unplanned Holidays

We will modify our US tenant to be closed today for the rest of the day, because it is
such a beautiful day, and we should really be outside enjoying it.
Part 1 - Users
Use Jane Hudson and Terri Randall as defined in Multiple Tenants Holidays - Step 1 -
Users on page 962.

970 Examples: Holidays

 MAN006-0612

Part 2 - Holidays
1. In the system tree pane, expand the Velocity Configuration folder to reveal the
Holidays folder.
2. Highlight the Holidays folder.
3. In the components pane, double click Add New Holiday.
The Holiday Properties dialog box appears.
4. In the 'Name' text box, enter Hurricane Alert.
5. Leave the current date.
Check the date on your computer to make sure you changed it back after the last
test.
6. Check Holiday Schedules 2 and 3.
These should be the US Tenant morning and evening schedules.
7. Click OK.
Part 3 - Test
1. At Reader 2 on the M2, enter PIN 1424. Access Denied: Access Zone.
2. At Reader 2 on the M2, enter PIN 1425. Access Grant.

Examples: Holidays 971

Velocity Version 3.1 Administrator’s Guide

Example: Latch Monitor Feature

Hirsch's DTLM3/MELM3 line module monitors normally support discrete monitoring of
door contacts, RQE (Request to Exit) devices, and tamper switches. However, you can
reassign the tamper switch function to handle a Latch Monitor function.
When so configured, the DTLM3/MELM3 will be able to verify that the door is locked -
not just closed. In this configuration, the tamper will be masked when the door contact
is masked. A lock with a latch monitor contact output is required for this feature, and
the contact must be normally closed.
If you haven't already, perform the Basic Setup. The following tests don't work without
the Basic Setup.
Step 1 - Hardware
Make sure you have a DTLM 3 or MELM 3 line module either wired directly to or wired
to a plug in Doors 1 & 7 on the M8.
Both of these doors should be set in Velocity to DTLM/MELM 3. If you haven't done
this already, go to “Basic Setup: Step 3 - Doors and Readers” on page 915.
Step 2 - Users
If Rose Sayer is not set up, go to “Basic Setup: Step 5 - Users” on page 916.
Step 3 - Doors
If Controller M8 is not yet defined, go to “Basic Setup: Step 1 - Controllers” on page
914.
1. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
2. Expand M8.
The components of M8 appear.
3. Click the Doors folder.
All currently defined doors appear in the components pane.
4. Double click Door 7.
The Doors Properties dialog box appear.
5. Click the Input tab.
The Input property page appears.
6. Verify that the 'Line Module' combo box is set to DTLM3/ MELM3.
7. Check the 'Mask tamper when door contact masked' box located on the bottom
right.
You cannot check this box if you do not have DTLM3/MELM3 selected.
8. Click OK.
Step 4 - Test
Perform the first tests on Door 1, which does not have the latch monitor enabled. This
will show the standard operation of a door.
1. Press and release the tamper switch.
A tamper alarm will sound.
2. At Reader 1, enter PIN 2222.
3. While the relay is still active, press and release the tamper switch.

972 Example: Latch Monitor Feature

 MAN006-0612

A tamper alarm will sound.

4. At Reader 1, enter PIN 2222.
5. While the relay is still active, open the door switch.
6. While the door is still open, press and release the tamper switch.
A tamper alarm will sound.
7. Close the door.
8. Wait for the relay to turn off.
9. Press and release the tamper switch.
A tamper alarm will sound.
Now perform the next tests on Door 7, which has the latch monitor enabled.
10. Press and release the tamper switch.
A tamper alarm will sound.
11. At Reader 7, enter PIN 2222.
12. While the relay is still active, press and release the tamper switch.
There is no alarm.
13. At Reader 7, enter PIN 2222.
14. While the relay is still active, open the door switch.
15. While the door is still open, press and release the tamper switch.
There is no alarm.
16. Close the door.
17. Wait for the relay to turn off.
18. Press and release the tamper switch.
A tamper alarm will sound.

Example: Latch Monitor Feature 973

Velocity Version 3.1 Administrator’s Guide

Example: Long PINs

When defined using Velocity, you can use up to 15-digit Personal ID Numbers (PINs)
plus a duress digit with attached ScramblePads. For instance, a 9-digit Social Security
Number plus a 5-digit secret code would create a 14-digit PIN.
To perform basic setup instructions, go to Basic Setup. The following tests will not work
without the Basic Setup.
Step 1- Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. From the left pane, click Add New Person.
The Personal Information form appears.
3. At the 'Name' text boxes, enter Tom Destry.
4. Click Apply.
5. In the credentials pane, double click Add New Credential.
The Credentials dialog box appears with the general page displayed.
6. In the 'Code' section, click in the 'Length' spin control box then either enter or use
the up spin button to select 15.
This allows you to enter up to fifteen alphanumeric characters for a PIN code.
7. In the 'PIN' text box, enter 194925088882080.
8. In the 'Duress Digit' spin control box, type or use the up spin button to select 9.
9. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
10. Click Add...
The Define Function dialog box appears.
11. From the 'Function Category' combo box, select Access.
12. From the 'Function' combo box, select Momentary.
13. From the 'Door Group' combo box, select All.
If All is not a selection in the Door Group window, go to “Basic Setup: Step 4 -
Door Groups” on page 915.
14. Click OK.
15. Click OK again.
16. Close Enrollment Manager.
Step 2 - Controller Properties
1. From the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
If the M2 controller is not yet defined, go to “Basic Setup: Step 1 - Controllers”
on page 914.
2. Right click M2.
3. Select Properties.
The M2 controller's general properties dialog box appears.
4. Click the Setup tab.
The controller setup page appears.
5. In the 'Options' section, check the 'Enable Duress Alarm Mode' box.

974 Example: Long PINs

 MAN006-0612

6. Click OK.
Step 3 - Test
1. At Reader 1 on the M2, enter PIN 1949250888820809.
The door relay and duress alarm fire on the M2. The Alarm Viewer pops up,
showing that Tom Destry was under duress.
2. In the Alarm Viewer, acknowledge the duress alarm.
3. In the Event Viewer, see that Tom was granted access and he was under duress.

Example: Long PINs 975

Velocity Version 3.1 Administrator’s Guide

Examples: Man Trap

This example demonstrates the use of an interlocking portal also called a man trap.
This is a very secure entrance and exit control requiring use of a card to enter the portal
and a card and code to exit.

The controller is programmed so that only one door can be opened at a time. The man
trap is used for many high-security operations including prisons and drug dispensaries.
A card reader enables access to the man trap; however, in this example, the man trap
requires both a card reader and ScramblePad to gain access to the inside. Door
contacts mediated by line modules are needed to monitor the two doors which should
never be open at the same time.
A man trap requires an interaction of control zones to provide the interlocking
mechanism. These control zones include both standard and master control zones that
utilize inputs as well as base and virtual relays. Because of Velocity’s immense flexibility,
many different configurations of this mechanism are possible.
Passback zones are also required to initiate Who’s Inside occupancy reports and make
the Who’s Inside module relevant.
Creating and configuring mantraps involve a complex set of variables because no two
doors defined in the mantrap can be open at the same time. That's why there are so
many Virtual Relays, Standard Control Zones, and Master Control Zones involved in the
finished configuration.
The following example presents one of the best all-round applications; however, it is
also one of the most difficult security solutions to configure due to all of the parameters
involved.
The DIGI*TRAC Controller must utilize DTLM\MELM Line Modules in order for the
application to work. In this example, Door 1 and Door 2 are utilized.
Step 1 – Controller Configuration
1. Go to Controller Properties > Control Zones > Edit Control Zones >
Standard Control Zones.

976 Examples: Man Trap

 MAN006-0612

2. Rename and configure 6 SCZ's as follows:

SCZ Name Time Zone Point Selected

CZ1 “Base Relay 1" <Always> Base relay 1

CZ2 “Base Relay 2" <Always> Base relay 2

CZ41 “X-41 Tmr Dr 1" <Always> X41

CZ42 “X-42 Tmr Dr 2" <Always> X42

CZ51 “X-51Reset Dr 2" <Always> X51

CZ52 “X-52 Reset Dr 1" <Always> X52

3. Click the Master Control Zones tab.

4. Rename and configure 4 (four) MCZ's as shown below. Use the actual MCZ
number and name.

MCZ Name Time Zone Trigger Action

201 FF Dr 1 <Always> “X-41 Tmr Dr 1" Force OFF: select “Base

Relay 1"

202 FF Dr 2 <Always> “X-42 Tmr Dr 2" Force OFF: select “Base

Relay 2"

211 FFR Dr 1 <Always> Force OFF Release: select

“Base Relay 1"

212 FFR Dr 2 <Always> Force OFF Release: select

“Base Relay 2"

Step 2 – Door Programming

Door 1
1. At Door 01 Properties, select the Relay/Setup tab.
2. At 'Door Mode time' text box, enter 4.00.
3. At 'Door delay mode', enter 1.50.
4. Select the Relay/Logic tab.
5. Under the 'Control Zones' section, at the 'Trigger relays in control zone' pick list,
select 202 FF Dr 2.
6. Select the Input/Logic tab.
7. Under the 'Control Zones' section, at the 'Disable relays in control zone' pick list,
select Base Relay 2.
8. At the 'Retrigger relays in control zone' pick list, select X-51Reset Dr 2.

Door 2
1. At Door 02 Properties, select the Relay/Setup tab.
2. At the 'Door mode time' text box, enter 4.00.
3. Click the Relay/Logic tab.
4. Under the 'Control Zones' section, at the 'Trigger relays in control zone' pick list,
select 201 FF Dr1.

Examples: Man Trap 977

Velocity Version 3.1 Administrator’s Guide

5. Click the Input/Logic tab.

6. Under the 'Control Zones' section, at the 'Disable relays in control zone' pick list,
select Base Relay 1.
7. At the 'Retrigger relays in control zone' pick list, select X-52 Reset Dr 1.
Step 3 – Expansion Relay Programming
Rename and enter values for the following expansion relays:

Control Control Trigger relays

XRelay Rename
mode time delay time in CZ*

XR 41 “XR-41Trg 211FFR Dr 1\9 delay” 1.00 9.00 211 FFR Dr 1

XR 42 “XR-42 Trg 212FFR Dr 2\9 delay” 1.00 9.00 212 FFR Dr 2

XR 51 “XR-51 Reset Dr 2 Trg 212" 1.00 1.00 212 FFR Dr 2

XR 52 “XR-52 Reset Dr 1 Trg 211" 1.00 1.00 211 FFR Dr 1

* The 'Trigger relays in Control Zone' pick list is located by clicking the Logic tab of the
respective Expansion Relay properties sheet and going to the 'Control Zones' section.
Step 4 – Credential and Passback Programming
There is no specific credential programming needed for this configuration. Add users to
a Door Group as usual.
 This example enables you to distinguish who is inside of the Interlock
area and denies access to another user if both credentials are presented
at the same time. This configuration allows access to only one user in the
specified area (Zone 3) at a time.
You must past through the Interlock by presenting or entering the credential at entry
reader address 1 or 2, then exit the Interlock by presenting or entering the credential at
exit reader address 9 or 10.
Add the following program configurations using System 1, Doors 1 & 2:
1. At the Controller Properties sheet, click the Passback tab.
2. At the 'On Passback Violation' section, select Report (enable Passback
/Occupancy tracking).
3. At the 'Occupancy Options Apply to this Zone' field, select: 3.
4. At the 'Max' field, and enter 1.
5. Click OK.
6. At the Door 01 Properties sheet, click the Entry Reader/Logic tab.
7. In the Passback Zones section, select these values: 'From zone:' select Zone 1 -
Outside to Zone 3 - Inside.
8. Click the Exit Reader/Logic tab.
9. At the Passback Zones section, select these values: 'From zone:' select Zone 3 -
Inside to Zone 1 - Outside.
10. Click OK.
11. At the Door 02 Properties sheet, click the Entry Reader/Logic tab.
12. In the Passback Zones section, select these values: 'From zone:' select Zone 1 -
Outside to Zone 3 - Inside.
13. Click the Exit Reader/Logic tab.

978 Examples: Man Trap

 MAN006-0612

14. At the Passback Zones section, select these values: 'From zone:' select Zone 3 -
Inside to Zone 1 - Outside.
15. Click OK.
Configure Doors 3 and 4 in the same way as the above configuration except you would
use Zone 4. Doors 5 and 6 would be Zone 5. Doors 7 and 8 would be Zone 6.

Examples: Man Trap 979

Velocity Version 3.1 Administrator’s Guide

Example: Two-Person Rule

There are new enhancements to Two-Person Rule:
 Two-Person A/B Rule: A+B or B+A allowed (also Normal + Normal, Normal + A or
Normal + B)
 A+A or B+B are disallowed
 Two-Person 'Executive Override'
 This rule does not apply to designated executives
The Two-Person “A/B” Rule is useful for “Supervisor/Trainee” applications where it is
desired to have two supervisors or a supervisor and a trainee, but not two trainees gain
entrance to an area.
Go to Basic Setup for basic instructions on setting up the system for this test. The
following tests will not work without the Basic Setup.
Step 1 - Users
Two types of persons (users) are required.
Step 1A - Standard Users
If your setup does not include Mike Conner and Rose Sayer yet, go to “Basic Setup:
Step 5 - Users” on page 916.
Step 1B - Two-Person Rule A Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. In the left pane, click Add New Person.
The Personal Information form appears.
3. In the Name fields, enter Susan Vance.
4. Click Apply.
5. In the credentials pane, double click Add New Credential.
The Credentials dialog box appears with the general property sheet displayed.
6. In the 'PIN' text box, enter 1400.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' combo box, select Access.
10. In the 'Function' combo box, select Momentary.
11. In the 'Door Group' combo box, select All.
If All is not a selection in the Door Group window, go to “Basic Setup: Step 4 -
Door Groups” on page 915.
12. Click OK.
13. Click the Limits tab.
The Limits property sheet appears.
14. In the '2-Person Rule' section, select the A/B Rule A radio button.
15. Click OK.
16. Repeat steps 2 - 13 for Elwood Dowd, PIN number 1401.

980 Example: Two-Person Rule

 MAN006-0612

Step 1C - Two-Person Rule B Users

Still in the Enrollment Manager:
1. Click Add New Person in the left pane.
2. In the Personal Information form 'Name' fields, enter Tess Harding.
3. Click Apply.
4. In the credentials pane, double click Add New Credential.
5. On the Credentials Properties general page, at the 'PIN' text box, enter 1402.
6. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
7. Click Add...
The Define Function dialog box appears.
8. At the 'Function Category' combo box, select Access.
9. At the 'Function' combo box, select Momentary.
10. At the 'Door Group' combo box, select All.
If All is not a selection in the Door Group window, go to “Basic Setup: Step 4 -
Door Groups” on page 915.
11. Click OK.
12. Click the Limits tab.
The Limits property sheet appears.
13. In the Two-Person Rule box, select the A/B Rule B radio button.
14. Click OK.
15. Repeat steps 1 - 12 for George Bailey, PIN number 1403.
Step 1D - Two-Person Executive Override User
Still in the Enrollment Manager:
1. Click Add New Person in the left pane.
2. In the 'Name' fields of the Personal Information form, enter Amanda Bonner.
3. Click Apply.
4. In the credentials pane, double click Add New Credential.
5. On the General tab at the 'PIN' text box, enter 1404.
6. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
7. Click Add...
The Define Function dialog box appears.
8. In the 'Function Category' combo box, select Access.
9. At the 'Function' combo box, select Momentary.
10. At the 'Door Group' combo box, select All.
If All is not a selection in the Door Group window, go to “Basic Setup: Step 4 -
Door Groups” on page 915.
11. Click OK.
12. Click the Limits tab.
The Limits property sheet appears.
13. In the Two-Person Rule box, select Executive Override.
14. Click OK.
15. Close the Enrollment Manager.

Example: Two-Person Rule 981

Velocity Version 3.1 Administrator’s Guide

Step 2 - DIGI*TRAC Configuration

If the M8 controller is not yet defined, go to “Basic Setup: Step 1 - Controllers” on
page 914.
1. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
2. Expand the M8.
3. Click Doors.
All currently defined doors appear in the components pane.
4. Double click Door 8.
Door 8's properties sheet appears.
5. In the 'Options' section, check the 'Enable two-person rule' box.
6. Click OK.
Step 3 - Test
Try each of these two-person rule users at Door 8:
Step 3A - Single users:
1. Enter PIN 1111 (standard user). Access Partial Grant.
2. Enter PIN 1400 (Rule A user). Access Partial Grant.
3. Enter PIN 1402 (Rule B user). Access Partial Grant.
 If you try step 2 and 3 right after one another, you will get an access
granted.
4. Enter PIN 1404 (Executive Override user). Access Granted.
Step 3B - Two users of the same type:
1. Enter PIN 1111 (standard user). Then enter PIN 2222 (standard user). Access
Granted.
2. Enter PIN 1400 (Rule A user). Then enter PIN 1401 (Rule A user). Access Denied.
3. Enter PIN 1402 (Rule B user). Then enter PIN 1403 (Rule B user). Access Denied.
Step 3C - Two users of different types:
1. Enter PIN 1111 (standard user). Then enter PIN 1400 (Rule A user). Access
Granted.
2. Enter PIN 1401 (Rule A user). Then enter PIN 1403 (Rule B user). Access
Granted.
3. Enter PIN 1111 (standard user). Then enter PIN 1403 (Rule B user). Access
Granted.

982 Example: Two-Person Rule

 MAN006-0612

Example: Print ACBs Not At Default

To print ACBs that have been changed from the factory default:
1. Open the Diagnostic Window. The diagnostic window appears.
2. Click Toggle Diagnostic Stream.
You should get a message that says the Diagnostic Stream is on. If you get a
message that says the Diagnostic Stream is off, toggle the button again.
3. On the bottom left side of the window, select Controller M8.
4. In the 'Digi*Trac Commands' window, enter 460*0.
5. Select the ellipses button, .
A report is displayed in the lower window containing only ACBs that are not at
factory default. If you just performed the above test, the report will tell you that
ACB 76 is not at factory default.
6. Close the Diagnostic Window.

Example: Print ACBs Not At Default 983

Velocity Version 3.1 Administrator’s Guide

Example: Quarter-Second Relay Times

Door Mode, Door Delay, Relay Control Mode, Relay Control Delay, Expansion Relay
Control Mode, and Expansion Relay Control Delay timers have all been reworked to
operate in quarter-second increments.
This means that triggering a standard control zone can result in a staggered sequence
of relays firing, up to four per second.
Step 1 - Configuring
To configure quarter-second relay times:
1. Open Enrollment Manager.
 Rather than follow steps 2 - 6, you can instead select Emily Baldwin, who
you created earlier; she already possesses a credential with a PIN of
333. Proceed to step 7.
2. Double click Add New Person.
3. Fill out the name and other required information.
4. Double click Add New Credential from either the credential pane or the button
at the bottom of the Personal Information screen.
The Credential dialog box for the new person appears.
5. From the IDF combo box, select IDF 1.
6. Change the Code Length to 3.
7. Enter a PIN of 333.
8. Select the Function tab.
The function property sheet appears with the Function(s) radio button selected.
9. Click Add...
The Define Function dialog box appears.
10. At the 'Function Category' combo box, select Relay.
11. At the 'Function' combo box, select Trigger.
The 'Controller' and 'Control Zone' combo boxes appear.
12. At the 'Controller' combo box, select M8.
13. At the 'Control Zone' combo box, select SCZ1.
14. Click Add then press OK.
15. Click OK again to close Enrollment Manager.
16. At the Velocity Administration window, click on the DIGI*TRAC Configuration folder.
17. Expand the folder to reveal the M8 Controller folder.
18. Right click on the M8 controller folder and select Properties.
The Controller General page appears.
19. Click the Control Zones tab then click the Edit Control Zones button.
The Control Zones dialog box appears.
20. Select SCZ1 on Door 4.
21. Right click on the 'x' you just marked at Door 4.
22. Select Relay Properties...
The Door properties dialog box for Door 4 appears.
23. Click the Relay tab.
24. At the 'Control Mode Time' field, select 3.25 seconds.

984 Example: Quarter-Second Relay Times

 MAN006-0612

25. At the 'Control Delay Time' field, select 0.00 seconds.

26. Repeat steps 17 - 23 with Doors 5 - 8 in SCZ1 using the following control mode
and control delay times:

Door Control Mode Time Control Delay Time

Door 5 2.75 0.25

Door 6 2.25 0.50

Door 7 1.75 0.75

Door 8 1.25 1.00

27. Click OK.

Step 2 - Test
To test this configuration:
 Go to any door (4 - 8) and press PIN 333. Relays 4 through 8 should fire, then go
off at 1/4-second intervals.

Example: Quarter-Second Relay Times 985

Velocity Version 3.1 Administrator’s Guide

Examples: ScramblePad Options

There are several options described here:

Deny under Use this feature to deny access and alert operators when a
Duress duress digit is entered at the end of a PIN.
Refer to “Example: Deny Under Duress” on page 987.

Duress For high security, where what is inside is more valuable than the
without employee (e.g., a missile lock-up), readers can be configured to
Access transmit a duress alarm to a central station—yet not let the
individual through the door.
This feature may be implemented on a per reader basis.
Refer to “Example: Duress without Access” on page 987.

Silent Code Use this feature to suppress ScramblePad beeping on a Code

Tamper Tamper violation. Code Tamper alarms occur when successive
incorrect codes or successive “denials” of any kind (default is
three) are entered. This feature may be implemented on a per
reader basis.
Refer to “Example: Deny Under Duress” on page 987.

Code Tamper Use this feature to disable a person using a credential that
Disables Code causes a code tamper alarm.
or Card For more on this, refer to “Example: Code Tamper Disables Card
Holder or Code Holder” on page 990.

Code Tamper It is now possible to disable a specific user (credential) upon a

Disables Card and/or Code Tamper violation. This will apply to Invalid
Credential Codes, Bad PIN, Access Zone Invalid, or a Passback Violation.
This feature may be implemented on a per reader basis. The
feature also applies to codes used repeatedly at the wrong door
or at the wrong time.
Code Tamper can apply to a range of successive denials which
may include conditions such as Invalid Function Extension, Relay
Overridden, or many other reasons.
Refer to “Example: Code Tamper Disables Card or Code Holder”
on page 990.

ScramblePad There are three LED options:

LED Options • Green LED on steady while the Relay is active. See “Example:
Green LED While Relay Active” on page 992.
• Green Flash throughout the Door Delay timer. See “Example:
Green Flash in Door Delay” on page 993.
• Yellow Flash throughout the Control Delay timer. See
“Example: Yellow Flash for Control Delay” on page 994.

The following tests will not work without the instructions in “Basic Example” on page
914.

986 Examples: ScramblePad Options

 MAN006-0612

Example: Deny Under Duress

Sometimes what's inside is more valuable than the employee.
Most of the time, if an employee is being forced to open a door, Hirsch has an easy
way to signal this fact, using the duress digit. An alarm is enunciated and/or reported
and the requisite measures are taken to help the person being threatened and arrest
the person doing the threatening.
However, there are circumstances when the stuff inside is too valuable to allow access
to anyone, no matter what the threat is. In these cases, access can be denied under
duress.
Step 1 - Setup
To set up Deny Under Duress:
1. At the Velocity Administration window, click on the DIGI*TRAC Configuration folder.
2. Right click on the M8 Controller and select Properties.
3. Click the Setup tab.
4. In the Options section, check the 'Enable Duress Alarm Mode' box.
5. Click OK.
6. Expand the Doors folder to reveal Door 2.
7. Right click on Door 2 and select Properties.
8. Click the Entry Reader tab.
9. Click on the ScramblePad Options tab.
10. Check the 'Deny codes under duress' box.
11. Click OK.
12. Right click on the Controller and select Download > Configuration.
Step 2 - Test
At the Entry ScramblePad at Door 1 and 2, enter the numbers for several people we
have enrolled. (Make sure duress digit is set.)

At: Enter this PIN: The result is:

Door 1 111 access

222 access

1119 access with duress

2229 access with duress

Door 2 111 access

222 access

1119 denied with duress

2229 denied with duress

Example: Duress without Access

Step 1 - Controller Properties
1. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.

Examples: ScramblePad Options 987

Velocity Version 3.1 Administrator’s Guide

If you have not yet defined the M2 controller, go to “Basic Setup: Step 1 -
Controllers” on page 914.
2. Right click on M2.
3. Select Properties.
The M2 controller properties sheets appear.
4. Click the Setup tab.
The setup page appears.
5. In the 'Options' section, check the 'Enable Duress Alarm Mode' box.
6. Click OK.
Step 2 - Doors
1. In the system tree pane, expand M2 until all the dependent components are
displayed.
2. Click on the Doors folder.
3. In the components pane, double click Door 02.
Door 02's properties appear.
4. Click the Entry Reader tab. The entry reader pages appear.
5. Click the ScramblePad Options tab. The ScramblePad Options subpage appears.
6. Check the 'Deny Codes Under Duress' box.
7. Click OK.
Step 3 - Test
At Reader 1 on the M2:
1. Enter PIN 1111. Mike Conners should receive an access grant.
If Mike Conners is not yet enrolled, go to “Basic Setup: Step 5 - Users” on page
916.
2. Enter PIN 11119. (PIN 1111 plus the duress digit 9.) Mike Conner should be
granted access under duress.
 Make sure the duress digit is programmed.
The Alarm Viewer will pop up. Clear the beeping by acknowledging the alarm.
At Reader 2 on the M2 (Set to deny codes under duress):
1. Enter PIN 1111. Mike Conner should receive an access grant.
2. Enter PIN 11119. (PIN 1111 plus the duress digit 9.) Mike Conner should be
denied access under duress.
The Alarm Viewer will pop up. Clear the beeping by acknowledging the alarm.

Example: Silent Code Tamper

Under normal circumstances, three denials in a row result in a 'Code Tamper' condition.
The ScramblePad beeps and its red LED flashes; however, if you select the Silent Code
Tamper option, the beeps and flashing LED are suppressed.
This is useful in situations where a facility does not want to alert the intruder to
detection. It is only activated on a reader-by-reader basis. Two examples of code
tamper are shown here.

988 Examples: ScramblePad Options

 MAN006-0612

Example 1
Step 1 - Set up Silent Code Tamper
1. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
If you haven't defined the M8 controller yet, go to “Basic Setup: Step 1 -
Controllers” on page 914.
2. Expand the Controller folder then the Doors subfolder to reveal Door 3.
3. Right click on Door 3 and select Properties.
4. Click the Entry Reader tab.
5. Click on the ScramblePad Options tab.
6. Check the 'Silent Code Tamper' box.
7. Click OK.
Step 2 - Tests
 At Door 1, enter 100 (or another incorrect PIN) three times. You are denied with a
flashing LED and beeps.
 At Door 3, enter 100 three times. You are denied and the ScramblePad red LED
flashes.

Example 2
Step 1 - Doors
1. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
If you haven't defined the M8 controller yet, go to “Basic Setup: Step 1 -
Controllers” on page 914.
2. Double click M8.
The doors and other dependent components are revealed.
3. Highlight the doors folder.
All defined doors for M8 are displayed in the components pane.
4. Double click Door 02.
Door 02's Properties dialog box appears.
5. Click the Entry Reader tab.
6. Click the ScramblePad Options tab.
7. Check the 'Silent Code Tamper' box.
8. Click OK.
Step 2 - Test
1. At Reader 1 on the M8, enter PIN 100 three times.
Make sure PIN 100 is not already assigned.
• The reader will go into code tamper, flashing the red LED and beeping.
• The M8's alarm relay will fire.
• The Velocity Event Viewer will report a code tamper.
• The Alarm Window will pop up.
2. Silence the alarm by acknowledging it.
3. At Reader 2 on the M8, enter PIN 100 three times.

Examples: ScramblePad Options 989

Velocity Version 3.1 Administrator’s Guide

• The reader will go into silent code tamper, flashing the red LED but not
beeping.
• The M8's alarm relay will fire.
• The Velocity Event Viewer will report a code tamper.
• The Alarm Window will pop up.
4. Silence the alarm by acknowledging it.

Example: Code Tamper Disables Card or Code Holder

Code tamper can result from several infractions including invalid code, bad PIN, access
zone invalid, or passback violation. If the code tamper can be traced to a specific
credential, this option disables that credential.
To set up Code Tamper Disables User in Velocity:
1. At the Velocity Administration window, click on the DIGI*TRAC Configuration folder.
If you haven't defined the M8 controller yet, go to “Basic Setup: Step 1 -
Controllers” on page 914.
2. Expand the Controller folder then the Doors subfolder to reveal Door 4.
3. Right click on Door 4 and select Properties.
4. Click the Entry Reader tab.
5. Click on the ScramblePad Options tab.
6. Check the 'Code Tamper Disables User' box.
7. Click OK.
Now let's test the configuration.
At the Entry ScramblePad at Doors 1 and 4, enter the PINs for several people we have
enrolled.

Using this card, enter

At: The result is:
this PIN:

Door 1 Card 3, 333 access

Card 4, 444 access

Door 4 Card 3, 333 access

Card 4, 444 access

Card 3, 100 three times access denied and the user is disabled

Door 1 Card 4, 444 access

Card 3, 333 access denied: user already disabled

The credential can be re-enabled by selecting Override Code Tamper in the Credentials
pane.

Example: Code Tamper Disables Credential

Step 1 - Users
1. Open Enrollment Manager.
The Enrollment Manager main screen appears.
2. In left pane, click Add New Person.

990 Examples: ScramblePad Options

 MAN006-0612

The Personal Information form appears.

3. At the 'Name' fields, enter Dutch Holland.
4. Click Apply.
5. In the credentials pane, double click Add New Credential.
The credentials dialog box appears.
6. In the 'IDF' combo box, select 3-Dual.
7. In the 'Card' section in the MATCH text box, enter the MATCH number of a card.
8. In the 'PIN' text box, enter 1555.
9. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
10. Click Add...
The Define Function dialog box appears.
11. From the 'Function Category' combo box, select Relay.
12. From the 'Function' combo box, select Trigger.
13. From the 'Controller' combo box, select M8.
14. From the 'Control Zone' combo box, select SCZ 1.
15. Click the Add button.
16. Click OK.
17. Repeat Steps 2 - 15 for Jo March with PIN 2666.
18. Close the Enrollment Manager.
Step 2 - Doors
1. In the system tree pane expand the DIGI*TRAC Configuration folder to the
controller level.
If you haven't yet set up controller M8, go to “Basic Setup: Step 1 - Controllers”
on page 914.
2. In the system tree pane, double click M8.
The dependent components including the Doors appear below M8.
3. Highlight the Doors folder under M8.
4. In the components pane, double click Door 03.
5. Click the Entry Reader tab.
6. Click the ScramblePad Options tab.
The ScramblePad Options subpage appears.
7. Check the 'Code Tamper Disables User' box.
8. Click OK.
Step 3 - Test
At Reader 1, M8:
1. Present card 1, enter PIN 1555. Access granted.
2. Present card 2, enter PIN 2666. Access granted.
Reader 3, M8:
1. Present card 1, enter PIN 1555. Access granted.
2. Present card 2, enter PIN 2666. Access granted.
3. Present card 1, enter PIN 100 (an incorrect PIN) three times. The reader will go
into code tamper.
Reader 1, M8:

Examples: ScramblePad Options 991

Velocity Version 3.1 Administrator’s Guide

1. Present card 1, enter PIN 1555. Access denied - User disabled. This was the card
we used with the bad PIN.
2. Present card 2, enter PIN 2666. Access granted. This card is still working.
Step 4 - Enable User
1. Open Enrollment Manager.
2. From the right pane, click Dutch Holland.
Holland's personal information form appears.
3. From the credentials pane, right click on Holland's Dual Credential.
Several options pop-up.
4. Select Override Code Tamper.

Step 5 - Test
At Reader 1, M8:
 Present card 1, enter PIN 1555. Access granted.

Example: Green LED While Relay Active

A ScramblePad's green LED can now be configured to light up when the corresponding
door's relay is active. Use this feature on doors that are sometimes unlocked using
either an Unlock command or a time zone.
The lit state is for both access grants and other control events for the relay such as
Time Zone control.
 If the green LED is configured to remain lit all the time, this feature
toggles it; thus the LED would turn off when the relay is active.

Example 1
Step 1 - Doors
1. At the Velocity Administration window, click on the DIGI*TRAC Configuration folder.
If you haven't defined the M8 controller yet, go to “Basic Setup: Step 1 -
Controllers” on page 914.
2. Expand the M8 Controller folder then the Doors subfolder to reveal Door 2.
3. Right click on Door 2 and select Properties.
4. Click the Entry Reader tab.
5. Click on the ScramblePad Options tab.
6. Check the 'Green LED on while relay active' box.
7. Click OK.
Step 2 - Test
1. Go to Door 2.
2. Enter 111.
The green LED should blink on and remain on for 6 seconds while the relay is active.

Example 2
Step 1 - Doors

992 Examples: ScramblePad Options

 MAN006-0612

1. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
If the M8 controller is not yet defined, go to “Basic Setup: Step 1 - Controllers”
on page 914.
2. In the system tree pane, double click M8 to reveal the dependent doors.
3. Highlight the Doors folder.
All defined doors appear in the components pane.
4. In the components pane, double click Door 03.
5. Click the Entry Reader tab.
6. Click the ScramblePad Options tab.
7. Check the 'Green LED on while relay active' box.
8. Click OK.
Step 2 - Test
At Reader 3 on M8, enter PIN 1111. The green LED remains on for 6 seconds, while
the relay is active.
If user Mike Conner is not enrolled, go to “Basic Setup: Step 5 - Users” on page 916.

Example: Green Flash in Door Delay

Hirsch ScramblePads can be made to flash their green LED during a door delay.
For example, if you had configured 10-minute door delay, the green LED on the
ScramblePad tied to a bank vault would flash for 10 minutes after you entered the
correct code before the vault door would actually open.

Example 1
Step 1 - Doors
1. At the Velocity Administration window, click on the DIGI*TRAC Configuration folder.
If you haven't defined the M8 controller yet, go to “Basic Setup: Step 1 -
Controllers” on page 914.
2. Expand the Controller folder then the Doors subfolder to reveal Door 3.
3. Right click on Door 3 and select Properties.
4. Click the Entry Reader tab.
5. Click on the ScramblePad Options tab.
6. Check the 'Green LED flash during door delay' box.
7. Click OK.
8. Go to the system tree and right click on the Door 3 folder.
9. Select Properties.
The Door properties dialog box appears.
10. Click the Relay tab.
The Door Relay property sheet appears.
11. At the 'Door Delay Time' combo box, specify 5 seconds.
12. Click OK.
Step 2 - Test
1. Go to Door 3.
2. Enter PIN number 111.

Examples: ScramblePad Options 993

Velocity Version 3.1 Administrator’s Guide

The Green LED flashes for 5 seconds before the door opens.

Example 2
Step 1 - Doors
1. In the system tree pane, expand the DIGI*TRAC Configuration folder to the
controller level.
If the M8 controller is not yet defined, go to “Basic Setup: Step 1 - Controllers”
on page 914.
2. Double click M8 to reveal the Doors folder.
3. Highlight the Doors folder.
All doors appear in the components pane.
4. In the components pane, double click Door 03.
5. Click the Entry Reader tab.
6. Click the ScramblePad Options tab.
7. Check the 'Green LED flash during door delay' box.
8. If 'Green LED flash while relay active' is checked, uncheck it.
9. Click the Relay tab.
10. At the Timers section, click in the 'Door delay time' box and use the up arrow or
enter 5.00 seconds.
11. Click OK.
Step 2 - Test
 At Reader 2 on M8, enter PIN 2222. The green LED flashes for 5 seconds during
the door delay.
If user Rose Sayer is not yet enrolled, go to “Basic Setup: Step 5 - Users” on page
916.

Example: Yellow Flash for Control Delay

You can set the ScramblePad's yellow LED to flash while counting down during a
pre-defined control delay.
To configure yellow flashing during a control delay:

Example 1
Step 1 - Users
1. Open Enrollment Manager.
2. Select Kris Munroe from the list of persons.
If you haven't already created this person, refer to the “Basic Setup: Step 5 -
Users” on page 916 for her details.
3. If no credential yet exists for her, create one by double clicking Add New
Credential from either the credential pane or at the button at the bottom of the
Personal Information screen.
If a credential already exists, double click this in the credential pane.
The Credential dialog box for the new person appears.
4. At the General property sheet, specify IDF 1 and enter a PIN of 444.
5. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.

994 Examples: ScramblePad Options

 MAN006-0612

6. Click Add...
The Define Function dialog box appears.
7. At the 'Function Category' combo box, select Relay.
8. At the 'Function' combo box, select Trigger.
The 'Controller' and 'Control Zone' fields appear.
9. At the 'Controller' combo box, select M8.
10. At the 'Control Zone' combo box, select SCZ2.
11. Click the Add button.
The new function appears in the window below.
12. Click OK.
13. Close Enrollment Manager.
14. At the Velocity Administration window, click on the DIGI*TRAC Configuration folder.
If the M8 controller is not yet defined, go to “Basic Setup: Step 1 - Controllers”
on page 914.
15. Expand the Controller folder then the Doors subfolder to reveal Door 3.
16. Right click on Door 3 and select Properties.
17. Click the Entry Reader tab.
18. Click on the ScramblePad Options tab.
19. Check the 'Yellow flash during control delay' box.
20. Click OK.
21. From the system tree pane, right click on the Door 3 folder.
22. Select Properties.
The Door properties dialog box appears.
23. Click the Relay tab.
The Relay Setup property sheet appears.
24. In the Timers section, specify a five-second (5) delay at the 'Control delay time'
field.
Step 2 - Test
To test this:
1. Go to Door 3.
2. Enter 444.
The yellow LED should flash for 5 seconds before the door actually unlocks.

Example 2
Step 1 - Users
1. Open Enrollment Manager.
2. In the Persons pane, select Add New Person.
A new personal information form appears.
3. In the personal information form, enter Jeff Jeffries in the 'Name' fields.
4. Click Apply.
5. In the Credentials pane, double click on Add New Credential.
The General page of the Credential dialog box appears.
6. In the 'PIN' text box, enter 1333.
7. Click the Function tab.

Examples: ScramblePad Options 995

Velocity Version 3.1 Administrator’s Guide

The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. From the 'Function Category' drop-down combo box, select Relay.
10. From the 'Function' drop-down combo box, select Trigger.
11. From the 'Controller' drop-down combo box, select M8.
12. From the 'Control Zone' drop-down combo box, select SCZ 1.
13. Click the Add button.
14. Click OK.
15. Click OK again.
16. Close Enrollment Manager.
Step 2 - Doors
1. In the system tree pane, expand M8 until the Doors folder appears.
2. Highlight the Doors folder.
All available doors for M8 appear in the components pane.
3. In the components pane, double click Door 03.
The Reader Properties dialog box appears for Door 03.
4. Select the Entry Reader tab.
The Entry Reader page appears.
5. On the Entry Reader page, select the ScramblePad Options tab.
The ScramblePad Options sub-page appears.
6. Check the 'Yellow LED flash during control delay' box.
7. If 'Green LED flash during door delay' is checked, uncheck it.
8. Select the Relay tab.
The Relay Setup page appears.
9. In the 'Control delay time' field, use the up arrow or type 5.00 (seconds).
10. Click OK.
Step 3 - Test
 At Reader 03, enter PIN 1333.
The first yellow LED will flash for 5 seconds, during the control delay on Door 3. The
other doors in control zone 1 will come on without a delay.

996 Examples: ScramblePad Options

 MAN006-0612

Example: Threat Levels

Threat Levels can be established within a controller to change the behavior of doors,
typically to produce a higher level of security in an emergency. Threat Levels may be
set to an operator-selected value of 0 to 99.
There are three ways to change a Threat Level:
 By a ScramblePad and/or card reader, using a Code that is assigned an associated
Threat Level.
 By a Master Control Zone, which sets the Threat Level to an operator-selected
value.
 By a command from Velocity.
Each door has an option to disable the reader(s) when the Threat Level in the
controller is above an operator-selected value. The entry and exit readers can have
different disable values. Each door has an option to disable CCOTZ (Card or Code Only
Time Zone) operation (i.e., enforce Dual) for the entry and/or exit reader when the
Threat Level in the controller is above an operator-selected value. Here again, the entry
and exit readers may have different disable CCOTZ values.
Each user (credential in Velocity) can be assigned a Threat Authority between 0 and
99. When the Threat Level is greater than the assigned Threat Authority, the credential
will not perform its normal operation (e.g., access will not be granted).
For Basic Setup, refer to “Basic Example” on page 914. The following tests will not work
without the Basic Setup.
Step 1 - Users
1. Open Enrollment Manager.
The Enrollment Manager screen appears.
2. In the left pane, select Add New Person.
The Personal Information pane appears in the lower right.
3. In the 'Name' fields, enter Lutie Carmeron.
4. Click Apply.
5. Double-click on Add New Credential in the credential pane.
The General page appears.
6. In the 'PIN' text box, enter 1406.
7. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
8. Click Add...
The Define Function dialog box appears.
9. In the 'Function Category' drop-down window, select Special.
10. In the 'Function' drop-down window, select Set Threat Level.
11. In the 'Set Threat Level' drop-down window, type or select 10.
12. In the 'All Controllers' box, highlight the M8.
If M8 is not a choice, go to “Basic Setup: Step 1 - Controllers” on page 914.
13. Select the << button to move M8 to the 'Selected Controllers' box.
14. Click OK.
15. Click the Limits tab.
The Limits page appears.

Example: Threat Levels 997

Velocity Version 3.1 Administrator’s Guide

16. In the Threat Authority box on the right side, type or use the up arrow to select 11.
17. Click OK.
18. From the person pane, select Add New Person.
Another Personal Information pane appears.
19. In the 'Name' fields, type David Graham.
20. Click Apply.
21. Double-click Add New Credential in the credential pane.
22. In the 'PIN' field, enter 1407.
23. Click the Function tab.
The function property sheet appears with the Function(s) radio button selected.
24. Click Add...
The Define Function dialog box appears.
25. In the 'Function Category' drop-down window, select Special.
26. In the 'Function' drop-down window, select Set Threat Level.
27. In the 'Set Threat Level' drop-down window, type or select 0.
28. In the 'All Controllers' box, highlight the M8.
If M8 is not a choice, go to “Basic Setup: Step 1 - Controllers” on page 914.
29. Select the << button to move M8 to the 'Selected Controllers' box.
30. Click the Limits tab.
The Limits page appears.
31. In the 'Threat Authority' box on the right side, type or use the up arrow to select 11.
32. Click OK.
33. Close the Enrollment Manager.
Step 2 - Test
 Enter PIN 1406 at any reader on the M8. The threat level will change to 10.
 Enter PIN 1111 at the reader. Mike Conner will be denied for threat level.
 If Mike Conner, PIN 1111, is not enrolled, go to Basic Setup - Users.
 Enter PIN 1407 at the reader. The threat level will return to 0.
 Enter PIN 1111 at the reader. Mike Conner will be granted entry.

998 Example: Threat Levels

 MAN006-0612

Examples: Who's Inside

To see who is inside an affected area:
Step 1 - Setup
Use the instructions in Examples - Zoned Passback to set up the passback zones. In this
example, we want to move both Rose Sayer and Mike Conner from Zone 1 into Zone
2.
Step 2 - User Entry
1. Enter PIN 1111 at Door 4. Entry access granted from zone 1 to zone 2.
2. Enter PIN 2222 at Door 4. Entry access granted from zone 1 to zone 2.
Now both Conner and Sayer are inside zone 2.
Step 3 - Review Occupancy
1. From the menu bar, select Console > Who's Inside.
The Who's Inside screen appears. All currently defined zones appear in the Zone
pane.
2. In the Zone pane, click to select Zone 02.
Both Sayer and Conner should appear in the person window.
3. From the person window, right click on Rose Sayer.
Options pop up.
4. Select Display Credential.
Rose Sayer's default credential appears for the requisite number of seconds.

Examples: Who's Inside 999

Velocity Version 3.1 Administrator’s Guide

1000 Examples: Who's Inside

 MAN006-0612

Velocity Learning
Center
The Velocity Learning Center enables the operator to access these Velocity-specific
documents and tutorials:
 Velocity Online Help
 Release Notes
 Defects Fixed in the Release
 Known Issues
 Tutorials
 Velocity Quick Installation Guide (Adobe Acrobat required)
 Velocity Administrator's Guide (Adobe Acrobat required)
 Velocity Operator's Guide (Adobe Acrobat required)
 DIGI*TRAC Reference Information
 Uninstall Information
 Install Adobe Acrobat Reader
As noted above, several of these documents cannot be run or read without Adobe
Acrobat Reader. (Velocity includes a copy of the Adobe Acrobat Reader installer in the
option list.)
To open and use the Learning Center, see Opening the Velocity Learning Center. The
topics in this section include:

Topic See page:

How to Use the Learning Center 1003

Opening the Learning Center 1002

Learning Center Main Screen 1002

Closing the Learning Center 1003

1001
Velocity Version 3.1 Administrator’s Guide

Opening the Learning Center

To open the Learning Center:
1. Open Velocity.
The Velocity main screen appears.
2. From the menu bar, select Help > Velocity Learning Center.
The Velocity Learning Center main screen appears.

Learning Center Main Screen

The Velocity Learning Center website uses the Microsoft Internet Explorer or the default
browser on your computer. Its screen and function should be familiar to you.
The Learning Center screen looks like this example:

This screen contains these features:

Navigation Bar This bar depends on the browser you are using and contains the
necessary tools to navigate the screen.

Display Screen This window displays any linked topic requested.

Most web pages, including the main Velocity web page, contain
linked text and graphics that enable you to click and jump to
additional referenced page. For example, when you click Release
Notes, the program displays the release notes page in the
Display Screen window.
For more on using this screen, refer to “How to Use the Learning
Center” on page 1003.

1002 Opening the Learning Center

 MAN006-0612

How to Use the Learning Center

The Velocity Learning Center works like any other browser except that its focus is solely
the Velocity site.
Click on the linked text or graphic in the pane and the requested topic appears in the
pane.
Use your navigation tools at the top of the page as you would normally with your
browser.

Closing Learning Center

To close the Learning Center, do one of these:
 Click the button at the upper right corner of the Learning Center
 Press Ctrl + F4
You are returned to the main Velocity screen.

How to Use the Learning Center 1003

Velocity Version 3.1 Administrator’s Guide

1004 Closing Learning Center

 MAN006-0612

Report Manager
Use the Report Manager to generate reports on Velocity's activity. The Report Manager
comes with more than sixty standard reports for instant generation of reports dealing
with every aspect of your facility's security. Report Manager also includes sophisticated
sorting and filtering tools that enable you to customize reports to your specific
requirements.
The Report Manager currently supports reports for these topics:
 Customization Reports (3 reports)
 DIGI*TRAC Configurations (19 reports)
 History Logs (13 reports)
 Person Information (27 reports)
 Velocity Configuration (24 reports)
You can create additional report groups and reports as required.
Most report types a customer might desire are available as standard. However, for
those installations that require customized reports, Report Manager also imports
reports created using Crystal Reports, the industry-standard report formatter and
generator.
 You cannot open Report Manager until you have selected a report
printer in Preferences. If you attempt to do this, an error message will
appear. For more on this, refer to “Printers Preferences” on page 50.

1005
Velocity Version 3.1 Administrator’s Guide

The following flowchart below may help you understand how to use Report Manager.

The subjects covered in this chapter include:

Topic Refer to:

Opening Report Manager page 1007

Report Manager Main Screen page 1008

Creating a Report page 1011

Customizing an Existing Report page 1018

Exporting Reports page 1032

Importing Reports page 1034

Preview Screen page 1025

Report Groups page 1037

Report Definition Files page 1035

Save Custom Reports page 1025

1006
 MAN006-0612

Opening Report Manager

Before you can open any reports or use the Report Manager, you must first select one
of the printers attached to this system as the report printer on the Printers page of
Preferences. If you try to open Report Manager without this selection, you get an error
message and Report Manager won't open.
To open Report Manager:
1. Open Velocity.
The Velocity screen appears.
2. Do one of the following:
• Click the Reports icon on the Icon bar, .
• From the Components window, double click the Report Manager module.
• From the Velocity option bar, select Console > Report Manager.
The main Reports Manager screen appears like the following example:

For details on the Report Manager main screen, refer to the next topic, “Report
Manager Main Screen” on page 1008.

Opening Report Manager 1007

Velocity Version 3.1 Administrator’s Guide

Report Manager Main Screen

The main Report Manager screen looks like this example:

The screen contains a number of parts each of which is explained below.

Menu tool bar This includes three options and associated sub-options.
For more on this, refer to “Report Manager: Menu Bar” on page
1009.

Icon tool bar This bar gives you access to the basic Report Manager functions.
For more on this, refer to “Report Manager: Icon Tool Bar” on
page 1010.

Use Report Check this box to use the default criteria and sorting settings for
Default each page. The program automatically generates a report based
Criteria and on the default ordering and criteria.
Sorting To customize an existing report by creating new criteria and
sorting, leave this box unchecked. The fields below the box are
activated.
Note: You cannot customize reports unless this box is unchecked.

Criteria page This page enables you to select all the database fields or select
one or more fields on which to report.
For more on this, refer to “Criteria Page” on page 1021.

Sorting page Click the Sorting tab to display this page. This page enables you
to sort criteria by columns.
For more on this, refer to “Sorting Page” on page 1023.

Selected This pane displays all criteria selected (added) by the Criteria
Criteria List and Sorting pages. You can change the criteria for either
pane selecting or sorting the information you need right in this pane.
For more on this, refer to “Selected Criteria List Pane” on page
1024.

1008 Report Manager Main Screen

 MAN006-0612

Report Tree This pane displays all currently available reports. Simply select a
pane report from the list and then either print it or use the Criteria and
Sorting pages to customize it, if required.
An expanded version of this pane is shown in the following
example:

You can also add a new report folder to this tree, add a new
report, and import externally created reports to populate the
report group.

Report Manager: Menu Bar

The Report Manager menu bar includes these options:

File

Print Preview Bring up the Print Preview Screen for the currently selected
report. This option is also available through the icon tool
bar.

Print (Ctrl + P) Print the currently displayed report to a predetermined

printer. This option is also available through the icon tool
bar.

Exit Exit Report Manager.

Edit

Reports Delete – Delete the currently selected report group.

Rename – Rename the currently selected report group.
New Report Definition File... – Create a new report
definition file. For more on this, refer to “Report Definition
Files” on page 1035.
Edit Report Definition File... – Edit an existing report
definition file. For more on this, refer to “Report Definition
Files” on page 1035.
Import Report and Report Definition File – Import an
existing report and its associated definition file. For more on
this, refer to “Importing Previously-Exported Reports” on
page 1035.
Export Report and Report Definition File – Export an
existing report and its associated definition file to a backup
location. For more on this, refer to “Exporting Reports &
Report Definition Files” on page 1032.

Report Manager Main Screen 1009

Velocity Version 3.1 Administrator’s Guide

Refresh Refresh data for the currently displayed report. All values
are immediately updated.

Preferences... Access the Report Manager preferences page.

For more on this, refer to the “Preferences” on page 1038.

Help

Help Topics Consult the online help for Report Manager.

Version Find the version number of this module.

Report Manager: Icon Tool Bar

The Report Manager icon bar includes these functions:

Print the report.

Preview the report before printing.

Add a report group.

Add a new report.

Import a report and report definition file.

Export a report and report definition file.

Add a new report definition file.

Edit an existing report definition file.

Delete report.

1010 Report Manager Main Screen

 MAN006-0612

Creating a Report
This section describes how to create and print a report.
 Before you can open any reports or use the Report Manager, you must
first assign a printer as the report printer on the Printers page of
Preferences. If you attempt to do it without this assignment, you get an
error message.
To create and print a report:
1. Open Report Manager.
The Report Manager main screen appears.
2. From the Report Tree pane, select one of the existing reports.
The criteria for that report are loaded into the Criteria page.
3. Select one of these options:
• To specify a report with the full complement of criteria defined by the default
report, check the 'Use Report Default Criteria and Sorting' box.
• To customize your report further—including or excluding components and
fields as well as defining precise criteria for this report—leave the 'Use Report
Default Criteria and Sorting' unchecked then customize the report.
4. When you're finished, do one of these:
• Click the Preview button, . The Preview screen appears as described on
page 1027.
• Select File > Preview from the menu bar to review the finished report before
printing it. The Preview screen appears as described on page 1027.
• Double click the report in the report tree.
5. Do one of these:
• From the Print Preview screen, click the Print button, .
• From the main Report Manager menu bar, select File > Print.
The report is printed.

Add a New Report

To add a new report:
1. Import the file you want to use from another source—such as Crystal Reports or
Report Manager export.
2. From the report tree pane, right click the Report Group into which you want the
new report placed.
If you need to create a new report group for this report, refer to “Report Groups”
on page 1037.
An option list pops up.
3. Select Add > Report...

Creating a Report 1011

Velocity Version 3.1 Administrator’s Guide

The Add Report dialog box appears like this example:

By default, the dialog box selects the \Reports subdirectory.

4. If required, select another directory.
Most of the time, you will want to store all reports in the default directory.
5. At the 'File name' combo box, either enter a new name or specify an existing
name.
6. Click Open.
The new file is added to the report tree in Report Manager.
Once this is done, you can customize the report as required.

List of Existing Reports

Velocity currently supports these reports:

Customization Reports

Components All Components settings currently recognized by Velocity as

Customization specified in Customization Manager.

Events All event settings—such as alarms, RTNs, events, and

Configuration software—currently recognized by Velocity. This includes not
only DIGI*TRAC hardware events but also integrated device
events, such as DVR and CCTV events.

Point All point customizations performed by qualified operators

Customizations using Customization Manager.

DIGI*TRAC Configuration

Controller Master All settings for all master control zones by controller.
Control Zone

Controller All settings associated with controller passback zone

Passback Zone occupancy settings.
Occupancy

Controller All settings for all standard control zones by controller.

Standard Control
Zone

Controllers Brief summary of all controllers on this system.

1012 Creating a Report

 MAN006-0612

Controllers with All attributes defined for each controller in the system,
Detail including ID, name, description, address, model number,
general setups, and miscellaneous setup parameters such as
alarm relay timer settings.
Basically anything entered in the Controllers configuration
dialog box is reflected on this page.

Doors Brief summary of doors associated with each controller on

this system.

Doors with Detail Complete description of all settings for each door in system.

Expansion Inputs Brief summary of inputs defined for or recognized by the

system.

Expansion Inputs Complete description of all settings for each expansion input
with Detail in the system.

Expansion Relays Brief summary of all expansion relays defined for or

recognized by the system.

Expansion Relays Complete description of all settings for each expansion relay
with Detail in the system.

Inputs Brief summary of all inputs defined for or recognized by this

system including the module type and all other settings
defined by the Input Configuration dialog box.

Inputs with Detail Complete description of all settings for each input in the
system.

Network Layout Description of each site defined for this system,

cross-referenced by server and port. This includes most of the
information specified in the System Tree pane.

Printers Brief summary of each printer recognized by the system.

Readers Brief summary of each reader defined for or recognized by

this system including all settings defined by the Reader
Configuration dialog box.

Readers with Complete description of all settings for each reader in the
Detail system.

Relays Brief summary of each relay defined for or recognized by this

system including settings defined by the Relay Configuration
dialog box.

Relays with Detail Complete description of all settings for each relay in the
system.

History Logs

Acknowledged All acknowledged and cleared alarms cross-referenced by the

Cleared Alarms by operator who acknowledged or cleared them.
Operator

Creating a Report 1013

Velocity Version 3.1 Administrator’s Guide

Active Alarms by All unacknowledged/uncleared alarms cross-referenced by

Date date.

Active Alarms by All unacknowledged/uncleared alarms cross-referenced by

Date with date with comments.
Comments

Alarm Log by Date Complete log of all alarms, both acknowledge and
unacknowledged, cross-referenced by date

Alarm Log by Date Complete log of all alarms, both acknowledge and
with Comments unacknowledged, cross-referenced by date with any
comments entered by the operator for individual alarms

All Events Log by Complete list of all events ordered by category (e.g. event
Category type).

All Events Log by Complete list of all events logged by the system, ordered by
Date date.
Note: It has been reported that after restoring a 2003 server
database on a SQL 2008 server, the All Events Log by Date
report will not open. To fix this, simply delete or rename the
Velocity LDF files from the Microsoft SQL Server/MSSQL/data
subdirectory. The appropriate LDF files will be regenerated
and the report should open without difficulty.

External Events List of all external events logged by Velocity.

Log

Internal Events Log List of all internal events logged by Velocity.

Operator Log List of all events recorded by operators, sorted operator.

Transaction Log List of all transactions recorded by the system.

Transaction Log by List of all transactions recorded by the system and sorted by
Transaction Type transaction type.

Person Information

Active Credentials List of all active credentials including the first three
with User-Defined user-defined fields.
Fields 1-2-3

Credential Current Lists the current issue status for all credentials registered by
Issue Status the Enrollment Manager for this system including credential
number, last access date, net address, and so on. The card
and code numbers are not included here.

Credential Current Lists the current issues status for all credentials with UDF 1, 2,
Issue Status (with or 3 registered by the Enrollment Manager for this system.
UDF 1-2-3)

Credential Reissue Lists the reissue history for each existing credential.
History

Credential Status Lists the current status for each existing credential.

1014 Creating a Report

 MAN006-0612

Credential Status Lists the current status for all credentials registered by the
with Codes and Enrollment Manager for this system including Code and Card
Cards numbers.

Door Access by Times when each door in the system was accessed,
Person cross-referenced by the person seeking access.

Dossier Style by List of all persons registered by Enrollment Manager including

Person their photograph and signature (where available),
cross-referenced by person.

Expired And List of all persons whose credentials have expired or are
To-Be-Expired about to expire, cross-referenced by Name, Credential ID,
Person Access Function, Function Group, Activation Date, Expiration Date
and Door Group.

Expired List of all credentials whose expiration dates have passed

Credentials without update or renewal. This does not include the code or
card number.

Expired List of all credentials whose expiration dates have passed

Credentials with without update or renewal including the code or card
Codes and Cards number.

Expired Person Summary of all accesses granted to each person whose

Access Summary credential has expired.

Inactive and List of all credentials that are now either inactive or disabled.
Disabled
Credentials

Last Access by List of the last access granted for each person, sorted by
Person person.

Lost Cards List of all credentials that are recorded as lost. This does not
include the code or card number.

Lost Cards with List of all credentials that are recorded as lost with code or
Codes and Cards card number.

Lost Cards with List of all credentials that are recorded as lost with their
User-Defined associated user-defined field values for UDFs 1 - 3.
Fields 1-2-3

Person Access and List of credentials sorted by person and function groups
Function Group assigned to each credential.
Summary

Person Access and List of credentials sorted by person and function groups
Function Group assigned to each credential. This includes the code and card
Summary with numbers for each credential.
Codes and Cards

Person Access by List of all accesses granted or denied cross-referenced by

Door door.

Creating a Report 1015

Velocity Version 3.1 Administrator’s Guide

Person Access Summary of all accesses either granted or denied for each
Summary credential cross-referenced by persons.

Person Access Summary of all accesses either granted or denied for each
Summary with credential cross-referenced by persons. This includes the
Codes and Cards code and card numbers for each relevant credential.

Person Function Summary of the function groups to which each credential is

Group Summary assigned cross-referenced by the people possessing the
credential.

Person Function Summary of the function groups to which each credential is

Group Summary assigned cross-referenced by the people possessing the
with Codes and credential. This includes the code and card numbers for each
Cards relevant credential.

Person Summary Brief summary of every person defined by the system.

with UDF 1-2-3

Person Summary Brief summary of every person defined by the system

with Codes and including their code and card numbers.
Cards

Who is Inside List of all people currently identified as inside one or more
Where defined passback zones.

Velocity Configuration

Badge Templates List of all currently defined badge templates.

Command Sets List of command sets defined for this system with ID, name,
command type, affected devices, and command string
entered. All information entered in the Command Sets dialog
box is shown here.

Comports List of COM ports currently defined for and connected to this
Velocity system. This includes controllers, printers, switchers,
cameras, and photo/signature capture devices.

Credential List all credential templates currently defined for this system.
Templates

Door Groups List of all defined door groups with basic settings.

Door Groups with List of all defined door groups with a list of the persons
Persons assigned to them.

Function Group List of all extensions defined for each Function Group,
Extensions cross-referenced by the Function Group.

Function Groups List of functions groups defined for this system

with Persons cross-referenced by the persons assigned to each group.

Functions with List of functions cross-referenced by the persons authorized

Persons to use them. Functions are defined by the 'Function' field
under the function page of the credential dialog box.

1016 Creating a Report

 MAN006-0612

Holiday Schedules All holiday schedules as defined by the Holiday dialog box.

Holidays All holidays defined by the Holiday dialog box.

Linked Credentials A list of all credentials that currently linked to their credential
templates.

Master Door List of all master door groups defined for this system
Groups including all door groups included in this master group.

Master Door List of all master door groups defined for this system
Groups with including all persons associated with each door group
Persons included in this master group.

Operators List of all operators defined for the system by the Operator
Properties dialog box.

Person Groups List of all currently defined person groups.

Person Templates List of all currently defined person templates.

Roles with List of all currently defined roles with the operators
Operators (members) to which they are assigned.

Roles with List of all currently defined roles with an exhaustive list of
Permissions permissions defined for each.

Time Zones - List of all Grand Master Time Zones as defined by the Time
Grand Master Zone matrix.
Time Zones

Time Zones - List of all Master Time Zones as defined by the Time Zone
Master Time matrix.
Zones

Time Zones - List of all Standard Time Zones as defined by the Time Zone
Standard Time matrix.
Zones

Time Zones - List of all standard time zones currently in use as defined by
Standard Time the Time Zone matrix.
Zones in Use

Trigger Actions List of all the trigger actions currently defined by the Trigger
Action Manager.

Creating a Report 1017

Velocity Version 3.1 Administrator’s Guide

Customizing an Existing Report

You have the choice of either generating the pre-defined reports that come with
Velocity or customizing the reports by eliminating certain criteria from the final list or
sorting the existing criteria in any manner you need.
To customize an existing report:
1. Open Report Manager.
The Report Manager main screen appears.
2. From the Report Tree pane, select one of the existing reports.
The available data fields for that report are loaded into the 'Field' combo box on
the Criteria page.
For example, if you selected Readers from the System Tree pane, the 'Field'
combo box identifies four possible options:
• Reader Name
• Controller Name
• Index
• Address
The options displayed in the 'Function' combo box vary according to the options
selected in the 'Field' combo box.
3. From the 'Field' combo box, select one of the available options.
Depending on the report type and option you selected in the 'Field' combo box,
several different combo and text boxes can appear.
4. Click and select appropriate values in the one or more fields that now appear in
the 'Function' area.
Additional fields and boxes appear depending on the field and arguments
specified.
5. In the 'is' field, select either is or is not.
6. In the next field, select one of the available arguments, including equal to, less
than, greater than, starting with, or like.
If you specify the 'greater than' or 'less than' argument, an additional field 'or equal
to' check box appears. Check this box to indicate that the argument includes an
equal to clause, such as 'greater than or equal to'.
7. In the variable window, do one of these:
• If you specify the 'equal to' argument, the variable window expands to
become a pick list from which you select one or more values. Select one or
more options from this list. If this report supports a range of values, you can
click the beginning value then hold down the Shift key and click the last value
in the range. To select non-contiguous values, hold down the Ctrl key while
clicking.
• If you specify the 'starting with' or 'like' argument, enter the value you want
the report to start with or be like.
• If you specify 'greater than' or 'less than', enter the value this criterion will be
greater than or less than. If it is also equal to, check the previous box.
For more on the criteria page, refer to the “Criteria Page” on page 1021.
8. When you're finished with this specific criterion, click the Add button.
The criterion is displayed in the Selected Criteria List pane.

1018 Customizing an Existing Report

 MAN006-0612

9. Repeat steps 3 - 8 to add more criteria to this report.

An example of a typical customization process is shown below:

If you have selected one of the UDF reports, like the Person Summary (with UDF
1-2-3) or the Active Credentials With User Defined Fields 1-2-3, an additional
section appears below the variable fields called ‘Select which user defined fields to
appear on the user defined columns’, like this example:

10. If the 'Select which user defined fields...' section appears, from the three available
drop-down lists, select up to three user-defined fields you want to appear as
columns in the customized report.
11. If you need to add sorting elements to your report specifications, click the Sorting
tab and the Sorting Page appears.
12. From the 'Field' combo box, select the item (field) by which you want to sort.
The values appearing on the combo box list depend on the type of report you
have selected.
13. From the 'Direction' combo box, select either Ascending or Descending.
This indicates in which direction the selected field is used to sort: from least to
greatest value or vice versa.
For example, if you select 'Input Index' as the sorting point and indicate it should
be used as an Ascending sorting feature, then the Report Manager sorts the report
according to the Input Index, starting from the smallest value and proceeding down
the list to the highest value.
14. Click Add and the Sort Field function is added to the Selected Criteria List.
15. If there are any other sorting criteria you need to add, repeat steps 11 - 13.

Customizing an Existing Report 1019

Velocity Version 3.1 Administrator’s Guide

An example of the sorting customization process is shown below:

16. Go to the Selected Criteria List pane and click any line (criterion) you need to edit.
• To nest the line as an expression, click in the specific line's open parenthesis
column. A combo box appears. Select the number of parentheses you need
for this expression. To close the nested expression, click in the closed
parenthesis column of the specific line and another combo box appears.
Select the number of closed parentheses you need to satisfy this expression.
• To add an AND argument to include or an OR argument to exclude this part of
the expression, click in the AND/OR column of this line and a combo box
appears. Select either AND or OR.
To remove a line, select it and press Delete.
17. Continue to edit lines to create boolean expressions as required.
A simple example of this process is shown below:

18. When you're finished, click the Preview button, , or select File > Print
Preview from the menu bar to review the finished report before printing it.
19. If you need to modify the column header names appearing on this report, modify
the Report Definition File; otherwise, skip this step and continue to the next.
For more on the Report Definition File, refer to “Report Definition Files” on page
1035.
20. To save the custom report, refer to “Saving Custom Reports” on page 1025.
21. To print the report, click the Print button, , or select File > Print from the
menu bar to print the report.

1020 Customizing an Existing Report

 MAN006-0612

Criteria Page
The Criteria page is one of two pages displayed at top right on the Report Manager.
Select the page by clicking the Criteria tab. The page looks like this example:

This page contains these fields:

Use Report Uncheck this box to customize the criteria and sorting for this
Default report. When checked, the default settings for this report are
Criteria and accepted.
Sorting The default for this box is checked.

Field Click this combo box and select from the drop-down list the fields
you want to include in this report. You can only select one field at a
time.
The fields that appear in this pick list depend on the report you
have selected in the report tree pane. For example, fields included
in the Standard Time Zone report are different from those
displayed for the Network Layout report.
When you select a field, the Function combo boxes are activated.

Function When you select a field in the Field combo box, the Function
combo box is activated. Depending on the field specified, this
section can display a number of different fields and combo boxes.
Several are listed below:

Click this combo box and select either is or is not from the
drop-down option box. These are the two allowed arguments for
the field to the right. The default argument is is.

Customizing an Existing Report 1021

Velocity Version 3.1 Administrator’s Guide

Click this combo box to select one of the operators from the
drop-down option list to complete this argument. These operators
include:
• like – the value selected from the Variable window is similar to
the values for this parameter you wanted reported from the
Velocity database.
• equal to – the value selected from the Variable window is
identical to the values for this parameter you want reported
from the Velocity database. If this value is selected, the variable
window expands to include a pick list of all possible values.
• less than – the value selected from the Variable window is less
than the values for this parameter you wanted reported from
the Velocity database. If this option is selected, the additional 'or
equal to' field appears.
• greater than – the value selected from the Variable window is
greater than values for this parameter you wanted reported from
the Velocity database. If this value is specified then an additional
'or equal to' field appears.
• starting with – start with the value selected from the Variable
window and proceed forward using the Velocity database.
The default argument is like.

Variable Once you have selected an option in the 'Field' combo box and
window the required options in the 'Function' fields, one or more windows
or combo boxes appear below the argument combo box. This can
be a simple text box like this:

into which values are entered, or more extensive pick lists like this
example:

You are expected to either enter a value in this field or pick one or
more elements from the available pick list.
Once you have supplied this criteria, click Add to display the final
criterion in the Criteria List window.
For example, if you selected Server ID from the Field combo box
for Network Layout, all of the currently defined server IDs would
appear in this window.

1022 Customizing an Existing Report

 MAN006-0612

Select If you select a report involving UDFs, like one of the following
which user reports:
defined • Active Credentials with User Defined Fields 1-2-3
fields...
• Credential Current Issue Status (with UDF 1-2-3)
• Inactive and Disabled Credentials
• Lost Cards With User Defined Fields 1-2-3
• Person Summary (with UDF 1-2-3)
• Person Summary with Codes and Cards
an additional section appears below the variable fields, like this
example:

From the three available drop-down lists, select up to three

user-defined fields you want to appear as columns in the
customized report.

Add Click this button to add the full argument to the list of report items
needed for this customized report.
The new argument appears in the Selected Criteria List window.

For example, say you only wanted to see a report on Server ID1. You would select
Network Layout from the Report Tree pane, then select 'Server ID' from the Field
combo box. All the currently-defined server IDs would appear. Select '1' from the
window and specify in the Function combo boxes 'is' and 'equal to.' Then click the Add
button and the criterion appears in the Selected Criteria List.
You can make a criterion that is still more complex using the arguments in the Selected
Criteria List window.

Sorting Page
When you click the Sorting tab on the Report Manager screen, the sorting page appears
like this example:

Customizing an Existing Report 1023

Velocity Version 3.1 Administrator’s Guide

This page contains these fields:

Field Click this combo box and select from the drop-down list one or more
of those fields you want to sort for in this report. You can only select
one field at a time. When you select a field, the possible values for
that field appear in the variable window.
Fields change according to which report is selected; for example,
fields included in the Standard Time Zone report are different from
those displayed for the Network Layout report.
If you select a criterion in this combo box, the Function combo boxes
are activated. When the All field is deselected, this field is activated.

Direction Click this combo box and select either Ascending or Descending from
the drop-down option box. Ascending is the default.
If you select Ascending, all items detected in the Velocity database for
the selected field will appear in the report listed from
earliest/smallest/least significant to latest/largest/most significant.
If you select Descending, all items detected in the Velocity database
for the selected field will appear in the report listed from
latest/largest/most significant to earliest/smallest/least significant.

Add Click this button to add the sort specification to the list of report items
needed for this customized report. The new sort specification
appears in the Selected Criteria List window.

For example, say you only wanted to sort all port type items in the Velocity database
from 1 through the end of its range for a Network Layout report.
To do this:
1. Click the Sorting tab to access the Sort page.
2. Click the 'Field' combo box and select Port Type.
3. Click the 'Direction' field and select Ascending.
4. Click the Add button.
The criterion appears in the Selected Criteria List as a Sort Field selection.

Selected Criteria List Pane

Use the Selected Criteria List window to customize a query still more using parentheses
to nest arguments and the AND/OR expression to include or exclude arguments
clauses.

1024 Customizing an Existing Report

 MAN006-0612

The pane possesses these fields and buttons:

( Select a specific line then click under the open parenthesis column.
A drop-down option list appears. Select the option you want to insert
one or more parentheses into the selected criteria. The parenthesis
function enables the building of nested arguments. The default is
blank.

Criteria The entries built through the Criteria and Sorting pages.
To add parentheses or an AND/OR argument to the criterion, click
and highlight the entry.

) Select a specific line then click under the closed parenthesis column.
A drop-down option list appears as shown below.

Select the option you want to insert one or more parentheses into
the selected criteria. The parenthesis function enables the building
of nested arguments. The default is blank.

AND/OR Select a specific line then click under this column. A drop-down
option list appears as shown below.

If needed, select an AND or OR argument to the selected criterion;

otherwise, leave blank.

You can customize your query as you like using this pane. The software does not make
assumptions for the user anymore. Meaning they have to know what they are doing or
it won't fly. Primarily, they have to know where and when to add Open and Closed
Parenthesis, and know where and when to add the appropriate AND/OR modifier.
Read the expression in the window like a book: left to right, top to bottom. The criteria
arguments come first followed by the sorting arguments. In the example above, you
can see that the query only returns Inputs that are named 'Input 01' OR 'Input 02'. This
query will then sort the list by the Input Index in ascending order.
The parenthesis are added to show you they can be there. But the reality is, for this
simple query, you don't need them. Report generation will run either way. The
parenthesis function is to allow the building of complicated queries.

Saving Custom Reports

To save a custom report for future use:
1. Customize the report as required.
2. Click to preview the custom report.
The Preview screen appears.
3. At the Preview screen, click the Export icon, .

Customizing an Existing Report 1025

Velocity Version 3.1 Administrator’s Guide

The Export dialog box appears.

For more on exporting reports, refer to “Exporting Reports” on page 1032.

4. From the 'Format' combo box, select Crystal Reports (RPT).
5. From the 'Destination' combo box, select the destination for this file.
Normally this is Disk File.
6. Click OK.
The Choose Export File dialog box appears.
7. Navigate to the directory where you want this file to be stored. In most cases, you
will specify the Program Files\Hirsch Electronics\Velocity\Reports directory.
8. In the 'File name' field, enter a name for this file, such as New Report.rpt.
9. Click Save.
You are returned to the Preview screen.
Two files are created: the data file, RPT, and the report definition file, tmp. You can
use these two files to import the custom report into Crystal Report. If you need to
re-import this custom report back into Velocity, refer to “Importing Reports” on
page 1034.
10. Do one of these:
• If you need to print this report, do so now using Step 20 in Customize an
Existing Report then exit the Preview screen. The main Report Manager screen
reappears.
• Exit the Preview screen. The main Report Manager screen reappears.

1026 Customizing an Existing Report

 MAN006-0612

Previewing a Report
To preview a report:
1. From the Report Tree pane, click to select the report you want to preview.
2. Do one of these:
• From the icon bar, click the preview icon, .
• From the menu bar, select File > Preview.
• From the Report Tree pane, double click the report you want to preview.
The Preview Screen appears. For more on this, refer to “Report Preview Screen” on
page 1027.
3. Review the report and, if required, print it directly from the preview screen or
export it.

Report Preview Screen

The Report Manager Preview screen looks like the following example:

The fields on this screen include:

Icon Tool Provides many functions such as print, copy, refresh, and export in
Bar addition to basic navigation functions.

Criteria Shows the criteria currently specified for this version. If this is not a
selection customized report, All appears here. To suppress this feature, refer to
“Preferences” on page 1038.

Icon Displays the Velocity program logo. To hide this feature, refer to
“Preferences” on page 1038.

Company Displays the name of your company. To show this feature and specify
title the company name, refer to “Preferences” on page 1038.

Report Displays information that can be both viewed and manipulated.

Screen Refer to the description below for more on this.

Previewing a Report 1027

Velocity Version 3.1 Administrator’s Guide

The columns that appear on the report screen depend on the type of report you
generate. The previous example provides columns of data relevant to active alarms;
another type of report, such as Expansion Inputs, presents different columns and data,
as in the following example:

The Preview screen has these tool bar controls:

Click: To:

Exit the current report preview and return to the Report Manager.

Print the displayed report.

Display the Export dialog box and save this screen to file. For more on
this, refer to “Saving Custom Reports” on page 1025.

Refresh the current screen. This incorporates any new information

about the components that have been added to the database since
Report Manager generated the preview screen.

Specify the size of the page displayed on the screen. Select from the
available options.
The default is 100% but you can select another setting to increase or
decrease the size of the page you see.

Go to the first page of this report.

Go to the previous page of this report.

Go to the next page of this report.

Go to the last page of this report.

Halt report generation. This effectively stops the generating process.

Bring up the Search dialog box and search the currently displayed
report for the entered text string.

The report preview screen includes a footer that indicates the page number for this
page, if this is a multi-page report, as well as the total number of pages.

1028 Previewing a Report

 MAN006-0612

Additionally, you can view and manipulate information on the Report Screen through
various right click options. For more on these, refer to the “Preview Screen Features”
starting on page 1029.

Preview Screen Features

The preview screen provides several features that can help you in locating data. One
method for locating a specific piece of information in the Velocity SQL database, is to
mouse over the data in the Report Preview screen. The exact location of the
information appears in a yellow pop-up like the following example:

Another method for ascertaining information as well as copying information to another

program, is right clicking on the data in the Report Preview screen.
A list of options like this example appears:

Depending on which data you select one of these options appears:

Field: Indicates the field within the Velocity SQL database where this piece
xxx of information resides.

Copy Select this option to copy this information to the Windows buffer from
where you can paste it into any other program, such as Word.

Previewing a Report 1029

Velocity Version 3.1 Administrator’s Guide

Freeze Select this option to create a page partition marker like this example:
Pane

You can scroll information that exists below this point but not above it.
This is useful as a way to page-mark information you think is
important for closer scrutiny.

Unfreeze Select this option to remove an existing page markers.

Pane

1030 Previewing a Report

 MAN006-0612

Printing Reports
To print a report:
1. From the Report Tree pane, click to select the report you want to print.
2. Do one of these:
• From the icon bar, click the print icon, .
• From the menu bar, select File > Print.
• From the keyboard, press Ctrl + P.
The report is printed to the printer specified on the Velocity Preferences printers
page.
You can hide the Velocity logo and put the name of your company at the top of the
page through the Report Manager Preferences page.

Printing Reports 1031

Velocity Version 3.1 Administrator’s Guide

Exporting Reports
Use this feature to export a report to a text file for Crystal Reports or another report
generator. There are two methods:
 Export both the report and the report definition file at the same time
 Export the report in one of several formats.

Exporting Reports & Report Definition Files

The simplest way to export an existing report is to use the Export Report and Report
Definition File feature. This feature automatically exports the selected report in the
default Crystal Reports format, .rpt.
To export a file in some other format, use the second method, Exporting Reports.
To export a report definition file and a report:
1. If required, create the report you want.
If the report already exists, skip to Step 2.
2. From the Report tree pane, click to highlight the report you want to export.
3. From the Report Manager icon bar, click the Export Report Definition File icon, .
Both the report itself (.rpt) and the report definition file (.rdf) file associated with this
report are automatically exported to the Velocity default report directory,
...\Velocity\Reports.

Exporting Reports
This method gives you greater control of the export process, enabling you to select
from one of many report formats. It is also the only method for exporting a customized
report. This method does not, however, automatically generate a report definition file
so that if you need to re-import this file, you must create a new RDF during the
importing process.
For more on this, refer to “Importing Reports” on page 1034.
To export a report:
1. If required, create the report you want or customize an existing report.
If the report already exists, skip to Step 2.
2. From the Report tree pane, click to highlight the report you want to export.
3. Preview the report.
4. At the Preview screen, click the Export icon, .
The Export dialog box appears.

5. From the 'Format' combo box, select the option you need.

1032 Exporting Reports

 MAN006-0612

Select from the following formats:

Option Description

Acrobat Format The file is exported as an Adobe Acrobat file. This is

(PDF) the default format.

Crystal Reports The file is exported as a Crystal Reports file (version

(RPT) 8.0 or later).
This is the default format.

MS Excel 97-2000 The file is exported as an Excel .xl file that can be
read by any Excel version from 97 to 2000.

MS Excel 97-2000 The file is exported as an Excel .xl file with data only.
(data only) This file can be read by any Excel version from 97 to
2000.

MS Word The file is exported as a Word .doc file that can be

read by any MS Word program.

Rich Text Format The file is exported as a Word RTF file. This file can
be imported by any version of Microsoft Word.

Separated Values The file is exported as a flat file with each column
(CSV) separated by a comma.

Tab-separated text The file is exported as a text file with each column
and each line separated by a tab.

Text The file is exported as a simple text (.txt) file.

XML The file is exported as an XML file (.xml).

6. From the 'Destination' combo box, select the destination for this file.
Normally this is Disk File.
7. Click OK.
8. In the 'Separator' field, select the character you want to use to separate one
column from another. In the 'Delimiter' field, select the character you want to use
to separate one row from another.
The default separator is a comma and the default delimiter is a quotation mark.
The Choose Export File dialog box appears.
9. Navigate to the directory where you want this file to be stored.
Normally, you should specify Program Files\Hirsch Electronics\Velocity\Reports.
10. In the 'File name' field, enter a name for this file, such as New Report.rpt.
11. Click Save.
You can now import this report into Crystal Reports or another report program as
required.

Exporting Reports 1033

Velocity Version 3.1 Administrator’s Guide

Importing Reports
Use these instructions to import a report. The report can be either a report
previously-exported from Velocity or a report created by Crystal Reports.
 Before a report can be imported, it must be in the proper Crystal Reports
format.
To import a report:
1. Open Report Manager.
The Report Manager main screen appears.
2. If needed, create a report group into which you want to place this report. For more
on this, refer to “Report Groups” on page 1037.
3. Do one of these:
• From the Report Tree pane, right click on one of the main report folders such
as DIGI*TRAC Configuration, History Logs, or a report group you have created
for this report type. A pop-up menu appears. Select Add > Reports... from
the pop-up option list.
• Highlight the report folder into which you want this report placed and click the
Add Report icon on the icon tool bar, .
The Add Report dialog box appears like the following example:

By default, the Velocity report directory (...Program Files\Hirsch

Electronics\Velocity\Reports) is displayed, listing all currently existing Crystal
Reports files.
 Only those reports possessing the .rpt extension can be imported.
If the report you want to add is not currently stored in the Velocity Report
subdirectory, use the 'Look in:' combo box to find the directory where the report is
saved.
4. Select the new report and click Open.
This message may appear:

If this message does not appear, double click to select the imported report from
the appropriate group and the message will appear. Alternatively, select the
imported file and click the Edit Report Definition File button.
5. Click Yes to create a report definition file for this imported report.

1034 Importing Reports

 MAN006-0612

The Report Definition File screen appears. For more on this, refer to “Report
Definition Files” on page 1035.
6. Define an Alias for each Table.Column in the Report.
This entails entering a new value in the Alias column for each column present on
this imported file.
7. When you're finished, click OK.
The imported file is now ready for use.
If required, customize the report as you would any other.

Importing Previously-Exported Reports

You can also use this feature to create a new report based on a previously customized
report. To do this:
1. Open an existing report.
2. Customize the report as required.
3. Save the customized report.
4. Export the report as an RPT file.
5. Import the previously-exported report as detailed above.

Report Definition Files

All reports include column header names. These are the titles each column in the
report possesses. Using the Report Definition File, you can add or change these
column header names as required for any selected report.
To create a new report definition file:
1. From the Report Tree window, select the report whose report definition file you
want to change.
2. Do one of these:
• From the icon bar, click the Edit Report Definition File icon, .
• From the menu bar, select Edit > Report Definition File.
The Report Definition File screen appears without values in the Alias field like this
example:

3. Click in each Alias column field you need to define and enter the new definition
name.
4. When you're finished, click OK.
To edit the existing report definition file:
1. From the Report Tree window, select the report whose report definition file you
want to change.
2. Do one of these:

Importing Reports 1035

Velocity Version 3.1 Administrator’s Guide

• From the icon bar, click the Edit Report Definition File icon, .
• From the menu bar, select Edit > Report Definition File.
The Report Definition File dialog box appears like this example:

3. From the 'Alias' column, click the cell where the name you want to change
appears.
4. Edit the name as you require.
5. Modify as many aliases as you need.
6. When you're finished, click OK.
When you create the report, the column names are appropriately modified.

1036 Importing Reports

 MAN006-0612

Report Groups
Use Report Groups to divide and administer reports in the Report Tree pane. The
default report groups are:
 DIGI*TRAC Configuration
 History Logs
 Personal Information
 Velocity Configuration
However, you can add new groups and rearrange existing groups as required.
To create a report group:
1. Open Report Manager.
The Report Manager main screen appears.
2. Right click one of the existing file groups (such as History Logs or Person
Information) in the Report Tree pane.
A pop-up list appears.
3. Select Add > Groups... from the option list.
The Add Group dialog box appears like this example:

4. Type a group name into the text field and click OK.
The new group name appears as a new branch in the Report Tree pane as shown
below:

5. Add (import) new reports to the new Report Group by right clicking the new group
and selecting Add > Reports...
For more on this, refer to “Importing Reports” on page 1034.

Report Groups 1037

Velocity Version 3.1 Administrator’s Guide

Preferences
The Report Manager Preferences page looks like this example:

This page includes these fields:

Suppress Velocity logo Check this box to hide the Velocity logo from the top
on report header left corner of the report page.

Show company name Check this box to insert your company name at the
on report header top of the report. The 'Company Name' text box is
activated.

Company Name: Enter the name you want to appear at the top of
each report.

1038 Preferences
 MAN006-0612

Scheduling Agent
The qualified operator can schedule several tasks for activation at specified times using
the Scheduling Agent. In this way, jobs that take more than a few minutes can be
scheduled for off-peak hours.
This module performs the following tasks:
 activate / deactivate credentials
 back up Velocity alarm and event logs
 back up Velocity database
 synchronize controller clocks
 dial up remote DIGI*TRAC controllers
 print reports
 execute programs
 import data
 export data
 execute command sets
Instructions on using Scheduling Agent are explained in “Scheduling Agent: How To
Use” on page 1040.
 None of the tasks listed above run from a Velocity client. They are all run
from the Velocity server. However, most tasks can be configured from a
client with the exceptions of these: import data, export data, and execute
programs. For more on this, refer to “Scheduler Wizard: Select Task Type”
on page 1058.

1039
Velocity Version 3.1 Administrator’s Guide

Scheduling Agent: How To Use

To use the Scheduling Agent:
1. Do one of these:
• With the top-level Configuration folder selected in the System tree pane,
double click the Scheduling Agent option in the Components pane, .
• From the Velocity menu tool bar, select Console > Scheduling Agent.
• From the Velocity icon tool bar, click the Scheduling Agent icon, . The icon
is second from the right.
The Scheduled Tasks screen appears like this example:

All currently defined tasks are displayed in this dialog box. For more on this screen,
refer to “Scheduled Tasks Screen” on page 1058.
In the default form, only the Activate/Deactivate Credentials and Velocity Daily
Backup tasks are defined. All other tasks must be defined and activated by clicking
on the Add New Schedule option.
2. To add a task to scheduled tasks, double click the Add New Schedule option.
The Scheduler Wizard introduction screen appears.

3. Click Next.
The Select Task Type screen appears.

1040 Scheduling Agent: How To Use

 MAN006-0612

For more on this screen, refer to “Scheduler Wizard: Select Task Type” on page
1058.
4. From the 'Select the task you want Velocity to run' window, select a task to
schedule it.
The task name appears in the upper window.
5. Click Next.
The Configuration screen appears. For more on this, refer to “Scheduler Wizard:
Configuration Screen” on page 1059.
6. Define the parameters of this task.
Each task displays a different configuration screen. Refer to the individual task for
more on this.
7. Click Next.
The Select Scheduler Interval screen appears. For more on this screen, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
8. Specify the interval you need for this task, then click Next.
The Schedule Detail screen appears. For more on this, refer to “Scheduler Wizard:
Schedule Detail” on page 1061.
9. Define the schedule detail for this task, then click Next.
The finished screen appears, summarizing the schedule and task.
10. Click Finish.
The new task appears in the Scheduled Tasks window and will run when specified.
All tasks run in latent mode, meaning that they run in the background while other
Velocity operations continue to function as required. If a task is missed because the
required Windows, SQL, or Velocity service was not running, it resumes as soon as the
service starts. If a task is scheduled for a particular controller and the controller is
off-line at that time, the task resumes as soon as the controller is back online.

Activating/Deactivating Credentials
The Activate/Deactivate Credentials option is selected by default in the Scheduling
Agent. This enables Velocity to download new credential information to all system
controllers. Credentials that have been activated since the last download are entered
into the relevant controller's memory; all credentials that have been deactivated are
removed from the relevant controller's memory.
If you have already entered an activation or expiration date for any credentials on the
credential general property page, this will already exist in the Scheduling Agent.
 You should never have to delete or change the properties of this task.

Archiving Alarm and Event Logs

Use this task to move alarm and event logs to an MDF file. This effectively cuts existing
logged data out of the database, providing more room for new log entries.
If the Report Manager requires data from either of these logs, it can recall this file and
use it as needed.
To schedule an archive of alarm and event logs:
1. From the Scheduling Agent Select Task Type screen, select the Archive Alarm
and Event Logs option.

Scheduling Agent: How To Use 1041

Velocity Version 3.1 Administrator’s Guide

The Scheduler Wizard Configuration dialog box appears like this:

2. Either enter or use the buttons to specify how many days you want retained in
local storage for this archive.
The default is 30 days.
3. Click Next.
The Select Schedule Interval page appears. For more on this, refer to “Scheduler
Wizard: Select Schedule Interval” on page 1060.
4. Specify the interval as required then click Next.
The Schedule Detail page appears. For more on this, refer to “Scheduler Wizard:
Schedule Detail” on page 1061.
5. Specify the schedule detail according to the interval you selected.
6. Click Next.
A message displays the specifications for the task as requested.
7. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
By default, the archive file is stored in the \MSSQL\data directory with an MDF
extension.

Dialing Remote DIGI*TRAC Networks

Use Scheduling Agent to schedule regularly timed connections to remote DIGI*TRAC
networks through host and remote modems.
 In order for this to work properly, you must first define and configure a
dial-up connection. Once the host and remote modems are talking to
each other and Velocity has identified the first remote controller, you can
proceed with this task.
To schedule an archive of alarm and event logs:
1. From the Scheduling Agent Select Task Type screen, select the Dial Remote
DigiTrac Network option.

1042 Scheduling Agent: How To Use

 MAN006-0612

The Scheduler Wizard Configuration dialog box appears like this:

2. From the 'Does not contain...' window, select all systems you want the Scheduling
Agent to dial.
3. Click the <<Add button. The selected systems are added to the 'Contains...'
window.
To remove an systems mistakenly added to the 'Contains...' window, simply select
them and click the Remote >> button.
Use the and buttons to move a highlighted system listed in the
'Contains...' window up or down in the list. Systems nearer the top are dialed first.
4. Click Next.
The Select Schedule Interval screen appears. For more on this screen, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
5. Click the radio button designating the interval you want to observe for performing
this task.
6. Specify the interval as required then click Next.
The Schedule Detail page appears. For more on this screen, refer to “Scheduler
Wizard: Schedule Detail” on page 1061.
7. Specify the interval required.
8. Click Next.
A message displays the specifications for the task as requested.
9. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
The task now appears on the Scheduled Tasks screen.

E-mail Reports
Schedule this task to E-mail generated reports to specified addresses. This enables
qualified operators at remote locations to receive and keep up-to-date on Velocity
reports.
To set up E-mail reports:
1. From the Scheduling Agent Select Task Type screen, select the E-mail Reports
option.

Scheduling Agent: How To Use 1043

Velocity Version 3.1 Administrator’s Guide

The initial Scheduler Wizard dialog box appears like this example:

2. From the pick list, select one of the available Roles under which this schedule will
run.
Only those people who are members of the selected Role are allowed to receive
the emails the Scheduling Agent generates using this feature and only those Roles
currently defined for Velocity appear in the drop-down list. For more on defining
roles, refer to “Roles: How To Define” on page 287.
 The role you select only restricts Velocity data, such as reports and
command sets. It does not affect data generated by Windows resources,
such as printers, which are based on the account under which Velocity
Extension Service runs.
The default choice is Administrators.
3. Click Next.
The Scheduler Wizard Configuration dialog box appears like this example:

4. From the 'Select the reports you want to print' window, check in the left hand cell
of each report you want printed.
An X appears in each cell you select.
• If you want to select all the reports listed, click the Select All button.
• To deselect all the reports currently selected in the window, click the
Deselect All button.
5. Click Next.

1044 Scheduling Agent: How To Use

 MAN006-0612

The E-mail Settings page appears.

It includes these fields:

Server From the drop-down list, select the mail server, if required,
through which this E-mail is directed.
The server must be recognized by the network.

From: Enter the name of the company from which this E-mail is
being sent.

User name: Enter the name of the person sending this E-mail.

Password: If required, enter the password required to send/receive this

E-mail.

To: Enter the E-mail addresses of the persons to whom this

E-mail is being sent.

Subject: Enter the subject of this E-mail.

Message: Enter a brief message that will accompany the reports in this
E-mail.

Next Click this button to proceed to the Select Scheduler Interval

page.

6. Fill out the form as required to E-mail the selected reports.

7. Click Next.
The Select Schedule Interval page appears. For more on this screen, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
8. Specify the interval as required then click Next.
The Schedule Detail page appears.
9. Specify the schedule detail according to the interval you selected.
10. Click Next.
A message displays the specifications for the task as requested.
11. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
The task now appears on the Scheduled Tasks screen.

Scheduling Agent: How To Use 1045

Velocity Version 3.1 Administrator’s Guide

Executing Command Sets

Use Scheduling Agent to schedule the execution of command sets.
 Before you can run this task successfully, you must first define the
required command set(s).
To schedule the execution of a command set:
1. From the Scheduling Agent Select Task Type screen, select the Execute
Command Set option.
The Scheduler Wizard Configuration dialog box appears like this:

2. From the Command Set Name window, click to check each command set you
want executed at a given time.
• To select all of the displayed command sets, click the Select All button.
• To deselect any currently selected command sets, click the Deselect All
button. If you want to deselect one at a time, uncheck the appropriate box.
3. Click Next.
The Select Schedule Interval page appears. For more on this screen, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
4. Specify the interval as required then click Next.
The Schedule Detail page appears. For more on this screen, refer to “Scheduler
Wizard: Schedule Detail” on page 1061.
5. Specify the schedule detail according to the interval you selected.
6. Click Next.
A message displays the specifications for the task as requested.
7. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
The task now appears on the Scheduled Tasks screen.

Executing Programs
The Scheduling Agent enables the qualified operator to start a program at some
selected interval. These programs can include any executable that resides on this
computer, including a dedicated video feed or VoIP programs.

1046 Scheduling Agent: How To Use

 MAN006-0612

 You cannot create and configure this task from a Velocity client; it must
be configured from the Velocity server.
To schedule a program start:
1. At the Scheduler Wizard Select Task Type screen, select Execute Program then
click Next.
The Configuration screen appears like this example:

In the text box, do one of these:

• Enter the full path and executable file name for the program you want to start,
or
• Click the Browse... button. The ‘Select a program to be scheduled to run’
dialog box appears. Search for the executable you want to run, then click the
Open button.
2. Click Next.
The Select Schedule Interval page appears. For more on this page, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
3. Specify the interval as required then click Next.
The Schedule Detail page appears. For more on this page, refer to “Scheduler
Wizard: Schedule Detail” on page 1061.
4. Specify the schedule detail according to the interval you selected.
5. Click Next.
A message displays the specifications for the task as requested.
6. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
The task now appears on the Scheduled Tasks screen.

Exporting Data
Velocity generates a lot of data that periodically needs to be exported to an archive
location. While you can do this manually, it is easier and safer to schedule data export
at regular intervals.

Scheduling Agent: How To Use 1047

Velocity Version 3.1 Administrator’s Guide

Importing and exporting records in most programs requires you to specify both a
source and a destination. Velocity is different. The Velocity database is always
understood to be at one end of the transfer process. During the import process,
Velocity only needs to know where the source file is; during the export process, Velocity
only needs to know where the destination file exists.
 You cannot create and configure this task from a Velocity client; it must
be configured from the Velocity server.

Hint If you schedule the export from a Velocity machine other than the Velocity server,
the path you specify may not be available to the Velocity server when it actually
runs the export and attempts to write the file. It's normally best to schedule export
from the Velocity server.

To schedule data export:

1. From the Scheduling Agent Select Task Type screen, select the Export Data
option.
The Scheduler Wizard Configuration dialog box appears like this:

2. Click the Configure Data Export... button.

The Velocity Data Export Wizard appears.
3. Complete the Wizard by performing the following tasks:
• Choose a destination and file name at the Choose Destination screen, then
click Next.
• Select a destination file format at the Select Destination File Format screen,
then click Next.
• Click Finish.
The Scheduler Wizard Configuration screen reappears.
4. Click Next.
The Select Schedule Interval page appears. For more on this screen, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
5. Specify the interval as required then click Next.
The Schedule Detail page appears.
6. Specify the schedule detail according to the interval you selected.

1048 Scheduling Agent: How To Use

 MAN006-0612

7. Click Next.
A message displays the specifications for the task as requested.
8. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
The task now appears on the Scheduled Tasks screen.

Importing Data
Many installations use data gathered by Human Resources and other departments to
keep the Velocity database up-to-date. While you can do this manually through the
Velocity Data Import Wizard, it is often easier and safer to schedule data import at
regular intervals.
Importing and exporting records in most programs requires you to specify both a
source and a destination. Velocity is different. The Velocity database is always
understood to be at one end of the transfer process. During the import process,
Velocity only needs to know where the source file is; during the export process, Velocity
only needs to know where the destination file exists.
 You cannot create and configure this task from a Velocity client; it must
be configured from the Velocity server.
To schedule data import:
1. From the Scheduling Agent Select Task Type screen, select the Import Data
option.
The Scheduler Wizard Configuration dialog box appears like this:

2. Click the Configure Data Import... button.

The Velocity Data Import Wizard appears.
3. Complete the Wizard by performing the following tasks:
• Choose a source and file name at the Choose a Data Source screen, then
click Next.
• Select a source file format at the Select Source File Format screen, then click
Next.
• Click Finish.
The Scheduler Wizard Configuration screen reappears.

Scheduling Agent: How To Use 1049

Velocity Version 3.1 Administrator’s Guide

4. Click Next.
The Select Schedule Interval page appears. For more on this screen, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
5. Specify the interval as required then click Next.
The Schedule Detail page appears. For more on this screen, refer to “Scheduler
Wizard: Schedule Detail” on page 1061.
6. Specify the schedule detail according to the interval you selected.
7. Click Next.
A message displays the specifications for the task as requested.
8. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
The task now appears on the Scheduled Tasks screen.

Perform Database Maintenance

This is one of the most important tasks Like the Activate/Deactivate Credentials task,
this task is scheduled by default and should always appear in the Velocity Scheduling
Agent scheduled tasks screen.
This tasks assures that Velocity's database are backed up on a regular basis. By default,
this task is scheduled everyday at 11:30 pm starting on the day Velocity is installed.
If you need to change these parameters, refer to “Editing Existing Tasks” on page 1068.
If you need to delete this task and redefine it, use the following instructions.

Hint You may need to edit this task, but it is uncommon to delete and recreate it unless
the task has become unstable or corrupted for some reason.

This task differs from the Archive Alarm/Event Logs in scope. As its name implies, the
Archive... Logs procedure removes alarm and event logs and histories from the Velocity
database and places them in a separate file, while the SQL Database Backup copies
the entire Velocity database to a location predefined by SQL Database Manager.
To schedule database maintenance:
1. From the Scheduled Tasks screen, double click on Add New Schedule.
2. Click Next.
The Select Schedule Interval page appears. For more on this screen, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
3. Specify the interval as required then click Next.
The Schedule Detail page appears. For more on this screen, refer to “Scheduler
Wizard: Schedule Detail” on page 1061.
4. Specify the schedule detail according to the interval you selected.
5. Click Next.
A message displays the specifications for the task as requested.
6. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
Once scheduled, it appears in the Scheduled Tasks as Perform Database Maintenance
unless you rename it.

1050 Scheduling Agent: How To Use

 MAN006-0612

By default, all Velocity database backups are stored under the Velocity_Backup_Device
file name on the MSSQL7\Backup subdirectory on the drive where MSDE or SQL is
installed. However, you can designate another location or device for the backup files,
such as a tape drive, another local hard drive, or even a networked hard drive using the
instructions in SQL Database Manager - Designate Backup File Location.

Hint We recommend that you periodically copy the backup files to an alternate media,
drive, or directory where they are protected from hardware failure. You can
combine backup and archiving chores by designating the backup location as a
tape drive.

If you need to restore the Velocity database from backup, use the SQL Database
Manager.
If you need to define and use multiple backup locations, you must use the backup
utility supplied through SQL Database Manager. Scheduling Agent does not support
multiple backup. For more on this process, refer to “Defining Multiple Backup
Locations” on page 1101.

Printing Reports
While you can create, format, and print reports manually, it is both easier and less
time-consuming to schedule Velocity to do it.
To schedule report printing:
1. From the Scheduling Agent Select Task Type screen, select the Print Reports
option.
The Scheduler Wizard Configuration dialog box appears like this:

2. In the 'Select the printer you want to print to:' combo box, select from the
drop-down list the printer where you want the reports printed.
Only printers currently recognized by the network to which this Velocity workstation
is connected appear in this list. The default selection is the printer you specified for
report printing on the Preferences Printers page.

Scheduling Agent: How To Use 1051

Velocity Version 3.1 Administrator’s Guide

 Before you select a printer to perform scheduled report printing, make

sure that the VelocityServices account which is created during
installation and is responsible for printing scheduled reports, has
permissions to print. For more on this, refer to “Report Printing
Configuration” on page 1053.
3. From the 'Select the reports you want to print' window, check in the left hand cell
of each report you want printed.
An X appears in each cell you select as shown in the following example:

4. If you want to select all the reports listed, click the Select All button.
To deselect all the reports currently selected in the window, click the Deselect All
button.
If you want to change the default settings for a selected report:
f. Click in the Criteria column of the selected report.
g. Click the button that appears.
The criteria and sorting page for that report appears. These pages closely
resemble the criteria and sorting pages available for through the Report
Manager.
h. Uncheck the 'Use Report Default Criteria and Sorting' box.

1052 Scheduling Agent: How To Use

 MAN006-0612

The fields and tabs are activated as shown in the following example:

i. Customize the report as you require.

For more on customizing a report, refer to “Customizing an Existing Report” on
page 1018.
j. When you're finished, click OK.
You are returned to the Scheduling Agent Configuration page.
5. Click Next.
The Select Schedule Interval page appears. For more on this page, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
6. Specify the interval as required then click Next.
The Schedule Detail page appears. For more on this page, refer to “Scheduler
Wizard: Schedule Detail” on page 1061.
7. Specify the schedule detail according to the interval you selected.
8. Click Next.
A message displays the specifications for the task as requested.
9. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
The task now appears on the Scheduled Tasks screen.

Report Printing Configuration

In Velocity 2.6, report printing was overseen by the LocalSystem account which was a
member of the local computer's administrators group. In Velocity 3.0 and later, the
LocalSystem account has been replaced by the VelocityServices account which is not
part of the local administrators group. While VelocityServices can perform many tasks
required of administrators of the local system, it has few privileges beyond the
boundaries of the server on which it is used and by default does not have any printers
associated with its profile.

Scheduling Agent: How To Use 1053

Velocity Version 3.1 Administrator’s Guide

When you click the 'Select the printer you want to print to:' combo box, a drop-down
list appears showing all the printers to which the current Velocity operator has access,
like the following example:

However, since the actual scheduled task is run under the VelocitySevices account, that
account may not have access to the printer you specified.
To check this, try these two procedures:
 Try printing to a local printer:
a. Log off Windows and log back on Windows as VelocityServices.
b. Select Start > Settings > Control Panel > Printers and Faxes > Add
Printer.
Make sure that the required printer is not already added to the Printers and
Faxes list.
c. Follow the instruction to add the printer to which you want the scheduler to print
reports.
d. If VelocityServices account doesn’t have permission to that printer, contact your
IT administrator to grant permission to it.
e. Log back on as normal Velocity Operator account and proceed to configure the
rest of the report printing schedule.
 Print to a network printer:
Since VelocityServices is a local account, it doesn’t have access to network printers.
Therefore you should change the Extension Service’s (and ONLY the extension ser-
vice) logon account to a domain account which has access to that network printer.
One way to make sure which account has access to which printer is to logon to
Windows using that account and go to Settings->Printers and Faxes and check
which printers are registered under that account. The following steps show you
how to achieve this.
1. Stop Velocity Extension Service, if it is running.
2. Select Start > Control Panel > Administrative Tools > Component Services.
3. Expand the Services node until Velocity Extension Service appears in the right
panel.
4. Double click on Velocity Extension Service or right click and select Properties.
5. Click the Log On tab.

1054 Scheduling Agent: How To Use

 MAN006-0612

A page like this appears:

6. Click to select This account: radio button.

The three text fields to the right are activated.
7. Enter the user name in the first text box and the password of the user account
under which you want Velocity Extension Service to run.
Usually this is the same account under which the report printing schedule is set up.
Also make sure that this account has access to the report printer you specified in
the Scheduling Agent.
8. When you're finished, click the OK button.
 If you didn't stop the “Velocity Extension Service” in Step 1, the following
warning message will popup:

If you see the above dialog box, click OK and follow the instruction to stop
and restart the service.
The Velocity Extension Service runs under the account you just specified until you
change it again. If you set up the schedule to print to any printer to which this account
has access, it will print correctly; otherwise, in the Velocity Scheduler_Reports.txt file, it
will tell you that you are trying to print to a printer that the current user doesn’t have
access to.

Scheduling Agent: How To Use 1055

Velocity Version 3.1 Administrator’s Guide

The log file will also give you the current user name, the printer(s) to which it has
access, and the printer to which the report(s) are scheduled to print. If the third
condition is not found among the printers it has access to, it will say so and the printing
job terminates.

1056 Scheduling Agent: How To Use

 MAN006-0612

Synchronizing Controller Clocks

Use this task to synchronize all controller clocks at specified intervals.
 This feature is not supported in Dial-Up Configuration; however, clocks
are synchronized every time Velocity connects to its remote sites, so this
feature is not really required.
To schedule clock synchronization:
1. From the Scheduling Agent Select Task Type screen, select the Synchronize
Controller Clocks option.
2. Click Next.
The Select Schedule Interval page appears. For more on this page, refer to
“Scheduler Wizard: Select Schedule Interval” on page 1060.
3. Specify the interval as required then click Next.
The Schedule Detail page appears. For more on this page, refer to “Scheduler
Wizard: Schedule Detail” on page 1061.
4. Specify the schedule detail according to the interval you selected.
5. Click Next.
A message displays the specifications for the task as requested.
6. If the information on this task is correct, click Finish.
If it isn't correct, click Back to return to the previous screen and make corrections.
Velocity synchronizes all clocks of connected controllers at the times specified.

Scheduling Agent: How To Use 1057

Velocity Version 3.1 Administrator’s Guide

Scheduling Agent Wizard

The screens shown during the wizard’s progress are described in the following section.

Scheduled Tasks Screen

The Scheduled Tasks screen looks like this example:

This screen includes a brief menu tool bar and the scheduled tasks window. Notice that
both the Activate/Deactivate Credentials and the Velocity Daily Backup are included by
default.
The menu tool bar includes only one option: View > Refresh. This enables you to
refresh the currently displayed list of scheduled tasks. Use the Refresh tasks to update
the current list of tasks in real-time.
The scheduled tasks window lists all currently displayed tasks. It also includes the Add
New Schedule option which enables you to create and define a new task.
This window includes these read-only columns:

Name Name of the current task.

Schedule A brief summary of the current schedule for this task.

Creator A person or computer that created this task. If the task is default,
such as Activate/Deactivate Credentials, the creator is System.

Last Run Displays the date and time when this task was last run.

Scheduler Wizard: Select Task Type

The Select Task Type screen looks like this example:

1058 Scheduling Agent Wizard

 MAN006-0612

This screen includes two windows:

Type the name for this The task you select in the 'Select the task...' window
task: below appears in this text box. If needed, you can
change the task name here.

Select the task you want From the list in the window, click to highlight the
Velocity to run: task you want to schedule.
The task name appears in the 'Type the name...'
text box. For a list of the tasks displayed in this
window, see below.

Next Click this button after you have completed the task
selection. The Schedule Wizard Configuration page
appears.

The Select Task Type window includes these tasks:

 Activate/Deactivate Credentials (page 1041) (defined by default)
 Archive Alarm/Event Logs (page 1041)
 Synchronize Controller Clocks (page 1061)
 Dial Remote DigiTrac Network (page 1042)
 Perform Database Maintenance (page 1050) (defined by default)
 Print Reports (page 1051)
 Execute Program (page 1046)
 Import Data (page 1049)
 Export Data (page 1047)
 Execute Command Set (page 1046)

Scheduler Wizard: Configuration Screen

The Configuration screen that appears in the Scheduling Wizard depends on the task
you select in the Select Task Type screen.
An example of this screen is shown here:

Scheduling Agent Wizard 1059

Velocity Version 3.1 Administrator’s Guide

Scheduler Wizard: Select Schedule Interval

The Select Schedule Interval looks like this example:

This page contains the following radio buttons and pick list:

Daily Click this radio button to schedule this task to be performed

every day.

Weekly Click this radio button to schedule this task to be performed

on a weekly basis.

Monthly Click this radio button to schedule this task to be performed

on a monthly basis.

One time only Click this radio button to schedule this task to be performed
one time only.

Schedule Select the date on which this task should be begun. Click
Effective date the button to bring up a calendar.

Next Click this button to proceed to the next step of this wizard.

Several of these intervals have more flexibility than first appears. When you select
Weekly, it doesn't necessarily mean you are planning to run this task once a week. It
means you are planning to run the process on a weekly basis, but you can still specify
multiple days to run the process within that week (such as on both Monday and
Thursday) during that week; and even on those days during the week that it is running,
you can run it multiple times.
The same is true for Monthly schedules: you can still run the process multiple times
during that month, even multiple times during a specified day.

1060 Scheduling Agent Wizard

 MAN006-0612

Scheduler Wizard: Schedule Detail

The Schedule Detail page looks like this example:

The precise appearance of this page depends on the interval you selected on the
Select Scheduler Interval page (page 1060).

If you selected... Refer to...

Daily “Scheduler Wizard (Daily) Dialog Box” on page 1061

Weekly “Scheduler Wizard (Weekly) Dialog Box” on page 1063

Monthly “Scheduler Wizard (Monthly) Dialog Box” on page 1064

One time only “Scheduler Wizard (One Time Only) Dialog Box” on page
1066

Next Click this button to proceed to the next step. To return to a

prior step, click Back.

Each of these interval dialog boxes are discussed in the following sections.

Scheduler Wizard (Daily) Dialog Box

If you select Daily on the Select Schedule Interval dialog box then click Next, the
Schedule Detail dialog box appears like this example:

Scheduling Agent Wizard 1061

Velocity Version 3.1 Administrator’s Guide

The radio buttons and fields on this screen include:

Occurs once at: Click this radio button then either enter or use the spin
control buttons to set the time at which this task occurs
every day.
If you select this option, the Occurs every: option is
deactivated.

Occurs every: Click this radio button then either enter or use the spin
control buttons in the first field to specify the number of
minutes/hours describing the intervals occurring between
execution of this task every day.
In the second field, pick either Hours or Minutes. The
default is Hours.
If you select this option, the Occurs once at: option is
deactivated.

Starting at: If you select the Occurs every: option, enter or use the
spin control buttons to indicate the time at which the
specified intervals take effect for this task.
For example, if you specify every 3 hours in the previous
field and 3:30 AM here, then the task is first initiated at 3:30
AM and repeated every 3 hours until the Ending at: time is
reached.
This is an optional field.

Ending at: If you select the Occurs every: option, enter or use the
spin control buttons to indicate the time at which the
specified intervals are no longer relevant for this task.
For example, if you specify every 3 hours in the Occurs
every: field, 3:30 AM in the Starting at: field, and 8:30 at
this field, then the task is first initiated at 3:30 AM and is
repeated every 3 hours until the 8:30 at which time the
schedule is inactivated until 3:30 AM.
This is an optional field.

Hint How to change time fields: click the and spin control buttons to
change the hour field. Use the right cursor key or click in the minute field, then
change that value by either entering a new value or using the spin control buttons
to increase or decrease the value. Use the right cursor or click in the AM/PM field
and use the spin control buttons to toggle between these values.

1062 Scheduling Agent Wizard

 MAN006-0612

Scheduler Wizard (Weekly) Dialog Box

If you select Weekly from the Select Scheduler Interval screen, the Schedule Detail
dialog box appears like this example:

The radio buttons and fields on this screen include:

Select the day(s) Check each day of the week on which you want this task
of the week run. Only those days you check are run.
below:

Occurs once at: Click this radio button then either enter or use the spin
control buttons to set the time at which this task occurs
every day.
If you select this option, the Occurs every: option is
deactivated.

Occurs every: Click this radio button then either enter or use the spin
control buttons in the first field to specify the number of
minutes/hours describing the intervals occurring between
execution of this task every day.
In the second field, pick either Hours or Minutes. The
default is Hours.
If you select this option, the Occurs once at: option is
deactivated.

Starting at: If you select the Occurs every: option, enter or use the
spin control buttons to indicate the time at which the
specified intervals take effect for this task.
For example, if you specify every 3 hours in the previous
field and 3:30 AM here, then the task is first initiated at
3:30 AM and repeated every 3 hours until the Ending at:
time is reached.
This is an optional field.

Scheduling Agent Wizard 1063

Velocity Version 3.1 Administrator’s Guide

Ending at: If you select the Occurs every: option, enter or use the
spin control buttons to indicate the time at which the
specified intervals are no longer relevant for this task.
For example, if you specify every 3 hours in the Occurs
every: field, 3:30 AM in the Starting at: field, and 8:30 at
this field, then the task is first initiated at 3:30 AM and is
repeated every 3 hours until the 8:30 at which time the
schedule is inactivated until 3:30 AM.
This is an optional field.

Hint How to change time fields: click the and spin control buttons to
change the hour field. Use the right cursor key or click in the minute field, then
change that value by either entering a new value or using the spin control buttons
to increase or decrease the value. Use the right cursor or click in the AM/PM field
and use the spin control buttons to toggle between these values.

Scheduler Wizard (Monthly) Dialog Box

If you selected Monthly from the Select Scheduler Interval screen, the Schedule Detail
dialog box looks like this example:

The radio buttons and fields on this screen include:

Day: Enter or use the spin control buttons to set the day of the
month on which this task is to be run.

Month(s) Check each month you want this task performed. It will be
performed on the day of the month specified in the
previous field.
Only checked months run the task; the task is not run
during unchecked months.

1064 Scheduling Agent Wizard

 MAN006-0612

Occurs once at: Click this radio button then either enter or use the spin
control buttons to set the time at which this task occurs
every day.
If you select this option, the Occurs every: option is
deactivated.

Occurs every: Click this radio button then either enter or use the spin
control buttons in the first field to specify the number of
minutes/hours describing the intervals occurring between
execution of this task every day.
In the second field, pick either Hours or Minutes. The
default is Hours.
If you select this option, the Occurs once at: option is
deactivated.

Starting at: If you select the Occurs every: option, enter or use the
spin control buttons to indicate the time at which the
specified intervals take effect for this task.
For example, if you specify every 3 hours in the previous
field and 3:30 AM here, then the task is first initiated at
3:30 AM and repeated every 3 hours until the Ending at:
time is reached.
This is an optional field.

Ending at: If you select the Occurs every: option, enter or use the
spin control buttons to indicate the time at which the
specified intervals are no longer relevant for this task.
For example, if you specify every 3 hours in the Occurs
every: field, 3:30 AM in the Starting at: field, and 8:30 at
this field, then the task is first initiated at 3:30 AM and is
repeated every 3 hours until the 8:30 at which time the
schedule is inactivated until 3:30 AM.
This is an optional field.

Hint How to change time fields: click the and spin control buttons to
change the hour field. Use the right cursor key or click in the minute field, then
change that value by either entering a new value or using the spin control buttons
to increase or decrease the value. Use the right cursor or click in the AM/PM field
and use the spin control buttons to toggle between these values.

Scheduling Agent Wizard 1065

Velocity Version 3.1 Administrator’s Guide

Scheduler Wizard (One Time Only) Dialog Box

If you selected One Time Only from the Select Scheduler Interval screen, the
Schedule Detail dialog box appears like this example:

The single field on this screen is:

Start time: Either enter or use the spin control buttons to set the time
at which this task occurs.

The task is performed only once. After the task is completed, the item remains in the
list until a qualified operator deletes the task from the Scheduling Agent.

Hint How to change time fields: click the and spin control buttons to
change the hour field. Use the right cursor key or click in the minute field, then
change that value by either entering a new value or using the spin control buttons
to increase or decrease the value. Use the right cursor or click in the AM/PM field
and use the spin control buttons to toggle between these values.

1066 Scheduling Agent Wizard

 MAN006-0612

Running a Task Manually

Most of the time you will want to run a specific task according to the schedule you
select; however, there are occasions when you will want to run a task immediately.
To run a task manually:
1. Do one of these:
• With the top-level Configuration folder selected in the System tree pane,
double click the Scheduling Agent option in the Components pane, .
• From the Velocity menu tool bar, select Console > Scheduling Agent.
• From the Velocity icon tool bar, click the Scheduling Agent icon, . (The
icon is third from the right.)
The Scheduled Tasks screen appears. All currently defined tasks are displayed in
this dialog box.
2. Right click on the task in the window you want to run immediately.
A list of options pops up.
3. Select Run Now.
The task is immediately run.

Running a Task Manually 1067

Velocity Version 3.1 Administrator’s Guide

Editing Existing Tasks

To modify an existing task:
1. Open the Scheduling Agent.
The Scheduled Tasks screen appears. For more on this, refer to “Scheduled Tasks
Screen” on page 1058.
2. Right click on the task in the task window you want to modify.
3. Select Properties.
The Task Schedule Properties screen appears. For more on this, refer to “Task
Schedule Properties Screen” on page 1070.
4. From the Task page, change the editable fields as required.
5. Click the Schedule tab.
The Schedule page appears.
6. Make changes to the editable fields on this page as required.
7. When you're finished modifying the task, click OK.
While you can rename the task from the Task Schedule Properties screen, you can
shortcut this by using the following procedure.
To rename an existing task:
1. Open the Scheduling Agent.
The Scheduled Tasks screen appears. For more on this, refer to “Task Schedule
Properties Screen” on page 1070.
2. Right click on the task in the task window you want to modify.
3. Select Rename.
The current name is highlighted in a text box with the text cursor at the end of the
name.
4. Enter a new name and press Enter.
A new name appears in the Scheduled Tasks window.
You can also delete a scheduled task from this option list. For more on this, refer to
“Deleting Tasks” on page 1069.

1068 Editing Existing Tasks

 MAN006-0612

Deleting Tasks
You can also delete a scheduled task from this option list.
To delete an existing task from the Scheduling Agent:
1. From the Scheduled Tasks screen, right click on the task you want to delete.
A pop-up option list appears.
2. Select Delete from this list.
The existing task is deleted from the screen.

Deleting Tasks 1069

Velocity Version 3.1 Administrator’s Guide

Task Schedule Properties Screen

The Task Schedule Properties sheet that appears when you select the right click
Properties option depends on the kind of task being described.
For example, when you bring up the properties sheet for the Perform Database
Maintenance task, a screen like this example appears:

If you select the Import Data or Execute Program task properties, screens like these
appear:

1070 Task Schedule Properties Screen

 MAN006-0612

All of these property sheets share two fields at the top of the page:

Schedule The current name of this schedule. You can click in this field
Name: and change it as required.

Task Type: The type of task represented by this task. This field cannot be
changed.

All fields appearing below these two are task-dependent: the fields you see depend on
the task defined by the Scheduling Agent.
When you click the Schedule tab, a screen like this example appears:

This screen lists the interval of the selected task. The fields vary according to the type of
option selected in the Schedule Task field.

Schedule Select an option from the drop-down option list indicating the
Task: type of schedule used with the selected task.
Your choices are:
• Daily
• Weekly
• Monthly
• One Time Only

Schedule Either enter date in these fields or click the to open a calendar.
Effective Specify the day on which you want this task begun.
Date:

Daily/Weekly/Monthly/Run Once

Select the Check one or more days. For Weekly schedule task only.
day(s) of the
week below:

Task Schedule Properties Screen 1071

Velocity Version 3.1 Administrator’s Guide

Runs on Day Enter or use spin buttons to set the day of month on which this
___ of runs. For Monthly schedule task only.
month(s): Check month(s) this task is run.

Start time: Indicate the starting time for this task on the day selected. For
One Time Only schedule task only.

Daily Frequency

Occurs Once For Daily, Weekly, and Monthly schedule task only. If you click
at: this radio button, enter or use spin buttons to set the time at
which this task is run.

Occurs Every: For Daily, Weekly, and Monthly schedule task only. If you click
this radio button, enter or use spin buttons to set the interval in
hours or minutes when this task is run.

Starting at: For Daily, Weekly, and Monthly schedule task only. Either
enter or use spin buttons to set the starting time for this task.

Ending at: For Daily, Weekly, and Monthly schedule task only. Either
enter or use spin buttons to set the stop time for this task.

1072 Task Schedule Properties Screen

 MAN006-0612

Service Control Manager (SCM)

The Service Control Manager (SCM) provides an easy-to-use way to control start,
pause, or stop these Velocity services:
 Velocity Security Domain Service (SDS)
 Velocity DIGI*TRAC Network Service (DTNS)
 Velocity Extension Service
 Velocity CCTV Service
The SDS and DNS are the services that control the basic function of Velocity. For more
on DTNS, refer to “DIGI*TRAC Network Service (DTNS)” on page 1084.
The Velocity Extension Service oversees the function of Velocity extensions, such as the
Add-Ins option.
 The Extension Service does not run on a Velocity client. It only runs on a
Velocity server. For this reason, certain tasks in Scheduling Agent cannot
be run on the client. For more on this, refer to “Scheduler Wizard: Select
Task Type” on page 1058.
Velocity CCTV service controls CCTV port, switcher, and camera operations.
SCM should start automatically each time you start Windows. The SCM icon, ,
appears in the desktop tray in the lower right hand corner of the screen, just next to the
MSDE icon.
The SCM icon indicates which state it is in:

No SCM services are started.

SDS started. DNS is not yet started.

All applicable services, including SDS and DTNS, are started. Velocity is
ready to open and use.

On system startup, SCM normally starts all services within 30 seconds; however,
occasionally it can take as long as one minute. If, for some reason, SCM does not start
automatically, you can manually start the services in this way:
 From the Windows desktop, select Start > Programs > Hirsch Electronics
Velocity > Service Control Manager.
 From the Windows tray, right click on the SCM icon . Refer to “Controlling SCM
Services” on page 1074 for more information.
The SCM starts and the SCM icon appears in the Windows tray.

1073
Velocity Version 3.1 Administrator’s Guide

Controlling SCM Services

Once services are started, you can stop or start them individually by doing the
following.
 If any of the services fail to start, and starting them manually (as
explained below) results in an error message, it means Velocity installer
has not correctly registered the services. To solve this problem
permanently, refer to “Restarting Velocity Services” on page 1085.
To control SCM services:
1. From the Windows desktop tray, right click on the SCM icon, .
A pop-up menu like this appears:

If a service is currently running, the option stopping the service appears. If the
service is currently stopped, the option starting the service appears. (In the above
example, all services are currently running.)
2. Select the options you need.
To change the basic settings, select the Settings options as explained in
“Customizing SCM” on page 1075.
 The Settings option only appears if this version of SCM is running on the
Velocity server. If this version of SCM is running on a client, only the Start
and Stop options are available.
3. When you're finished, select Exit to return to the Velocity desktop.
If you are NOT currently using the CCTV feature, make sure these two features are
disabled:
 Stop the Velocity CCTV Service from the SCM
 Switch the Hirsch Port Manager Service to a manual setting
 When working on a Velocity client, a user will neither see nor be able to
use the SCM to start or stop services, even if the user has the necessary
rights to use the SCM. Only if the Velocity administrator is logged on to
the client will the SCM be available. In all other cases, the SCM icon does
not appear on a Velocity client.

1074 Controlling SCM Services

 MAN006-0612

Customizing SCM
Customizing SCM settings enables the qualified operator to enable and retune many
important Velocity functions — such as CCTV, RSS, Web Server, SQL Database, and the
network connection.
To change current SCM settings:
1. Right click on the SCM icon on the right side of the Windows desktop tray.
A list of options pulls up.
2. Select Settings.
The Velocity Settings dialog box appears. For more on this, refer to “Velocity
Settings Dialog Box” on page 1076.
3. Click on the tab you require to reveal the specific page you need.
Choose from these pages:
• CCTV
• Database
• Diagnostics
• Advanced
• Web Server
4. Make changes to the page as required.
5. When you're finished, click OK.
If you make any changes to the SCM, a message like this appears:

6. Click OK to continue.
7. To activate the changes you made here, do one of two things:
• Right click the SCM icon to stop then restart all currently running Velocity
services (such as SDS and DNTS) as discussed in Service Control Manager
(SCM)
• Restart Windows

Hint We recommend the first option, since it takes less time and does not interrupt
Velocity's monitoring of your security system.

The changes you made are now activated.

Customizing SCM 1075

Velocity Version 3.1 Administrator’s Guide

Velocity Settings Dialog Box

 This dialog box does not appear if Velocity has been installed on this
computer as a client since the Settings option on the SCM is not
available.
When you select the Settings... option from the Velocity Service Control Manager, the
following dialog box appears:

Four subdirectories are available.

CCTV Select what IP address and remote port you want to use for the
attached CCTV system. For more on this, see “CCTV Settings” on
page 1077.

Database Select what SQL server you want to use for Velocity. For more on
this, see “Database Settings” on page 1077.

Network Select the remote port and IP address for the Velocity network
settings. For more on this, see “Network Settings” on page 1078.

Diagnostics Enable the debugging of the polling engine and/or HCS and
specify the level of the debugging to be performed. For more on
this, see “Diagnostics Settings” on page 1079.

Advanced Enable a variety of advanced features, such as event level

customization and point customization escalation.

Web Server Enable the Velocity web server and RSS features.

To access a subdirectory, single-click on the option and the settings appear in the right
pane.
If you make any changes to any of the values on these pages, such as enable the web
server or CCTV, a dialog box appears like this:

Click OK. Restart the services as required.

1076 Velocity Settings Dialog Box

 MAN006-0612

CCTV Settings
When you click the CCTV subdirectory, these options appear:

The fields shown here are:

Enable CCTV This box is checked by default. Uncheck the box to disable
Integration CCTV integration.

IP Address This field displays the IP address that the Security Domain
Server uses to establish communications with the CCTV
server.
Since the SDS and CCTV servers are almost always on the
same machine, a loop back address is automatically
displayed here.

Port Enter the port number where the CCTV switcher is

connected to the Velocity computer.

Debug File Name Enter the path and name you want to give to the CCTV
debug file.
The default directory and name is C:\Program Files\Hirsch
Electronics\Velocity\Velocity CCTV Services-Technical
Support File.txt.

Debug Level Indicate the debug level you require for this debug file.

Database Settings
When you click the Database subdirectory, these options appear:

Velocity Settings Dialog Box 1077

Velocity Version 3.1 Administrator’s Guide

The fields shown here are:

SQL Server

SQL Server From the combo box option list, select the name of the
computer which runs SQL Server and the instance of SQL
Server that handles Velocity's database (usually \HIRSCH).
In a single workstation environment, this name should be
the same name as the Velocity workstation. In networked
environments, the SQL Server computer is often a
dedicated machine.

Database If required, enter a new password for entry to the Velocity

'Application Role' database. When Velocity is first installed it assigns a special
password password to the Velocity database which makes it virtually
impossible for a person to access and read the database
from another program, such as SQL Server, without first
entering the correct password. By providing a new
password here, it enables anyone with knowledge of this
new password to access and use the Velocity database
from an external application.
In creating this password, you are
allowing an external application to view
the Velocity database. Normally this is
not recommended, such it compromises
the security of the system.

Set Click this button to set the password you just typed in the
text box.

SQL Server Availability

Startup timeout Specify the number of seconds Velocity allows for SQL
Server to start up before a timeout alarm is sent to the
Alarm Viewer.
The default is 300 seconds.

Network Settings
When you click the Network subdirectory, these options appear:

1078 Velocity Settings Dialog Box

 MAN006-0612

The fields shown here are:

IP Port Enter the port number of the Security Domain where the Velocity
service resides.
This is normally the default, 2025, for the Velocity service. Most of
the time this works; however, there may be rare instances when a
conflict with another port occurs. If this happens, you can change the
port number as shown in the example above.

Server Enter the computer name of the Velocity server as assigned by the
Name system administrator.

Active This combo box automatically displays the default root of your
Directory domain where all new Velocity operators are stored. If you need to
specify another location, click to reveal the list of available
organizational units (OUs) and select one of these, as shown in this
example:

Note: If you select an OU, your existing accounts will not be automatically
moved. Instead, you will receive ‘Access Denied’ messages until they
are reassigned to ‘Velocity Users’ on the OU. You will have to create
the ‘Velocity Users’ on the OU manually.
Only select a new authentication source if you need to change the
location where new Velocity operators are created to an OU instead
of the root of your domain.

Diagnostics Settings
When you click the Diagnostics subdirectory, these options appear:

Velocity Settings Dialog Box 1079

Velocity Version 3.1 Administrator’s Guide

Only enable or change these values when requested by

Hirsch Technical Support. These values are normally reserved
for debugging or troubleshooting Velocity. If these settings
are enabled or changed, log files can quickly fill up the hard
disk and cause major problems.
The fields on this page are explained below:

Advanced troubleshooting options

Message Queue size of polling engine. How many messages can the
queue size program buffer at one time.
Under most circumstances, this size should not be reset unless
expressly requested by Hirsch Technical Support.
The default is 20.

HCS Debug Hirsch spooler debugger. This sets the debug bit flags. Specify the
Level level of detail at which the debugger should run where 0 = no
debug and 7 = highest level of detail.
All debug results are stored in the Velocity log file. Under most
circumstances, this setting should not be reset unless expressly
requested by Hirsch Technical Support.
The default is Disabled and Level 1.

PE Debug Polling engine debugger. This sets the debug bit flags. Specify the
Level level of detail at which the debugger should run where 0 = no
debug and 7 = highest level of detail.
All debug results are stored in the Velocity log file. Under most
circumstances, this setting should not be reset unless expressly
requested by Hirsch Technical Support.
The default is Disabled and Level 1.

Flash Flash download debugger. This sets the debug bit flags for the flash
Debug download process. Specify the level of detail at which the debugger
should run where 0 = no debug and 7 = highest level of detail.
All debug results are stored in the Velocity log file. Under most
circumstances, this setting should not be reset unless expressly
requested by Hirsch Technical Support.
The default is Enabled and Level 1.

Enable Check this box to report any line voltage updates during an input
line state change.
voltage Line voltage requests are very resource intensive on systems
updates possessing a large number of active inputs. For this reason, we
on input recommend that you leave this feature disabled unless you need to
state review real-time line voltage updates in your Status Viewer.
change
The default is unchecked and disabled.

1080 Velocity Settings Dialog Box

 MAN006-0612

Advanced Settings
When you select the Advanced subdirectory in Velocity Settings, a page like this
example appears:

The fields on this screen include:

Advanced Settings

Synchronize Check this box to indicate that the database is synchronized

Velocity with all of the controllers. By default this feature is enabled.
database with
controllers

Enable event Check this box to enable event level customization. If this
level description feature is not enabled, any changes you make an alarm or
customization event in Customization Manager will not take effect.
This option is unchecked by default.

Enable address Check this box to enable point customization. This allows a
level description qualified operator to modify events and alarms on a
customization point-by-point basis. If no point level customization is
defined in Customization Manager, Velocity checks for an
event level modification. If neither of these have been
changed, then Velocity uses the factory default.
This option is unchecked by default.

Restrict alarms Check this box to restrict which alarms and events an
and events using operator can review through a role definition.
Velocity Roles This option is unchecked by default.

Escalate alarms Check this box to enable Velocity to escalate point level
outside Roles alarms through Point Customization in Customization
Manager.

Escalate after Enter the number of seconds or minutes an alarm or event

can wait for response before it is escalated to another
operator.
The default value is 30 seconds.

Velocity Settings Dialog Box 1081

Velocity Version 3.1 Administrator’s Guide

Enable detail Check this box to enable operator logging. This allows the
Operator logging Report Manager to detect and report activity in a more
(Requires client detailed manner, indicating exactly what each operator
restart) changed (such as door groups for credentials) or did (such
as printing a badge), what the previous setting was, and at
what Velocity client or workstation the change was made.
The default value for this feature is unchecked and disabled.
Before this feature can be enabled, each Velocity client must
be restarted.

Cold-start/CCM Replacement options

Download Check this box to automatically download controller settings

controller from the Velocity server to the CCM after the controller has
settings been cold started or the CCM has been replaced.
This expedites the task of manually downloading
configuration information. This technique is recommended
when you have to cold start or replace the CCMs for a large
number of controllers.
The default is unchecked and disabled.

Download Check this box to automatically download credentials from

credentials the Velocity server to the CCM after the controller has been
cold started or the CCM has been replaced.
This expedites the task of manually downloading credential
information. This technique is recommended when you
have to cold start or replace the CCMs for a large number of
controllers.
Note: Enabling this feature can tie up the system if there are a
large number of credentials waiting to be downloaded.
The default is unchecked and disabled.

Web Server
When you select the Web server subdirectory in Velocity Settings, a screen like this
example appears:

1082 Velocity Settings Dialog Box

 MAN006-0612

The fields on this page include:

Enable web Check this box to enable the web server. This is the
server HTML-based page associated with the Velocity server that
enables remote PCs using Mobile Velocity to access Velocity
and use portions of it to monitor and control the system.
The default is unchecked and disabled.

Default page This text box identifies the default page that first appears
when the Velocity web server is opened.
A default page, \Index.html, is located in the \Velocity root
directory.

Port Enter the port number that the web server is using.
The default port number is 80. Consult your system
administrator for the port you should designate.

Root directory The directory designated as the root where Velocity

programs are located.
This directory cannot be changed.

Enable RSS Check this box to enable RSS streaming. This enables a
computer, including wireless pocket PCs, to display
up-to-the-minute event and alarm data in a streaming
format.
To run this feature, simply point your web browser to
http://servername/velocity.rss (this file is installed
automatically with Velocity 3.0 and later) and if the browser
is RSS-enabled, like IE7 or Firefox, it will recognize this file
and do the rest.
If your web browser is not RSS-capable, you will need to get
a third-party RSS reader, such as Pluck, that is an add-on
available for almost any browser on the market. After
installing this add-on, point the browser to the Security
Domain and you’re done.
No additional definitions within Velocity are required. Velocity
will issue the last 100 alarms and events without discretion
and does not adhere to Roles.

Velocity Settings Dialog Box 1083

Velocity Version 3.1 Administrator’s Guide

DIGI*TRAC Network Service (DTNS)

The DIGI*TRAC Network Service (DTNS) is required to control and oversee
communication between Velocity and all DIGI*TRAC controllers through either X*NET
or S*NET.
DTNS must be running in the background before you can use Velocity to talk with
system controllers. You control DTNS through the Service Control Manager (SCM).
Normally, SCM starts DTNS automatically. However, there are occasions when you
might have to start or stop it manually.
To start DTNS manually:
1. Right click the SCM icon in the Windows tray.
The SCM option list appears.
2. Select Start DigiTrac Network Service.
DTNS is started and the SCM icon arrow turns green.
To stop DTNS manual:
1. Right click the SCM icon in the Windows tray.
The SCM option list appears.
2. Select Stop DigiTrac Network Service.
The service is stopped and the SCM icon arrow turns red.

1084 DIGI*TRAC Network Service (DTNS)

 MAN006-0612

Restarting Velocity Services

Occasionally, Velocity Services, particularly DNS or SDS, won't start on their own and
any attempts to start them manually result in an error message. This is caused by an
Velocity installer error that fails to recognize the AD path used for the service name.
To resolve this problem permanently, refer to this procedure:
1. Open Windows Explorer (press + E) on your Velocity computer.
Windows Explorer appears.
2. Navigate to the \Program Files\Hirsch Electronics\Velocity subdirectory and select
it.
All Velocity files appear in the right pane.
3. Back at the Windows desktop, select Start > Run or press + R.
The Run dialog box appears like this example:

4. Clear the 'Open' text box until it looks like the example above.
5. From the right pane of Windows Explorer, find and drag the relevant .exe file into
the 'Open' box.
Three possible files are available:

Select this file: To restart this service:

SDServer.exe Security Domain Service (SDS)

DTServer.exe DIGI*TRAC Network Service (DNS)

EXServer.exe Extension Service

The file appears in the 'Open' text box with its complete path and file name in
quotation marks.
6. With the file and path in the text box, add this argument to the end of it:
–uninstall
Make sure you place a space before the hyphen. This uninstalls the currently
malfunctioning service.
7. Click OK.
8. Bring up the Run dialog box again and, using the down button to the right of the
'Open' field, reselect the last command.
9. At the end of the line, delete the –uninstall argument and replace it with this
argument:
–install yourservicepassword .\VelocityServices

Restarting Velocity Services 1085

Velocity Version 3.1 Administrator’s Guide

Where yourservicepassword is the password you specified in the first

password field of the Application Security screen. Make sure to place a space
before the hyphen and after your password. Also, remember to put a period
before the backward slant (.\) symbol.
10. Click OK again.
For example, if you are having trouble starting SDS and you have specified your
service password as 567, you would enter these two commands at the Run dialog
box followed each time by OK:
“C:\Program Files\Hirsch Electronics\Velocity\SDServer.exe”
–uninstall
“C:\Program Files\Hirsch Electronics\Velocity\SDServer.exe”
–install 567 .\VelocityServices
11. Repeat these steps for each service requiring it.
This should resolve the problem.

1086 Restarting Velocity Services

 MAN006-0612

SQL Database Manager

Velocity maintains its extensive database—including all user and system setup
information—as a separate module controlled by SQL Server. Three versions of SQL
Server are supported by Velocity:
 SQL Server 2005 Express
 SQL Server 2005
 SQL Server 2008 SP1 (only with Windows Server 2008 R2)
Hirsch Velocity's run-time version of SQL Server is SQL Server 2005 Express. Normally,
SQL 2005 Express runs in the background, supplying information to and collecting
information from the other Velocity modules. Inevitably, however, there are occasions
when you will need to work directly with this database: many database-related tasks,
such as database restore, require this approach. You must use SQL Manager for these
tasks.
SQL Manager controls and monitors SQL Server 2005 Express. With SQL Manager you
can make direct modifications to the SQL database without having to use the more
complex and expensive SQL Enterprise Manager which is part of the full-blown SQL
Server 2005 package; however, with large security installation, Hirsch recommends that
you purchase and install the complete SQL Server 2005 version, since it has more
features and is more robust. If you are using Windows Server 2008 R2 you must also
use SQL Server 2008 SP1.
 SQL Database Manager does not appear on this computer if Velocity has
been installed on this machine as a client.
SQL Server is a large, feature-rich, and complicated program. It can be confusing if you
haven't prior experience with it. The topics in this help section should familiarize you
with SQL Database Manager and make using it a little less daunting.
 Not all elements of SQL Database Manager are covered in this section.
Only those elements that might prove useful appear here. In general,
only one or two of these elements are recommended for use by Velocity
administrators, such as Back Up and Restore. The rest are for
administrators and programmers thoroughly conversant in SQL Server.
To open SQL Database Manager:
1. Perform one of these procedures:
• From the Windows desktop, select Start > All Programs > Microsoft SQL
Server 2005 > SQL Database Management Studio Express or Start >
All Programs > Microsoft SQL Server 2008 > SQL Database
Management Studio Express.
• At Velocity's System Tree window, click the top-level Configuration folder. You'll
see all the associated Velocity modules in the Components window. Double
click the SQL Manager program.
• From the Velocity menu bar, select Console > SQL Manager.
• From the Velocity icon bar, click the SQL Manager icon, .
The first time you open SQL Database Manager, it may take a few seconds to
configure the environment.

1087
Velocity Version 3.1 Administrator’s Guide

The Connect to Server dialog box appears like this example:

2. If required, enter a password to complete authentication; otherwise, go to Step 3.

3. Click Connect.
The SQL Server Manager main screen appears.
If you have previously installed the full-blown version of SQL Server 2005, Velocity will
detect it and open that instead of the run-time Express version.
The SQL Database Manager main screen appears. For more on this, refer to “SQL
Database Manager Main Screen” on page 1090.
Many of the functions in the SQL Database Manager are
intended for trained Velocity technicians only.
Velocity automatically creates most of the required settings
and these settings should not be changed.
Modifying or deleting the default settings can result in
program malfunction or failure.
For detailed information on SQL Server 2005, refer to your SQL Server 2005 help
documentation.

1088
 MAN006-0612

Installing SQL Server Help

SQL Database Manager for SQL Server 2005 Express Books Online is a suite of help
documentation available for your assistance. However, this documentation is not
automatically installed when you install Velocity (the file is 125 MB), although it is
available on the installation disk.
To install SQL Server 2005 Express help documentation:
1. Exit SQL Database Manager and Velocity.
2. Insert Disc 1 of the Velocity Installation DVD into your disk drive.
3. Use Windows Explorer, navigate to this directory and file on the DVD:
...\Setup\Prerequisites\SQL 2005 Books
Online\SqlServer2K5_BOL_Apr2006_v2.msi
4. Double click the .msi file.
The Windows Installer appears.
5. Click Next twice.
6. Accept the EULA and click Next.
7. Click Install.
The installer copies the new files to the designated directory. This should take
several minutes.
8. Click Finish.
The SQL Server 2005 Books Online should now be installed.
To open the SQL Server Books Online:
 From Windows desktop, select Start > All Programs > Microsoft SQL Server 2005 >
Documentation and Tutorials > SQL Server Books Online.
To view the tutorials:
1. From Windows desktop, select Start > All Programs > Microsoft SQL Server
2005 > Documentation and Tutorials > Tutorials.
2. Select SQL Server Tutorials from the list.
The Tutorials web page appears.
3. Select the tutorial(s) you want to read.

If you need to download the latest edition of this file, link to:
http://www.microsoft.com/technet/prodtechnol/sql/2005/downloads
/books.mspx
and download the latest version of the Books Online.

Installing SQL Server Help 1089

Velocity Version 3.1 Administrator’s Guide

SQL Database Manager Main Screen

The main SQL Manager screen looks like this:

The SQL Server Management Studio screen contains:

 a system tree pane (window) on the left that displays a hierarchical tree of
components
 a component pane (window) on the right, displaying the components and items
contained within the component or folder highlighted in the system tree pane.
Normally, when an item from the left window is selected, the elements making up that
item are displayed in the right window.
Like the Velocity screen, you can expand or contract this tree in order to reveal or hide
components. The expanded tree reveals these main elements:

Databases This folder contains one or more databases used for this SQL
Server workstation. A server may contain more than one
database, particularly if it is used for storing database programs
besides Velocity. However, it's generally a good idea to limit a
Velocity workstation to the Velocity database and the default
system databases, as shown in the example above.
This folder contains database diagrams, tables, views,
synonyms, programmability, and security.
For more on this, refer to “SQL Database Manager: Databases”
on page 1092.

Security This folder contains the security functions used by SQL Server
including the logins, server roles, and credentials.
For more on this, refer to “SQL Database Manager: Security” on
page 1131.

Server Objects This folder contains the backup devices, linked servers, and
server triggers.

1090 SQL Database Manager Main Screen

 MAN006-0612

Replication This folder contains the local subscriptions.

Management This folder contains the management functions used by SQL

Server, such as SQL Server logs and the Activity Monitor.
For more on this, refer to “SQL Database Manager:
Management” on page 1130.

SQL Database Manager Main Screen 1091

Velocity Version 3.1 Administrator’s Guide

SQL Database Manager: Databases

When you expand the SQL Database Manager Databases folder in the system tree
pane, you reveal these elements:

Under Velocity there are four main elements:

Database This element displays Velocity's database diagrams, an

Diagrams alternative way of looking at data from one or more tables
within the database.

Tables This element displays all Velocity's database tables. Tables are
modules SQL Server creates to categorize different types of
information.
As you can tell by looking in the SQL Database Manager
component window, Velocity generates many different types
of database tables. Each one of these can be viewed and,
where necessary, modified.
For more on this, refer to “SQL Database Manager: Tables”
on page 1113.

Views This element presents an alternate way of looking at data

from one or more tables in the database.
A view is a virtual table, usually created as a subset of
columns from one or more tables.
For more on this, refer to “SQL Database Manager: Views” on
page 1122.

Synonyms This element displays the synonyms that have been defined
for this database.
Unless defined within Velocity, no synonyms appear.

Programmability This element includes stored procedures, functions, database

triggers, assemblies, types, rules, and defaults.

Security This element displays all procedures used by SQL Server to

maintain the database.
Each procedure can be viewed and edited as required.
For more on this, refer to “SQL Database Manager: Security”
on page 1131.

You can use SQL Database Manager to perform a variety of database tasks.

1092 SQL Database Manager: Databases

 MAN006-0612

Database Tasks
When you right click on the Velocity Database folder in the left system tree pane, a
number of pop-up options appear.
Most of the operations in this section should not to be
performed by anyone who is not a SQL Server programmer.
Very bad things can happen if you decide to modify or
eliminate existing scripts. Even worse things happen when
you decide to delete or rename existing databases.
These include:

New Create a new database.

Database...

New Query Create a blank query screen in the right pane where you can write
new SQL instructions for this database.

Script This enables the qualified SQL programmer to edit existing SQL
Database script based on the following SQL commands:
as • CREATE To
• ALTER To
• DROP To
• SELECT To
• INSERT To
• UPDATE To
• DELETE To
• EXECUTE To
This enables the programmer to create new programs based on
existing templates.
For more on this, refer to SQL Commands - Introduction.

Tasks Perform the following operations:

• Detach...
• Shrink
• Back up...
• Restore
• Generate Scripts

Rename Rename the currently selected database.

Delete Delete the currently selected database.

Refresh Refresh the currently selected database.

Properties View the current properties of this database.

SQL Database Manager: Databases 1093

Velocity Version 3.1 Administrator’s Guide

Most tasks on this page are beyond the purview of this Help. Only the Backup, Restore,
and Shrink operations are explained in any detail here, and even these tasks are best
left to knowledgeable administrators. Of these, only the Restore feature may prove
necessary if the Velocity database becomes corrupted.
For more detailed information on using these database tasks, refer to your SQL Server
2005 help documentation.

SQL Database Manager Database Properties

To inspect the properties for the current Velocity database:
Use this feature with extreme care. Improper settings on this
screen can result in Velocity system crash. Unless otherwise
instructed by your system administrator or a Hirsch
technician, leave the default values.
1. From SQL Database Manager system tree pane, right click the Velocity canister icon
under the Databases folder.
A pop-up option list appears.
2. Select Properties from the option list.
The Velocity Database Properties screen appears. For more on this, refer to
“Velocity Database Properties Screen” on page 1094.
3. Inspect or make changes to this dialog box as required.

Velocity Database Properties Screen

The Velocity Properties screen appears like this example:

This screen includes six property sheets:

 General
 Files

1094 SQL Database Manager: Databases

 MAN006-0612

 Filegroups
 Options
 Permissions
 Extended Properties
For more on these properties, refer to your SQL Database Manager help
documentation.

Database Diagrams
Database diagrams are a pictorial way to see the way in which the elements of a
specific database relate.
To create a database diagram:
1. Expand the Velocity database element until the Database Diagrams element
appears.
2. Click to highlight the Database Diagrams element.
A message appears asking you whether you want to create the requisite diagrams.
3. Click Yes.
The specified diagrams are generated.
An example of a database diagram is shown in the following example:

The scrollable middle window contains the set of all tables relevant to this database.
Many tables can appear here. In order to glimpse the properties for a specific item, just
click on one of the table elements, and the properties for that element appear in the
right properties pane.
The right properties pane not only displays the properties of a selected element, it also
allows you to change a value as required.
Be very careful what you change here. The essential principal
should be this: look but don't touch, unless you are
thoroughly conversant with SQL Server and know what you
are doing. Otherwise, a change here can cause irreparable
damage to the Velocity database.

SQL Database Manager: Databases 1095

Velocity Version 3.1 Administrator’s Guide

Backing Up the Velocity Database

When you back up a database it makes a copy of the Velocity database and stores it in
a pre-defined place. This file can then be used to restore the database if it is lost.
Backing up a database copies everything in the database, including any needed
portions of the transaction log.

Hint We recommend that you use the Scheduling Agent's Perform Database
Maintenance for every day backup of the Velocity database; however, to archive a
copy of the Velocity database, use this procedure. For more on backing up using
Scheduling Agent, refer to “Backup Velocity Database” on page 1086.

To backup the Velocity database from within SQL Database Manager:

1. Open SQL Database Manager.
The SQL Database Manager main screen appears.
2. In SQL Database Manager, expand the system tree until the Databases folder
appears.
The Velocity database should appear in the components window.
3. Expand the Databases folder until the Velocity database folder appears.
4. From the system tree window, right click on the Velocity database.
A pop-up option list appears.
5. Select Tasks > Backup... from the option list.
The Back Up Database dialog box appears with the General page displayed. For
more on this, refer to “Back Up Database Dialog Box” on page 1097.
6. In the 'Source' section, accept the default values:
Source Database: Velocity
Backup type: Full
Backup component: Database
7. In the 'Backup set' section, accept the default name: Velocity-Full Database Backup.
8. In the 'Destination' section, accept the default destination that appears in the
window unless you need to change this destination file or create more than one
backup destination.
For more on this, refer to SQL Database Manager - Multiple Backup Locations.
9. If needed, click the Options folder in the left pane and the Options page appears in
the right pane.
10. Make changes as required.
Normally, you will accept these defaults.
11. Click OK to start the backup.
The entire Velocity database is copied to the file and directory you specified. Once
this is finished, a message appears indicating that the database backup has been
successfully completed.
12. Click OK.
This is a different operation from Archive Alarm and Event Logs or the Perform
Database Maintenance tasks in Scheduling Agent.

1096 SQL Database Manager: Databases

 MAN006-0612

Back Up Database Dialog Box

The SQL Server Backup dialog box appears when you select Backup Database from the
task option list.
The Back Up Database screen looks like this example:

There are two pages in this dialog box:

 General
 Options
Each is described below.
General Page
The fields and buttons on the General page are:

Source

Database From the combo box, select an existing SQL database.

In most cases, you will select the default, Velocity.

Recovery Read only field. The default is SIMPLE.

model

Backup type Accept the default Full unless you want to perform a
Differential backup.
A differential database backup records only those data changes
made to the database after the last full database backup. A
differential database backup is smaller and takes less time to
complete than a full database backup. By creating differential
database backups more frequently than database backups, you
can decrease the amount of data you risk losing.
Most of the time, you will accept the Full option.

SQL Database Manager: Databases 1097

Velocity Version 3.1 Administrator’s Guide

Backup set

Name Accept the default name fort this database: Velocity-Full

Database Backup. If you need another name for this backup,
type a new name in the text box.

Description Type a short description of this database, if required.

Backup set will Specify an expiration for this backup, either by selecting the
expire After radio button and designating the number of days this
backup is active or the On radio button and designating the
date on which this backup expires.

Transaction log Click this radio button to indicate you only want the transaction
log updated.
Note: This is currently not an available option for Velocity.

Destination Use this section to specify one or more destinations to which

you want backups written.

Back up to: Select one of these options:

Disk — Click this radio button to specify you want the database
backed up to one of the workstation's floppy or hard disk
drives. This is the default.
Tape — Click this radio button to specify you want the database
backed up to a tape drive. This radio button is only active if the
machine you're using includes a tape drive.

Add... Use this button either to select an alternative to the default

destination or create additional default destinations.
When you click this button, the Select Backup Destination
dialog box appears like the following example:

Click the browse button to locate the destination you want.

Unless otherwise instructed, accept the default location and
option, C:\Program Files\Microsoft SQL
Server\MSSQL.1\MSSQL\Velocity.bak. Click OK.
The selection appears in the Destination window.
You can select more than one device. Only those devices
already defined in the Backup section of the system tree are
available. To create multiple backup files, go to “Defining
Multiple Backup Locations” on page 1101.

1098 SQL Database Manager: Databases

 MAN006-0612

Remove Click this button to remove a selected backup device from the
Destination window. To do this:
Click and highlight a currently-displayed backup device.
Click this button.
The backup device disappears from the window.
Note: This is not a recommended practice. In most instances, you will
want to preserve your initial Velocity database backup file and
location. Deleting this default file can cause serious problems.

Contents... Click this button to display the Device Contents dialog box for
this backup device.

Options Page
This page looks like this example:

This page contains these fields:

Overwrite media This section specifies whether the latest backup is appended
to previous backup set or overwrites those backup sets.

Back up to the Click this radio button to back up this new backup set to the
existing media set existing media set.
This is the default value. Under most circumstances, you
should not have to change it.

Append to the Click this radio button if you want to append the current
existing backup backup to the previous backup.
sets The advantage of this is that it maintains a running history of
the database from one backup to the next. The disadvantage is
that more space is required. This is the default value.

SQL Database Manager: Databases 1099

Velocity Version 3.1 Administrator’s Guide

Overwrite all Click this radio button to overwrite the previous backup with
existing backup this new backup.
sets The advantage of this method is that it saves space. The
disadvantage is that any previous backup data is deleted.

Check media set If you check 'Check media set name...' box above, enter the
name... media set name.

Back up to a new If you select this radio button, the Backup to the existing media
media set and set radio button is inactivated. This selection indicates that you
erase all existing want to create a new media set each time you back up this
backup sets database and delete the existing backup set after the backup
operation is completed.
The New media set name and New media set description text
boxes are activated.

Media set name Enter a name for this media set.

A media set can contain one or more backup sets and
describes all of the media used by those backup sets,
regardless of the number of media or backup devices involved.
For example, if four tape backup devices are used when
creating a database backup, and five tapes per tape backup
device are used to store the backup, the media set contains 20
tapes.
A media family describes all the media used by a single backup
device for a single backup set. In the earlier example, there are
four media families with each set of five tapes used by each
tape backup device comprising one media family.

Media set Enter a brief description of this media set.

description

Reliability This section specifies ways SQL Database Manager can use to
verify that the backup was successful.

Verify backup Check this box to specify that the program backs up reads the
upon completion entire backup and checks for the backup's integrity on
whatever format you specified (disk, diskette, tape, etc.).

1100 SQL Database Manager: Databases

 MAN006-0612

Perform Check this box to perform a checksum test before writing this
checksum before media to the destination. This enables SQL Database Manager
writing to media to ascertain whether the data was correctly copied from the
source.
The Continue on error box is activated. Check this box if you
want the backup operation continued even if the checksum
test detects a checksum error.

Transaction Log

Truncate the Check this box to specify that the program should truncate the
transaction log transaction log. This is the default selection.
If log records were never deleted from the transaction log, the
log would keep growing until it filled all the available space on
the disks holding the log. At some point, you have to delete old
log records that are no longer necessary for recovering or
restoring a database in order to make room for new log
records. The process of deleting these log records is called
truncating the log.

Back up the tail of Check this box to back up the log tail and leave the database in
the log, and leave the restoring state. This keeps the transaction log open and
the database... ready for new information.

Tape drive

Unload the tape If a tape drive is installed and is detected by the system, this
after backup selection instructs SQL Server to unload (eject or route to
storage stack) the tape from the tape drive after backup is
completed.

Rewind the tape If a tape drive is installed, is detected by the system, and the
before unloading Unload the tape after backup option is selected, this instructs
the tape drive to rewind the tape before it unloads.

Defining Multiple Backup Locations

Velocity defines one location to which it backs up the entire Velocity database;
however, SQL Database Manager provides you with the option to create two or
more locations to which you can write Velocity data.
If you require more than one backup location, it's easily accomplished through SQL
Database Manager.
1. At the SQL Database Manager system tree, expand the Databases folder until
Velocity appears.
2. Right click Velocity.
Several options pop up.
3. Select Tasks > Backup Databases...
The Back Up Database dialog box appears.
4. In the 'Destination' section, click the Add... button.

SQL Database Manager: Databases 1101

Velocity Version 3.1 Administrator’s Guide

The Choose Backup Destination dialog box appears like this example:

If a tape drive or other backup device (such as a CD/RW or DVD/RW drive) is

detected by the system, the 'Backup device' radio button is also activated.
5. Do one of these:
If this is a file name, do this:
a. If not already done, click the File name radio button. This is the default selection.
The text box below the radio button is activated.
b. In the 'File name' text box, either enter the exact path for this new file, or click
the button.
The Locate Database Files screen appears.
c. Specify the location for this new backup file.
d. In the 'File Name' text field, enter a name for this new backup file then click OK.
The Select Backup Destination dialog box reappears.
e. Click OK.
If this is a tape drive or other backup device, do this:
a. Click the Backup device radio button. The combo box below is activated.
b. From the combo box, select the name of the tape drive or other backup device
you want to serve as the destination.
c. Click OK.
The new backup file name or device name appears in the Destination window.
6. Click OK.
7. Repeat Steps 4 - 6 for each new destination you want to define.
8. When you're finished, click OK at the Back Up Database dialog box.

Hint You shouldn't have to change any of the other values on the SQL Server Back Up
Database screen.

 The Velocity Scheduling Agent cannot recognize multiple backup

devices.

Restoring the Velocity Database

Restoring the Velocity database returns the database to the same state it was in when
backup was last performed. Any incomplete transactions in the database
backup—transactions that were not complete when the backup operation completed
originally—are rolled back to ensure the database remains consistent.

1102 SQL Database Manager: Databases

 MAN006-0612

Normally, you'll use Scheduling Agent to back up the Velocity database; however, if you
need to restore a corrupted or damaged database for any reason, use this feature.
For more on using the Scheduling Agent, refer to “Scheduling Agent,” starting on page
1039.

Hint You can use SQL Database Manager's backup procedure; however, it isn't as easy
to use as the Task Manager feature.

To restore a database from an existing file:

1. Log onto Velocity as the system administrator or a member of the system
administrator group.
2. Stop all Velocity services that are currently running.
To do this:
a. Click Start > Programs > Hirsch Electronics Velocity > Service Control
Manager.
The Velocity Services menu appears. The icon, , appears in the system tray
next to the clock and resembles the SQL Service Control Manager.
b. Right click the icon and stop all services currently running.
Once stopped, the Manager indicates 'Start' before each service as shown below.
This is how you will restart these services once you are finished restoring the
database.

3. Locate your backup file.

This should be located in the directory where you stored your previously archived
Velocity database files.
4. Click Start > Programs > Microsoft SQL Server 2005 > SQL Server
Management Studio Express to open the SQL Database Manager.
5. In SQL Database Manager, expand the system tree until the Databases folder
appears.
The Velocity database should appear in the components window.
6. Right click on the Velocity database in the components window.
A pop-up option list appears.
7. Select Tasks > Restore > Database... from the option list.
The Restore Database dialog box appears.
8. In the 'Destination for restore' section, select the place to which you want this
backup file sent.
Normally, you accept the default, Velocity.
9. In the 'Source for restore' section, select the backup file you are using to do the
restore operation.
Normally you will accept the default, Velocity.

SQL Database Manager: Databases 1103

Velocity Version 3.1 Administrator’s Guide

10. In the 'Select the backup sets to restore' window, check one or more backup sets
to restore.
Normally the relevant backup sets are checked already in the window. Accept
these selection.
11. Click OK.
The Restore Database dialog box disappears. SQL restores the specified file as the
new Velocity database.
12. Close the SQL Database Manager.
13. From the Windows tray, right click the Velocity Service Control Manager icon, .
14. Select both Start Velocity Security Domain Service and Start DIGI*TRAC
Network Service.
You can tell if these services have started correctly by observing whether the word
“start” changes to “stop” in the Velocity Service Control Manager option list.
15. Open Velocity.
The backed-up database file should now be restored on Velocity and running as the
current database.
After a Velocity database has been restored to a new computer, there are other services
and items that have to be updated in order to fully restore the Velocity system. For
more on this, refer to the next sections, “Restoring Server Extensions” on page 1106.

Restoring Velocity Database to a New Computer

If you are restoring the Velocity database as the same Velocity server/workstation/data
server where you backed it up, use “Restoring the Velocity Database,” starting on page
1102.
However, if you are restoring a backed-up Velocity database to a computer other than
the one that originally backed it up, you must perform these procedures before the task
is completely finished. These tasks should be performed after you have used SQL
Database Manager to restore the Velocity database.
 The instructions below apply only to restoring the Velocity database to a
machine on the same domain as the source machine. If you need to
move your Velocity database from one domain to another, refer to
“Moving Velocity Database to Another Domain” on page 1109.
Rename Server and Workstations Fields
There are two fields in the SQL database you must change or rename:
1. Find and record the full computer name. To do this you:
a. Open Control Panel by selecting Start > Settings > Control Panel from the
Windows desktop.
The Control Panel appears.
b. Double click the System icon.
c. Click the Network Identification tab.
The current computer name appears in the “Computer Name” field.
d. Write down the full computer name excluding the period at the end of it.
For example if the computer name says “desktop.” Then the name is “desktop”.
e. Close Control Panel.

1104 SQL Database Manager: Databases

 MAN006-0612

2. From the Windows desktop, select Start > Programs > Hirsch Electronics
Velocity > SQL Database Manager.
The SQL Database Manager appears.
3. Expand the Databases tree to display the Velocity sub-tree.
4. Expand the Velocity sub-tree to display the 'Tables' branch.
5. Click on Tables to open it up. In the right pane, a list of SQL tables appears.
 Be very careful while working with these tables since inadvertent editing
can corrupt the database.
6. Scroll down the list of tables appearing in the right pane until you see the 'Servers.'
7. Right click Servers and select open table > return all rows.
A dialog box appears.
8. At the “Server Name” field, delete the current name and type in the full computer
name you recorded in step 1.
Remember to exclude the period after the name.
9. Close the dialog box.
10. Scroll down the right pane until you come to the 'Workstations' field.
11. Right click workstations and select open table > return all rows.
Another dialog box appears.
12. At the “workstation name” field, remove the name currently displayed and replace
it with the full computer name you recorded in Step 1.
Make sure to exclude the period after the name.
13. Close that dialog box.
14. Restart the Velocity Security Domain Service.
15. Start Velocity.
16. At the Velocity menu bar, select Add-Ins > Server Extensions.
The Velocity Server Extensions Manager appears.
 The Server Extensions Manager lists the service extensions that need to
have the name of the computer updated before the service works on the
new computer. Make note of which server extensions you are actually
using.
17. Uninstall each server extension.
18. Reinstall the server extensions you actually use.
For example, if you are not using the E-mail Writer, do not reinstall this service
extension, because installing unnecessary service extensions expend valuable
computer resources; however, extensions like the Velocity Scheduling Agent, are
very important server extensions and should be reinstalled as a matter of course.
19. After you have reinstalled the necessary service extensions, stop and restart the
Velocity Extension Service through the SCM icon.
20. Start the Velocity DIGI*TRAC Network Service.

Restoring SNIB2 Encryption Files

If you are using one or more SNIB2s on your new computer, you should replace the
new encryption files with pre-restore encryption information from your old computer.
This saves you the time and energy of resetting encryption on each SNIB2.

SQL Database Manager: Databases 1105

Velocity Version 3.1 Administrator’s Guide

To restore SNIB2 encryption files:

1. From the old computer, locate the ...\Program Files\Hirsch Electronics\Velocity
directory and find the velocitytmpxxxxx.dat files where xxxxx is the number of each
encryption file.
There should be one data file for each SNIB2 installed in this system.
2. Copy all relevant .dat files from the old machine.
3. At your new computer, paste the relevant .dat files into the \\Program Files\Hirsch
Electronics\Velocity directory.
These files will overwrite the existing files and provide Velocity with the encryption
information it needs to communicate with the connected SNIB2s.
You are now ready to open Velocity and resume communication between this Velocity
server and the SNIB2-installed controller using the specified encryption.

Restoring Server Extensions

Before you can consider the Velocity server or single-user Velocity workstation
completely restored on a new computer, you must first redefine the server extensions.
To do this, perform these operations:
1. From the Windows desktop, start the Velocity Security Domain Service so Velocity
will boot.
2. Start Velocity.
3. From the Velocity menu bar, select Add-Ins > Server Extensions.
The Velocity Server Extensions Manager window appears. This contains a list of the
service extensions that need to have the name of the computer updated before
these services work after the database has been restored to a new computer.
4. Uninstall each server extension.
5. Reinstall the necessary Service Extensions for this particular customer.
For example, if the customer is not using the E-mail Writer, don’t install this service
extension because it will use valuable computer resources.
The Task Manager is a very important Server Extension to install because it includes
the Activate/Deactivate Credentials, Velocity Daily Backup, and other important
Tasks that need to execute as needed.
6. After the necessary service extensions have been reinstalled, stop and start the
Velocity Extension Service located in the Velocity Service Control Manager icon.
7. When you are ready to communicate with the controllers on your network, start
the Velocity DIGI*TRAC Network Service.

Restore Database Dialog Box

The Restore Database dialog box includes two pages:
 General
 Options
Each of these pages is described below:

1106 SQL Database Manager: Databases

 MAN006-0612

General Page
The Restore Database dialog box looks like this example:

The Restore Database dialog box presents you with a list of all the backups of the
database currently stored in the archive. It also displays which set of the backups in the
history you can use to restore the database in the shortest possible time.
When the dialog box is displayed, the backups needed to restore the database are
checked. If you know that one of the backups is not available or is out-of-date—for
example if a tape cartridge was damaged or lost—you can deselect that backup and
SQL Database Manager calculates a new restore process.
The fields and buttons on this page are explained below.

Destination for Select or enter the name of a new or existing database for
restore your restore operation.

To database: The database for which the backup is intended. The default
appears in the pick list.
If you need to pick another one, select it from the drop-down
pick list or enter a new one. Most of the time, you will accept
the default, Velocity.

To a point in Indicates the version of the database you want selected to

time: restore.
You should accept the Most recent possible option unless
you need to pick from a less recent database backup.

Restore as From the combo box select the database you want to restore.
database Always accept the default, Velocity.

Source for Specify the source and location of the backup sets to restore.
restore

SQL Database Manager: Databases 1107

Velocity Version 3.1 Administrator’s Guide

From database Click this radio button to indicate that the database to be
restored is stored either locally (on this computer) or remotely
(on a networked computer). If you need to choose another
backup set, either enter a new database or select from the
existing databases for this restore operation. Normally, you will
accept the default option.

From device Click this radio button to indicate the archived database is
stored on a device, such as a tape drive or DVD drive (if one is
detected).

Select the This window displays all of the database backups currently
backup sets to detected by SQL Server. The relevant database is checked.
restore: To select another database, check the entry.

Options Page
The Options page looks like this example:

The fields and buttons on this page are explained below.

Restore options

Overwrite the Check this box to specify that you want the restore process
existing to overwrite the existing database.
database This is the recommended technique, particularly if the
current database is corrupted.

Preserve the Check this box to preserve the replication settings.

replication Replication settings are created through the Replication
settings folder.

Prompt before Check this box to instruct SQL Server to prompt the operator
restoring each before restoring each backup.
backup

1108 SQL Database Manager: Databases

 MAN006-0612

Restrict access to Check this box to restrict access to the restored database.
the restored Before you can use the restored database, you must first
database enter a password.

Restore database When you select a database to restore, the logical and
files as: original physical filenames for each file on this database are
displayed in the table. By default, each file is restored by the
same name. However, if you need to change the name of
one or more files appearing in this list, you can type a new
name in the Restore As: column or click the browse button
to the right of each entry.
Note: Be careful with this feature: often Velocity is looking for a
specific database file name and changing it will corrupt the
Velocity database.

Recovery state

Leave database Click this radio button to specify that no further transaction
operational log backups are to be applied.

Leave database Click this radio button to specify that another transaction log
nonoperational backup is to be applied.

Leave database Click this radio button if you want this database restored as
read-only... read-only. No changes can be made to the database.
The standby file window is activated.

Standby file If you select the Leave database read-only... (RESTORE

WITH STANDBY), enter or select the standby file name to
use.

Moving Velocity Database to Another Domain

To move a Velocity database from one Velocity Security Domain to another:
1. Back up the existing Velocity database.
For more on this, refer to “Backing Up the Velocity Database” on page 1096.
2. Copy the backup file to the destination Velocity Security Domain SQL Server's
\Backup folder.
This is typically located at C:\Program Files\Microsoft\Microsoft SQL
Server\MSSQL.1\Backup.
3. Restore the Velocity database on the destination SQL Server.
For more on this, refer to “Restoring Velocity Database to a New Computer” on
page 1104.

SQL Database Manager: Databases 1109

Velocity Version 3.1 Administrator’s Guide

4. Once restored, open the database with either SQL Server Enterprise Manager (full
edition) or SQL Database Manager (Velocity run-time edition) and change the
following table values:

Table Column Value

Servers Server_Name Name of the destination Security Domain

computer

Workstations WorkstationName Name of the destination Security Domain

computer for WorkstationID=1

MiscProperties UseDomainAuthentication 1=Use Domain accounts

0=Use Local accounts

MiscProperties AuthenticationPath Name of the local computer if using local

Windows accounts or the Windows
Domain name if using domain accounts

Operators Name Your Windows user name if not logging in

as Administrator for OperatorID=2 (if
using Administrator, skip this step)

Operators DirectorySource Update all rows to the domain name if

using domain accounts or the local
computer name if using local accounts

ServerExtensions RemoteComputerName Name of the destination Security Domain

computer

5. Start the Velocity services and client.

As a result of differences in physical serial COM port configurations from the
source Velocity Security Domain computer and the destination, alarms and port
connection errors should be expected when the Velocity DIGI*TRAC Network
Service is started. Other system components such as the Serial Writer, Enrollment
Manager Enrollment Station, and printer settings also require modifications due to
possible mismatches between computers.
 Once you move a database from one system to another, you risk
compromising the integrity of your alarm and event history if:
• the destination server has hardware and Velocity gets alarms and/or
events from it
• the database is later put back to the original Security Domain
These transactions will appear in your history reports.

Shrinking Databases
SQL Database Manager allows you to shrink each file within a database to remove
unused pages and reduce the size of the files.
This activity occurs in the background and does not affect any user activity within the
database.
To shrink the database:

1110 SQL Database Manager: Databases

 MAN006-0612

1. In SQL Database Manager, expand the system tree until the Databases folder
appears.
The Velocity database should appear in the components window.
2. Right click on the Velocity database in the components window.
A pop-up option list appears.
3. Select Tasks > Shrink > Database from the option list.
The Shrink Database dialog box appears as described in “Shrink Database Dialog
Box,” starting on page 1111.
4. Supply values to the fields as required.
Most of the time, you should not have to change any values.
5. Click OK to shrink the specified database file.

Shrink Database Dialog Box

The Shrink Database dialog box appears when you select the Shrink Database...
option from the Velocity database pop-up option list.
The dialog box looks like this example:

The fields on this dialog box include:

Database Specify the database you want to shrink.

Accept the default.

Database size

Currently allocated A read-only file indicating the total current size of the
space specified database.

Available free space A read-only file indicating the size predicted after this
database is shrunk.

SQL Database Manager: Databases 1111

Velocity Version 3.1 Administrator’s Guide

Shrink action

Reorganize Check this box to move data pages to the beginning of the
files... files.
Selecting this option may affect performance.

Maximum free • If you select Reorganize files... option above, indicating the
space... percentage you require.

1112 SQL Database Manager: Databases

 MAN006-0612

SQL Database Manager: Tables

Tables are database objects that contain all the data in a database. A table definition is
a collection of columns.
In tables, data is organized in a row-and-column format similar to a spreadsheet. Each
row represents a unique record, and each column represents a field within the record.
For example, a table containing employee data for a company can contain a row for
each employee and columns representing employee details such as employee
number, name, address, job title, and home phone number.
Velocity contains many such tables, each one dealing with a different aspect of the total
security database. Many tables reflect the Velocity modules (such as DoorGroups or
EventLogs) from which they come.
There are several operations you can perform with tables in SQL Database Manager:
 View table data
 View table properties
 Modify existing tables
 Open tables
 Delete tables
For more on this, click How to Use Tables.For more on this, click “How to Use Tables”
on page 1113.

How to Use Tables

There are generally two operations you can perform within the Tables feature:
 View table data
 View table properties
 Add a table
 Modify an existing table
Each is described below.
Tables also incorporate server triggers. For more information of triggers, refer to “Server
Triggers” on page 1138.

View Table Data

Use this feature to view either a partial or complete description of all data currently
stored in a particular table.
To view a complete list of data stored in a table:
1. At the SQL Database Manager system tree pane, expand the system tree to display
the Tables element under the Velocity database.
2. Click to highlight the Tables element.

SQL Database Manager: Tables 1113

Velocity Version 3.1 Administrator’s Guide

All currently defined tables appear in the Components window.

3. Right click on the table whose data you want to view.

A pop-up option list appears.
4. Select Open Table from the option list.
The full data output for this table is displayed in the Data in Table dialog box like
this example:

5. Use the vertical and horizontal scrollbars to scroll through the information.
As you can see, you can have dozens of columns and hundreds of rows for
complicated tables.
6. If required, you can click in a particular row and column. The element is
highlighted.
7. Make changes to the value of this element as needed.
Make sure you know what you’re doing when you change a
value in a table. This is a very powerful and potentially
dangerous procedure. If you change the database in anyway
here, you can corrupt the Velocity database and damage
Velocity's operation.
8. When you're finished, click the exit button, , in the upper right corner of the
matrix.
Since a database table can hold many lines of data—particularly if the database is large
— you may only want to see a certain number of lines.

View Table Properties

Use this feature to view the current properties defined for a selected table.
To view table properties:

1114 SQL Database Manager: Tables

 MAN006-0612

1. At the SQL Tree window, expand the system tree to display the Tables element
under the Velocity database folder.
2. Select the Tables element and all currently defined tables appear in the SQL
Components window.
3. Right click on the table whose data you want to view.
A pop-up option list appears.
4. Select Properties from the option list.
A Table Properties dialog box like the following example appears:

5. View the attributes of this table and click between pages using the ‘Select a page’
pane.
6. Click OK to return to the main SQL Database Manager screen.

Adding a Table
To add a table:
1. At the SQL Tree window, expand the system tree to display the Tables element
under the Velocity database folder.
2. Select the Tables element and all currently defined tables appear in the SQL
Components window.
3. Right click on either the Tables folder in the SQL Tree pane or one of the existing
tables in the SQL Components window.
A pop-up option list appears.
4. Select New Table... from the option list.

SQL Database Manager: Tables 1115

Velocity Version 3.1 Administrator’s Guide

A screen like this example appears:

The middle pane appears with a new table displayed. The Properties pane appears
with default values displayed.
5. Create this table as required.
Make very sure what you're doing if you add a table. This is a
very powerful and potentially dangerous procedure. If you
change the database in anyway here, you can corrupt the
Velocity database and damage Velocity's operation.
For more information on doing this, refer to your SQL Server 2005 help
documentation.
6. When you're finished, click the exit button, , in either the middle or right pane to
exit this addition.
A message appears asking you to confirm your addition.
7. Click Yes.

Modify Existing Tables

To modify an existing table:
1. At the SQL Tree window, expand the system tree to display the Tables element
under the Velocity database folder.
2. Select the Tables element and all currently defined tables appear in the SQL
Components window.
3. Right click on the table whose data you want to view.
A pop-up option list appears.
4. Select Modify from the option list.

1116 SQL Database Manager: Tables

 MAN006-0612

A table like this example appears:

Notice that the middle pane displays the attributes and values for this table and
the right pane displays the properties.
5. Make changes to this table as required.
Make very sure what you're doing if you modify a table. This
is a very powerful and potentially dangerous procedure. If
you change the database in anyway here, you can corrupt the
Velocity database and damage Velocity's operation.
For more information on this, refer to your SQL Server 2005 help documentation.
6. When you're finished, click the exit button, , in either the middle or right pane to
exit this modification.
A message appears asking you to confirm your modification.
7. Click Yes.

SQL Database Manager: Tables 1117

Velocity Version 3.1 Administrator’s Guide

SQL Database Manager: Programmability

The Programmability element includes:

Stored procedures This folder includes all the stored procedures associated with
this database.
For more on this, refer to “SQL Database Manager: Stored
Procedures,” starting on page 1118.

Functions This folder includes table-valued functions, scalar-valued

functions, aggregate functions, and system functions
associated with this database.

Database triggers This folder contains all the triggers associated with this
database.

Assemblies This folder contains all the assemblies associated with this
database.

Types This folder contains all the types (system data, user-defined
data, user-defined, and XML Schema collections) associated
with this database.

Rules This folder contains all the rules associated with this
database.

Defaults This folder contains all the defaults associated with this
database.

Only Stored Procedures is detailed in this help. For more on stored procedures, refer to
“SQL Database Manager: Stored Procedures,” starting on page 1118.
For information on the other elements, refer to SQL Server 2005 Help.

SQL Database Manager: Stored Procedures

The SQL programming language is the primary programming interface between
Velocity and the SQL Server database. When you use SQL programs, two methods are
available for storing and executing the programs:
 You can store the programs locally and create applications that send the commands
to SQL Server and process the results.
 You can store the programs as stored procedures in SQL Server and create
applications that execute the stored procedures and process the results.
Stored procedures in SQL Server are similar to procedures in other programming
languages in that they can:
 accept input parameters and return multiple values in the form of output
parameters to the calling procedure or batch.
 contain programming statements that perform operations in the database, including
calling other procedures.
 return a status value to a calling procedure or batch to indicate success or failure
(and the reason for failure).
For more on using stored procedures, click How to Use Stored Procedures.

1118 SQL Database Manager: Programmability

 MAN006-0612

Creating or modifying stored procedures should be done only

by trained personnel. Velocity automatically creates all of the
stored procedures required to run Velocity or the SQL
Database Manager. Creating, modifying or deleting stored
procedures can result in program malfunction or failure.

How to Use Stored Procedures

There are several different operations you can perform with the Stored Procedures
feature. These include:
 Viewing or editing existing stored procedures
 Creating new stored procedures
Each is described below.
There are two types of stored procedures allowed by SQL Database Manager:
 Built-in stored procedures created by Hirsch and installed when Velocity is
installed. These procedures cannot be changed; they can only be viewed.
 User-designed stored procedures which can be created by a qualified Velocity
user. These procedures are distinguished from built-ins by an X_ or x_ prefix. These
can be edited, if required.
Viewing and Modifying Stored Procedures
Only those stored procedures which are user-created can be modified here. Built-in
stored procedures can only be viewed.
To view and/or modify a stored procedure:
1. At the system tree pane, expand the system tree to display the Stored Procedures
element under the Velocity Programmability folder appears.
2. Click to highlight the Stored Procedures element.
All currently defined stored procedures appear in the Components window.
3. In the Components window, right click on the procedure you want to view.
A pop-up option list appears like this example:

4. Select Modify from the option list.

SQL Database Manager: Programmability 1119

Velocity Version 3.1 Administrator’s Guide

The programming for the selected Stored Procedure appears in the middle page
like this example:

5. Use the vertical and horizontal scrollbars to scroll through the script in the middle
pane.
6. If required, click in the middle pane and make changes to the code as required.
You cannot edit the code in this window if it is built-in stored procedure.
For more information on this procedure, refer to your SQL Server 2005 help
documentation.
7. When you're finished, click the middle pane's exit button, .
A message appears asking you whether you want to modify this stored procedure.
8. To confirm this, click Yes.
Make very sure what you're doing if you edit a line in the
script. If you change the database in anyway here, you can
corrupt the Velocity database and damage Velocity's
operation.

Creating New Stored Procedures

To create a new stored procedure:
1. At the SQL system tree pane, expand the system tree to display the Stored
Procedures element, , under the Velocity database.
2. Click to highlight the Stored Procedures element.
All currently defined procedures appear in the SQL Components window.
3. In the SQL Tree window, right click on the Stored Procedures element.
A pop-up option list appears like this:

4. Select New Stored Procedure... from the option list.

1120 SQL Database Manager: Programmability

 MAN006-0612

A Stored Procedures Properties dialog box for that procedure appears like this
example:

5. Click in the middle pane and enter SQL script as needed.

The script can be as many lines as needed to describe the stored procedure fully.
For help on some elementary commands, refer to SQL Commands - Introduction.
For a more detailed description of SQL Server commands, consult your SQL Server
2005 help documentation or one of the many third-party books available on the
SQL Language.
For help on some elementary commands, refer to “Basic SQL Commands” on
page 1140. For a more detailed description of SQL Server commands, consult one
of the many books available on the SQL Language.
In order to use this feature effectively, you must have a
thorough knowledge of SQL.
Incorrect syntax or inappropriate terms can corrupt SQL and
affect Velocity's database.
6. When you're finished, click the middle pane's exit button, .
A message appears asking you whether you want to modify this stored procedure.
7. To confirm this, click Yes.
For more on stored procedures and the ways in which they can be used, refer to your
SQL Server 2005 help documentation.

SQL Database Manager: Programmability 1121

Velocity Version 3.1 Administrator’s Guide

SQL Database Manager: Views

A view is a virtual table whose contents are defined by a query. Like a real table, a view
consists of a set of named columns and rows of data. However, a view does not exist
as a stored set of data values in a database. The rows and columns of data come from
tables referenced in the query defining the view and are produced dynamically when
the view is referenced.
A view acts as a filter on the underlying tables referenced in the view. The query that
defines the view can be from one or more tables or from other views in the current or
other databases. Distributed queries can also be used to define views that use data
from multiple heterogeneous sources. This is useful, for example, if you want to
combine similarly structured data from different servers each of which stores data for a
different region of your organization.
There are no restrictions on querying through views and few restrictions on modifying
data through them. The following illustration shows a view based on two tables.

For information on using views, click “How to Use Views” on page 1122.

How to Use Views

There are a number of procedures you can use to manipulate View components.
These include:
 Create a new view (page 1122)
 Open an existing view (page 1124)
 Display view properties (page 1125)
Each of these procedures follows below.

Creating a New View

To create a new view:
1. At the SQL Database Manager system tree window, expand the system tree to
display the Views element under the Velocity database folder.
2. Select the Views element.

1122 SQL Database Manager: Views

 MAN006-0612

All currently defined views appear in the components pane as shown in the
following example:

3. From the components pane, right click on any view.

A pop-up option list appears.
4. Select New View... from the option list.
The Add Table dialog box appears.
5. Click Add then click Close.
A View Properties dialog box appears with the new View displayed in the middle
pane and the Properties for that view displayed in the right pane, like this example:

6. In the middle tabbed pane and the right property pane, make changes to the new
view as required.
For more on this, refer to your SQL Server 2005 help documents.
7. When you're finished, click the exit button, , on the middle or right pane.
A message appears asking you whether you want to save the additions you've
made.
8. Click Yes to confirm the modifications.
The new view is added to the View list.

SQL Database Manager: Views 1123

Velocity Version 3.1 Administrator’s Guide

Opening an Existing View

There are two ways to open an existing view, you can:
 open and review the entire database no matter how many rows that entails.
 open and review a partial database list, specifying the maximum number of rows
you actually want to see.
To open and view all rows for an existing view:
1. At the SQL system tree pane, expand the system tree to display the Views element
under the Velocity database folder.
2. Select the Views element.
All currently defined views appear in the SQL Components window.
3. Right click on the view whose data you want to display.
A pop-up option list appears.
4. Select Open View from the option list.
The properties for this view appear as shown in the following example:

5. If required, you can click in a particular row and column.

The element is highlighted. An right arrow appears in the far left column denoting
the row that has been selected.
6. You can customize the FunctionName as needed by clicking in any of the
CustomizedFunction columns. Make changes to the value of the default function
as needed.
7. You can also click in the Properties pane and make changes as required.
Make very sure what you're doing if you change a value in a
view. This is a very powerful and potentially dangerous
procedure. If you change the database in anyway here, you
can corrupt the Velocity database and damage Velocity's
operation.
8. When you're finished, click the exit button, , in the upper right corner of the
matrix.
A message appears asking you to confirm you changes.
9. Click Yes to confirm.

1124 SQL Database Manager: Views

 MAN006-0612

Modifying Existing Views

To modify an existing view:
1. At the SQL Tree window, expand the system tree to display the Views element
under the Velocity database folder.
2. Select the Views element.
All currently defined views appear in the SQL Components window.
3. Right click on the view you want to modify.
A pop-up option list appears.
4. Select Modify from the option list.
A screen like this example appears:

This screen includes a view of all tables associated with this view, each column that
applies to each table, the properties that apply to the selected view, and a code
window that displays the current code for that view.
5. Make changes to any of these windows or panes as required.
For more on this, refer to your SQL Server 2005 Help documents.
6. When you're finished, click the exit button, , in the upper right corner of the
matrix.
A message appears asking you whether you want to save the changes you've
made.
7. Click Yes to confirm the modifications.
Make very sure what you're doing if you change a value in a
view. This is a very powerful and potentially dangerous
procedure. If you change the database in anyway here, you
can corrupt the Velocity database and damage Velocity's
operation.

Displaying View Properties

This is another way of displaying a view.
To display an existing view:
1. At the SQL Tree window, expand the system tree to display the Views element
under the Velocity database folder.
2. Select the Views element.
All currently defined views appear in the SQL Components window.

SQL Database Manager: Views 1125

Velocity Version 3.1 Administrator’s Guide

3. Right click on the view whose properties you want to display.

A pop-up option list appears.
4. Select Properties... from the option list.
A View Properties dialog box appears like this example:

5. Click between the pages displayed in the ‘Select a page’ pane and review the
properties.
6. Click OK when you're finished.

1126 SQL Database Manager: Views

 MAN006-0612

SQL Database Manager: Users

A database user ID identifies a user within the SQL database. All permissions and
ownership of objects in the database are controlled by the user account. User accounts
are specific to a database: a user account in the sales database is different from the
user account in the inventory database.
A login ID by itself does not give a user permission to access objects in any database. A
login ID must be associated with a user ID before anyone with that login ID can access
objects in the database. If a login ID has not been explicitly associated with any user ID
in a database, it is associated with the default guest user ID. If a database has no guest
user account, a login cannot access the database unless it has been associated with a
valid user account.
To learn about setting up database users, click “How to Set Up Database User
Accounts” on page 1127.
Under most circumstances, this operation is unnecessary.
Velocity automatically assigns those operators with SQL
Database Manager permissions the required user ID for SQL
Database Manager.
Adding, modifying, or deleting user settings in SQL Database
Manager may result in program malfunction or failure.

How to Set Up Database User Accounts

To create new database users:
1. At the SQL Tree window, expand the Velocity Database to display the Users folder
under the Security database.
2. Select the Users folder.
All currently defined database users appear in the Components window like the
example below:

3. Right click on the Users folder in the SQL Tree pane and select New User... from
the pop-up option list.
The Database Users Properties dialog box appears. For more on this, refer to
“Database Users Properties Dialog Box” on page 1128.
4. Make changes as required to the pages of this screen.

SQL Database Manager: Users 1127

Velocity Version 3.1 Administrator’s Guide

For more information on using this procedure, refer to your SQL Server 2005 help
documentation.
5. When you're finished, click OK.
Make sure you understand database user accounts before
making changes. Inappropriate changes can leave the
Velocity database vulnerable to unauthorized entry.

Database Users Properties Dialog Box

This dialog box appears when you select a user's properties.
An example of this dialog box is shown below:

This dialog box contains these fields and buttons:

User Name This field contains the name you assign to this database user.

Login Name Click this radio button to indicate that this user name is the
login name. This is the default option.
The text box to the right indicates the current login name. You
can change it, if required, using the browse button.

Certificate name Click this radio button to indicate that this user name is a
certificate name.
The text box to the right indicates the current certificate name.
You can change it, if required, using the browse button.

Key name Click this radio button to indicate that this user name is a key
name.
The text box to the right indicates the current key name. You
can change it, if required, using the browse button.

Without login Click this radio button to indicate that no user name is
required. No login screen appears before entering SQL Server.

Default schema If applicable, find or enter the default schema for this user.

Schemas own by This window lists all schemas owned by this user. Check one
this user: or more to activate listed schemas.

1128 SQL Database Manager: Users

 MAN006-0612

Database role This window contains all the currently defined database roles.
membership • To select a role for this user, check the appropriate box.
• To deselect, uncheck the box.
By default, the 'public' database role includes all authorized
login users.

The other two pages, Securables and Extended Properties, are described in detail in the
SQL Server 2005 Online Help.

SQL Database Manager: Users 1129

Velocity Version 3.1 Administrator’s Guide

SQL Database Manager: Management

The Management folder of the SQL Database Manager tree contains two tasks:

SQL Server Logs logs all events recorded by SQL Server for use in case
of troubleshooting

Activity Monitor monitor SQL Server activity

1130 SQL Database Manager: Management

 MAN006-0612

SQL Database Manager: Security

The security tasks described here are designed for Hirsch
technicians only.
Do not attempt to add, change, or delete logins or server
roles in SQL Database Manager. Velocity automatically
creates the required logins and server roles when Velocity is
installed. Modifying or deleting the default login settings or
server roles will almost certainly result in program
malfunction or failure.
SQL Database Manager is protected by security procedures specified in the Security
folder.
Three procedures are contained in this folder:
 Logins which specify who can access SQL Database Manager and what passwords
they must use. For more on this, refer to “ Logins” on page 1131.
 Server Roles which specify what tasks a qualified user can perform once they log
onto SQL Database Manager. For more on this, refer to “ Logins” on page 1131.
 Credentials
Only the Logins and Server Roles subfolders are discussed in this help document.

Logins
In most cases, there are only two pieces of information Velocity requires in order to
connect to the MSDE module:
 Network name of the computer running SQL Server
 Your login ID
Login IDs are the account identifiers that control access to any SQL Server system. SQL
Server will not complete a connection unless it has first verified that the login ID you
specified is valid. This verification of the login is called authentication.
Do not attempt to add, change, or delete logins in SQL
Database Manager. Velocity automatically creates logins by
creating a Velocity group that is assigned access to the SQL
Database Manager. Modifying or deleting the default login
settings will almost certainly result in program malfunction
or failure.
For information on using certain aspects of logins, refer to “How to Use Logins” on
page 1131.

How to Use Logins

There are three functions you can perform with logins:
 Create a new login
 Review existing logins
 Delete an existing login
Each of these procedures is described below.
Logins are assigned to Server Roles.

SQL Database Manager: Security 1131

Velocity Version 3.1 Administrator’s Guide

Only Hirsch technicians should ever use these features.

Velocity performs the required task of creating logins for SQL
by creating a Velocity group that is capable of using SQL
Database Manager. You should not add, modify, or delete the
default login settings in any way. Modifying or deleting the
default login settings will almost certainly result in program
malfunction or failure.

Create a New Login

To create a new login:
1. At SQL Database Manager, expand the system tree until you see Logins under the
Security folder.
The existing login routines appear in the component window.
2. Right click on the Logins icon in the system tree window.
A pop-up option list appears.
3. Select New Login... from this list.
The SQL Server Login Properties dialog box appears.
4. Supply information as required for this new login on all three pages.
5. When you're finished, click OK to save this login and return to the main SQL
Database Manager.
6. If the new login doesn't appear in the component window, right click the Logins
icon and select Refresh from the pop-up option list.
The latest modifications should now be displayed in the component window.
Review Login Properties
To review an existing login:
1. At SQL Database Manager, expand the system tree until you see Logins under the
Security folder.
The existing login routines appear in the component window.
2. In the components pane, right click on the login you want to inspect.
A pop-up option list appears.
3. Select Properties from this list.
The SQL Server Login Properties dialog box appears.
4. Make changes to this dialog box as required.
5. When you're finished, click OK to return to the main SQL Database Manager.

Delete an Existing Login

To delete an existing login from the login list:
1. At SQL Database Manager, expand the system tree until you see Logins under the
Security folder.
The existing login routines appear in the component window.
2. In the components pane, right click on the login you want to delete. A pop-up
option list appears.
3. Select Delete from this list.
The program prompts you to confirm your deletion.
4. Select Yes.

1132 SQL Database Manager: Security

 MAN006-0612

SQL Server Login Properties Dialog Box

Each user is assigned one or more logins. Each login possesses properties that
determine how SQL Server treats the information generated by the user assigned that
login. This includes what roles SQL Server allows this login to perform and what type of
database information SQL Server allows a user with this login to create.
The default values are set by Velocity and should not be changed without technical
assistance.
This screen and its operation are intended for trained Velocity
technicians only. Do not attempt to add, change, or delete
server logins in SQL Database Manager. Velocity
automatically creates server logins by creating a Velocity
group that is assigned access to the SQL Database Manager.
Modifying or deleting the default server login settings will
almost certainly result in program malfunction or failure.
This dialog box consists of five pages:
 General
 Server Roles
 User Mapping
 Securables
 Status
The first three pages are described below.
General Login Properties Page
The general page looks like this example:

Login name Type the name of this login account.

Windows NT Click this radio button to specify that the login account uses
authentication Windows NT or 2000 authentication.
A member of the sysadmin fixed server role first specifies to
SQL Server all the valid SQL Server login accounts and
passwords. You must supply both the SQL Server login and
password when you connect to SQL Server. You are identified in
SQL Server by your SQL Server login.

SQL Database Manager: Security 1133

Velocity Version 3.1 Administrator’s Guide

SQL Server Click this radio button to specify that the login account uses SQL
authentication Server authentication.
A member of the SQL Server sysadmin fixed server role must
first specify to SQL Server all the Windows accounts or groups
that can connect to SQL Server. When using Windows NT
Authentication, you do not have to specify a login ID or
password when you connect to SQL Server. Your access to SQL
Server is controlled by your Windows account or group, which is
authenticated when you log on to the Windows operating
system on the client.

Password / Confirm Check this box to observe password policy. By default, this box
Password is checked.

Enforce password Check this box to observe password. By default, this box is
expiration checked.

User must change Check this box to force the user to change the password at the
password at next next login. By default, this box is checked.
login

Mapped to Click this radio button to indicate that you want this login
certification mapped to the certification entered below.

Certification name Enter the certification name if you selected Mapped to

certification.

Mapped to Click this radio button to indicate that you want this login
asymmetric key mapped to the asymmetric key entered below.

Key name Enter the key name if you selected Mapped to asymmetric
key.

Default Database Select the database file from the combo box drop-down list that
serves as the default database for this account. The specified
database appears on login.

Default Language Specify the language used as the default language for this login
account.
The option <Default> assumes the language of this SQL Server
edition.

1134 SQL Database Manager: Security

 MAN006-0612

Server Roles Page

The Server Roles page looks like this example:

Server roles are used to grant specific server-wide security privileges to a login. The
security privileges you can assign are listed in the Server Role window.
Click each applicable role in this window to assign or deselect the role for this particular
login.
The roles which you can assign to a user of this login are:

This role: Can:

System Administrators (sysadmin) perform any activity in the SQL Server

installation

Security Administrators manage the logins for the server

(securityadmin)

Server Administrators configure the server-wide settings

(serveradmin)

Setup Administrators manage extended stored procedures

(setupadmin)

Process Administrators manage the processes running in SQL Server

(processadmin)

Disk Administrators (diskadmin) manage the disk files

Database Creators (dbcreator) create and alter databases

Check to assign the server role to this login you want.

SQL Database Manager: Security 1135

Velocity Version 3.1 Administrator’s Guide

User Mapping Page

The User Mapping page looks like this example:

This page enables you to specify which databases can be accessed by this login.
To specify the database that can access this login:
1. In the top window appears one or more databases currently defined for this
workstation.
Only those databases listed as Velocity databases are relevant.
2. Click to check the database you want to permit for this login. You can select more
than one database.
A list of permitted database roles is displayed in the lower window.
3. In the lower window check one or more roles you want permitted for the selected
database(s).
Only those roles selected here can be accessed by this login.
For information on the remaining two pages, refer to the SQL Server 2005 Online Help.

Server Roles
When a group of users needs to perform a specified set of activities in SQL Server and
there is no applicable Velocity user group or you do not have permissions to manage
Windows NT user accounts, you can add a SQL Server role directly into the database.
This function is normally reserved for trained Hirsch
technicians only. Velocity automatically creates the required
server roles when Velocity is installed. Modifying or deleting
these role settings may result in program malfunction or
failure.

1136 SQL Database Manager: Security

 MAN006-0612

For example, a company forms a Charity Event Committee involving employees from
different departments and levels within the organization. These employees need
access to a special project table in the database. There is no existing Velocity group that
includes just these employees, and there is no other reason to create one in Velocity. A
custom SQL Server database role, CharityEvent, could be created for this project and
individual Velocity users added to the database role. When permissions are applied, the
users in the database role gain table access. Permissions for other database activities
are not affected, and they are the only ones who can work with the project table.
SQL Server roles exist within a database and cannot span more than one database. The
advantages of using database roles include:
 For any user, more than one database role can be active at any time.
 SQL Server roles can contain Windows NT groups and users, and SQL Server users
and other roles, providing all users, groups, and roles exist in the current database.
 A user can belong to more than one role in the same database.
 A scalable model is provided for setting up the correct level of security within a
database.
Because users can belong to more than one database role at a time, it is not necessary
for users to assume the identity (and permissions) of other users through temporary
aliases.
A database role is owned by either the user explicitly specified as the owner when the
role is created, or the user who created the role when no owner is specified. The owner
of the role determines who can be added or removed from the role. However, because
a role is not a database object, multiple roles of the same name in the same database
owned by different users cannot be created.

SQL Database Manager: Security 1137

Velocity Version 3.1 Administrator’s Guide

SQL Database Manager: Server Objects

When you click on the Server Objects folder in the SQL Database Manager system tree,
three subfolders are displayed:
 Backup devices
 Linked servers
 Server triggers
Two of these tasks are detailed in this help. For a discussion of Linked Servers, refer to
the SQL Database Help.
For more on backup devices, refer to “Backing Up the Velocity Database” on page
1096.
For more on Server triggers, refer to “Server Triggers” on page 1138.

Server Triggers
A server trigger is a special type of stored procedure that is automatically invoked
whenever the data in the table is modified. Server triggers are invoked in response to
INSERT, UPDATE, or DELETE statements.
A server trigger can query other tables and can include complex Transact-SQL
statements. The server trigger and the statement that fires it are treated as a single
transaction that can be rolled back from within the trigger. If a severe error is detected,
the entire transaction automatically rolls back.
Server triggers are essentially housekeeping procedures, enabling MSDE to tidy up an
entire database not just a given table or instance. For instance, if you delete a door in
Velocity, it effects the data concerning inputs, readers/keypads, relays and controllers in
the Velocity database maintained by MSDE. You can, then, assign a trigger to the door
table that automatically cleans up references to the door in all these other tables.
Server triggers are useful in these ways:
 Server triggers can cascade changes through related tables in the database.
For example, a delete trigger on the title_id column of the titles table causes a
corresponding deletion of matching rows in other tables, using the title_id column
as a unique key to locate rows in titleauthor, sales, and roysched.
 Server triggers can disallow or roll back changes that violate referential integrity,
thereby canceling the attempted data modification.
A trigger like this might go into effect when you change a foreign key and the new
value does not match its primary key. For example, you can create an insert trigger
on titleauthor.title_id that rolls back an insert if the new value does not match some
value in titles.title_id. (However, foreign key constraints are usually used for this
purpose.)
 Server triggers can enforce restrictions that are more complex than those defined
with CHECK constraints.
Unlike CHECK constraints, triggers can reference columns in other tables. For
example, a trigger can use a SELECT from another table to roll back updates that
attempt to increase a book’s price by more than one percent of its advance.
 Server triggers can also find the difference between the state of a table before and
after a data modification and take action(s) based on that difference.

1138 SQL Database Manager: Server Objects

 MAN006-0612

Multiple triggers of the same type (INSERT, UPDATE, or DELETE) on a table allow
multiple different actions to take place in response to the same modification
statement.
In the context of Velocity, the effect of server triggers can be extremely useful. For
example, if a relay is deleted from a system, it affects not only the configuration and
database of the relay itself, but also the door, controller, XBox, and Velocity workstation
with which it is associated or connected.
The task of rippling these changes throughout the system is difficult for SQL Server and
in the normal course of things, there would be artifacts of the prior state remaining
throughout the database. With triggers, however, the deletion of one relay, if properly
triggered, can delete references to that relay in all other components with which it is
associated.
Use this function with caution. Velocity automatically
generates most of the triggers it will require during normal
operation. In most circumstances, it is unnecessary to add,
modify, or delete triggers. In fact, any of these actions may
result in serious system malfunction or failure.
For more on using Server Triggers, refer to your SQL Server 2005 help documentation.

SQL Database Manager: Server Objects 1139

Velocity Version 3.1 Administrator’s Guide

Basic SQL Commands

There are a large number of SQL commands. Several commands, however, are
described in some detail here because they are particularly important in the control
and upkeep of the Velocity database.
These are:
 INSERT
 SELECT
 UPDATE

SQL Commands: INSERT

Use this command to add a new row to a table or a view.
Syntax:
INSERT [INTO]
{
table_name WITH ( table_hint_limited [...n])
| view_name
| rowset_function_limited
}

{ [(column_list)]
{ VALUES ( { DEFAULT
| NULL
| expression
}[,...n]
)
| derived_table
| execute_statement
}
}
| DEFAULT VALUES
table_hint_limited ::=
{ INDEX(index_val [,...n])
| FASTFIRSTROW
| HOLDLOCK
| PAGLOCK
| READCOMMITTED
| REPEATABLEREAD
| ROWLOCK
| SERIALIZABLE
| TABLOCK
| TABLOCKX
}

Arguments:
[INTO]
Is an optional keyword that can be used between INSERT and the target table.
table_name

1140 Basic SQL Commands

 MAN006-0612

Is the name of a table that is to receive the data.

WITH (<table_hint_limited> [...n])
Specifies one or more table hints that are allowed for a target table. The WITH key-
word and the parentheses are required. READPAST, NOLOCK, READUNCOMMIT-
TED, and UPDLOCK are not allowed. For information about table hints, see FROM.
view_name
Is the name and optional alias of a view. The view referenced by view_name must
be updatable. The modifications made by the INSERT statement cannot affect
more than one of the base tables referenced in the FROM clause of the view. For
example, an INSERT into a multitable view must use a column_list that references
only columns from one base table. For more information on updatable views, see
CREATE VIEW.
rowset_function_limited
Is either the OPENQUERY or OPENROWSET function. For more information, see
OPENQUERY and OPENROWSET.
(column_list)
Is a list of one or more columns in which to insert data. column_list must be
enclosed in parentheses and delimited by commas.
If a column is not in column_list, SQL Server must be able to provide a value based
on the definition of the column; otherwise, the row cannot be loaded. SQL Server
automatically provides a value for the column if the column:
• Has an IDENTITY property. The next incremental identity value is used.
• Has a default. The default value for the column is used.
• Has a timestamp data type. The current timestamp value is used.
• Is nullable. A null value is used.
column_list and VALUES list must be used when inserting explicit values into an
identity column, and the SET IDENTITY_INSERT option must be ON for the table.
VALUES
Introduces the list of data values to be inserted. There must be one data value for
each column in column_list (if specified) or in the table. The values list must be
enclosed in parentheses.
If the values in the VALUES list are not in the same order as the columns in the
table or do not have a value for each column in the table, column_list must be
used to explicitly specify the column that stores each incoming value.
DEFAULT
Forces SQL Server to load the default value defined for a column. If a default does
not exist for the column and the column allows NULLs, NULL is inserted. For a col-
umn defined with the timestamp data type, the next timestamp value is inserted.
DEFAULT is not valid for an identity column.
expression
Is a constant, a variable, or an expression. The expression cannot contain a SELECT
or EXECUTE statement.
derived_table
Is any valid SELECT statement that returns rows of data to be loaded into the table.
execute_statement

Basic SQL Commands 1141

Velocity Version 3.1 Administrator’s Guide

Is any valid EXECUTE statement that returns data with SELECT or READTEXT state-
ments.
If execute_statement is used with INSERT, each result set must be compatible with
the columns in the table or in column_list. execute_statement can be used to exe-
cute stored procedures on the same server or a remote server. The procedure in
the remote server is executed, and the result sets are returned to the local server
and loaded into the table in the local server. If execute_statement returns data with
the READTEXT statement, each individual READTEXT statement can return a maxi-
mum of 1 megabyte (MB) (1024 KB) of data. execute_statement can also be
used with extended procedures, and inserts the data returned by the main thread
of the extended procedure. Output from threads other than the main thread are
not inserted.
 For SQL Server version 7.0, execute_statement cannot contain an
extended stored procedure that returns text or image columns. This
behavior is a change from earlier versions of SQL Server.
DEFAULT VALUES
Forces the new row to contain the default values defined for each column.
Remarks:
INSERT appends new rows to a table. To replace data in a table, the DELETE or
TRUNCATE TABLE statements must be used to clear existing data before loading
new data with INSERT. To modify column values in existing rows, use UPDATE. To
create a new table and load it with data in one step, use the INTO option of the
SELECT statement.
Columns created with the uniqueidentifier data type store specially formatted
16-byte binary values. Unlike with identity columns, SQL Server does not automat-
ically generate values for columns with the uniqueidentifier data type. During an
insert operation, variables with a data type of uniqueidentifier and string constants
in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (36 characters including hyphens,
where x is a hexadecimal digit in the range 0-9 or a-f) can be used for uniqueiden-
tifier columns. For example, 6F9619FF-8B86-D011-B42D-00C04FC964FF is a
valid value for a uniqueidentifier variable or column. Use the NEWID() function to
obtain a globally unique ID (GUID).
When you insert rows, these rules apply:
• If a value is being loaded into columns with a char, varchar, or varbinary data
type, the padding or truncation of trailing blanks (spaces for char and varchar,
zeros for varbinary) is determined by the SET ANSI_PADDING setting defined
for the column when the table was created. For more information, see SET
ANSI_PADDING. The following table shows the default operation when SET
ANSI_PADDING is OFF:

Data type Default operation

char Pad value with spaces to the defined width of column.

varchar Remove trailing spaces to the last nonspace character or to a

single space character for strings consisting of only spaces.

varbinary Remove trailing zeros.

1142 Basic SQL Commands

 MAN006-0612

• If an empty string (‘ ‘) is loaded into a column with a varchar or text data type,
the default operation is to load a zero-length string. If the compatibility level
for the database is less than 70, the value is converted to a single space.
• If an INSERT statement violates a constraint or rule, or if it has a value
incompatible with the data type of the column, the statement fails and SQL
Server displays an error message.
• Inserting a null value into a text or image column does not create a valid text
pointer, nor does it preallocate an 8 KB text page.
• If INSERT is loading multiple rows with SELECT or EXECUTE, any violation of a
rule or constraint that occurs from the values being loaded causes the entire
statement to be terminated, and no rows are loaded.
• When an INSERT statement encounters an arithmetic error (overflow, divide
by zero, or a domain error) occurring during expression evaluation, SQL Server
handles these errors as if SET ARITHABORT is ON. The remainder of the batch
is halted, and an error message is returned.
Permissions:
INSERT permissions default to members of the sysadmin fixed server role, mem-
bers of the db_owner fixed database role, and the table owner, who can transfer
permissions to other users.
Examples:
Use a simple INSERT. This example creates the table T1 and inserts one row.
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_NAME = 'T1')
DROP TABLE T1
GO
CREATE TABLE T1 ( column_1 int, column_2 varchar(30))
INSERT T1 VALUES (1, 'Row #1')

Insert data that is not in the same order as the columns. This example uses column_list
and VALUES list to explicitly specify the values that are inserted into each column.
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_NAME = 'T1')
DROP TABLE T1
GO
CREATE TABLE T1 ( column_1 int, column_2 varchar(30))
INSERT T1 (column_2, column_1) VALUES ('Row #1',1)

Insert data with fewer values than columns. This example creates a table that has four
columns. The INSERT statements insert rows that contain values for some of the
columns, but not all of them.
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_NAME = 'T1')
DROP TABLE T1
GO
CREATE TABLE T1
( column_1 int identity,
column_2 varchar(30)
CONSTRAINT default_name DEFAULT ('column default'),
column_3 int NULL,

Basic SQL Commands 1143

Velocity Version 3.1 Administrator’s Guide

column_4 varchar(40)
)
INSERT INTO T1 (column_4)
VALUES ('Explicit value')
INSERT INTO T1 (column_2,column_4)
VALUES ('Explicit value', 'Explicit value')
INSERT INTO T1 (column_2,column_3,column_4)
VALUES ('Explicit value',-44,'Explicit value')
SELECT *
FROM T1

Load data into a table with an identity column. The first two INSERT statements allow
identity values to be generated for the new rows. The third INSERT statement overrides
the IDENTITY property for the column with the SET IDENTITY_INSERT statement, and
inserts an explicit value into the identity column.
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_NAME = 'T1')
DROP TABLE T1
GO
CREATE TABLE T1 ( column_1 int IDENTITY, column_2 varchar(30))
INSERT T1 VALUES ('Row #1')
INSERT T1 (column_2) VALUES ('Row #2')
SET IDENTITY_INSERT T1 ON
INSERT INTO T1 (column_1,column_2)
VALUES (-99,'Explicit identity value')
SELECT *
FROM T1

Load data into a table through a view. The INSERT statement in this example specifies
a view name; however, the new row is inserted in the view’s underlying table. The
order of VALUES list in the INSERT statement must match the column order of the
view.
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_NAME = 'T1')
DROP TABLE T1
GO
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.VIEWS
WHERE TABLE_NAME = 'V1')
DROP VIEW V1
GO
CREATE TABLE T1 ( column_1 int, column_2 varchar(30))
GO
CREATE VIEW V1 AS SELECT column_2, column_1
FROM T1
GO
INSERT INTO V1
VALUES ('Row 1',1)
SELECT *
FROM T1

1144 Basic SQL Commands

 MAN006-0612

Load data using the DEFAULT VALUES option. The CREATE TABLE statement in this
example defines each column with a value that can be used when no explicit value for
the column is specified in the INSERT statement. The DEFAULT VALUES option of the
INSERT statement is used to add rows without supplying explicit values.
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_NAME = 'T1')
DROP TABLE T1
GO
CREATE DEFAULT bound_default AS 'Bound default value'
GO
CREATE TABLE T1
( column_1 int identity,
column_2 varchar(30)
CONSTRAINT default_name DEFAULT ('column default'),
column_3 timestamp,
column_4 varchar(30),
column_5 int NULL)
GO
USE master
EXEC sp_bindefault 'bound_default','T1.column_4'
INSERT INTO T1 DEFAULT VALUES
SELECT *
FROM T1

Load data using the SELECT and EXECUTE options. This example demonstrates three
different methods for getting data from one table and loading it into another. Each is
based on a multitable SELECT statement that includes an expression and a literal value
in the column list.
The first INSERT statement uses a SELECT statement directly to retrieve data from the
source table, authors, and store the result set in the author_sales table. The second
INSERT executes a procedure that contains the SELECT statement, and the third
INSERT executes the SELECT statement as a literal string.
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_NAME = 'author_sales')
DROP TABLE author_sales
GO
IF EXISTS(SELECT name FROM sysobjects
WHERE name = 'get_author_sales' AND type = 'P')
DROP PROCEDURE get_author_sales
GO
USE pubs
CREATE TABLE author_sales
( data_source varchar(20),
au_id varchar(11),
au_lname varchar(40),
sales_dollars smallmoney
)
GO
CREATE PROCEDURE get_author_sales
AS
SELECT 'PROCEDURE', authors.au_id, authors.au_lname,

Basic SQL Commands 1145

Velocity Version 3.1 Administrator’s Guide

SUM(titles.price * sales.qty)
FROM authors INNER JOIN titleauthor
ON authors.au_id = titleauthor.au_id INNER JOIN titles
ON titleauthor.title_id = titles.title_id INNER JOIN sales
ON titles.title_id = sales.title_id
WHERE authors.au_id like '8%'
GROUP BY authors.au_id, authors.au_lname
GO
--INSERT...SELECT example
USE pubs
INSERT author_sales
SELECT 'SELECT', authors.au_id, authors.au_lname,
SUM(titles.price * sales.qty)
FROM authors INNER JOIN titleauthor
ON authors.au_id = titleauthor.au_id INNER JOIN titles
ON titleauthor.title_id = titles.title_id INNER JOIN sales
ON titles.title_id = sales.title_id
WHERE authors.au_id LIKE '8%'
GROUP BY authors.au_id, authors.au_lname
--INSERT...EXECUTE procedure example
INSERT author_sales EXECUTE get_author_sales
--INSERT...EXECUTE('string') example
INSERT author_sales
EXECUTE
('
SELECT ''EXEC STRING'', authors.au_id, authors.au_lname,
SUM(titles.price * sales.qty)
FROM authors INNER JOIN titleauthor
ON authors.au_id = titleauthor.au_id INNER JOIN titles
ON titleauthor.title_id = titles.title_id INNER JOIN sales
ON titles.title_id = sales.title_id
WHERE authors.au_id like ''8%''
GROUP BY authors.au_id, authors.au_lname
')
--Show results.
SELECT * FROM author_sales

Insert data using the TOP clause in a SELECT statement. Because a SELECT statement
can be specified in an INSERT statement, the TOP clause can also be used within the
SELECT statement. The example inserts the top 10 authors from the authors table into
a new table called new_authors.
IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_NAME = 'new_authors')
DROP TABLE new_authors
GO
USE pubs
CREATE TABLE new_authors
(
au_id id,
au_lname varchar(40),
au_fname varchar(20),
phone char(12),

1146 Basic SQL Commands

 MAN006-0612

address varchar(40),
city varchar(20),
state char(2),
zip char(5),
contract bit
)
INSERT INTO new_authors
SELECT TOP 10 *
FROM authors

SQL Commands: SELECT

Use this command to choose a table or view entry.
The SELECT command comes in two flavors:
 T-SQL for selecting tables
 Views for selecting views
Both are described below.

SELECT (T-SQL)
Retrieves rows from the database and allows the selection of one or more rows or
columns from one or more tables.
Syntax:
The full syntax of the SELECT statement is complex, but the main clauses can be
summarized as:
SELECT select_list
[INTO new_table_]
FROM table_source
[WHERE search_condition]
[GROUP BY group_by_expression]
[HAVING search_condition]
[ORDER BY order_expression [ASC | DESC] ]

The UNION operator can be used between queries to combine their results into a
single result set.
SELECT statement ::=
query_expression
[ ORDER BY { order_by_expression | column_position [ ASC | DESC ] }
[,...n] ]
[ COMPUTE
{ { AVG | COUNT | MAX | MIN | SUM } (expression) } [,...n]
[ BY expression [,...n] ]
]
[ FOR BROWSE ]
[ OPTION (query_hint [,...n]) ]
query expression ::=
{ query specification | (query expression) }
[UNION [ALL] query specification | (query expression) [...n] ]
query specification ::=
SELECT [ ALL | DISTINCT ]

Basic SQL Commands 1147

Velocity Version 3.1 Administrator’s Guide

[ {TOP integer | TOP integer PERCENT} [ WITH TIES] ]

select_list
[ INTO new_table ]
[ FROM {table_source} [,...n] ]
[ WHERE search_condition ]
[ GROUP BY [ALL] group_by_expression [,...n]
[ WITH { CUBE | ROLLUP } ]
]
[ HAVING search_condition ]

Arguments:
Because of the complexity of the SELECT statement, detailed syntax elements and
arguments are shown by clause:
 SELECT Clause (page 1148)
 INTO Clause (page 1150)
 FROM Clause (page 1150)
 WHERE Clause (page 1152)
 GROUP BY Clause (page 1153)
 HAVING Clause (page 1154)
 UNION Operator (page 1155)
 ORDER BY Clause (page 1156)
 COMPUTE Clause (page 1157)
 FOR BROWSE Clause (page 1158)
 OPTION Clause (page 1159)

SELECT Clause
Specifies the columns to be returned by the query.
Syntax:
SELECT [ ALL | DISTINCT ]
[ TOP n [PERCENT] [ WITH TIES] ]
select_list
select_list ::=
{ *
| { table_name | view_name | table_alias }.*
| { column_name | expression | IDENTITYCOL | ROWGUIDCOL }
[ [AS] column_alias ]
| column_alias = expression
} [,...n]

Arguments:
ALL
Specifies that duplicate rows can appear in the result set. ALL is the default.
DISTINCT
Specifies that only unique rows can appear in the result set. Null values are consid-
ered equal for the purposes of the DISTINCT keyword.
TOP n [PERCENT]
Specifies that only the first n rows are to be output from the query result set. If
PERCENT is also specified, only the first n percent of the rows are output from the

1148 Basic SQL Commands

 MAN006-0612

result set. When specified with PERCENT, n must be an integer between 0 and
100.
If the query includes an ORDER BY clause, the first n rows (or n percent of rows)
ordered by the ORDER BY clause are output. If the query has no ORDER BY clause,
the order of the rows is arbitrary.
WITH TIES
Specifies that additional rows be returned from the base result set with the same
value in the ORDER BY columns appearing as the last of the TOP n (PERCENT)
rows. TOP ...WITH TIES can only be specified if an ORDER BY clause is specified.
<select_list>
The columns to be selected for the result set. The select list is a series of expres-
sions separated by commas.
*
Specifies that all columns from all tables and views in the FROM clause should be
returned. The columns are returned by table or view, as specified in the FROM
clause, and in the order in which they exist in the table or view.
table_name | view_name | table_alias.*
Limits the scope of the * to the specified table or view.
column_name
Is the name of a column to return. Qualify column_name to prevent an ambiguous
reference, such as occurs when two tables in the FROM clause have columns with
duplicate names. For example, the Customers and Orders tables in the Northwind
database both have a column named ColumnID. If the two tables are joined in a
query, the customer ID can be specified in the select list as Customers.Custom-
erID.
expression
Is a column name, constant, function, any combination of column names, con-
stants, and functions connected by an operator(s), or a subquery.
IDENTITYCOL
Returns the identity column. For more information, see IDENTITY (Property), ALTER
TABLE, and CREATE TABLE.
If more than one table in the FROM clause has a column with the IDENTITY prop-
erty, IDENTITYCOL must be qualified with the specific table name, such as
T1.IDENTITYCOL.
ROWGUIDCOL
Returns the row global unique identifier column.
If more than one table in the FROM clause with the ROWGUIDCOL property,
ROWGUIDCOL must be qualified with the specific table name, such as
T1.ROWGUIDCOL.
column_alias
Is an alternative name to replace the column name in the query result set. For
example, an alias such as “Quantity”, or “Quantity to Date”, or “Qty” can be speci-
fied for a column named quantity.
Aliases are used also to specify names for the results of expressions, for example:

Basic SQL Commands 1149

Velocity Version 3.1 Administrator’s Guide

USE Northwind
SELECT AVG(UnitPrice) AS 'Average Price'
FROM [Order Details]
column_alias can be used in an ORDER BY clause; however, it cannot be used in a
WHERE, GROUP BY, or HAVING clause. If the query expression is part of a
DECLARE CURSOR statement, column_alias cannot be used in the FOR UPDATE
clause.

INTO Clause
Creates a new table and inserts the resulting rows from the query into it.
The user executing a SELECT statement with the INTO clause must have CREATE TABLE
permission in the destination database. SELECT...INTO cannot be used with the
COMPUTE clause or inside an explicit transaction.
You can use SELECT...INTO to create an identical table definition (different table name)
with no data by having a FALSE condition in the WHERE clause.
Syntax:
[ INTO new_table ]
Arguments:
new_table
Specifies the name of a new table to be created, based on the columns in the
select list and the rows chosen by the WHERE clause. The format of new_table is
determined by evaluating the expressions in the select list. The columns in
new_table are created in the order specified by the select list. Each column in
new_table has the same name, data type, and value as the corresponding expres-
sion in the select list.
When a computed column is included in the select list, the corresponding column
in the new table is not a computed column. The values in the new column are the
values that were computed at the time SELECT...INTO was executed.
To select into a permanent table, execute sp_dboption to turn on the select
into/bulkcopy option before executing the SELECT statement.
• If select into/bulkcopy is on in the database in which the table is to be
created, a permanent table is created. The table name must be unique in the
database and conform to the rules for identifiers. For more information, see
Using Identifiers.
• If select into/bulkcopy is not on in the database in which the table is to be
created, permanent tables cannot be created using SELECT INTO; only local or
global temporary tables can be created. To create a temporary table, the table
name must begin with a number sign (#).

FROM Clause
Specifies the table(s) from which to retrieve rows. The FROM clause is required except
when the select list contains only constants, variables, and arithmetic expressions (no
column names).
Syntax:
[ FROM {table_source} [,...n] ]
table_source ::=
table_name [ [AS] table_alias ] [ WITH ( table_hint [,...n]) ]
| view_name [ [AS] table_alias ]
| rowset_function [ [AS] table_alias ]

1150 Basic SQL Commands

 MAN006-0612

| derived_table [AS] table_alias [ (column_alias [,...n] ) ]

| joined_table
joined_table ::=
table_source join_type table_source ON search_condition
| table_source CROSS JOIN table_source
| joined_table
join_type ::=
[ INNER | { { LEFT | RIGHT | FULL } [OUTER] } ]
[ join_hint ]
JOIN

Arguments:
<table_source>
Specifies tables, views, derived tables, and joined tables for the SELECT statement.
table_name [ [AS] table_alias ]
Specifies the name of a table and an optional alias.
view_name [ [AS] table_alias ]
Specifies the name a view and an optional alias.
rowset_function [ [AS] table_alias ]
Is the name of a rowset function and an optional alias. For more information about
a list of rowset functions, see Rowset Functions.
WITH (<table_hint> [,...n])
Specifies one or more table hints. For information about table hints, see FROM.
derived_table [ [AS] table_alias ]
Is a nested SELECT statement, retrieving rows from the specified database and
table(s).
column_alias
Is an optional alias to replace a column name in the result set.
<joined_table>
Is a result set that is the product of two or more tables, for example:
FROM tab1 LEFT OUTER JOIN tab1.c3 = tab2.c3
RIGHT OUTER JOIN tab3 LEFT OUTER JOIN tab4
ON tab3.c1
ON tab2.c3 = tab4.c3
For multiple CROSS joins, use parentheses to change the natural order of the joins.
<join_type>
Specifies the type of join operation.
INNER
Specifies that all matching pairs of rows are returned. Discards unmatched rows
from both tables. This is the default if no join type is specified.
LEFT [OUTER]
Specifies that all rows from the left table not meeting the specified condition are
included in the result set in addition to all rows returned by the inner join. Output
columns from the left table are set to NULL.

Basic SQL Commands 1151

Velocity Version 3.1 Administrator’s Guide

RIGHT [OUTER]
Specifies that all rows from the right table not meeting the specified condition are
included in the result set in addition to all rows returned by the inner join. Output
columns from the right table are set to NULL.
FULL [OUTER]
If a row from either the left or right table does not match the selection criteria,
specifies the row be included in the result set, and output columns that corre-
spond to the other table be set to NULL. This is in addition to all rows usually
returned by the inner join.
<join_hint>
Specifies a join hint or execution algorithm. If <join_hint> is specified, INNER, LEFT,
RIGHT, or FULL must also be explicitly specified. For more information about join
hints, see FROM.
JOIN
Indicates that the specified tables or views should be joined.
ON <search_condition>
Specifies the condition on which the join is based. The condition can specify any
predicate, although columns and comparison operators are often used, for exam-
ple:
SELECT ProductID, Suppliers.SupplierID
FROM Suppliers JOIN Products
ON (Suppliers.SupplierID = Products.SupplierID)
When the condition specifies columns, the columns do not have to have the same
name or same data type; however, if the data types are not identical, they must be
either compatible or types that SQL Server can implicitly convert. If the data types
cannot be implicitly converted, the condition must explicitly convert the data type
using the CAST function.
CROSS JOIN
Specifies the cross-product of two tables. Returns the same rows as if the tables to
be joined were simply listed in the FROM clause and no WHERE clause was speci-
fied. For example, both of these queries return a result set that is a cross join of all
the rows in T1 and T2:
SELECT * FROM T1, T2
SELECT * FROM T1 CROSS JOIN T2

WHERE Clause
Specifies a search condition to restrict the rows returned.
Syntax:
[WHERE search_condition | old_outer_join]
old_outer_join ::=
column_name { *= | =* } column_name

Arguments:
<search_condition>
Restricts the rows returned in the result set through the use of predicates. There is
no limit to the number of predicates that can be included in a search condition. For
more information about search conditions and predicates, see Search Condition.

1152 Basic SQL Commands

 MAN006-0612

<old_outer_join>
Specifies an outer join using the nonstandard product-specific syntax and the
WHERE clause. The *= operator is used to specify a left outer join and the =* oper-
ator is used to specify a right outer join.
This example specifies a left outer join in which the rows from Tab1 that do not
meet the specified condition are included in the result set:
SELECT Tab1.name, Tab2.id
FROM Tab1, Tab2
WHERE Tab1.id *=Tab2.id

 Using this syntax for outer joins is discouraged because of the potential
for ambiguous interpretation and because it is nonstandard. Instead,
specify joins in the FROM clause.
It is possible to specify outer joins by using join operators in the FROM clause or by
using the non-standard *= and =* operators in the WHERE clause. The two meth-
ods cannot both be used in the same statement.

GROUP BY Clause
Specifies the groups into which output rows are to be placed and, if aggregate
functions are included in the SELECT clause <select list>, calculates a summary value
for each group. When a GROUP BY clause is used, each item in the select list must
produce a single value for each group. Null values in one item are placed in one group.
 If the ORDER BY clause is not specified, groups returned using the
GROUP BY clause are not in any particular order. It is recommended that
you always use the ORDER BY clause to specify a particular ordering of
the data.
Syntax:
[ GROUP BY [ALL] group_by_expression [,...n]
[ WITH { CUBE | ROLLUP } ]
]

Arguments:
ALL
Includes all groups and result sets, even those that do not have any rows that meet
the search condition specified in the WHERE clause. When ALL is specified, null
values are returned for the summary columns of groups that do not meet the
search condition. You cannot specify ALL with the CUBE or ROLLUP operators.
GROUP BY ALL is not supported in queries that access remote tables.
group_by_expression
Is an expression on which grouping is performed. group_by_expression is also
known as a grouping column. group_by expression can be a column or a
non-aggregate expression that references a column. A column alias that is defined
in the select list cannot be used to specify a grouping column. When GROUP BY is
specified, any column in the select list (except a column used in an aggregate
function) must be specified as a grouping column.
 Columns of type text, ntext, image, and bit cannot be used in
group_by_expression.

Basic SQL Commands 1153

Velocity Version 3.1 Administrator’s Guide

For GROUP BY clauses that do not contain CUBE or ROLLUP, the number of
group_by_expression items is limited by the GROUP BY column sizes, the aggre-
gated columns, and the aggregate values involved in the query. This limit originates
from the limit of 8,060 bytes on the intermediate work table that is needed to hold
intermediate query results. A maximum of 10 grouping expressions is permitted
when CUBE or ROLLUP is specified.
CUBE
Specifies that, in addition to the usual rows provided by GROUP BY, summary rows
are introduced into the result set. A GROUP BY summary row is returned for every
possible combination of group and subgroup in the result set. A GROUP BY sum-
mary row is displayed as NULL in the result, but is used to indicate all values. Use
the GROUPING function to determine whether null values in the result set are
GROUP BY summary values.
The number of summary rows in the result set is determined by the number of
columns included in the GROUP BY clause. Each operand (column) in the GROUP
BY clause is bound under the grouping NULL and grouping is applied to all other
operands (columns). Because CUBE returns every possible combination of group
and subgroup, the number of rows is the same, regardless of the order in which
the grouping columns are specified.
ROLLUP
Specifies that, in addition to the usual rows provided by GROUP BY, summary rows
are introduced into the result set. Groups are summarized in a hierarchical order,
from the lowest level in the group to the highest. The group hierarchy is deter-
mined by the order in which the grouping columns are specified. Changing the
order of the grouping columns can affect the number of rows produced in the
result set.
 Distinct aggregates, for example, AVG(DISTINCT column_name),
COUNT(DISTINCT column_name), and SUM(DISTINCT column_name),
are not supported when using CUBE or ROLLUP. If used, SQL Server
returns an error message and cancels the query.

HAVING Clause
Specifies a search condition for a group or an aggregate. HAVING is usually used with
the GROUP BY clause. When GROUP BY is not used, HAVING behaves like a WHERE
clause.
Syntax:
[ HAVING search_condition ]

Arguments:
<search_condition>
Specifies the search condition for the group or the aggregate to meet. When HAV-
ING is used with GROUP BY ALL, the HAVING clause overrides ALL. For more infor-
mation, see Search Condition.
The text, image, and ntext data types cannot be used in a HAVING clause.
 Using the HAVING clause in the SELECT statement does not affect the
way the CUBE roles the result set and returns summary aggregate rows.

1154 Basic SQL Commands

 MAN006-0612

UNION Operator
Combines the results of two or more queries into a single result set consisting of all the
rows belonging to all queries in the union. This is different from using joins that
combine columns from two tables.
Two basic rules for combining the result sets of two queries with UNION are:
 The number and the order of the columns must be identical in all queries
 The data types must be compatible.
Syntax:
{ query specification | (query expression) }
UNION [ALL]
query specification | (query expression)
[UNION [ALL] query specification | (query expression)
[...n] ]

Arguments:
<query_specification> | (<query_expression>)
Is a query specification or query expression that returns data to be combined with
the data from another query specification or query expression. The definitions of
the columns that are part of a UNION operation do not have to be identical, but
they must be compatible through implicit conversion.
The following table shows the rules for comparing the data types and options of
corresponding (ith) columns:

Data type of ith column of

Data type of ith column
results table

Not data type-compatible (data Error returned by SQL Server.

conversion not handled implicitly by
SQL Server).

Both fixed-length char with lengths L1 Fixed-length char with length equal to
and L2. the greater of L1 and L2.

Both fixed-length binary with lengths Fixed-length binary with length equal
L1 and L2. to the greater of L1 and L2.

Either or both variable-length char. Variable-length char with length equal

to the maximum of the lengths
specified for the ith columns.

Either or both variable-length binary. Variable-length binary with length

equal to the maximum of the lengths
specified for the ith columns.

Basic SQL Commands 1155

Velocity Version 3.1 Administrator’s Guide

Data type of ith column of

Data type of ith column
results table

Both numeric data types (for example, Data type equal to the maximum
smallint, int, float, money). precision of the two columns. For
example, if the ith column of table A is
of type int and the ith column of table
B is of type float, then the data type of
the ith column of the results table is
float because float is more precise
than int.

Both columns’ descriptions specify Specifies NOT NULL.

NOT NULL.

UNION
Specifies that multiple result sets are to be combined and returned as a single
result set.
ALL
Incorporates all rows into the results, including duplicates. If not specified, duplicate
rows are removed.

ORDER BY Clause
Specifies the sort for the result set. Subqueries and view definitions cannot include an
ORDER BY clause.
Syntax:
[ORDER BY {order_by_expression [ ASC|DESC ] } [,...n] ]

Arguments:
order_by_expression
Specifies a column on which to sort. A sort column can be specified as a name or
column alias (which can be qualified by the table or view name), an expression, or
a nonnegative integer representing the position of the name, alias, or expression in
select list.
Multiple sort columns can be specified. The sequence of the sort columns in the
ORDER BY clause defines the organization of the sorted result set.
The ORDER BY clause can include items not appearing in the select list; however, if
SELECT DISTINCT is specified or if the SELECT statement contains a UNION opera-
tor, the sort columns must appear in the select list.
Furthermore, when the SELECT statement includes a UNION operator, the column
names or column aliases must be those specified in the first select list.
 ntext, text, or image columns cannot be used in an ORDER BY clause.
ASC
Specifies that the values in the specified column should be sorted in ascending
order, from lowest value to highest value.
DESC

1156 Basic SQL Commands

 MAN006-0612

Specifies that the values in the specified column should be sorted in descending
order, from highest value to lowest value.
Null values are treated as the lowest possible values.
There is no limit to the number of items in the ORDER BY clause; however, there is a
limit of 8,060 bytes, for the row size of intermediate worktables needed for sort
operations. This limits the total size of columns specified in an ORDER BY clause.

COMPUTE Clause
Generates totals that appear as additional summary columns at the end of the result
set. When used with BY, the COMPUTE clause generates control-breaks and subtotals
in the result set. You can specify COMPUTE BY and COMPUTE in the same query.
Syntax:
[ COMPUTE
{ { AVG | COUNT | MAX | MIN | STDEV | STDEVP
|VAR | VARP | SUM }
(expression) } [,...n]
[ BY expression [,...n] ]
]

Arguments:
AVG | COUNT | MAX | MIN | STDEV | STDEVP | VAR | VARP | SUM
Specifies the aggregation to be performed. These row aggregate functions are
used with the COMPUTE clause.

Row aggregate
Result
function

AVG Average of the values in the numeric expression

COUNT Number of selected rows

MAX Highest value in the expression

MIN Lowest value in the expression

STDEV Statistical standard deviation for all values in the

expression

STDEVP Statistical standard deviation for the population for all

values in the expression

SUM Total of the values in the numeric expression

VAR Statistical variance for all values in the expression

VARP Statistical variance for the population for all values in

the expression

There is no equivalent to COUNT(*). To find the summary information produced

by GROUP BY and COUNT(*), use a COMPUTE clause without BY.
These functions ignore null values.
The DISTINCT keyword is not allowed with row aggregate functions when they are
specified with the COMPUTE clause.

Basic SQL Commands 1157

Velocity Version 3.1 Administrator’s Guide

When you add or average integer data, SQL Server treats the result as an int value,
even if the data type of the column is smallint or tinyint.
 To reduce the possibility of overflow errors in ODBC and DB-Library
programs, make all variable declarations for the results of averages or
sums the data type int.
(expression)
An expression, such as the name of a column on which the calculation is per-
formed. Expression must appear in the select list and must be specified exactly
the same as one of the expressions in the select list. A column alias specified in
the select list cannot be used within expression.
 ntext, text, or image data types cannot be specified in a COMPUTE or
COMPUTE BY clause.
BY expression
Generates control-breaks and subtotals in the result set. expression is an exact
copy of an order_by_expression in the associated ORDER BY clause. Typically, this
is a column name or column alias. Multiple expressions can be specified. Listing
multiple expressions after BY breaks a group into subgroups and applies the aggre-
gate function at each level of grouping.
If you use COMPUTE BY, you must also use an ORDER BY clause. The expressions
must be identical to or a subset of those listed after ORDER BY, and must be in the
same sequence. For example, if the ORDER BY clause is:
ORDER BY a, b, c
The COMPUTE clause can be any (or all) of these:
COMPUTE BY a, b, c
COMPUTE BY a, b
COMPUTE BY a

 In a SELECT statement with a COMPUTE clause, the order of columns in

the select list overrides the order of the aggregate functions in the
COMPUTE clause. ODBC and DB-Library programmers must be aware of
this order requirement to put the aggregate function results in the
correct place.
You cannot use COMPUTE in a SELECT INTO statement because statements including
COMPUTE generate tables and their summary results are not stored in the database.
Therefore, any calculations produced by COMPUTE do not appear in the new table
created with the SELECT INTO statement.
You cannot use the COMPUTE clause when the SELECT statement is part of a
DECLARE CURSOR statement.

FOR BROWSE Clause

Specifies that updates be allowed while viewing data in client applications using
DB-Library.
A table can be browsed in an application under these conditions:
 The table includes a time-stamped column (defined with the timestamp data type).
 The table has a unique index.
 The FOR BROWSE option is at the end of the SELECT statement(s) sent to SQL
Server.

1158 Basic SQL Commands

 MAN006-0612

 It is not possible to use the <lock_hint> HOLDLOCK in a SELECT

statement that includes the FOR BROWSE option.
The FOR BROWSE option cannot appear in SELECT statements joined by the UNION
operator.
Syntax:
[ FOR BROWSE ]

OPTION Clause
Specifies that the indicated query hint should be used throughout the entire query.
Each query hint can be specified only once, although multiple query hints are
permitted. The OPTION clause must be specified with the outermost query of the
statement. The query hint affects all operators in the statement. If a UNION is involved
in the main query, only the last query involving a UNION operator can have the
OPTION clause. If one or more query hints causes the query optimizer to not generate
a valid plan, SQL Server recompiles the query without the specified query hints, and
issues a SQL Server Profiler event.
Because the query optimizer usually selects the best
execution plan for a query, it is recommended that
<join_hint>, <query_hint>, and <table_hint> be used only as
a last resort by experienced database administrators.
Syntax:
[ OPTION (query_hint [,...n) ]
query_hint ::=
{ { HASH | ORDER } GROUP
| { CONCAT | HASH | MERGE } UNION
| { LOOP | MERGE | HASH } JOIN
| FAST number_rows
| FORCE ORDER
| MAXDOP number
| ROBUST PLAN
| KEEP PLAN
}

Arguments:
{HASH | ORDER} GROUP
Specifies that aggregations described in the GROUP BY or COMPUTE clause of the
query should use hashing or ordering.
{MERGE | HASH | CONCAT} UNION
Specifies that all UNION operations are performed by merging, hashing, or concat-
enating UNION sets. If more than one UNION hint is specified, the optimizer
selects the least expensive strategy from those hints specified.
{LOOP | MERGE | HASH |} JOIN
Specifies that all join operations are performed by loop join, merge join, or hash
join in the whole query. If more than one join hint is specified, the optimizer
selects the least expensive join strategy for the allowed ones. If, in the same query,
a join hint is also specified for a specific pair of tables, it takes precedence in the
joining of the two tables.
FAST number_rows

Basic SQL Commands 1159

Velocity Version 3.1 Administrator’s Guide

Specifies that the query is optimized for fast retrieval of the first number_rows (a
nonnegative integer). After the first number_rows are returned, the query contin-
ues execution and produces its full result set.
FORCE ORDER
Specifies that the join order indicated by the query syntax is preserved during
query optimization.
MAXDOP number
Overrides the max degree of parallelism configuration option (of sp_configure)
only for the query specifying this option. All semantic rules used with max degree
of parallelism configuration option are applicable when using the MAXDOP query
hint.
ROBUST PLAN
Forces the query optimizer to attempt a plan that works for the maximum potential
row size, possibly at the expense of performance. When the query is processed,
intermediate tables and operators may need to store and process rows that are
wider than any of the input rows. The rows may be so wide that, in some cases,
the particular operator cannot process the row. If this happens, SQL Server pro-
duces an error during query execution. By using ROBUST PLAN, you instruct the
query optimizer not to consider any query plans that may encounter this problem.
KEEP PLAN
Forces the query optimizer to relax the estimated recompile threshold for a query.
The estimated recompile threshold is the point at which a query is automatically
recompiled when the estimated number of indexed column changes (update,
delete or insert) have been made to a table. Specifying KEEP PLAN ensures that a
query will not be recompiled as frequently when there are multiple updates to a
table.
Remarks:
The order of the clauses in the SELECT statement is significant. Any of the optional
clauses can be omitted, but when used, they must appear in the appropriate order.
The length returned for text or ntext columns included in the select list defaults to
the smallest of the actual size of the text, the default TEXTSIZE session setting, or
the hard-coded application limit. To change the length of returned text for the ses-
sion, use the SET statement. By default, the limit on the length of text data
returned with a SELECT statement is 4,000 bytes.
SQL Server raises exception 511 and rolls back the current executing statement if
either of these occur:
The SELECT statement produces a result row or an intermediate work table row
exceeding 8,060 bytes.
The DELETE, INSERT, or UPDATE statement attempts action on a row exceeding
8,060 bytes.
In SQL Server, an error occurs if no column name is given to a column created by
a SELECT INTO or CREATE VIEW statement. For more information, see trace flag
246 in Trace Flags.
Selecting Identity Columns
When selecting an existing identity column into a new table, the new column
inherits the IDENTITY property, unless one of the following conditions is true:

1160 Basic SQL Commands

 MAN006-0612

• The SELECT statement contains a join, GROUP BY clause, or aggregate

function.
• Multiple SELECT statements are joined with UNION.
• The identity column is listed more than once in the select list.
• The identity column is part of an expression.
If any of these conditions is true, the column is created NOT NULL instead of inher-
iting the IDENTITY property. All rules and restrictions for the identity columns apply
to the new table.
Old-Style Outer Joins
Earlier versions of SQL Server supported the definition of outer joins that used the
*= and =* operators in the WHERE clause. SQL Server version 7.0 supports the
SQL-92 standard, which provides join operators in the FROM clause. It is recom-
mended that queries be rewritten to use the SQL-92 syntax.
Processing Order of WHERE, GROUP BY, and HAVING Clauses:
This list shows the processing order for a SELECT statement with a WHERE clause,
a GROUP BY clause, and a HAVING clause.
1. The WHERE clause excludes rows not meeting its search condition.
2. The GROUP BY clause collects the selected rows into one group for each
unique value in the GROUP BY clause.
3. Aggregate functions specified in the select list calculate summary values for
each group.
4. The HAVING clause further excludes rows not meeting its search condition.
Permissions:
SELECT permissions default to members of the sysadmin fixed server role, mem-
bers of the db_owner fixed database role, and the table owner, who can transfer
permissions to other users. If the INTO clause is used to create a permanent table,
the user must have CREATE TABLE permission in the destination database.

SELECT (Views)
A view can be thought of as either a virtual table or a stored query. The data accessible
through a view is not stored in the database as a distinct object. What is stored in the
database is a SELECT statement. The result set of the SELECT statement forms the
virtual table returned by the view. A user can use this virtual table by referencing the
view name in Transact-SQL statements the same way a table is referenced. A view is
used to do any or all of these functions:
 Restrict a user to specific rows in a table. For example, let an employee see only the
rows recording their work in a labor-tracking table.
 Restrict a user to specific columns. For example, let employees who do not work in
payroll see the name, office, work phone, and department columns in an employee
table, but do not let them see any columns with salary information or personal
information.
 Join columns from multiple tables so that they look like a single table.
 Aggregate information instead of supplying details. For example, present the sum of
a column, or the maximum or minimum value from a column.

Basic SQL Commands 1161

Velocity Version 3.1 Administrator’s Guide

Views are created by defining the SELECT statement that retrieves data to be presented
by the view. The data tables referenced by the SELECT statement are known as the
base tables for the view. titleview in the pubs database is an example of a view that
selects data from three base tables to present a virtual table of commonly needed data.
CREATE VIEW titleview
AS
SELECT title, au_ord, au_lname, price, ytd_sales, pub_id
FROM authors AS a
JOIN titleauthor AS ta ON (a.au_id = ta.au_id)
JOIN titles AS t ON (t.title_id = ta.title_id)

You can then reference titleview in statements in the same way you would reference a
table.
SELECT *
FROM titleview

A view can reference another view. For example, titleview presents information that is
useful for managers, but a company typically only discloses year-to-date figures in
quarterly or annual financial statements. A view can be built that selects all the titleview
columns except au_ord and ytd_sales. This new view can be used by customers to get
lists of available books without seeing the financial information:
CREATE VIEW Cust_titleview
AS
SELECT title, au_lname, price, pub_id
FROM titleview

You can update views in SQL Server—making them the targets of UPDATE, DELETE, or
INSERT statements—so long as the modification only affects one of the base tables
referenced by the view. For example:
-- Increase the prices for publisher 0736 by 10%.
UPDATE titleview
SET price = price * 1.10
WHERE pub_id = '0736'
GO

SQL Commands: UPDATE

Use this command to change existing data in a table.
Syntax:
UPDATE
{
table_name WITH ( table_hint_limited [...n])
| view_name
| rowset_function_limited
}
SET
{column_name = {expression | DEFAULT | NULL}
| @variable = expression
| @variable = column = expression } [,...n]
{{[FROM {table_source} [,...n] ]
[WHERE
search_condition] }
|

1162 Basic SQL Commands

 MAN006-0612

[WHERE CURRENT OF
{ { [GLOBAL] cursor_name } | cursor_variable_name}
] }
[OPTION (query_hint [,...n] )]
table_source ::=
table_name [ [AS] table_alias ] [ WITH ( table_hint [,...n]) ]
| view_name [ [AS] table_alias ]
| rowset_function [ [AS] table_alias ]
| derived_table [AS] table_alias [ (column_alias [,...n] ) ]
| joined_table
joined_table ::=
table_source join_type table_source ON search_condition
| table_source CROSS JOIN table_source
| joined_table
join_type ::=
[ INNER | { { LEFT | RIGHT | FULL } [OUTER] } ]
[ join_hint ]
JOIN
table_hint_limited ::=
{ INDEX(index_val [,...n])
| FASTFIRSTROW
| HOLDLOCK
| PAGLOCK
| READCOMMITTED
| REPEATABLEREAD
| ROWLOCK
| SERIALIZABLE
| TABLOCK
| TABLOCKX
}
table_hint ::=
{ INDEX(index_val [,...n])
| FASTFIRSTROW
| HOLDLOCK
| NOLOCK
| PAGLOCK
| READCOMMITTED
| READPAST
| READUNCOMMITTED
| REPEATABLEREAD
| ROWLOCK
| SERIALIZABLE
| TABLOCK
| TABLOCKX
| UPDLOCK
}
query_hint ::=
{ { HASH | ORDER } GROUP
| { CONCAT | HASH | MERGE } UNION
| {LOOP | MERGE | HASH} JOIN
| FAST number_rows
| FORCE ORDER

Basic SQL Commands 1163

Velocity Version 3.1 Administrator’s Guide

| MAXDOP
| ROBUST PLAN
| KEEP PLAN
}

Arguments:
table_name
Is the name of the table to update. The name can be qualified with the linked
server, database, and owner name if the table is not in the current server or data-
base, or is not owned by the current user.
WITH (<table_hint_limited> [...n])
Specifies one or more table hints that are allowed for a target table. The WITH key-
word and the parentheses are required. READPAST, NOLOCK, READUNCOMMIT-
TED, and UPDLOCK are not allowed. For information about table hints, see FROM.
view_name
Is the name of the view to update. The view referenced by view_name must be
updatable. The modifications made by the UPDATE statement cannot affect more
than one of the base tables referenced in the FROM clause of the view. For more
information on updatable views, see CREATE VIEW.
rowset_function_limited
Is either the OPENQUERY or OPENROWSET function, subject to provider capabili-
ties. For more information about capabilities needed by the provider, see UPDATE
and DELETE Requirements for OLE DB Providers. For more information about the
rowset functions, see OPENQUERY and OPENROWSET.
SET
Specifies the list of column or variable names to be updated.
column_name
Is a column that contains the data to be changed. column_name must reside in
the table or view specified in the UPDATE clause. Identity columns cannot be
updated.
If a qualified column name is specified, the qualifier must match the table or view
name in the UPDATE clause. For example, this is valid:
UPDATE authors
SET authors.au_fname = 'Annie'
WHERE au_fname = 'Anne'
A table alias specified in a FROM clause cannot be used as a qualifier in SET
column_name. For example, this is not valid:
UPDATE titles
SET t.ytd_sales = t.ytd_sales + s.qty
FROM titles t, sales s
WHERE t.title_id = s.title_id
AND s.ord_date = (SELECT MAX(sales.ord_date) FROM sales)
To make the example work, remove the t. alias from the column name.
UPDATE titles
SET ytd_sales = t.ytd_sales + s.qty
FROM titles t, sales s
WHERE t.title_id = s.title_id

1164 Basic SQL Commands

 MAN006-0612

AND s.ord_date = (SELECT MAX(sales.ord_date) FROM sales)

expression
Is a variable, literal value, expression, or a parenthesized subSELECT statement that
returns a single value. The value returned by expression replaces the existing value
in column_name or @variable.
DEFAULT
Specifies that the default value defined for the column is to replace the existing
value in the column. This can also be used to change the column to NULL if the
column has no default and is defined to allow null values.
@variable
Is a declared variable that is set to the value returned by expression.
SET @variable = column = expression sets the variable to the same value as the
column. This differs from SET @variable = column, column = expression, which
sets the variable to the pre-update value of the column.
FROM <table_source>
Specifies that a table is used to provide the criteria for the update operation. For
more information, see FROM.
table_name [[AS] table_alias ]
Is the name of a table to provide criteria for the update operation.
If the table being updated is the same as the table in the FROM clause, and there
is only one reference to the table in the FROM clause, table_alias may or may not
be specified. If the table being updated appears more than one time in the FROM
clause, one (and only one) reference to the table must not specify a table alias. All
other references to the table in the FROM clause must include a table alias.
view_name [[AS] table_alias ]
Is the name of a view to provide criteria for the update operation.
WITH (<table_hint> [...n])
Specifies one or more table hints for a source table. For information about table
hints, see FROM.
rowset_function [ [AS] table_alias ]
Is the name of any rowset function and an optional alias. For information about a
list of rowset functions, see Rowset Functions.
derived_table
Is a subquery that retrieves rows from the database. derived_table is used as input
to the outer query.
column_alias
Is an optional alias to replace a column name in the result set. Include one column
alias for each column in the select list, and enclose the entire list of column aliases
in parentheses.
<joined_table>
Is a result set that is the product of two or more tables, for example:
FROM tab1 LEFT OUTER JOIN tab1.c3 = tab2.c3
RIGHT OUTER JOIN tab3 LEFT OUTER JOIN tab4

Basic SQL Commands 1165

Velocity Version 3.1 Administrator’s Guide

ON tab3.c1
ON tab2.c3 = tab4.c3
For multiple CROSS joins, use parentheses to change the natural order of the joins.
<join_type>
Specifies the type of join operation.
INNER
Specifies that all matching pairs of rows are returned. Discards unmatched rows
from both tables. This is the default if no join type is specified.
LEFT [OUTER]
Specifies that all rows from the left table not meeting the specified condition are
included in the result set in addition to all rows returned by the inner join. Output
columns from the left table are set to NULL.
RIGHT [OUTER]
Specifies that all rows from the right table not meeting the specified condition are
included in the result set in addition to all rows returned by the inner join. Output
columns from the right table are set to NULL.
FULL [OUTER]
If a row from either the left or right table does not match the selection criteria,
specifies the row be included in the result set, and output columns that corre-
spond to the other table be set to NULL. This is in addition to all rows usually
returned by the inner join.
<join_hint>
Specifies a join hint or execution algorithm. If <join_hint> is specified, INNER, LEFT,
RIGHT, or FULL must also be explicitly specified. For more information about joint
hints, see FROM.
JOIN
Indicates that the specified tables or views should be joined.
ON <search_condition>
Specifies the condition on which the join is based. The condition can specify any
predicate, although columns and comparison operators are often used, for exam-
ple:
FROM Suppliers JOIN Products
ON (Suppliers.SupplierID = Products.SupplierID)
When the condition specifies columns, the columns do not have to have the same
name or same data type; however, if the data types are not identical, they must be
either compatible or types that Microsoft® SQL Server™ can implicitly convert. If
the data types cannot be implicitly converted, the condition must explicitly convert
the data type using the CAST function.
CROSS JOIN
Specifies the cross-product of two tables. Returns the same rows as if the tables to
be joined were simply listed in the FROM clause and no WHERE clause was speci-
fied.
WHERE

1166 Basic SQL Commands

 MAN006-0612

Specifies the conditions that limit the rows that are updated. There are two forms
of update based on which form of the WHERE clause is used:
• Searched updates specify a search condition to qualify the rows to delete.
• Positioned updates use the CURRENT OF clause to specify a cursor. The
update operation occurs at the current position of the cursor.
<search_condition>
Specifies the condition to be met for the rows to be updated. The search condition
can also be the condition upon which a join is based. There is no limit to the num-
ber of predicates that can be included in a search condition. For more information
about predicates and search conditions, see Search Condition.
CURRENT OF
Specifies that the update is performed at the current position of the specified cur-
sor.
GLOBAL
Specifies that cursor_name refers to a global cursor.
cursor_name
Is the name of the open cursor from which the fetch should be made. If both a
global and a local cursor exist with cursor_name as their name, cursor_name refers
to the global cursor if GLOBAL is specified. If GLOBAL is not specified, cursor_name
refers to the local cursor. The cursor must allow updates.
cursor_variable_name
Is the name of a cursor variable. cursor_variable_name must reference a cursor
that allows updates.
OPTION (<query_hint> [,...n] )
Specifies that optimizer hints are used to customize SQL Server’s processing of the
statement.
{HASH | ORDER} GROUP
Specifies that the aggregations specified in the GROUP BY or COMPUTE clause of
the query should use hashing or ordering.
{LOOP | MERGE | HASH |} JOIN
Specifies that all join operations are performed by loop join, merge join, or hash
join in the whole query. If more than one join hint is specified, the query optimizer
selects the least expensive join strategy for the allowed ones. If, in the same query,
a join hint is also specified for a specific pair of tables, it takes precedence in the
joining of the two tables.
{MERGE | HASH | CONCAT} UNION
Specifies that all UNION operations should be performed by merging, hashing, or
concatenating UNION sets. If more than one UNION hint is specified, the query
optimizer selects the least expensive strategy from those hints specified.
 If a join hint is also specified for any particular pair of joined tables in the
FROM clause, it takes precedence over any join hint specified in the
OPTION clause.

Basic SQL Commands 1167

Velocity Version 3.1 Administrator’s Guide

FAST number_rows
Specifies that the query is optimized for fast retrieval of the first number_rows (a
nonnegative integer). After the first number_rows are returned, the query contin-
ues execution and produces its full result set.
FORCE ORDER
Specifies that the join order indicated by the query syntax should be preserved dur-
ing query optimization.
MAXDOP number
Overrides the max degree of parallelism configuration option (of sp_configure)
only for the query specifying this option. All semantic rules used with max degree
of parallelism configuration option are applicable when using the MAXDOP query
hint. For more information, see max degree of parallelism Option.
ROBUST PLAN
Forces the query optimizer to attempt a plan that works for the maximum potential
row size at the expense of performance. If no such plan is possible, the query opti-
mizer returns an error rather than deferring error detection to query execution.
Rows may contain variable-length columns; SQL Server allows rows to be defined
whose maximum potential size is beyond the ability of SQL Server to process. Usu-
ally, despite the maximum potential size, an application stores rows that have
actual sizes within the limits that SQL Server can process. If SQL Server encounters
a row that is too long, an execution error is returned.
KEEP PLAN
Forces the query optimizer to relax the estimated recompile threshold for a query.
The estimated recompile threshold is the point at which a query is automatically
recompiled when the estimated number of indexed column changes (update,
delete or insert) have been made to a table. Specifying KEEP PLAN ensures that a
query will not be recompiled as frequently when there are multiple updates to a
table.
Remarks:
If an update to a row violates a constraint or rule, if it violates the NULL setting for
the column, or if the new value is an incompatible data type, the statement is can-
celed, an error is returned, and no records are updated.
When an UPDATE statement encounters an arithmetic error (overflow, divide by
zero, or a domain error) during expression evaluation the update is not performed.
The remainder of the batch is not executed, and an error message is returned.
If an update to a column or columns participating in a clustered index causes the
size of the clustered index and the row to exceed 8,060 bytes, the update fails and
an error message is returned.
If an update query could alter more than one row while updating both the cluster-
ing key and one or more text, image, or Unicode columns, the update operation
fails and SQL Server returns an error message.
Modifying a text, ntext, or image column with UPDATE initializes the column,
assigns a valid text pointer to it, and allocates at least one data page unless updat-
ing the column with NULL.

1168 Basic SQL Commands

 MAN006-0612

 The UPDATE statement is logged. If you are replacing or modifying large

blocks of text, ntext, or image data, use the WRITETEXT or UPDATETEXT
statement instead of the UPDATE statement. The WRITETEXT and
UPDATETEXT statements (by default) are not logged.
All char and nchar columns are right-padded to the defined length.
If ANSI_PADDING is set OFF, all trailing spaces are removed from data inserted into
varchar and nvarchar columns, except in strings containing only spaces. These
strings are truncated to an empty string. If ANSI_PADDING is set ON, trailing spaces
are inserted. The Microsoft SQL Server ODBC driver and OLE DB Provider for SQL
Server automatically set ANSI_PADDING ON for each connection. This can be con-
figured in ODBC data sources or by setting connection attributes or properties.
A positioned update using a WHERE CURRENT OF clause updates the single row
at the current position of the cursor. This can be more accurate than a searched
update that uses a WHERE <search_condition> clause to qualify the rows to be
updated. A searched update modifies multiple rows when the search condition
does not uniquely identify a single row.
The results of an UPDATE statement are undefined if the statement includes a
FROM clause that is not specified in such a way that only one value is available for
each column occurrence that is updated (in other words, if the UPDATE statement
is not deterministic). For example, given the UPDATE statement in the following
script, both rows in table s meet the qualifications of the FROM clause in the
UPDATE statement, but it is undefined which row from s is used to update the row
in table t.
CREATE TABLE s (ColA INT, ColB DECIMAL(10,3))
GO
CREATE TABLE t (ColA INT PRIMARY KEY, ColB DECIMAL(10,3))
GO
INSERT INTO s VALUES(1, 10.0)
INSERT INTO s VALUES(1, 20.0)
INSERT INTO t VALUES(1, 0.0)
GO
UPDATE t
SET t.ColB = t.ColB + s.ColB
FROM t INNER JOIN s ON (t.ColA = s.ColA)
GO
The same problem can occur when combining the FROM and WHERE CURRENT
OF clauses. In this example, both rows in table t2 meet the qualifications of the
FROM clause in the UPDATE statement. It is undefined which row from t2 is to be
used to update the row in table t1.
CREATE TABLE t1(c1 INT PRIMARY KEY, c2 INT)
GO
CREATE TABLE t2(d1 INT PRIMARY KEY, d2 INT)
GO
INSERT INTO t1 VALUES (1, 10)
INSERT INTO t2 VALUES (1, 20)
INSERT INTO t2 VALUES (2, 30)
go
DECLARE abc CURSOR LOCAL FOR
SELECT * FROM t1
OPEN abc

Basic SQL Commands 1169

Velocity Version 3.1 Administrator’s Guide

FETCH abc

UPDATE t1 SET c2 = c2 + d2
FROM t2
WHERE CURRENT OF abc
GO

Setting Variables and Columns

Variable names can be used in UPDATE statements to show the old and new val-
ues affected. This should only be used when the UPDATE statement affects a sin-
gle record; if the UPDATE statement affects multiple records, the variables only
contain the values for one of the updated rows.
Permissions
UPDATE permissions default to members of the sysadmin fixed server role, the
db_owner fixed database role, and the table owner, who can transfer permissions
to other users. SELECT permissions are also required for the table being updated if
the UPDATE statement contains a WHERE clause, or if expression in the SET clause
uses a column in the table.
Examples
Use a simple UPDATE. These examples show how all rows can be affected if a
WHERE clause is eliminated from an UPDATE statement.
If all the publishing houses in the publishers table move their head offices to
Atlanta, Georgia, this example shows how the publishers table can be updated.
UPDATE publishers
SET city = 'Atlanta', state = 'GA'
This example changes the names of all the publishers to NULL.
UPDATE publishers
SET pub_name = NULL
You can also use computed values in an update. This example doubles all prices in
the titles table.
UPDATE titles
SET price = price * 2
Use the UPDATE statement with a WHERE clause. The WHERE clause specifies the
rows to update. For example, in the unlikely event that northern California is
renamed Pacifica (abbreviated PC) and the people of Oakland vote to change the
name of their city to Bay City. This example shows how to update the authors table
for all former Oakland residents whose addresses are now out of date.
UPDATE authors
SET state = 'PC', city = 'Bay City'
WHERE state = 'CA' AND city = 'Oakland'
You must write another statement to change the name of the state for residents of
other northern California cities.
Use the UPDATE statement using information from another table. This example
modifies the ytd_sales column in the titles table to reflect the most recent sales
recorded in the sales table.
UPDATE titles
SET ytd_sales = titles.ytd_sales + sales.qty
FROM titles, sales
WHERE titles.title_id = sales.title_id
AND sales.ord_date = (SELECT MAX(sales.ord_date) FROM sales)

1170 Basic SQL Commands

 MAN006-0612

This example assumes that only one set of sales is recorded for a given title on a
given date and that updates are current. If this is not the case (if more than one
sale for a given title can be recorded on the same day), the example shown here
does not work correctly. It executes without error, but each title is updated with
only one sale, regardless of how many sales actually occurred on that day. This is
because a single UPDATE statement never updates the same row twice.
In the situation in which more than one sale for a given title can occur on the same
day, all the sales for each title must be aggregated together within the UPDATE
statement, as shown in this example:
UPDATE titles
SET ytd_sales =
(SELECT SUM(qty)
FROM sales
WHERE sales.title_id = titles.title_id
AND sales.ord_date IN (SELECT MAX(ord_date) FROM sales))
FROM titles, sales
Use UPDATE with the TOP clause in a SELECT statement. This example updates
the state column for the first 10 authors from the authors table.
UPDATE authors
SET state = 'ZZ'
FROM (SELECT TOP 10 * FROM authors ORDER BY au_lname) AS t1
WHERE authors.au_id = t1.au_id

Basic SQL Commands 1171

Velocity Version 3.1 Administrator’s Guide

1172 Basic SQL Commands

 MAN006-0612

Status Viewer
The Status Viewer enables you to quickly review all of the current component settings.
To open the Status Viewer, use one of these methods:
 From the components window, double click the Status Viewer option, .
 From the icon tool bar, click the Status Viewer icon, .
 From the menu bar, select Console > Status Viewer.
 Press F9.
The Status Viewer main screen appears. For more on this, refer to “Status Viewer Main
Screen” on page 1174.
Once the Status Viewer appears, review it as required.
 Expand each component group
 Review current status for selected groups (page 1181)
 Perform tasks (page 1181)
 Define status groups (page 1183)
 Before you can view the status of inputs or expansion inputs, first
configure the required inputs to report the required status. To do this,
enable the required reporting features in either the door inputs general
property sheet or inputs/expansion inputs general property sheet under
the 'Enable State Change Reporting' section.
For dial-up connections, status is not available from the Status Viewer unless there is a
current dial-up connection. If Velocity needs to dial up the connection before seeking
status, Velocity will disconnect from the location after two minutes and status will not
be continuously updated.

1173
Velocity Version 3.1 Administrator’s Guide

Status Viewer Main Screen

One possible version of Status Viewer looks like this example:

This viewer includes the following fields and buttons:

Click this button to display only those points currently masked in this
status window. A simplified screen appears like this example:

Notice that the reason for masking each item is displayed in the
third column, 'Reason Masked'.
To display all currently selected points again in the status window,
click the Status Group button. The Masked and Status Group
buttons are mutually exclusive: if one is selected, the other one is
deselected.

Select the class of points from the drop-down list you want to
display. This filters the points displayed. The Masked and Status
Group buttons are mutually exclusive: if one is selected, the other
one is deselected.
Only those points currently defined for this status group appear in
this list.

Select the status group from this drop-down list that you want to
display in the status window.
Only those status groups currently defined for this system appear in
this list. None is the default.

Click this button to display the Status Viewer Properties and either
define a new status group or modify an existing status group.
For more on this, refer to Status Viewer Properties.

status Displays the status of all currently selected points. The columns that
window appear change according to the type of component displayed.
For a complete description of the columns and items displayed
here, refer to Status Window Columns below.

1174 Status Viewer Main Screen

 MAN006-0612

Click this button to display Velocity online help.

 No results appear for a door or input unless reporting has been enabled
for that input type under the Enable State Change Reporting section of
either the Door Input or Input pages. Four types can be enabled: Door
Contact, RQE, Tamper, and Line Fault.

Status Window Columns

The columns and items for each component type are described briefly here:

Component Columns Explanation

Doors

Door Name Name assigned to this door

Address Address Velocity generated for this door. For

more on interpreting this address format, refer
to “Address Format” on page 422.

Status Status of inputs associated with this door (i.e.

active, inactive, open circuit, etc.)

Alarm Indicates whether this door is currently alarmed

(Yes) or not (-).

Masked Indicates whether this door's input is currently

masked (Yes) or unmasked (-).

Enabled Is this door enabled? (Yes/No)

1ALRM Status of this door's line module Alarm point. All

LMs have a first point for Alarms.
If no point is detected, a dash appears.

2RQE Status of this door's line module RQE point. All

LM2s and LM3s have a second point for RQEs.
If no point is detected, a dash appears.

3TMPR Status of this door's line module Tamper point.

All LM3s have a third point for tamper.
If no point is detected, a dash appears.

LM Type of line module associated with this door,

where:
1 = LM1
2 = LM2
3 = LM3

LM Volts Voltage level for this door's line module.

Relay Whether the relay associated with this door is

currently ON or OFF.

Status Viewer Main Screen 1175

Velocity Version 3.1 Administrator’s Guide

Component Columns Explanation

2PR Is this door enabled for two-person rule?

(Yes/No)

Updated The date and time when the status of this door
was last refreshed.

Inputs

Input Name Name assigned to this input

Address Address Velocity generated for this input. For

more on interpreting this address format, refer
to “Address Format” on page 422.

Status Current status of this input (i.e. active, inactive,

etc.)

Alarm Indicates whether this input is currently alarmed

(Yes) or not (-).

Masked Indicates whether this input is currently masked

(Yes) or unmasked (-).

Enabled Is this input currently enabled? (Yes/No)

1ALRM Status of this line module's Alarm point. All LMs

have a first point for Alarms.
If no point is detected, a dash appears.

2RQE Status of this line module's RQE point. All LM2s

and LM3s have a second point for RQEs.
If no point is detected, a dash appears.

3TMPR Status of this line module's Tamper point. All

LM3s have a third point for tamper.
If no point is detected, a dash appears.

LM Type of line module this input uses, where:

1 = LM1
2 = LM2
3 = LM3

LM Volts Voltage level for this line module.

Updated The date and time when the status of this input
was last refreshed.

Relays

Relay Name Name assigned to this relay.

Address Address Velocity generated for this relay. For

more on interpreting this address format, refer
to “Address Format” on page 422.

1176 Status Viewer Main Screen

 MAN006-0612

Component Columns Explanation

Status Current status of this relay (i.e. active, inactive,

etc.).

Updated The date and time when the status of this relay
was last refreshed.

Readers

Reader Name Name assigned to this reader.

Address Address Velocity generated for this reader. For

more on interpreting this address format, refer
to “Address Format” on page 422.

Status Current status of this reader.

Code Tamper Indicates whether this reader is currently

experiencing a code tamper condition (Yes) or
not.

Physical Indicates whether this reader is currently

Tamper experiencing a physical tamper condition (Yes)
or not.

Updated The date and time when the status of this

reader was last refreshed.

Controllers

Controller Name assigned to this controller

Name

Address Address Velocity generated for this controller. For

more on interpreting this address format, refer
to “Address Format” on page 422.

Status Current status of this controller (online, inactive,

etc.).

Enclosure Current status of the door protecting this

controller board. The lock alarm can indicate
one of three conditions: secure (door is closed),
tamper (door is ajar), or blank if the system
does not know.

Enabled Is this controller currently enabled for Velocity?

(Yes/No)

Terminal Indicates whether this controller is using a SCIB

to connect to a terminal. This enables it to issue
D*T commands directly to the controller
through an terminal emulate program. (Logged
ON/Logged OFF)

Status Viewer Main Screen 1177

Velocity Version 3.1 Administrator’s Guide

Component Columns Explanation

AC Power The voltage/amperage at which this controller is

running.

UPS Battery Current status of this controller’s UPS.

(OK/Weak/Failed)

Local Whether this controller is currently being

Programming programmed by an attached keypad. (OFF/ON)

Mem Current state of controller memory. (OK/Parity

Error/etc.)

Printer Current state of the connected parallel printer.

(Offline/Online)

S Printer Current state of any connected serial printer.

(Offline/Online)

Tamper Current tamper state (Pending/Not Pending).

Pending

Updated The date and time when the status of this

controller was last refreshed.

XBoxes

XBox Name Name assigned to this XBox.

Address Address Velocity generated for this XBox. For

more on interpreting this address format, refer
to “Address Format” on page 422.

Enabled Is this XBox currently active? (Yes/No)

Rev What is the revision number for this XBox as

detected by Velocity?

Updated The date and time when the status of this XBox
was last refreshed.

Ports

Port Name Name assigned to this port.

Address Address Velocity generated for this port. For

more on interpreting this address format, refer
to “Address Format” on page 422.

Status Current status of the port.

Enabled Is this port currently active? (Yes/No)

Updated The date and time when the status of this port
was last refreshed.

Expansion Inputs

1178 Status Viewer Main Screen

 MAN006-0612

Component Columns Explanation

XInput Name Name assigned to this expansion input.

Address Address Velocity generated for this expansion

input. For more on interpreting this address
format, refer to “Address Format” on page 422.

Status Current status of the expansion input.

Alarm Indicates whether this expansion input is

currently alarmed (Yes) or not (-).

Masked Indicates whether this expansion input is

currently masked (Yes) or unmasked (-).

Enabled Is this input currently enabled? (Yes/No)

1ALRM Status of this line module's Alarm point. All LMs

have a first point for Alarms.
If no point is detected, a dash appears.

2RQE Status of this door's line module RQE point. All

LM2s and LM3s have a second point for RQEs.
If no point is detected, a dash appears.

3TMPR Status of this door's line module Tamper point.

All LM3s have a third point for tamper.
If no point is detected, a dash appears.

LM Type of line module this input uses, where:

1 = LM1
2 = LM2
3 = LM3

LM Volts Voltage level for this line module.

Updated The date and time when the status of this

expansion input was last refreshed.

Expansion Relays

XRelay Name Name assigned to this expansion relay.

Address Address Velocity generated for this expansion

relay. For more on interpreting this address
format, refer to “Address Format” on page 422.

Status Current status of this expansion relay.

Updated The date and time when the status of this

expansion relay was last refreshed.

Status is not available from the Status Viewer unless there is a current dial-up
connection. If Velocity needs to dial up the connection before seeking status, Velocity
will disconnect from the location after two minutes and status will not be accurate.

Status Viewer Main Screen 1179

Velocity Version 3.1 Administrator’s Guide

Expand or contract each component type as required.

 To expand a component type, click the plus button to the left of the group, . The
plus button becomes a minus button.
 To contract an expanded group, click the minus button, . The minus button
becomes a plus button.

1180 Status Viewer Main Screen

 MAN006-0612

Status Viewer: How to Use

To customize the status viewer:
1. From the main Velocity screen, do one of these:
• From the icon tool bar, click the Status Viewer icon, .
• From the menu bar, select Console > Status Viewer.
• Press F9.
The Status Viewer main screen appears. For more on this, refer to “Status Viewer
Main Screen” on page 1174.
2. From the 'Status Group' combo box, select one of the available options:
• one of the existing status groups
• None to display no status
The window changes to display all components for the selected status group. If
required, create a new status group.
 We strongly recommend that you create status groups as soon as
possible, since viewing the status of 'all points' (the default value) on all
controllers can take a long time. Velocity must poll each point on all
connected controllers before it displays the results.
For instructions on adding, modifying, or configuring a status group, click Create
Status Groups.
3. If required, customize the column headers that appear on the status viewer.
4. Expand or contract each component group as required and monitor the current
status of the system.
Polling status of the selected points takes place as soon as you pick the points you
want to view.
To decode messages, refer to “Status Messages” on page 1186.
5. Perform one or more of the right-click tasks available for a selected component.
For more on this, refer to “Status Viewer Right-Click Options” on page 1181.
6. Click to exit Status Viewer and return to the main Velocity menu.
 Before you can view the status of inputs or expansion inputs, first
configure the required inputs to report the required status. To do this,
enable the required reporting features in either the door inputs general
property sheet or inputs/expansion inputs general property sheet under
the 'Enable State Change Reporting' section.
Status is not available from the Status Viewer unless there is a current dial-up
connection. If Velocity needs to dial up the connection before seeking status, Velocity
will disconnect from the location after two minutes and status will not be accurate.

Status Viewer Right-Click Options

Status Viewer provides a variety of options you can perform from this module.
To perform a task:
1. Right click on a specific component or point that appears in the status window.
An option list appears.

Status Viewer: How to Use 1181

Velocity Version 3.1 Administrator’s Guide

2. Select one of these options:

Click this option... To:

Access Functions Perform one of the access functions on the

selected device.
Only doors support this function.

Control Functions Perform one of the control functions on the

selected device.
Only those functions available to the
device/point appear in the sublist. For example,
a door supports a full set of control options
while an expansion input or relay supports only
some. All other categories of points do not
support control functions at all.

Refresh Consult the controller for the most up-to-date

information on the selected device/point.

Configure Device Bring up the properties sheet for the selected

device/point. For example, if you select this
option for a reader, the reader properties sheet
for that reader appear.
The qualified operator can change values on the
property sheet and modify the device/point as
required. When you're finished, click OK to
return to the Status Group screen.

1182 Status Viewer: How to Use

 MAN006-0612

Creating Status Groups

When you first open Status Viewer, you have a choice of only one group: All. This
displays the status of all devices on all controllers throughout your entire system. This
often provides a very large and daunting status list to the operator. In order to limit the
number of devices shown in Status Viewer, you must create one or more status
groups.
To create a status group:
1. From the Status Viewer, click the Configure Status Group button, , on the menu
tool bar.
The Status Viewer Properties dialog box appears with the Status Groups page
showing. For more on this, refer to “Status Groups Page” on page 1184.
2. From the 'Status Group' combo box on the Status Group property sheet, select the
<New> option.
The Available pane is populated with all available devices. The Selected pane is
emptied.
3. In the Status Group text box, enter the name you want for the new status group.
4. From the 'View as' section, click the radio buttons for the component type you
want displayed in the Available pane.
Only the component type selected here is displayed in the Available pane.
Select All to display all available system components in the Available pane.
5. From the 'Available' pane, select those system elements you want to view on the
Event Viewer for this Status Group.
• Ctrl + click to select a non-contiguous group of elements.
• Shift + click to select a contiguous range of elements.
6. Click the right arrow button, , to move all the highlighted components in the
'Available' pane to the 'Selected' pane.
Click the double right arrow button, , to move all components in the 'Selected'
pane back into the 'Available' pane.
7. Remove components from the 'Selected' pane by highlighting one or more in the
'Selected' pane then click the left arrow button, , to move those components
back into the 'Available' pane.
Click the double arrow button, , to move all components from the 'Selected'
pane back into the 'Available' pane.
8. When you've selected all the components you want to view for this Status Group,
click the Column Headers tab to display the Column Headers page.
For more on this page, refer to “Column Headers Page” on page 1185.
Use this page to customize the arrangement of the columns on the Status Viewer
page.
9. Make changes as required on the Column Headers page.
10. Click OK to return to the Status Viewer.
The configuration for this status group is automatically saved.

Creating Status Groups 1183

Velocity Version 3.1 Administrator’s Guide

Status Groups Page

The status groups page looks like this:

It includes these combo boxes, buttons, and windows:

Status Click this combo box to select the status group you want to display.
Group: If you want to create a new status group, select <New>.

Click this button to delete the currently displayed status group from
the system. A message appears asking you whether you are sure
you want to delete this item. Click Yes to delete the displayed status
group.

View as: Click the radio button that describes the components you want to
view on the Status Viewer during the specified status group.
Click All to display all relevant components.

Available This window displays all the components you specified to show in
the 'View as' section. Select from this window and the selection
appears in the 'Selected' window.

Selected This window displays all the components you selected from the
'Available' window and included using one of the right arrow
buttons.

Click this button to select only those components you have

highlighted in the 'Available' window. They now appear in the
'Selected' window.

Click this button to select all the components appearing in the

'Available' window. All the components now appear in the 'Selected'
window.

1184 Creating Status Groups

 MAN006-0612

Click this button to remove one or more highlighted components

from the 'Selected' window and return them to the 'Available'
window.

Click this button to remove all displayed components from the

'Selected' window and return them to the 'Available' window.

For information on the Column Headers page, see the next topic.

Column Headers Page

When you select the Column Headers tab from the Status Viewer Properties dialog
box, a screen like this example appears:

Use this page to define which columns appear on the Status Viewer for the specified
Status Group.
To customize the Status Viewer for this specific status group:
1. From the 'Object' combo box, select the object whose properties you want to
define.
The properties specific to the selected object appear in the lower window.
2. Check the boxes of all those properties you want displayed on the Status Viewer
for the selected object.
Only checked items appear as columns for that object on the Status Viewer; all
unchecked items do not appear on the Status Viewer.
3. Rearrange the displayed columns as required.
• Click the Move Up button to move a selected item up in priority. Each click
moves the selected item one column left on the Status Viewer. The nearer the
top an object appears in the 'Check an item...' window, the farther to the left it
appears on the Status Viewer.
• Click the Move Down button to move a selected item down the list. Each
click moves the selected column to the right by one column on the Status
Viewer. The nearer the bottom of the window an object appears, the farther to
the right it appears on the Status Viewer.
4. Repeat Steps 1 - 3 for each object you need to customize this status group.
5. When you're finished, click OK to return to the Status Viewer.
Changes to the look of the Viewer for this Status Group are reflected on the screen.

Creating Status Groups 1185

Velocity Version 3.1 Administrator’s Guide

Status Messages
Here is a complete list of status messages currently displayed by the Status Viewer
together with their meaning:

Message Meaning Possible Response

Active This device is currently active None required.

or actuated.

Inactive This device is currently inactive None required.

or de-actuated.

Open Circuit Velocity has detected that Check to make sure the DTLM
there is no DTLM input. is connected properly.

Secure No alarm, no tamper, and None required.

relay OFF. Note: A door can have a Secure
status even if it is being
tampered with, so it's
important to monitor the
Status and Alarm Viewers.

Unlocked Relay ON. None required.

Masked Input is masked. None required.

Door open Switch open. None required.

Short Velocity has detected a short Check the circuit and

in the circuit. connections between the
controller and this device.

Noisy Velocity has detected unusual Check the circuit and

static or noise on this line. connections between the
controller and this device.

Out of spec Velocity has detected that the Check the circuit and
voltage on this line is currently connections between the
not within acceptable limits. controller and this device.

Relays have two possible normal states:

 Energized (LED On)
 De-energized (LED Off)
Inputs have two possible normal states:
 Normally Open
 Normally Closed

1186 Creating Status Groups

 MAN006-0612

Trigger Action Manager

The Hirsch Trigger Action Manager is a feature that enables qualified operators to
create, edit, and delete trigger action pairs. A trigger action pair is an event or alarm that
is matched to a resulting action. These pairs currently are associated with CCTV and
DVR device actions, but in the future, this feature will serve as a clearinghouse for all
event triggers and resulting actions no matter what the device.

Using Trigger Action Manager

To use the Trigger Action Manager:
1. From the system tree pane, click the Interfaces Configuration folder.
The Hirsch Trigger Action Manager option appears in the components pane.
2. From the components pane, double click the Hirsch Trigger Action Manager
option.
The Trigger Action Summary appears.

This screen includes the following columns and buttons:

Trigger This column specifies the trigger's name.

Location This column specifies the trigger's location. This is the address
of the point specified in the standard Velocity address format.
This is the location specified in the 'Location:' combo box of the
Add Trigger Action screen.

Action This column specifies the action that is triggered at the

designated device.

Type This column specifies the type of trigger this is.

Device This column specifies the device that is being triggered.

Add... Click this button to display the Add Trigger Action screen and
create a new trigger action.

1187
Velocity Version 3.1 Administrator’s Guide

Edit... Click this button after highlighting an existing trigger action to

display the Add Trigger Action screen and edit the selected
trigger action.

Delete Click this button to delete a selected trigger action.

Close Click this button to close the trigger action summary.

3. Do one of these:
• Add a new trigger action. For more on this, refer to “Adding Trigger Actions” on
page 1188.
• Edit an existing trigger action. For more on this, refer to “Editing Triggers and
Actions” on page 1189.
• Delete an existing trigger action. For more on this, refer to “Deleting Triggers
and Actions” on page 1189.
4. When you're finished, click Close.
You are returned to the main Velocity screen.
 Control zones, which incorporate triggers and actions, are not included
in this group; nor are alarm actions that are within the purview of
controller properties.

Adding Trigger Actions

To create a new trigger action:
1. At the Trigger Action Summary screen, click the Add... button.
The Add Trigger Action screen appears. For more on this, refer to “Add Trigger
Action Screen” on page 1189.
2. At the 'Location:' combo box do one of two things:
• Enter the address of a specific point defined as the trigger.
• Click the browse button, , and the Select Location dialog box appears (see
page 1191). Locate and select the point you need.
3. In the left pane, check one or more boxes indicating the type of events that can
trigger an action.
Each checked box displays the available events/alarms for that type in the right
pane.
4. In the right pane, check the box of each event/alarm you want to serve as a trigger.
To select all the events/alarms listed, click the Select All button. To deselect all
checked events/alarms listed in this pane, click the Deselect All button.
5. Click the Action tab.
The Action page appears.
6. Fill out this page as required to indicate what the actions/events designated on the
Trigger page will cause.
7. When you're finished, click OK.
The Trigger Action Summary reappears with the designated trigger action displayed in
the window.

1188
 MAN006-0612

Editing Triggers and Actions

To edit an existing trigger action:
1. At the Trigger Action Summary screen, click to highlight the trigger action you want
to edit.
2. Click the Edit... button.
The Edit Trigger Action screen appears like this example:

As you can see, the trigger page is an abbreviated version of the Add Trigger Action
screen. The action page is identical to the Add Trigger Action screen.
3. Make changes to the Trigger page as required.
4. Click the Action tab.
The Action page appears.
5. Make changes to the Action page as required.
6. When you're finished, click OK.
The Trigger Action Summary reappears with the designated trigger action displayed in
the window.

Deleting Triggers and Actions

To delete an existing trigger action:
1. At the Trigger Action Summary screen, click to highlight the trigger action you want
to delete.
2. Click the Delete button.
A prompt appears asking you to confirm the deletion.
3. Click Yes.
The Trigger Action Summary reappears. The designated trigger action no longer
appears.

Add Trigger Action Screen

This screen is divided into two tabbed pages.
 Trigger page (page 1190)
 Action page (page 1191)

1189
Velocity Version 3.1 Administrator’s Guide

Trigger Page
The trigger page specifies the events and/or alarms that will trigger an action.

The windows and fields on this page include:

Location The point defined as the trigger. To locate this point:

1. Click the Add... button to the right of the combo box.
The Select Locations screen appears (see page 1191).
2. From the system tree, expand to identify the point (reader,
door, expansion input, etc.) you want to use as the trigger.
This can be any device in the system tree.
3. Double click your selected trigger point.
The selected point appears in the Location pane.
4. Repeat Steps 2 - 3 to identify more trigger points.
5. Once you have selected the trigger points you require, click
Close.
The newly selected trigger appears in the Location pane.

Add... Click this button to bring up the Select Locations screen (see
page 1191).

Delete Click this button to delete a point location currently selected in

the Location pane.

Alarm/Event The types of alarms and events available for triggering.

Type window There are seven event types to choose from. You can select
more than one type at a time. Each type you check increases
the number of specific events appearing in the Alarm/Event
window.

1190
 MAN006-0612

Alarm/Event Displays a list of all events of the types selected in the

window Alarm/Event Type window. These events are sorted by Type,
Event Number, and Description.
You can re-sort these events by columns, as required. For more
on this, refer to “Column Management” on page 34.

Select All Click this button to select all the events currently listed in the
Alarm/Event window.

Deselect All Click this button to deselect all the events currently selected in
the Alarm/Event window.

Select Locations Page

When you click the Add... button on the Trigger Action Manager trigger page (see page
1190), a screen like this example appears:

The main window displays a list of the currently defined devices for this Velocity
system.
To select one or more devices to serve as trigger(s):
1. Expand the system tree in the window until you locate the point you want to use
as a trigger.
2. Select the point (door, input, relay, etc.) defined as the trigger.
3. Double click the point.
The point with its path appears in the Location pane on the Trigger Action Manager
trigger page. The location is expressed in the standard Velocity address format.
4. Repeat Steps 1 - 3 for each point you want to add.
5. When you're finished, click Close.

Action Page
The action page specifies the actions that are triggered when the events specified on
the trigger page occur.
The Device Type pick list at the top of the page determines the rest of the fields that
will appear.

Device Type: Select the device where the action occurs. CCTV and DVR are
available as options.

1191
Velocity Version 3.1 Administrator’s Guide

If you select CCTV, a screen like this example appears.

The fields on this page include:

Switcher: Select the Switcher to which this CCTV device is connected.

Only those switchers currently defined by this system appear in
the dropdown list.

Action: Select the action that this device can perform given the
specified trigger. The switcher can perform these actions:
• Call Camera to Monitor — indicates the CCTV camera
(connected to this switcher) that should appear on the
attached monitor(s). This enables the operator to direct a
camera's output to any monitor to which the switcher is
connected. The monitor receiving the camera's output is
specified in the 'Monitor' field. For information on how you
can place this action onto a map, refer to Badge Designer -
CCTV Call Camera to Monitor.
• Trigger Alarm on Switcher — issues an alarm at the switcher.
The type of alarm issued is specified in the 'Alarm' field.
• ACK Alarm on Switcher — issues an acknowledgement alarm
at the switcher.

Camera: If you selected the action Call to Monitor, specify the camera
output to be viewed on the selected monitor in this field.
To choose the camera, either select a camera from the
drop-down option list or enter it directly. Only those cameras
currently defined and connected to this switcher are valid
choices.

Monitor: If you selected the action Call to Monitor, specify the monitor
that will display the camera output designated in the 'Camera'
field.
To choose the monitor, either select a monitor from the
drop-down option list or enter it directly. Only those monitors
currently defined and connected to this switcher are valid
choices.

1192
 MAN006-0612

Preset: If you selected the action Call to Monitor, you can select a
preset routine for the camera specified in the 'Camera' field.
Both the 'Camera' field and the 'Monitor' field must be
specified.
To choose a preset, either select a preset from the drop-down
option list or enter it directly. Only those presets currently
defined for this switcher and assigned to a camera are valid
choices.
For more on defining presets, refer to “Using Presets” on page
669.

Display Viewer Check this box to indicate that if this action is triggered, Velocity
associated automatically opens the CCTV Viewer (if it isn't already open)
with monitor and displays the specified camera's output. This means that
both the dedicated monitor at the workstation and CCTV
Viewer are showing the same images. For more on the CCTV
Viewer, refer to “CCTV Viewer” on page 671.
If this box is left unchecked, only the monitor displays the
image.
The camera displayed in the viewer depends on switches
made either manually or automatically.

If you select DVR, a screen like this example appears.

The windows and fields on this page include:

Trigger Alarm on DVR

DVR: Select the DVR or NVR where the action occurs.

Only those DVRs or NVRs previously defined for this system
appear in this list. For more on this, refer to “Configuring the
DVR/NVR” on page 719.

Camera: Select the camera attached to the designated DVR you want to
record this action.
Only those cameras associated with the specified DVR/NVR
appear in this list.

1193
Velocity Version 3.1 Administrator’s Guide

Preset From the drop-down pick list, select the camera pattern or
camera quick view you want shown when the trigger associated
with this action occurs.
Only those camera patterns and camera quick views that a
qualified operator has previously defined for this camera can
appear in this list. For more on this, refer to “Camera Quick
Views” on page 750.

Alarm Enter the number of seconds that this alarm action lasts. This is
Duration effectively the length of time the designated camera must
record video to the DVR.

Optionally Launches Video Explorer and specifies the View Group in which
launch the this camera preset can appear.
Video Note: If a camera is triggered and the operator on duty is not a
Explorer... member of a role that has access to this View Group, then no
video appears.
Only those View Groups a qualified operator has previously
defined for the Video Explorer can appear in this list. If the
<None> option appears, this indicates that you want the
native DVR Live View Viewer to shown the video when the
specified camera view or pattern triggers.
The default is <None>.
Even if the Video Explorer is enabled for triggering, it does not
necessarily mean that the operator has the necessary role
permissions to view a specific view group. This table shows
how these two factors are interrelated:

Role Console Expected

Permission Preference Action

No Yes No video

Yes Yes Video

No No No video

Yes No No video

The role permission in this table refers to permission granted to

view a specific video group. The console preference refers to
whether Video Explorer has been enabled for triggering in
Console Preferences.
If a non-admin operator has permission to some view groups
but not the specific group triggered, the Video Explorer will
open but no video will be displayed. All permissions must be
selected in order to view the video from Video Explorer. In
addition, to view the video explorer group, the operator must
have application permissions for 'DVR Unit - View' and 'Velocity
- Video Explorer'.

1194
 MAN006-0612

Execute From the drop-down list, select an existing command set that is
command set triggered when the specified action occurs. In particular, the
Bosch DVR requires a command set in order to make the
trigger action work.
Only those command sets previously defined for the system
appear in this list. For more information on this, refer to
“Command Sets” on page 216.

1195
Velocity Version 3.1 Administrator’s Guide

1196
 MAN006-0612

Troubleshooting
This chapter provides quick answers to many questions you might have while using
Velocity.
This chapter is divided into these sections:
 Basic Troubleshooting (page 1198)
 System Report Wizard (page 1201)
 How Do I... (page 1203)
 Frequently Asked Questions (page 1208)
 Technical Support (page 1213)

1197
Velocity Version 3.1 Administrator’s Guide

Basic Troubleshooting
Q. When I open Velocity help, I can't see the sequence or glossary pane. What's wrong?
A. Probably, the .dll responsible for enabling these two windows is not installed
properly. This should be installed automatically when the program is installed, however
if you experience a problem, try this:
1. Copy the included file HHActiveX.DLL into the Windows\System directory on
your Velocity server's C: drive.
2. Click the Windows Start > Run.
The Run dialog box appears.
3. Type the following:
regsvr32 hhactivex.dll
4. Click OK.

Q: I tried to get my Velocity client to talk to my Velocity server according to the

instructions in the Velocity Installation Guide but it doesn't seem to be working. What's
wrong?
A: This problem can arise from one of many problems, including:
1. Make sure the domain account used for installation is a local administrator and a
member of the Velocity Users Windows user group on the Velocity Server.
2. Make sure the Velocity Server is powered on and the Velocity/SQL services are
running.
3. Check to see if your network cable is connected and you can see the Velocity
Server by browsing the network.
4. Verify that your Windows account has the appropriate Operator permissions for the
Velocity Client in question.
Try each of these solutions in turn, then retest to see whether the server is now
available.
Q: Event viewer is displaying incorrect base relay events for one of my controllers.
What's going on?
A: Could be that you have designated the wrong controller type for the controller
generating those events. Check your general properties page for the controller to make
sure you selected the correct controller type.
Q: When I try to print a report that has been scheduled through the Scheduling Agent,
it does not print. What am I doing wrong?
A: Sounds like your Velocity installer didn't register the VelocityServices account to use
the printer you've specified. To resolve this problem, refer to “Report Printing
Configuration” on page 1053. This should enable you to set up the required printer on
the VelocityServices account.
Q: I'm having trouble with my USB hub attached-ScanShell scanner. It's not responding
properly. What's wrong?
A: If you are experiencing problems with your attached scanner, the trouble may be
insufficient power to the device. Make sure you're USB hub is powered. If it isn't,
connect a separate power line to your scanner or get a powered USB hub.

1198 Basic Troubleshooting

 MAN006-0612

Q: Is there any way to find out which time zones are being used and therefore should
be downloaded to a controller?
A: Generate a time zone usage report using Report Manager.

Q: While using the back arrow in Learning Center, I get this message:
Error: can't move focus to the control because it its
invisible, not enabled, or of a type that does not accept the
focus. Code: 0. Do you want to continue running scripts on
this page? Yes No
A: Simply click Yes and the page requested appears.

Q: I tried to get my Velocity client to talk to my Velocity server according to the

instructions in the Velocity Installation Guide but it doesn't seem to be working. What's
wrong?
A: This problem can arise from one of many problems, including:
1. Make sure the domain account used for installation is a local administrator and a
member of the Velocity Users Windows user group on the Velocity Server.
2. Make sure the Velocity Server is powered on and the Velocity/ SQL services are
running.
3. Check to see if your network cable is connected and you can see the Velocity
Server by browsing the network.
4. Verify that your Windows account has the appropriate Operator permissions for the
Velocity Client in question.
Try each of these solutions in turn, then retest to see whether the server is now
available.

Q: Is there any way to find out which time zones are being used and therefore should
be downloaded to a controller?
A: Generate a time zone usage report using Report Manager. For more on this, refer to
“Creating a Report” on page 1011.

Q: I'm getting a lot of timeout messages in Event Viewer. What can I do about it?
A: Try changing the Total timeout constant value in the Advanced Settings dialog box for
the port that is giving you problems. Usually by tweaking the 50 ms default either up or
down you can effect the timeout messages you're getting.

Q: The Client has lost network connection to the server. What now?
A: When you unplug the network (Ethernet) cable, you get the message 'Loss of
Connection.' This message or variations on it can also appear when the network
connection is lost for some other reason. A good place to begin troubleshooting is this:
1. Plug the cable back in.
2. Click on Attempt to Reestablish Connection.
The screen changes and it appears that Velocity is closing windows preliminary to
closing down. Sometimes it looks like it has reestablished connection, but the first time
you select something like DIGI*TRAC Configuration, the screen starts closing windows
and appears to close Velocity.

Basic Troubleshooting 1199

Velocity Version 3.1 Administrator’s Guide

In either case, the best approach is to close Velocity then restart it. This should
reestablish communications.

Q. Connecting the panel to the system causes the message “X-Box Command 5
Complete” to appear in the Event Viewer. There is no XBox connected to the system.
A. This is expected in a Velocity system. ALL systems run over XNet, either true XNet or
via our Virtual XNet interface for polling controllers. This is a change from the previous
systems but will be overlooked in time. There is no detriment to the performance, only
a few more messages when a controller logs on the first time.

Q. I am getting an error in Event Viewer when I try to configure the second controller
accessed through a dialup location. What's wrong?
A. Ignore this message. Your modem is connected to a dialup location with more than
one controller on it. Whichever controller is not Address 0 reports that the CCM is
unrecognized when you register the address 1 CCM. Velocity recognizes additional
controllers.
Q: My wireless tablet PC running Velocity disconnects unexpectedly. How can I fix this
problem?
A: Wireless tablet PCs timeouts can spike to 2000ms. To avoid this problem, go to the
Registry on your tablet PC and locate HKEY_LOCAL_MACHINE>SOFTWARE>Hirsch
Electronics>Velocity>Client>Checkpoint. Change the value you find there from 5000
to something higher. We suggest 50000.
Q: What happened to My Velocity?
A: Velocity 3.0 and later made the My Velocity module obsolete through the use of
Roles. By restricting most operators to only specific tasks, the interface can be
customized to fit whatever view is desired.
Q: When I open Enrollment Manager, I keep getting an error message that says “The
scanner is not connect to the PC.” What does this mean?
A: You have configured Enrollment Manager for use with a scanner or PIV, but have not
yet specified a legitimate port through which the scanner can communicate with the
Velocity workstation. You can still use Enrollment Manager, but you won't be able to use
the scanning feature until the scanner's port is properly configured.
Q: When I open Customization Manager, I only see two items under the Components
folder. What does this mean?
A: You've just installed a new version of Velocity and have not yet checked the 'Access
and Enable Customized Values for Components in Customization Manager' box on the
General page of Velocity Preferences. Once this is done, each module you open is
automatically registered in Customization Manager and is displayed in the Components
folder.
Q: After restoring my 2003 server database on a SQL 2008 server, the All Events Log
by Date report in Report Manager will not open. What's the problem?
A: This is a known issue and can be easily resolved. Simply delete or rename the
Velocity LDF files from the Microsoft SQL Server/MSSQL/data subdirectory. The
appropriate LDF files will be regenerated and the report should open without difficulty.

1200 Basic Troubleshooting

 MAN006-0612

System Report Wizard

Use this wizard to create a report about the entire Velocity system. Once this report is
generated, you can E-mail it to Hirsch Electronics for further evaluation.
Velocity administrators should generate this report when a problem arises with Velocity
that cannot be handled locally. Hirsch Electronic's Quality Control and Support staff can
usually solve a problem after consulting this report.
To create a system report:
1. From the Help option bar, select Create System Report.
The Velocity System Report wizard appears:

2. Click Next.
The Input Information screen appears like this example:

3. Fill out the form, including your name and the name of your company.
Describe the problem in detail in the ‘Description’ text box.
4. Click Next.

System Report Wizard 1201

Velocity Version 3.1 Administrator’s Guide

The Verify file creation page like this example:

By default, both the Include all Velocity Log and Debug files and Include Windows
System Information boxes should remain checked.
5. Click Next.
The Finish sheet appears.

6. Click Finish.
The file, SystemReport xxxx-xx-x-xx-yy-yy.zip, is written to the Program Files\Hirsch
Electronics\Velocity directory. The xxxx-xx-xx suffix fields specify the date
(year-month-day) and the yy-yy fields represent a serial number.
Attach or copy this file to an E-mail message and send it to either
[email protected] or an address provided by your Hirsch Electronics
provider.

1202 System Report Wizard

 MAN006-0612

How Do I...
Perform Basic Velocity Functions

Task See:

Start Velocity page 3

Exiting Velocity page 5

Dock, Float or use Normal (Child) Windows page 33

Use a Mouse (Right Click and Left Click Conventions) page 29

Navigate (Find my Way In) Velocity page 29

Velocity Configuration Flowchart page 53

Create a Velocity System

Task See:

Add/Configure a Controller (panel or system) page 72

Add/Configure a Port page 60

Add/Configure an XBox page 205

Add/Configure a Control Zone page 110

Add/Configure Time Zones page 314

Add Holidays page 330

Add Operators page 275

Add Doors page 145

Add a Reader page 195

Add Door Groups page 257

Add Inputs (Alarms) page 178

Add Relays (Outputs) page 167

Add Roles page 287

Disable a Relay during a Time Zone page 170

Actuate a Relay during a Time Zone page 169

Enable an RQE page 162

Find out who's inside a passback area page 1215

Import SAM database files to Velocity page 384

Issue DIGI*TRAC Commands page 216

How Do I... 1203

Velocity Version 3.1 Administrator’s Guide

Task See:

Program my system for:

• Control Zones page 110

• ACBs page 128

• Occupancy Controls page 106

• Timers page 213

Specify a type of line module (DTLM or MELM) page 179

Create a Badge or Backdrop

Task See:

Set up a Badge Printer page 439

Create (Design) a Badge Template page 494

Preview Badges page 492

Create Backdrops (Maps) page 497

Print Badges/Backdrops page 493

Create maps page 497

Create placeable objects page 619

Import maps and drawings page 501

Make placeable objects smart page 623

Place icons on a map page 605

Link related maps page 604

Enroll People

Task See:

Enroll a Person (Badgeholder or Cardholder) page 800

Assign a Badge or Code to an Enrolled Person page 804

Create a Credential page 864

Create a Credential Template page 228

Disable a Credential (Card, or Code) page 807

Find a Person (Badgeholder or Cardholder) page 809

Find a Credential (Card or Code) page 813

1204 How Do I...

 MAN006-0612

Task See:

Define/Configure/Change User-Defined Fields page 778

Take/Acquire/Import a Photo page 835

Take/Acquire/Import a Signature page 833

Forgive passback page 891

Override code tamper page 889

Reset limit count page 889

Force download page 889

Restrict Operators/Roles

Task See:

Assign Rights and Permissions page 287

Control the Alarm Viewer

Task See:

Acknowledge an Alarm page 424

Acknowledge All Alarms page 424

View Alarms within the Map page 429

Add Operator Notes page 426

Clear (Delete) an Alarm from Alarm Viewer page 425

Clear (Delete) all Alarms from Alarm Viewer page 425

Modify the Alarm Viewer page 419

Use Report Manager

Task See:

Generate a Report page 1011

Customize an Existing Report page 1018

Schedule report printing page 1087

Create Report Groups page 1037

How Do I... 1205

Velocity Version 3.1 Administrator’s Guide

Use Status Viewer

Task See:

Use Status Viewer page 1181

Create a Status Groups page 1183

CCTV

Task See:

Define my CCTV System page 659

Control/Configure my CCTV Switcher page 664

Control/Configure my CCTV Cameras page 667

View CCTV page 671

Control my Camera (Pan-Tilt, Zoom, Focus, Iris, Auto-Pan etc.) page 674

Backup, Archive, and Download

Task See:

Backup the Velocity Database to my hard drive page 1086

Restore my Velocity Database page 1102

Archive my Alarm and Event Logs page 1077

Download Controller & Time Zone Information page 75

Update CCM Firmware page 712

Update SNIB2 Firmware page 715

Schedule Useful Tasks

Task See:

Activate or Deactivate Credentials page 1077

Archive Alarm/Event Logs page 1077

Back Up SQL Database page 1086

Dial Remote DIGI*TRAC Network page 1078

Execute Command Sets page 1080

Execute Programs page 1081

Export Data page 1083

1206 How Do I...

 MAN006-0612

Task See:

Import Data page 1084

Print Reports page 1087

Synchronize Controller Clocks page 1090

Customize Velocity

Task See:

Setup/Configure my screens, viewers, dialog boxes and page 678

windows

Convert Velocity Fields to another Language page 699

Export/Import Velocity Customized GUI Changes to/from page 700

another Velocity PC

Changing Text in Velocity fields page 678

How Do I... 1207

Velocity Version 3.1 Administrator’s Guide

Frequently Asked Questions

What version of Windows do I need?
If you are installing Velocity for use as a domain server, use Windows 2000 Server. If
you are installing Velocity as a standalone workstation or client, use either Windows
2000 Pro or Windows XP Pro.
While you can upgrade from earlier versions of Windows to any of these current
platforms, we advise you to perform a clean install. This avoids all kinds of problems
that can arise when you upgrade an existing system.
Will any Windows configuration work with Velocity?
Presently, only Windows 2000 and Windows XP Pro work with Velocity. You should
never try to run Velocity with less than the recommended minimum requirements as
set down in the Velocity Installation Guide.
Windows 2000 and Windows XP Pro run best with a lot of memory: the more the
better. While the minimum is 64 MB of RAM, Windows and Velocity will run more
smoothly with 128 MB or even 256 MB of RAM.
Where do I start?
Once you've installed Velocity, start Velocity, then define your system.
Use the worksheets to aid you in specifying initial settings. Follow the flowcharts as
needed. Use the examples to help familiarize yourself with many Velocity functions.
What is a Time Zone?
Time zones are used to specify time durations for specific activities.
Time zones are used for defining control zones, door groups, alarm actions, relays,
inputs, and readers.
What is a Control Zone?
A control zone is a combination of relays or functions, a trigger mechanism, and a time
zone. Use control zones to define when specific relays are actuated, disabled, triggered,
or retriggered. Control zones can be associated with bundled doors (alarms and
relays), unbundled alarms and unbundled relays.
In addition, control zones are also used to define code extensions within Function
Groups.
What replaces an Access Zone in Velocity?
In standard DIGI*TRAC terminology, an access zone determines When and Where
access is granted and denied. It consists of one or more time zones and a set of valid
doors.
This function is replaced in Velocity by credentials that define specific door groups used
at specific time zones.
What are Velocity services?
Services are the tasks that run in the background while Velocity runs in the foreground.
You usually are not aware of these services (like DIGI*TRAC Network Service or CCTV
Service) unless you need to stop them (or start them again) using the Service Control
Manager.
There are other services that support Velocity which run under the Windows services.
These are available to you through Start > Settings > Control Panel > Services.

1208 Frequently Asked Questions

 MAN006-0612

How does Velocity work with controllers in different time zones?

Velocity can support controller running in several different time zones. In order to
synchronize them, you should periodically run a special task called Synchronize
Controller Clocks available through the Task Scheduler. This does not set all controller
clocks in your Velocity network to the same time zone, but synchronizes your minutes
and seconds while recognizing the time zone in which the controller resides. Time
stamps issued for each event and alarm are provided with the correct time zone.
What is the difference in Velocity between a User, Person, and Credential?
The term Person has been substituted for a User (an employee, consultant, contractor,
part timer, etc.) in Velocity terminology. The Person represents the physical person who
is employed by the company.
A Credential is a card or code or card/code issued to a person. Each person can be
assigned one or more credentials. For example, Joe Smith might be assigned a PIN
code for one building and a card with a magstripe for another building. Each is a
credential with its own permissions and conditions.
What is the Windows Local Administrator?
A local administrator is an administrator restricted to a single computer. On that one
machine, he/she is the installer, authorizer, authenticator, and final word on any issue
having to do with that machine, such as passing out passwords, assigning rights and
privileges to other users, and so on.
If, however, the computer is networked, the local administrator cannot exceed his
sphere of influence beyond the one machine. A higher authority, the network
administrator, controls the way in which everyone on the network, including all the local
administrators on all the client machines, uses the network.
What is a Domain Controller?
The domain controller is the computer that monitors and controls the domain for a
computer network (either LAN or WAN). The person who oversees this computer is
termed the domain administrator.
What are the parameters of PIN codes?
A PIN is the Personal Identification Number assigned to a credential (which is, in turn,
assigned to a person).
The maximum length of an assigned PIN code is determined by the Code Length in
the Credential dialog box up to a length of 15 digits. The maximum length of an
automatically generated PIN is determined by the AutoGen Code Length up to a
maximum of 8 digits.
What is a Bundled Door?
In its default state, Velocity bundles each entry reader with a relay and an input to make
a door. The bundled door can be modified to include an exit reader as well.
Each door is comprised of one relay, one input, and one reader (assumed to be the
entry reader).
When required, however, Velocity also enables operators to unbundle a door, releasing
the relay, input, and reader for other purposes.
How do I install Velocity on a company network?

Frequently Asked Questions 1209

Velocity Version 3.1 Administrator’s Guide

There are many strategies for installing Velocity on a company network. We

recommend a dedicated client/server network, using the Velocity PC as the server.
Other networked machines can then be set up as clients of the Velocity server and
used as Velocity workstations.
How many controllers can I have on a Port?
One port can support up to 63 controllers by using a combination of XBoxes and
NET*MUX4 multiplexors. With the addition of more ports, additional controllers can be
added, as required.
Can I use USB ports instead of COM ports?
Velocity does support USB. It enables you to create more connections between your
computer and attached XBoxes, since you are no longer limited to the one or two COM
ports generally included with computers and eliminates the need for the inclusion of
DigiBoards or other serial port multipliers. Using USB hubs, a single USB connection
can connect up to 127 XBoxes.
Connections between USB hubs/ports and XBoxes require USB-to-RS232 adapters.
These adapters are manufactured by many companies including Belkin and are
available through most electronic supply stores including Radio Shack.
How many DIGI*TRAC controllers can you connect to a single XBox?
No more than 16 controllers can connect to a single XBox due to alarm latency and
general event response time.
The XBox polls each controller approximately each 1/16th second. If there are more
than 16 controllers, there is the possibility that a controller is polled less than every
second which is unacceptably slow.
What about using a NET*MUX?
We recommend no more than 16 controllers, total, going to a single XBox. You can
spread it out with 4 controllers each on 4 different NET*MUX ports, if that's what's
needed for the installation, but make sure that you don't overload the XBox's
data-handling capacity.
Are there any IRQ or memory conflicts with having too many Ports?
Yes, there can be.
Most newer computers come with extra ports to which peripherals -- such as printers,
modems and the Hirsch XBox -- can be attached. However, there can be a problem if
two devices attempt to grab the attention of the CPU at the same time, leading to an
IRQ conflict. In general, it's best to let your system's Plug and Play feature detect the
device for you. If your system cannot detect the device, make sure the device is
assigned its own IRQ.
Modern buses allow sharing of IRQs and memory. In fact, several devices can often use
the same IRQ without adverse effects so long as the devices are not memory intensive,
like hard drives and video cards. Make sure that memory-intensive devices are assigned
their own IRQs.
Another way to increase available connections is to use USB ports. Many USB devices
can share a single IRQ. The rule of thumb is to always check the IRQ settings when
new devices are installed.
Why can't I see any other computers on the network?
You can only see other computers on a network when:

1210 Frequently Asked Questions

 MAN006-0612

 Your computer is networked.

 The system administrator has allowed your computer access to other machines on
the network.
 Other machines have been configured to allow sharing of resources.
If all of these conditions are not met, then your computer cannot see any other
computers.
What is the difference in Velocity between Permissions and Rights?
Rights and Permissions are both rules enabling a user/operator to gain access to
processes, modules, or pages.
 Permissions are those privileges assigned to Operators.
 Rights are privileges assigned to Roles.
What are the recommended steps I should follow to migrate from the SAM
database to the Velocity database?
The recommended migration path is:
1. Buy and configure a new computer dedicated to Velocity.
2. Transfer (copy) required user database files from the SAM computer to the Velocity
computer. Create a new directory for these files, such as \SAM user files.
3. Once on the Velocity computer, use the SAM Database File Import Wizard to
transform the SAM database files into a form Velocity can read and incorporate.
4. Enter Velocity and create the required controller definitions.
5. Upload definitions from each controller using the Load Setups from Controller
radio button in the Add New Controller dialog box.
This does not supply the names for each relay, input, and reader connected to the
controller. Go to Step 6.
6. Customize the settings for each controller using the controller dialog box.
How do I create and use maps in Velocity?
Velocity includes the Graphics module that enables a qualified operator to:
 import graphics, including maps and blueprints, from other sources
 arrange these graphics in a hierarchical order
 link the maps to allow drill down or drill up access
 place icons on each map that represent alarm points in the system
Once this is done, a qualified operator can:
 monitor icons on the maps
 perform selected operator functions
 control icon points that appear on the maps
How do I back up my Velocity database?
Backing up the database is accomplished through the Task Scheduler. There are two
distinct backup routines:
 back up the entire Velocity database
 Back up only the alarm and event logs
You can also export portions of the database to a convenient location using the Task
Scheduler - Export Data procedure.

Frequently Asked Questions 1211

Velocity Version 3.1 Administrator’s Guide

An optional method for doing this employs the SQL Database Manager (see “Backing
Up the Velocity Database” on page 1096). While this second method exists, we
recommend that you use the Task Scheduler—it's both easier and safer.
For more on using the Task Scheduler backup, refer to “Backup Velocity Database” on
page 1086.
How do I restore my Velocity database?
There are two ways to restore Velocity data:
 Import a previously exported Velocity database using the Task Scheduler.
• For instructions on exporting a Velocity database, refer to “Backup Velocity
Database” on page 1086.
• For instructions on importing a previously exported Velocity database, refer to
“Importing Data” on page 1084.
This method is the recommended technique.
 Employ the SQL Database Manager restore function (see “Restoring the Velocity
Database” on page 1102).

1212 Frequently Asked Questions

 MAN006-0612

Technical Support
Here are the important numbers you need to know for contacting Hirsch Electronics:

Mail: Hirsch Electronics

900 East Carnegie Avenue
Building B
Santa Ana, CA 92705-5520
Attn: Technical Services

Voice: (877) HIRSCHX (technical queue)

(949) 283-0881 (emergency after-hours support)
(888) 809-8880 (general Hirsch number)

Fax: (949) 250-7362

E-mail: [email protected]

Web: www.hirschelectronics.com

Whenever you call your local dealer or Hirsch, be sure to have your registration
material, serial number and software version number available.
For future reference, print this page and record these numbers:
Serial Number: _________________________________
Version Number: ________________________________
Dealer: ________________________________________
Dealer Phone #: ________________________________
CCM Rev/Version #: _____________________________

Technical Support 1213

Velocity Version 3.1 Administrator’s Guide

1214 Technical Support

 MAN006-0612

Who’s Inside
When an emergency occurs in an area or building, you need to know immediately who
is inside the area.
To enable this feature and define each area—passback zone —you need to oversee, use
the following technique:
 Designate each passback zone you need.
 Enable all defined passback zones for each controller overseeing those zones.
Once you have defined the required passback zones and enabled them for the
relevant controllers, you can immediately generate a report showing who is inside
using this technique.
 You do not need to define passback zones in order to use this feature; it
only gives you a better sense of exactly where they are within the
security system. If passback zones are not defined, then credentials are
still displayed here. All credentials used at a defined reader are listed
here within Everyone and Zone 00 - Unknown, with information on the
reader that recorded the last credential use, the time it was recorded,
and other relevant information.

1215
Velocity Version 2.6 Administrator’s Guide

How To Use Who’s Inside

To use Who’s Inside:
1. Open Who's Inside in one of these ways:
• With the Configuration folder highlighted in the System Tree pane, double click
the option in the Components pane.
• From the menu bar, select Console > Who's Inside.
• From the icon bar, click the Who's Inside icon, .
The Who's Inside screen appears. For more on this, refer to “Who's Inside Screen”
on page 1217.
2. Review the current situation as required.
Identify all those people still located inside the affected area. Determine how many
of the people Velocity shows as being inside the affected zone are actually at the
mustering station.
3. Customize the screen view using the following icons:

Click this
To:
icon:

Toggle between hiding all zones that are currently empty and
showing all zones. When you hide empty zones, you simplify the
screen, making it easier to see and manage.

Refresh this screen. All controllers are queried as to their current

status and the most recent status of each zone is returned.

Display an HTML rendition of this information for printing or

E-mailing.

4. Reassign those people who were inside the affected area and are now at the
mustering station.
For more on this, refer to “Who's Inside: Reassigning Credentials to Another Zone”
on page 1220.
5. Forgive user credentials as required.
If you need to temporarily halt polling on a busy screen, click the red button on the
Who’s Inside icon bar. You can restart polling by clicking the green button. For more
on this, refer to “Who's Inside: Forgiving Credentials” on page 1219.
6. Identify credential properties as required in this way:
a. Right click on one or more people in the right pane.
b. Select Display Credential.
The badge template for the specified credential appears. For more on this feature,
refer to “Display Credential Information” on page 889.
7. When you're finished, exit the screen.

Alternative Method:
An alternative method is available using the Diagnostic window. This method has none
of the flexibility of the Who's Inside module, but can be useful as a diagnostic tool.
1. Open the Diagnostics window.
2. In the 'Controller' combo box, select the controller connected to the affected zone.

1216 How To Use Who’s Inside

 MAN006-0612

3. Turn the Diagnostic Stream ON.

The message 'Diagnostic stream is ON' appears in the upper window.
4. In the 'DIGI*TRAC Commands' field, type this command:
34*9*0*[capacity]
where [capacity] = the number of people allowed inside. Then press Enter.
5. Click the ellipsis button to the right, , to execute this command.
The message “Sending Host issued DigiTrac commands: 34*9*0*999” appears in
the upper window. The results of this command are displayed in the lower
window.
6. Generate and print a report based on this information.
A report can also be generated in the Report Manager using the Person Information
folder’s Who is Inside Where report.
For more on generating reports, refer to “Creating a Report” on page 1011.
For more on the Diagnostic Window, refer to “Diagnostic Window,” starting on page
703.

Who's Inside Screen

The Who's Inside screen looks like this example:

It includes the following icons:

Click this icon to hide all zones in the Zone Tree pane that have no
people inside. This simplifies the screen.

Click this icon to refresh the screen. Current controller information is

uploaded to Velocity. This keeps this screen absolutely current -- a
necessity during emergencies.

How To Use Who’s Inside 1217

Velocity Version 2.6 Administrator’s Guide

Click this icon to generate an HTML page showing the latest Who's
Inside information. This page is displayed on the default web browser
(e.g. MS Internet Explorer or Mozilla). The web page looks like this
example:

You can print (Ctrl + P) or E-mail this page (File > Send > Page by
E-mail...) as required.

This icon is both a status indicator and a button. As a status indicator,

green indicates that the Who's Inside feature is spooling and refreshing
normally; when the indicator turns red, it indicates that the feature is not
refreshing, in most cases because the icon was clicked to pause this
function.
Click the green button to stop polling by the Who's Inside engine. (The
red button appears.) This halts the screen refresh which enables the
operator to focus on investigations of specific lines and problems. This is
particular useful when the screen is very busy and lines keep jumping
around in the window as new information flows in and the screen is
refreshed. Once the operator has finished investigating one or more
incidents, he can click the red button to resume refresh and polling.
(The green button reappears.)

Zone This left pane displays a list of all 65 available passback zones (Zone 00
Tree – Unknown and Zone 1 – Inside through Zone 63 – Inside), whether
pane these zones have been set up for the system or not. The Everyone zone
lists everyone currently recorded within the system. Click to highlight a
particular zone in this pane and all those persons who are currently
inside that zone appear in the right pane.
The columns in this pane include the zone name and the present
person count.

1218 How To Use Who’s Inside

 MAN006-0612

right This pane displays a list of all persons who are inside a selected zone.
pane The columns in this pane include:
Name – Name of the person assigned the credential.
ID – Number assigned to this credential.
Zone – The passback zone where this credential was last used. If no
passback zones are defined, then all credentials are shown as Zone 00
- Unknown.
Function – The IDF option assigned to this credential on the general
page of the credential properties.
Last Access Time – The date and time when this credential was last
used to request access at a defined reader.
Last Accessed Reader – The last reader, by door and reader number,
where this credential requested access.
Last Transaction Type – The result of the access attempt at the specified
reader: Granted or Denied.

This screen also supports the following right-click functions:

If you click on: And select this option: This occurs:

A zone in the left Forgive All Credentials in Zone All credentials displayed in the right pane
pane are forgiven, even those that the system
did not grant access to. For more on this,
refer to Who's Inside - Forgiving
Credentials.

One or more Forgive Selected Credentials All credentials associated with the
persons in the right selected people are forgiven, even those
pane that the system did not grant access to.
For more on this, refer to Who's Inside -
Forgiving Credentials.

One or more Display Credential The default display credential (as defined
persons in the right by Preferences) is displayed for the
pane selected people.

Who's Inside: Forgiving Credentials

During an emergency, people leave affected areas any way they can. Most of the time,
all doors are automatically unlocked, enabling people to leave as quickly as possible. In
other facilities, such as high-security installations, doors cannot be unlocked and people
must exit as quickly and expeditiously as allowed. Frequently, a few rules are broken in
the process, including passback violations such as tailgating. Occasionally, Velocity may
invalidate those credentials used for such a purpose.
Under such circumstances, it is up to the qualified operator to forgive these credentials,
in effect 'resetting' or overriding them, so that users don't have to go through the
reissue process.
There are two ways to forgive credentials from within Who's Inside.

How To Use Who’s Inside 1219

Velocity Version 2.6 Administrator’s Guide

To forgive selected credentials:

1. In the Who's Inside left pane, click to select the affected zone.
The persons who were inside this zone when the alarm went off appear in the
right pane.
2. In the right pane, click one or more of the persons whose credentials you want to
forgive.
3. Right click on the highlighted persons.
A list of options pops up.
4. Select Forgive Selected Credentials.
The selected persons' credentials are forgiven.
To forgive every credential inside the affected:
1. In the Who's Inside left pane, right click the affected zone.
A list of options pops up.
2. Select Forgive all credentials in Zone.
All persons' credentials inside this zone are forgiven.

Who's Inside: Reassigning Credentials to Another Zone

Using Who's Inside, a qualified operator can manually move a credentialed person
from an affected zone to a safe zone.
This is particularly useful for mustering a large group of people from one area to
another. During an emergency, most readers and doors are opened automatically,
allowing free movement from the affected area into a safe area. Once users exit a
problem area, they normally muster in an area where they can be identified and
accounted for by an operator. Since users normally do not have to use a credential to
exit an area during an emergency, Velocity will continue to show them as present in the
zone until they are manually removed from it. This process tells the program that the
user has successfully left the affected area.
To move a person to another zone:
1. From the left Who's Inside pane, click to select the affected zone.
All persons inside this zone appear in the right pane.
2. Identify all those persons at the mustering station who are identified in the right
pane as being inside the affected zone.
3. From the right pane, click to select those persons who have been identified at the
mustering station.
4. Drag those persons to the left pane and drop them into the zone identified as the
mustering station.
A message appears like this:

5. Click Yes to confirm your move.

Velocity now identifies the new position for the persons identified.

1220 How To Use Who’s Inside

 MAN006-0612

Worksheets
The following worksheets are available for your use:

General Information page 1224

Badge Template Design page 1225

Controllers

• M1N Controller page 1226

• M2 Controller page 1227

• M8 Controller page 1228

• M16 Controller page 1229

• MSP Controller page 1230

Time Zones & Holidays

• Standard Time Zones page 1 page 1231

• Standard Time Zones page 2 page 1232

• Master Time Zones page 1233

• Holiday page 1234

Door Groups

• page 1 page 1235

• page 2 page 1236

• Master Door Groups page 1237

Function Groups page 1238

Enrollment Manager

• for Momentary Access page 1239

• for Function Group page 1240

• General tab page 1241

• Additional tab page 1242

• Additional Images tab page 1243

Credential Templates

• General tab page 1245

• Function tab page 1 page 1246

1221
Velocity Version 3.1 Administrator’s Guide

• Function tab page 2 page 1247

• Function tab page 3 page 1248

• Function tab page 4 page 1249

• Limits and Options tabs page 1250

User-Defined Fields

• General tab page 1 page 1251

• General tab page 2 page 1252

• Additional tab page 1253

• Additional Images tab page 1254

Roles

• page 1 page 1255

• page 2 page 1256

• page 3 page 1257

• page 4 page 1258

• page 5 page 1259

• page 6 page 1260

• page 7 page 1261

• page 8 page 1262

• page 9 page 1263

• page 10 page 1264

• page 11 page 1265

• page 12 page 1266

• page 13 page 1267

• page 14 page 1268

• page 15 page 1269

• page 16 page 1270

• page 17 page 1271

• page 18 page 1272

• page 19 page 1273

• page 20 page 1274

• page 21 page 1275

1222
 MAN006-0612

Person Templates

General page 1276

TABs page 1277

Groups page 1278

Additional Images page 1279

Operators

• page 1 page 1280

• page 2 page 1281

Control Zones

• Standard Control Zones page 1282

• Master Control Zones page 1283

Simply select the page and print the worksheet as many times as you need. Fill the
sheets out as required and use them to program your system.

1223
Velocity Version 3.1 Administrator’s Guide

General Information

1224
 MAN006-0612

Badge Template Design

1225
Velocity Version 3.1 Administrator’s Guide

Model 1N Configuration

1226
 MAN006-0612

Model 2 Configuration

1227
Velocity Version 3.1 Administrator’s Guide

Model 8 Configuration

1228
 MAN006-0612

Model 16 Configuration

1229
Velocity Version 3.1 Administrator’s Guide

Model SP Configuration

1230
 MAN006-0612

Standard Time Zones page 1

1231
Velocity Version 3.1 Administrator’s Guide

Standard Time Zones page 2

1232
 MAN006-0612

Master Time Zones

1233
Velocity Version 3.1 Administrator’s Guide

Holidays

1234
 MAN006-0612

Door Groups page 1

1235
Velocity Version 3.1 Administrator’s Guide

Door Groups page 2

1236
 Master Door Groups Worksheet

Master Door Group Name Tag Alert

Door Groups Door Groups

Master Door Groups

Steps to Create Master Door Groups:

From Velocity Configuration: Select Door Groups > Select Add New Master Door Group >
Enter Name > Select Door Groups from right pane and click < button to add them to left pane
as needed > Select OK when finished

1237
MAN006-0612
Velocity Version 3.1 Administrator’s Guide

Function Groups

1238
 MAN006-0612

Enrollment Manager: Quick Worksheet

1239
Velocity Version 3.1 Administrator’s Guide

Enrollment Manager: Quick for Function Groups

1240
 MAN006-0612

Enrollment Manager: general tab

1241
Velocity Version 3.1 Administrator’s Guide

Enrollment Manager: page 3

1242
 MAN006-0612

Enrollment Manager: page 4

1243
Velocity Version 3.1 Administrator’s Guide

Enrollment Manager: page 5 (credential assignment)

1244
 MAN006-0612

Credential Templates General tab

1245
Velocity Version 3.1 Administrator’s Guide

Credential templates Function tab page 1

1246
 MAN006-0612

Credential templates Function tab page 2

1247
Velocity Version 3.1 Administrator’s Guide

Credential templates Function tab page 3

1248
 MAN006-0612

Credential templates Function tab page 4

1249
Velocity Version 3.1 Administrator’s Guide

Credential templates Limits and Options tab

1250
 MAN006-0612

User-Defined Fields General tab page 1

1251
Velocity Version 3.1 Administrator’s Guide

User-Defined Fields General page 2

1252
 MAN006-0612

User-Defined Field Addition tabs

1253
Velocity Version 3.1 Administrator’s Guide

User-Defined Fields Additional Images tab

1254
 MAN006-0612

Roles page 1

1255
Velocity Version 3.1 Administrator’s Guide

Roles page 2

1256
 MAN006-0612

Roles page 3

1257
Velocity Version 3.1 Administrator’s Guide

Roles page 4

1258
 MAN006-0612

Roles page 5

1259
Velocity Version 3.1 Administrator’s Guide

Roles page 6

1260
 MAN006-0612

Roles page 7

1261
Velocity Version 3.1 Administrator’s Guide

Roles page 8

1262
 MAN006-0612

Roles page 9

1263
Velocity Version 3.1 Administrator’s Guide

Roles page 10

1264
 MAN006-0612

Roles page 11

1265
Velocity Version 3.1 Administrator’s Guide

Roles page 12

1266
 MAN006-0612

Roles page 13

1267
Velocity Version 3.1 Administrator’s Guide

Roles page 14

1268
 MAN006-0612

Roles page 15

1269
Velocity Version 3.1 Administrator’s Guide

Roles page 16

1270
 MAN006-0612

Roles page 17

1271
Velocity Version 3.1 Administrator’s Guide

Roles page 18

1272
 MAN006-0612

Roles page 19

1273
Velocity Version 3.1 Administrator’s Guide

RolRoles page 20

1274
 MAN006-0612

Roles page 18Roles page 21

1275
Velocity Version 3.1 Administrator’s Guide

Person Templates (General)

1276
 MAN006-0612

Person Templates (TAB pages)

1277
Velocity Version 3.1 Administrator’s Guide

Person Templates (Groups)

1278
 MAN006-0612

Person Templates (Additional Images)

1279
Velocity Version 3.1 Administrator’s Guide

Operators page 1

1280
 MAN006-0612

Operators page 2

1281
Velocity Version 3.1 Administrator’s Guide

Standard Control Zone

1282
 MAN006-0612

Master Control Zones

1283
1284
Velocity Integrated Object Worksheet

Name of Object:

VO Type:
VIO Preparation
Velocity Version 3.1 Administrator’s Guide

Sketch Area

Cause Name Cause Type Cause Value Effect Name Effect Object Effect Action
 MAN006-0612

Index
Acknowledging an alarm 424
Symbols Acquire
% 817 files 840
photographs 835
Numerics TWAIN 838
2-person rule video capture 836
see Two-person rule Action page 1191
Activating credentials on specific dates 868
A Active directory
A/B rule 108
specifying 1079
AATL time 180 Actuate door relay in CZ 164
for expansion inputs 188
Actuate during time zone 169
report when unlocked for expansion inputs 188
expansion relays 174
AATL warning time 180 Actuate relay in control zone 164, 181
for expansion inputs 188
for expansion inputs 190
AATL when unlocked reporting 180
Actuate relays 249
Abort download 134 Add Ins
Absentee Limiting 237
manager 406
Absentee limiting 889
server extensions 412
assigning 237 Add new scanner 789
example 927 Add-In Manager 406
for credentials 871
External Application Launcher 407
Absentee rule 894
Remote Desktop 409
Absentee rules Tip of the Day 410
example 927
Adding controllers 72
ACBs
Adding ports 60
enable reporting 98 Add-ins 405–416
mappings 129
for roles 292
overview 128
options 23
print not at default example 983 Add-ins options 23
table of 129
Additional images 781
Accept access codes 199
Address format 422
Accept control codes 200 Administration main screen 7
Accept programming codes 199
design mode 15
Accept status requests 200
Administrators 280
Access and enable customized values for components in Cus- creating domain administrators 280
tomization Manager 45
Advanced event selection 351
Access codes
Advanced flowchart 54
accepting 199 Advanced options setup 94
Access functions 241
Advanced port settings 66
extended unlock 242
lease-line configuration considerations 66
momentary 242 Advanced report setups 97
relock 242
Advanced settings 1081
unlock 242
AES encryption 208
Access grants Alarm actions
report 200
changing 127
Access zones
configuring controllers for 124
what replaces in Velocity 1208 description 126
Account is disabled 278
types of 127
Account management
Alarm actions page 124
adding new account 373 Alarm cancel 250
adding new area 374
alarm cancel 250
adding new point 375
Alarm control blocks
Accounts see ACBs
add new alarm 373
Alarm functions 242
management 373
cancel entry delay 243
setting up fire alarm 373 condition unmask 244

1285
Velocity Version 3.1 Administrator’s Guide

example 920 display alarms most recento to oldest 50

mask/cancel entry delay 243 display alarms oldest to most recent 50
masking 242 displaying notes 427
momentary mask 242 force new note for multiple acknowledgement 49
partial unmask 245 Force new note for multiple clear 49
pre-arm status 244 general property sheet 431
start exit timer 243 get recorded DVR video 428
unmask/start exit timer 243 icon bar 420
unmasking 242 main screen 419
Alarm levels maximum alarms to display 431
customizing 698 modifying 430
Alarm queue placing on Velocity desktop 435
acknowledge alarms 466 playing DVR video 428
clearing alarms from 466 properties 431
icon tool bar 466 refresh alarms on 429
Alarm queue pane 465 repeat multimedia until acknowledged 49
Alarm queuing replay WAV file 428
display alarms most recent to oldest 50 require entry of note on clear 49
display alarms oldest to most recent 50 restore on new alarm 432
sort alarms by alarm level 49 sort alarms by alarm level 49
Alarm record rate 722 starting 418
Alarm Relay Timers 93 unacknowledged alarms pane 420
Alarm relay timers using 424
duress 93 viewing instructions for alarms 429
general 93 viewing maps for alarms 429
tamper 93 AlarmFlash property
trouble 94 assigning 645
Alarm systems Alarms
account setup for Velocity 373 acknowledged pane 421
add new account 373 acknowledging from alarm queue 466
alarm properties 376 archiving logs 1041
area setup for Velocity 374 attaching to WAV files 682, 691
configuring panels 366 cancel 250
configuring receivers 368 check secure 244
D6500 receiver 366 clearing 425
illustration of a system 365 clearing all 425
introduction 365 clearing from alarm queue 466
operator and role definitions 377 conditional unmaks example 922
placing icons in Graphics 378 conditional unmask 244
point setup for Velocity 375 copying to clipboard 426
receiver setup for Velocity 369 creating instructions for 698
see also Central stations customizing levels 698
setting up Velocity to use 369 customizing text and fields 681
steps to configure 365 example 920
using Alarm Viewer to monitor 377 get recorded DVR video 428
using Graphics to monitor 378 hiding or showing as default 681
Alarm types 127 host DVR 740
Alarm Viewer instructions 682, 692
central stations 377 masking 242
require entry of note on acknowledgement 49 momentary mask 242
using for fire alarm systems 377 partial unmask 245
Alarm viewer 417–430 partial unmask example 923
acknowledged alarms pane 421 playing associated DVR video 428
acknowledging an alarm 424 point customization 681
address format 422 pre-arm status 244
clearing alarms 425 pre-arm status example 922
clearing all alarms 425 queue pane in Designer 465
closing 436 refresh alarms on viewer 429
colors 432 restore viewer on new 432
column headers 432 show graphic on 601
columns 420 test if secure 244
copying to clipboard 426 unacknowledged pane 420
customizing properties 430 unmasking 242

1286
 MAN006-0612

viewing instructions for 429 AutoGen code length 93

viewing maps for 429 AutoGen printout 93
Alert Auto-generate codes 234
control zones 114 Auto-generate PIN codes 869
controller 91 Auto-generate PINs 869
credentials 873, 888
overview 892 B
Aligning objects 489 BackColor 602
All DVR video events 753 Backdrops
All Events Log by Date report, cannot open 1200 designing 497
Allocate 20% of MEB/CE memory to buffer 88 displaying 500
Allow user count display 202 Background color 444
American Dynamics 717, 721 Backing up SNIB2 encryption 211
see DVR Backing up Velocity database 1096
Annunciator 256 Backup
alarm cancel 250 defining multiple locations 1101
configuring 256 Backups
Annunicator database dialog box 1097
use numeric LEDs as 201 Badge & Graphic Designer 437–655
Anti-passback add image dialog box 585
timed 203 adding color 586
Application permissions for roles 292 advanced procedures 601–655
Apply Credential Management Globally 237 alarm queue pane 465
Arc properties aligning objects 489
UDF 518 arc properties 517
Archiving alarm and event logs 1041 arcs 503
Arcs assigning badge templates to credentials 865
drawing 503 assigning objects to layers 653
extending to semicircles 504 background color 444
properties 517 background colors 602
Areas badge template creation 494
add new alarm 374 barcode properties 520
alarm setup 374 barcode symbologies 524
properties 375 barcodes 514
Assign credential to person dialog box 804 basic procedures 479–493
Assign person to existing credential bleeding edge text 596
dialog box 806 canvas 450
Assigning a credential template to a person 807 categorizing properties 601
Assigning a new credential to a person 806 cause types 628
Assigning a person to an existing credential 806 changing text characteristics 594
Assigning existing credential to a person 804 chord properties 527
Associations chords 504
ACBs 129 circles 505
Attempt redial at start of time zone 142 closing 478
Auto accept scanned data 790 closing drawings 500
Auto acknowledge of return to normal 48 color dialog box 588
Auto enroll 827 color models 590
Auto launch on paper detect 790 color palette 588
Auto lock workstation after x minutes of idle time 278 command set properties 573
Auto pan 674 control zone default colors 602
AutoCad control zone properties 529
file import 598 control zones 505
importing files 502 copying objects 481
see also DXF creating drawings 498
support for 598 custom badge fields 646
Auto-clear after time zone 161, 170 custom links 613
expansion relays 175 cutting objects 482
Auto-delete data bound objects 470
on expiration 894 databound image properties 539
overview 892 databound images 512
Auto-delete credential 238 databound text 511
Auto-delete credentials 871 databound text properties 562
Auto-delete on expiration 894 deleting objects 482

1287
Velocity Version 3.1 Administrator’s Guide

design/live mode 464 mirroring objects 489

designing backdrops 497 moving objects 488
designing badges 494 object library pane 467
designing maps 497 object properties 516–600
designing Velocity objects 619 opening 438
directory pane 471 options 601
displaying backdrops 500 ordering objects 486
displaying badge templates 500 overlapping objects 487
double-sided badges 496 overriding default printers 439
drawing and designing 494–515 page properties 444
drawing scale 443 page setup 441
drawing selection tabs 473 page setup dialog box 441
edit text dialog box 594 page size 442
editing property sheets 516 pan and zoom pane 473
editing text 593 panning drawings 491
editing Velocity objects 622 pasting objects 482
ellipses 505 placed object properties 547
ellipses properties 532 placing cameras 607
exporting drawings 597 placing command sets 612
extending arcs to semicircles 504 placing objects on backdrops and maps 605
fill color 586 polygon properties 550
fill style 592 polygons 507
font dialog box 594 polyline properties 552
font styles 595 polylines 508
fundamentals 446–478 print preview 492
general drawing properties 581 print setup page 441
grid properties 444 printing 493
grid settings 441 properties pane 474
grid settings modification 452 quick link viewer 616
grid spacing 445 rectangle properties 555
grid style 445 rectangles 510
grids 450 renaming drawings 492
group properties 535 renaming objects 492
grouping objects 488 reshaping objects 483
hatching and cross-hatching 592 resizing objects 483
hot keys 449 rotating objects 485
icon tool bar 458 ruler bars 452
icon tool bar repositioning 463 saving drawings 492
ignore state changes 601 sector properties 557
image properties 537 sectors 509
images 511 see also Objects
importing drawings 501 selecting an object 479
importing Velocity objects 503 selecting multiple objects 480
inserting photos 513 setting up badge printers 439
inserting pictures 513 show canvas tabs 601
inserting signatures 513 show graphic on alarm 601
integration builder 623 snap to grid 444
integration builder screen 625 standard images 511
introduction 437 standard text 510
layers 651, 652 status line 448
layers properties 654 straight line 506
line color 586 supported images 512
line properties 542 switching between drawings 491
line style 591 testing links 605
lines 506 text characteristics 594
link properties 576 text insertion 510
linking maps and backdrops 604 text properties 559
magnifying drawings 490 topology object mapping 647
magstripe properties 544 UDF assignment 649
magstripes 513 UDF property definitions 648
map hierarchies 603 undoing an action 491
measurement units 444 ungrouping objects 488
menu tool bar 453 using integration builder 628

1288
 MAN006-0612

variable field names 582 Bleeding edge text 596

VDO folder 470 Blink yellow left LED on power failure 200
VIO behavior 633 BMP 597
VIO folder 469 BMPs
Badge printer exporting 598
define 50 Borders
Badge printers coloring 586
configuration 762 Bosch DVR 721
overriding default 439 Breaking apart doors 146
setting up 439 Bring object to front 487
Badge templates Browser 1001–1003
assigning to credential 865 closing 1003
creating 494 main screen 1002
displaying 500 opening 1002
inserting photos 513 using 1003
inserting pictures 513 Buffer count, for event viewer statistics 903
inserting signatures 513 Buffer threshold setup 144
migration wizards 382 Bundled doors
selecting for photo callup 151 what are 1209
worksheet 1225 Bundling components to create a door 147
Badges
credential overview 863 C
custom fields 646 Calibrate scanners 792
designing 494 Call host at start of time zone 142
double-sided 496 Cameras
double-sided printing 862 addressing DVR 726
previewing 859 addressing DVR directly 727
printing 861 addressing NVR 726
printing an example from credential property sheet 865 addressing NVR directly 727
specifying for credential 866 configuring 667
template migration wizard 382 drag & drop DVR views 744
Barcodes DVR control 746
comment on top 521 for roles 307
comments 521 placing on maps 607
data 521 preset selection 672
height 521 presets 668
include text 522 program views for DVR 750
inserting 514 programming DVR patterns 751
narrow bar width 521 properties 667
narrow to wide ratio 522 PTZ controls using DVR 749
properties 520 tour selection 672
reduction/gain 521 video input on switcher 668
show bearer bars 522 viewing DVR video 728
show check characters 522 viewing video from attached DVR 727
show quiet zones 522 Cancel Dial-Host during time zone 143
supplement 521 Cancel entry delay 243
symbologies 524 Canvas 450
symbology 521 background color 441
text on top 522 measurement units 441
Basic flowchart 53 showing tabs 601
Batch enroll credentials 766 captions
Batch enrollment changing 688
card credentials 826 Capture photo if available 790
Baud rate Capture rate 52
CCTV port 662 Capture signature if available 790
Bezel tamper Capturing filters 840
enabling 196 Capturing photos 835
Biometrics Capturing signatures 833
credential property sheet 877 Capturing TWAIN images 838
GUID 877 Capturing video images 836
panel ID 877 Card codes
site ID 877 accept access 199
Biometrics page 877 accept control 200

1289
Velocity Version 3.1 Administrator’s Guide

assigning PIN 869 IP address 662

code tamper disables example 990 IP port address 662
custom examples 932 overview 657
length 868 port 660
overview 863 port dialog box 660
programming 199 port manager 663
see also Credentials presets 668, 669
specifying for credential 866 serial port 661
Card data mapping 340 supported switchers 657
Card select number 877 switcher inputs and outputs 666
Card types switcher properties 665
indicating for credentials 866 switchers 664
one-field ABA 235 TCP/IP 661
overview 234 viewer 671
special 235 viewer control functions 674
standard 26-bit Wiegand 234 CCTV preferences
standard 27-bit Wiegand 235 capture rate 52
standard 28-bit Wiegand 235 CCTV viewer
standard 29-bit Wiegand 235 auto pan 674
card types control functions 674
standard 26-bit Wiegand 234 focus mode 674
Card/code only access during time zone icon tool bar 673
see CCOTZ iris mode 674
Cards pan-tilt 674
custom codes 340 using 671
custom codes for readers 197 zoom mode 674
designating types for credential templates 231 Central stations
enabling hex pass-through 785 account setup 373
in credential templates 231 alarm system illustration 365
mapping custom codes 784 area setup 374
overview 863 configuration preparation 366
see also Credentials configuring fire alarm panels 366
special handling 785 configuring fire alarm receivers 368
Caret sign (^) 817 introduction 365
Cause types 628 operator definitions 377
Causes palcing alarm icons in Graphics 378
adding 629 placing alarm icons 378
basic device states 629 point setup 375
click 629 Radionics D9124 Fire Alarm panel 366
event type 628 receiver setup 369
specific event 628 role definition 377
types 628 setting up Velocity to use 369
updating 633 steps to configure 365
CCM using Alarm Viewer 377
import wizard 388 using RPS 366
CCM Replacement options 1082 Check an item to enable that column 909
CCMs Check secure 244
firmware update 712 Chords
CCOTZ drawing 504
defining 203 properties 527
disable above threat level 196 Clean scanner 792
enabling 203 Clear code tamper 253
inhibit dual technology in 152 Clear relays 249
validate 91 Clearing alarms 425
CCTV Clearing alarms from alarm queue 466
settings for Velocity 1077 Clearing all alarms 425
CCTV cameras Client does not talk to server 1198
properties 675 Client Routing Enabled 45
CCTV configuration 657–670 Clients
basic steps 657 using SCM on 1074
baud rate 662 Cloning door groups 260
cameras 667 Cloning function groups 272
defining the system 659 Codabar 525

1290
 MAN006-0612

Code 11 524 current setups and status 221

Code 128 525 Commands sets
Code 39 525 rules & conventions 226
Code 93 525 Comment on top 521
Code extensions Communications
defining 270 for controllers 132
Code tamper 89 Components
clearing 253 checkboxes 688
disables card or code holder example 990 commandbutton 688
disables credential example 990 coolbars 688
disables user 201 customizing 687
on dual 152 elements 689
overriding 889 forms 688
silencing 201 labels 688
silent example 988 menus 688
Codes message boxes 688
auto-generate 234 Components pane 14
custom card 340 Components windows 14
custom card examples 932 Conditional unmask 244
defining extensions 270 example 922
in credential templates 234 Configuration
length 234 advanced flowchart 54
Cold-start options 1082 basic flowchart 53
Colors preliminaries 41
adding to drawings 586 Configuration folder 9
background 602 Configuration preliminaries 41
changing event 903 Configuring a system 42
changing event viewer 909 Configuring PIV readers 854
default control zone 602 Configuring SNIB2 208
dialog box 588 Configuring Velocity 215–332
fill 586 Connecting modems 136
line or border 586 Connection timeout 47
models 590 Console options 22
palette 588 Control code reporting 183
Column delimiter 392, 400 Control codes
Column management 34 accepting 200
rearranging column headers 36 Control delay time
resizing columns and panes 37 expansion relays 173
sorting by column header 36 for relays 169
Command 188 225 Control delay timers 213
Command 88 221 Control functions 246
Command 98 223 force off 247
control functions 224 force off release 247
miscellaneous functions 224 force on 246
Command echo force on release 247
enabling 98 lock down 247
Command sets lock down release 247
command 188 225 lock open 247
command 88 221 lock open release 247
command 98 223 priority levels 248
command syntax 221–227 relays states 249
defining 216 trigger 246
executing 1046 using CMD 98 224
executive 219 Control mode time 168
for roles 307 expansion relays 173
modifying 220 Control mode timers 213
overview 216 Control zones
placing on a map 612 actual relay in 181
properties 218, 573 actuate door relay in 164
report of setup changes 225 assigning to function group 272
Command syntax 221–227 basic example of standard 914
Commands controller configuration 109
basic SQL 1140–1171 default colors in Designer 602

1291
Velocity Version 3.1 Administrator’s Guide

defining master 111, 120 moving 80

defining standard 110, 117 MSP worksheet 1230
disable relay in 164, 182 passback page 99
door inputs actuate relays during CZ 164 properties 85
door inputs retrigger relays during 165 renaming 80
door inputs trigger relays in 165 reporting page 95
drawing in Designer 505 setup page 88
editing objects 112 synchronizing clocks 1057
enable global master 92 Conventions
expansion input actuates relay in 190 guide iii
expansion input disables relay in 190 Copying alarms to the clipboard 426
expansion input retriggers relays in 190 Copying door groups 260
expansion input triggers relays in 190 Copying objects 481
expansion inputs 190 Copying roles 288
explanation 109 Count
globalized master example 956 for download monitor 134
linking master 121 Count users other side 254
master 119 Creating domain administrators 280
master worksheet 1283 credential enrollment
properties 112 special handling 785
properties in Designer 529 Credential management 894–895
retrigger door relays in 161 absentee rule 894
retrigger expansion outputs in 175 auto-delete on expiration 894
retrigger relays in 170, 182 examples 927
specifying for objects 530 global 895
standard 117 occupancy count 894
standard worksheet 1282 passback 894
trigger expansion outputs in 175 temporary days 894
trigger relays in 161, 170, 182 two-person rule 894
triggers by alarm actions 124 use count 894
triggers on secure example 925 Credential pane 765
what is 1208 Credential tempaltes
Controller configuration execute function groups 884
Alarm Actions page 124 Credential template
Controllers overview 228
adding 72 Credential templates
alarm actions 126 2-person rule 238
alarm actions page 124 absentee limiting 237
alarm relay timers 93 activate on 233
allocate 20% of MEB/CE memory to buffer 88 activation/expiration dates 233
assigning to function group 272 adding 228
basic example 914 apply credential management globally 237
basic steps for configuring 73 assigning to person 807
code tamper 89 auto generate code 234
communications page 132 auto-delete credential 238
configuring 71–78 code length 234
control zone page 109 codes 234
deleting 80 data number 232
different time zones 1209 day limiting 237
download monitor 133 day/use/absentee limits 237
downloading credentials 1041 defining card type 231
duplicating 80 designating IDFs 231
duress digits 93 duress digit 234
features 71 editing 229
general properties 86 enrollment state status 233
global credential management 895 expire on 233
how many per XBox 1210 for roles 307
importing 81 function property sheet 235
M16 worksheet 1229 general property sheet 230
M1N worksheet 1226 issue number 241
M2 worksheet 1227 limits property sheet 236
M8 worksheet 1228 MATCH number 232
modifying existing 85 on expiration 233

1292
 MAN006-0612

PIN 234 indicating card type 866

properties 230 last door column 767
see also Credentials limits property sheet 870
special needs access time extension 240 management 894
stamp number 232 management examples 927
threat authority 237 modifying existing for persons 821
use limiting 237 options property sheet 873
worksheets 1245–1250 overview 863
Credentials passback 873
absentee limiting 889 printing a badge example from 865
absentee limits 871 properties 864
access time extension 873 reassigning from Who’s Inside 1220
activating dates 868 response to expiration 868
activating/deactivating 1041 show last access 767
alert 892 special needs 873
alerting 873, 888 tagging 873, 888, 892
apply global management 870 tasks 887
assign threat authority 871 two-person rule 872
assigning badge templates 865 unassign 889
assigning duress digits 869 unassigning 807
assigning existing to persons 804 use limiting 890
assigning function groups 869 use limits 871
assigning IDFs 866 writing fingerprints to 878
assigning new to person 806 Credentials templates
assigning person to existing 806 deleting 229
assigning PINs 869 Criteria list pane 1024
assigning template to persons 807 Criteria page 1021
assigning to persons 804 Cross-hatching 592
auto-delete 871 Crystal reports 1033
auto-generate PIN 869 CSN 877
auto-generate PINs 869 Custom badge fields 646
batch enroll card 785, 830 Custom card codes 340
batch enroll cards 826 selecting for readers 197
biometrics page 877 Custom card mapping 784
biometrics properties sheet 877 Custom codes
code length 868 mapping 784
code tamper disables example 990 Custom filters 910
custom card mapping 784 Custom links 613
day limiting 890 Custom page sizing 441
day limits 871 Custom reports
define function dialog box 875 saving 1025
defining 864 Customization Manager
delete 889 mouse rollover 689
displaying from who’s inside 1216 tool tip text 689
download to controllers 1041 Customization manager 677–701
downloading 807 advanced options dialog box 696
downloading multiple 808 alarm levels 698
dual technology 866 alarms 681
enabling hex pass-through 785 component folder depopulated 1200
enabling special handling 785 components 687
execute function groups 884 creating instructions 698
executive override 872, 873 escalation 696
executive passback override 891 events 683
expiration dates 868 export wizard 700
finding card 813 foreign language text 699
fingerprints for 877 form captions 688
force download 889 import wizard 700
forgive passback 891 instructions 682, 692
forgive users 891 integrated alarms 690
forgiving from Who’s Inside 1219 integrated devices 690
function property sheet 869 integrated events 692
general property sheet 865 main screen 679
global management 895 overview 677

1293
Velocity Version 3.1 Administrator’s Guide

point customization 694 Delay timer 90

point customization for alarms 681 Deleting a controller 80
point customization for events 683 Deleting objects 482
point customization for integrated alarms 691 Deleting tasks in Scheduling agent 1069
point customization for integrated events 693 Deny access 99
point customization for RTNs 684 Deny codes under duress 202
reset to default 693 Deny under duress example 987
return to normal events 684 DESFire 792
software 685 Design mode
tool tip text 688 administration module 15
using 678 enrollment manager 798
Customization reports 1012 for Designer 464
Customizing event viewer 901 Design tips for email notifier 352
Customizing export files 393 Designer 437–655
Customizing reports 1018 Device configuration
Customizing SCM 1075 add new scanners 789
Cutting objects 482 enrollment manager 786
PIV readers 792
D scanner maintenance 791
Daily midnight report 96 scanners 787
Database signature capture 786
enter name of 47 Device servers 68
moving Velocity to another domain 1109 technology 69
Database diagrams 1095 Diagnostic options 98
Database settings for Velocity 1077 Diagnostic settings for Velocity 1079
Database user accounts Diagnostic window 703–709
setting up 1127 generating reports 709
Database users performance 708
overview 1127 preview reports 708
properties 1128 using 704
setting up 1127 Dialing remote DIGI*TRAC networks 1042
Databases Dial-up configuration
backing up with SQL database manager 1096 buffer threshold setup 144
controlling with SQL database manager 1092 connecting modems 136
restoring Velocity with SQL database manager 1102 dialing remote DIGI*TRAC networks 1042
shrinking 1110 host settings 140
tasks in SQL database manager 1093 introduction 135
users 1127 modem pools 138
Databound images modem setup 136
inserting 512 modem setup on Velocity 137
properties 539 remote settings 140
Databound objects 470 Dialup configuration
Databound text using event viewer with a 1200
inserting 511 Dial-up controllers
properties 562 errors in Event Viewer 1200
DataMatrix 526 Dial-up location properties
Day Limiting 237 host settings 139
Day limiting 890 remote settings 140
assigning 237 time zones subpage 142
for credentials 871 DIGI*TRAC
Daylight savings 328 role properties 308
deactivating credentials 1041 DIGI*TRAC Annunciator
Deadman timer 251 alarm cancel 250
Debug levels DIGI*TRAC annunciator 256
flash 1080 configuring 256
HCS 1080 DIGI*TRAC command language (DCL) 216
PE 1080 rules and conventions 226
De-energized (LED off) 158 DIGI*TRAC configuration folder 11
expansion relays 173 DIGI*TRAC configuration reports 1012
for relays 168 DIGI*TRAC network service 1084
Default encryption key 133 see also DTNS
Define extension dialog box 269 DIGI*TRAC networks
Define function dialog box 875 dialing remote 1042, 1043

1294
 MAN006-0612

Digital video recorder retrigger relays in control zone 165

see DVR setup property sheet 161
Directory pane 471 timers 163
Disable answer during time zone 143 trigger mask 162
Disable CCOTZ above this threat level 196 trigger relay and mask 162
Disable during time zone 101 trigger relays in control zone 165
expansion relays 174 Door mode time 158
Disable entry delay during 164 extended access 154
for expansion inputs 189 Door open 1186
Disable passback during TZ 99 Door open too long
Disable reader above this level 196 see DOTL
Disable relay during time zone 170 Door relays
Disable relay in control zone 164, 182 actuate during time zone 160
for expansion inputs 190 auto-clear after time zone 161
Disable reporting of 96 disable during time zone 160
Display alarms most recent to oldest 50 logic 160
Display alarms oldest to most recent 50 properties 158
Display new events at top of list 909 report mask state change 183
Display print confirmation 896 retrigger in control zone 161
Display the current progress of countdown 155 timers 158
Displaying backdrops 500 trigger in contrtol zone 161
Displaying badge templates 500 Door timers 213
Domain administrators 280 Doors
creating additional 280 basic example 915
Domain controller bundling components 147
what is 1209 configuring 145
Door contact delay timers 214
state change reporting 183 enabling photo callup 151
Door delay time 158, 159 entry reader page 156
Door delay timers 214 exit reader page 157
Door groups 257–262 extended access timers 154
adding 262 extended unlock 242
assigning to function group 272 general page 149
changing time zones for 259 green flash in delay example 993
cloning 260 grouping 257–262
defining 257 input page 161
editing 262 introduction 145
example 915 properties 147
for roles 309 relay logic property sheet 160
lock down example 274 relay page 157
master 263 relays setup property sheet 157
properties 261 relock 242
removing 262 special handling for readers 197
worksheets 1235–1237 timers 213
Door inputs unbundling 146
actuate relay in control zone 164 unlock 242
change reporting property sheet 165 what is a bundled 1209
contract state change reporting for 165 Wiegand hex pass-through 196
control zones 164 DOTL 90
disable entry delay during TZ 164 report when unlocked 163
disable relay in CZ 164 specifying time 163
DOTL time 163 warning time for door inputs 163
DOTL warning time 163 Double-sided badge printing 862
enabling RQE 162 Double-sided badges 496
line module type 162 Download controller settings 1082
logic property sheet 164 Download credentials
mask during time zone 164 settings 1082
mask state change reporting 166 Download monitor 133
mask tamper when door contact masked 163 cancelling downloads 134
normal state when secure 162 count 134
normally open or closed 162 identity number 134
report DOTL when unlocked 163 queued 134
retrigger relay and mask 163 status 134

1295
Velocity Version 3.1 Administrator’s Guide

Downloading credentials 807 alarm record rate 722

Downloads all video events 753
cancelling 134 American Dynamics 717, 721
credentials 807 American Dynamics VideoEdge 721
force credentials 889 AVI files 740
forcing 808 Bosch 721
monitor 133 camera control 746
multiple credentials 808 configuring 719
persons and credentials 77 customizing event logs 757
queued 134 drag & drop camera views 744
time zones and holidays 77 event history viewer 756
Drag & drop with live view DVR 744 event list functions 759
Drag & drop with Video Explorer 745 export recorded video 734
Drawing scale page 443 export video 740
Drawing selection tabs 473 general configuration process 717
Drawingboard 450 generate and stop host alarms 740
Drawings generating history logs 756
adding color 586 get alarm list 741
closing 500 get recorded video from Alarm Viewer 428
creating 498 Integral 721
designing 497 introduction 717
exporting 597 IP ports 721
general properties 581 live video screen 729
importing 501 live view 728
linking 604 manual time synchronization 744
magnifying 490 operating 726
panning 491 override or stop host alarms 741
renaming 492 Pelco 721
saving 492 play local video 734
see also Badge & Graphic Designer play recorded video 734
switching between 491 play video from Alarm Viewer 428
Dropdown combo box 779 play video window 735
Dropdown list 779 port (listen) 721
DTLM PTZ camera controls 749
DTLM1 184 retrieve recorded video 733
DTLM2 184 right click options 743
DTLM3 184 search & retrieve recorded video 733
overview 184 time synchronization 723, 744
DTNS 1084 triggering an action with 1187–1193
start manually 1084 unit info page 724
stop manually 1084 unit status page 723
Dual technology 152 video explorer 731
code tamper on dual 152 video record rate 722
inhibit in CCOTZ mode 152 view camera video 728
options 152 view groups 745
specifying for credential 866 viewing video from attached cameras 727
trail zeroes on 152 DVRs
unknown cards on dual 152 camera patterns 751
Duplicating controllers 80 enabled triggered Video Explorer window 52
Duress digits 881 quick view 750
assigning in credentials 869 DXF
defining 93, 881 exporting 598
deny codes under 202 file export 599
deny under example 987 importing 502
duress without access example 987 see also AutoCad
gen codes with 93
specifying 234 E
using with extension digits 882 EAN Bookland 524
Duress without access example 987 EAN-13 524
DVR EAN-8 524
add unit properties 720 Edit command string dialog box 220
address camera directly 727 Edit text dialog box 594
addressing attached cameras 726 Editing existing tasks in Scheduling agent 1068

1296
 MAN006-0612

Effects AES 208

adding 629 backing up SNIB2 211
fill color 630 resetting 64, 211
fill style 630 restoring SNIB2 1105
flash 630 Encryption key
flash options 631 randomizing 133
line color 630 encryption key
line style 630 default 133
line width 630 Energized (LED off)
position 630 for relays 168
text 630 Energized (LED on) 158
text color 630 for expansion relays 173
updating 633 Enrolling a new member to this role 310
values 630 Enrolling a new person 800
visibility 630 Enrollment
Ellipses auto 827
drawing 505 Enrollment device configuration 783
properties 532 Enrollment Manager
Email notifications 348 add new scanner 789
content 350 display print confirmation 896
properties 348 enable print control 896
Email Notifier scanner error 1200
advanced event selection 351 setting maximum print control defaults 896
properties 348 Enrollment manager 761–895
Email notifier acquire 835
design tips 352 adding persons 800
Email reports additional images 773, 843
scheduling and sending 1043 alert 888
E-mailing images from enrollment manager 844 apply credential management globally 870
Emailing reports 1043 assign credential to person dialog box 804
emailing reports 1043 assign person to credential dialog box 806
EMF 597 assigning a credential template to a person 807
exporting 598 assigning a new credential to a person 806
Employees assigning a person to an existing credential 806
see Persons and Enrollment Manager assigning credential to person 804
Empty local alarm via reset 91 assigning existing credential to a person 804
Enable ACB reporting 98 auto enroll 827
Enable address level description customization 1081 badge printer configuration 762
Enable bezel tamper 196 batch enroll card credentials 785, 826, 830
Enable card/code-only access during TZ 203 capturing signatures 833
Enable command echo 98 changing field size 798
Enable contact state change report closing 766
for inputs 183 configuring the enrollment station 830
Enable contact state change reporting 165 connecting the enrollment station 830
Enable duress alarm mode 91 credential pane 765
Enable event level description customization 1081 credential properties 864
Enable global MCZ 91 credentials 863
enable global user management 91 customizing personal information form 798
Enable hex pass-through 785 defining additional images 781
Enable line voltage updates on input state change 1080 defining credentials 864
Enable local system code reset 92 delete credentials 889
Enable mask state change reporting 166 design mode 798
for inputs 183 device configuration 783
Enable operator logging 1082 device configuration screen 783
Enable print control 896 double-sided badges 862
Enable printing SNET messages on local printer 98 downloading credentials 807
Enable RSS 1083 downloading multiple credentials 808
Enable single zone 100 downloading persons and credentials 77
Enable triggered Video Explorer window 52 e-mailing images 844
Enable web server 1083 enrolling new person 800
Enable Wiegand hex pass-through 196 enrollment station 829
enabling 98 file capture 840
Encryption finding card credentials 813

1297
Velocity Version 3.1 Administrator’s Guide

finding persons 809 Entry delay time 163, 180

force download 808, 889 disable during time zone 181
forcing downloads 808 for expansion inputs 188
forgive passback 888 Entry reader page 157
IDFs 866 Entry/exit delay reporting 183
image placeholders 781 Escalate after 1081
image preview 840 Escalate alarms outside Roles 1081
image preview dialog box 841 Escalation 696
last door column in credentials pane 767 setting up 1081
main screen 764 Ethernet connectivity 208
map UDF fields 795 Event colors
map UDF fieldsl 789 changing in event viewer 903
menu bar 766 Event history viewer for DVR 756
modifying an existing person 820 Event reporting 96
modifying existing credentials for a person 821 Event Viewer
opening 763 errors when configuring second controller through dial-up
override code tamper 889 1200
overview 761 redraw rate 908
personal information form 775 Event viewer 899–911
personal information pane 769 buffer count 903
photo capture 835 changing event colors 903
PIV reader configuration 792 check an item to enable that column 909
previewing badges 859 colors 909
print preview screen 859 copy events to clipboard 904
printing badges 861 creating filter groups 905
quick worksheet for momentary access 1239 custom filters 910
saving an image to another source 845 customizing 901, 907
scanner configuration 787 dialup error message 1200
scanner maintenance 791 display new events at top of list 909
see also Credentials displaying incorrect base relay events 1198
signature capture 833 event colors 909
signature capture dialog box 833 events last second 903
signature capture pad configuration 786 filter builder 911
start Badge Designer from 888 filter events by type 906
station configuration 784, 786 filter groups 905
testing enrollment stations 831 filter property sheet 910
TWAIN capture 838 general property sheet 908
unassign credentials 889 load cached events on start 909
unassigning credentials 807 main screen 900
user-defined fields 776 maximum lines to display 908
user-defined setup 778 properties 907
video capture 836 selecting filter groups 906
wildcard symbols 817 suspend scrolling in 902
worksheet for function groups 1240 timeout messages 1199
worksheets 1239–1254 using 900
Enrollment station 829 xbox command 5 complete 1200
auto mapping UDFs 796 Event viewers
configuration for enrollment manager 784, 786 assigning filters to roles 309
configuring 830 Events
connecting 830 archiving logs 1041
diagnostics dialog box 831 assigning WAV files 697
SMES-H 829 copy to clipboard 904
SMES-M 829 customizing 683
SMES-U 829 customizing DVR logs 757
status 233 customizing RTNs 684
Enrollment stations customizing text and fields 683
enabling hex pass-through 785 DVR history viewer 756
serial port designation 784 DVR list functions 759
special handling 785 point customization 683
testing 831 Events Last Second 903
Entry delay Examples 913–998
cancel 243 absentee rules 927
mask 243 access per reader 918

1298
 MAN006-0612

additional users 916 Exit reader page 157

alarm functions 920 Exit timer
basic 914 start 243
basic controllers 914 unmask/start 243
basic doors and readers 915 Exiting Velocity 5
basic users 916 Expanding and contracting the system tree 9
code tamper disables card or code holder 990 Expansion inputs 186
code tamper disables credential 990 AATL time 188
conditional unmask 922 AATL warning time 188
control zone triggers on secure 925 actuate relay in control zone 190
credential (user) management 927 configuring 186
custom card codes 932 control code state change reporting 191
deny under duress 987 control zones 190
door groups 915 disable entry delay during 189
duress without access 987 disable relay in control zone 190
executive override 948 door contact reporting 191
extended access 951 door relay mask state change reporting 191
flex schedules 968 enabling RQE 188
forgive passback 946 entry delay time 188
function groups 273, 954 entry/exit delay state change reporting 191
global passback 948 exit delay time 188
global user management 931 general property sheet 187
globalized master control zones 956 line fault state change reporting 191
green flash in door delay 993 logic property sheet 189
green LED while relay active 992 M1N exception 186
half-day holidays 965 mask during time zone 189
holidays 962 mask tamper when door contact masked 188
introduction 913 mode time 188
latch monitor feature 972 normal state when secure 187
list of 917 normally closed 188
long PINs 974 normally open 187
man trap 976 overview 186
multiple tenants holidays 962 properties 186
partial unmask 923 report AATL when unlocked 188
passback 943 retrigger mask only 188
pre-arm status 922 retrigger relays in control zone 190
print ACBs not at default 983 RQE enabled 188
quarter-second relay times 984 RQE mask state change reporting 191
ScramblePad options 986 RQE reporting 191
silent code tamper 988 tamper state change reporting 191
standard control zones 914 time zone state change reporting 191
threat levels 997 time zones 189
time zones 325 trigger mask only 188
two-person rule 980 trigger relays in control zone 190
unplanned holidays 970 unlock state change reporting 191
use count 930 Expansion relays
VIO 637 configuring 172
who’s inside 999 general property sheet 173
yellow flash for control delay 994 introduction 172
zoned occupancy control 944 properties 172
zoned passback 943 virtual relays 175
Executing a command set 219 Expiration dates 868
Executing command sets 1046 response to 868
executing function groups 884 Export DVR video 740
Executing programs 1046 Export files
Executive override customizing 393
credential passback 873 Export local video 734
example 948 Export wizard
for credentials 872 for customization manager 700
for two-person rule 108 Exporting drawings 597
Executive passback override 891 Exporting reports 1032
Exit delay time 163, 180 Exports
for expansion inputs 188 reports 1032

1299
Velocity Version 3.1 Administrator’s Guide

scheduling data 1047 operator and role definitions 377

Extended access point setup 375
display the current progress of countdown 155 receiver setup 369
examples 951 see also Central stations
Extended access timers 154 setting up Velocity to use 369
Extended code 39 525 steps to configure 365
Extended unlock 242 using Graphics to monitor 378
Extension digits 269 Flash debug 1080
defining 269 Flash options 631
using with duress digits 882 FlashBus TWAIN32 setup dialog box 839
Extension service FlashBus video
installing 414 capturing photos using 835
External Application Launcher 407 Flex schedules
External events 96 example 968
Focus mode 674
F Fonts
Field caption 779 changing in Designer 594
Field type 779 dialog box 594
Field types styles 595
ascending and descending order 779 Force download 808
dropdown 779 Force new note for multiple acknowledgement 49
dropdown lists 779 Force new note for multiple clear 49
text boxes 779 Force off 247
File capture 840 Force off release 247
File options 21 Force on 246
lock workstations 32 Force on release 247
switching operators 31 Foreign languages
Fill customizing Velocity for 699
style 592 Forgive all users 254
Fill color 586 Forgive passback 888, 891
Fill colors example 946
for effects 630 Forgive users 891
Filter builder 911 Forgiving credentials from Who’s Inside 1219
Filter groups form captions
builder 911 changing 688
creating 905 Freeze pane 1030
editing 905 Frequently asked questions 1208
exclude from display 910 bundled doors 1209
filter by event types 906 controllers in different time zones 1209
limit display to only the following 910 how many controllers per XBox 1210
overview 905 how to restore Velocity database 1212
properties 910 installing Velocity on company network 1209
saving 910 IRQ and memory conflicts 1210
selecting in event viewer 906 maps 1211
Filter property sheet 910 migrating from SAM to Velocity 1211
Filtering events by type in event viewer 906 monitoring other computers on the network 1210
Find permissions vs. rights 1211
operators 278 PIN parameters 1209
Finding card credentials 813 ports allowed per controller 1210
Finding persons 809 USB ports instead of COM 1210
Fingerprints users, persons, and credentials 1209
enrolling for credentials 877 using NET*MUX 1210
writing to a credential 878 version of Windows required 1208
FIPS 201 standard 792 what are Velocity services 1208
Fire alarms what is a control zone 1208
account setup 373 what is a domain controller 1209
area setup 374 what is a local administrator 1209
configuration panels 366 what is a time zone 1208
configuration preparation 366 what replaces an access zone in Velocity 1208
configuring receivers 368 where do I start 1208
illustration of a system 365 windows configurations 1208
introduction 365 Function category 271
monitoring using Alarm Viewer 377 Function groups 265–881

1300
 MAN006-0612

access + unlock/relock example 273 placed object properties 547

assigning control zone 272 placing alarm icons 378
assigning controllers 272 Graphics module 437–655
assigning door group 272 Green LED always on 200
assigning to credentials 869 Green LED flash during door delay 200
assigning to roles 309 Green LED on while the relay active 200
copying 272 Grid properties 444
define extension dialog box 269 show/hide 445
defining 265 snap to 444
defining code extensions 270 spacing 445
deleting 268 style 445
duress digits 881 Grid settings
duress digits with extension digits 882 change 452
editing 268 Grids 450
enrollment worksheet for 1240 hide/show 451
example 954 see also Grid properties
examples 273 Grouping objects 488
executing using credential templates 884 Groups
executing using credentials 884 properties 535
extension digits 269 GUID 877
function category 271
properties 267 H
worksheet 1238 H column
Functions explanation 326
access 241 Half-day holidays
alarm 242 example 965
control 246 Hardware configuration 55–214
define dialog box 875 controllers 71
grouping 265–881 devices to configure 57
input 245 doors 145
momentary access 242 inputs 178
overview 241–256 introduction 56
password 249 ports 59
priority levels 248 relays 167
special 250 Hatching 592
HCS debug level 1080
G help
Gen codes with duress digits 93 technical support iii
Generate alarm 99 Help options 24
Generating DVR history logs 756 Help topics 24
Generating reports 1011 Hex pass-through
Get recorded DVR video 428 enabling for readers 196
Global broadcasting 121 Hex passthrough
Global credential management 237, 870, 895 enabling 785
Global ID 121 HHActiveX.DLL 1198
Global MCZ HIR 598
enable 91 Hirsch
Global passback fax number iii
example 948 technical support iii
Global unique identifier 877 web page iii
Global user management History logs 1013
enable 91 Holiday tables
example 931 9-out-of-10 flex schedule 333
Globalized master control zone half-day holidays 333
example 956 multiple tenants 333
Globalized MCZ feature 109 overview 332
Grand master time zones Holidays 330–332
properties 323 defining 330
Granted transactions 96 deselect prevailing table from site 255
Graphics downloading to controllers 77
acknowledging alarms from 466 examples 962
assigning to roles 310 expanded calendar 331, 332
monitoring alarms using 378 flex schedules example 968

1301
Velocity Version 3.1 Administrator’s Guide

force table at site 255 Velocity data export 390

half-day examples 965 Velocity data import 397
multiple tenants example 962 Importing controllers 81
overview 330 Importing drawings 501
properties 331 Imports
schedules 332 previously-exported reports 1035
tables 332 reports 1034
unplanned example 970 scheduling data 1049
worksheet 1234 Indexed commands 252
Host alarms clear code tamper 253
generate and stop DVR 740 count users other side 254
Host settings 140 forgive all users 254
Hot Keys manual holiday tables 255
using to access programs 22 manual unholiday tables 255
Hot keys procedures 253
Designer 449 Industrial 2 of 5 525
How do I... 1203 Inhibit dual in CCOTZ mode 152
How to configure a system 42 Input functions 245
How Velocity 3.1 Upgrade handles operator permissions 286 mask 246
HSB model 590 momentary mask 246
HTML unmask 246
using with email notifier 352 Input state changes
enable line voltage updates 1080
I Inputs
Icon tool bar 18 AATL time 180
Icons AATL warning time 180
system 27 actuate relay in control zone 181, 182
ID formats 880 configuring 178
Identity 134 control code mask/unmask reporting 183
IDFs 880 designating line module type 179
assigning to credential 866 disable entry delay during time zone 181
designating for credential templates 231 disable relay in control zone 182
Ignore state changes 601 door contact state change reporting 183
Image preview 840 door relay mask state change reporting 183
Images enabling 179
add image dialog box 585 entry delay time 180
add placeholders 781 entry/exit delay reporting 183
additional 843 exit delay time 180
capturing 835 expansion 186
databound 512 extended access timers 154
defining additional 781 general property sheet 179
e-mailing from Enrollment Manager 844 input state change report property sheet 182
file capture 840 line fault state change reporting 183
inserting into drawings 511 logic property sheet 181
preview dialog box 841 mask 246
properties 537 mask during time zone 181
saving from enrollment manager to another source 845 mask tamper when door contact masked 180
standard 511 mode time 180
supported in Designer 512 momentary mask 246
TWAIN capture 838 non-door configuration 178
updating 843 normal closed 179
video capture 836 normal state when secure 179
Import wizard normally open 179
for customization manager overview 178
700 properties 179
Import/Export Wizards 381–400 report AATL when unlocked 180
Import/Export wizards retrigger mask only 180
badge template migration 382 retrigger relays in control zone 182
CCM 388 RQE 179
introduction 381 RQE enabled 179
SAM database file import 384 RQE mask state change reporting 183
SNIB2 403 RQE state change reporting 183
see also Expansion Inputs

1302
 MAN006-0612

specifying line module type 179 JPGs

tamper state change reporting 183 exporting 598
time zone state change reporting 183
trigger mask only 180 K
trigger relays in control zone 182 Keyboard functions 29
unlock mask/unmask reporting 183 Keypads
unmask 246 accept access codes 199
INSERT 1140 accept control codes 200
Inserting variable field names 582 accept programming codes 199
Instructions accept status requests 200
creating for alarms 698 allow user count display 202
Integral 721 also see ScramblePads
Integrated alarms green LED flash during door delay 200
customizing text and fields 690 overview 193
point customization 691 red LED always on 200
Integrated devices 690 scramble display for ScramblePad 199
Integrated events ScramblePad options 199
customizing text and fields 692 ScramblePad options examples 986
point customization 693 silent operation 199
Integration builder use numeric LEDs as annunicator 201
adding causes 629
adding effects 629 L
basic device states 629 Language for reporting 96
cause types 628 Last door column in Credential pane 767
create VIO example 637 Latch monitor feature
edit behavior for VIO groups 633 example 972
edit VIO 637 Launch Pad
effects options 630 see External Application Launcher 407
event type 628 Layers
example 637 assigning objects to 653
flash options 631 creating 652
overview 623 deleting 653
screen 625 editing 652
see also Causes hiding and showing 655
see also Effects overview 651
update cause 633 properties 654
update effects 633 removing unreferenced layers 655
using 628 Lease-line configuration
Interfaces configuration total timeout constant 66
central stations 365 LED reverse 196
serial port redirection 344 LEDs
Interfaces configuration folder 13 enabling or disabling 123
Interleaved 2 of 5 525 Limits
Internal events 96 absentee 237
internal events disable 96 day 237
Interval timeout 66 use 237
Invalid Codes 96 Line fault
Invalid penalty timer 89 reporting for door inputs 166
IP address Line fault reporting for inputs 183
define 47 Line modules
for CCTV port 662 designating for expansion inputs 187
setting for SNIB2 209 overview 184
IP port specify type for door input 162
specifying 1079 specifying type 179
IP port address 662 Lines
Iris mode 674 coloring 586
IRQ conflicts 1210 drawing 506
Issue Number 241 properties 542
style 591
J Lines per page 96
jpegs 512 Linking maps and backdrops 604
exporting 598 testing 605
JPG 597 Linking master control zones 121

1303
Velocity Version 3.1 Administrator’s Guide

Links main menu

custom 613 system tree pane 7
data 576 Main menu description 6
maps and backdrops 604 Main screen
properties 576 status line 26
testing 605 Man traps 976
Live mode Management tasks
for Designer 464 for SQL database manager 1130
Live view 728 Managing columns 34
Load cached events on start 909 Managing desktop space 33
Local administrator Managing Velocity windows 33
what is 1209 Manual holiday tables 255
Local keypad programming Manual time synchronization for DVR systems 744
system code 92 Manual unholiday tables 255
timeout 92 Map data fields
local keypad programming manual 402
enabling 92 Velocity data import wizard 401
Local printer setup 96 Map Grand Master Time Zones page 85
Local printer shows new user codes 92 Map Master Time Zones page 84
Local video Map Standard Time Zones page 84
play & export 734 Map UDF fields 789, 795
Lock down 247 Mapping control relays to alarm relays 170
example 274 Mapping topology objects 647
operators 281 Mapping UDF fields
workstations 335 automatic 796
Lock down release 247 removing 797
operators 281 Mappings
workstations 335 ACBs 129
Lock open 247 Maps
Lock open release 247 designing 497
Locking workstations 32 general properties 581
Lockout time 89 hierarchies 603
Logins how to create and use 1211
creating new 1132 linking 604
deleting existing 1132 panning 491
how to use 1131 placing cameras 607
introduction 1131 placing command sets 612
reviewing properties 1132 placing objects on 605
SQL server properties 1133 viewing alarms on 429
LOGMARS 526 Mask alarms 242
Logoff time 206 Mask entry delay 243
Logs Mask expansion input during time zone 189
archiving alarm and event 1041 Mask input during time zone 181
time 251 Mask tamper when door contact masked 163, 180
watch 251 for expansion inputs 188
Long PINs Masking
example 974 conditional unmask 244
input 246
M momentary 242
M16 momentary for inputs 246
worksheet 1229 partial unmask 245
M1N unnmask for inputs 246
expansion input exception 186 Master control zones
worksheet 1226 defining 111, 120
M2 description 119
worksheet 1227 enable global 92
M8 enable reporting 98
worksheet 1228 enabling or disabling LEDs 123
MagiCard badge printers 439 globalized example 956
Magnifying drawings 490 linking 121
Magstripes properties 115
inserting 513 worksheet 1283
properties 544 Master door groups 263

1304
 MAN006-0612

Master time zones MSI 525

properties 322 MSP
worksheet 1233 worksheet 1230
MATCH Multiple locations for backup 1101
never reuse codes 46 Multiple tenants holidays
reuse with operator override only 46 example 962
MATCH number 232 My Velocity
MATCH reader what happened to it? 1200
specifying 196
MATCH Reader Interface N
overview 194 Narrow bar width 521
Mate pattern recognition 721 Narrow to wide ratio 522
Maxicode 526 Navigating between modules 29
Maximum alarms to display 431 Navigating Velocity 29
Maximum lines to display in event viewer 908 ned 781
MCZ NET*MUX
enable reporting 98 using 1210
Measurement units 444 Network password 133
Measurement units for canvas 441 Network settings
MELM using OUs 1079
overview 185 Network settings for Velocity 1078
MELM1 185 Network video recorder
MELM2 185 see NVR
MELM3 185 Never reuse MATCH card codes 46
Members Never reuse PIN codes 46
assigning to roles 310 New area properties dialog box 375
Memory conflicts 1210 New point properties dialog box 376
Menu tool bar 20 NIST approved encryption 208
Message filters Noisy 1186
command echo 98 Normal closed
diagnostic options 98 for inputs 179
enable printing SNET messages on local printer 98 Normal state when secure 179
Messages for door inputs 162
xbox command 5 complete 1200 for expansion inputs 187
Messages per poll 206 Normally closed
Migrating from SAM database to Velocity 1211 for expansion inputs 187
Mirroring objects 489 Normally open
horizontally 489 for expansion inputs 187
vertically 489 for inputs 179
Miscellaneous functions 224 Notes
Mode time 180 displaying in Alarm viewer 427
for expansion inputs 188 Notifying operators via email 348
Modem pools 138 NTSC 837, 840
configuring 138 Number of people inside disable 2-person rule 101
Modems NVR
connecting 136 add unit properties 720
modem pools 138 address camera directly 727
setup for Windows 136 addressing attached cameras 726
Velocity setup 137 alarm record rate 722
Modifying ports 62 American Dynamics 717
Momentary access 242 configuring 719
worksheet for 1239 general configuration process 717
Momentary mask 242 IP ports 721
inputs 246 operating 726
Mouse time synchronization 723
rollover notes 689 unit info page 724
Mouse functions 29 unit status page 723
Mouse rollover 689 video record rate 722
Mouseover notes 689 VideoEdge 721
mouse-over text 688
Moving a controller 80 O
Moving objects 488 Object library pane 467
Moving Velocity database to another domain 1109 Object properties

1305
Velocity Version 3.1 Administrator’s Guide

arcs 517 Occupancy limiting

barcodes 520 zoned example 944
categorizing 516, 601 Occupancy options apply to this zone 101
chords 527 Occupancy tracking
command sets 573 enable 99
control zones 529 Off normal points 27
databound images 539 On local printer 95
databound text 562 On passback violation 99
editing 516 One-Field ABA 235
ellipses 532 One-field ABA 866
groups 535 OPC 525
images 537 Open circuit 1186
layers 654 Operational units
lines 542 specifying 1079
links 576 Operator logging 1082
magstripes 544 Operator permissions
pane 474 how upgrade handles it 286
polygons 550 Operators 275–281
polylines 552 account is disabled 278
rectangles 555 auto lock workstation after idle time 278
sectors 557 central stations 377
text 559 creating domain administrators to define 280
UDFs 650 defining 275
Objects detailed logging 1082
aligning 489 domain administrators 280
assigning layers to 653 enrolling 275
bring forward 487 find other users 278
bring to front 487 locking down 281
copying 481 partitioning 285
cutting 482 password 277
deleting 482 password never expires 277
designing Velocity 619 restrict by shift 278
fill color 586 rights vs. permissions 1211
grouping 488 shift definition 278
importing Velocity 503 switching 31
mirroring 489 unlocking locked 281
moving 488 user cannot change password 277
ordering 486 user must change password at next logon 277
overlapping 487 worksheets 1280–1281
pasting 482 Options for local keypad programming only 92
placing on maps 605 Ordering objects 486
properties 516–600 Organization unit
renaming 492 see OUs
reshaping 483 OUs
resizing 483 selecting an 1079
rotating 485 using as network setting 1079
selecting 479 Out of spec 1186
selecting multiple 480 Outputs
send backward 487 force off 247
send to back 487 force off release 247
topology mapping 647 force on 246
ungrouping 488 force on release 247
Occupancy lock down 247
count 106 lock down release 247
count users other side 254 lock open 247
minimums and maximums 102 lock open release 247
report violations 101 time zone control of 249
triggers 102 trigger 246
Occupancy control Overlapping objects 487
zoned example 944 Override code tamper 889
Occupancy Count 106 Override executive passback 891
Occupancy count 106, 894 Overriding print control 294
description 106

1306
 MAN006-0612

P defining for operator 277

Page properties 444 never expires 277
background color 444 user cannot change 277
measurement units 444 user must change 277
Page setup 441 Pasting objects 482
dialog box 441 Pattern recognition,using Mate 721
Page setup dialog box 441 Patterns
Page size 442 DVR camera 751
PAL 840 programming DVR 751
Palette 588 PDA
Pan and zoom pane 473 adding 334
Pan Tilt Zoom PDF-417 526
see PTZ PE debug level 1080
Panel ID 877 Pelco 721
Panning percentage sign (%) 817
using CCTV Viewer 674 Permissions
Partial unmask 245 how the upgrade handles them 286
example 923 required for viewing triggered Video Explorer 1194
Partitioning 285 versus rights 1211
how Velocity handles it 285 Person groups
Passback 894 assigning to a role 311
assigning to credentials 873 Person templates
control 104 assigning to roles 311
controller setup 99 worksheets 1276–1279
defining zones 105, 203 Personal identification verification
deny access 99 see PIV readers
disable during TZ 99 Personal information form 775
enable single zone 100 customizing 798
enable tracking 99 customizing user-defined fields 776
examples 943 user-defined fields 776
executive override 891 Personal information pane 769
executive override example 948 additional images 773, 843
forgive 891 general property sheet 770
forgive example 946 Persons
forgiving 888 adding 800
generate alarm 99 enrolling new 800
global example 948 finding 809
man traps 976 forgive access 891
number of people inside disable 2-person rule 101 modifying 820
occupancy options apply to this zone 101 modifying existing credentials 821
on violation 99 photo callup
options 99 enabling for a door 151
passback zones 101 Photographs
report occupancy violations 101 capturing 835
timed anti- 203 file capture 840
two-person rule 100 image preview 840
zoned example 943 TWAIN capture 838
zoned occupancy control example 944 video capture 836
zones 104 Photos
Passback zones inserting into badge template 513
defining 105, 203 PINs
disable two-person rule 101 assigning to credential 869
introduction 104 auto-generate 869
minimums and maximums 102 example of long 974
occupancy options 101 specifying 234
occupancy triggers 102 what are parameters 1209
Pass-thru 866 PIV readers
Password functions 249 configuring 792
priorities and levels 250 configuring for Velocity 854
restrictions 250 DESFire 792
Password never expires 277 FIPS 201 standard 792
Passwords Placed object properties 547
Placing icons

1307
Velocity Version 3.1 Administrator’s Guide

for central stations 378 overriding 294

Placing objects on backdrops and maps 605 set display confirmation default 896
Play DVR video 428 Print preview
Play local video 734 in Designer 492
Plessey 525 reports 1027
Point customization Print preview screen 859
alarms 681 Print setup page 441
events 683 Printers
how to use 694 badge configuration 762
integrated alarms 691 define badge 50
integrated events 693 define report 50
RTNs 684 local setup 96
using 694 on local 95
Points overriding default badge printers 439
alarm properties 376 setting up badge 439
alarm setup 375 transactions 96
how to customize 694 Printing
Polygons ACBs not at default example 983
drawing 507 badges 861
properties 550 double-sided badges 862
Polylines preview screen for enrollment manager 859
drawing 508 schedule report 1051
properties 552 Printing badges and drawings 493
Port manager 663 Printing reports 1031
Ports Priority levels 248
adding 60 Programmability
advanced port settings 66 introduction 1118
CCTV 661 stored procedures 1118
CCTV configuration 660 Programming codes
CCTV properties 660 accept 199
configuring 59 Programming DVR quick views 750
define name of 47 Programs
lease-line configuration considerations 66 executing third-party 1046
modifying 62 Properties
number of controllers allowed per 1210 general drawing 581
properties 63 Properties pane 474
redirecting serial 344 showing/hiding 477
replacing COM with USB 1210 PTZ
S*NET 66 using DVR 749
timeouts 66
Postnet 525 Q
Postpone dial-host during time zone 143 QR code 526
Pre-arm status 244 Queued downloads 134
Pre-arm status example 922 Quick link viewer 616
Preferences 44 Quick views 750
client routing enabled 45 programming 750
dialog box 44
enable triggered Video Explorer window 52 R
setting 44 Radionics
Preferences option D6500 receiver 366
accessing 22 fire alarm system 365
Preliminaries Readers
configuration 41 accept access codes 199
Presets accept control codes 200
assigning 669 accept programming codes 199
defining 668 accept status requests 200
selecting 672 also see ScramblePads
using 669 basic example 915
Preview screen blink yellow left LED on power failure 200
features 1029 card data mapping 340
Previewing badges 859 code tamper disables user 201
Print control code tamper on dual technology 152
enabling defaults 896 configuring 195

1308
 MAN006-0612

configuring non-door 195 input retriggers in control zone 182

configuring PIV 854 input triggers in control 182
custom card codes 197, 340 introduction 167
defining passback zones 203 lock down 247
disable CCOTZ above this threat level 196 lock down release 247
disable reader above this level 196 lock open 247
dual technology 152 lock open release 247
enable bezel tamper 196 logic property sheet 169
enabling Wiegand hex pass-through 196 mapping alarm to control relays 170
example of access per 918 mask state change reporting for door 183
general properties dialog box 195 normal states 158, 168
general property sheet 195 properties 167
green LED always on 200 quarter-second timer example 984
Green LED on while the relay active 200 retrigger in CZ 170
how to configure 195 states 249
inhibit dual technology in CCOTZ mode 152 time zone control of 249
LED reverse 196 timers 168
logic property sheet 202 trigger in CZ 170
MATCH reader 196 triggering 246
overview 193 virtual 172
properties 195 Release force off function 247
red LED always on 200 Release force on function 247
report access grants 200 Release lock open function 247
scramble keypad display 199 Relock door 242
ScramblePad options 199 Remote Desktop 409
silent code tamper 201 Remote settings 140
silent ScramblePad operation 199 Renaming a controller 80
special handling 197 Renaming drawings and objects 492
trailing zeroes on dual technology 152 Renaming roles 289
unknow cards on dual technology 152 Renaming threat levels 339
yellow LED flash during control delay 200 Repeat multimedia until acknowledged 49
yellow left LED always on 200 Report (enable passback/occupancy tracking) 99
Rearranging column headers 36 Report AATL when unlocked
Receivers for expansion inputs 188
alarm setup 369 Report access grants 200
Rectangles Report all occupancy violations 101
drawing 510 Report definition files
properties 555 creating 1035
Red LED always on 200 editing 1035
Redirect serial ports 344 exporting 1032
Redraw rate 908 importing 1035
Reduce autogen printout 93 Report DOTL when unlocked 163
Refresh alarms on alarm viewer 429 Report groups 1037
Registering Velocity 3 creating 1037
Relay state changes 97 Report Manager
Relay states cannot open All Events Log by Date report 1200
actuate 249 customization reports 1012
clear 249 customizing with UDFs 1023
disable 249 DIGI*TRAC configuration reports 1012
Relays history logs 1013
actuate during time zone 169 insert company name 1038
auto-clear after time zone 170 person information reports 1014
configuring 167 show company name on report header 1038
control delay time 169 suppress Velocity logo on report header 1038
disable during time zone 170 using UDFs to customize reports 1019
force off 247 Velocity configuration reports 1016
force off release 247 Report manager 1005–1037
force on 246 add new reports 1011
force on release 247 criteria page 1021
general property sheet 168 crystal reports 1033
green LED while active example 992 customizing existing reports 1018
input actuates in control zone 181 definition file exports 1032
input disables in control zone 182 export reports 1032

1309
Velocity Version 3.1 Administrator’s Guide

exporting customized reports 1032 unlock mask state 183

exporting definition files 1032 Reports
exporting reports 1032 assigning to roles 311
flowchart of use 1006 generating diagnostic window 709
freeze pane 1030 schedule printing of 1051
generating a report 1011 see Report manager
icon tool bar 1010 Repositioning Designer icon tool bar 463
importing previously-exported reports 1035 Request-To-Exit
importing reports 1034 see RQE
introduction 1005 Require acknowledgement before clearing 48
list of existing reports 1012 Require entry of note on acknowledgement 49
main screen 1008 Require entry of note on clear 49
opening 1007 Resetting encryption 64
preview screen 1027 Resetting encryption for SNIB2 211
preview screen features 1029 Reshaping objects 483
print reports 1011 Resizing columns and panes 37
printing 1031 Resizing objects 483
report definition files 1035 Resizing screens 15
report groups 1037 Resizing text 15
saving custom reports 1025 Restarting Velocity services 1085
scheduling printing of reports 1051 Restore alarm viewer on new alarm 432
selected criteria list pane 1024 Restore database dialog box 1106
sorting page 1023 general page 1107
Report printer options page 1108
define 50 Restore server extensions 1106
report printing configuration 1053 Restoring Velocity database 1102
Reporting 96 how to 1212
AATL when unlocked 180 Restoring Velocity database to a new computer 1104
access grants 200 Restrict alarms and events using Velocity Roles 1081
advanced setups 97 Restrict by shift 278
contact state change 165 Retrieve recorded DVR video 733
controller 95 Retrigger expansion outputs in control zone 175
daily midnight report disable 96 Retrigger mask
disable 96 for door inputs 162
door contact for inputs 183 Retrigger mask only
DOTL when unlocked 163 for expansion inputs 188
enable ACB 98 for inputs 180
enable contact state change for inputs 183 Retrigger relay and mask
enable mask state change reporting 183 for door inputs 163
enable MCZ 98 Retrigger relays in control zone 161, 165, 170, 182
enable RQE mask state change 183 for expansion inputs 190
entry/exit delay for inputs 183 Return to normal
events 96 see also RTNs
external events disable 96 Reuse deleted codes 46
granted transactions 96 Reuse MATCH with operator override only 46
input mask/unmask because of time zone 183 Reuse PINs with operator override only 46
invalid codes disable 96 RGB model 590
language 96 Rights
line fault for inputs 183 version permissions 1211
lines per page 96 Roles
local printer setup 96 active time zones 290
mask state change 166 add-ins 292
mask tamper when door contact masked 180 application permissions 292
mask/unmask input because of control code 183 application permissions detail 302
on local printer 95 cameras 307
printer transactions 96 central stations 377
relay state changes disable 97 command sets 307
RQE state change for inputs 183 copying 288
tamper for inputs 183 credential templates 307
timezone state changes disable 97 DIGI*TRAC properties 308
transaction events disable 96 door groups 309
TZ driven input masking changes disable 97 enrolling members 310
TZ driver relay state changes disable 97 event viewer filters 309

1310
 MAN006-0612

function groups 309 cleaning 792

graphics 310 configuring for Velocity 787
how to define 287 maintenance 790, 791
how upgrade handles operator permissions 286 testing 792
members 310 ScanShell scanner
partitioning 285 not respondingq 1198
permissions and behaviors 301 Scanshell scanners 789
person groups 311 Scheduled tasks screen 1058
person templates 311 refresh 1058
properties sheet 289 Scheduler wizard
renaming 289 daily 1061
reports 311 monthly 1064
rights vs. permissions 1211 one time only 1066
selecting for emailing reports 1044 weekly 1063
status viewer groups 312 Schedules
time zone limitations on DIGI*TRAC properties 308 holiday 332
video explorer groups 312 Scheduling agent 1039–1072
worksheets 1255–1273 accessing 1040
Rotating objects 485 activating credentials 1041
Row delimiter 392, 400 archiving logs 1041
RPS command set execution 1046
using to configure alarm panels 366 daily dialog box 1061
RQE deleting tasks 1069
enable mask state change reporting 183 dialing remote DIGI*TRAC network 1042, 1043
enabling 162, 179 downloading credentials 1041
enabling for expansion inputs 188 editing existing tasks 1068
overview 185 executing command sets 1046
state change reporting for inputs 183 executing programs 1046
RSS 1082 exporting data 1047
enabling 1083 how to use 1040
RTN importing data 1049
auto acknowledge 48 introduction 1039
RTNs monthly dialog box 1064
customizing events 684 not printing report correctly 1198
point customization 684 one time only dialog box 1066
Ruler bars 452 printing reports 1051
changing 453 properties 1070
Rules & conventions refresh screen 1058
commands 226 report printing configuration 1053
Running tasks manually in Scheduling agent 1067 running tasks manually 1067
scheduled tasks screen 1058
S synchronizing controller clocks 1057
s 1080 task schedule properties 1070
S*NET systems 66 weekly dialog box 1063
S*NET timeout 133 SCIB
SAM (import only) 384 settings 94
SAM database SCM
migrating to Velocity 1211 customizing 1075
SAM database file import wizard 384 enable detailed operator logging 1082
fields that the wizard imports 386 enabling RSS 1083
Saving a photo from enrollment manager to another source restarting 1085
845 using on a client 1074
Saving drawings 492 web server settings 1082
SBMS3-2707A 184 Scramble keypad display 199
SC readers field 877 SCRAMBLE*NET protocol
Scaling drawing 443 see S*NET
Scanners ScramblePads
add new 789 allow user count display 202
auto accept scanned data 790 blink yellow left LED on power failure 200
auto launch on paper detect 790 code tamper disables card or code holder example 990
calibrating 792 code tamper disables credential example 990
capture photo if available 790 code tamper disables user 201
capture signature if available 790 defining passback zones 203

1311
Velocity Version 3.1 Administrator’s Guide

deny codes under duress 202 Server objects

deny under duress example 987 overview 1138
duress without access example 987 server triggers 1138
enable sharing 197 Server roles 1135, 1136
green flash in door delay example 993 introduction 1136
green LED always on 200 Server triggers
green LED flash during door delay 200 overview 1138
green LED on while the relay active 200 Service control manager 1073–1084
green LED while relay active example 992 CCTV settings 1077
options 199 control services 1074
options example 986 customizing 1075
overview 193 database settings 1077
red LED always on 200 diagnostic settings 1079
report access grants 200 DIGI*TRAC network service 1084
scramble keypad display 199 introduction 1073
silent code tamper 201 network settings 1078
silent code tamper example 988 start manually 1073
silent operation 199 Velocity settings dialog box 1076
use keypad numeric LEDs as annunciator 201 Services
yellow flash for control delay example 994 restarting 1085
yellow LED flash during control delay 200 Set threat level 253
yellow left LED always on 200 Sharing ScramblePads 197
Scrolling Shift definition 278
suspend in event viewer 902 Short 1186
Sectors Short-cut keys 25
drawing 509 Show bearer bars 522
properties 557 Show graphics on alarm 601
Secure network interface board 207 Show last access for credentials 767
Security Show quiet zones 522
in SQL database manager 1131 Show splash screen 45
logins 1131 Show UDF field summary 767
overview 1131 Shrink database dialog box 1111
server roles 1136 Shrinking databases 1110
SELECT 1147 Signal type 837
compute clause 1157 Signature capture pads
for browse clause 1158 configuring 786
from clause 1150 Hirsch-approved 787
group by clause 1153 Signatures
having clause 1154 capture dialog box 833
into clause 1150 capture if available through scanner 790
option clause 1159 capturing 833
order by clause 1156 inserting into badge template 513
select clause 1148 Silent code tamper 201
T-SQL 1147 example 988
union operator 1155 Silent operation 199
Views 1161 Site ID 877
where clause 1152 Size page for double-sided printing 441
Selecting an object 479 Sizing the page 442
Semicircles Smart*SNIB
extending arcs to 504 port settings 61
Send objects to back 487 SMES-H 829
Sequence or glossary pane in Velocity help 1198 SMES-M 829
Serial communications interface board 94 SMES-U 829
Serial port redirection 344 SMTP 348
properties 345 Snap to grid 444
redirecting 344 SNIB2
Serial ports backing up encryption 211
designation for enrollment stations 784 configuring 61
Server extensions configuring the 208
email notifications 348 connectivity 60
installing 412 import wizard 403
overview 412 introduction 207
restoring through SQL Server 1106 resetting encryption 211

1312
 MAN006-0612

restoring encryption 1105 see also Views

X*NET 2 69 server objects 1138
SNUX 90 server roles 1136
Software setting up database user accounts 1127
customizing 685 shrink database dialog box 1111
Software configuration 215–332 shrinking databases 1110
Sort alarms by alarm level 49 stored procedures 1118
Sorting by column header 36 tables 1113
Sorting page 1023 users 1127
Special card types 235 Velocity properties screen 1094
Special functions 250 view table properties 1114
deadman timer 251 viewing and modifying stored procedures 1119
indexed commands 252 views 1122
set threat level 253 SQL Server
time log 251 startup timeout 1078
watch log 250 SQL server
Special handling 785 selecting computer 1078
for readers 197 SQL server login properties 1133
Special needs general page 1133
access time extension for credentials 873 server roles page 1135
Special needs access time extension 240 SQL Server Name
Special needs time extension 90, 95 specifying 47
Splash screen modification 5 Square brackets 817
SQL commands 1140–1171 Stamp number 232
INSERT 1140 Standard 2 of 5 525
SELECT 1147 Standard 26-Bit Wiegand 234
SELECT (T-SQL) 1147 Standard 27-Bit Wiegand 235
SELECT (views) 1161 Standard 28-Bit Wiegand 235
UPDATE 1162 Standard 29-Bit Wiegand 235
SQL Database Manager Standard control zones
moving the Velocity database to another domain 1109 basic example 914
SQL database manager 1087–1171 defining 110, 117
adding tables 1115 description 117
backing up SNIB2 encryption 211 properties 113
backing up Velocity database 1096 worksheet 1282
backup database dialgo box 1097 Standard images
basic SQL commands 1140–1171 inserting 511
creating new stored procedures 1120 Standard text
creating new views 1122 inserting 510
database diagrams 1095 Standard time zones
database tasks 1093 H column 326
databases 1092 properties 319
defining multiple backup locations 1101 worksheet 1231
displaying view properties 1125 Start exit timer 243
logins 1131 Startup timeout for SQL Server 1078
main screen 1090 State change reporting
management tasks 1130 for door inputs 165
modifying existing tables 1116 Status
opening 1087 for download monitor 134
opening existing views 1124 Status groups
programmability 1118 column headers 1185
properties 1094 creating 1183
restore database dialog box 1106 properties 1184
restore server extensions 1106 Status line 26, 448
restoring SNIB2 encryption 1105 Status messages 1186
restoring velocity database 1102 active 1186
restoring Velocity database to a new computer 1104 door open 1186
security 1131 inactive 1186
see also Logins masked 1186
see also SQL commands noisy 1186
see also Stored procedures open circuit 1186
see also Tables out of spec 1186
see also Users secure 1186

1313
Velocity Version 3.1 Administrator’s Guide

short 1186 Tagging

unlocked 1186 credentials 888
Status requests for credentials 873
accepting 200 overview 892
Status viewer 1173–1186 Tailgating 104
assigning groups to roles 312 Tamper
columns and rows 1175 reporting fo door inputs 166
how to use 1181 Tamper reporting for inputs 183
main screen 1174 Task schedule screen
opening 1173 properties 1070
right-click options 1181 Task scheduler
status groups 1183 see Scheduling agent
status messages 1186 TCP/IP
tasks 1181 CCTV ports 661
Status viewer groups Technical support iii, 1213
assigning to roles 312 technical support iii
Std 26-Bit Wiegand 866 Temporary days 894
Std 27-Bit Wiegand 866 see Day limiting
Std 28-Bit Wiegand 866 Tenants
Std 29-Bit Wiegand 866 multiple holidays example 962
Stored procedures Terminal servers 68
creating new 1120 Test if secure 244
how to use 1119 Test links 605
overview 1118 Test scanner 792
viewing and modifying 1119 Text
Straight lines bleeding edge 596
see Lines changing characteristics 594
Support databound 511
technical iii edit dialog box 594
Suspend scrolling in event viewer 902 editing 593
Switchers font characteristics 594
configuring 664 font styles 595
inputs/outputs 666 for effects 630
properties 665 inserting in drawings 510
supported 657 properties 559
Switching between drawings 491 standard 510
Switching operators 31 Threat Authority 237
Symbology of barcodes 521 Threat authority
Symbols assign to credentials 871
wildcards 817 Threat levels
Synchronize Velocity database with controllers 1081 example 997
Synchronizing controller clocks 1057 overview 338
System code renaming 339
for keypad programming 92 setting 253
System icons 27 specify for credential templates 237
System report wizard 1201 Threshold time 100
creating 1201 Threshold timer 89
System tree pane 7 Thresholds
expanding and contracting 9 buffer setup 144
System tree window 7 Time increment for each valid reader 100
Time log 251
T Time synchronization 723, 744
Tables Time zone control of relays 249
adding 1115 Time zones 313–329
controlling with SQL database manager 1113 actuate door relay during 160
holiday 332 actuate expansion relay during 174
how to use 1113 actuate relay during 169
modifying existing 1116 attempt redial at start of 142
view data 1113 auto-clear door relay after 161
view properties 1114 auto-clear expansion relay during 175
Tag auto-clear relay after 170
control zones 114 call host at start of 142
controller 90 cancel dial host during 143

1314
 MAN006-0612

changing for door groups 259 entry delay 180

control of relays 249 entry delay for expansion inputs 188
creating on-the-fly 328 entry delay time 163
daylight savings 328 exit delay 180
defining 314 exit delay for expansion inputs 188
deleting 325 exit delay time 163
disable answer during 143 expansion inputs 188
disable door relay during 160 expansion relays 173
disable entry delay during 181, 189 extended access 154
disable entry delay during door input 164 inputs 180
disable expansion relay during 174 invalid penalty 89
disable passback during 99 lockout 89
disable relay during 170 logoff for XBoxes 206
disable two-person rule during 101 mode 90, 180
downloading to controllers 77 mode for expansion inputs 188
effects of DIGI*TRAC roles during specified 290 overview 213
enable card/code-only access during 203 quarter-second relay example 984
examples 325 relays 168
explaining the H column 326 special needs extension 90
grand master properties 323 start exit 243
inputs 181 threshold 89
mask door input during 164 threshold for two-person rule 100
mask expansion input during 189 unmask/start exit 243
mask input during 181 Timezone state changes 97
master properties 322 Tip of the Day 410
master worksheet 1233 Tool Bars
overview 313 console options 22
postpone dial host during 143 Tool Tip Text
properties 318 using mouse rollover 689
report input masking changes driven by 97 Tool tip text 688
report mask/unmask input because of 183 Topology object mapping 647
report relay state changes driven by 97 Total timeout constant
standard properties 319 lease-line configuration 66
standard worksheet 1231 total timeout constant 66
state changes 97 Total timeout multiplier 66
unmask input at the end of 181 Tours 672
what is 1208 Trailing zeroes on dual 152
which being used 1199 Transaction events 96
which to download 1199 Trigger 246
Timed anti-passback 203 Trigger Action Manager
Timeouts report 1017
local keypad programming 92 Trigger action manager
S*NET 133 action page 1191
Timers add trigger action screen 1189
AATL 180 adding trigger actions 1188
AATL for expansion inputs 188 deleting trigger actions 1189
AATL warning 180 editing trigger actions 1189
AATL warning for expansion inputs 188 summary screen 1187
alarm relay 93 trigger page 1190
calculating for two-person rule 107 Trigger action summary screen 1187
control delay 169, 213 Trigger actions
control mode 168, 213 adding 1188
deadman 251 deleting 1189
delay 90 editing 1189
disable entry delay during TZ 181 Trigger expansion outputs in control zone 175
door 213 Trigger mask only
door control delay 159 for expansion inputs 188
door control mode 159 for inputs 179
door delay 158, 159, 214 Trigger page 1190
door input 163 Trigger relay and mask
door mode 158 for door inputs 162
DOTL 90, 163 Trigger relays in control zone 161, 165, 182
DOTL warning 163 in expansion inputs 190

1315
Velocity Version 3.1 Administrator’s Guide

Triggered Video Explorer window 52 specifying the number of 778

Triggers using as criteria for reports 1023
server 1138 using to customize reports 1019
Troubleshooting 1197–1213 UL listings iv
can’t move focus 1199 UL requirements iv
cannot open all events log by date report 1200 Unassign credentials 889
client does not talk to server 1198 Unassigning credentials 807
client loses network connection 1199 Unbundling doors 146
component folder in Customization manager depopulated Underscore sign (_) 817
1200 Undoing an action in Designer 491
error in Event Viewer when configuring second controller Ungrouping objects 488
through dial-up 1200 Unknown cards on dual 152
event viewer displays incorrect base relay events 1198 Unlock door 242
frequently asked questions 1208 extended 242
how do I... 1203 Unlock reporting 183
My Velocity 1200 Unlocking workstations 32
not printing report through Scheduling Agent 1198 Unmask alarms 242
Q & A 1198 Unmask for inputs 246
scanner error message 1200 Unmask input at the end of time zone 181
ScanShell scanner not responding 1198 Unmask/start exit timer 243
system report wizard 1201 Unplanned holidays
technical support 1213 example 970
time zone reporting 1199 UPC shipping container code 524
timeout messages in event viewer 1199 UPC-A 524
which time zones being used 1199 UPC-E 524
wireless tablet PC disconnects unexpectedly 1200 UPDATE 1162
TWAIN capture 838 Update image 843
FlashBus setup 839 Updating CCM firmware 712
setup dialog box 838 Upgrade program
Two-person rule 894 how it handles operator permissions 286
A/B rule 108 USB ports
A/B Rule A 238 replacing COM with 1210
A/B Rule B 238 Use 24-Hour format 45
assigning for credential templates 238 Use count 894
calculating time 107 example 930
controller stups 100 overview 890
description 106 Use keypad numeric LEDs as annunciator 201
disable during time zone 101 Use Limiting 237
example 980 Use limiting 890
executive override 108, 238 assigning 237
explanation 106 example 930
for credentials 872 for credentials 871
number of people inside disable 101 User cannot change password 277
rule variations 108 User defined setup
supervisor/trainee rule 108 number of UDFs 778
threshold time 100 User must change password at next logon 277
time increment for each valid reader 100 User-defined fields
TZ driven input masking changes 97 additional images 781
TZ driven relay state changes 97 changing 776
customizing field size 798
U field caption 779
UCC/EAN shipping container code 524 image placeholders 781
UCC/EAN-128 526 property definitions 648
UDF 527, 532, 550, 553, 557, 560, 563 see UDF
assigning properties 649 setup 778
property definitions 648 setup screen 778
UDFs worksheets 1251–1254
auto mappinjg 796 User-defined setup 778
mapping fields 789, 795 additional images 781
remove mapping 797 Users
see also Field types basic example 916
setting field types 779 count other side 254
show field summary for 767 forgive 891

1316
 MAN006-0612

forgive all 254 restoring database to a new computer 1104

global management 895 restoring database with SQL database manager 1102
global management example 931 Scheduling agent 1039–1072
in SQL database manager 1127 service control manager 1073–1084
management 894 setting up fire alarm system in 369
management examples 927 settings dialog box 1076
setting up database accounts in SQL database manager SQL database manager 1087–1171
1127 SQL database manager properties 1094
Using fields and tools 29 status viewer 1173–1186
Using the mouse and keyboard 29 troubleshooting 1197–1213
Using the mouse and keypad 29 using programs 38
Using Velocity fields and tools 30 what are services 1208
Using Velocity programs 38 worksheets 1221–1284
XML data output 360
V Velocity configuration 215–332
Validate immediately CCOTZ 91 command sets 216
Validate on dual CCOTZ 91 credential management 894–895
Variable field names credential templates 228
inserting 582 door groups 257–262
VBDs function groups 265–881
exporting 598 holidays 330–332
VBTs operators 275–281
exporting 598 overview 215
VDO folder 470 roles 287
Vector images 512 time zones 313–329
Velocity Velocity configuration folder 9
administration main screen 7 Velocity configuration reports 1016
Badge & Graphic Designer 437–655 Velocity data export wizard 390
browser 1001 choose destination 391
CCTV configuration 657–670 customizing export files 393
CCTV settings 1077 data export results 395
customization manager 677–701 select destination file format 392
data export wizard 390 Velocity data import wizard 397
data import wizard 397 data import results 399
database settings 1077 data source 399
diagnostic settings 1079 manual mapping 402
diagnostic window 703–709 map data fields 401
DTNS 1084 select file format 400
enrollment manager 761–895 Velocity database
event viewer 899–911 moving to another domain 1109
examples 913–998 Velocity desktop
exiting 5 placing alarm viewer on 435
exporting data 1047 Velocity icon tool bar 18
fields and tools 30 Velocity objects
hardware configuration 55–214 designing 619
hot keys 25 editing 622
how to configure a system 42 importing 503
import/export wizards 381–400 Velocity settings
importing data 1049 advanced 1081
installing on company network 1209 using OUs 1079
main menu 6 web server 1082
managing desktop space 33 Velocity settings dialog box 1076
managing windows 33 CCTV settings 1077
menu tool bar 20 database settings 1077
migrating from SAM database to 1211 diagnostic settings 1079
mouse and keyboard 29 network settings 1078
navigating 29 Video
network settings 1078 export DVR 740
partitioning 285 retrieve recorded 733
preferences 44 Video capture 836
registration 3 dialog box 837
report manager 1005–1037 signal 837
restarting services 1085 Video dialog box 837

1317
Velocity Version 3.1 Administrator’s Guide

Video Explorer main screen 1217

enable triggered 52 overview 1215
enabling triggered window 52 pause button 1218
permissions required for viewing triggered 1194 persons inside pane 1219
Video explorer 731 reassigning credentials 1220
assigning groups to roles 312 refresh screen 1217
drag and drop with 745 resume button 1218
Video explorer groups right-click functions 1219
assigning to roles 312 start polling button 1218
Video record rate 722 status indicator 1218
VideoEdge NVR 721 stop polling button 1218
View DVR camera video 728 zone tree pane 1218
View groups 745 Wiegand hex pass-through 196
Viewer Wiegand types 231
CCTV 671 Wildcard symbols 817
Viewing instructions for an alarm 429 % 817
Viewing maps for alarms 429 square brackets 817
Views underscore 817
creating new 1122 Windows NT authentication
displaying properties 1125 with SQL database manager 1133
how to use 1122 Wireless tablet PC
introduction 1122 disconnects unexpectedly 1200
modifying existing 1125 Wizards
opening existing 1124 add hardware 137
overview 1122 add printer 762
VIO folder 469 badge template migration 382
VIOs CCM import 388
designing 619 customization import/export 700
edit behavior 633, 637 export 381–400
edit behavior for groups 633 import 381–400
editing 622 install new modem 139
example 637 SAM database file import 384
exporting 598 SNIB2 export 403
importing 503 Velocity data export 390
using integration builder 628 Velocity data import 397
worksheet 1284 WMF 597
Virtual relays 172 exporting 598
defining 176 Worksheets 1221–1284
overview 175 badge template design 1225
using controllers with 177 credential templates 1245–1250
VSOs door groups 1235–1237
designing 619 enrollment 1239–1254
editing 622 enrollment additional images tab 1243
importing 503 enrollment for function groups 1240
enrollment for momentary access 1239
W Enrollment general tab 1241
Watch log 250 Enrollment groups tab 1242
WAV file function groups 1238
replaying 428 general information 1224
WAV files holidays 1234
assigning to events 697 introduction 1221
attaching to alarms 682, 691 M16 controller 1229
Web server 1082 M1N controller 1226
RSS 1083 M2 controller 1227
Weigand card types 235 M8 controller 1228
When occupancy... 102 master control zones 1283
Who’s Inside master time zone 1233
alternative method for using 1216 MSP controller 1230
displaying credentials 1216 operators 1280–1281
example 999 person templates 1276–1279
forgiving credentials 1219 roles 1255–1273
hide zones 1217 standard control zones 1282
how to use 1216 standard time zone 1231

1318
 MAN006-0612

system qualification 1224

user-defined fields 1251–1254
VIO preparation 1284
Workstations
adding 334
auto-locking after idle time 278
locking 32
locking down 335
overview 334
PDA client 334
unlocking 32
unlocking locked 335
XML interface client 334
Writing fingerprints to a credential 878

X
X*NET 2 69
X*NET systems 69
XBox
functionality using SNIB2 208
X-Box command 5 complete 1200
XBoxes 69
adding 205
enabling 206
how many controllers 1210
logoff time 206
messages per poll 206
modifying 205
overview 204
properties 206
revision number 206
substituting SNIB2s 69
XML
adding client interface 334
translating Velocity data to 360
XML Writer 360
configuring 361
installing 361
properties 362
XNET 2 211

Y
Yellow LED flash during control delay 200
Yellow left LED always on 200

Z
Zoned passback
example 943

1319