Introduction

Filters are used to generate and send custom reports based on a single dashboard. For example, you can create a generic Kibana/Grafana dashboard to display the Web traffic for all your customers. You can then apply a dynamic filter CustomerID: “1001” to the Kibana/Grafana dashboard to view the web traffic for CustomerID 1001 and send an email only to that customer.

You can reuse the filter on other Kibana/Grafana Dashboards. For example, you can apply the same filter to the Sales Dashboard to view the sales information for a specific customer.

Note: Setting up filters is optional.

Note: For Skedler Reports v3.12 below refer How to create filters

Pre-requisites

• A successful configuration of Skedler settings. Refer How to configure Datasource and Notification channel details

Step-by-Step Instruction

• Set up Filter List
• Set up query filters

Set up Filter Lists

1. Click on Burst Filters in the main menu, then click the Create New Filters button to create a filter list.

2. Enter the name of the filter list in the Filter Name field.

3. Filter list can be added using the following ways - uploading an excel file or creating an empty file.

• To upload an excel file, click the Upload Filter From the Excel button. Please note that only the .xlsx file format is supported. 

  • Select the Excel file with filters, recipients, folder, and customparam. A sample Excel file format is shown below. The recipients can be an individual email address, email mailing list, or bank cell.  The filter consists of the Lucene/Kibana query filter. The folder is the name of the sub-folder in which the report needs to be generated. You can assign a custom parameter name and value for the filter query (before adding the customparam in the excel, we need to create the custom parameters in the advanced settings. Please refer the Step 4 below)
  • Click the Create button to create the filter list with query filters.

4. Click the Add Parameter button to add the custom parameters. The Parameter Name is the list of the parameter name created in the Custom Parameter section in the Advanced settings page. Select the Parameter Name from the drop-down and assign a specific value.

5. Click the save icon to save to the entire row of Report Filter, Report Recipients, Folder Name, and Custom Parameter.

Set up query filters

1. Click the edit icon in the Filter List to set up or edit the Report filters.

Note: You can edit the report filters by uploading the excel file or through UI.

2. Click the UPLOAD REPORT FILTERS FROM EXCEL to add or overwrite the report filters. 

1. The Add option enables you to add the uploaded report filters to the existing report filters.

   Select the option Add and then click the CREATE button to create the Report filter listQuery filter has been added to the existing query filter list

2. The Overwrite option replaces the existing filters with uploaded report filters
   Select the option Overwrite and then click the CREATE button to create the Report filter listQuery filter has overwritten to the query filter list

3. To add the report filters through UI, click the ADD REPORT FILTER button.

4. Enter the query filter in the Report Filter field, optionally you can fill the Report Recipients field, Folder Name, and Custom Parameter. Click Add/Edit Parameter to add custom parameters to the query filter.

1. The Custom Parameter page is displayed. Click the Add Parameter button to add the customer

3. Click the Delete icon to delete the custom parameter.

5. Click the save icon to save to the entire row of Report Filter, Report Recipients, Folder Name, and Custom Parameter.

6. To edit the report filter, click the edit icon.

7. To delete the report filter, click the delete icon.

Next Steps

• Use filters with scheduled reports