Skip to main content
Conga Support

Filter Settings

This page applies to: Analytics Add-on module

In addition to the general settings, which apply to all the filters added to your report, you can adjust the settings for the individual filters in your report. Filter settings vary based on the type of field used as the filter: Dimension, Metric, or Date.

Based on the fields you add as filters to your report, the formatting categories and fields may differ from those shown below.

Dimensions

Dimensions are text-based report fields and there are several formatting options for dimension filters.

1

Filter Formatting icon

From the Data view, click on the image301.png icon to display the Filter Formatting window.

2

Filters list

Click on a dimension filter (e.g., Payment Created By) to display the formatting options for the filter. The categories and fields that can be used to format the filter display in the canvas, and the Display category is expanded.

3

Description field

Enter a short descriptor for the filter. If you do not enter a description, the filter will retain the name of the field.

4

Display Filter in Legend option

  • When enabled, the filter is displayed in the Filters Value legend.
  • When disabled, the filter does not display in the legend.

5

Filter Requirement options

If you want to change the default (i.e., Allow Omit), which allows the user to leave the filter value field blank, click on Mandatory to force the user to provide a value for the filter in order to run the report.

6

Remember User Selection option

  • When enabled, the program remembers the filter values provided by users for future use. 
  • When disabled, the program does not remember filter values provided by users.

7

Entry Style category

Click the expand icon image319.png to display the fields that control the formatting for a User Prompt filter.

8

Value Entry Method radio buttons

Select an option for the way in which the user should provide values for the filter:

  • Manual User Entry - user has to enter information into the field. 
  • Value List Selection - you can cache values or provide a list of pre-defined items for the user to select from. See Dimension Value List.

9

Allow Prompt option

This option is only available for the Manual User Entry option. When enabled, it allows users to prompt the database for a list of values to select from when viewing the report.

10

CVS Entry

This option is only available for the Manual User Entry option. When enabled, it allows users to enter values for the filter using a CSV (Comma separated Value) file, which is a simple file format used to store Analytics report data

11

Default Value field

Click on the image323.png icon to display a Search prompt with a list of default values.

12

Value check boxes

Select the check boxes for all the values you want to be available to the report reader when the report is initially loaded.

13

Submit button

Click to save your selections and close the prompt. The Default Value field is populated with you selection(s).

14

Close & Apply icon

Click on the image186.png icon to close the window and apply the formatting to the filter dimension settings.

Dimension Value List

If you selected Value List Selection as the option for the way in which the user should provide values for the filter, the fields and selections differ from those when Manual User Entry is selected.

1

Value Entry Method radio buttons

Select Value List Selection to cache values or provide a list of pre-defined items for the user to select from.

2

Value List Setup radio buttons

If you want to change the default value of Cached Values, which creates a list of values by caching the current contents of the field in the database, make another selection:

  • Cached Values on Demand - creates a list of values by loading the contents of the field each time the report is loaded
  • Custom Query - creates a list of values by caching the current contents of the field in the database using a custom SQL query. 
  • Custom Query Cached on Demand - creates a list of values by caching the current contents of the field in the database using a custom SQL query.

3

List Display Type

If you want to change the default from List, make another selection to identify how the user will select values for this filter. The options are Checkbox and Popup.

4

Sort options

If you want to change the default sort order from Ascending, click on Descending.

5

Default Value field

Select the value(s) to be selected when the report is first loaded.

6

Close & Apply icon

Click on the image186.png icon to close the window and apply the formatting to the filter dimension settings.

Metrics

Metrics are numeric report fields and there are several formatting options for metric filters.

1

Filter Formatting icon

From the Data view, click on the image301.png icon to display the Filter Formatting window.

2

Filters list

Click on a metric filter (e.g., Payment Paid Amount) to display the formatting options for the filter. The categories and fields that can be used to format the filter display in the canvas, and the Display category is expanded.

3

Description field

Enter a short descriptor for the filter. If you do not enter a description, the filter will retain the name of the field.

4

Display Filter in Legend option

  • When enabled, the filter is displayed in the Filters Value legend. 
  • When disabled, the filter does not display in the legend.

5

Filter Requirement options

If you want to change the default (i.e., Allow Omit), which allows the user to leave the filter value field blank, click on Mandatory to force the user to provide a value for the filter in order to run the report.

6

Remember User Selection option

  • When enabled, the program remembers the filter values provided by users for future use. 
  • When disabled, the program does not remember filter values provided by users.

7

Entry Style category

Click the expand icon image319.png to display the fields that control the formatting for a User Prompt filter.

Metric Entry Style

There are three entry styles that are user to accept user input for a filter: Manual Entry, Slider, and Range.

Manual User Entry

1

Value Entry Method radio buttons

Use the default selection, Manual User Entry, if you want to require the user to manually enter a numeric value for the filter.

2

Default Value fields

Enter a minimum and maximum value to define the range of values that can be selected when the report is first loaded.

  These fields are optional.

3

Close & Apply icon

Click on the image186.png icon to close the window and apply the formatting to the filter metric settings.

Slider

1

Value Entry Method radio buttons

Select Slider if you want the user to select values using a numeric slider.

2

Value List Setup radio buttons

If you want to change the default (i.e., Manual), which allows the user to manually enter values for this filter, select Custom Query, which creates a list of values by caching the current contents of the field in the database using a custom SQL query.

3

Min field

If you want to change the default minimum value that the user can select for this filter, replace the "1" with a different number.

4

Max field

If you want to change the default maximum value that the user can select for this filter, replace the "100" with a different number.

5

Default Value field(s)

Enter a minimum and maximum value to define the range of values that can be selected when the report is first loaded.

 These fields are optional.

6

Close & Apply icon

Click on the image186.png icon to close the window and apply the formatting to the filter metric settings.

Range

1

Value Entry Method radio buttons

Select Range if you want the user to provide a low and high value.

2

Value List Setup radio buttons

If you want to change the default (i.e., Manual), which allows the user to manually enter values for this filter, select Custom Query, which creates a list of values by caching the current contents of the field in the database using a custom SQL query.

3

Min field

If you want to change the default minimum value that the user can select for this filter, replace the "1" with a different number.

4

Interval field

If you want to change the default increment by which the value is increased between the minimum and maximum, replace the "10" with a different number.

5

Max field

If you want to change the default maximum value that the user can select for this filter, replace the "100" with a different number.

6

Default Value list

If desired, make a selection in the list to provide a range that can be selected when the report is first loaded. Entries in the list reflect the range between the minimum and maximum values, displayed in increments as defined in the Interval field.

 This field is optional.

7

Close & Apply icon

Click on the image186.png icon to close the window and apply the formatting to the filter metric settings.

Dates

Dates fall under the umbrella of metrics in the identification of report fields, but they have distinct formatting options.

1

Filter Formatting icon

From the Data view, click on the image301.png icon to display the Filter Formatting window.

2

Filters list

Click on a date filter (e.g., Payment Created On) to display the formatting options for the filter. The categories and fields that can be used to format the filter display in the canvas, and the Display category is expanded.

3

Description field

Enter a short descriptor for the filter. If you do not enter a description, the filter will retain the name of the field.

4

Display Filter in Legend option

  • When enabled, the filter is displayed in the Filters Value legend. 
  • When disabled, the filter does not display in the legend.

5

Filter Requirement options

If you want to change the default (i.e., Allow Omit), which allows the user to leave the filter value field blank, click on Mandatory to force the user to provide a value for the filter in order to run the report.

6

Filter Hierarchy option

This field is only present if a hierarchical relationship can be established between the date filter and another filter. Click on the Specify Parent Filter to display a Set Parent prompt.

7

Parent Filter list

Make a selection in the list if you want to link the date filter to another filter.

8

Dependent Values option

  • When enabled, only the values related to the selected parent values will be displayed. 
  • When disabled, all values will be displayed.

9

Dependent Display option

  • When enabled, the filter will only be displayed once the parent filter values have been selected. 
  • When disabled, the filter will always be displayed.

10

Submit button

Click to create the filter hierarchy between the date filter and another filter in the report.

11

Remember User Selection option

  • When enabled, the program remembers the filter values provided by users for future use. 
  • When disabled, the program does not remember filter values provided by users.

12

Entry Style category

Click the expand icon image330.png to display the fields that control the formatting for a User Prompt filter.

13

Value Entry Method

The entry method is set to Manual User Entry and is not editable.

14

Default Value options

View the two Dynamic Date fields, which require the user to either (1) enter a date manually or use the Calendar Picker to locate the date when the option is disabled, or (2) select a timeframe, and provide a plus (+) or minus (-) value for the variance in the timeframe when the option is enabled.

  The two dynamic date fields are used to format a start date and an end date. Therefore, it is recommended that you select the same option (enabled or disabled) for both date fields.

15

Dynamic Date fields - disabled

When the field is disabled, you must enter a date into the blank field, or click on the image119.png icon to display a pop-up calendar and use it to select the date.

16

Dynamic Date fields - enabled

When the field is enabled, you can set the timeframe for the date filter by making a selection in the list, which ranges from seconds to years. You can also set a variance for the timeframe using the current date as the standard, selecting plus (+) or minus (-) in the list, and entering a number in the field.

17

Close & Apply icon

Click on the image332.png icon to close the window and apply the formatting to the filter date settings.

  • Was this article helpful?