SearchActor

The main function of the SearchActor is to send search queries to the Core Engine. Various components and actors are able to use a SearchActor.

Properties

• Parent:

  • Actor

• Type: SearchActor

Parameter

Parameters in the Layout

Name	Type	Description
count	number fallback: If SearchSetActor is defined, attribute searchDefaultPageSize	Specifies the page size for the search queries. (Not required if searchSetActor applies.)
module	string fallback: module of context	Specifies the Core Engine module in which to search (only required if not the current module should be used).
defaultSortField	string	Specifies the default field on basis of which the search result is to be sorted (not required if searchSetActor applies).
defaultSortOrder	string possible values: asc desc	Specifies the default sorting order (not required if searchSetActor applies).
instantSearch	boolean default: false	Defines whether the actor searches immediately at the beginning.
searchSetActor	SearchSetActor	Used to get values from object renderer set configuration.
fields	array of strings	Fields are loaded directly with the search request.
additionalFilter	array of SearchPropertyFilter	Additional filters that are sent with each search request (legacy).
additionalQuery	string	Additional 4APQL query that is sent with each search request.
sortField	string fallback: If SearchSetActor is defined, attribute searchDefaultSortField attribute defaultSortField	Specifies the field on the basis of which the search query is to be triggered.
sortOrder	string possible values: asc desc fallback: If SearchSetActor is defined, attribute searchDefaultSortOrder attribute defaultSortOrder	Specifies the sorting order (not required if searchSetActor applies).
additionalSortFields	array of strings	Specifies additional fields, on the basis of which the values of a sorted list are further sorted and displayed. Example: With the additionalSortFields "firstname" and "email" in a subpanel containing contacts, sorting the contacts by last name would automatically sort all "Millers" by their first name in alphabetical order. If there are two "Millers" with the same first name, they would be sorted by their email address
additionalSortOrders	array of strings possible values: asc desc default: asc	Specifies the sorting order of the additionalSortFields. The first given order is used for the first additionalSortField, the second for the second, and so on.

SearchPropertyFilter

type SearchPropertyFilter = {
    operator: LogicalOperator,
    comparator: Comparator,
    value?: unknown,
    group: string,
    field: string,
    unit?: string,
}

Comparator

type Comparator =
        'EQUAL' |
        'NOT_EQUAL' |
        'LIKE' |
        'NOT_LIKE' |
        'IN' |
        'NOT_IN' |
        'LESS_THAN' |
        'LESS_THAN_OR_EQUAL' |
        'GREATER_THAN' |
        'GREATER_THAN_OR_EQUAL' |
        'IS' |
        'IS_NOT' |
        'CONTAINS_ALL' |
        'NOT_CONTAINS_ALL';

LogicalOperator

type LogicalOperator =
        'AND' |
        'OR' |
        'AND NOT' |
        'OR NOT';