pub.task.taskclient:searchTasksIndexed

Edit online

WmTaskClient. Returns a subset of tasks that match the specified search criteria for indexed business data fields only. Only indexed fields are returned as part of the task data.

The query must contain a search term specifying the taskTypeID when searching for business data fields. The Task Engine uses the taskTypeID to identify the specific index table to use. You can search for multiple task types in a single query by specifying multiple taskTypeID values when you define the search criteria. If you are not searching for business data fields, then a taskTypeID is not required.

Use this service only when working with indexed business data fields. If you are working with standard business data fields, use pub.task.taskclient:searchTasks.

Input Parameters

businessData Boolean Optional. Indicates whether the search query operation includes indexed business data when processing the search query.

Use this property when your search query contains search terms that reference indexed business data fields.

Set to:

  • true to include business data in the search query processing.
  • false when your search query does not require processing of business data or when your task type does not use any defined indexed business fields.

The default value for businessData is false.

user String Optional. Specifies the user ID of the Integration Server user for which the operation executes. If user is not specified, the administrative user ID under which your client program logged on as is used. The operation only searches tasks the user can access.
TaskSearchQuery TaskSearchQueryV2 Specifies the pub.task.TaskSearchQueryV2 document type that provides the search criteria. If TaskSearchQueryV2 is null, an error occurs.
searchUserTasks String Optional. Specifies whether the service searches all tasks or just the user's inbox.

Set to:

  • true to search only the inbox for user.
  • false (default) to search all tasks to which user has access.

By default, only active tasks are returned. This can be overridden with the showNonActiveTasks parameter in pub.task:TaskSearchQuery.

retryOnFailureCount String Optional. Specifies the number of times to attempt to invoke the service. The default is 0 times. When specified, this value will override the configuration value set on the WmTaskClient Home page in IS Administrator.
retryDelay String Optional. Specifies the number of milliseconds to wait between attempts. The default is 1000 ms (this field is ignored if retryOnFailureCount = 0). When specified, this value will override the configuration value set on the WmTaskClient Home page in IS Administrator

Output Parameters

Task Document List Contains TaskData documents that match the search criteria in TaskSearchQuery. Each document in the result set has the following structure:
  • TaskID String The identifier assigned to the task.
  • TaskInfo Document TaskInfo document containing standard information about the task. See pub.task:TaskInfo for a description of the fields in this document.
  • TaskData Document TaskData document containing the indexed business data associated with the task. Returned only if businessData is set to true.

Usage Notes

If no tasks match the search criteria, an empty TaskData document is returned. The search query must contain a search term specifying the taskTypeID to search business fields and create an index of the results.

For detailed information about implementing indexed searching, see IBM webMethods BPM Task Development Help (available online in IBM webMethods Designer and as a PDF publication) and the PDF publication IBM webMethods Task Engine User’s Guide.