Setting Up Abort Actions

From OpsWise Documentation Wiki

Open as PDF

Contents 1 Overview 2 Attaching an Abort Action to a Task 3 Abort Actions Field Descriptions

Overview

The Abort Action allows you to abort a running process and/or overwrite the exit code generated by a process, based on specified conditions. You can trigger the action based on one or more of the following events associated with the task instance:

• Status or statuses of the task instance
• Exit code(s) generated by the program (along with at least one status)
• Late start
• Early or late finish

You can attach one or more Abort Actions to any OpsWise Automation Center task. For Workflow tasks, you can also specify whether you want the abort action instructions to apply to the workflow itself, the workflow and its tasks, or to the tasks only.

Attaching an Abort Action to a Task

1. Display the task that will generate the Abort Action.
2. Click on the Actions tab. This tab displays a list of all previously entered Actions for this task, including Abort Actions, Email Notifications, and Set Variables.
3. Click New. The Action wizard displays, as shown below.



4. Click Abort Action. The Abort Actions screen displays.



5. Using the field descriptions provided below as a guide, complete the fields as needed.
6. Click the Submit button to save the record and return to the Actions list, or, right-click and select Save to save the record and remain on the current display.
7. If appropriate, repeat these steps for any additional Actions you want to add.

Abort Actions Field Descriptions

The table below describes the fields and buttons on the Abort Actions screen.

Field Name	Description
Action Inheritance	Workflow tasks only. Specifies what records these instructions apply to. Options: SELF - These instructions apply only to the workflow. SELF/CHILDREN - These instructions apply to the workflow and its contained tasks (children). CHILDREN - These instructions apply only to the tasks within the workflow (children).
Status	The status of this task. To trigger an abort action, you can specify status only, or status and exit code. You can specify as many statuses as needed. Options: Defined - All task types. The new task instance has been created (the task has been launched). Not yet implemented. Waiting - All task types. The task has been loaded by a workflow and is waiting to run. Held - All task types. The task has been put on hold by a user. Resource Wait - The task with a virtual resource defined is waiting for enough units to become available on the virtual resource. Undeliverable - Agent-based tasks. The agent is unavailable. Queued - Agent-based tasks only. The task has been queued on a resource. Submitted - z/OS only. The task has been submitted to the z/OS Job Entry subsystem and scheduled by the z/OS Job Scheduler. Action Required - Manual tasks only. When a manual task launches, it goes into Action Required status, meaning a user must perform some manual activity. For details, see Manual task. Started - Agent-based and Manual tasks only. The task has started. For agent-based tasks, this means the agent has received the task. Running - All task types. The task is running. For agent-based tasks, the agent has started running the program. Running Problems - Workflows only. One or more tasks within the workflow has one of the following statuses: Held Undeliverable Running Problems (for sub-workflows) Cancel Pending In Doubt Start Failure Cancelled In Doubt - Agent-based tasks only. The agent is "in doubt" about the current status of the task instance. This may occur if an agent or agent connection goes down. In this case, the agent restarts and reviews its data about tasks in progress. If the agent finds a task still running, it resumes normal monitoring. If the agent cannot find the task, this usually indicates that the task completed, but the agent considers the task status to be "in doubt." Start Failure - All task types. The task was unable to start. Cancelled - All task types. The task was cancelled by a user. Failed - All task types. The task ran to a failure status. Skipped - All task types. The task was skipped by a user. Finished - All task types. The task was forced by the user to finish. The user may do this in cases where the task had "Cancelled" or "Failed" status, and the user needed to release other task instances depending on the successful completion of this task instance in a workflow. For more information, see Force Finishing a Task. Success - All task types. The task has completed successfully
Exit Codes	Specifies one or more exit codes that will trigger the Abort Action. If you specify an exit code, you must also specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Example: 1, 5, 22-30.
On Late Start	Generate the Abort Action if the task started late, based on the Late Start Time specified in the task.
On Late Finish	Generate the Abort Action if the task finishes late, based on the Late Finish time specified in the task.
On Early Finish	Generate the Abort Action if the task finishes early, based on the Early Finish Time specified in the task.
Cancel Process if Active	If enabled, instructs the system to cancel the process that was launched by this task.
Override Exit Code	Overrides the exit code returned by the process with the exit code specified in this field.
Submit button	Submits the new record to the database.
Update button	Saves updates to the record.
Delete button	Deletes the current record.