Using the Task Engine Built-in Services
Task Engine Built-In Services Location
The built-in services in this chapter are installed on Integration Server as part of the WmTaskClient package. You can find these Java services by opening the following folder location in the Package Navigator view in IBM webMethods Designer:
Integration Server_directory\instances\instance_name\packages\WmTaskClient\pub
This chapter describes the services and supporting elements found in the \pub\task folder. You can use these services as templates to create custom services in Designer that can create, modify, locate, queue, and delete tasks on the Task Engine to which Integration Server is connected.
For more information about working with services in general, see IBM webMethods Service Development Help.
Summary of Available Services
The following table lists the services, available in the \pub\task folder:
| Element | Package and Description |
|---|---|
| pub.task.taskclient:addTagsToTask | WmTaskClient. Adds the specified tags to a task. |
| pub.task.taskclient:addTaskAttachment | WmTaskClient. Adds an attachment to a task. |
| pub.task.taskclient:addTaskComment | WmTaskClient. Adds a comment to a task. |
| pub.task.taskclient:countTasksIndexed | WmTaskClient. Service that returns the total count of tasks that match the specified search criteria. This service applies only to tasks with indexed business data. |
| pub.task.taskclient:countTasksIndexedHPSTRA | WmTaskClient. Service that returns the total count of tasks that match the specified search criteria. This service applies only to HPSTRA-enabled tasks with indexed business data. |
| pub.task.taskclient:deleteTagsFromTask | WmTaskClient. Deletes all tags from a task. |
| pub.task.taskclient:deleteTask | WmTaskClient. Service that deletes an instance of a task on the Task Engine to which the Integration Server is connected. |
| pub.task.taskclient:deleteTaskAttachment | WmTaskClient. Deletes the specified task attachment from a task. |
| pub.task.taskclient:deleteTaskComment | WmTaskClient. Deletes the specified task comment from a task. |
| pub.task.taskclient:formFlowTaskNotify | WmTaskClient. Service that notifies a waiting step in a task workflow that the workflow is completed. |
| pub.task.taskclient:getTask | WmTaskClient. Service that returns the TaskInfo object, and optionally the TaskData object, for a specified task. |
| pub.task.taskclient:getTaskAttachments | WmTaskClient. Returns all the attachments in a task. |
| pub.task.taskclient:getTaskAudit | WmTaskClient. Returns the audit log of all of the operations performed on a task. |
| pub.task.taskclient:getTaskComments | WmTaskClient. Returns all the comments in a task. |
| pub.task.taskclient:getTaskExpertList | WmTaskClient. This service returns a list of experts associated with the specified tags. |
| pub.task.taskclient:listTagsByTask | WmTaskClient. This service returns a list of tags associated with a task. |
| pub.task.taskclient:queueTask | WmTaskClient. Service that adds a task instance to the Task Engine's queue. |
| pub.task.taskclient:rollbackTask | WmTaskClient. Enables you to roll back the task to any available audit point in the task's audit history. |
| pub.task.taskclient:searchTasks | WmTaskClient. Service that is used to retrieve tasks that match specified search criteria. This service applies only to tasks that use standard business data. |
| pub.task.taskclient:searchTasksHPSTRA | WmTaskClient. Retrieves tasks that match the specified search criteria. This service applies only to HPSTRA-enabled tasks with standard business data. |
| pub.task.taskclient:searchTasksFields | WmTaskClient. Service that returns a collection of named fields requested in each service that matches specified search criteria. |
| pub.task.taskclient:searchTasksFieldsHPSTRA | WmTaskClient. Service that returns a collection of named fields requested in each service that matches specified search criteria. This service applies only to HPSTRA-enabled tasks with indexed business data. |
| pub.task.taskclient:searchTasksIndexed | WmTaskClient. Service that returns a subset of tasks that match the specified search criteria on the Task Engine connected to the Integration Server. |
| pub.task.taskclient:searchTasksIndexedHPSTRA | WmTaskClient. Service that returns a subset of tasks that match the specified search criteria on the Task Engine connected to the Integration Server.This service applies only to HPSTRA-enabled tasks with indexed business data. |
| pub.task.taskclient:updateTask | WmTaskClient. This service modifies a task on the Task Engine that is connected to the Integration Server. You use this service to change information in the task's TaskInfo and TaskData documents. This service applies only to tasks with Active, Error, and Suspended status. For information about updating tasks with other statuses, see Usage Notes. |
| pub.task.taskclient:updateTaskAttachment | WmTaskClient. Updates the specified task attachment. |
| pub.task.taskclient:updateTaskComment | WmTaskClient. Updates the specified task comment. |
| pub.task.taskclient:updateTaskTags | WmTaskClient. Updates the tags associated with a task. |