Designing and Implementing Business Process Models 10.5 | Designing and Implementing Business Process Models | Task Engine API and Service Reference | Using the Task Engine Web Service API | Summary of Data Structures | TaskSearchQueryV2
 
TaskSearchQueryV2
Use the TaskSearchQueryV2 data type as input to searchTasksIndexed.
The TaskSearchQueryV2 data type includes the same fields as TaskSearchQuery plus the additional fields listed in the table below to support queries on indexed business data.
Field Name
Description
fromIndex
Integer Specifies the starting index of the page of search results. Zero represents the first index of the result set.
toIndex
Integer Indicates the end of the search results indexed on the page. The toIndex must be greater than the fromIndex and less than or equal to the total result count.
sortBy
String Optional. Specifies the comma-separated list of field names used to sort the search results. The first entry is the primary sort key, second entry is the secondary sort key, matching the results to the order of the sort key sequence.
When specifying indexed field names, you must provide the database index field name. To determine the value of the database index field name, see TaskSearchQueryTerm.
sortOrder
String Optional. Specifies the comma-separated list of values ascending (ASC) or descending (DESC) that match the sortBy list of fields. sortOrder indicates the sort order used to list the fields, ascending or descending order.
Set sortOrder to:
*ASC to display the results in ascending order.
*DESC to display the results in descending order.
The default sortOrder is ascending (ASC).
searchEngineType
String Optional. Specifies the search engine to use when searching for tasks. Valid values are:
*db - to search task data, stored in the indexed table of the My webMethods Server database.
*hpstra - to search task data, indexed in an Elasticsearch store by the HPSTRA module in Task Engine.
You can also specify the name of any custom engine that you develop for task searches and register as an OSGi service in the My webMethods Server runtime. For more information and examples about adding custom task search engines, see the Software AG TECHcommunity website.
principalID
String Optional. The ID of the principal whose inbox is to be searched. If not specified, the default value is the Task Server User, as defined on the WmTaskClient package's home page.
checkPermissions
Boolean Optional. Specifies if the current user’s permission are checked prior to the task search. Default is true.
invocationID
This parameter is for internal use only. Do not use.
Copyright © 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.