Task Engine 10.11 | Task Engine Webhelp | webMethods Task Engine API and Service Reference | Using the Task Engine Built-in Services | pub.task.taskclient:searchTasksHPSTRA
 
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.
For more information about HPSTRA indexes and HPSTRA-enabled tasks, see webMethods Task Engine User’s Guide and webMethods BPM Task Development Help.
Input Parameters
includeTaskData
String Optional. Specifies whether the service will return the TaskData document as well as the TaskInfo document for each task matching the search criteria. Set to:
*true to include the TaskData document in the result set.
*false (default) to include only the TaskInfo document in the result set.
user
String Optional. The user ID of the My webMethods Server user on whose behalf this service will execute. If user is not specified, the user ID associated with the WmTaskClient package is used. For information about configuring this user ID, see webMethods Task Engine User’s Guide.
Note:
Only tasks to which user has access are searched.
TaskSearchQuery
Document Optional. TaskSearchQuery document, which specifies the search criteria. See pub.task:TaskSearchQuery for a description of the fields in this document.
If TaskSearchQuery is null, all tasks for user will be returned. For additional behavior, see the MaxResults parameter in pub.task:TaskSearchQuery.
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.
retryOnFailure Count
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 Result set containing the tasks 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 A TaskInfo document containing standard information about the task. See pub.task:TaskInfo for a description of the fields in this document.
*TaskData Document A TaskData document containing the business data associated with the task. TaskData does not have a specified structure. Its content varies according to the task. Returned only if includeTaskData is set to true.
Usage Notes
When a task is configured with a standard search provider, the search examines all business data in all the tasks in the inbox. If the number of tasks in an inbox is relatively small, this search executes quickly. However, when a large number of tasks are present, a standard (full) search can take significantly longer.
For faster searches, consider implementing an indexed search provider, which examines only specified indexed business data fields table and ignores all other fields, resulting in a much faster search. In this case, the task developer must mark one or more business data fields as indexed fields, otherwise the search will return no results.
For detailed information about implementing indexed searching, see webMethods BPM Task Development Help and webMethods Task Engine User’s Guide.
For more information about searching indexed business data fields with a service, see pub.task.taskclient:searchTasksIndexed.