...
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.
...
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]
|
|---|
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, 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 |
|
|---|
...
| Note |
|---|
|
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. |
...
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 |
| Panel |
|---|
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 |
|
|---|
...
