CH logo® Knowledge Base
Contents Search
   

 

Saved Filters

Note: These settings are accessed via the Admin menu, which is displayed to Admin users only (hidden from Member users).

Saved filters include both customer-created “company” filters and Kentik-provided “preset” filters. Creation and management of saved filters is covered in the following topics:

 

 
 top

About Filters

General information about filters is provided in the following topics:

 

 
 top  |  section

Filters Overview

In Kentik Detect, a filter allows you to narrow query results, either inclusively or exclusively, based on a value or range of values for one of the 50+ dimensions that represent the fields of the KDE main table (described in Main Table Schema). Any filters specified for a given query are included in the WHERE clause of that query.

Filters are configured within filter groups to allow control over the order of their operations. An unlimited number of filter groups can be defined, each containing an unlimited number of filters.

Kentik Detect supports two main types of filters, preset and company, which are covered in the topics below.

 

 
 top  |  section

About Preset Filters

A preset filter is a ready-made filter provided as part of Kentik Detect. Preset filters are:

  • Applied to queries via the Saved Filters selector on the Filters pane of the sidebar in Data Explorer or Dashboards.
  • Managed via the Saved Filters Page.

 

 
 top  |  section

About Company Filters

A company filter is a filter created by a Kentik Detect user and available to other users in the same organization. Company filters are:

  • Created in and saved from one of the following:
    - the Filtering Pane Settings on the Filters pane of the sidebar in Data Explorer or in Dashboards;
    - the Saved Filters page (Admin » Saved Filters), either by duplicating an existing filter (preset or company) or by creating a filter from scratch (see Add or Edit Filter).
  • Applied to queries via the Saved Filters Selector on the Filters pane of the sidebar in Data Explorer or Dashboards.
  • Managed via the Saved Filters Page.

Note: Filters can also be created and applied in the Filters pane of the Add Dataset dialog when creating a BGP Dataset for Peering Analytics), but those filters are not saved and saved filters cannot currently be applied in that modal.

 

 
 top

Saved Filters Page

To access the Saved Filters page, choose Admin from the Kentik navbar, then Saved Filters from the sidebar at left. The page is covered in the following topics:

 

 
 top  |  section

Saved Filters Page UI

The Saved Filters page includes the following UI elements:

  • Filter field: Filters the Saved Filter List to show only rows containing the entered text in the filter’s name or description.
  • Share Level selector: Allows you to narrow the filters listed in the Saved Filter List by share level:
    - All: List all saved filters.
    - Preset: List only preset saved filters (see About Preset Filters).
    - Company: List only company saved filters (see About Company Filters).
  • Add Filter button: Opens an Add Saved Filter dialog where you can add a saved filter (see Saved Filter Admin Dialogs).
  • Saved Filter List: A table listing your organization’s preset and company filters (see Saved Filter List).

 

 
 top  |  section

Saved Filter List

The Saved Filter List is a table that shows information about the listed saved filters as well as available actions. By default the list is ordered alphabetically by name (ascending). To change the sort order of the list, click on a heading to choose a sort column, and on the resulting blue up or down arrow to choose the sort direction (ascending or descending).

Note: To see additional information about a given saved filter, click anywhere in the row for that saved filter, which opens a Edit Saved Filter dialog in which you can review and edit settings (see Saved Filter Admin Dialogs).

The Saved Filter List includes the following columns (left to right):

  • Share Level: Either preset or company.
  • Name: The name of the saved filter, as well as a description of it, including (hopefully) what it does and how it’s used.
  • Copy: Duplicates the saved filter, appending “Copy” to the name, and adds it to the list.
  • Delete (company filters only): Opens a confirming dialog that enables you to remove the saved filter from your organization.
    Note: You can also remove a saved filter via the Remove button at lower left in the Edit Saved Filter dialog.

Click on a column heading to sort the list (ascending or descending).

 

 
 top

Saved Filter Admin Dialogs

Adding or editing a saved filter via the Kentik portal involves specifying information in the fields of the saved filter admin dialogs, which are covered in the following topics.

Notes:
- Saved filter admin dialogs are visible only to users whose level is Administrator.
- Saved filters can also be added and edited with the Saved Filter API.

 

 
 top  |  section

About Saved Filter Dialogs

The Kentik portal uses saved filter admin dialogs to collect and display saved filter information. The required information is entered into or displayed in the fields of the following dialogs:

  • Add Saved Filter when creating a new saved filter.
  • Edit Saved Filter when editing an existing company filter.
  • Preset Filter Details for viewing (but not editing) details of a preset filter.

 

 
 top  |  section

Saved Filter Dialogs UI

The Add Saved Filter and Edit Saved Filter dialogs share the same layout and the following common UI elements:

  • Close button: Click the X in the upper right corner to close the dialog. All elements will be restored to their values at the time the dialog was opened.
  • Description: A user-specified description string including (ideally) what the filter does and how it is used.
  • Ad-Hoc Filter Groups: A list of the filter groups that make up the saved filter, as well as the interface for configuring a filter group (see Filter Groups Interface).
  • Remove button (Edit Saved Filter dialog only): Remove the saved filter from your organization’s collection of Kentik-registered saved filters. This button is only present if the saved filter being edited was manually added.
  • Cancel button: Cancel the add saved filter or edit saved filter operation and exit the dialog. All elements will be restored to their values at the time the dialog was opened.
  • Add Filter button (Add Saved Filter dialog only): Save settings for the new saved filter and exit the dialog.
  • Save button (Edit Saved Filter dialog only): Save changes to saved filter settings and exit the dialog.

Note: The UI elements of the Preset Filter Details dialog are covered in Preset Filter Details Dialog.

 

 
 top  |  section

Filter Groups Interface

The interface of the Ad-hoc Filter Groups section enables configuration of the filter groups that can be saved in a company filter. The interface includes the controls described in the topics below.

 

Filter Groups Controls

The following UI elements are high-level controls for the set of filter groups that make up a saved filter:

  • Match selector: Show only when there are multiple filter groups, the drop-down match selector determines the conjunctive operator used to join all groups in the filter set:
    - All of the following groups (default) is used to AND the groups.
    - Any of the following groups is used to OR the groups.
  • Remove All Groups: Removes all filter groups.
  • Add Group button: Adds a new filter group to the set.

 

Group Container Controls

A single container for one or more individual filters, which includes the following controls:

  • Include/Exclude: A drop-down selector that determines whether results that match the group are included or excluded from the results of queries to which the filter set is applied.
  • All/Any: A drop-down selector that, if there are multiple filters in a filter group, determines the conjunctive operator used to join those filters:
    - All (default) is used to AND the filters.
    - Any is used to OR the filters.
  • Remove Group: Removes the entire filter group.
  • Add Condition: Adds a filter to the group.

 

Filter Controls

An individual filter in a group, which includes the following controls:

  • Dimension selector: Opens a dialog enabling you to choose the dimension (column from Main Table Schema) on which to filter (see Dimension Selector Dialog).
  • Operator: The operator to apply in the filter: =, <>, <, >, contains/does not contain (case insensitive), matches regex/does not match regex.
  • Value: The value to match.
    Note: Leave the value undefined to include or exclude all records for which no value has been assigned to the filter dimension.
  • Remove (X): Removes the filter from the group.

 

Dimension Selector Dialog

The dimension selector presents a list from which you can choose a dimension on which to filter. The dialog includes the following elements:

  • Filter field: Filters the available dimensions to show only those whose name contains the entered text.
  • Dimension lists: Lists of the available dimensions in each category (source, destination, etc.; see Dimension Categories).

 

 
 top  |  section

Preset Filter Details Dialog

The Preset Filter Details dialog opens when you click on a row in the Saved Filter List that represents a preset filter (see About Preset Filters). The information in this dialog is read-only (not editable). The dialog contains the following UI elements:

  • Close button: Click the X in the upper right corner to close the dialog.
  • Filter Name: The user-specified name of the filter.
  • Show/Hide Description button: A button that toggles the description between shown and hidden.
  • Description: A user-specified description string including (ideally) what the filter does and how it is used.
  • Filter Groups: One or more filter group tiles, each of which contains:
    - Any/All selector: Indicates whether the filters in the filter group are matched on an Any or All basis.
    - Filters: A list of the individual filters in the filter group, including the dimension, operator, and value.
  • Match selector: Indicates whether the filter groups in the saved filter are matched on an Any or All basis.

Note: For more details on the information in the Preset Filter Details dialog, see Filter Groups Interface.

 

 
 top

Add or Edit Filter

Saved filters are added and edited via the Saved Filters page of the Kentik Detect portal (choose Admin from the Kentik navbar, then Saved Filters from the sidebar at left). Adding and editing saved filters is covered in the following sections:

Note: The Saved Filters page is visible only to users whose level is Administrator.

 

 
 top  |  section

Adding a Saved Filter

To add a new saved filter:

  1. Open the Saved Filters page (choose Admin from the Kentik navbar, then Saved Filters from the sidebar at left).
  2. Click the Add Filter button to open the Add Saved Filter dialog.
  3. Specify the values of the general fields in the dialog (see Saved Filter Dialogs UI).
  4. Under Ad-Hoc Filter Groups, configure one or more filters (see Filter Groups Interface).
  5. Save the new saved filter by clicking the Add Filter button (lower right).

 

 
 top  |  section

Editing a Saved Filter

Only saved filters whose share level is “Company” can be edited. To edit the settings for an existing company filter:

  1. Open the Saved Filters page (choose Admin from the Kentik navbar, then Saved Filters from the sidebar at left).
  2. In the Saved Filter List, click in the row of the company filter that you’d like to edit. The Edit Saved Filter dialog will open.
  3. Edit the saved filter settings:
    - Change any general fields that you’d like to modify (see Saved Filter Dialogs UI).
    - Add, remove, or modify any filter groups or individual filters that you’d like to change (see Filter Groups Interface).
  4. To save changes, click the Save button (lower right).

To remove the saved filter from your organization’s collection of saved filters, click Remove (lower left).

 

In this article: