Composite Trigger
Overview
The Composite trigger consists of Time, Agent File Monitor, Task Monitor, Variable Monitor, and Email Monitor components - which function like Time, Agent File Monitor, Task Monitor, Variable Monitor, and Email Monitor triggers - that allow you to trigger one or more tasks based on correlated events from those components.
Each Composite trigger can contain the following number of components:
- Time Component (0 or 1)
- Agent File Monitor Component (0 or more)
- Task Monitor Component (0 or more)
- Variable Monitor Component (0 or more)
- Email Monitor Component (0 or more)
- Universal Monitor Component (0 or more)
When you enable a Composite trigger, all components of that trigger are enabled. Each enabled component has its own event queue. When a component fires, an event is enqueued and the component notifies its parent Composite trigger. The Composite trigger will then check the event queues of all of its components and launch the specified task(s) if a correlated set of events is found.
Note
If a Composite trigger has Restrict Times enabled, its components will be enabled only within the specified Enabled Start and Enabled End times:
- If the Composite trigger is disabled. the components stay disabled.
- If the Composite trigger is enabled, and the time is within its specified Enabled Start and Enabled End times, its components will be enabled.
- If the Composite trigger is enabled, and the time is outside of its specified Enabled Start and Enabled End times, its components will stay disabled.
The Composite Trigger Details provides the following fields for component queue specifications:
- Time Limit and Time Limit Units specify the length of time that events are maintained in all component queues.
- Queue Depth specifies the maximum number of events that can be contained in each component queue. If the maximum has been reached but more events are ready to be placed in a queue, the oldest events are discarded.
Built-In Variables
In order to propagate built-in variables up to a Composite trigger, from the files, tasks, and variables being monitored by its File Monitor, Task Monitor, Variable Monitor, and Email Monitor components, the Component Details provide a Variable Prefix field.
- If a Variable Prefix is not specified, no built-in variables for that component will be propagated.
- If a Variable Prefix is specified, all built-in variables supported by the component type will be propagated using the specified prefix rather than the reserved ops_ prefix.
Additionally, all components - File Monitor, Task Monitor, Variable Monitor, Email Monitor, and Time - support the built-in variable <prefix>trigger_component_event_time
that resolves to the time when the component fired.
Monitoring Component Status
You can monitor the following statuses of each enabled component in its component Details (available via the Components tab of the Composite trigger).
Component |
Status |
---|---|
Time |
|
File Monitor |
|
Task Monitor |
|
Variable Monitor |
|
Email Monitor |
|
Universal Monitor |
Forecasting
Forecasting is not supported for Composite triggers.
Creating a Composite Trigger
Step 1 |
From the Automation Center navigation pane, select Triggers > Composite Triggers. The Composite Triggers list displays. |
---|---|
Step 2 |
Enter/select Details for a new Composite 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).
Composite Trigger Details
The following Composite Trigger Details is for an existing Composite trigger. See the field descriptions, below, for a description of the fields that display in the Composite Trigger Details.
Composite Trigger Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the Composite Trigger Details.
Field Name |
Description |
---|---|
General |
This section contains general information about the trigger. |
Name |
|
Version |
System-supplied; version number of the current record, which is incremented by the system every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning. |
Description |
Description of this record. Maximum length is 255 characters. |
Member of Business Services |
User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted. |
Calendar |
Select a Calendar from the drop-down list of all existing Calendars. To display detailed information about a selected calendar, click the Details icon next to the Calendar field. |
Time Zone |
User-defined; allows you to specify the time zone that will be applied to the time(s) specified in the trigger. For example, if you specify 23:00 and a time zone of Canada/Central, the task will run at 11:00 p.m. Central Canada time. |
Task(s) |
Name of the task(s) being triggered when this trigger is satisfied. When selecting tasks from the Details, click on the lock icon to unlock the field and select tasks. |
Purge By Retention Duration |
|
Exclude Backup |
If Purge By Retention Duration is selected; Specification for whether qualifying task instances can be excluded from the backup when being purged by retention duration. |
Retention Duration |
If Purge By Retention Duration is selected; Minimum retention duration for the selected Retention Duration Unit before triggered task instances can qualify for purge. If Retention Duration Unit = Days, valid values are 1 to 366. If Retention Duration Unit = Hours, valid values are 1 to 24. |
Retention Duration Unit |
|
Execution User |
|
Status |
This section contains information about the current status of the trigger. |
Status |
|
Next Scheduled Time |
System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information. |
Enabled By |
System-supplied. If Status = Enabled, ID of the user who most recently enabled this trigger. |
Disabled By |
System-supplied; If Status = Disabled, ID of the user who most recently disabled this trigger. (By default, all new triggers are disabled.) |
Enabled Time |
System-supplied. If Status = Enabled, Date and time that the trigger was enabled. |
Disabled Time |
System-supplied. If Status = Disabled, Date and time that the trigger was disabled. |
Skip Details | This section contains detailed information about skipping the trigger. |
Task Launch Skip Condition |
User-defined; Controls when launching a task for the trigger will be skipped. Default is the value of the Trigger Task Launch Skip Condition Default Universal Controller system property. Options:
Task Launch Skip Condition is not applicable when using the Trigger Now... command and will be ignored. |
Skip Restriction |
User-defined; Specification for when this trigger should skip and not launch the task(s). Options:
Default is - - None - -. |
Skip Count |
User-defined; Allows you to specify that the Controller should skip the next N times this task is triggered. |
Skip Before Date |
If Skip Restriction is Before or Span; Date before which the Trigger will skip. |
Skip Before Time |
If Skip Restriction is Before or Span; Time before which the Trigger will skip on the specified Skip Before Date. |
Skip After Date |
If Skip Restriction is After or Span; Date after which the Trigger will Skip. |
Skip After Time |
If Skip Restriction is After or Span; Time after which the Trigger will skip on the specified Skip After Date. |
Skip Date List |
If Skip Restriction is On; List of dates on which the trigger will skip. |
Composite Details |
This section contains assorted detailed information about the trigger. |
Time Limit |
Amount of time (in Time Limit Units) that component events will remain in their queue before being removed. |
Time Limit Unit |
Unit of time specified in the Time Limit field.
|
Queue Depth |
Number of events that are maintained in the queue for each component at any time. To maintain the Queue Depth, the Controller discards the oldest events. |
Restrictions |
This section specifies any restrictions that apply to the trigger. |
Restrict Times |
Period during which the trigger is active. Enable this field and specify the start and end times in the Enabled Start and Enabled End fields. |
Enabled Start |
If Restrict Times is enabled, allows you to specify the start time of the period during which the trigger should be active. Use 24-hour time. |
Enabled End |
If Restrict Times is enabled, allows you to specify the end time of the period during which the trigger should be active. Use 24-hour time. |
Special Restriction |
Enable this field in order to specify additional parameters that tell the Controller how to handle exceptions, such as when the trigger is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a Simple Restriction that disables the trigger if it is satisfied on a holiday identified in the calendar and/or a Complex Restriction that disables the trigger on the last business day of every month. |
Action |
If Special Restriction is enabled, allows you to select an action to take on a non-business day or holiday (see Situation field). Options:
|
Simple Restriction |
|
Situation |
If Simple Restriction is enabled, allows you to select the situation that causes the system to initiate the action specified in the Action field. Options:
|
Complex Restriction |
If enabled, allows you to specify a set of parameters that determine one or more situations when this trigger should not be satisfied. Used in conjunction with the following fields: Restriction Mode, Restriction Adjective, Restriction Noun, Restriction Qualifier. For example, you may specify that you do not want to satisfy this trigger on the last business day of the year or the first day of each month. |
Restriction Mode |
If both Simple Restriction and Complex Restriction are enabled, specifies whether you want to use both restriction types (AND) or one or the other (OR). Options:
|
Restriction Adjective |
If Complex Restriction is enabled, the type of selection. Options:
Example: The last business day of the month. |
Restriction Noun(s) |
If Complex Restriction is enabled, the day(s) you want to select. Options:
Example: The last Business Day and Sunday of the month. |
Restriction Qualifier(s) |
If Complex Restriction is enabled, the period(s) you are selecting from. Options:
Example: The last Day of Quarter, Year, and January. |
Restriction Nth Amount |
If Restriction Adjective is Nth, allows you to specify the value of N. If Restriction Qualifier is Week, Restriction Nth Amount must be <= 7. |
Self-Service Options | This section contains Self-Service specifications for the trigger. |
Enforce Variables | Specifies whether or not to enforce Override Trigger Variables when using Trigger Now... from the User Interface. |
Lock Variables | Specifies whether or not to prevent editing variables when using Trigger Now... from the User Interface. |
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 |
Saves updates to the record. |
Enable |
Activates this trigger and writes your User ID to the Enabled By field. |
Disable |
Deactivates this trigger. |
Trigger Now... |
Immediately triggers all the tasks specified in this trigger.
Note If you click Trigger Now... for an Enabled trigger that does not have an assigned Execution User, the trigger will launch its task(s) under the context of the Enabled By user. |
List Component Events |
For enabled triggers; Displays a new tab that lists all components of the Composite trigger and maintains a dynamic count of all events that have occurred for each component. |
Copy |
Creates a copy of this trigger, which you are prompted to rename. |
Delete |
Deletes the current record. |
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. |
Components |
Allows you to define the following components:
|
Variables |
|
Instances |
Lists all task instances that were triggered directly by this trigger. |
Notes |
|
Versions |
|
Time Component
Time Component Details Field Descriptions
The following table describes the fields and buttons that display in the Time Component Details.
Field Name |
Description |
---|---|
General |
This section contains general information about the component. |
Name |
Name used within the Controller to identify this component. It can contain a maximum of 255 alphanumerics. |
Description |
Description of this record. Maximum length is 255 characters. |
Built-In Variable Prefix |
User-specified prefix that enables built-in variables to be propagated up to the Composite trigger. |
Status |
This section contains information about the current status of the component. |
Event Match Type |
Controls whether events from the Time component will be used for a single match or multiple matches at the Composite trigger level. Note You can select Multiple only if a Time Limit is specified in the Composite Trigger Details. |
Status |
|
Next Scheduled Time |
System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information. |
Time Details |
This section contains assorted detailed information about the component. |
Time Style |
Specifies whether this trigger is for a specific time or a series of times. Options:
|
Time |
Required if Time Style = Time; time of the trigger in hours and minutes, using 24-hour time. For example, 01:45 means trigger the task at 1:45 a.m.; 13:45 means trigger the task at 1:45 p.m. (See also Daylight Saving Time.) |
Time Interval |
Required if Time Style = Time Interval; number of Time Interval Units. For example, for a Time Interval of every three hours, specify 3 in this field and select Hours in the Time Interval Units field. Note See Scheduling a Time Interval, below, for information on using a Time Trigger to schedule a time interval for triggering a task. |
Time Interval Units |
Required if Time Style = Time Interval; Type of time interval. Used in conjunction with the Time Interval field. For example, for a Time Interval of every three hours, specify 3 in the Time Interval field and select Hours in this field. Options:
|
Enable Offset |
If Time Style = Time Interval, allows you to define (in the Initial Time Offset field) a starting time, in minutes offset from the hour, for the trigger to run. |
Initial Time Offset (hh:mm) |
If Enable Offset is selected, allows you to define a starting time, in minutes offset from the hour. The default value ( * ) lets you select a starting hour (0 to 23) other than the next hour. For example:
|
Day Details |
This section contains assorted detailed information about the trigger day. |
Day Style |
Allows you to indicate when this trigger will be run: Options:
|
Daily |
If Day Style = Simple, allows you to specify that the trigger is active every day of the week. |
Business Days |
|
Specific Day(s) |
|
Date Adjective |
If Day Style = Complex, allows you to specify which in a series of days you want to select. Used in conjunction with the Date Noun(s) and the Date Qualifier(s) fields. For example, to specify "the 2nd Monday and Friday of January and December," select Date Adjective = Nth, Nth Amount = 2, Date Noun(s) = Monday, Friday, Date Qualifier(s) = Jan, Dec. Options:
|
Nth Amount |
If Day Adjective = Nth, allows you to specify the value of N. |
Date Noun |
If Day Style = Complex, allows you to specify the type of day you want to select. Used in conjunction with the Date Adjective and the Date Qualifier fields. For example, to specify "the 15th business day of the month," select Date Adjective = Nth, Date Noun = Business Day, Date Qualifier = Month, and Nth Amount = 15. This drop-down menu is populated as follows:
|
Date Qualifier |
If Day Style = Complex, allows you to specify the period for your selection formula. Used in conjunction with the Date Noun and Date Adjective fields. For example, to specify "the 15th business day of the month," select Date Adjective = Nth, Date Noun = Business Day, Date Qualifier = Month, and Nth Amount = 15. Options:
|
Date Adjustment |
If Day Style = Complex, allows you to adjust your date setting by a less or plus number of Days or Business Days. For example, to specify the 2nd to last day of the month (last day of the month less one day), select Date Adjective = Last, Date Noun(s) = Day, Date Qualifier(s) = Month, Data Adjustment = Less, Adjustment Amount = 1, and Adjustment Type = Day. Options:
Default is None. |
Adjustment Amount |
Required if Day Adjustment = Less or Plus; Allows you to specify the number of Days or Business Days to adjust your date setting. Maximum is 366. Default is 1. |
Adjustment Type |
If Day Adjustment = Less or Plus, allows you to specify the type of day by which to adjust your date setting. Options:
|
Day Interval |
If Day Style = Every, allows you to specify the interval (in days) at which this trigger will run. |
Interval Start |
If Day Style = Every, allows you to specify the first day of the interval on which this trigger will run. |
Restrictions |
This section specifies any restrictions that apply to the component. |
Restrict Times |
If Time Style = Time Interval; Period during which the trigger is active. Enable this field and specify the start and end times in the Enabled Start and Enabled End fields. Note Restrict Times and Enable Offset are mutually exclusive. |
Enabled Start |
If Restrict Times is enabled, allows you to specify the start time of the period during which the trigger should be active. Use 24-hour time. |
Enabled End |
If Restrict Times is enabled, allows you to specify the end time of the period during which the trigger should be active. Use 24-hour time. |
Adjust Interval To Enabled Start |
If Restrict Times is enabled; Specification for whether to always begin at the Enabled Start, regardless of the time interval, or to begin based on the actual interval. If Adjust Interval To Enabled Start is not selected, the start time and end time specify only the time frame/window during which the trigger is active; they do not modify the actual time interval (see Restrict Times). |
Special Restriction |
Enable this field in order to specify additional parameters that tell the Controller how to handle exceptions, such as when the trigger is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a Simple Restriction that disables the trigger if it is satisfied on a holiday identified in the calendar and/or a Complex Restriction that disables the trigger on the last business day of every month. |
Simple Restriction |
|
Situation |
If Simple Restriction is enabled, allows you to select the situation that causes the system to initiate the action specified in the Action field. Options:
|
Action |
If Special Restriction is enabled, allows you to select an action to take on a non-business day or holiday (see Situation field). Options:
|
Complex Restriction |
If enabled, allows you to specify a set of parameters that determine one or more situations when this trigger should not be satisfied. Used in conjunction with the following fields: Restriction Mode, Restriction Adjective, Restriction Noun, Restriction Qualifier. For example, you may specify that you do not want to satisfy this trigger on the last business day of the year or the first day of each month. |
Restriction Mode |
If both Simple Restriction and Complex Restriction are enabled, specifies whether you want to use both restriction types (AND) or one or the other (OR). Options:
|
Restriction Adjective |
If Complex Restriction is enabled, the type of selection. Options:
Example: The last business day of the month. |
Restriction Noun(s) |
If Complex Restriction is enabled, the day(s) you want to select. Options:
Example: The last Business Day and Sunday of the month. |
Restriction Qualifier(s) |
If Complex Restriction is enabled, the period(s) you are selecting from. Options:
Example: The last Day of Quarter, Year, and January. |
Restriction Nth Amount |
If Restriction Adjective is Nth, allows you to specify the value of N. If Restriction Qualifier is Week, Restriction Nth Amount must be <= 7. |
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 Component Details that let you perform various actions. |
Save |
Saves a new record in the Controller database. |
Save & View |
Saves a new record in the Controller database and continues to display that record. |
Update |
Saves updates to the record. |
List Qualifying Times |
Lets you generate a list of future dates and times that the trigger will trigger the specified task (see Generating a List of Qualifying Times, below). |
Delete |
Deletes the current record. |
Refresh |
Refreshes any dynamic data displayed in the Details. |
Close |
For pop-up view only; closes the pop-up view of this component. |
Agent File Monitor Component
Agent File Monitor Component Details Field Descriptions
The following table describes the fields and buttons that display in the Agent File Monitor Component Details.
Field Name |
Description |
---|---|
General |
This section contains general information about the component. |
Name |
Name used within the Controller to identify this component. It can contain a maximum of 255 alphanumerics. |
Description |
Description of this record. Maximum length is 255 characters. |
Built-In Variable Prefix |
User-specified prefix that enables built-in variables in the file(s) being monitored to be propagated up to the Composite trigger. |
Status |
This section contains information about the current status of the component. |
Status |
|
Monitor Status |
System-supplied; Lists the status of Agent File Monitor tasks currently running that were launched by this trigger. |
Agent File Monitor Details |
This section contains assorted detailed information about the component. |
Agent File Monitor |
Required; Agent File Monitor task being executed. Enter a task name, select a task from the drop-down list, or click the Task Details icon to create a new task. If a task already is specified in this field, click the Task Details icon to view the Details of that task. |
Running Monitor |
System-supplied; Name of the currently running task instance of the specified Agent File Monitor task that was launched by this enabled trigger. |
Restrictions |
This section specifies any restrictions that apply to the component. |
Restrict Times |
Period during which the component is active. Enable this field and specify the start and end times in the Enabled Start and Enabled End fields. |
Enabled Start |
If Restrict Times is enabled, allows you to specify the start time of the period during which the component should be active. Use 24-hour time. |
Enabled End |
If Restrict Times is enabled, allows you to specify the end time of the period during which the component should be active. Use 24-hour time. |
Special Restriction |
Enable this field in order to specify additional parameters that tell the Controller how to handle exceptions, such as when the component is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a Simple Restriction that disables the component if it is satisfied on a holiday identified in the calendar and/or a Complex Restriction that disables the component on the last business day of every month. |
Simple Restriction |
|
Situation |
If Simple Restriction is enabled, allows you to select the situation that causes the system to initiate the action specified in the Action field. Options:
|
Action |
If Special Restriction is enabled, allows you to select an action to take on a non-business day or holiday (see Situation field). Options:
|
Complex Restriction |
If enabled, allows you to specify a set of parameters that determine one or more situations when this component should not be satisfied. Used in conjunction with the following fields: Restriction Mode, Restriction Adjective, Restriction Noun, Restriction Qualifier. For example, you may specify that you do not want to satisfy this component on the last business day of the year or the first day of each month. |
Restriction Mode |
If both Simple Restriction and Complex Restriction are enabled, specifies whether you want to use both restriction types (AND) or one or the other (OR). Options:
|
Restriction Adjective |
If Complex Restriction is enabled, the type of selection. Options:
Example: The last business day of the month. |
Restriction Noun(s) |
If Complex Restriction is enabled, the day(s) you want to select. Options:
Example: The last Business Day and Sunday of the month. |
Restriction Qualifier(s) |
If Complex Restriction is enabled, the period(s) you are selecting from. Options:
Example: The last Day of Quarter, Year, and January. |
Restriction Nth Amount |
If Restriction Adjective is Nth, allows you to specify the value of N. If Restriction Qualifier is Week, Restriction Nth Amount must be <= 7. |
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 Component Details that let you perform various actions. |
Save |
Saves a new 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. |
Update |
Saves updates to the record. |
Delete |
Deletes the current record. |
Refresh |
Refreshes any dynamic data displayed in the Details. |
Close |
For pop-up view only; closes the pop-up view of this component. |
Task Monitor Component
Task Monitor Component Details Field Descriptions
The following table describes the fields and buttons that display in the Task Monitor Component Details.
Field Name |
Description |
---|---|
General |
This section contains general information about the component. |
Name |
Name used within the Controller to identify this component. It can contain a maximum of 255 alphanumerics. |
Description |
Description of this record. Maximum length is 255 characters. |
Built-In Variable Prefix |
User-specified prefix that enables built-in variables in the task(s) being monitored to be propagated up to the Composite trigger. |
Status |
This section contains information about the current status of the trigger. |
Status |
|
Monitor Status |
System-supplied; Lists the status of Task Monitor tasks currently running that were launched by this trigger. |
Task Monitor Details |
This section contains assorted detailed information about the component. |
Task Monitor |
Required; Task Monitor task being executed. Enter a task name, select a task from the drop-down list, or click the Task Details icon to create a new task. If a task already is specified in this field, click the Task Details icon to view the Details of that task. |
Running Monitor |
System-supplied; Name of the currently running task instance of the specified Task Monitor task that was launched by this enabled trigger. |
Restrictions |
This section specifies any restrictions that apply to the component. |
Restrict Times |
Period during which the component is active. Enable this field and specify the start and end times in the Enabled Start and Enabled End fields. |
Enabled Start |
If Restrict Times is enabled, allows you to specify the start time of the period during which the component should be active. Use 24-hour time. |
Enabled End |
If Restrict Times is enabled, allows you to specify the end time of the period during which the component should be active. Use 24-hour time. |
Special Restriction |
Enable this field in order to specify additional parameters that tell the Controller how to handle exceptions, such as when the component is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a Simple Restriction that disables the component if it is satisfied on a holiday identified in the calendar and/or a Complex Restriction that disables the component on the last business day of every month. |
Simple Restriction |
|
Situation |
If Simple Restriction is enabled, allows you to select the situation that causes the system to initiate the action specified in the Action field. Options:
|
Action |
If Special Restriction is enabled, allows you to select an action to take on a non-business day or holiday (see Situation field). Options:
|
Complex Restriction |
If enabled, allows you to specify a set of parameters that determine one or more situations when this component should not be satisfied. Used in conjunction with the following fields: Restriction Mode, Restriction Adjective, Restriction Noun, Restriction Qualifier. For example, you may specify that you do not want to satisfy this component on the last business day of the year or the first day of each month. |
Restriction Mode |
If both Simple Restriction and Complex Restriction are enabled, specifies whether you want to use both restriction types (AND) or one or the other (OR). Options:
|
Restriction Adjective |
If Complex Restriction is enabled, the type of selection. Options:
Example: The last business day of the month. |
Restriction Noun(s) |
If Complex Restriction is enabled, the day(s) you want to select. Options:
Example: The last Business Day and Sunday of the month. |
Restriction Qualifier(s) |
If Complex Restriction is enabled, the period(s) you are selecting from. Options:
Example: The last Day of Quarter, Year, and January. |
Restriction Nth Amount |
If Restriction Adjective is Nth, allows you to specify the value of N. If Restriction Qualifier is Week, Restriction Nth Amount must be <= 7. |
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 Component Details that let you perform various actions. |
Save |
Saves a new 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. |
Update |
Saves updates to the record. |
Delete |
Deletes the current record. |
Refresh |
Refreshes any dynamic data displayed in the Details. |
Close |
For pop-up view only; closes the pop-up view of this component. |
Variable Monitor Component
Variable Monitor Component Details Field Descriptions
The following table describes the fields and buttons that display in the Variable Monitor Component Details.
Field Name |
Description |
---|---|
General |
This section contains general information about the component. |
Name |
Name used within the Controller to identify this component. It can contain a maximum of 255 alphanumerics. |
Description |
Description of this record. Maximum length is 255 characters. |
Built-In Variable Prefix |
User-specified prefix that enables built-in variables in the task(s) being monitored to be propagated up to the Composite trigger. |
Status |
This section contains information about the current status of the trigger. |
Status |
|
Monitor Status |
System-supplied; Lists the status of Variable Monitor tasks currently running that were launched by this trigger. |
Variable Monitor Details |
This section contains assorted detailed information about the component. |
Variable Monitor |
Required; Variable Monitor task being executed. Enter a task name, select a task from the drop-down list, or click the Task Details icon to create a new task. If a task already is specified in this field, click the Task Details icon to view the Details of that task. Note If you click the Details icon to create or update a Variable Monitor, Change is pre-selected for the Variable Monitor Type field and cannot be changed. |
Running Monitor |
System-supplied; Name of the currently running task instance of the specified Variable Monitor task that was launched by this enabled trigger. |
Restrictions |
This section specifies any restrictions that apply to the component. |
Restrict Times |
Period during which the component is active. Enable this field and specify the start and end times in the Enabled Start and Enabled End fields. |
Enabled Start |
If Restrict Times is enabled, allows you to specify the start time of the period during which the component should be active. Use 24-hour time. |
Enabled End |
If Restrict Times is enabled, allows you to specify the end time of the period during which the component should be active. Use 24-hour time. |
Special Restriction |
Enable this field in order to specify additional parameters that tell the Controller how to handle exceptions, such as when the component is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a Simple Restriction that disables the component if it is satisfied on a holiday identified in the calendar and/or a Complex Restriction that disables the component on the last business day of every month. |
Simple Restriction |
|
Situation |
If Simple Restriction is enabled, allows you to select the situation that causes the system to initiate the action specified in the Action field. Options:
|
Action |
If Special Restriction is enabled, allows you to select an action to take on a non-business day or holiday (see Situation field). Options:
|
Complex Restriction |
If enabled, allows you to specify a set of parameters that determine one or more situations when this component should not be satisfied. Used in conjunction with the following fields: Restriction Mode, Restriction Adjective, Restriction Noun, Restriction Qualifier. For example, you may specify that you do not want to satisfy this component on the last business day of the year or the first day of each month. |
Restriction Mode |
If both Simple Restriction and Complex Restriction are enabled, specifies whether you want to use both restriction types (AND) or one or the other (OR). Options:
|
Restriction Adjective |
If Complex Restriction is enabled, the type of selection. Options:
Example: The last business day of the month. |
Restriction Noun(s) |
If Complex Restriction is enabled, the day(s) you want to select. Options:
Example: The last Business Day and Sunday of the month. |
Restriction Qualifier(s) |
If Complex Restriction is enabled, the period(s) you are selecting from. Options:
Example: The last Day of Quarter, Year, and January. |
Restriction Nth Amount |
If Restriction Adjective is Nth, allows you to specify the value of N. If Restriction Qualifier is Week, Restriction Nth Amount must be <= 7. |
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 Component Details that let you perform various actions. |
Save |
Saves a new 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. |
Update |
Saves updates to the record. |
Delete |
Deletes the current record. |
Refresh |
Refreshes any dynamic data displayed in the Details. |
Close |
For pop-up view only; closes the pop-up view of this component. |
Email Monitor Component
Email Monitor Component Details Field Descriptions
The following table describes the fields and buttons that display in the Email Monitor Component Details.
Field Name |
Description |
---|---|
General |
This section contains general information about the component. |
Name |
Name used within the Controller to identify this component. It can contain a maximum of 255 alphanumerics. |
Description |
Description of this record. Maximum length is 255 characters. |
Built-In Variable Prefix |
User-specified prefix that enables built-in variables in the task(s) being monitored to be propagated up to the Composite trigger. |
Status |
This section contains information about the current status of the trigger. |
Status |
|
Monitor Status |
System-supplied; Lists the status of Email Monitor tasks currently running that were launched by this trigger. |
Email Monitor Details |
This section contains assorted detailed information about the component. |
Email Monitor |
Required; Email Monitor task being executed. Enter a task name, select a task from the drop-down list, or click the Task Details icon to create a new task. If a task already is specified in this field, click the Task Details icon to view the Details of that task. Note If you click the Details icon to create or update an Email Monitor, Change is pre-selected for the Email Monitor Type field and cannot be changed. |
Running Monitor |
System-supplied; Name of the currently running task instance of the specified Email Monitor task that was launched by this enabled trigger. |
Restrictions |
This section specifies any restrictions that apply to the component. |
Restrict Times |
Period during which the component is active. Enable this field and specify the start and end times in the Enabled Start and Enabled End fields. |
Enabled Start |
If Restrict Times is enabled, allows you to specify the start time of the period during which the component should be active. Use 24-hour time. |
Enabled End |
If Restrict Times is enabled, allows you to specify the end time of the period during which the component should be active. Use 24-hour time. |
Special Restriction |
Enable this field in order to specify additional parameters that tell the Controller how to handle exceptions, such as when the component is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a Simple Restriction that disables the component if it is satisfied on a holiday identified in the calendar and/or a Complex Restriction that disables the component on the last business day of every month. |
Simple Restriction |
|
Situation |
If Simple Restriction is enabled, allows you to select the situation that causes the system to initiate the action specified in the Action field. Options:
|
Action |
If Special Restriction is enabled, allows you to select an action to take on a non-business day or holiday (see Situation field). Options:
|
Complex Restriction |
If enabled, allows you to specify a set of parameters that determine one or more situations when this component should not be satisfied. Used in conjunction with the following fields: Restriction Mode, Restriction Adjective, Restriction Noun, Restriction Qualifier. For example, you may specify that you do not want to satisfy this component on the last business day of the year or the first day of each month. |
Restriction Mode |
If both Simple Restriction and Complex Restriction are enabled, specifies whether you want to use both restriction types (AND) or one or the other (OR). Options:
|
Restriction Adjective |
If Complex Restriction is enabled, the type of selection. Options:
Example: The last business day of the month. |
Restriction Noun(s) |
If Complex Restriction is enabled, the day(s) you want to select. Options:
Example: The last Business Day and Sunday of the month. |
Restriction Qualifier(s) |
If Complex Restriction is enabled, the period(s) you are selecting from. Options:
Example: The last Day of Quarter, Year, and January. |
Restriction Nth Amount |
If Restriction Adjective is Nth, allows you to specify the value of N. If Restriction Qualifier is Week, Restriction Nth Amount must be <= 7. |
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 Component Details that let you perform various actions. |
Save |
Saves a new 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. |
Update |
Saves updates to the record. |
Delete |
Deletes the current record. |
Refresh |
Refreshes any dynamic data displayed in the Details. |
Close |
For pop-up view only; closes the pop-up view of this component. |
Universal Monitor Component
Universal Monitor Component Details Field Descriptions
The following table describes the fields and buttons that display in the Universal Monitor Component Details.
Field Name |
Description |
---|---|
General |
This section contains general information about the component. |
Name |
Name used within the Controller to identify this component. It can contain a maximum of 255 alphanumerics. |
Description |
Description of this record. Maximum length is 255 characters. |
Built-In Variable Prefix |
User-specified prefix that enables built-in variables in the task(s) being monitored to be propagated up to the Composite trigger. |
Status |
This section contains information about the current status of the trigger. |
Status |
|
Monitor Status |
System-supplied; Lists the status of Universal Monitor tasks currently running that were launched by this trigger. |
Universal Monitor Details |
This section contains assorted detailed information about the component. |
Universal Monitor |
Required; Universal Monitor task being executed. Enter a task name, select a task from the drop-down list, or click the Task Details icon to create a new task. If a task already is specified in this field, click the Task Details icon to view the Details of that task. Note If you click the Details icon to create or update a Universal Monitor, Change is pre-selected for the Universal Monitor Type field and cannot be changed. |
Running Monitor |
System-supplied; Name of the currently running task instance of the specified Universal Monitor task that was launched by this enabled trigger. |
Restrictions |
This section specifies any restrictions that apply to the component. |
Restrict Times |
Period during which the component is active. Enable this field and specify the start and end times in the Enabled Start and Enabled End fields. |
Enabled Start |
If Restrict Times is enabled, allows you to specify the start time of the period during which the component should be active. Use 24-hour time. |
Enabled End |
If Restrict Times is enabled, allows you to specify the end time of the period during which the component should be active. Use 24-hour time. |
Special Restriction |
Enable this field in order to specify additional parameters that tell the Controller how to handle exceptions, such as when the component is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a Simple Restriction that disables the component if it is satisfied on a holiday identified in the calendar and/or a Complex Restriction that disables the component on the last business day of every month. |
Simple Restriction |
|
Situation |
If Simple Restriction is enabled, allows you to select the situation that causes the system to initiate the action specified in the Action field. Options:
|
Action |
If Special Restriction is enabled, allows you to select an action to take on a non-business day or holiday (see Situation field). Options:
|
Complex Restriction |
If enabled, allows you to specify a set of parameters that determine one or more situations when this component should not be satisfied. Used in conjunction with the following fields: Restriction Mode, Restriction Adjective, Restriction Noun, Restriction Qualifier. For example, you may specify that you do not want to satisfy this component on the last business day of the year or the first day of each month. |
Restriction Mode |
If both Simple Restriction and Complex Restriction are enabled, specifies whether you want to use both restriction types (AND) or one or the other (OR). Options:
|
Restriction Adjective |
If Complex Restriction is enabled, the type of selection. Options:
Example: The last business day of the month. |
Restriction Noun(s) |
If Complex Restriction is enabled, the day(s) you want to select. Options:
Example: The last Business Day and Sunday of the month. |
Restriction Qualifier(s) |
If Complex Restriction is enabled, the period(s) you are selecting from. Options:
Example: The last Day of Quarter, Year, and January. |
Restriction Nth Amount |
If Restriction Adjective is Nth, allows you to specify the value of N. If Restriction Qualifier is Week, Restriction Nth Amount must be <= 7. |
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 Component Details that let you perform various actions. |
Save |
Saves a new 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. |
Update |
|