Task Instance Commands

uac task-instance

Commands for managing task instances, including listing, updating, and controlling the execution of task instances

uac task-instance [OPTIONS] COMMAND [ARGS]...

cancel

Cancel a Task Instance

uac task-instance cancel [OPTIONS] name=value id=value criteria=value
                         workflow_instance_name=value resource_name=value
                         recursive=value predecessor_name=value
                         wait_type=value wait_time=value wait_duration=value
                         wait_seconds=value wait_day_constraint=value
                         delay_type=value delay_duration=value
                         delay_seconds=value halt=value priority_type=value
                         task_status=value operational_memo=value
                         hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

clear-dependencies

Clear All Dependencies

uac task-instance clear-dependencies [OPTIONS] name=value id=value
                                     criteria=value
                                     workflow_instance_name=value
                                     resource_name=value recursive=value
                                     predecessor_name=value wait_type=value
                                     wait_time=value wait_duration=value
                                     wait_seconds=value
                                     wait_day_constraint=value
                                     delay_type=value delay_duration=value
                                     delay_seconds=value halt=value
                                     priority_type=value task_status=value
                                     operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

clear-exclusive

Clear Exclusive Dependencies

uac task-instance clear-exclusive [OPTIONS] name=value id=value criteria=value
                                  workflow_instance_name=value
                                  resource_name=value recursive=value
                                  predecessor_name=value wait_type=value
                                  wait_time=value wait_duration=value
                                  wait_seconds=value wait_day_constraint=value
                                  delay_type=value delay_duration=value
                                  delay_seconds=value halt=value
                                  priority_type=value task_status=value
                                  operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

clear-instance-wait

Clear Instance Wait Dependencies

uac task-instance clear-instance-wait [OPTIONS] name=value id=value
                                      criteria=value
                                      workflow_instance_name=value
                                      resource_name=value recursive=value
                                      predecessor_name=value wait_type=value
                                      wait_time=value wait_duration=value
                                      wait_seconds=value
                                      wait_day_constraint=value
                                      delay_type=value delay_duration=value
                                      delay_seconds=value halt=value
                                      priority_type=value task_status=value
                                      operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

clear-predecessors

Clear Predecessor Dependencies

uac task-instance clear-predecessors [OPTIONS] name=value id=value
                                     criteria=value
                                     workflow_instance_name=value
                                     resource_name=value recursive=value
                                     predecessor_name=value wait_type=value
                                     wait_time=value wait_duration=value
                                     wait_seconds=value
                                     wait_day_constraint=value
                                     delay_type=value delay_duration=value
                                     delay_seconds=value halt=value
                                     priority_type=value task_status=value
                                     operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

clear-resources

Clear Virtual Resource Dependencies

uac task-instance clear-resources [OPTIONS] name=value id=value criteria=value
                                  workflow_instance_name=value
                                  resource_name=value recursive=value
                                  predecessor_name=value wait_type=value
                                  wait_time=value wait_duration=value
                                  wait_seconds=value wait_day_constraint=value
                                  delay_type=value delay_duration=value
                                  delay_seconds=value halt=value
                                  priority_type=value task_status=value
                                  operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

clear-timewait

Clear Time Dependency

uac task-instance clear-timewait [OPTIONS] name=value id=value criteria=value
                                 workflow_instance_name=value
                                 resource_name=value recursive=value
                                 predecessor_name=value wait_type=value
                                 wait_time=value wait_duration=value
                                 wait_seconds=value wait_day_constraint=value
                                 delay_type=value delay_duration=value
                                 delay_seconds=value halt=value
                                 priority_type=value task_status=value
                                 operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

delete

Delete a Task Instance

uac task-instance delete [OPTIONS] name=value id=value criteria=value
                         workflow_instance_name=value resource_name=value
                         recursive=value predecessor_name=value
                         wait_type=value wait_time=value wait_duration=value
                         wait_seconds=value wait_day_constraint=value
                         delay_type=value delay_duration=value
                         delay_seconds=value halt=value priority_type=value
                         task_status=value operational_memo=value
                         hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

force-finish

Force Finish a Task Instance

uac task-instance force-finish [OPTIONS] name=value id=value criteria=value
                               workflow_instance_name=value
                               resource_name=value recursive=value
                               predecessor_name=value wait_type=value
                               wait_time=value wait_duration=value
                               wait_seconds=value wait_day_constraint=value
                               delay_type=value delay_duration=value
                               delay_seconds=value halt=value
                               priority_type=value task_status=value
                               operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

force-finish-cancel

Force Finish/Cancel a Task Instance

uac task-instance force-finish-cancel [OPTIONS] name=value id=value
                                      criteria=value
                                      workflow_instance_name=value
                                      resource_name=value recursive=value
                                      predecessor_name=value wait_type=value
                                      wait_time=value wait_duration=value
                                      wait_seconds=value
                                      wait_day_constraint=value
                                      delay_type=value delay_duration=value
                                      delay_seconds=value halt=value
                                      priority_type=value task_status=value
                                      operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

hold

Hold a Task Instance

uac task-instance hold [OPTIONS] name=value id=value criteria=value
                       workflow_instance_name=value resource_name=value
                       recursive=value predecessor_name=value wait_type=value
                       wait_time=value wait_duration=value wait_seconds=value
                       wait_day_constraint=value delay_type=value
                       delay_duration=value delay_seconds=value halt=value
                       priority_type=value task_status=value
                       operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

list

List Task Instances

uac task-instance list [OPTIONS] name=value id=value criteria=value
                       workflow_instance_name=value resource_name=value
                       recursive=value predecessor_name=value wait_type=value
                       wait_time=value wait_duration=value wait_seconds=value
                       wait_day_constraint=value delay_type=value
                       delay_duration=value delay_seconds=value halt=value
                       priority_type=value task_status=value
                       operational_memo=value hold_reason=value
                       agent_name=value workflow_instance_criteria=value
                       workflow_instance_id=value status=value type=value
                       execution_user=value late_start=value late_finish=value
                       early_finish=value started_late=value
                       finished_late=value finished_early=value late=value
                       late_early=value business_services=value
                       updated_time_type=value updated_time=value sys_id=value
                       instance_number=value task_id=value task_name=value
                       custom_field1=value custom_field2=value
                       trigger_id=value trigger_name=value
                       workflow_definition_id=value
                       workflow_definition_name=value status_description=value
                       template_id=value template_name=value
                       response_fields=value instance_output_type=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value agent_name=value workflow_instance_criteria=value workflow_instance_id=value status=value type=value execution_user=value late_start=value late_finish=value early_finish=value started_late=value finished_late=value finished_early=value late=value late_early=value business_services=value updated_time_type=value updated_time=value sys_id=value instance_number=value task_id=value task_name=value custom_field1=value custom_field2=value trigger_id=value trigger_name=value workflow_definition_id=value workflow_definition_name=value status_description=value template_id=value template_name=value response_fields=value instance_output_type=value: Optional argument(s)

list-dependency-list

List Predecessors / Successors of a Task Instance in a Workflow

uac task-instance list-dependency-list [OPTIONS] taskinstancename=value
                                       taskinstanceid=value
                                       workflowinstancename=value
                                       criteria=value dependencytype=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

taskinstancename=value taskinstanceid=value workflowinstancename=value criteria=value dependencytype=value: Required argument(s)

release

Release a Task Instance from Hold

uac task-instance release [OPTIONS] name=value id=value criteria=value
                          workflow_instance_name=value resource_name=value
                          recursive=value predecessor_name=value
                          wait_type=value wait_time=value wait_duration=value
                          wait_seconds=value wait_day_constraint=value
                          delay_type=value delay_duration=value
                          delay_seconds=value halt=value priority_type=value
                          task_status=value operational_memo=value
                          hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

rerun

Rerun a Task Instance

uac task-instance rerun [OPTIONS] name=value id=value criteria=value
                        workflow_instance_name=value resource_name=value
                        recursive=value predecessor_name=value wait_type=value
                        wait_time=value wait_duration=value wait_seconds=value
                        wait_day_constraint=value delay_type=value
                        delay_duration=value delay_seconds=value halt=value
                        priority_type=value task_status=value
                        operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

-w, --wait

-t, --timeout <timeout>

-i, --interval <interval>

-r, --return_rc

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

retrieve-output

Retrieve Task Instance Output

uac task-instance retrieve-output [OPTIONS] taskinstancename=value
                                  taskinstanceid=value
                                  workflowinstancename=value criteria=value
                                  outputtype=value startline=value
                                  numlines=value scantext=value
                                  operational_memo=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

taskinstancename=value taskinstanceid=value workflowinstancename=value criteria=value outputtype=value startline=value numlines=value scantext=value operational_memo=value: Required argument(s)

set-complete

Issue Set Completed Command for a Manual Task Instance

uac task-instance set-complete [OPTIONS] name=value id=value criteria=value
                               workflow_instance_name=value
                               operationalMemo=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value operationalMemo=value: Required argument(s)

set-priority

Set Priority for a Task Instance

uac task-instance set-priority [OPTIONS] name=value id=value criteria=value
                               workflow_instance_name=value
                               resource_name=value recursive=value
                               predecessor_name=value wait_type=value
                               wait_time=value wait_duration=value
                               wait_seconds=value wait_day_constraint=value
                               delay_type=value delay_duration=value
                               delay_seconds=value halt=value
                               priority_type=value task_status=value
                               operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

set-timewait

Set or Modify Wait Time/Duration for Task Instance

uac task-instance set-timewait [OPTIONS] name=value id=value criteria=value
                               workflow_instance_name=value
                               resource_name=value recursive=value
                               predecessor_name=value wait_type=value
                               wait_time=value wait_duration=value
                               wait_seconds=value wait_day_constraint=value
                               delay_type=value delay_duration=value
                               delay_seconds=value halt=value
                               priority_type=value task_status=value
                               operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

show-variables

List Task Instance Variables (Show Variables)

uac task-instance show-variables [OPTIONS] taskinstancename=value
                                 taskinstanceid=value
                                 workflowinstancename=value criteria=value
                                 fetchglobal=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

taskinstancename=value taskinstanceid=value workflowinstancename=value criteria=value fetchglobal=value: Optional argument(s)

skip

Skip a Task Instance

uac task-instance skip [OPTIONS] name=value id=value criteria=value
                       workflow_instance_name=value resource_name=value
                       recursive=value predecessor_name=value wait_type=value
                       wait_time=value wait_duration=value wait_seconds=value
                       wait_day_constraint=value delay_type=value
                       delay_duration=value delay_seconds=value halt=value
                       priority_type=value task_status=value
                       operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

skip-path

Skip a Task Instance Path

uac task-instance skip-path [OPTIONS] name=value id=value criteria=value
                            workflow_instance_name=value resource_name=value
                            recursive=value predecessor_name=value
                            wait_type=value wait_time=value
                            wait_duration=value wait_seconds=value
                            wait_day_constraint=value delay_type=value
                            delay_duration=value delay_seconds=value
                            halt=value priority_type=value task_status=value
                            operational_memo=value hold_reason=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value resource_name=value recursive=value predecessor_name=value wait_type=value wait_time=value wait_duration=value wait_seconds=value wait_day_constraint=value delay_type=value delay_duration=value delay_seconds=value halt=value priority_type=value task_status=value operational_memo=value hold_reason=value: Required argument(s)

task-insert

Insert a Task into a Workflow with Dependencies

uac task-instance task-insert [OPTIONS] id=value name=value alias=value
                              workflow_instance_id=value
                              workflow_instance_name=value
                              workflow_instance_criteria=value
                              predecessors=value successors=value
                              vertex_x=value vertex_y=value
                              inherit_trigger_time=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

id=value name=value alias=value workflow_instance_id=value workflow_instance_name=value workflow_instance_criteria=value predecessors=value successors=value vertex_x=value vertex_y=value inherit_trigger_time=value: Required argument(s)

unskip

Unskip a Task Instance

uac task-instance unskip [OPTIONS] name=value id=value criteria=value
                         workflow_instance_name=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value id=value criteria=value workflow_instance_name=value: Required argument(s)

update-operational-memo

Update a Task Instance Operational Memo

uac task-instance update-operational-memo [OPTIONS] memo=message
                                          taskinstancename=value
                                          taskinstanceid=value
                                          workflowinstancename=value
                                          criteria=value

Options

-o, --output <output>

-i, --input <input>: Required

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

memo=message taskinstancename=value taskinstanceid=value workflowinstancename=value criteria=value: Optional argument(s)