Skip to main content

Task Functions

The command line syntax for each execution of the CLI command, uagcmd, must specify a single CLI function, required / optional Global parameters, and required / optional function-specific parameters. You must use the required Global parameters to connect to OMS Servers and to log on to a Controller (User ID and Password).

Universal Controller supports the following CLI functions for Tasks, which are listed alphabetically on this page.

Syntax, parameters, and examples for each function are provided.

Cancel Task​

Description

Cancels the specified task instance.

See Cancelling a Task Instance for a description of behavior and restrictions.

Syntax

uagcmd ops-task-cancel global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter

  • task-instance=

    Required; An internal Universal Controller identifier.

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-task-cancel -c config.cfg task-instance-name=Task A

Clear All Dependencies​

Description

Clears all dependencies of a task instance.

Syntax

uagcmd ops-task-clear-dependencies global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>]

Parameters

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-task-clear-dependencies -c config.cfg task-instance-name=Task A

Clear Virtual Resource Dependencies​

Description

Clears all virtual resource dependencies of a task instance.

Syntax

uagcmd ops-task-clear-resources global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>] resource-name=<name>

Parameters

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.
  • resource-name=
    Required; One of the following:
    • Name of the virtual resource dependency to clear.
    • An asterisk ( * ) to clear all virtual resource dependencies.

Example

uagcmd ops-task-clear-resources -c config.cfg task-instance-name=Task A resource-name=Resource A

Clear Exclusive Dependencies​

Description

Clears all exclusive dependencies of a task instance.

Syntax

uagcmd ops-task-clear-exclusive global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>]

Parameters

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-task-clear-exclusive -c config.cfg task-instance-name=Task A

Clear Time Dependency​

Description

Clears the time dependency of a task instance.

Syntax

uagcmd ops-task-clear-timewait global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>]

Parameters

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-task-clear-timewait -c config.cfg task-instance-name=Task A

Display All Tasks​

Description

Displays all specified tasks.

Syntax

uagcmd ops-task-list global parameters task-name=<name> [task-type=<type>]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameters

  • task-name=
    Optional; Name or partial name of one or more tasks. Wildcards are supported.
  • task-type=
    Optional; One of the following (not case sensitive): application_control, approval, email, email_monitor, agent_file_monitor, ftp, ibm_i, remote_file_monitor, indesca / universal_command / ucmd, manual, peoplesoft, recurring, sap, sql, stored_procedure, system_monitor, task_monitor, timer, universal, universal_monitor, unix, variable_monitor, web_service, windows, workflow, zos, z/os_monitor

Example

uagcmd ops-task-list -c config.cfg task-name=Task A task-type=timer

Display Task Instance Status​

Description

Displays the status of all task instance(s) associated with the specified task.

Syntax

uagcmd ops-task-status global parameters task-instance-name=<name> [agent-name=<name>] [task-type=<type>] [task-status=<status>] [{workflow-instance-id=<id>] | [workflow-instance-name=<name>}] [workflow-instance-criteria=<criteria>] [options=v]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameters

  • task-name=

    Required; Name or partial name of one or more tasks. Wildcards are supported.

warning

Replaced by task-instance-name= parameter; the command first will check for task-name=; if it is not specified, the command will check for task-instance-name=.

  • task-instance-name=
    Optional; Name of the task instance(s) to be listed. Wildcards are supported.
  • agent-name=
    Optional; Name of the agent the task instance(s) are running on.
  • task-type=
    Optional; One of the following (not case sensitive): application_control, approval, email, email_monitor, agent_file_monitor, ftp, ibm_i, remote_file_monitor, indesca / universal_command / ucmd, manual, peoplesoft, recurring, sap, sql, stored_procedure, system_monitor, task_monitor, timer, universal, universal_monitor, unix, variable_monitor, web_service, windows, workflow, zos, z/os_monitor
  • task-status=
    Optional; List of comma-separated task status codes and/or names (not case sensitive): status code or name,status code or name,...,status code or name. An exclamation mark (!) preceding a task status code or name excludes task instances with that status.
  • workflow-instance-id=
    For a task instance in a workflow, optional if workflow-instance-name= is not specified; sys_id of the workflow instance.
  • workflow-instance-name=
    For a task instance in a workflow, optional if workflow-instance-id= is not specified; Name of the workflow instance. (If workflow-instance-criteria= is not specified, the oldest active Workflow instance with the matching name will apply.)
  • workflow-instance-criteria=
    Optional, if workflow-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.
  • options=
    Optional; v (Return verbose results.)

Example

uagcmd ops-task-status -c config.cfg task-instance-name=mantask agent-name=managent task-type=manual

Task Instance Status Types​

The following table describes all possible task instance statuses for all task types.

info

The format of multi-word task status names specified in the Task Instance Status CLI function differs from the format of task status names used in the Controller user interface. In Task Instance Status, the words are separated by an underscore character; in the user interface, they are separated by a space.

Status Name

Status Code

Task Type

Description

Action_Required

60

Manual

When a manual task launches, it goes into Action Required status, meaning a user must perform some manual activity. For details, see Manual task.

Approval_Required

55

Approval

When an Approval Task launches, it goes into Approval Required status, meaning the Approval Task instance is waiting for action from its approver(s). For details, see Approval Task.

Approved

195

Approval

The Approval Criteria have been satisfied for this task instance.

Cancel_Pending

99

Agent-based

A process running on the Agent needs to be terminated. When the Cancel command is issued, the task instance will go into a Cancel Pending status until the Agent reports back that the process has been cancelled. At that point, the task instance will transition into the Cancelled status.

Cancelled

130

All

The task was cancelled by a user.

Confirmation_Required

125

z/OS

If you make JCL changes and restart a z/OS task, Universal Controller will put the task into Confirmation Required status and prompt you for a confirmation. For detailed processing steps, see Rerunning a z/OS Task.

Defined

0

All

The new task instance has been created (the task has been launched).

Exclusive_Requested

22

All

All tasks with a mutually exclusive task defined go immediately to a status of Exclusive Requested. If the task is available to run exclusively, the task then moves to the next appropriate processing status.

Exclusive_Wait

23

All

The task is mutually exclusive with one or more other tasks, and it is waiting for those tasks to finish before it will run.

Execution_Wait

33

Agent-based

The task must wait to be completed; either the Agent/Agent Cluster running the task has reached its Task Execution Limit, or the ability of the Agent/Agent Cluster to run tasks has been suspended.

Failed

140

All* (except Approval)

The task ran to a failure status.

Finished

190

All

The task was forced by the user to finish. The user may do this in cases where the task had a 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 Instance.

Held

20

All

The task has been put on hold by a user.

In_Doubt

110

Agent-based

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."

Instance_Wait

17

All

The task instance has been loaded by a workflow and is waiting on a previous instance(s) of the same task based on the Instance Wait Resolved specification.

Queued

40

Agent-based

The task has been queued on a resource.

Rejected

145

Approval

The Approval Criteria can no longer be satisfied for this task instance.

Resource_Requested

25

All

All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is available, the task then moves to the next appropriate processing status.

Resource_Wait

30

All

All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is not available, the task goes to a status of Resource Wait. When the resource becomes available, the task moves to the next appropriate processing status

Running

80

All

The task is running. For Agent-based tasks, the Agent has started running the program.

Running/Problems

81

Workflow

One or more tasks within the workflow has one of the following statuses:

  • Cancelled
  • Confirmation Required
  • Failure
  • In Doubt
  • Running/Problems (for sub-workflows)
  • Start Failure
  • Undeliverable

Skipped

180

All

The task was skipped by a user.

Start Failure

120

All

The task was unable to start.

Started

70

Agent-based, Manual

The task has started. For Agent-based tasks, this means the Agent has received the task.

Submitted

43

z/OS

The task has been submitted to the z/OS Job Entry subsystem and scheduled by the z/OS Job Scheduler.

Success

200

All (except Approval)

The task has completed successfully. Workflows will transition to Success status when all of its tasks have transitioned to Success (or Approved for Approval tasks), Finished, or Skipped status.

Time_Wait

15

All (except Timer)

The task is waiting to start based on a Wait To Start and/or Delay On Start specification.

Undeliverable

35

Agent-based

The Agent is unavailable.

Waiting

10

All

The task has been loaded by a workflow and is waiting on a predecessor.

* Workflows cannot go to Failed status.

Force Finish a Task​

Description

Force finishes the specified task instance.

See Force Finishing a Task Instance for a description of behavior and restrictions.

Syntax

uagcmd ops-task-forcefinish global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter

task-instance=

Required; An internal Universal Controller Identifier

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-task-forcefinish -c config.cfg task-instance-id=90079020d861e5e40128cbb3cdbe1cf3

Launch a Task​

Description

Launches the specified task(s).

Syntax

uagcmd ops-task-launch global parameters [task-type=<type>] task-name=<name> {time-zone=<Australia/Sydney>] [hold=<option>] [task-variables=<variables>] [virtual-resource-priority=<priority>] [virtual-resources=<resources>]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameters

  • task-type=
    Optional; One of the following (not case sensitive): application_control, approval, email, email_monitor, agent_file_monitor, ftp, ibm_i, remote_file_monitor, indesca / universal_command / ucmd, manual, peoplesoft, recurring, sap, sql, stored_procedure, system_monitor, task_monitor, timer, universal, universal_monitor, unix, variable_monitor, web_service, windows, workflow, zos, z/os_monitor

  • task-name=
    Required; Valid task name. Wildcards are supported.

  • time-zone=
    Optional; Time zone in which the task is launched.

  • hold=
    Optional; Specification for whether to place the task in Held status when it is launched. Valid values are (not case sensitive): yes/y/true.

  • task-variables=
    Optional; Any variables specified in the task that need a value to run properly.

  • virtual-resource-priority=
    Optional; Virtual resource priority of the task instance. Valid values are any integer between 1 and 20. Defaults to the virtual resource priority defined in the task Details.

  • virtual-resources=
    Optional; Comma-separated list of <resource-name>:<amount> pairs. For example, VR1:10,VR2:20,...,VRN:N. An amount of 0 indicates the virtual resource should be dropped. Defaults to virtual resources defined in the task Details.

    The virtual resource dependencies specified in virtual-resources= are merged with the default virtual resource dependencies.

    • If a default virtual resource dependency already exists for a specified virtual resource amount, the virtual resource dependency is updated.
    • Any virtual resource specified with an amount of 0 is dropped from the default virtual resource dependencies; if the virtual resource did not exist as a default dependency, the command will fail.
    • If a default virtual resource dependency does not already exist for a specified virtual resource amount, the virtual resource dependency is added.

Example

(All variable=value pairs must be specified within one set of braces.)

uagcmd ops-task-launch -c config.cfg task-name=Windows Task A task-variables={variable1=first value variable2=second value}

Put Task on Hold​

Description

Puts the specified task instance on hold.

See Putting a Task Instance on Hold for a description of behavior and restrictions.

Syntax

uagcmd ops-task-hold global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter

  • task-instance=

    Required; An internal Universal Controller identifier

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-task-hold -c config.cfg task-instance=90079020d861e5e40128cbb3cdbe1cf3

Release a Task from Hold​

Description

Releases the specified task instance from hold.

See Releasing a Task Instance from Hold for a description of behavior and restrictions.

Syntax

uagcmd ops-task-release global parameters {task-instance-id=<ID> | task-instance-id=<name>} [instance-criteria=<criteria>] [workflow-instance-<name>] [recursive=<option>]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter

  • task-instance=

    Required; An internal Universal Controller identifier

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.
  • recursive=
    Optional; Specification (yes or no), if the task instance specified in task-instance-id= or task-instance-name= is a workflow, for whether or not to release the held workflow recursively. (Default is no.) If the task instance is not a workflow, recursive= is ignored.

Example

uagcmd ops-task-release -c config.cfg task-instance-id=90079020d861e5e40128cbb3cdbe1cf3

Rerun a Task​

Description

Reruns the specified Task instance.

See Re-running a Task Instance for a description of behavior and restrictions.

Syntax

uagcmd ops-task-rerun global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>] {[task-status=<status> [recursive=<option>]] }

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter

  • task-instance=

    Required; An internal Universal Controller identifier

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.

  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)

  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance

  • workflow-instance-name=
    Optional; Name of the workflow instance.

  • task-status=
    Optional; list of comma-separated status codes or case-insensitive status names (see below). Format: <:status-code-or-name>,<status-code-or-name>,...,<status-code-or-name>. Applicable only if matched task instance is workflow type; command will fail otherwise.

    All tasks within the matching workflow with a matching status will be queued for re-run. Sub-workflows do not support re-run directly; the recursive= parameter controls whether or not tasks within sub-workflows matching the status will be queued for re-run.

    • Start_Failure (120)
    • Cancelled (130)
    • Failed (140)
    • Finished (190)
    • Success (200)

  • recursive=
    Optional if task-status= is specified; One of the following (not case-sensitive): Yes|Y|true or No|N|false (default). Indicates whether or not tasks within sub-workflows will qualify for re-run.

Example

uagcmd ops-task-rerun -c config.cfg task-instance=8fda93dcd861e5e4005bf48e2cad6206 task-status=140

Set Manual Task to Started​

Description

For a Manual task, changes its status from Action Required to Started. This allows you to acknowledge the Manual task and indicate that the manual procedures have been started.

Syntax

uagcmd ops-manual-setstarted global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-<name>]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter

  • task-instance=

    Required; An internal Universal Controller identifier

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-manual-setstarted -c config.cfg task-instance=8fda93dcd861e5e4005bf48e2cad6206

Set Manual Task to Success​

Description

For a Manual task, sets its status to Success.

Syntax

uagcmd ops-manual-setcompleted global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-<name>]

info

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter

  • task-instance=

    Required; An internal Universal Controller identifier

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria= Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance
  • workflow-instance-name= For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-manual-setcompleted -c config.cfg task-instance=8fda93dcd861e5e4005bf48e2cad6206

Set or Modify Wait Time for a Task Instance​

Description

Sets or modifies the Wait time for a task instance that specifies how long it will wait to run after it has become eligible to run.

Syntax

uagcmd ops-task-set-timewait global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-name=<name>] {wait-type=<type> [wait-day-constraint=<constraint>] {wait-time=<wait time> | wait-duration=<duration> | wait-seconds=<duration in seconds>} | delay-type=<type> {delay-duration=<duration> | delay-seconds=<duration in seconds> }} change-description=<description>

Parameters

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the time task instance. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance. (The most recently created workflow instance with the matching name will apply.)
  • wait-type=
    Required if delay-type= is not specified; one of the following (not case sensitive): none, time, relative_time, duration, seconds.
  • wait-time=
    Required if wait-type=time or relative_time; Wait time in format HH:MM. Variables are supported.
  • wait-day-constraint=
    Optional if wait-type=time or relative_time; One of the following (not case sensitive): none, same day/same_day, next day/next_day, next business day/next_business_day, sunday, monday, tuesday, wednesday, thursday, friday, saturday.
  • wait-duration=
    Required if wait-type=duration; Wait duration in format DD:HH:MM:SS.
  • wait-seconds=
    Required if wait-type=seconds; Wait duration in format SS. Variables are supported.
  • delay-type=
    Required if wait-type= is not specified; One of the following (not case sensitive): none, duration, seconds.
  • delay-duration=
    Required if delay_type=duration; Specific delay duration in format DD:HH:MM:SS.
  • delay-seconds=
    Required if delay_type=seconds; Specific delay duration in format SS. Variables are supported.
  • change-description=Required if the Change History Description CLI Required system property is true; ignored if the Change History Enabled system property is false; Change Description for the update.

Example

uagcmd ops-task-set-timewait -c config.cfg task-instance-name=Task 5A workflow-instance-name=Workflow A wait-type=time wait-time=18:00 change-description=update

Set Task Priority​

Description

For Agent-based tasks (Linux/Unix, Universal, Windows, and z/OS), changes the priority on the specified task instance.

See Changing the Priority of a Task Instance for a description of behavior and restrictions.

Syntax

uagcmd ops-task-setpriority global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-<name>] priority=<priority>

Parameters

  • task-instance=

    Required; An internal Universal Controller identifier

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.
  • priority=
    Required; One of the following (not case sensitive): high, medium, low.

Example

uagcmd ops-task-setpriority -c config.cfg task-instance=90079026d861e5e400bba81913a4fdd0 priority=high

Skip a Task​

Description

Skips the specified task instance.

See Skipping a Task Instance for a description of behavior and restrictions.

Syntax

uagcmd ops-task-skip global parameters {task-instance-id=<ID> | task-instance-name=<name>} [instance-criteria=<criteria>] [workflow-instance-<name>]

Parameter

  • task-instance=

    Required; An internal Universal Controller identifier

warning

Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=.

  • task-instance-id=
    Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.
  • task-instance-name=
    Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)
  • instance-criteria=
    Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance
  • workflow-instance-name=
    For a task instance in a workflow, optional; Name of the workflow instance.

Example

uagcmd ops-task-skip -c config.cfg task-instance=90079026d861e5e400bba81913a4fdd0