Panel | ||||
---|---|---|---|---|
|
...
For RESTful-based web services for Workflow Task Instance operations, see Workflow Task Instance Web Services.
Anchor | ||||
---|---|---|---|---|
|
...
Note | ||
---|---|---|
| ||
The format of multi-word task status names specified in the Task Instance Status Web Service 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. | ||||||
Cancel_Pending | 99 | 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. | ||||||
| 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 | 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* | The task ran to a failure status. | ||||||
| 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. | ||||||
| 20 | All | The task has been put on hold by a user. | ||||||
In_Doubt | 110 | 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." | |||||||
Queued | 40 | The task has been queued on a resource. | |||||||
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 | ||||||
| 80 | All | The task is running. For Agent-based tasks, the Agent has started running the program. | ||||||
| 81 | Workflow | One or more tasks within the workflow has one of the following statuses:
| ||||||
Skipped | 180 | All | The task was skipped by a user. | ||||||
| 120 | All | The task was unable to start. | ||||||
| 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. | ||||||
| 200 | All | The task has completed successfully. Workflows will transition to Success status when all of its tasks have transitioned to Success, Finished, or Skipped status. | ||||||
| 15 | All (except Timer) | The task is waiting to start based on a Wait To Start and/or Delay On Start specification. | ||||||
Undeliverable | 35 | The Agent is unavailable. | |||||||
Waiting | 10 | All | The task has been loaded by a workflow and is waiting on a predecessor. |
...
Description | |
---|---|
URI | http://host_name/uc/resources/taskinstance/clearresources |
HTTP Method | POST |
Description | Clears virtual resource dependencies of a task instance. |
Authentication | HTTP Basic |
Example URI | http://localhost:8080/uc/resources/taskinstance/clearresources |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | See Clear Virtual Resource Dependencies: XML and JSON Examples. |
Request Properties | See Clear Virtual Resource Dependencies: Request Properties. |
Example Response | See Clear Virtual Resource Dependencies: XML and JSON Examples. |
...
Description | |
---|---|
URI | http://host_name/uc/resources/taskinstance |
HTTP Method | DELETE |
Description | Deletes the specified task instance. For Workflow task instances, if the |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Example URI | http://localhost:8080/uc/resources/taskinstance |
Example Request | |
Request Properties | |
Example Response |
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agentName | Agent | Name of the agent that this task instances is assigned to run on. | N | |||||||||||||
businessServices | Member of Business Services | Business Services that this task instance belongs to. | Comma-separated list. | N | ||||||||||||
customField1 | Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.) | User-defined task field 1. | Wildcards are supported. | N | ||||||||||||
customField2 | Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.) | User-defined task field 2. | Wildcards are supported. | N | ||||||||||||
executionUser | Execution User | Execution User of a task instance that determines the security context under which the task instance runs. | System-supplied. | N | ||||||||||||
instanceNumber | Instance Number | Sequentially assigned number, maintained per task, representing the creation order of the instance. | Integer value. | N | ||||||||||||
late | Started Late / Finished Late | Indication of whether or not to list all task instances that started late or finished late. | Valid values: true/false. | N | ||||||||||||
lateEarly | Started Late / Finished Late / Finished Early | Indication of whether or not to list all task instances that started late, finished late, or finished early. | Valid values: true/false. | N | ||||||||||||
name | Instance name | Name or partial name of one or more task instances. | Wildcards are supported. | Y |
| |||||||||||
status | Status | List of comma-separated task instance status codes and/or names (not case sensitive). | Specifying one or more statuses automatically excludes task instances in all other statuses. | N | ||||||||||||
statusDescription | Status Description | Description (if any) of the current status of the Task Instance. | Wildcards are supported. | N | ||||||||||||
sysId | n/a | sys_id used within the Controller to identify a task instance. | Y |
| ||||||||||||
taskId | n/a | sys_id of the task definition that this Task Instance was created from. | N |
| ||||||||||||
taskName | n/a | Name of the task definition that this Task Instance was created from. | N |
| ||||||||||||
templateId | n/a | ID used within the controller to identify a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateName | |||||||||||
templateName | Template Name | Name of a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateId | |||||||||||
triggerId | n/a | sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). | N |
| ||||||||||||
triggerName | n/a | Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) | N |
| ||||||||||||
type | n/a | Task type of this task instance. | Valid values: 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, sql, stored_procedure, system_monitor, task_monitor, timer, universal, unix, variable_monitor, web_service, windows, workflow, zos. | N | ||||||||||||
updatedTime | n/a | If | Valid values:
Default is d. If
| Y | ||||||||||||
updatedTimeType | n/a | Type of | Valid values:
| N | ||||||||||||
workflowDefinitionId | n/a | sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowDefinitionName | n/a | Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowInstanceCriteria | n/a | Specification for how | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
workflowInstanceId | n/a | sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
| ||||||||||||
workflowInstanceName | Workflow | Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agentName | Agent | Name of the agent that this task instances is assigned to run on. | N | |||||||||||||
businessServices | Member of Business Services | Business Services that this task instance belongs to. | Comma-separated list. | N | ||||||||||||
customField1 | Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.) | User-defined task field 1. | Wildcards are supported. | N | ||||||||||||
customField2 | Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.) | User-defined task field 2. | Wildcards are supported. | N | ||||||||||||
executionUser | Execution User | Execution User of a task instance that determines the security context under which the task instance runs. | System-supplied. | N | ||||||||||||
instanceNumber | Instance Number | Sequentially assigned number, maintained per task, representing the creation order of the instance. | Integer value. | N | ||||||||||||
| Output Type | Type of task instance output to retrieve. | String; Valid values:
| N | ||||||||||||
late | Started Late / Finished Late | Indication of whether or not to list all task instances that started late or finished late. | Valid values: true/false. | N | ||||||||||||
lateEarly | Started Late / Finished Late / Finished Early | Indication of whether or not to list all task instances that started late, finished late, or finished early. | Valid values: true/false. | N | ||||||||||||
name | Instance name | Name or partial name of one or more task instances. | Wildcards are supported. | Y |
| |||||||||||
| N/A | Allowed Response fields | Comma separated list of any of the following fields can be viewed.
| N | ||||||||||||
status | Status | List of comma-separated task instance status codes and/or names (not case sensitive). | Specifying one or more statuses automatically excludes task instances in all other statuses. | N | ||||||||||||
statusDescription | Status Description | Description (if any) of the current status of the Task Instance. | Wildcards are supported. | N | ||||||||||||
sysId | n/a | sys_id used within the Controller to identify a task instance. | Y |
| ||||||||||||
taskId | n/a | sys_id of the task definition that this Task Instance was created from. | N |
| ||||||||||||
taskName | n/a | Name of the task definition that this Task Instance was created from. | N |
| ||||||||||||
templateId | n/a | ID used within the controller to identify a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateName | |||||||||||
templateName | Template Name | Name of a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateId | |||||||||||
triggerId | n/a | sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). | N |
| ||||||||||||
triggerName | n/a | Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) | N |
| ||||||||||||
type | n/a | Task type of this task instance. | Valid values: 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, sql, stored_procedure, system_monitor, task_monitor, timer, universal, unix, variable_monitor, web_service, windows, workflow, zos. | N | ||||||||||||
updatedTime | n/a | If | Valid values:
Default is d. updatedTimeType is Between; date/time values (start date/time inclusive, end date/time exclusive)( yyyy-MM-dd [HH:mm:ss], yyyy-MM-dd [HH:mm:ss])
| Y | ||||||||||||
updatedTimeType | n/a | Type of | Valid values:
| N | ||||||||||||
workflowDefinitionId | n/a | sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowDefinitionName | n/a | Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowInstanceCriteria | n/a | Specification for how | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
workflowInstanceId | n/a | sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
| ||||||||||||
workflowInstanceName | Workflow | Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/taskinstance/showvariables |
HTTP Method | GET |
Description | Retrieve the variables for a specific task instance. (Comparable to the Show Variables functionality in the user interface.) |
Authentication | HTTP Basic |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example URI Properties | See List Task Instance Variables (Show Variables): Example URI Properties. |
Example Response | See List Task Instance Variables (Show Variables): XML and JSON Response Examples. |
...
Description | |
---|---|
URI | http://host_name/uc/resources/taskinstance/release |
HTTP Method | POST |
Description | Releases the specified task instance from hold. |
Authentication | HTTP Basic |
Example URI | http://localhost:8080/uc/resources/taskinstance/release |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | See Release a Task Instance from Hold: XML and JSON Examples. |
Request Properties | |
Example Response | See Release a Task Instance from Hold: XML and JSON Examples. |
...
Description | |
---|---|
URI | http://host_name/uc/resources/taskinstance/setpriority |
HTTP Method | POST |
Description | Set priority for a task instance (Linux/Unix, Windows, Universal, or z/OS). |
Example URI | http://localhost:8080/uc/resources/taskinstance/setpriority |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | See Set Priority for a Task Instance: XML and JSON Examples. |
Request Properties | |
Example Response | See Set Priority for a Task Instance: XML and JSON Examples. |
...