Skip to content

Predefined Searches card

The Predefined Searches card gives dashboard readers a curated set of query chips.

When to use it

Use it when readers should combine a small, understandable set of filters without writing search syntax. Use Query box for unrestricted input.

Live example

The Card Lab mounts the production filter selector with deterministic interface-state choices.

Open the Predefined Searches Card Lab in a new page

Requirements

Requirement Value
Dashboard types Standard
Minimum size 1 column by 1 row
Data The selected entity context
Backend capabilities Entity search for the selected type
Permissions Read access to the selected entity type

Configuration

The paths below are relative to cardConfig.data.

entityType

Property Value
Type string
Required Yes
Default No default
Values device, interface, client, or group

Selects the entity filter updated by the chips.

predefinedSearches

Property Value
Type PredefinedSearch[]
Required When showing choices
Default Empty array
Values Ordered search definitions

Defines the available chips. Duplicate queries remain separate configured choices.

predefinedSearches[].name

Property Value
Type string
Required No
Default Runtime fallback in sorting: none
Values Short chip label

Sets the text shown to readers.

predefinedSearches[].query

Property Value
Type Neops search query string
Required No
Default * while parsing; undefined when composing a missing configured value
Values A query accepted by the Neops query parser

Defines the expression contributed by the chip.

predefinedSearches[].sortPriority

Property Value
Type Integer
Required No
Default Runtime sort priority 9
Values Integer priority; lower values sort first

Controls display order, with the name used as a secondary key.

localCardFilter

Property Value
Type JMESPath expression
Required No
Default No filter
Values An expression returning an array

Controls the card’s subscribed rows and its no-data state, without replacing the search expressions configured above.

Examples

Interface state choices

{
  "cardId": "predefined-query-selector",
  "data": {
    "entityType": "interface",
    "predefinedSearches": [
      { "name": "Up", "query": "state: UP", "sortPriority": 1 },
      { "name": "Down", "query": "state: DOWN", "sortPriority": 2 }
    ]
  }
}

Readers can activate either chip, invert it, and change the operator between selected chips.

Behavior

With no selected chip the card publishes *. Selected chips can be joined with AND or OR and individually inverted with NOT. The card restores its chip state when the shared filter changes elsewhere and shows an overflow gradient when choices exceed the available space.

Limitations and safety

Every selection updates the shared entity search, so dependent cards reload. Invalid query text can prevent the control from reconstructing its state.

See Query box and Query with predefined filters.