Agent File Monitor Trigger
Overview
The Agent File Monitor trigger allows you to trigger one or more tasks based on the creation, deletion, or change of a file on a particular machine, as specified by a selected Agent File Monitor task, as illustrated below. For a detailed description, see Launching an Agent File Monitor Task Using an Agent File Monitor Trigger.
Note
Using an Agent File Monitor trigger to trigger an Agent File Monitor task that is monitoring for the creation of one or more files (Monitor Type = Exists) will disable the trigger. You should instead specify (Monitor Type = Create) and check Trigger on Existence.
Built-In Variables
The built-in variables outlined below can be used to pass data where appropriate:
Prerequisites
Before you can use an Agent File Monitor Trigger, you need the following:
A Windows, Linux/Unix, or z/OS agent, which will execute the Agent File Monitor task.
An Agent File Monitor task, which watches for the creation, deletion, change, existence, or non-existence of a file.
Note
Any changes made to an Agent File Monitor task are not recognized by its respective Agent File Monitor Triggers until those Triggers are disabled and re-enabled.
Creating an Agent File Monitor Trigger
Step 1 | From the Automation Center navigation pane, select Triggers > Agent File Monitor Triggers. The Agent File Monitor Triggers list displays. |
|---|---|
Step 2 | Enter/select Details for a new Agent File Monitor trigger, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
Step 3 | Click a button. The trigger is added to the database, and all buttons and tabs in the Trigger Details are enabled. |
Step 4 | Enable the trigger(s) as desired. |
Note
To open an existing record on the list, either:
Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).
Agent File Monitor Trigger Details
The following Agent File Monitor Trigger Details is for an existing Agent File Monitor trigger. See the field descriptions, below, for a description of the fields that display in the Agent File Monitor Trigger Details.
Agent File Monitor Trigger Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the Agent File Monitor Trigger Details.
Field Name | Description |
|---|---|
General | This section contains general information about the trigger. |
Name | |
Version | |
Description | |
Member of Business Services | |
Calendar | |
Time Zone | |
Task(s) | |
Simulate | |
Purge By Retention Duration | |
Exclude Backup | |
Retention Duration | |
Retention Duration Unit | |
Execution User | |
Status | This section contains information about the current status of the trigger. |
Status | |
Next Scheduled Time | |
Enabled By | |
Disabled By | |
Enabled Time | |
Disabled Time | |
Skip Details | This section contains detailed information about skipping the trigger. |
Task Launch Skip Condition | |
Skip Restriction | |
Skip Count | |
Skip Before Date | |
Skip Before Time | |
Skip After Date | |
Skip After Time | |
Skip Date List | |
Agent File Monitor Details | This section contains assorted detailed information about the trigger. |
Agent File Monitor | |
Running Monitor | |
Restrictions | This section specifies any restrictions that apply to the trigger. |
Restrict Times | |
Enabled Start | |
Enabled End | |
Special Restriction | |
Action | |
Simple Restriction | |
Situation | |
Complex Restriction | |
Restriction Mode | |
Restriction Adjective | |
Restriction Noun(s) | |
Restriction Qualifier(s) | |
Restriction Nth Amount | |
Self-Service Options | This section contains Self-Service specifications for the trigger. |
Enforce Variables | |
Lock Variables | |
Metadata | This section contains Metadata information about this record. |
UUID | Universally Unique Identifier of this record. |
Updated By | Name of the user that last updated this record. |
Updated | Date and time that this record was last updated. |
Created By | Name of the user that created this record. |
Created | Date and time that this record was created. |
Buttons | This section identifies the buttons displayed above and below the Trigger Details that let you perform various actions. |
Save | Saves a new task record in the Controller database. |
Save & New | Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. |
Save & View | Saves a new record in the Controller database and continues to display that record. |
New | Displays empty (except for default values) Details for creating a new record. |
Update | |
Enable | |
Disable | |
Trigger Now... | |
Copy | Creates a copy of this trigger, which you are prompted to rename. |
Delete | |
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | For pop-up view only; closes the pop-up view of this trigger. |
Tabs | This section identifies the tabs across the top of the Trigger Details that provide access to additional information about the trigger. |
Variables | |
Instances | |
Notes | |
Versions |