Versions Compared

Old Version 3

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

  • Cancel Task
  • Clear All Dependencies
  • Clear Virtual Resource Dependencies
  • Clear Exclusive Dependencies
  • Clear Time Dependency
  • Display All Tasks
  • Display Task Instance Status
  • Force Finish a Task
  • Launch a Task
  • Put Task on Hold
  • Release a Task from Hold
  • Rerun a Task
  • Set Manual Task to Started
  • Set Manual Task to Success
  • Set or Modify Wait Time for a Task Instance
  • Set Task Priority
  • Skip a Task

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

...

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]
 

Note
titleNote

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
titleDeprecated

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


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


...

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]
 

Note
titleNote

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
titleDeprecated

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, email, email_monitor, agent file_monitor, ftp, remote_file_monitor, indesca / universal_command / ucmd, manual, sap, peoplesoft, sql, stored_procedure, system_monitor, task_monitor, timer, unix, variable_monitor, web_service, windows, workflow, zos.
  • 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


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


...

<ul> <li> <code>task
  • task-instance=
</code> <br>Required; An

  • Required; An internal Universal Controller identifier

 

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]
 

Note
titleNote

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


Parameter

Html bobswift
. <li><code>task
Warning
titleDeprecated

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

Html bobswift
  • task-instance-id=
</code> <br> Required if <code>task

  • Required if task-instance-name=
</code>
  • is
  • not
  • specified;
  • sys_id
  • of
  • the
  • task
  • instance
  • to
  • run
  • the
  • command
  • on.
<li><code>task
  • task-instance-name=
</code> <br> Required if <code>task

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

  • Optional,
  • if
<code>task
  • task-instance-name=
</code>
  • is
  • specified;
  • One
  • of
  • the
  • following
  • (not
  • case-sensitive):
<b>oldest
  • oldest_active_
instance</b>
  • instance (default),
<b>oldest_instance</b>, <b>newest
  • oldest_instance, newest_active_
instance</b>, <b>newest_instance</b> <li><code>workflow
  • instance, newest_instance
  • workflow-instance-name=
</code> <br> For a task instance in a workflow, optional; Name of the workflow instance. </ul>

  • For a task instance in a workflow, optional; Name of the workflow instance.

Example


<pre>uagcmd
uagcmd ops-task-hold 
-c config.cfg
 task-instance=
90079020d861e5e40128cbb3cdbe1cf3</pre>
90079020d861e5e40128cbb3cdbe1cf3
Panel
Html bobswift
Html bobswift


Anchor
ops-task-release
ops-task-release
Release a Task from Hold

<ul> <li> <code>task
  • task-instance=
</code> <br>Required; An

  • Required; An internal Universal Controller identifier
 

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]
 

Note
titleNote

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


Parameter

Html bobswift
. <li><code>task
Warning
titleDeprecated

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

Html bobswift
  • task-instance-id=
</code> <br> Required if <code>task

  • Required if task-instance-name=
</code>
  • is
  • not
  • specified;
  • sys_id
  • of
  • the
  • task
  • instance
  • to
  • run
  • the
  • command
  • on.
<li><code>task
  • task-instance-name=
</code> <br> Required if <code>task

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

  • Optional,
  • if
<code>task
  • task-instance-name=
</code>
  • is
  • specified;
  • One
  • of
  • the
  • following
  • (not
  • case-sensitive):
<b>oldest
  • oldest_active_
instance</b>
  • instance (default),
<b>oldest_instance</b>, <b>newest
  • oldest_instance, newest_active_
instance</b>, <b>newest_instance</b> <li><code>workflow
  • instance, newest_instance
  • workflow-instance-name=
</code> <br> For a task instance in a workflow, optional; Name of the workflow instance. <li><code>recursive=</code> <br> Optional; Specification (yes or no), if the task instance specified in <code>task

  • 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=
</code> or <code>task
  • or task-instance-name=
</code>
  • is
  • a
  • workflow,
  • for
  • whether
  • or
  • not
  • to
  • release
  • the
  • held
  • workflow
  • recursively.
  • (Default
  • is
  • no.)
  • If
  • the
  • task
  • instance
  • is
  • not
  • a
  • workflow,
<code>recursive=</code> is ignored. </ul>
  • recursive= is ignored.

Example


<pre>uagcmd
uagcmd ops-task-release 
-c config.cfg
 task-instance-id=90079020d861e5e40128cbb3cdbe1cf3
</pre>
 Panel
 Html bobswift
 Html bobswift

 Anchor
ops-task-rerun
ops-task-rerun
Rerun a Task
<ul>
<li> <code>task
  • task-instance=
</code> <br>Required; An 
  •  
     
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]] }
 
 Note
titleNote
For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter
 Html bobswift
.
<li><code>task-
 Warning
titleDeprecated
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=.
 Html bobswift
  • task-instance-id=
</code> <br> Required if <code>task

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

<li><code>task
  • task-instance-name=
</code> <br> Required if <code>task

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

<li><code>instance
  • instance-criteria=
</code> <br> 

  • Optional, 
 
  •  if 
 <code>task
  • task-instance-name=
</code> 
  •  is 
 
  •  specified; 
 
  •  One 
 
  •  of 
 
  •  the 
 
  •  following 
 
  •  (not 
 
  •  case-sensitive): 
 <b>oldest
  • oldest_active_
instance</b> 
  • instance (default), 
 <b>oldest_instance</b>, <b>newest
  •  oldest_instance, newest_active_
instance</b>, <b>newest_instance</b> 
<li><code>workflow
  • instance, newest_instance
  • workflow-instance-name=
</code> <br> 

  • Optional; 
 
  •  Name 
 
  •  of 
 
  •  the 
 
  •  workflow 
 
  •  instance.

<li><code>task
  • task-status=
</code> <br> 

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



  • 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 
 <code>recursive=</code> parameter controls whether or not tasks within 
  •  recursive= parameter controls whether or not tasks within sub-workflows 
 
  •  matching 
 
  •  the 
 
  •  status 
 
  •  will 
 
  •  be 
 
  •  queued 
 
  •  for 
 
  •  re-run.

<ul>
<li> 
    • Start_Failure 
 
    •  (120)
 
<li> 
    • Cancelled 
 
    •  (130)
 
<li> 
    • Failed 
 
    •  (140)
 
<li> 
    • Finished 
 
    •  (190)
 
<li> 
    • Success 
 
    •  (200)

</ul>
<li><code>recursive=</code> <br> Optional if <code>task
  • recursive= 
    Optional if task-status=
</code> 
  •  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.
 </ul>
Example

<pre>uagcmd
uagcmd ops-task-rerun 
-c config.cfg
 task-instance=8fda93dcd861e5e4005bf48e2cad6206 task-status=
140</pre>
140
 Panel
 Html bobswift
 Html bobswift

 Anchor
ops-manual-setstarted
ops-manual-setstarted
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] 
 
 Note
titleNote
For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter
 Html bobswift
<ul>
<li> <code>task-instance=</code> <br>Required; An 
  • task-instance=
    Required; An internal Universal Controller identifier

 
.
<li><code>task
 Warning
titleDeprecated
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=.
 Html bobswift
  • task-instance-id=
</code> <br> Required if <code>task

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

<li><code>task
  • task-instance-name=
</code> <br> Required if <code>task

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

<li><code>instance
  • instance-criteria=
</code> <br> 

  • Optional, 
 
  •  if 
 <code>task
  • task-instance-name=
</code> 
  •  is 
 
  •  specified; 
 
  •  One 
 
  •  of 
 
  •  the 
 
  •  following 
 
  •  (not 
 
  •  case-sensitive): 
 <b>oldest
  • oldest_active_
instance</b> 
  • instance (default), 
 <b>oldest_instance</b>, <b>newest
  •  oldest_instance, newest_active_
instance</b>, <b>newest_instance</b> 
<li><code>workflow
  • instance, newest_instance
  • workflow-instance-name=
</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul>

  • For a task instance in a workflow, optional; Name of the workflow instance.
Example

<pre>uagcmd
uagcmd ops-manual-setstarted 
-c config.cfg
 task-instance=8fda93dcd861e5e4005bf48e2cad6206
 </pre>
 Panel
 Html bobswift
 Html bobswift

 Anchor
ops-manual-setcompleted
ops-manual-setcompleted
Set Manual Task to Success
<ul>
<li> <code>task</code> <br>Required; An 
 
     
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] 
 
 Note
titleNote
For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameter
 Html bobswift
.
<li><code>task
 Warning
titleDeprecated
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=.
 Html bobswift
</code> <br> Required if <code>task</code>             
<li><code>task</code> <br> Required if <code>task</code>               <code>instance<code>              
<li><code>instance</code> <br>   <code>task</code>         <b>oldestinstance</b>  <b>oldest_instance</b>, <b>newestinstance</b>, <b>newest_instance</b> 
<li><code>workflow</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul>
Example

<pre>uagcmd
uagcmd ops-manual-setcompleted 
-c config.cfg
 task-instance=8fda93dcd861e5e4005bf48e2cad6206
 </pre>
 Panel
 Html bobswift
 Html bobswift

 Anchor
ops-task-set-time
ops-task-set-time
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 }}
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.
Example

<pre>uagcmd
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
 </pre>
 Panel
 Html bobswift
 Html bobswift

 Anchor
ops-task-setpriority
ops-task-setpriority
Set Task Priority
<ul>
<li> <code>task</code> <br>Required; An 
 
     
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
 Html bobswift
.
<li><code>task-
 Warning
titleDeprecated
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=.
 Html bobswift
</code> <br> Required if <code>task</code>             
<li><code>task</code> <br> Required if <code>task</code>               <code>instance</code>              
<li><code>instance</code> <br>   <code>task</code>         <b>oldestinstance</b>  <b>oldest_instance</b>, <b>newestinstance</b>, <b>newest_instance</b> 
<li><code>workflow</code> <br>For a task instance in a workflow, optional; Name of the workflow instance.
<li><code>priority=</code> <br> Required; One of the following (not case sensitive): <b>high</b>, <b>medium</b>, <b>low</b>. 
</ul>
Example
 Panel Html bobswift<pre>uagcmd
Example

 task-instance=90079026d861e5e400bba81913a4fdd0 priority=
high</pre>
high
 Panel
uagcmd ops-task-setpriority 
-c config.cfg
 Html bobswift

 Anchor
ops-task-skip
ops-task-skip
Skip a Task
<ul>
<li> <code>task</code> <br>Required; An  
     
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
 Html bobswift
 Warning
titleDeprecated
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=.
 Html bobswift
.
<li><code>task
.
</code> <br> Required if <code>task</code>             
<li><code>task</code> <br> Required if <code>task</code>               <code>instance</code>              
<li><code>instance=</code> <br>   <code>task</code>         <b>oldestinstance</b>  <b>oldest_instance</b>, <b>newestinstance</b>, <b>newest_instance</b> 
<li><code>workflow</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul>
Example

<pre>uagcmd
uagcmd ops-task-skip 
-c config.cfg
 task-instance=90079026d861e5e400bba81913a4fdd0 
</pre>
 Panel
 Html bobswift
 Html bobswift