Skip to main content

Decorators

NQE Decorators enable the use of NQE Queries to enhance Forward applications by incorporating additional contextual data.

Forward supports NQE Decorators for Devices, Hosts, Interfaces, and Paths.

Add a Decorator​

To add a Decorator, navigate to NQE > Decorators and click Add a Decorator

NQE Decorators add

note

The drawer for adding an NQE Decorator is very similar for devices, hosts, interfaces, and paths. The following describes the flow for devices.

  • Select Device from the Entity type drop-down menu

    NQE Decorators Entity Types

  • Use data connectors from a specific network: If the NQE Decorator relies on an NQE query that retrieves data from a data connector, enable this option and choose the Network with the data connectors from the provided drop-down menu.

    NQE Decorators Data Connectors

  • NQE query: choose an NQE query from the drop-down menu. Start typing the NQE query name to quickly find it among the full list of queries.

    NQE Decorators Query

  • The Decorator name field is pre-filled with the NQE query name, but it can be customized.

    NQE Decorators Name

  • Join Columns: The columns from the NQE query results to use to filter the results before joining/combining them with an individual entity. For example, you must choose the column that contains device names to decorate devices. For each device being decorated, the chosen column will be used to filter the results to those that match the device.

    NQE Decorators Join Columns

  • Display all columns: Keep this selected to display all columns from the query's results when displaying this Decorator's data. Turn this off to choose specific columns to display instead.

    NQE Decorators Query Columns

Then, click on Save.

The following screenshot shows a device card with an example NQE Decorator.

NQE Decorators Example

Display/Edit/Delete a Decorator​

Decorators can be turned off/on by using the Display toggle in the table.

NQE Decorators Edit

To edit an NQE Decorator, click on the edit icon on the right side of the Decorator's row in the table, change any Decorator detail, and click on Save.

note

Once a Decorator is created, it is not possible to change the Entity type associated with it.

To delete an NQE Decorator, click on the bin icon on the right side of the Decorator's row in the table, and confirm its deletion.

NQE Decorators Edit