Skip to main content

Celonis Product Documentation

Global Search
Overview

Placement

View

or

Profile View

Required KM objects

Record.Attribute

Introduction to Search

Use the "Search" component on (Profile) Views to allow your user to search by relevant attributes. The entire View will be filtered by the entered search term.

55705914.gif
Basic configuration

Please find below an example of the most basic configuration of the "Global Search" component:

Attribute

Required

Type

Description

search

true

List of attributes

Requires a list of attributes by which the user can search.

attribute

true

Record.Attribute

References an attribute defined in the Knowledge Model, which will be considered for the search.

Important

Ensure that the columnType is defined in your KM. For more details open the screenshot below.

Click here to see screenshot

55705917.png

Then add the relevant attributes that should be available for search. The attributes are called by their ID defined in the Knowledge Model.

Column Type required

Make sure you added the columnType in the attribute in the Knowledge Model:

e.g.

      - id: INVOICE_PAYMENT_TERM
        displayName: Payment Term
        pql: ${VARIBALE_CASE_TABLE}."ZTERM"
        filterIds: []
        columnType: string

(Integer or string)

Info

optimised for component editor

id: GlobalSearch
type: global-search
settings: 
    search:
                - attribute: SEARCH_BY_RECORD.ATTRIBUTE1
        - attribute: SEARCH_BY_RECORD.ATTRIBUTE2
Advanced configuration

In addition to the basic configuration , these additional configuration options are also available.

Attribute

Required

Type

Possible values

Default Value

Description

floatingPlaceholder

false

Boolean

true

false

false

Defines if the "Search" title is displayed within the search only or additionally above the search bar.

Click here to see screenshot

55705919.png

autoFocus

false

Boolean

true

false

true

Defines if auto-focus is turned on/off for the search component.

Click here to see screenshot

55705918.gif

label

false

String

-

Search

Defines a custom label that should be displayed.

Click here to see screenshot

55705920.png

search

true

List of attributes

Requires a list of attributes by which the user can search.

id

false

String

-

-

Defines a unique identifier for the search option. It is important in context of Base and Extension.

scope

false

Enum

hidden

disabled

immutable

Defines the scope of the search option. It is important in the context of Base and Extension.

styles

false

Defines the different styles you can apply to the component. As of now, the only position is available.

position

false

Defines that the position within the given layout.

horizontal

false

Enum

full

left

center

right

full width

Defines the horizontal position within the given layout.

vertical

false

Enum

top

center

bottom

bottom

Defines the vertical position with the given layout.

Info

optimised for component editor

id: GlobalSearch
type: global-search
settings: 
        autofocus: false 
        floatingPlaceholder: true 
        label: customLabel 
    search:
                - attribute: SEARCH_BY_RECORD.ATTRIBUTE1
                  id: SEARCH_BY_RECORD.ATTRIBUTE1
                  scope: hidden
        - attribute: SEARCH_BY_RECORD.ATTRIBUTE2
        style:
                position:
                        horizontal: right
                        vertical: top