Advanced searches in Workplace
NOT
,
AND
, and OR
.
The advanced searches in Workplace are available in both federated and nonfederated environments. In federated environments, advanced searches are enabled, but it is recommended that you configure BPD indexing. In nonfederated environments, you must configure a federated data repository on your Business Automation Workflow servers. When a federated data repository is configured in your environment, the advanced searches work with processes and tasks. For more information, see Administering the federated data repository indexes.
Typically, a search query that is created using basic filters can be converted to an advanced search and back. However, when a query that you created by using an advanced search includes one or more elements that are not supported by the basic search, the advanced search cannot be converted into a basic search. Similar to basic searches, you can save your advanced searches for reuse or share them with other people or your team.
- You do not have complex search criteria. Use basic searches instead.
- You are not comfortable using the advanced search query syntax. Combine filters and use the basic searches instead.
Syntax
An advanced search consists of a filter and an (optional) sort clause.
- Filters
- A filter can be any of the following options:
Table 1. Filters Filters Description field
operator
value
A basic filter. For example, "Name" is "Approval"
.(filter) Enclose filter in parantheses to change the default priority of the keywords not
,and
, andor
.not
filterThe not
keyword applies to only one filter (basic or compound) and creates a new filter that evaluates totrue
when the original filter evaluates tofalse
, and vice versa.filter and
filterTwo filters that are combined together by using the and
keyword create a new filter that evaluates totrue
when at least one of the initial filters evaluates totrue
, and evaluates tofalse
otherwise.filter or
filterTwo filters that are combined together by using the or
keyword create a new filter that evaluates tofalse
when both initial filters evaluate tofalse
, and evaluates totrue
otherwise. - Sort
- The
sort
clause consists of the keywordorder by
, followed byfield
and (optional)order
. - Keywords
- Keywords are case-insensitive:
and
,or
,not
,order by
- operators
- sort order
following rules apply:
- The sort clause is always placed after the filter
- The sort clause cannot be enclosed in parantheses
()
. - The
"in"
operator supports array values. For example,"Name" in (val1, val2, val3)
.
Department is Finance order by Department ASC and Name is test (invalid)
is
invalid because the sort clause order by Department ASC
should
have been placed at the end.Reference
The following information provides an overview of the fields, operators, and values that you can use to build your advanced search queries in Workplace.
Filter attributes | Description |
---|---|
Fields | Fields can be:
Restriction: Note that the
"Task state" or "Workflow
state" fields can only be used once, and cannot be preceded or followed by the keyword
OR . Also, the "Task state" and "Workflow state"
fields cannot be preceded by the keyword not . |
Operators |
|
Value |
Value supports text that is enclosed in single or
double quotation marks (" , ' ). For example,
"Approval" , 'Approval' .If the value is not enclosed in quotation marks, make sure that the string does not contain any space. If the type of field is
If the type of field is
Date , the value supports multiple date
formats:
If the field contains predefined values, these values are returned by an API:
|
Sort attributes | Description |
---|---|
Field |
System and business data |
Order |
|
Examples
The following examples are provided for a better understanding of the query concepts and syntax.
- Example 1
- Query: Get all tasks with names that contain “Approval”.
- Example 2
- Query: Get all tasks that have Department equals Finance. Sort the list by task due date in ascending order.
- Example 3
- Query: Get all tasks that are not decision tasks and task names do not contain “Activity”.
- Example 4
- Query: Get all claimed and available tasks that do not have a completed date past 16 April 2024.
- Example 5
- Query: Get all tasks with names that contain “Approval” or whose hiring manager is Bob.