Custom interactive filters

<a class="link" href="https://docs.servicenow.com/bundle/xanadu-now-intelligence/page/use/performance-analytics/concept/c_performanceAnalyticsAndReporting.html" title="Optimize processes and increase productivity with the Platform Analytics applications. These applications include Reporting, Performance Analytics, User Experience Analytics, and Process Mining. Present data through either the Core UI or the Platform Analytics experience.">Platform Analytics > Reporting, dashboards, and Performance Analytics in the Core UI >

As an administrator, you can create scripted interactive filter widgets to provide advanced filtering options on dashboard reports.

With a custom interactive filter, you can control aspects of the filter interface and filtering logic. Create filters that fit your specific needs. Custom interactive filters include filters that perform multiple, common filtering operations with a single click.

Custom filters are scripted System UI Widgets that use the DashboardMessageHandler JavaScript class to define and publish report filters.

Role required: hp_publisher_admin and report_admin. The hp_publisher_admin role exists only for managing interactive filters in Core UI. By default, it contains the role analytics_filter_admin for managing Core UI filters that are migrated to Platform Analytics experience.

Note: The exposed API for custom interactive filters is limited and does not provide parity with standard interactive filters. Before implementing any custom interactive filters, review the Custom interactive filter limitations . Access control lists on the Table API may restrict the records shown when a dashboard is filtered. To alleviate this problem, add users or roles to the Table API access control list. For more information, see Access control list rules .

The code that publishes the filter must call the SNC.canvas.interactiveFilters.setDefaultValue() method and it must call the dashboardMessageHandler.publishFilter() method to publish the filter.

Define the appearance of the widget, such as available buttons, using Jelly.

You can add multiple custom interactive filters to the same dashboard. The filters must have unique IDs in the filter object and unique IDs for the DashboardMessageHandler .

Custom interactive filter examples As an administrator, you can create custom interactive filter widgets to provide advanced filtering options on dashboards. Use the Debug filter The debug interactive filter helps you create custom filters. This filter displays a JSON array representation of all active filters on a dashboard. Custom interactive filter limitations Custom interactive filters are a fallback for use when standard interactive filters do not provide certain functionality. DashboardMessageHandler Provides methods to define custom filtering logic for interactive filters. Dynamic JavaScript filters Create dynamic conditions in JavaScript that you can configure as part of a report visualization's criteria instead of specified values.

Parent Topic: Interactive Filters