Cisco Physical Access Manager Appliance User Guide, Release 1.1.0
Configuring Automated Tasks
Downloads: This chapterpdf (PDF - 3.55MB) The complete bookPDF (PDF - 36.19MB) | Feedback

Configuring Automated Tasks

Table Of Contents

Configuring Automated Tasks

Contents

Creating Quick Launch Buttons

Creating a Button

Creating a Button That Runs An Automated Rule

Creating Panels (Windows) of Related Buttons

Restricting User Access to Button Panels

Configuring Device Automated Rules

Configuring Global I/O Automated Rules

Enabling the Automation Driver

Configuring Automated Tasks Using Global I/O

Understanding Automated Rule Actions

Example: Automated Weekly Report

Defining Reports (Report Manager)

Using the Report Manager

Filter-based Report Template

Object SQL-based Report Template

SQL-Based Report Template


Configuring Automated Tasks


This chapter describes how to create and manage automated tasks such as triggering a relay when an alarm is generated, playing an alarm video, or sending an event e-mail.

In addition, you can create Quick Launch buttons for commonly used actions, and organize the buttons into different panels.

Contents

Creating Quick Launch Buttons

Creating a Button

Creating a Button That Runs An Automated Rule

Creating Panels (Windows) of Related Buttons

Restricting User Access to Button Panels

Configuring Device Automated Rules

Configuring Global I/O Automated Rules

Enabling the Automation Driver

Configuring Automated Tasks Using Global I/O

Example: Automated Weekly Report

Defining Reports (Report Manager)

Using the Report Manager

Filter-based Report Template

Object SQL-based Report Template

SQL-Based Report Template

Creating Quick Launch Buttons

Quick Launch buttons provide one-click access to commonly used actions. For example, you can create buttons to unlock a door or open a Cisco PAM module. Complete the following instructions to create or modify buttons, and organize them into different panels (windows).

Creating a Button

Creating a Button That Runs An Automated Rule

Creating Panels (Windows) of Related Buttons

Restricting User Access to Button Panels

Creating a Button

 
To do this
Use this display

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 also Configuring Door Groups, page 11-6.

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.

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.

Creating a Button That Runs An Automated Rule

Create a button that runs an automated rule.


Step 1 Select Add Widget and then Device Command.

Step 2 Click Choose to select a single device.

Step 3 In the Hardware view, select the Automation Driver, and then click OK.

Step 4 Click Choose next to the Command field, click Choose.

Step 5 Select Invoke Automation Rule and click OK.

Step 6 Click Choose next to the Parameters field, select a Rule, and then click OK.

Step 7 Click OK to save the changes and close the window.

See Configuring Global I/O Automated Rules for more information.


Creating Panels (Windows) of Related Buttons


Step 1 Create one or more Quick Launch buttons.

Step 2 Select Save or Save As to save the current quick launch window as a panel.

Step 3 Enter the panel name.

Step 4 Click OK.

Tip To toggle between the panels, select Panels from the menu bar and select a panel.

Restricting User Access to Button Panels

Restrict user access to the button panels using the Profiles and Login modules, as described in the following instructions.


Step 1 Create or modify profiles to include the required Quick Launch access privileges. Profiles are sets of access privileges that are assigned to individual user logins.

a. Open the Profiles module.

b. Click Add or Edit to create or modify a profile.

c. Click the Module tab.

d. Click Quick Launch.

e. Select the options to the right:

Allow access to module: allow profile users to access the Quick Launch module.

Allow edit: allow users to create and edit buttons.

Allow all panels: allow access to all panels. Uncheck this option to enable the following button.

Choose allowed panels. select the panels that can be accessed by this profile.

f. Click Save and Close.

Step 2 Assign the profile to the user login.

a. Open the Login module.

b. Click Add or Edit to create or modify a user login.

c. Select Profiles.

d. Select the profile that includes the required access privileges.

e. Click Save and Close.


Configuring Device Automated Rules

Use the Device I/O Rules module to create event based rules for a specific Gateway and the doors and devices configured on the Gateway. For example, when a door is forced open, a rule can activate a generic output device to sound an alarm. Since device rules are implemented for a single Gateway, the action is triggered immediately.

Device automation rules differ from global automation rules in the following ways:

Device rules affect a single Gateway. Global rules can affect multiple Gateways.

Device rules trigger actions immediately since they are executed on the Gateway and not subject to system or network delays. Global rules may not execute immediately due to network delays, rules processing, communication between Cisco PAM and the Gateways, or other factors. See Configuring Global I/O Automated Rules instructions to create global rules.

Complete the following instructions to create or modify Device IO Rules:

 
To do this
Use this display

Step 1 

Select Device IO Rules from the Doors menu.

Step 2 

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

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: read-only. The device type Door.

Device: select the door name.

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

Action

Device: select the device for the action. Only devices configured on the selected door are displayed.

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

Step 4 

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

 

Step 5 

To activate the rule, right-click the affected Gateway and select Apply Configuration Changes.

Hardware module

To download configuration changes for all Gateways, right-click on the Access GW Driver and select Apply Configuration Changes.

To download configuration changes for a single Gateway, right-click on a Gateway Controller and select Apply Configuration Changes. The options to apply configuration changes are available only if the Gateway is connected and shown in the Up state.

Locations & Doors module

Select Gateway Controllers from the View menu.

To download the configuration for a single device, right-click a Gateway icon and select Apply Configuration Changes.

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

See Applying Configuration Changes, page 8-16 for more information.

Configuring Global I/O Automated Rules

Automated rules can execute commands, generate event reports, edit multiple records, or perform URL actions. Once created, you can invoke the automated rules from other modules, such as Quick Launch buttons and Graphic Maps. Create automated tasks using the Global I/O module, as described in the following sections.

Enabling the Automation Driver

Configuring Automated Tasks Using Global I/O

Example: Automated Weekly Report

Enabling the Automation Driver

To enable automated tasks, the Automation Driver must be created and configured in the Hardware window. The driver is only created once and remains active unless deactivated.


Tip The Automation Driver is a system component that executes automation policy actions. See Viewing Doors and Devices in the Hardware View, page 7-3 for a description of the various system drivers.


 
To do this
Use this display

Step 1 

Select Hardware from the Doors menu.

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

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.

Configuring Automated Tasks Using Global I/O

Create automated rules to automatically execute commands, generate event reports. The automated rules can also be configured for manual use, useful when placing a task icon in a graphic map.

 
To do this
Use this display

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 and then click Edit Filter to define the filter).

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. See Understanding Automated Rule Actions for descriptions of the fields and settings for each option.

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.

URL Action: performs a pre-defined URL action.

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.

Facility: The 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.

 

Understanding Automated Rule Actions

Automated rule Actions define what occurs when the rule is triggered. Actions are defined when creating or editing a rule, as described in Configuring Automated Tasks Using Global I/O. This section describes the options for each automated rule option. 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 located on an FTP server. The file can contain personnel, organization, or access level data.

Group Edit: Edits multiple personnel or badge records.

URL Action: performs a pre-defined URL action.

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. 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 Door Groups, page 11-6.

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

For example: Triggering Event: Device. If the device type in question is triggered with the configured event(trigger), the single device associated with the trigger will create the action.

c. Click Choose to select the Command for the device(s). See Device and Driver Commands in the Hardware Device View, page 8-30 and Door Modes and Commands, page 8-34 for command descriptions.

d. (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.

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 14-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).

Example: Automated Weekly Report

The following sample shows how to configure an automated rule that runs a report on a weekly basis.

 
To do this
Use this display

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.

Defining Reports (Report Manager)

Use the Report Manager to add or modify reports used in automated tasks. Report templates include the following:

Filter-based reports

Reports defined using a filter, similar to the Filter toolbar button in many modules. This is the most straightforward way to define a report. For more complex reports, use one of the following SQL-based options.

Object SQL-based reports

Reports defined using explicit SQL which returns the unique IDs of the items to display, which are otherwise presented in a similar fashion as a filter-based report does.

SQL-based reports

Reports defined using explicit SQL.


Tip See Configuring Global I/O Automated Rules for instructions to assign reports to automated tasks.


This section includes the following information:

Using the Report Manager

Filter-based Report Template

Object SQL-based Report Template

SQL-Based Report Template

Using the Report Manager


Step 1 Select Report Manager from the Reports menu. The main window appears, as shown in Figure 13-1.

Figure 13-1 Report Manager Main Window


Note Some reports are used for internal processes and cannot be used to generate reports. For example: Badges-Unused.


Step 2 Use the toolbar to perform the following actions:

Add: Add a new report or folder. The following options are available:

Add Filter-based Report Template...: See Filter-based Report Template.

Add Object SQL-based Report Template...: See Object SQL-based Report Template.

Add SQL-based Report Template...: See SQL-Based Report Template.

Add Folder...: Adds a new folder for report organization.

Import...: Import a previously exported report or set of reports from XML.

Export...: Export all reports to an XML file, which may be later imported on the same or another system.

Edit...: Select a report and click Edit...: to view and modify the details of the report. You can also double-click the report entry.

Delete: Delete the report.

Run: Run the report and open the contents of the report in a new window.

Step 3 Edit the report using the description in the following sections:

Filter-based Report Template

Object SQL-based Report Template

SQL-Based Report Template


Filter-based Report Template

When you add or edit a report, the Report Manager detail window includes properties for the specific type of report.

All report types include the following toolbar buttons:

Save and Close: Save changes and close the report.

Run: Run the report and open the contents of the report in a new window.

Export...: Export the report to an XML file, which may be later imported on the same or another system.

Figure 13-2 shows the detail window for a Filter-based Report Template. Complete the fields according to the descriptions in Table 13-1.

Figure 13-2 Filter-based Report Template

Table 13-1 Filter-based Report Template Settings 

Field
Description

Name

Enter a unique name for the report.

Max results

The number of results displayed in the report. -1 is unlimited results.

Item type

The type of category to build the filter based report on.

Edit Filter...

Defines the filter, similar to filters available in the toolbar. See Using Filters, page 5-12.

Report Settings...

Report generation options, which are the same as when generating a report from one of the other modules. For more information see Creating Reports, page 5-10.

Variable Parameters...

Parameters the user is be prompted to provide when the report is run.

Edit Columns...

Select the columns used in the report. Use the Up and Down buttons to reorder the columns for the report.


Object SQL-based Report Template

When you add or edit a report, the Report Manager detail window includes properties for the specific type of report.

All report types include the following toolbar buttons:

Save and Close: Save changes and close the report.

Run: Run the report and open the contents of the report in a new window.

Export...: Export the report to an XML file, which may be later imported on the same or another system.

Figure 13-3 shows the detail window for a Object SQL-based Report Template. Complete the fields according to the descriptions in Table 13-2.

Figure 13-3 Object SQL-based Report Template

Table 13-2 Object SQL-based Report Template Settings 

Field
Description

Name

Enter a unique name for the report.

Max results

The number of results displayed in the report. -1 is unlimited results.

Item type

The type of category to build the object SQL-based report on.

SQL

The SQL query to be executed. The SQL defined should only return a single column, which is the unique id of an object matching the Item type drop-down menu.

Report Settings...

Report generation options. For more information on report settings see Creating Reports, page 5-10).

Variable Parameters...

Parameters the user is prompted to provide when running the report. Variable parameters replace question marks in the SQL query, in order. The number of parameters must match the number of question marks in the query.


SQL-Based Report Template

When you add or edit a report, the Report Manager detail window includes properties for the specific type of report.

All report types include the following toolbar buttons:

Save and Close: Save changes and close the report.

Run: Run the report and open the contents of the report in a new window.

Export...: Export the report to an XML file, which may be later imported on the same or another system.

Figure 13-4 shows the detail window for a SQL-based Report Template. Complete the fields according to the descriptions in Table 13-3.

Figure 13-4 SQL-based Report Template

Table 13-3 SQL-Based Report Template Settings 

Field
Description

Name

Enter a unique name for the report.

Max results

The number of results displayed in the report. -1 is unlimited results.

Item type

The type of category to build the object SQL-based report on.

SQL

The SQL query to be executed. The SQL defined should only return a single column, which is the unique id of an object matching the Item type drop down menu.

Report Settings...

Report generation options. For more information on report settings see Creating Reports, page 5-10).

Variable Parameters...

Parameters the user is prompted to provide when running the report. Variable parameters replace question marks in the SQL query, in order. The number of parameters must match the number of question marks in the query.