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

approval-approve

Approve a Task Instance Approval

uac task-instance approval-approve [OPTIONS] taskinstancename=value
                                   taskinstanceid=value
                                   workflowinstancename=value criteria=value

Options

-o, --output <output>

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

Arguments

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

approval-reject

Reject a Task Instance Approval

uac task-instance approval-reject [OPTIONS] taskinstancename=value
                                  taskinstanceid=value
                                  workflowinstancename=value criteria=value

Options

-o, --output <output>

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

Arguments

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

cancel

Cancel a Task Instance

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

Options

-o, --output <output>

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

Arguments

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

clear-dependencies

Clear All Dependencies

uac task-instance clear-dependencies [OPTIONS] id=value operational_memo=value
                                     name=value criteria=value
                                     workflow_instance_name=value

Options

-o, --output <output>

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

Arguments

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

clear-exclusive

Clear Exclusive Dependencies

uac task-instance clear-exclusive [OPTIONS] id=value operational_memo=value
                                  name=value criteria=value
                                  workflow_instance_name=value

Options

-o, --output <output>

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

Arguments

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

clear-instance-wait

Clear Instance Wait Dependencies

uac task-instance clear-instance-wait [OPTIONS] id=value
                                      operational_memo=value name=value
                                      criteria=value
                                      workflow_instance_name=value

Options

-o, --output <output>

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

Arguments

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

clear-predecessors

Clear Predecessor Dependencies

uac task-instance clear-predecessors [OPTIONS] predecessor_name=value id=value
                                     name=value criteria=value
                                     workflow_instance_name=value
                                     operational_memo=value

Options

-o, --output <output>

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

Arguments

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

clear-resources

Clear Virtual Resource Dependencies

uac task-instance clear-resources [OPTIONS] id=value name=value
                                  workflow_instance_name=value criteria=value
                                  resource_name=value return_in_use=value
                                  operational_memo=value

Options

-o, --output <output>

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

Arguments

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

clear-timewait

Clear Time Dependency

uac task-instance clear-timewait [OPTIONS] id=value operational_memo=value
                                 name=value criteria=value
                                 workflow_instance_name=value

Options

-o, --output <output>

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

Arguments

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

delete

Delete a Task Instance

uac task-instance delete [OPTIONS] id=value operational_memo=value name=value
                         criteria=value workflow_instance_name=value
                         recursive=value

Options

-o, --output <output>

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

Arguments

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

force-finish

Force Finish a Task Instance

uac task-instance force-finish [OPTIONS] id=value operational_memo=value
                               name=value criteria=value
                               workflow_instance_name=value halt=value

Options

-o, --output <output>

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

Arguments

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

force-finish-cancel

Force Finish/Cancel a Task Instance

uac task-instance force-finish-cancel [OPTIONS] id=value
                                      operational_memo=value name=value
                                      criteria=value
                                      workflow_instance_name=value halt=value

Options

-o, --output <output>

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

Arguments

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

get

Read a Task Instance

uac task-instance get [OPTIONS] taskinstancename=value taskinstanceid=value
                      workflowinstancename=value criteria=value
                      include_output=value include_sql_results=value

Options

-o, --output <output>

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

Arguments

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

hold

Hold a Task Instance

uac task-instance hold [OPTIONS] id=value operational_memo=value name=value
                       criteria=value workflow_instance_name=value
                       hold_reason=value

Options

-o, --output <output>

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

Arguments

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

list

List Task Instances

uac task-instance list [OPTIONS] status=value type=value agent_name=value
                       sys_id=value name=value workflow_instance_id=value
                       workflow_instance_name=value task_id=value
                       task_name=value workflow_definition_id=value
                       workflow_definition_name=value trigger_id=value
                       trigger_name=value workflow_instance_criteria=value
                       business_services=value template_id=value
                       template_name=value updated_time=value
                       updated_time_type=value instance_number=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 custom_field1=value
                       custom_field2=value status_description=value
                       operational_memo=value sort=value

Options

-o, --output <output>

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

Arguments

status=value type=value agent_name=value sys_id=value name=value workflow_instance_id=value workflow_instance_name=value task_id=value task_name=value workflow_definition_id=value workflow_definition_name=value trigger_id=value trigger_name=value workflow_instance_criteria=value business_services=value template_id=value template_name=value updated_time=value updated_time_type=value instance_number=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 custom_field1=value custom_field2=value status_description=value operational_memo=value sort=value: Optional argument(s)

list-advanced

List Task Instances - Advanced

uac task-instance list-advanced [OPTIONS] operational_memo=value name=value
                                workflow_instance_id=value
                                workflow_instance_name=value status=value
                                type=value agent_name=value sys_id=value
                                task_id=value task_name=value
                                workflow_definition_id=value
                                workflow_definition_name=value
                                trigger_id=value trigger_name=value
                                workflow_instance_criteria=value
                                business_services=value template_id=value
                                template_name=value updated_time=value
                                updated_time_type=value
                                instance_output_type=value
                                instance_number=value response_fields=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 custom_field1=value
                                custom_field2=value status_description=value
                                sort=value

Options

-o, --output <output>

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

Arguments

operational_memo=value name=value workflow_instance_id=value workflow_instance_name=value status=value type=value agent_name=value sys_id=value task_id=value task_name=value workflow_definition_id=value workflow_definition_name=value trigger_id=value trigger_name=value workflow_instance_criteria=value business_services=value template_id=value template_name=value updated_time=value updated_time_type=value instance_output_type=value instance_number=value response_fields=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 custom_field1=value custom_field2=value status_description=value sort=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)

patch-instance

Patch a task instance

uac task-instance patch-instance [OPTIONS] taskinstanceid=value scope=value
                                 sys_id=value exclude_related=value
                                 notes=value actions=value outputs=value
                                 retain_sys_ids=value name=value
                                 resolve_name_immediately=value summary=value
                                 opswise_groups=value start_held=value
                                 start_held_reason=value res_priority=value
                                 res_priority_var=value hold_resources=value
                                 credentials=value credentials_var=value
                                 retry_maximum=value retry_indefinitely=value
                                 retry_interval=value
                                 retry_suppress_failure=value ls_enabled=value
                                 ls_type=value ls_time=value
                                 ls_day_constraint=value ls_nth_amount=value
                                 ls_duration=value lf_enabled=value
                                 lf_type=value lf_time=value
                                 lf_day_constraint=value lf_nth_amount=value
                                 lf_duration=value lf_offset_type=value
                                 lf_offset_percentage=value
                                 lf_offset_duration=value
                                 lf_offset_duration_unit=value
                                 ef_enabled=value ef_type=value ef_time=value
                                 ef_day_constraint=value ef_nth_amount=value
                                 ef_duration=value ef_offset_type=value
                                 ef_offset_percentage=value
                                 ef_offset_duration=value
                                 ef_offset_duration_unit=value
                                 user_estimated_duration=value
                                 cp_duration=value cp_duration_unit=value
                                 tw_wait_type=value tw_wait_amount=value
                                 tw_wait_time=value tw_wait_duration=value
                                 tw_wait_day_constraint=value
                                 tw_delay_type=value tw_delay_amount=value
                                 tw_delay_duration=value
                                 tw_workflow_only=value custom_field1=value
                                 custom_field2=value
                                 execution_restriction=value
                                 restriction_period=value
                                 restriction_period_before_date=value
                                 restriction_period_after_date=value
                                 restriction_period_before_time=value
                                 restriction_period_after_time=value
                                 restriction_period_date_list=value
                                 log_level=value exclusive_with_self=value
                                 avg_run_time=value avg_run_time_display=value
                                 simulation=value acquired_agent=value
                                 acquired_agent_cluster=value
                                 attempt_count=value avg_estimated_end=value
                                 calendar=value cpu_time=value critical=value
                                 critical_endpoint=value
                                 duration_seconds=value early_finish=value
                                 end_time=value exclusive_state=value
                                 execution_user=value exit_code=value
                                 extension_status=value
                                 high_estimated_end=value
                                 instance_wait_resolved=value
                                 instance_wait_lookup_resolved=value
                                 instance_wait_state=value invoked_by=value
                                 io_other=value io_reads=value io_writes=value
                                 late_finish=value late_start=value
                                 launch_source=value launch_time=value
                                 lf_computed_time=value
                                 low_estimated_end=value
                                 ls_computed_time=value memo=value
                                 memo_history=value memory_peak=value
                                 memory_used=value percent_done=value
                                 priority=value projected_end_time=value
                                 projected_late=value
                                 projected_start_time=value queued_time=value
                                 rd_exclude_backup=value res_state=value
                                 resources_consumed=value retention_time=value
                                 retry_counter=value retry_time=value
                                 run_called=value security_name=value
                                 source_instance=value source_version=value
                                 start_time=value state_changed_time=value
                                 status_attributes=value status_code=value
                                 status_description=value status_history=value
                                 task=value task_id=value
                                 instance_number=value time_zone=value
                                 top_level_workflow=value trigger=value
                                 trigger_time=value tw_state=value
                                 tw_until_time=value user_estimated_end=value
                                 vertex_id=value wait_for_exclusive=value
                                 wait_for_resources=value wf_progress=value
                                 workflow_definition=value workflow=value
                                 workflow_start_time=value
                                 time_zone_pref=value virtual_resources=value
                                 exclusive_requests=value type=value

Options

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

-o, --output <output>

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

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

Arguments

taskinstanceid=value scope=value sys_id=value exclude_related=value notes=value actions=value outputs=value retain_sys_ids=value name=value resolve_name_immediately=value summary=value opswise_groups=value start_held=value start_held_reason=value res_priority=value res_priority_var=value hold_resources=value credentials=value credentials_var=value retry_maximum=value retry_indefinitely=value retry_interval=value retry_suppress_failure=value ls_enabled=value ls_type=value ls_time=value ls_day_constraint=value ls_nth_amount=value ls_duration=value lf_enabled=value lf_type=value lf_time=value lf_day_constraint=value lf_nth_amount=value lf_duration=value lf_offset_type=value lf_offset_percentage=value lf_offset_duration=value lf_offset_duration_unit=value ef_enabled=value ef_type=value ef_time=value ef_day_constraint=value ef_nth_amount=value ef_duration=value ef_offset_type=value ef_offset_percentage=value ef_offset_duration=value ef_offset_duration_unit=value user_estimated_duration=value cp_duration=value cp_duration_unit=value tw_wait_type=value tw_wait_amount=value tw_wait_time=value tw_wait_duration=value tw_wait_day_constraint=value tw_delay_type=value tw_delay_amount=value tw_delay_duration=value tw_workflow_only=value custom_field1=value custom_field2=value execution_restriction=value restriction_period=value restriction_period_before_date=value restriction_period_after_date=value restriction_period_before_time=value restriction_period_after_time=value restriction_period_date_list=value log_level=value exclusive_with_self=value avg_run_time=value avg_run_time_display=value simulation=value acquired_agent=value acquired_agent_cluster=value attempt_count=value avg_estimated_end=value calendar=value cpu_time=value critical=value critical_endpoint=value duration_seconds=value early_finish=value end_time=value exclusive_state=value execution_user=value exit_code=value extension_status=value high_estimated_end=value instance_wait_resolved=value instance_wait_lookup_resolved=value instance_wait_state=value invoked_by=value io_other=value io_reads=value io_writes=value late_finish=value late_start=value launch_source=value launch_time=value lf_computed_time=value low_estimated_end=value ls_computed_time=value memo=value memo_history=value memory_peak=value memory_used=value percent_done=value priority=value projected_end_time=value projected_late=value projected_start_time=value queued_time=value rd_exclude_backup=value res_state=value resources_consumed=value retention_time=value retry_counter=value retry_time=value run_called=value security_name=value source_instance=value source_version=value start_time=value state_changed_time=value status_attributes=value status_code=value status_description=value status_history=value task=value task_id=value instance_number=value time_zone=value top_level_workflow=value trigger=value trigger_time=value tw_state=value tw_until_time=value user_estimated_end=value vertex_id=value wait_for_exclusive=value wait_for_resources=value wf_progress=value workflow_definition=value workflow=value workflow_start_time=value time_zone_pref=value virtual_resources=value exclusive_requests=value type=value: Optional argument(s)

release

Release a Task Instance from Hold

uac task-instance release [OPTIONS] id=value operational_memo=value name=value
                          criteria=value workflow_instance_name=value
                          recursive=value

Options

-o, --output <output>

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

Arguments

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

rerun

Rerun a Task Instance

uac task-instance rerun [OPTIONS] id=value operational_memo=value name=value
                        criteria=value workflow_instance_name=value
                        recursive=value task_status=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

id=value operational_memo=value name=value criteria=value workflow_instance_name=value recursive=value task_status=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

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: 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
                               operational_memo=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 operational_memo=value: Required argument(s)

set-priority

Set Priority for a Task Instance

uac task-instance set-priority [OPTIONS] id=value operational_memo=value
                               name=value criteria=value
                               workflow_instance_name=value
                               priority_type=value

Options

-o, --output <output>

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

Arguments

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

set-started

Issues a Set Started command for a Manual Task instance.

uac task-instance set-started [OPTIONS] name=value id=value criteria=value
                              workflow_instance_name=value
                              operational_memo=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 operational_memo=value: Required argument(s)

set-timewait

Set or Modify Wait Time/Duration for Task Instance

uac task-instance set-timewait [OPTIONS] id=value name=value criteria=value
                               workflow_instance_name=value delay_type=value
                               wait_type=value wait_time=value
                               wait_day_constraint=value wait_duration=value
                               wait_seconds=value delay_duration=value
                               delay_seconds=value operational_memo=value

Options

-o, --output <output>

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

Arguments

id=value name=value criteria=value workflow_instance_name=value delay_type=value wait_type=value wait_time=value wait_day_constraint=value wait_duration=value wait_seconds=value delay_duration=value delay_seconds=value operational_memo=value: Required argument(s)

set-variable

Set a task instance variable

uac task-instance set-variable [OPTIONS] variablevalue=value
                               taskinstancename=value taskinstanceid=value
                               workflowinstancename=value criteria=value
                               variablename=value

Options

-o, --output <output>

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

Arguments

variablevalue=value taskinstancename=value taskinstanceid=value workflowinstancename=value criteria=value variablename=value: Optional 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] id=value operational_memo=value name=value
                       criteria=value workflow_instance_name=value

Options

-o, --output <output>

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

Arguments

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

skip-path

Skip a Task Instance Path

uac task-instance skip-path [OPTIONS] id=value operational_memo=value
                            name=value criteria=value
                            workflow_instance_name=value

Options

-o, --output <output>

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

Arguments

id=value operational_memo=value name=value criteria=value workflow_instance_name=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] id=value operational_memo=value name=value
                         criteria=value workflow_instance_name=value

Options

-o, --output <output>

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

Arguments

id=value operational_memo=value name=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>

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

Arguments

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