Application Control
From OpsWise Documentation Wiki
Contents |
Overview
Application Control tasks allow you to execute a start, stop, or query command against an application in the OpsWise network. Three Application Control tasks are created automatically when you define and save an Application Resource record -- one each for starting, stopping, and querying the application. The sample below shows three Application Control tasks created when an Application resource record called "Appl Tomcat" was saved to the OpsWise database:
Each of these auto-created records is stored as a separate task record and can be executed independently or added to a workflow like any other task. Shown below is the task record for the Appl Tomcat#QUERY# task that was automatically created when the Appl Tomcat Application resource record was submitted to the database. Note that many of the fields are protected and the Generated field at the bottom is selected, indicating that this task was generated automatically. You cannot delete an auto-generated Application Control task.
Creating a New Application Control Task
You can also manually create Application Control tasks. You might want to do so if you need to set different variables or conditions for different uses of the same task.
- From the Navigation Pane, select Application Control Tasks.
- From the trigger wizard, select New. OpsWise Automation Center displays the Application Control task 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 on the title bar and select Save to save the record and remain on the current display.
- If appropriate, repeat these steps for any additional tasks you want to add.
Application Control Task Field Descriptions
The table below describes the fields, buttons, and tabs on the Application Control task definition and task instance screens. Most fields appear on both screens; however they do not always appear at the same spot. In the latter case, the table provides a field description at the location found on the task definition screen. Some fields appear only on one of the screens. Field labels shown in bold appear only on the task instance screen and are labelled as such.
| Name | Description | |
|---|---|---|
| Task Name | Required; protected if auto-generated. Name used within OpsWise Automation Center to identify this task. Up to 40 alphanumerics; variables supported. Note • It is the user’s responsibility to develop a workable naming scheme for tasks. | |
| Summary | User-supplied description of this task. | |
| Application | Required; protected if auto-generated. The name of the Application resource defined using the Application resource screen. The Application resource defines where the software application is running and the start, stop, and query commands. Type in a name, or click the magnifying glass to browse to an existing Application resource record or create a new one. | |
| Command | Required; protected if auto-generated. The command this task is executing against the software application. One of the following:
|
|
| Hold on Start | If enabled, when the task is launched it appears in the Activity display with a status of Held. The task runs when the user releases it. . | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this task definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| Late Start | If enabled, and if the task instance starts after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late start (see Late Start Type below). To determine whether a task instance started late, open the task instance and locate the Started Late field; the field is checked if the instance started after the specified time or lasted longer than expected. | |
| Late Start Type | If Late Start is enabled, use this field to specify whether you want to use time (see Late Start Time below) or duration (see Late Start Duration below) to determine whether the task instance started late. | |
| Late Start Time (hh:mm) | If Late Start Type is Time, the time after which the task start time is considered late. Use hh:mm, 24-hour time. | |
| Late Start Duration | If Late Start Type is Duration, use this to specify .... You can specify any combination of days, hours, minutes, and seconds. | |
| Late Finish | If enabled, and if the task instance finishes after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late finish (see Late Finish Type below). To determine whether a task instance finished late, open the task instance and locate the Finished Late field; the field is checked if the instance finished after the specified time or lasted longer than expected. | |
| Late Finish Type | If Late Finish is enabled, use this field to specify whether you want to use time (see Late Finish Time below) or duration (see Late Finish Duration below) to determine whether the task instance finished late. | |
| Late Finish Time (hh:mm) | If Late Finish Type is Time, use this to specify the time after which the task finish time is considered late. Use hh:mm, 24-hour time. | |
| Late Finish Duration | If Late Finish Type is Duration, use this to specify the longest amount of time this task instance should take to run. You can specify any combination of days, hours, minutes, and seconds. | |
| Early Finish | If enabled, and if the task instance finishes before the time or period specified, the task instance is flagged as early. You can specify a time or duration to determine an early finish (see Early Finish Type below). To determine whether a task instance finished early, open the task instance and locate the Finished Early field; the field is checked if the instance finished before the specified time or did not last as long as expected. | |
| Early Finish Type | If Early Finish is enabled, use this field to specify whether you want to use time (see Early Finish Time below) or duration (see Early Finish Duration below) to determine whether the task instance finished early. | |
| Early Finish Time (hh:mm) | If Early Finish Type is Time, use this to specify the time before which the task finish time is considered early. Use hh:mm, 24-hour time. | |
| Early Finish Duration | If Early Finish Type is Duration, use this to specify the shortest amount of time this task instance should take to run. You can specify any combination of days, hours, minutes, and seconds. | |
| First Time Ran | System-supplied. Displays after task has been run. The date and time this task first ran. | |
| Lowest Instance Time | System-supplied. Displays after task has been run. The shortest amount of time this task has taken to run. | |
| Last Time Ran | System-supplied. Displays after task has been run. The last date and time the task ran. | |
| Average Instance Time | System-supplied. Displays after task has been run. The average amount of time this task takes to run. | |
| Number of Instances | System-supplied. Displays after task has been run. The number of times this task has run. | |
| Highest Instance Time | System-supplied. Displays after task has been run. The longest amount of time this task has taken to run. | |
| Generated | System-supplied; protected. If selected, indicates that this Application Control task was generated automatically when the Application resource record was submitted. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| Launch Task button | Manually launches the task. | |
| Delete button | Deletes the current record. | |
| Task Virtual Resources tab | Allows you to create virtual resource definitions for controlling access to resources by multiple tasks. See Creating Virtual Resources. | |
| Variables tab | Displays all variables associated with this task. | |
| Actions tab | Allows you to specify actions that the system will take automatically based on events that occur during the execution of this task. Events supported are task instance status, exit codes, late start, late finish, and early finish. Actions include:
|
|
| Task Instances tab | System-supplied. Displays a list of all instances generated by this task. | |
| Triggers tab | Displays a list of all triggers that have been defined to launch this task. Also allows you to add new triggers. For instructions, see Triggers. | |
| Notes tab | Displays all notes associated with this task. See Runbook Notes. | |
Specifying When a Task Runs
You can run the task as part of a workflow, specify triggers that run the task automatically based on times or events, or run the task manually.
Monitoring Task Execution
You can monitor all system activity from the Activity screen and can view activity history from the Activity History screen.
