Triggers
From OpsWise Documentation Wiki
Overview
A trigger specifies times or events, or both, that trigger one or more tasks. When each trigger is satisfied, OpsWise Automation Center loads the task(s) into the schedule (creates a task instance for each task) and runs it. If a task has multiple triggers, OpsWise Automation Center creates and runs a task instance each time a trigger is satisfied.
Supported triggers will run a task based on the following:
- A specific date and time, or a series of dates and times (Time, Cron, and Temporary triggers)
- Upon the creation, deletion, change, existence or non-existence of a file on a particular machine (File Monitor trigger)
Each trigger can have an unlimited number of tasks associated with it. All the specified tasks are run each time the trigger is satisfied. If you want to specify dependencies such as "run TaskB only if TaskA fails," create a Workflow, which is a series of inter-connected tasks. For more information, see Workflows.
Accessing the Triggers List Screen
From the OpsWise Automation Center Main menu, select Triggers > All Triggers or Triggers > Active Triggers. Active Triggers have the Enabled flag set. Or, select a specific type of trigger by selecting the appropriate option, such as Triggers > Cron Triggers. OpsWise Automation Center displays a list of triggers, depending on what menu option you selected.
For information about sorting, searching, and other list features, see Using Lists. Shown below is a sample list of triggers.
The following table provides column descriptions for the default column display.
| Field Name | Description |
|---|---|
| Trigger Name | User-defined. Name used within OpsWise Automation Center to identify this trigger. Up to 40 alphanumerics. It is the user’s responsibility to develop a workable naming scheme for triggers. |
| Type | User-defined. The type of trigger. Options:
|
| Description | User-defined. Copied from the Description field in the trigger. |
| Task(s) | User-defined. The name of the task being triggered by this trigger. |
| Next Scheduled Time | Supplied by OpsWise Automation Center. For time-based triggers, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information. |
| Enabled | User-defined. Whether or not the Enabled field is checked. Only enabled triggers are processed by the OpsWise Automation Center. |
Cron Trigger
OpsWise Automation Center allows you to enter Cron triggers into the system. The OpsWise Automation Center Cron trigger uses standard Cron syntax. Once the Cron trigger is entered into the system, OpsWise Automation Center interprets it and processes it as it would any other trigger. The trigger fires when the current date and time match the all the values specified in the Minutes, Hours, Day of Month, Month, and Day of Week fields.
Creating a New Cron Trigger
- From the Navigation Pane, select Cron Triggers.
- From the trigger wizard, select New. OpsWise Automation Center displays the Cron Trigger screen:
- Using the field descriptions provided below as a guide, complete the fields as needed.
- Click the Submit button to save the record and return to the menu, or, right-click the title bar and select Save to save the record and remain on the current display.
- If appropriate, repeat these steps for any additional triggers you want to add.
- Enable the trigger(s).
CRON Trigger Field Descriptions
| Field Name | Description | |
|---|---|---|
| Trigger Name | User-defined. Descriptive name assigned to this trigger. It is the user’s responsibility to develop a workable naming scheme for triggers. | |
| Enabled | Value supplied when user clicks the Enable Trigger or Disable Trigger button. Defines whether or not this trigger is active. | |
| Task(s) | User-defined. One or more tasks that will run when this trigger is satisfied. Click on the lock icon to unlock the field and select tasks. | |
| Enabled By | System-supplied. Displays the ID of the user who most recently enabled this trigger. | |
| Forecast | Enabled or disabled by user. If enabled, the system calculates the date and time when this trigger will be satisfied for the next number days specified in the Forecast Period In Days property. The system writes the forecasting entries to the Triggers > Forecasts display. | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this trigger definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| Calendar | If the user selects Special Restriction, the calendar defines what the Holidays or Non Business days are. Type in a calendar name or click the magnifying glass to browse for an existing calendar or to add a new calendar. To display details about the calendar specified in this field, hover over the paper icon. | |
| Skip Count | User-defined. Allows you to specify that OpsWise Automation Center skip the next N times this task is triggered. | |
| Skip Trigger if Active | User-defined. Allows you to specify that OpsWise Automation Center skip the next run of the specified tasks if the previous run has not gone to a complete status (is still active). | |
| Minutes | The time in minutes, using standard Cron syntax. | |
| Hours | The time in hours, using standard Cron syntax. | |
| Day of Month | The day of the month, using standard Cron syntax. | |
| Month | The month, using standard Cron syntax. | |
| Day of Week | The day of the week, using standard Cron syntax. | |
| Description | Descriptive information for this trigger. Displays in the Description field on the Triggers list. | |
| Cron Criteria | System-supplied. Provides a summary of the Cron specifications. Displays in the Cron Criteria field on the Triggers list. | |
| Next Scheduled Time | System-supplied. The date and time this trigger will next be satisfied. | |
| Special Restriction | Enable this field to specify additional parameters that tell the system how to handle exceptions such as when the trigger is satisfied on a holiday or non-business day. You can specify Simple or Complex Restrictions or both (see field descriptions below for details). For example, you may specify a Simple Restriction that disables the trigger if it is satisfied on a holiday. Or, you may chose Complex Restriction and specify more detailed parameters such do not trigger on the last business day of the month. | |
| Simple Restriction | If enabled, allows you to specify an Action such as Do Not Trigger (see below) on a non-business day or holiday (see Situation field below). For example, do not trigger on a non business day. | |
| 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 (see Action field below). Options:
|
|
| Action | If Simple Restriction is enabled, allows you to select an action to take on a non business day or holiday (see Situation field above). 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 (see details below). 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 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: 1st, 2nd, 3rd, 4th, Last. Example: The last business day of the month. | |
| Restriction Noun | If Complex Restriction is enabled, the day you want to select. Options: Sunday through Saturday, Day, or Business Day. Example: The last business day of the month. | |
| Restriction Qualifier | If Complex Restriction is enabled, the period you are selecting from. Options: January through December, Month or Year. Example: The last business day of the month. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| List Qualifying Times button | Opens a new browser and displays a list of the next 20 dates and times this trigger will be satisfied. | |
| Enable Trigger button | Activates this trigger and writes your UserID to the Enabled By field. | |
| Disable Trigger button | Deactivates this trigger. | |
| Trigger Now button | Immediately triggers all the tasks specified in this trigger. | |
| Delete button | Deletes the current record. | |
| Variables tab | Displays all variables associated with this trigger. | |
Time Trigger
The Time trigger allows you to specify dates and times at which a task will be triggered. You can define specific dates and times, such as "March 15 at 12:00 a.m.," or a series, such as "every hour of every Friday," or a mixture, such as "9 a.m. every Monday." You can specify simple date and time selection parameters, such as "every weekday at 12:00," or create more complex formulas such as "every 3 hours on the last business day of the year."
Creating a New Time Trigger
- From the Navigation Pane, select Time Triggers.
- From the trigger wizard, select New. OpsWise Automation Center displays the Time Trigger screen:
- Using the field descriptions provided below as a guide, complete the fields as needed.
- Click the Submit button to save the record and return to the menu, or, right-click the title bar and select Save to save the record and remain on the current display.
- If appropriate, repeat these steps for any additional triggers you want to add.
- Enable the trigger(s).
Time Trigger Field Descriptions
| Field Name | Description | |
|---|---|---|
| Trigger Name | User-defined. Descriptive name assigned to this trigger. It is the user’s responsibility to develop a workable naming scheme for triggers. | |
| Enabled | Value supplied when user clicks the Enable Trigger or Disable Trigger button. Defines whether or not this trigger is active. | |
| Task(s) | User-defined. One or more tasks that will run when this trigger is satisfied. Click on the lock icon to unlock the field and select tasks. | |
| Enabled By | System-supplied. Displays the ID of the user who most recently enabled this trigger. | |
| Calendar | User-defined. The calendar being used with this trigger. The calendar is used by the trigger as follows:
|
|
| Forecast | Enabled or disabled by user. If enabled, the system calculates the date and time when this trigger will be satisfied for the next number days specified in the Forecast Period In Days property. The system writes the forecasting entries to the Triggers > Forecasts display. | |
| Skip Count | User-defined. Allows you to specify that OpsWise Automation Center skip the next N times this task is triggered. A message is written to the audit table when a task run is skipped. | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this trigger definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| Skip Trigger if Active | User-defined. Allows you to specify that OpsWise Automation Center skip the next run of the specified tasks if the previous run has not gone to a complete status (Success, Finished, Failed, Cancelled, Start Failure, or Skipped). | |
| Description | User-defined. Description of this trigger. The contents of this field displays on the Trigger list. | |
| Time Zone | User-defined. Allows you to specify the timezone 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. | |
| Time Style | Specifies whether this trigger is a specific time or a series of times. Options:
|
|
| Time | Required if Time Style = Time. Specifies the time of the trigger in hours, minutes, and seconds, using 24-hour time. For example, 01:45:00 means trigger the task at 1:45 a.m.; 13:45:00 means trigger the task at 1:45 p.m. | |
| Time Interval | Required if Time Style = Time Interval. Specify a number indicating the number of Time Interval Units (see below). For example, for a Time Interval of every three hours, specify 3 in the Time Interval Field and select Hours in the Time Interval Units field. | |
| Time Interval Units | Required if Time Style = Time Interval. Select a type of time interval. Used in conjunction with the Time Interval field (see above). For example, for a Time Interval of every three hours, specify 3 in the Time Interval Field and select Hours in the Time Interval Units field. Options are:
|
|
| Starting Time | Optional. If Time Style = Time Interval, you can specify a Starting Time at which time the trigger activates. Enable the Starting Time field and specify the Starting Time in the Starting At field (see below). | |
| Starting At (hh:mm) | If Starting Time is enabled, specify the time that the trigger should activate. Use 24-hour time. | |
| Restrict Times | If Time Style = Time Interval, you can specify a period during which the trigger is active. Enable the Restrict Times field and specify the start and end times in the Enabled Start and Enabled End fields (see below). | |
| Enabled Start (hh:mm) | If Restrict Times is enabled, specify the start time of the period during which the trigger should be active. Use 24-hour time. | |
| Enabled End (hh:mm) | If Restrict Times is enabled, specify the end time of the period during which the trigger should be active. Use 24-hour time. | |
| Day Style | Allows you to indicate whether this trigger will use the typically used calendar days (Simple) or whether you are specifying a formula for the selection of days (Complex). Options:
|
|
| Daily | If Date Style = Simple, you can select this field to specify that the trigger is active every day of the week. | |
| Business Days | If Date Style = Simple, you can select this field to specify that the trigger is active on the business days specified in the calendar selected in the trigger's Calendar field. | |
| Custom Days | If Date Style = Simple, you can select this field to specify that the trigger is active on specific days. Select one or more days by selecting the Sun, Mon, Tue, Wed, Thu, Fri, and Sat fields. | |
| Date Adjective | If Day Style is Complex, you can use this field to specify which in a series of days you want to select. Used in conjunction with the Date Noun and the Date Qualifier fields. For example, to specify "the 1st business day of the month," select Date Adjective: 1st, Date Noun: Business Day, Date Qualifier: Month. Options:
|
|
| Date Noun | If Day Style is Complex, you can use this field 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 1st business day of the month," select Date Adjective: 1st, Date Noun: Business Day, Date Qualifier: Month.
This drop-down menu is populated as follows:
|
|
| Date Qualifier | If Day Style is Complex, you can use this field to specify the period for your selection formula. Used in conjunction with the Date Noun and the Date Adjective fields. For example, to specify "the 1st business day of the month," select Date Adjective: 1st, Date Noun: Business Day, Date Qualifier: Month. Options:
|
|
| Special Restriction | Enable this field to specify additional parameters that tell the system how to handle exceptions such as when the trigger is satisfied on a holiday or non-business day. You can specify Simple or Complex Restrictions or both (see field descriptions below for details). For example, you may specify a Simple Restriction that disables the trigger if it is satisfied on a holiday. Or, you may chose Complex Restriction and specify more detailed parameters such do not trigger on the last business day of the month. | |
| Simple Restriction | If enabled, allows you to specify an Action such as Do Not Trigger (see below) on a non-business day or holiday (see Situation field below). For example, do not trigger on a non business day. | |
| 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 (see Action field below). Options:
|
|
| Action | If Simple Restriction is enabled, allows you to select an action to take on a non business day or holiday (see Situation field above). 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 (see details below). 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 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: 1st, 2nd, 3rd, 4th, Last. Example: The last business day of the month. | |
| Restriction Noun | If Complex Restriction is enabled, the day you want to select. Options: Sunday through Saturday, Day, or Business Day. Example: The last business day of the month. | |
| Restriction Qualifier | If Complex Restriction is enabled, the period you are selecting from. Options: January through December, Month or Year. Example: The last business day of the month. | |
| Next Scheduled Time | System-supplied. The date and time this trigger will next be satisfied. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| List Qualifying Times button | Opens a new browser and displays a list of the next 20 dates and times this trigger will be satisfied. | |
| Enable Trigger button | Activates this trigger and writes your UserID to the Enabled By field. | |
| Disable Trigger button | Deactivates this trigger. | |
| Trigger Now button | Immediately triggers all the tasks specified in this trigger. | |
| Delete button | Deletes the current record. | |
| Variables tab | Displays all variables associated with this trigger. | |
Generating a List of Qualifying Times
OpsWise Automation Center allows you to create a list of future dates and times that this trigger will trigger the specified task. Click the List Qualifying Times button. OpsWise Automation Center opens a new browser tab and displays a list of the next 20 dates and times.
Temporary Trigger
The Temporary trigger allows you to set up a one-time trigger for a task, based on a single date and time. You will use this trigger if you want to set up a task to run once at some time in the future.
Creating a New Temporary Trigger
- From the Navigation Pane, select Temporary Triggers.
- From the trigger wizard, select New. OpsWise Automation Center displays the Temporary Trigger screen:
- Using the field descriptions provided below as a guide, complete the fields as needed.
- Click the Submit button to save the record and return to the menu, or, right-click the title bar and select Save to save the record and remain on the current display.
- If appropriate, repeat these steps for any additional triggers you want to add.
- Enable the trigger(s).
Temporary Trigger Field Descriptions
| Field Name | Description | |
|---|---|---|
| Trigger Name | User-defined. Required. Descriptive name assigned to this trigger. It is the user’s responsibility to develop a workable naming scheme for triggers. | |
| Enabled | Value supplied when user clicks the Enable Trigger or Disable Trigger button. Defines whether or not this trigger is active. | |
| Task(s) | User-defined. One or more tasks that will run when this trigger is satisfied. Click on the lock icon to unlock the field and select tasks. | |
| Enabled By | System-supplied. Displays the ID of the user who most recently enabled this trigger. | |
| Calendar | Not used. | |
| Forecast | Enabled or disabled by user. If enabled, the system calculates the date and time when this trigger will be satisfied for the next number days specified in the Forecast Period In Days property. The system writes the forecasting entries to the Triggers > Forecasts display. | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this trigger definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| Description | User-defined. A description for the trigger. | |
| Date | The date you want the task to be triggered. | |
| Time | The time you want the task to be triggered. Use 24-hour time. | |
| Time Zone | User-defined. Allows you to specify the timezone 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. | |
| Next Scheduled Time | System-supplied. The date and time this trigger will next be satisfied. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| Enable Trigger button | Activates this trigger and writes your UserID to the Enabled By field. | |
| Disable Trigger button | Deactivates this trigger. | |
| Trigger Now button | Immediately triggers all the tasks specified in this trigger. | |
| Delete button | Deletes the current record. | |
| Variables tab | Displays all variables associated with this trigger. | |
Manual Trigger
The Manual trigger allows you to launch a task(s) immediately, while overriding one or more user-defined variables used by the task. You will use this trigger if you want to manually launch a task but cannot use the Launch Task or Trigger Now buttons because you need to override one or more variables. For example, you might choose to use a Manual trigger to launch a "generic" workflow that you run occasionally with a slight variation in specific details. In this case, you will launch the workflow and pass in the appropriate details using variables you define in the Manual trigger.
You can use the Manual trigger to set values to pre-existing variables or create new variables. The variable values you enter here override all others. However, the change in value only persists while the launched task(s) is running. Future executions of the task(s), unless they are launched by a Manual trigger, will use the standard methods for resolving user-defined variables.
The audit message created when you use Manual trigger is the same as Trigger Now.
Creating a New Manual Trigger and Triggering One or More Tasks
- From the Navigation Pane, select Manual Triggers.
- From the trigger wizard, select New. OpsWise Automation Center displays the Manual Trigger screen:
- Using the field descriptions provided below as a guide, complete the fields as needed.
- Right-click the title bar and select Save to save the record and remain on the current display.
- Two methods are available for entering variables: using the Trigger With Variables popup window or using the Variables tab and Trigger Now button. If you want to preserve information about the variables you are overriding (the name and value), or if you want to specify default values, use the Variables tab. If you set up a Manual trigger with default values in the Variables tab, any values you set using the Trigger With Variables popup window override the values in the Variables tab. Each method is described below:
- Click the down-arrow to access the Right-Click menu. A menu displays showing the Trigger With Variables option.
- Select Trigger With Variables. A pop-up window displays that allows you to enter up to six variables that will be used when executing the task(s) named in the Manual trigger. These can be existing or new variables.
- When you are finished, click Submit in the pop-up window to launch the tasks named in the trigger. When you click Submit, the variable information in this window is used where referenced in the task execution and the contents of the window are deleted.
- Click the Variables tab.
- Use the New button to add the variables you want to modify for this task run.
- When you are finished, return to the main Trigger page and click Trigger Now to launch the tasks named in the trigger.
- If appropriate, repeat these steps for any additional triggers you want to add.
Using the Right-Click Menu:
or
Using the Variables Tab
Manual Trigger Field Descriptions
| Field Name | Description | |
|---|---|---|
| Trigger Name | User-defined. Required. Descriptive name assigned to this trigger. It is the user’s responsibility to develop a workable naming scheme for triggers. | |
| Task(s) | User-defined. One or more tasks that will run when this trigger is satisfied. Click on the lock icon to unlock the field and select tasks. | |
| Description | User-defined. A description for the trigger. | |
| Calendar | Not used. | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this trigger definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| Trigger Now button | Immediately launches all the tasks specified in this trigger. | |
| Delete button | Deletes the current record. | |
| Variables tab | Displays the variables that will be temporarily overridden when this trigger executes the specified tasks. | |
File Trigger
The File Monitor trigger allows you to trigger a task based on the creation, deletion, change, existence or non-existence of a file on a particular machine. As illustrated below, the trigger works by executing a File Monitor task, which specifies the remote machine (Windows, Linux, Unix, z/OS) and what kind of file event triggers the new task to run (create, delete, and so on). When the File Monitor task notifies the trigger that the File Monitor event has occurred, the trigger then runs the specified task.
Prerequisites
Before you can use a File Trigger, you need the following:
- A Windows, Unix, Linux, or z/OS agent, which will execute the File Monitor task.
- A File Monitor task, which watches for the creation, deletion, change, existence, or non-existence of a file.
Creating a New File Trigger
- From the Navigation Pane, select File Triggers.
- From the trigger wizard, select New. OpsWise Automation Center displays the File Monitor Trigger screen:
- Using the field descriptions provided below as a guide, complete the fields as needed.
- Click the Submit button to save the record and return to the menu, or, right-click the title bar and select Save to save the record and remain on the current display.
- If appropriate, repeat these steps for any additional triggers you want to add.
- Enable the trigger(s).
File Monitor Trigger Field Descriptions
| Field Name | Description | |
|---|---|---|
| Trigger Name | User-defined. Descriptive name assigned to this trigger. It is the user’s responsibility to develop a workable naming scheme for triggers. | |
| Enabled | Value supplied when user clicks the Enable Trigger or Disable Trigger button. Defines whether or not this trigger is active. | |
| File Monitor | User-defined. The File Monitor task being executed. Type in a task name or click the magnifying glass to browse for an existing task or to add a new task. To display details about the task specified in this field, hover over the paper icon. | |
| Enabled By | System-supplied. Displays the ID of the user who most recently enabled this trigger. | |
| Task(s) | User-defined. One or more tasks that will run when this trigger is satisfied. Click on the lock icon to unlock the field and select tasks. | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this trigger definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| Calendar | If the user selects Special Restriction, the calendar defines what the Holidays or Non Business days are.
Type in a calendar name or click the magnifying glass to browse for an existing calendar or to add a new calendar. To display details about the calendar specified in this field, hover over the paper  icon. |
|
| Running Monitor | System-supplied. Lists File Monitor tasks currently running that were launched by this trigger. | |
| Skip Count | User-defined. Allows you to specify that OpsWise Automation Center skip the next N times this task is triggered. | |
| Skip Trigger if Active | User-defined. Allows you to specify that OpsWise Automation Center skip the next run of the specified tasks if the previous run has not gone to a complete status (is still active). | |
| Description | Description of this trigger. | |
| Restrict Times | You can specify a period during which the trigger is active. Enable the Restrict Times field and specify the start and end times in the Enabled Start and Enabled End fields (see below). | |
| Time Zone | User-defined. Allows you to specify the timezone that will be applied to the times specified in the Restrict Times parameters. For example, if you specify an Enabled Start of 23:00, an Enabled End of 24:00, and a time zone of Canada/Central, the trigger is enabled at 11:00 p.m. and disabled at 12:00 a.m., Central Canada time. | |
| Enabled Start (hh:mm) | If Restrict Times is enabled, specify the start time of the period during which the trigger should be active. Use 24-hour time. | |
| Enabled End (hh:mm) | If Restrict Times is enabled, specify the end time of the period during which the trigger should be active. Use 24-hour time. | |
| Special Restriction | Enable this field to specify additional parameters that tell the system how to handle exceptions such as when the trigger is satisfied on a holiday or non-business day. You can specify Simple or Complex Restrictions or both (see field descriptions below for details). For example, you may specify a Simple Restriction that disables the trigger if it is satisfied on a holiday. Or, you may chose Complex Restriction and specify more detailed parameters such do not trigger on the last business day of the month. | |
| Simple Restriction | If enabled, allows you to specify the Action: Do Not Trigger (see below) on a non-business day or holiday (see Situation field below). For example, do not trigger on a non business day. | |
| Situation | If Simple Restriction is enabled, allows you to select the situation that prevents the trigger from being satisfied. Used in conjunction with the Action field below. Options:
|
|
| Action | If Simple Restriction is enabled, allows you to select Do Not Trigger as the action to take on a non business day or holiday (see Situation field above). Options: Do Not Trigger. | |
| 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 (see details below). 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 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: 1st, 2nd, 3rd, 4th, Last. Example: The last business day of the month. | |
| Restriction Noun | If Complex Restriction is enabled, the day you want to select. Options: Sunday through Saturday, Day, or Business Day. Example: The last business day of the month. | |
| Restriction Qualifier | If Complex Restriction is enabled, the period you are selecting from. Options: January through December, Month or Year. Example: The last business day of the month. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| Enable Trigger button | Activates this trigger and writes your UserID to the Enabled By field. | |
| Disable Trigger button | Deactivates this trigger. | |
| Trigger Now button | Immediately triggers all the tasks specified in this trigger. | |
| Delete button | Deletes the current record. | |
| Variables tab | Displays all variables associated with this trigger. | |
Task Monitor Trigger
The Task Monitor Trigger allows you to trigger one or more tasks based on the conditions specified in an associated Task Monitor task.
Each Task Monitor trigger is associated with a single Task Monitor task that monitors any number of running tasks for the specified conditions. When you enable this trigger, its associated Task Monitor task launches. When you disable this trigger, its associated Task Monitor task finishes.
You can trigger any number of tasks when the conditions in the associated Task Monitor are satisfied.
The following diagram shows an example of how you might set up a task monitoring scheme using the Task Monitor task and Task Monitor trigger.
Prerequisites
Before you can use a Task Monitor Trigger, you need a Task Monitor task, which defines the statuses being monitored for and the tasks being monitored.
Creating a New Task Monitor Trigger
- From the Navigation Pane, select Task Monitor Triggers.
- From the trigger wizard, select New. OpsWise Automation Center displays the Task Monitor Trigger screen:
- Using the field descriptions provided below as a guide, complete the fields as needed.
- Click the Submit button to save the record and return to the menu, or, right-click the title bar and select Save to save the record and remain on the current display.
- If appropriate, repeat these steps for any additional triggers you want to add.
- Enable the trigger(s). When you enable the trigger, its associated Task Monitor task launches.
Task Monitor Trigger Field Descriptions
| Field Name | Description | |
|---|---|---|
| Trigger Name | User-defined. Descriptive name assigned to this trigger. It is the user’s responsibility to develop a workable naming scheme for triggers. | |
| Enabled | Value supplied when user clicks the Enable Trigger or Disable Trigger button. Defines whether or not this trigger is active. When you enable this trigger, its associated Task Monitor task launches. When you disable this trigger, its associated Task Monitor task finishes. | |
| Task Monitor | User-defined. The Task Monitor task being executed. Type in a task name or click the magnifying glass to browse for an existing task or to add a new task. To display details about the task specified in this field, hover over the paper icon. | |
| Enabled By | System-supplied. Displays the ID of the user who most recently enabled this trigger. | |
| Task(s) | User-defined. One or more tasks that will run when this trigger is satisfied. Click on the lock icon to unlock the field and select tasks. | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this trigger definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| Calendar | User-defined. The calendar being used with this trigger. The calendar is used by the trigger as follows:
|
|
| Skip Count | User-defined. Allows you to specify that OpsWise Automation Center skip the next N times this task is triggered. | |
| Skip Trigger if Active | User-defined. Allows you to specify that OpsWise Automation Center skip the next run of the specified tasks if the previous run has not gone to a complete status (is still active). | |
| Description | Description of this trigger. | |
| Special Restriction | Enable this field to specify additional parameters that tell the system how to handle exceptions such as when the trigger is satisfied on a holiday or non-business day. You can specify Simple or Complex Restrictions or both (see field descriptions below for details). For example, you may specify a Simple Restriction that disables the trigger if it is satisfied on a holiday. Or, you may chose Complex Restriction and specify more detailed parameters such do not trigger on the last business day of the month. | |
| Simple Restriction | If enabled, allows you to specify the Action: Do Not Trigger (see below) on a non-business day or holiday (see Situation field below). For example, do not trigger on a non business day. | |
| Situation | If Simple Restriction is enabled, allows you to select the situation that prevents the trigger from being satisfied. Used in conjunction with the Action field below. Options:
|
|
| Action | If Simple Restriction is enabled, allows you to select Do Not Trigger as the action to take on a non business day or holiday (see Situation field above). Options: Do Not Trigger. | |
| 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 (see details below). 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 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: 1st, 2nd, 3rd, 4th, Last. Example: The last business day of the month. | |
| Restriction Noun | If Complex Restriction is enabled, the day you want to select. Options: Sunday through Saturday, Day, or Business Day. Example: The last business day of the month. | |
| Restriction Qualifier | If Complex Restriction is enabled, the period you are selecting from. Options: January through December, Month or Year. Example: The last business day of the month. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| Enable Trigger button | Activates this trigger and writes your UserID to the Enabled By field. When you enable this trigger, its associated Task Monitor task launches. | |
| Disable Trigger button | Deactivates this trigger. When you disable this trigger, its associated Task Monitor task finishes. | |
| Trigger Now button | Immediately triggers all the tasks specified in this trigger. | |
| Delete button | Deletes the current record. | |
| Variables tab | Displays all variables associated with this trigger. | |
Application Monitor Trigger
The Application Monitor Trigger allows you to trigger one or more tasks based on the status of:
- A specific application resource
- One or more application resources, based on selection criterion you supply.
You can launch any number of tasks when the conditions in the trigger are satisfied.
For example, if you specify Application Monitor Condition = ALL, and select all Application types, the trigger monitors all Application resource records you have defined. Any time any one of them goes to any of the Statuses you specified in the Status(es) fields, the trigger launches the task(s) specified in the Task(s) field.
Creating a New Application Monitor Trigger
- From the Navigation Pane, select Application Monitor Triggers.
- From the trigger wizard, select New. OpsWise Automation Center displays the Application Monitor Trigger screen:
- Using the field descriptions provided below as a guide, complete the fields as needed.
- Click the Submit button to save the record and return to the menu, or, right-click the title bar and select Save to save the record and remain on the current display.
- If appropriate, repeat these steps for any additional triggers you want to add.
- Enable the trigger(s). Once the trigger is enabled, it monitors the Application resource(s) specified in the Monitoring Type fields.
Application Monitor Trigger Variables
Three built-in variables are provided to pass information about the Application being monitored into the task or tasks being launched by the trigger. The variables are:
- ${ops_trigger_appl_name} - The name of the Application resource being monitored.
- ${ops_trigger_appl_status} - The status of the Application resource that satisfied the trigger.
- ${ops_trigger_appl_type} - The type of resource, as defined by the Application Type field.
You can pass the above information into the launched tasks by including the variables in a text field in the task definition.
Application Monitor Trigger Field Descriptions
| Field Name | Description | |
|---|---|---|
| Trigger Name | User-defined. Descriptive name assigned to this trigger. It is the user’s responsibility to develop a workable naming scheme for triggers. | |
| Enabled | Value supplied when user clicks the Enable Trigger or Disable Trigger button. Defines whether or not this trigger is active. | |
| Task(s) | User-defined. One or more tasks that will run when this trigger is satisfied. Click on the lock icon to unlock the field and select tasks. | |
| Enabled By | System-supplied. Displays the ID of the user who most recently enabled this trigger. | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this trigger definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| Calendar | User-defined. The calendar being used with this trigger. The calendar is used by the trigger as follows:
|
|
| Skip Count | User-defined. Allows you to specify that OpsWise Automation Center skip the next N times this task is triggered. | |
| Skip Trigger if Active | User-defined. Allows you to specify that OpsWise Automation Center skip the next run of the specified tasks if the previous run has not gone to a complete status (is still active). | |
| Description | Description of this trigger. | |
| Status(s) | System-supplied. The application status being monitored for. One or more of the following:
|
|
| Monitoring Type | Indicates whether you are monitoring one specific Application resource or want to provide selection parameters to monitor multiple Application resources. See Applications for information about setting up Application resources. Options:
|
|
| Application Monitor Condition | If Monitoring Type is "General Application(s)," this allows you to specify selection parameters, as follows:
|
|
| Condition Value | If Application Monitor Condition = Starts With, Contains, or Ends With, use this field to specify the search string. | |
| Application Type(s) | All Application resource definitions include a field called Application Type. You can use this information to select Application resources for monitoring based on what type they are. For example, you may want to monitor all Windows services. The options in the Application resource definitions match the options on this screen:
|
|
| Special Restriction | Enable this field to specify additional calendar-related parameters that tell the system how to handle exceptions such as when the trigger is satisfied on a holiday or non-business day. You can specify Simple or Complex Restrictions or both (see field descriptions below for details). For example, you may specify a Simple Restriction that disables the trigger if it is satisfied on a holiday. Or, you may chose Complex Restriction and specify more detailed parameters such do not trigger on the last business day of the month. | |
| Simple Restriction | If enabled, allows you to specify the Action: Do Not Trigger (see below) on a non-business day or holiday (see Situation field below). For example, do not trigger on a non business day. | |
| Situation | If Simple Restriction is enabled, allows you to select the situation that prevents the trigger from being satisfied. Used in conjunction with the Action field below. Options:
|
|
| Action | If Simple Restriction is enabled, allows you to select Do Not Trigger as the action to take on a non business day or holiday (see Situation field above). Options: Do Not Trigger. | |
| 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 (see details below). 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 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: 1st, 2nd, 3rd, 4th, Last. Example: The last business day of the month. | |
| Restriction Noun | If Complex Restriction is enabled, the day you want to select. Options: Sunday through Saturday, Day, or Business Day. Example: The last business day of the month. | |
| Restriction Qualifier | If Complex Restriction is enabled, the period you are selecting from. Options: January through December, Month or Year. Example: The last business day of the month. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| Enable Trigger button | Activates this trigger and writes your UserID to the Enabled By field. | |
| Disable Trigger button | Deactivates this trigger. When you disable this trigger, its associated Application Monitor task finishes. | |
| Trigger Now button | Immediately triggers all the tasks specified in this trigger. | |
| Delete button | Deletes the current record. | |
| Variables tab | Displays all variables associated with this trigger. | |
Enabling and Disabling Triggers
OpsWise Automation Center only processes triggers that are flagged as Enabled. For tracking and compliance purposes, you must use the Enable Trigger and Disable Trigger buttons to enable and disable triggers. This process saves an audit record detailing the event. The trigger record also displays the ID of the user who enabled it. When you define and submit a new trigger, you must then enable it in order for the system to begin processing it.
Note: This does not apply to Manual triggers.
Enabling/Disabling One or More Triggers
- Display the Triggers list or Active Triggers list.
- For each trigger you want to enable or disable, click the box in the leftmost column.
- From the Actions on selected rows... menu at the bottom of the list, select Enable Triggers or Disable Triggers as appropriate. The Enabled flag on the trigger is modified as appropriate.
Enabling/Disabling a Single Trigger
- From the triggers list, right-click the trigger you want to enable or disable. A drop-down menu displays.
- Select Enable Trigger or Disable Trigger as appropriate. The Enabled flag on the trigger is modified.
Or,
- Display the trigger you want to enable or disable.
- Click Enable Trigger or Disable Trigger as appropriate. The Enabled flag on the trigger is modified.
Enabling/Disabling One or More Triggers from the Command Line
See Command Line Reference for instructions.
Triggering with Variables
Overview
OpsWise provides two methods that allow you to manually launch all the tasks associated with a trigger while supplying variable values used by the task(s). These options are available for all trigger types. You will use one of these methods if you want to manually launch the task(s) but cannot use the Launch Task button because you need to override one or more variables.
Two methods are available for triggering tasks while supplying variable values:
- Using the Trigger With Variables popup window. Use this option if you do not want the values you enter for variables to persist. With this option, the values persist only for the time the task(s) is running.
- Using the Variables tab and Trigger Now button. If you want to preserve information about the variables you are setting (the name and value), use the Variables tab.
The variable values you enter when using either option override all others. The variables in the Launch with Variables window override any specified in the Variables tab, but only for this run of the task(s).
The audit message created when you use either method to Trigger with Variables is the same as Trigger Now.
Procedure
Display the Trigger whose tasks you want to launch, and select one of the methods below.
Using the Trigger with Variables Option
- Click the down-arrow or right-click on the title bar to access the Right-Click menu. A menu displays showing the Trigger With Variables option.
- Select Trigger With Variables. A pop-up window displays that allows you to enter up to six variables that will be used when executing the task(s) named in the trigger. These can be existing or new variables.
- When you are finished, click Submit in the pop-up window to launch the tasks named in the trigger. When you click Submit, the variable information in this window is used where referenced in the tasks. After launching the tasks, the system deletes the contents of the window.
Using the Variables Tab
- Click the Variables tab.
- Use the New button to add the variables you want to modify.
- When you are finished, return to the main Trigger page and click Trigger Now to launch the tasks named in the trigger.
Satisfying Trigger(s) from the Command Line
See Command Line Reference for instructions.
Displaying the Status of Trigger(s) from the Command Line
See Command Line Reference for instructions.
Exporting/Importing Trigger(s) from the Command Line
See Command Line Reference for instructions.
Copying, Deleting or Modifying a Trigger
To copy, delete or modify a trigger, select All Triggers or Active Triggers from the Navigation Pane, or, select a specific type of trigger to narrow the list. Follow the appropriate procedure below.
Copying a Trigger
- Display the trigger you want to copy.
- Enter any changes needed. Make sure you give the new trigger a different name.
- Right-click on the title bar and select Insert.
Deleting a Trigger
- Click the box in the leftmost column of the trigger you want to delete. You can click as many as you want. To select all Triggers for deletion, click the box next to the Actions on selected rows... menu.
- From the Actions on selected rows... menu, select Delete. The UI prompts for a confirmation.
- Click OK to confirm.
Modifying a Trigger
- Click on the trigger you want to modify. OpsWise Automation Center opens the Trigger screen and displays the trigger.
- Make the necessary changes and click the Update button.
