Smartlist / Smart search

Een voorbeeld van de YAML:

list:
    fields:
    -   name: ogc_fid
        label: id
    -   name: status
    -   name: title
        label: Titel
    -   name: locatie
        label: Naam van de locatie
    -   name: opdrachtgever
        label: Opdrachtgever
    -   name: due_date
        label: Uiterste opleverdatum
    -   name: expected_date
        label: Verwachte opleverdatum
    -   name: geom

    sortFields:
    -   name: ogc_fid
    -   name: titel
        direction: desc
    -   name: opdrachtgever
        direction: asc

    filterFields:
    -   name: locatie
    -   name: titel
    -   name: ogc_fid

    where:
    -   field: user_email
        type: principal_email
        force: true
    -   field: locatie
        type: equals
        value: Deventer

Het scherm zal vanzelf alle fields onder de YAML tonen.
Hier kunnen de velden gekoppeld worden aan de attributen van de dataset.

Let op als een field niet gekoppeld is zal een foutmelding worden getoond. De configuratie kan dan niet opgeslagen worden.

Where operators

De where-clausule kan gebruikt worden voor het filteren van de resultaten. Een voorbeeld van een where-statement is als volgt:

    where:
    - field: user_email
      type: principal_email
      force: true
    - field: locatie
      type: equals
      value: Deventer
      force: true
    - field: naam
      type: like

Een where-clausule is altijd opgebouwd uit een field (attribuutnaam) en type (operator).

Filter altijd toepassen of op invoer

De definities in het where-object kunnen afhankelijk van de configuratie altijd worden toegepast, of alleen worden toegepast op basis van gebruikersinvoer in het de zoekterm. Indien een filter altijd toegepast dient te worden, moet de parameter force: true toegevoegd worden in de configuratie (zie bovenstaand voorbeeld). Bij gebruik van operators anders dan principal_email of principal_setting dient ook hiermee altijd value: toegevoegd te worden met de gewenste waarde.

Operators (types)

Equals

equals
Equals directly compares a value to another value, this expects a single value and compares it exactly.

NotEqual

notequals
Not equals directly compares a value to another value, this expects a single value and compares it exactly and will return items that do not compare to the input value.

LIKE

like
Like is similar to equals but it allows for the use of wildcart characters, like % where you can put it in a string to find items that begin/end/contain a certain part as example: 'Deven%' would find the value 'Deventer' but also other values that begin with 'Deven'

NotLike

notlike
Not like works just like LIKE but returns all items that do not compare.

ILike

ilike
ILIKE is similar to LIKE in it's functionality but it is not case sensitive.

NotILike

notilike
Not ILIKE is similar to Not LIKE in it's functionality but it is not case sensitive.

GreaterThan

greaterthan
Greater than checks if the value is greater than the input value, this is mainly for numerical values.

LessThan

lessthan
Less than checks if the value is smalle than the input value, this is mainly for numerical values.

GreaterThanOrEqual

greaterthanorequal
Greater than or equal checks if the value is greater than or the same as the input value, this is mainly for numerical values.

LessThanOrEqual

lessthanorequal
Less than or equal checks if the value is smaller than or the same as the input value, this is mainly for numerical values.

IsNull

isnull
Checks if the column does not contain a value, no input is needed.

IsNotNull

isnotnull
Checks if the column does contain a value, no input is needed.

principal_email

principal_email
Principal Email will fetch the email of the currently logged in user and will compare it to the requested column.
This operator is always forced and can not be mutated by giving a value, or by the request.

principal_setting

principal_setting
Principal setting will fetch a certain setting for the currently logged in user and will compare it to the requested column. A additional parameter in the YAML needs to be given to set the setting that is to be used.
setting: <name of the setting>