WmTaskClient. Returns the
total count of tasks that match the specified search criteria for tasks with
indexed business data. This services applies only to tasks with indexed
business data, stored in an Elasticsearch store by the HPSTRA module in
Task Engine.
Use when specifying the
toIndex and
fromIndex
parameters of the
pub.task.taskclient:searchTasksIndexed
service to avoid requesting an index beyond the size of the search results.
For more information about HPSTRA indexes, see
IBM webMethods Task Engine User’s Guide
and
IBM webMethods BPM Task Development Help.
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. An error occurs if
businessData is set to
true and the task type does not
contain any indexed fields.
-
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.
|
|
user
|
String
Optional. Specifies the user ID of the
IBM My webMethods 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 taskData search
criteria. If TaskSearchQueryV2 data type does not contain the search criteria
required to for the search, an error occurs. For more information, see
pub.task.TaskSearchQueryV2.
|
|
searchUserTasks
|
Boolean Optional. Indicates whether the operation
searches all tasks or only the user’s inbox.
Set to:
-
true to
only search the user’s inbox; to use this value you must define a value for the
user parameter.
-
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
|
totalCount
|
Returns the total number of tasks that
match the query.
|
|