Automated rule actions define what occurs when a rule is triggered. The actions are defined when creating or editing a rule, as described in Configuring Automated Tasks Using Global I/O.
This section provides details about the following action types for automated rules:
· 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 or ICPAM server. The file can contain personnel or organization data.
· Group Edit: Edits multiple personnel or badge records.
· Sanity Report Action: Provides a snapshot of the specified system status.
· URL Action: performs a pre-defined URL action.
In the Actions section of the Add Automation Rule or Edit Automation Rule window, either click Add to create a new action or select an existing action and click Edit.
Generates a report that can be saved or sent to a user. Complete the following settings:
Step 1. Select the Action type of Report.
Step 2. Click Choose to select a pre-defined report template. To create or modify reports, see Defining Reports (Report Manager) .
Step 3. Click Settings to define the report:
· Title: edit the name of the report, if necessary.
· Group by: select the group, if available.
· Page break between groups: select this option to have each group start on a new page.
· Show group by label: if needed, display the group by label
· Format: select Record-style or Table-style.
· Output type: select an output type from the drop-down menu. For example: PDF document.
Executes a command on one or more devices:
Step 1. Select the Action type of Device Command.
Step 2. Device(s): Select the Device(s):
· Single: click Choose and select a single device or door from the Hardware - Tree 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.
· 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 Enter a Name for the rule and select or deselect the Enabled check box. is caused by a door, then the action is initiated.
Step 3. Command: Click Choose to
select the command for one or more devices. See Device
Commands and Door
Modes and Commands for command descriptions.
Step 4. If required, specify the parameters for the selected command:
a. If the Choose button to the right of the Parameters field is enabled, you must click that button to continue. In the resulting dialog, select a parameter from the list, and click OK.
b. If the message “Are you sure you want to continue?” appears, click OK. This message indicates that a parameter is not required.
Step 5. Click Save and Close.
Imports a comma separated values file from a directory located on the ICPAM Server or an FTP server.
· The properties import file must be named csv.import.properties.
· 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.
· 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.
Step 1. Select the Action type CSV Import.
Step 2. Select the data Type: Personnel or Organizations.
Step 3. For CSV import from ICPAM server enter the file settings as:
· Directory Path: The directory path of the CSV file location in ICPAM server.
· Configuration file : (read only) the import configuration file having import mapping settings must be named csv.import.properties.
Note Here the CSV file and csv.import.properties should be placed in any of the ICPAM server directories like /tmp or /directory that has root level permissions. Ensure that both files are in the same directory path.
Step 4. Click Save and Close.
Step 5. For CSV import from folder/directory located on a FTP server, enter the server and file settings as:
· 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 configuration file having import mapping settings, must be named as csv.import.properties.
Note The .csv and csv.import.properties files should be placed in the location specified in the Directory path.
Step 6. Click Save and Close.
For CSV import for personnel records from local client machine desktop, See Importing Personnel Records Using a Comma Separated Value (CSV) File.
Edits multiple personnel or badge records.
Step 1. Select the Action type of Group Edit.
Step 2. Select the Item type. For example, Badges.
Step 3. (Optional) Click Edit Filter to apply the changes to a subset of badges or records. Use the filter window to define the filter settings.
Step 4. Click
Group Edit to specify the changes that will
apply to all selected personnel or badge records.
Step 5. Click Save and Close.
System sanity reports provide information about potential system inconsistencies or issues in the access control system. See Generating a System Sanity Report for more information.
Step 1. Select the Action type of Sanity Report Action.
Step 2. Select
the Report type. For example, Devices/Doors - Disabled.
Step 3. Click Save and Close.
Performs a pre-defined URL action.
Step 1. Select the Action type of URL Action.
Step 2. Select a pre-defined URL Action from the drop-down menu.
Step 3. (Optional)
Click New or Edit
to create or modify a URL action. See Configuring
URL Actions for more information.
Step 4. Click Save and Close.
Tip Static URL actions can be invoked by creating a manual automated rule. Set the Trigger Type to Manual and the 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 - Tree module and selecting Invoke Automation Rule. You can also create a Quick Launch button to invoke the rule (see Creating Quick Launch Buttons).
See also:
Configuring Automated Tasks Using Global I/O
Example: Automated Weekly Report