Cisco Physical Access Manager Appliance User Guide, Release 1.1.0
Configuring Door and Device Templates
Downloads: This chapterpdf (PDF - 2.69MB) The complete bookPDF (PDF - 36.19MB) | Feedback

Configuring Door and Device Templates

Table Of Contents

Configuring Door and Device Templates

Contents

Creating Custom Gateway Configurations and Templates

Configuring Door Templates

Configuring Device Templates

Creating a Device Template

Configuring Credential Templates

Credential Templates Settings Overview

Wiegand Keypad

Wiegand

Keypad

Creating a Credential Template

Configuring Reader LED Profiles

Configuring Reader LED and Buzzer Profiles

Door Configuration Properties

Device Configuration Properties


Configuring Door and Device Templates


This chapter describes how to create and modify door and device templates. Device templates define common settings for device types, such as Gateways, readers and locks. Door templates define common settings for door configurations, including the devices that are attached to the door.

See Chapter 7, "Understanding Door Configuration" for more information.

Contents

Creating Custom Gateway Configurations and Templates

Configuring Door Templates

Configuring Device Templates

Configuring Credential Templates

Configuring Reader LED Profiles

Door Configuration Properties

Device Configuration Properties

Creating Custom Gateway Configurations and Templates

Door configurations are sets of door device hardware assigned to a Gateway module. To create a door, a Gateway configuration must be available. The Gateway templates allow you to quickly populate the Gateway configuration.

To view the existing templates, select Gateway Templates from the Doors menu (in the Templates sub-menu).

Figure 9-1 shows the main window. The default Gateway templates cannot be changed. Only user-created templates can be modified.

Figure 9-1 Gateway Templates Main Window

Complete the following instructions to create a custom Gateway configuration, and then save it as a template. You can also clone the configuration for use with another Gateway.

 
To do this
Use this display

Step 1 

Open the Hardware module in the Device view.

a. Select Hardware from the Doors menu.

b. Select Device from the View menu.

Step 2 

Add a Gateway module.

a. Right-click the Access GW Driver.

b. Select New Gateway Controller.

Step 3 

Select No to configure the Gateway without using a template.

Click Next to continue.

Step 4 

Enter the basic Gateway properties.

a. Name: enter a descriptive name to identify the Gateway module.

b. Serial Number: enter the serial number. See Locating Serial Numbers, page 7-23.

c. Location: the assigned location of the module. See Creating the Location Map, page 7-6.

d. Time Zone: select the time zone for your system.

e. Daylight Savings: select True if Daylight Savings time is observed.

f. Click Next to add additional expansion modules.

or

Click Finish to create the Gateway controller (the default module) without adding additional modules.

Step 5 

(Optional) Specify the expansion modules that are attached to the Gateway.

Note This step is only required if expansion modules are installed. If additional modules are not installed, click Finish.

Note The default module is the Gateway.

a. Name: enter a descriptive name to identify the Gateway module.

a. Serial Number: enter the serial number. See Locating Serial Numbers, page 7-23.

b. Module Type: select Reader, Input, or Output.

c. Reader Connection Mode: (Reader modules only) select if the device supports one or two reader connections.

d. Click Add. The expansion module is added to the list.

e. Repeat these steps for each additional module.

f. Click Finish to save the changes and close the window.

Tip To modify the module list, select a module and click Edit or Remove.

Step 6 

(Optional) Add devices to the Gateway or expansion module interfaces.

Note Devices are usually added when configuring a door. See Chapter 8, "Configuring Doors".

a. Expand the hardware tree to view the Gateway or expansion module interfaces.

b. Right-click an interface and select the device for the interface. For example: New REX.

c. In the device window, select Properties and enter the device settings.

Select a Template name to populate the fields.

To override the template settings, deselect the Default checkbox next to each field.

To restore the default template setting, re-select the Default checkbox.

d. Click Save and Close.

e. Repeat these steps for each device connected to the Gateway.

Step 7 

Apply the configuration changes to download the new settings to the devices.

Update All Gateways

Right-click the Access GW Driver and select Apply Configuration Changes. The command is applied only to Gateways in the Up state.

Update a Single Gateway

Right-click the Gateway and select Apply Configuration Changes. The command is available only for Gateways in the Up state.

Step 8 

(Optional) Create a Gateway template from the new configuration.

Right-click on the Gateway Controller and select Save As Gateway Template. Enter a name for the template and click OK. The new template is displayed in the main Gateway templates window (see Figure 9-1)

Select Clone Gateway to create an exact copy of a Gateway configuration for a single Gateway. See Cloning a Gateway Configuration, page 8-26.

Step 9 

(Optional) Add the door configuration that use the ports on the Gateway. See Configuring Doors, page 8-2.

Configuring Door Templates

Use door templates to create sets of hardware that can be applied to multiple doors. For example, you can create a template that includes a door swing for use with ADA-enabled doors, or a deadbolt for doors that require extra security. See Chapter 7, "Understanding Door Configuration" for more information.

Figure 9-2 Door Templates Main Window


Note The default templates are read-only. Only user-created door templates can be modified.


To create or modify a door template, do the following:

 
To do this
Use this display

Step 1 

Select Door Templates from the Doors menu, in the Templates sub-menu.

Step 2 

Click Add, or select an existing template and click Edit.

Tip You can also right-click an entry and select Add, Edit, or Delete.

Step 3 

Click the General tab and enter the Name and Description for the template.

Step 4 

Select the devices for in the door template:

a. Select the Devices tab.

b. Click Add to add a new device or select an existing device from the list and click Edit.

c. Select the Device Type. For example: Lock, Reader, etc.

d. Select the Template. Only the templates for the device type are displayed. For example, if the device type is Reader, then only reader templates are displayed. See Configuring Device Templates for instructions to create and modify the available templates.

e. Repeat these steps to add additional devices, if necessary.

f. Click Next to continue.

Step 5 

Define the door mode and schedule:

a. Default mode: select the default door mode. The door remains in this mode at all times except when a schedule is defined.

Open: the door is held open and the lock is in unlocked state.

Close: the door is physically closed and the lock is in unlocked state.

Lock: the door is physically closed and the lock is in Locked state.

Secure: the door is locked and the deadbolt is applied.

See Door Modes, page 8-34 for more information.

b. Door enable schedule: (optional) select a door schedule. If you select None, then the door will remain in the Default mode at all times. If you select a schedule, the schedule will override the default mode for the times and days defined in the schedule. See Using the Schedule Manager, page 11-9 to add or modify the available door schedules.

c. Scheduled door mode: select the door mode when the door scheduled is applied.

For example if the Default mode is Lock, and the scheduled door mode is Close, then the door will be locked at all times except during the hours and days defined by the schedule selected in Door enable schedule.

d. First Unlock: select First Unlock to activate the door schedule only on the first successful badge swipe. The door remains in default mode until a badge is used to access the door, even after the beginning time for the schedule. This is useful in situations such as snow days to ensure the door is not opened until a badge holder is physically present.

Step 6 

Enter the additional Door Properties:

Relock interval time(s): the number of seconds to keep the door open upon grant access.

Door held open time(s): the number of seconds before DoorHelpOpen alarm is generated.

Deadbolt engage delay(s): the delay (in seconds) after a door closes until the deadbolt is applied.

If badge not in gateway: the action taken by the Gateway if the badge is not in the Gateway database.

Access decision on timeout: the action taken by the Gateway if there is no response within Server access timeout.

If server unreachable: the action to be taken by gateway in case it cannot reach Cisco PAM.

Server access timeout(s): the time before an action is taken based on Access decision on timeout.

ADA timespec multiplier: the multiplier used on Relock interval time if an ADA access occurs.

Door swing activation delay (s): the amount of time, in seconds, before the door swing is activated. This setting allows time for the door lock or other devices to activate before the mechanical door swing activates.

Door swing usage:

Always operate: the door swing activates for all access requests.

Operate for ADA only: the door swing operates only for requests from an ADA device.

Do not operate: the door swing does not operate.

Step 7 

Enter the door Usage Profiles used by the reader device(s). These profiles define what LED or buzzer action occurs under the following events:

Grant access: the LED display when normal access is granted.

Grant access ADA: the LED display when access is granted for an ADA enabled badge.

Deny access: the LED display when access is denied.

Grant facility code: the LED display when access is granted based on a Facility Code.

Mode open: the LED display when the door mode is Open.

Mode close: the LED display when the door mode is Close.

Mode lock: the LED display when the door mode is Lock.

Tip See Configuring Reader LED and Buzzer Profiles for more information

Step 8 

Enter the Facility Code Info:

Click Add to add a credential template and facility code.

Each card format has a facility code associated with the card. All the card formats used with the door must be specified. The Gateway can also be configured to use facility codes during Server Unreachable and Server Access Timeout if necessary.

Step 9 

Enter the Duress Specifications.

Click Add to add an alarm type and code.

Step 10 

Click Save and Close to save the template and close the window.

Configuring Device Templates

Device templates are pre-defined configurations for the device types using in door configurations. Device templates are used to create door templates, or they can be applied directly to a Gateway interface.

This section includes instructions to create device templates.


Note Most settings in the default templates are read-only. Only user-created door templates can be modified.


Figure 9-3 Device Templates Main Window

For more information, see Chapter 7, "Understanding Door Configuration" and Chapter 8, "Configuring Doors".

Creating a Device Template

Use the Device Template Wizard to create a new device template.

 
To do this
Use this display

Step 1 

Select Device Templates from the Doors menu, in the Templates sub-menu.

Step 2 

Select Add..., and then select Device Template Wizard.

Tip You can also right-click on a template name to access the Edit and Delete functions.

Step 3 

Select the Device Template Type, and then click Next.

Step 4 

Enter the device settings. This example is for a REX device. The fields available vary depending on the device type.

a. Enter the template Name.

b. Enter the device settings. See Device Configuration Properties for detailed information about the options for each device type. The settings are different for each type of device.

c. Click Finish to save the template and close the window.


Configuring Credential Templates

Create templates define the settings for credential devices, such as Wiegand readers and keypads. Credential templates are applied to reader devices or to door templates.

When an access control card is presented to a reader, the reader reads a set of bits. The reader needs to know how to interpret the bits, how to validate the data, and how to extract relevant card information. Credential Templates specify the card data format for a reader, and are used to configure reader device templates.

The data specification include the following:

Card data fields and data range

Parity bits and their bit position for data validation

Marker bits and their bit positions/range using sentinels

Each credential template has Primary and Secondary Data fields to determine how the card data is extracted. See Credential Templates Settings Overview for a configuration overview.


Note Credential templates with the same length in bits for the Primary data cannot be associated with the same reader device; the templates must be associated with different devices. However, credential templates with different length in bits for the Primary data can be associated with the same reader device.


Figure 9-4 Credential Templates Main Window

Credential Templates Settings Overview

Cisco PAM supports credential templates for the following:

Wiegand Keypad

Wiegand

Keypad

The template is based on the type of Reader.

Wiegand Keypad

The keypad data is transported using the Wiegand protocol (when the user enters a pin on the keypad, the data is transported to the reader in the Wiegand frame). The credential template has two decoding configurations.

The first decoding configuration (Primary) specifies how to extract the pins data entered by the user.

Once the pins data is extracted, the second decoding configuration (Secondary) specifies how to extract each pin, by specifying the total length, length of each pin, parity etc.

For example, the 26BitWiegandKeypadCT.

Wiegand

Card data is transported over Wiegand protocol. When the user swipes or flashes the badge, the card data is transported to the reader in the Wiegand frame. Only the first decoding configuration (Primary) is required to specify the extraction of card data fields such as Card ID, Facility, Site, and Other. Parity and sentinel is used to validate the data.

For example, the 26BitWiegandCT.

Keypad

The keys pressed by a user are directly transported to the reader, so only the Primary decoding configuration is required.

For example, the KeyPad_BCD4.

Creating a Credential Template

 
To do this
Use this display

Step 1 

Select Credential Templates from the Doors menu, in the Templates sub-menu.

Step 2 

Select the General tab, enter the Name and Description of the template.

Step 3 

Enter the Primary Data and Secondary Data settings for the template.

See Credential Templates Settings Overview for more information.

Note Credential templates with the same length in bits for the Primary data cannot be associated with the same reader device; the templates must be associated with different devices. However, credential templates with different length in bits for the Primary data can be associated with the same reader device.

Step 4 

Click Save and Close to save the template and close the window.

 

Configuring Reader LED Profiles

Reader LED Profiles define the LED lights and buzzer on the reader interface of a Gateway or Reader module. The profiles are used to configure the Usage Profiles in door templates. The profiles can also be applied to reader interfaces in the Hardware module.

Figure 9-5 Reader UI Profile Main Window

Configuring Reader LED and Buzzer Profiles

The reader interface provides up to three output lines to control connections for LEDs or a buzzer. A typical reader includes connections for the red LED, green LED and a buzzer. Most readers use only one or two of these.

Complete the instructions below to configure LED profiles.

 
To do this
Use this display

Step 1 

Select Reader LED Profiles from the Doors menu, in the Templates sub-menu.

 

Step 2 

Create or edit the profile:

a. Click Add..., or select an existing profile and click Edit. (You can also right-click on an item to access the Add, Edit and Delete functions.)

b. Enter the profile Name.

c. Enter the profile settings:

Command: defines the state of the output when the profile is invoked (Output On or Output Off).

Duration: specifies how long the output is turned on and off.

Repeat: specifies the number of times the output is turned on and off.

On time (ms) and Off time (ms): specifies how long the output is ON or OFF, in milliseconds.

Step 3 

Click Save and Close to save the profile and close the window.

Door Configuration Properties

The following properties are configured for a door template and configuration:

Field
Description

Relock interval time(s)

the number of seconds to keep the door open upon grant access.

Door held open time(s)

the number of seconds before DoorHelpOpen alarm is generated.

Deadbolt engage delay(s)

the amount of time to wait (in seconds) after the door closes to engage the deadbolt.

Scheduled door mode

The schedule set when a door scheduled is applied in Door enable schedule.

For example if the Default mode is Lock, and the scheduled door mode is Close, then the door will be locked at all times except during the hours and days defined by the schedule selected in Door enable schedule.

Door enable schedule

The schedule to be used by Door.

If you select None, then the door will remain in the Default mode at all times and days. If you select a schedule, the schedule overrides the default mode for the times and days defined in the schedule.

See Using the Schedule Manager, page 11-9 to add or modify the available door schedules.

First unlock

Activates the door schedule on the first successful badge swipe (during the scheduled time span). If the door is not physically accessed, then the door remains locked. Also known as "Snow day".

Note The door remains in default mode until a badge is used to access the door, even after the beginning time for the schedule. This is useful in situations such as snow days to ensure the door is not opened until a badge holder attempts to enter the door.

Default mode

The door mode used in non - scheduled times. The door remains in this mode at all times except when a schedule is defined.

Open: the door is held open and the lock is in unlocked state.

Close: the door is physically closed and the lock is in unlocked state.

Lock: the door is physically closed and the lock is in Locked state.

Secure: the door is locked and the deadbolt is applied.

See Door Modes, page 8-34 for more information.

If badge not in gateway

the action taken by the Gateway if the badge is not in the Gateway database.

Access decision on timeout

the action taken by the Gateway if there is no response within Server access timeout.

If server unreachable

the action to be taken by gateway in case it cannot reach Cisco PAM.

Server access timeout(s)

the time before an action is taken based on Access decision on timeout.

ADA timespec multiplier

the multiplier used on Relock interval time if an ADA access occurs.

Door swing activation delay (s)

The amount of time, in seconds, before the door swing is activated. This setting allows time for the door lock or other devices to activate before the mechanical door swing activates.

Door swing usage

Select one of the following:

Always operate: the door swing activates for all access requests.

Operate for ADA only: the door swing operates only for requests from an ADA device.

Do not operate: the door swing does not operate.


Device Configuration Properties

Table 9-1 describes device settings for common device types.


Note Normally open (NO) contacts connect the circuit when the relay is activated; the circuit is disconnected when the relay is inactive.
Normally closed (NC) contacts disconnect the circuit when the relay is activated; the circuit is connected when the relay is inactive.


Table 9-1 Device Configuration Properties

Device
Properties

Deadbolt

Name: The template name.

Model: The device model.

Vendor: The device vendor or manufacturer.

Description: A text description of the device.

Door Swing

Name: The template name.

Model: The device model.

Vendor: The device vendor or manufacturer.

Description: A text description of the device.

Trigger Time (sec): The number of seconds that power is applied to operate the door swing.

Door Sensor

Sensor input: The type of device contact:

Normally Open: the device is normally open.

Normally Closed: the device is normally closed.

Supervised: Defines if the device is supervised or unsupervised.

Device state: The default state of the device.

Duress Sensor

Sensor input: The type of device contact:

Normally Open: the device is normally open.

Normally Closed: the device is normally closed.

Supervised: Defines if the device is supervised or unsupervised.

Sensor state: The default state of the device.

Fire Sensor

Sensor input: The type of device contact:

Normally Open: the device is normally open.

Normally Closed: the device is normally closed.

Supervised: Defines if the device is supervised or unsupervised.

Device state: The default state of the device.

Generic Input Device

Normal state: The type of device contact:

Normally Open: the device is normally open.

Normally Closed: the device is normally closed.

Supervised: Defines if the device is supervised or unsupervised.

Device state: The default state of the device.

Generic Output Device

Name: The template name.

Model: The device model.

Vendor: The device vendor or manufacturer.

Description: A text description of the device.

Activation Time (ms): When the command Timed Activate Relay is invoked, this property defines the number of milliseconds the generic output is activated.

Note In Cisco PAM Release 1.1.0 and higher, generic output and lock devices must use the physical wire connections to the Gateway or expansion module to define if the device is normally open or normally closed. In Cisco PAM Release 1.0.3 or earlier, this setting could also be made in software. If you are upgrading from Cisco PAM Release 1.0.3 or earlier, verify that devices are correctly wired to the module as normally open or normally closed. See Cisco Physical Access Gateway User Guide for more information.

Glass-Break

Sensor input: The type of device contact:

Normally Open: the device is normally open.

Normally Closed: the device is normally closed.

Supervised: Defines if the device is supervised or unsupervised.

Sensor state: The default state of the device.

Lock

Name: The template name.

Model: The device model.

Vendor: The device vendor or manufacturer.

Description: A text description of the device.

Note In Cisco PAM Release 1.1.0 and higher, generic output and lock devices must use the physical wire connections to the Gateway or expansion module to define if the device is normally open or normally closed. In Cisco PAM Release 1.0.3 or earlier, this setting could also be made in software. If you are upgrading from Cisco PAM Release 1.0.3 or earlier, verify that devices are correctly wired to the module as normally open or normally closed. See Cisco Physical Access Gateway User Guide for more information.

Power Fail

Normal state: The type of device contact:

Normally Open: the device is normally open.

Normally Closed: the device is normally closed.

Supervised: Defines if the device is supervised or unsupervised.

Power fail state: The default state of the device.

REX

Note REX is an abbreviation for request to exit. A REX is a type of door hardware, typically a button that allows people to exit through an access point without using a badge.

Rex input: The type of device contact:

Normally Open: the device is normally open.

Normally Closed: the device is normally closed.

Device state: The default state of the device.

Supervised: Defines if the device is supervised or unsupervised.

Push button: Indicates a push button type of REX.

Push button type: Indicates the kind of push button REX.

ADA enabled: Indicates if ADA is enabled or not. If ADA is enabled, ADA timespec multiplier property is applied on the door when REX is activated.

Reader

Reader type:

Card Reader

Card and Keypad Reader

Keypad Reader

Protocol: Only Wiegand is supported.

Data format: Only Standard Wiegand is supported.

Credential template: Set of credential templates to be used to validate the cards presented to this reader.

Category: Entry or Exit reader.

Reader connector: Type of connector Ten Wire/Five Wire

Use hold pin: Flag specifying if the Hold control line is part of the Reader. Not all readers have or use the Hold control line.

Credential order: If the reader is a Card and Keypad Reader this field specifies the credentials order.

Maximum timeout (sec): If the reader includes a keypad, this field specifies the maximum time to wait for the user to enter the pins using the keypad.

ADA enabled: Specifies if it is an ADA enabled reader. If ADA is enabled, the ADA timespec multiplier door property is used when a valid card with ADA flag set is presented to the reader.

Number of duress keys: If the reader has a keypad, this field specifies the length of duress key. If the duress key or triggers as configured on the door is "89898", then the value of this field is 5.

Number of pin keys: If the reader has a keypad, this field specifies the length of the pin to expect.

Keys buffered: Specifies if the pins entered are transferred in one frame (keys buffered) or in individual frames (keys not buffered). This is field is set based what is supported by the reader/keypad.

Tamper

Tamper input: The type of device contact:

Normally Open: the device is normally open.

Normally Closed: the device is normally closed.

Supervised: Defines if the device is supervised or unsupervised.

Tamper state: The default state of the device.