a!queryFilter() Function

Creates a value of type QueryFilter for use with a!pickerFieldRecords when defining filter options for expression-backed records, filtering a a!queryRecordType() or a!queryEntity() function call before any grouping or aggregation is computed, or using the a!recordData() function to define additional filters when referencing a set of records from a record type.

Syntax

a!queryFilter( field, operator, value )

  • field (Any Type): The field the filter will apply to. When filtering record data, reference a record field using the recordType! domain. For example, recordType!Case.fields.caseName.
  • operator (Text): The operator to apply to the filter. Valid values include =, <>, >, >=, <, <=, between, in, not in, is null, not null, starts with, not starts with, ends with, not ends with, includes, not includes.
  • value (Text): The value to compare to the given field using the given operator. Can be entered as an expression. Optional if the operator value is is null or not null.
  • applyWhen (Boolean): Determines whether the filter is applied on the query. When set to false, the filter is not evaluated. Default: true.

Returns

QueryFilter

Examples

1
2
3
4
5
	=a!queryFilter(
	  field: recordType!Case.fields.status,
	  operator: "=",
	  value: "active"
	)

Notes

  • If the operator value is between, the value must be a list of only two elements with the lower bound as the first element and the upper bound as the second.
  • When filtering record data, you must reference fields from the source record type. Use a record type field reference to reference the field you want to filter by. For example, recordType!Employee.fields.department.

See Also

a!recordFilterListOption(): use the a!queryfilter() function to create a value for the filter parameter of this function.

query: the query data type defines the grouping, aggregation, filtering, paging, and sorting configuration to be applied when querying data.

queryfilter: this is the data type the a!queryfilter() function returns.

a!queryRecordType(): Use the a!queryRecordType() function to execute a user-defined query on a given record type and return the results.

a!queryEntity(): Use the a!queryEntity() function to execute a user-defined query on a given data store entity and return the results.

a!recordData(): Use the a!recordData() function to reference a set of records from a record type and allow additional filtering if necessary.

Open in Github Built: Fri, Sep 17, 2021 (04:03:56 PM)

On This Page

FEEDBACK