Cisco Physical Access Manager Appliance User Guide, Release 1.3.0

Step 1 

Select Quick Launch from the Events & Alarms menu, in the Monitoring sub-menu. The Quick Launch window opens.

Note The Quick Launch window appears blank on first use since no Quick Launch icons have been created.

.

Step 2 

Select Add Widget.

Step 3 

Select a widget type to create a Quick Launch button.

The widget types include:

•Open Module: creates a button that opens a Cisco PAM module window.

•Device Command: creates a button that executes a command for a door or device. For example, grant access to a door.

•Label: Creates a text label used to organize Quick Launch buttons into rows and columns.

Step 4 

Select the row and column where the button will appear in the Quick Launch window.

Select the Locations tab and enter the row and column number.

Note If another button already exists in that location, the existing button location automatically shifts to the right.

Step 5 

Enter the text label for the button. You can also optionally select a custom icon image.

Note If the widget type is Label, enter only the label text, then skip to Step 10.

a. Click the Appearance tab.

b. Label: select the text label for the button.

–Default: the default text. For example, the name of the device and command.

–None: no text label. Only the icon image appears. If no icon image is selected, a blank button is displayed.

–Custom: enter a custom name for the button.

c. Image: (Optional) Select a button icon image.

–Default: the default icon image.

–None: no button image. Only the text label appears. If no label is selected, a blank button is displayed.

–Custom: click choose to select a custom image file.

Step 6 

If the widget type is Open Module, select a module:

a. Click the Open Module tab.

b. Select the Cisco PAM module that will open when the Quick Button is clicked.

c. Click OK.

d. Skip to Step 10.

Step 7 

If the widget type is Device Command, select the door or device for the command:

a. Click the Device Command tab.

b. Select the device(s):

•Single: click Choose and select a single device or door from the Hardware view, as shown in the example to the right.

•Multiple (by filter) of type: select a device type from the drop-down menu. For example, select deadbolt to select all deadbolt devices in all doors. To refine the selection, click Filter and select the filter options.

•Multiple (by group) of type: select a device group from the drop-down menu. Groups include:

–Access Point

–Door: select a Door Group. See Configuring Device Groups, page 6-28.

–Monitor Point

–Monitor Point Group

Step 8 

Select a command for the door or device(s):

a. Select Choose.

b. Select a command from the list. For example, Deactivate Access Levels.

c. Click OK.

Tip See Device and Driver Commands, page 6-34 and Door Modes and Commands, page 6-39 for command descriptions.

Step 9 

a. Click Choose to select the Parameters for the command, if required.

If Choose is shown in black, you must click the button to continue. Select a parameter from the list. If the message "Are you sure you want to continue?" appears, click OK. This message indicates that a parameter is not required.

b. Click OK. The new button appears on the main Quick Launch page.

Step 10 

(Optional) Repeat these steps to create additional quick launch buttons, or organize the buttons in the current panel (window).

•To edit an existing button (widget), right-click the button, select Edit, and edit the properties as necessary.

•To move the buttons on the page, do one of the following:

–Right-click the button and select Move Left, Move Right, Move Up, or Move Down.

–Right-click the button, select Edit and then Location to select the row and column.

or

Step 11 

(Optional) Create panels (windows) of related buttons.

Step 1 

Enable the Edge Policy menu.

a. Select System Configuration from the Admin menu.

b. Select the Cisco Setting tab.

c. Select the check box Enable "Edge Policies" Module.

d. Click Save.

e. Log out and log back in to the Cisco PAM application to activate the changes (select Logout from the Options menu).

Step 2 

Select Doors > Edge Policies > Edge Policy.

Step 3 

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

Step 4 

Enter a name and description for the rule.

Tip Select or de-select Enabled to activate or deactivate the policy.

Step 5 

Define the Trigger type.

The trigger defines the event (such as Door Grant Access) and the devices (such as a Gateway) for the trigger. When the specified event occurs on the specified device, the Edge Policy action is triggered.

Release 1.3 supports event triggers only.

a. Match—Select Any trigger.

b. Type—Select Event.

Step 6 

Define the Trigger.

The trigger defines an event that occurs on a device. When this triggers occurs, the action for the Edge Policy is invoked.

a. Click Add New to select the event and device(s) used to trigger the rule.

Tip You can also use the Add available button to choose a previously defined trigger (condition). To create, edit or delete the saved triggers, select Doors > Edge Policies > Conditions.

b. Enter the General properties:

–Name—enter a meaningful name. For example, Access Lobby Door.

–Description—enter the trigger description. For example, Access door event at lobby door.

c. Select Event and select the event for the trigger.

–Select an available event from the left column.

–Click the arrow to move the event to the right column.

d. Select Devices and select the devices that the event must occur on.

–Filter by—select the device. For example, Gateway.

–Device Type—shows the available device types. For example, Door.

–Select—highlight a device in the Available column, and click the arrow to move it to the Selected column.

–Device(s)—lick Choose and select an available device (such as a Door) and move it to the Selected field.

e. Verify that the selected device name appears in the Devices field.

f. Select Save and Close.

Step 7 

Select the Action that occurs when the condition(s) are met.

•URL Action—select a URL Action that will occur when the conditions are met. See the "Configuring URL Actions" section on page 12-2. The URL action must be an Edge action type.

Note For Cisco VSM video recording, use create a soft trigger event in VSM to generate the URL used to record video. Enter that URL in the URL action.

Step 8 

Click Save and Close to save the changes. The new or revised policy is displayed in the main window.

Tip Click the Enabled check box to activate or deactivate the policy.

Step 9 

Select Apply Configuration Changes on the affected Gateway to activate the rule.

Note Gateways must be in the Up state, signified by a green triangle in the icon. A dark green triangle means configuration changes that have not been applied.

You can apply changes using either the Hardware or Locations & Doors module:

Hardware module

•Right-click the Access GW Driver and select Apply Configuration Changes to download configuration changes for all Gateways.

or

•Right-click on a Gateway Controller and select Apply Configuration Changes to download configuration changes for a single Gateway.

Locations & Doors module

a. Select Gateway Controllers from the View menu to display the Gateways.

b. To download the configuration for a multiple devices, right-click a location and select Apply Configuration Changes.

or

c. Right-click a Gateway icon and select Apply Configuration Changes to download the configuration for a single device.

See Applying Configuration Changes, page 6-17 for more information.

Step 1 

Select Device IO Rules from the Doors menu.

Step 2 

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

To duplicate an existing rule:

–Select the entry and click the Duplicate button in the upper right of the main window.

–Enter a New Name for the rule and click OK.

–In the main window, select the duplicate rule name and click Edit.

–Revise the rule settings as described in the following steps.

Step 3 

Enter the rule settings:

•Name: enter the name of the rule.

•Description: enter a short description of the rule.

•Gateway: select the Gateway where the device is installed.

Trigger

•Device Type: select the device type:
Door, Generic Input device, Glass Break Sensor, Motion Sensor, Duress Sensor, Fire Sensor, Tamper device or Power Fail device.

•Device: select the device name.

•Event: select the event type. When this event occurs on the selected device, the following action is performed.

Action

•Device: select the device for the action.

•Command: Select the device command. For more information, see Device and Driver Commands in the Hardware Device View, page 6-34.

Step 4 

Click Save and Close to save the changes. The new or revised rule is displayed in the main window.

Step 5 

Select Apply Configuration Changes on the affected Gateway to activate the rule.

Note Gateways must be in the Up state, signified by a green triangle in the icon. A dark green triangle means configuration changes that have not been applied.

You can apply changes using either the Hardware or Locations & Doors module:

Hardware module

•Right-click the Access GW Driver and select Apply Configuration Changes to download configuration changes for all Gateways.

or

•Right-click on a Gateway Controller and select Apply Configuration Changes to download configuration changes for a single Gateway.

Locations & Doors module

a. Select Gateway Controllers from the View menu to display the Gateways.

b. To download the configuration for a multiple devices, right-click a location and select Apply Configuration Changes.

or

c. Right-click a Gateway icon and select Apply Configuration Changes to download the configuration for a single device.

See Applying Configuration Changes, page 6-17 for more information.

Step 1 

Select Hardware from the Doors menu.

Step 1 

Right-click the Driver Manager and select New Automation Driver....

Step 2 

Enter the driver settings:

a. Click the General tab and enter a Name for the Automation Driver.

b. If e-mail notification is needed, click the SMTP Server Settings tab and enter the SMTP server settings.

c. Click Save and Close to close the configuration window and create the Automation Driver.

Step 3 

Right-click the Automation Driver and select Start.

This enables the driver and activates any automated rules.

Step 1 

Select Global I/O from the Events & Alarms menu. The Automates Rules window lists the currently defined rules.

The main window includes the following columns.

•Name: The name of the automated task.

•Enabled: Yes if the task is enabled. No if the task is disabled.

•Trigger: Operator-defined events, and or time schedules that execute an action or notification.

•Action: Reporting or device commands executed on devices.

•Notification: The notification type. For example: E-mail, FTP, or Syslog notification.

Step 2 

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

Tip You can also right click to select an option.

Step 3 

Enter a Name for the rule and select or deselect the Enabled checkbox.

Step 4 

Enter a Trigger type for the rule.

Click New or Edit to define the Trigger Type. The choices are:

•Event: The rule is invoked when an event matching the defined filter occurs.

–Select Event.

–Click Edit Filter to define the filter.

–Select a Time Schedule for the rule. If the event occurs within the specified schedule, the rule will be invoked. See Configuring Time Schedules, page 10-34 to define the schedules.

•Periodic (time schedule): The rule is invoked according to a Monthly, Weekly, or Daily schedule. Select the day of week or day of month, if necessary, and the Time of day (in a 24-hour format).

•Manual Only: The rule is invoked manually. You can create a Quick Launch button or add the rule to a graphic map.

Step 5 

Define one or more Actions that occur when the rule is triggered. The options are:

•Report: Generates a report that can be saved or sent to a user.

•Device Command: Executes a command on a specified device.

•CSV Import: Imports a comma separated value file containing personnel, organization, or access level data. The file must be located on an FTP server.

•Group Edit: Edits multiple personnel or badge records.

•Sanity Report Action: Provides a snapshot of the system status.

•URL Action: performs a pre-defined URL action.

Tip See Understanding Automated Rule Actions for descriptions of the fields and settings for each option.

Step 6 

Specify a Notification option to define where the notification or report file is sent. The options are:

•E-mail: Sends the notification or report file to one or more e-mail addresses. To enable e-mail notifications, you must enter the SMTP server settings in the Automation driver. For instructions, see Enabling the Automation Driver.

•FTP: Sends the file to the specified FTP server.

–Host: The FTP server IP address or name.

–Username: Log in username required by the FTP server.

–Password: Password to log in to the FTP server.

–Path: Path on the FTP server where files should be uploaded.

•Syslog: Sends the notification or report to a Syslog.

–Host: The Syslog server IP address or name. You must verify that the server is accessible and allows remote hosts to log messages. Cisco PAM does not verify the Host server availability.

–Facility: The log facility to use when recording the information to the Syslog.

Step 7 

Select the event options. These events occur when the rule is successfully invoked, or when rule options fail.

Click the check boxes to activate or deactivate the options:

•Record event when rule invoked: Each time the rule is invoked, record an event.

•Record event when trigger fails: Each time the trigger fails, record an event.

•Record event when action fails: Each time the action fails, record an event

•Record event when notification fails: Each time the notification fails, record an event.

Step 8 

Click Save and Close.

Create or edit an automated rule as described in Configuring Automated Tasks Using Global I/O. In the Actions section, click Add to create a new action, or select an existing action and click Edit.

Report

Generates a report that can be saved or sent to a user. Complete the following settings:

a. Select the Action type Report.

b. Click Choose to select a predefined report template. To create or modify reports, see Defining Reports (Report Manager).

c. Click Settings to define the report:

–Title: edit the name of the report, if necessary.

–Group by: select the group, if available.

–Format: select Record-style or Table-style.

–Output type: select an output type from the drop-down menu. For example: PDF document.

Device Command

Executes a command on one or more devices:

a. Select the Action type Device Command.

b. Device(s): Select the Device(s):

–Single: click Choose and select a single device or door from the Hardware view.

–Multiple (by filter) of type: select a device type from the drop-down menu. For example, select deadbolt to select all deadbolt devices in all doors. To refine the selection, click Filter and select the filter options.

–Multiple (by group) of type: select a device group from the drop-down menu. To create door groups, see Configuring Device Groups, page 6-28.

–Variable (of type): select a device type from the drop-down menu and then click Variable to select a variable.

For example, select the variable type Door, and then click the Variable button. Select Triggering Event: Device from the drop-down menu and click OK. If a the event Trigger configured in is caused by a door, then the action is initiated.

c. Command: Click Choose to select the Command for the device(s). See Device and Driver Commands, page 6-34 and Door Modes and Commands, page 6-39 for command descriptions.

d. Parameters: (Optional) Click Choose to select the Parameters for the command, if required.

Note If Choose is shown in black, you must click the button to continue. Select a parameter from the list. If the message "Are you sure you want to continue?" appears, click OK. This message indicates that a parameter is not required.

e. Click OK

f. Click Save and Close.

CSV Import

Imports a comma separated value file from a file located on an FTP server.

Note The properties import file must be named csv.import.properties.

Note Do not include the header row in CSV import files. Otherwise, the header row is imported as data and results in one record more than the correct count.

Note To import pictures, the path name in the CSV file should be relative to the Directory path for the CSV properties file. If only the image name is specified in the CSV file, then the images must be located in the same directory as the CSV properties file.

a. Select the Action type CSV Import.

b. Select the data Type: Personnel, Organizations or Access Levels.

c. Enter the server and file settings:

–Host: the IP address of the FTP server.

–Username: the username required for access to the FTP server.

–Password: the FTP server password.

–Directory path: the directory path for the file location.

–Configuration file: (read-only). the import file must be named csv.import.properties.

d. Click Save and Close.

Group Edit

Edits multiple personnel or badge records.

a. Select the Action type Group Edit.

b. Select the Item Type: for example, Badges.

c. (Optional) Click Edit Filter to apply the changes to a subset of badges or records. Use the filter window to define the filter settings.

d. Click Group Edit to enter the changes that will apply to all specified personnel or badge records.

e. Click Save and Close.

Sanity Report Action

System sanity reports provide information about potential system inconsistencies or issues in the access control system. See Generating a System Sanity Report, page 5-16 for more information.

a. Select the Action type Sanity Report Action.

b. Select the Report type:
for example, Devices/Doors - Disabled.

c. Click Save and Close.

URL Action

Performs a pre-defined URL action.

a. Select the Action type URL Action.

b. Select a pre-defined URL Action from the drop-down menu.

c. (Optional) Click New or Edit to create or modify a URL action. See Configuring URL Actions, page 12-2 for more information.

d. Click Save and Close.

Tip Static URL actions can be invoked by creating a manual automated rule. Set the Trigger Type to Manual and Action Type as URL Action. Then select a static URL from the list. This rule can be invoked by right clicking on the Automation Driver in the Hardware module and selecting Invoke Automation Rule. You can also create a Quick Launch button to invoke the rule (see Creating Quick Launch Buttons).

Step 1 

Select Global I/O in the Events & Alarms menu.

Step 2 

Create a new rule and enter the General settings:

a. Click Add... to open the Automation Rule window.

b. Name: Enter a descriptive name for the rule. For example: Daily Gateway Report (output).

c. Enabled: Verify that the Enabled checkbox is selected.

Step 3 

Select the periodic Trigger to have the report sent at a regular scheduled time:

a. From the Trigger row, click the New... button.

b. Select Periodic from the drop-down menu.

c. Select OK.

Step 4 

Select the days and times for the periodic Trigger:

a. Interval: Options include: Monthly, Weekly and Daily.

b. Day of Week/Month: If you select Monthly or Weekly, select the day of the month or week.

c. Time of day: Enter a time using a 24-hour notation. For example, 1:00 p.m. in a 12-hour clock is expressed as 13:00 in a 24-hour clock.

d. Select OK.

Step 5 

Select the action to generate a report file:

a. In the Action section, click the Add... button.

b. Select Report from the drop-down menu.

Step 6 

Define the type of report and the format of the output:

a. From the Report window, click Choose.... The Choose Report window displays all reports defined in the system

–Select a report from the list.

–Click OK to close the Choose Report window.

Tip To create or edit reports, see Defining Reports (Report Manager).

b. From the Report window, click Settings to open the Report Generation window.

–Title: Enter a Title for the report.

–Format: Select if the report should be in Record-style or Table-style.

–Output: Select the type of file to output. For example: PDF document or Excel spreadsheet.

–Click OK to close the Report Generation window.

c. Click Save and Close to save the Action settings and close the Report window.

d. Repeat these steps to create additional Actions for the automated rule, if necessary.

Step 7 

Select the Notification method. For example, send the report file by e-mail:

a. From the Notification row, click the New... button. Notification options are: E-mail, FTP or Syslog.

a. Select E-mail from the notification drop-down and configure valid e-mail addresses as displayed in the following step.

b. Click OK.

Step 8 

a. Add e-mail addresses for the To, CC, and or BCC fields. You can enter specific e-mail addresses, or select addresses from the Personnel records configured in Cisco PAM.

b. Click OK to save the changes and close the window.

Step 9 

a. Verify that all configurations are correct.

b. Click Save and Close to save the Automated Rule and close the window.

Step 10 

Add the Automation driver as described in Enabling the Automation Driver.

Note This step is only necessary if the Automation Driver is not already added.