Sleep

From OpsWise Documentation Wiki

Open as PDF

Contents 1 Overview 2 Creating a New Sleep Task 3 Sleep Task Field Descriptions 4 Specifying When a Task Runs 5 Monitoring Task Execution

Overview

The Sleep task allows you to execute a sleep command for a specified number of seconds, a different type of duration such as minutes or days, or until a specific time. This task is helpful, for example, if you need to impose a pause in the processing of a workflow.

Creating a New Sleep Task

1. From the Navigation Pane, select Sleep Tasks.
2. From the trigger wizard, select New. OpsWise Automation Center displays the Sleep Task screen.
3. Using the field descriptions provided below as a guide, complete the fields as needed.
4. 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.
5. If appropriate, repeat these steps for any additional tasks you want to add.

Shown below is a sample Sleep task screen. Task run statistics appear after the first time this task has been launched.

Sleep Task Field Descriptions

The table below describes the fields, buttons, and tabs on the Sleep 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.

Field Name	Description
Task Name	Required. Name used within OpsWise Automation Center to identify this task. Up to 40 alphanumerics; variables supported. It is the user’s responsibility to develop a workable naming scheme for tasks.
Invoked by	Task instance only; system-supplied. How the task instance was launched. Options: Trigger: [Trigger Name] - The instance was launched by the named trigger. Workflow: [Workflow Name] - The instance was launched by the named workflow. Manually Launched - The instance was launched by a user. To identify the user who launched the instance:
Task	Task instance only; system-supplied.
Instance Reference Id	Task instance only; system-supplied.
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.
Sleep Type	User-supplied. The type of sleep command you want to execute. Options: Seconds - Use the Sleep Time (secs) field to specify the number of seconds. Duration - Use the Sleep Duration field to specify the number of days, hours, minutes, and/or seconds. Time - Use the Sleep Until Time (hh:mm) field to specify the time you want the sleep command to complete.
Sleep Time	User-supplied. If Sleep Type = Seconds, the number of seconds the Sleep should last.
Sleep Duration	User-supplied. If Sleep Type = Duration, the number of days, hours, minutes and/or seconds the Sleep should last.
Sleep Until Time	User-supplied. If Sleep Type = Time, the time the Sleep command should go to complete status. Use 24-hour time
Summary	User-supplied description of this task.
Status	Task instance only; system-supplied. See Task Status.
Status Description	Task instance only; system-supplied. Provides additional information, if any, about the status of the task.
Start Time	Task instance only; system-supplied. The time the task started.
End Time	Task instance only; system-supplied. The time the task completed.
Duration	Task instance only; system-supplied. The amount of time the task took to run.
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. .
Late Start	If enabled, and if the task instance starts after the time specified in the Late Start Time field (see below), the task instance is flagged as late. 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 late.
Late Start Time (hh:mm)	The time after which the task start time is considered late. Use hh:mm, 24-hour time.
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.
Last Time Ran	System-supplied. Displays after task has been run. The last date and time the task ran.
Number of Instances	System-supplied. Displays after task has been run. The number of times this task has run.
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: Abort Action - Abort the task if certain events occur. For details, see Setting Up Abort Actions. Email Notification - Send an email if certain events occur. For details, see Creating Email Notifications. SNMP Notification - Send an email if certain events occur. For details, see Creating SNMP Notifications. Set Variable - Set a variable if certain events occur. For details, see Setting Variables in a Workflow.
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.