/
Customize the CMS Widgets Using Filters

Customize the CMS Widgets Using Filters

For a list of the SmartServer widgets with links to the tasks you can perform using the widgets, see SmartServer CMS Widgets Index.

You can customize the information displayed by many of the CMS widgets. For widgets that display lists of resources such as device types, devices, datapoints, and datapoint properties, you can customize the list that is displayed with one or more search specifications that filter the contents of the lists to more rapidly find a particular entry in the list.

Widgets that include a search filter have a Set Filters button (image-20250212-003659.png) at the top of the widget.

This section demonstrates the Datapoints widget Set Filter feature as an example. The Datapoints widget is available with SmartServer 2.5 and higher. Prior to SmartServer 3.4, this widget was called Datapoint Browser. 

To set filters, perform the following steps:

  1. Open the SmartServer CMS.

  2. Open the Datapoints widget. Click the Expand button (image-20250212-003733.png).

    image-20250212-003757.png

     

  3. Click the Set Filters button (image-20250212-003813.png).

    The Set Filters view appears.

     

  4. Use the dropdown menus to define the search criteria. Click the Add Filters button (image-20250212-003851.png) to further refine the search parameters. See the reference tables at the end of this page for more information about filter settings.

    The example below shows the following filter settings:

    • Source: Live

    • Device Status: Provisioned

    • Device: Tstat-01 

    • Datapoint XIF Name: AV:39

       

  5. Click Apply Filters.

    The results below show the Datapoints widget prior to and after set filters.

     

Reference Tables

The table below summarizes available filter settings and values.

Filter Setting

Values

Filter Setting

Values

Alarm State

  • Active

  • Inactive

Block

System specific

Block Index - System specific

System specific

Block XIF Name - System specific

System specific

Category

  • Edge Device

  • System Controller

Context

System specific

Context Area

  • Building

  • Campus,

  • Campus Area

  • Floor

  • Floor Area

  • Room

Datapoint

System specific

Datapoint Type

System specific

Datapoint XIF Name

System specific

Device

System specific

Device Status

  • Deprovisioned – devices that are not provisioned

  • Down – provisioned devices that are not communicating

  • Marginal – devices with marginal health status indicating that a failure was reported by the device, typically during provisioning (i.e., the device could be reached but it would not provision due to an error unrelated to communication). For drivers that implement marginal state, this device status is available with SmartServer 3.2.

  • Normal – devices that are provisioned with normal health status

  • Provisioned – devices that are provisioned (all health status types)

  • Provisioning – devices that are being provisioned

  • Suspect – provisioned devices that are not communicating

Device Type

System specific

Driver

System specific

Firmware Version

System specific

Group

System specific

Override State

  • Not Overridden

  • Overriden

Priority

  • 1 (Highest), 2, 3,... 16 (Lowest)

  • Normal

Profile

System specific

Program ID

System specific

Segment Controller

System specific

Source

  • Live – displays real-time data for a datapoint

  • Log – displays data logs for datapoints (logging must be enabled using the Datapoint Properties widget in order to view logs)

Tag

System specific

Unique ID

System specific

XIF Name

System specific

The table below describes specific Setting features and functions.

Feature

Function

Feature

Function

Add Filter button ()

Adds filters

Remove Filter button ()

Removes a specific filter

Remove All Filters button ()

Clears all filter settings

Not

Finds items that do not match the search criteria

Exact

Finds items that are an exact match

(.*)

Specifies custom filters

Related content

Setting Filters on the Connections Widget
Setting Filters on the Connections Widget
More like this
Viewing and Setting Datapoints
Viewing and Setting Datapoints
More like this