filter¶

filter sets a filter on the root node. (only root node)

actionValues
`attribute`	define a attribute for the filter
`value`	define a value or a range for the filter
`label`	defines a label
`operator`	set one of the given operators. `Not equals`,`Is null`,`Is not null`,`like`,`gt`, `gte`, `lt`, `lte`
`clear`	clears all filters
`totalCount`	When set to true, it shows the total number of hits that this filter would display, regardless of other filters and restrictions.
Use this carefully as it can affect performance.

Fix¶

Sets a filter for a fixed value

{
    "label": "High prio",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "attribute": "WOPRIORITY",
            "value": "1"
        }
    ]
}

User profile¶

Compares a value from the userData with an attribute

{
    "label": "Mine",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "attribute": "OWNER",
            "value": "${userData.personid}"
        }
    ]
}

Date range¶

Date range filters react as follows: Filter example: DATE:WEEK:-2, Today is: 24.01.2019, resulting date filter is: from 07.01.2019 to 27.01.2019.

Pattern: <UNIT>:<VALUE>
UNIT: TODAY or WEEK or MONTH
VALUE: positiv or negative number

{
    "label": "Last week",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "attribute": "REPORTDATE",
            "value": "WEEK:-1",
            "label": "Last week"
        }
    ]
}

The different operators¶

Not equals¶

{
    "label": "Not Mine",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "attribute": "OWNER",
            "value": "${userData.personid}",
            "operator": "notEquals"
        }
    ]
}

Is null¶

{
    "label": "No prio",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "label": "No priority",
            "attribute": "WOPRIORITY",
            "operator": "isNull"
        }
    ]
}

Is not null¶

{
    "label": "Has prio",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "label": "Has priority",
            "attribute": "WOPRIORITY",
            "operator": "isNotNull"
        }
    ]
}

Is in list¶

{
    "label": "Prio 1 + 2",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "label": "High and Middle",
            "attribute": "WOPRIORITY",
            "value": ["1", "2"]
        }
    ]
}

like¶

{
    "label": "*m*",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "label": "*m*",
            "attribute": "OWNER",
            "operator": "like",
            "value": "*m*"
        }
    ]
}

gt, gte, lt, lte¶

{
    "label": "Greater than 5",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "label": "Greater than 5",
            "attribute": "PRIO",
            "operator": "gt",
            "value": 5
        }
    ]
}

isIn¶

{
    "label": "isIn",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "label": "isIn",
            "attribute": "PRIO",
            "operator": "isIn",
            "value": [1, 2]
        }
    ]
}

Extras¶

Clear all filter¶

{
    "label": "*m*",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "clear": true
        }
    ]
}

Combined filters¶

{
    "label": "Mine, last week",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "clear": true
        },
        {
            "attribute": "OWNER",
            "value": "${userData.personid}"
        },
        {
            "attribute": "REPORTDATE",
            "value": "WEEK:-1",
            "label": "Last week"
        }
    ]
}

Specific tree¶

{
    "label": "High prio",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "treeName": "my-tree",
            "attribute": "WOPRIORITY",
            "value": "1"
        }
    ]
}

totalCount¶

{
    "label": "High prio",
    "icon": "icon-user",
    "action": "filter",
    "actionValues": [
        {
            "totalCount": true
        },
        {
            "attribute": "WOPRIORITY",
            "value": "1"
        }
    ]
}

`OR` filters¶

Backend search with OR