Like what you see? Have a play with our trial version.

Versions Compared

Old Version 1

changes.mady.by.user Yellowfin

Saved on

compared with

New Version Current

changes.mady.by.user Wendy R

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Table of Contents
classcontents

Overview

Styleclass
ClasstopLink

top

The Filter format tab Formatting button contains a number of sections that you can use to format your filters.

Image Removed

Each of these sections is described below.

Image Removed

 

options to customize your filters. This gives you full control over restrictive each filter is, whether they're dependent on other filters, and how they should be displayed for user interaction.

Image Added

When you click on the Filter Formatting button, the general settings will be displayed. These can be updated at any time.

Image Added


General Filter Formatting

...

Settings



Styleclass
ClasstopLink

...

20709795

The main general formatting options for report filters are displayed below.

Image Removed

 

split three sections — Format, Actions and Filter Refresh. Note that Filter Refresh is only displayed when at least one filter in the list on the left is set to be a cached filter. 

Image Added


Expand
titleFormat


Option

Description

Filter Display

Select the location for User Prompt filters to be displayed where visible filters should appear on the Report page — Top, Left, or Left Side Nav.

Apply Link Location

Select where the location for the apply Apply button or Apply link to be displayedshould appear. This is positioned within the Filter Display (defined described above), and clicking on it triggers the results of the filter values selected by the user.

Apply Style

Use a button to apply selected filter valuesChoose whether the Apply trigger is shown as a button or as a link.

Filter Width

Select the length for User Prompt filter values display, allowing you to accommodate longer values.

Display Filter Values

Allows you to display Select whether you'd like users to see a legend of filter values applied to the report.



Expand
titleActionActions


Option

Description

Autorun Report on Load

Apply default and remembered filter values and Choose whether or not to run the report on first load. You might use this option for daily reports so that they display the most up-to-date data upon loading.

Remember Filter ValuesRemember

filter values previously applied to this report and load on next viewingChoose whether or not to remember previously applied filter values for this report for when it is next loaded. For example, a daily report might include a dynamic date of 'yesterday' in its filters. However, if the daily report contains a filter with a date to be manually selected, you might opt out of using this feature for that report.

Drill Filters

Choose whether the filter panel and filter breadcrumbs of the child report will appear after a drill through takes place. This only needs to be set on the parent report. There are three options:

  • Open: The filter panel is maximized, displaying the filter list, and the applied filter breadcrumbs appear at the top of the child report.
  • Closed: The filter panel is minimized, with the option to open the panel to display the filter list. Applied filter breadcrumbs still appear at the top of the child report.
  • Hidden: The filter panel is minimized, with the option to open the panel, but the filter list remains hidden. Applied filter breadcrumbs are not displayed.

Regardless of which option you choose, a breadcrumb list of applied filters is always displayed at the top of a report, which cannot be manipulated.

Minimize Filter Section

Choose whether to show or minimize the display of filters upon the

Minimise display of filters applied to the report as part of the Drill Through process.

Minimise Filter Section

Minimise the filter display on first load of the report.

Filter Date Reference

Apply pre-defined Choose how the report should apply filter date periods — either relative to the current date, or relative to the date when the view was last updated.



Expand
titleFilter Refresh


This option is only available if one or more filters have been set to use Cached Values.

Option

Description

Refresh

There are two available refresh options available for cached filters:

Manual: allow users to

Choose whether users can manually refresh cached filter values

. This should be used if values don't change regularly.
  • Scheduled: schedule automatic cached filter values refresh. This should be used if values change often.
    • If the refresh setting is defined as Scheduled then the following scheduling options will become available. This

    , or set them to automatically refresh on a schedule.

    Refresh NowWhen the Refresh toggle is set to Manual, the Refresh Now link will be displayed so you can manually refresh cached filter values at any time from this dialog box.
    ScheduleWhen the Refresh toggle is set to Scheduled, additional scheduling options will appear for full control over how often scheduling should occur and when it should start. 

    The schedule will apply to all cached filters on this report.

    Image Removed

     


    Note

    When refreshing cached filters in a multi-tenancy set up, be aware of the following:

    • If this is initiated from the default organization or through a scheduled task,  the filters in all the organizations will be refreshed. 
    • If this is initiated from a specific client organization,  only the filters of that organization will be refreshed.


    Filter Settings by Type

    The Filter Formatting panel for each type of filter is split into two sections — Display and Entry style. The Display section provides the bounding box settings, such as a label description, and whether the filter is mandatory. The Entry style section includes options to change the appearance of filters and what values they display. This latter section varies the most between filter types, so we've included screen shots of that section for each filter type, below.

    ...

    Styleclass
    ClasstopLink

    ...

    top

    Dates

    Image Removed

     

    20709795

    Date filter settings

    The screen below shows the Entry style options for date filters. See the tables below for descriptions of both the Display section and the Entry style section.

    Image Added


    Expand
    titleDisplay


    Expand
    titleDisplay

    The display options for dates are the same as those for dimensions and metrics, with the exception of Period Traversal.

    Option

    Description

    Description

    Define the title of the filter.

    Display Filter in Legend

    Show or hide this filter from the filter legend list.

    Filter Requirement

    There are two available options:

    • Allow Omit: allow  allows the user to leave this filter blank.
    • Mandatory: force  forces the user to provide a value for this filter in order to run the report.

    Filter Hierarchy

    Create a hierarchy of filters (eg, filter by year, then by quarter, then by month). To use this option, the parent filter must be set to a selection field (this can be done in the Entry Style section of this dialog box, where Value Entry Method should be set to Value List Selection.

    Click on the Specify Parent Filter link to display the Set Parent dialog box, where you can select the parent filter. You can also set two display options:

    • Dependent Values displays only the values related to one parent (eg, only display Jan, Feb, Mar when the parent filter for quarter is set to Q1). 
    • Dependent Display hides the current filter from the user until the parent filter value has been selected (eg, display the month filter only when a quarter has been selected)

    Display Dependent On

    Select a filter for this filter to be dependent on. This will mean that the selected filter will have to have a value selected before the dependent filter displays.
    Note: this option will only be displayed if you have another filter that had cached values.

    See Cached Dependent Filters for more information
    • .

    Remember User Selection

    Remember values applied to this filter for future use.

    Period Traversal

    Allows you to provide the user with a method of stepping through periods before and after that selected in the filter. For example, the user filters the report on Year = 2009. If the interval is 1 Year and the interval bounds are 5 Back and 5 Forward then the user will initially see data for 2009. Each time they either move back or forward it will be 1 year, and they will be restricted to 5 years in either direction.



    Expand
    titleEntry Style


    Option

    Description

    Value Entry Method

    Define the way the user should provide values for the filter. There are two available options:

    • Manual User Entry: allows  allows the user to either type in dates into the entry fields, or use the calendar picker.
    • Value List Selection: allows  allows you to cache values or provide a list of pre-defined date ranges for the user to select from.

    Allow Prompt

    This option is only available for the Manual User Entry option and allows users to prompt the database for a list of values to select from at the time of viewing the report.

    Display All Filter Values

    This option is displayed if the Allow Prompt option above is enabled. 

    By default (when this option is not active), your user prompt filters will only display the values available based on any selections already made. Say, For example, you had two user prompt filers — one for Date Range and one for Camp Country. If you select a date range of one month in one year,  the filter value list display for Camp Country would be limited to only those countries that hosted a camp during that month of that year. Enabling this option would ignore the date range and display all values for Camp Country. 

    • Toggled off (default): Display a restricted list of value prompts for this filter that automatically updates according to any other filter value selections already made.
    • Toggled on: Display the full, unrestricted list of value prompts for this filter, regardless of other filter value selections already made.

    Value List Setup

    Define which method of providing a list of values you will use. There are three options:

    • Pre-defined Periods: use Use a list of pre-defined date ranges for the user to select from. See Date Filter Periods for more information.
    • Cached Values: create Create a list of values by caching the current contents of the field in the database (and remember to check the Filter Refresh section of the General Settings to set the cache refreshing options).
    • Cached values On Demand: Create a list of values by loading the contents of the field each time the report is loaded.
    • Custom Query: create Create a list of values by caching the current contents of the field in the database using a custom SQL query (and remember to check the Filter Refresh section of the General Settings to set the cache refreshing options).
    • Custom Query Cached On Demand: Create a list of values by caching the current contents of the field using the custom SQL query each time the report is loaded.
    List Display Type

    Choose if cached values should be displayed in a dropdown or a popup.

    Pre-filter by Aggregated Metrics

    This setting filters the cached values with the result of any filtered metric fields in the report, provided the metric field filter is not user prompted.

    For example, you can use this setting to further filter the unique values of this field to be cached, by adding an age (metric) field with a defined filter of greater than 50. The values cached for this dimension field will only include unique content where the age field is > 50.

    Sort

    Define the sort order for the list of values as ascending or descending.

    Use Min/Max ValuesChoose whether to hide or display the minimum value and the maximum value for this filter.

    Default Value

    (Optional). Define the default value(s) to be used for the filter when the report is initially loaded. (Optional).

    If the Value List Setup option is set to Custom Query or Custom Query Cached on Demand, the following options will become available.

    Image Removed

     

    Use this to write a custom SQL query.

    Image Added


    Dimension filter settings

    ...

    When using a dimension as a filter you will have , dimension-specific options are available in the Display and Entry Style filter menusstyle sections. These options will allow let you to define various settings, such as filter caching, custom descriptions and list length (if using an In List operator). These Some of these options may therefore differ from the ones available when using a metric or a date.

    Image Removed

     See the tables below for descriptions of both the Display section and the Entry style section.

    Image Added 


    Expand
    titleDisplay


    Option

    Description

    Description

    Define the title of the filter.

    Display Filter in Legend

    Show or hide this filter from the filter legend list.

    Filter Requirement

    There are two available options:

    • Allow Omit: allow  allows the user to leave this filter blank.
    • Mandatory: force  forces the user to provide a value for this filter in order to run the report.

    Filter Hierarchy

    Create a hierarchy of filters (eg, filter by region, then by country). To use this option, the parent filter must be set to a selection field (this can be done in the Entry Style section of this dialog box, where Value Entry Method should be set to Value List Selection.

    Click on the Specify Parent Filter link to display the Set Parent dialog box, where you can select the parent filter. You can also set two display options:

    • Dependent Values displays only the values related to one parent (eg, only display European countries when the parent filter for region is set to Europe). 
    • Dependent Display hides the current filter from the user until the parent filter value has been selected (eg, display the country filter only when a region has been selected)

    Display Dependent On

    Select a filter for this filter to be dependent on. This will mean that the selected filter will have to have a value selected before the dependent filter displays.
    Note: this option will only be displayed if you have another filter that had cached values.

    See Cached Dependent Filters for more information
    • .

    Remember User Selection

    Remember values applied to this filter for future use.

    Display Style

    When a filter has a reference code applied to it additional display options become available:

    Text: display the descriptive text assigned to each reference code value

    .

  • Image & Text: display the text and image assigned to each reference code value.
  • Colour & Text: display the text and colour assigned to each reference code value.

    • List Size

    Define the number of values displayed in the list before scrolling is required.


    ...

    Expand
    titleEntry Style


    Option

    Description

    Value Entry Method

    Define the way the user should provide values for the filter. There are two available options:

    • Manual User Entry: allows  allows the user to either type in dates into values the entry fields, or use the calendar picker.
    • Value List Selection: allows you to cache values or provide  provides a list of pre-defined date ranges dimension values for the user to select from.

    Allow Prompt

    This option is only available for the Manual User Entry option and allows users to prompt the database for a list of values to select from at the time of viewing the report.
    Note: it is recommended that we recommend that you disable the user prompt option be disabled if your data set has too many variables that , as it may take some time for the values to be returned.CSV Entry

    Display All Filter Values

    This option is displayed if the Allow Prompt option above is enabled. 

    By default (when this option is not active), your user prompt filters will only display the values available based on any selections already made. Say, For example, you had two user prompt filers — one for Date Range and one for Camp Country. If you select a date range of one month in one year,  the filter value list display for Camp Country would be limited to only those countries that hosted a camp during that month of that year. Enabling this option would ignore the date range and display all values for Camp Country. 

    • Toggled off (default): Display a restricted list of value prompts for this filter that automatically updates according to any other filter value selections already made.
    • Toggled on: Display the full, unrestricted list of value prompts for this filter, regardless of other filter value selections already made.

    CSV Entry

    This option is only displayed when Manual User Entry

    option and

    is set as the entry method. It allows users to

    enter

    manually provide a list of comma-separated values for the filter

    with the use of a

    .

    csv file.

    Value List Setup

    Define which method of providing a list of values you will use. There are three options:

    • Reference Codes: create  Create a list of values for the user to select from based on the Org Ref Code applied to the filter. See Reference Code Use for more information.
    • Cached Values: create  Create a list of values by caching the current contents of the field in the database (and remember to check the Filter Refresh section of the General Settings to set the cache refreshing options).
    • Cached Values On Demand: Create a list of values by loading the contents of the field each time the report is loaded.
    • Custom Query: create  Create a list of values by caching the current contents of the field in the database using a custom SQL query (and remember to check the Filter Refresh section of the General Settings to set the cache refreshing options).
    • Custom Query Cached On Demand: Create a list of values by caching the current contents of the field using the custom SQL query each time the report is loaded.
    List Display Type

    Choose if cached values should be displayed in a list, checkboxes, or a popup.

    Pre-filter by Aggregated Metrics

    This setting filters the cached values with the result of any filtered metric fields in the report, provided the metric field filter is not user prompted.

    For example, you can use this setting to further filter the unique values of this field to be cached, by adding an age (metric) field with a defined filter of greater than 50. The values cached for this dimension field will only include unique content where the age field is > 50.

    Sort

    Define the sort order for the list of values as ascending or descending.

    Use Min/Max ValuesChoose whether to hide or display the minimum value and the maximum value for this filter.

    Default Value

    Define the default value(s) to be used for the filter when the report is initially loaded. (Optional).

    Dynamic Filter Value

    Enable this to automatically select the first filter value, when the default value is not available to the user.
    A user may not have the default value available to them (for example, as a result of access filter restrictions), in which case the system will select the first value to be used as the filter.
    Note: This only applies to dimension values where the filter values are selected from a list of options (i.e. ‘Value List Selection’ is the chosen entry method), such as checkboxes, or dropdowns. 

    If a default filter has multiple values, and at least one is available to the user, then dynamic filtering will not be applied.

    If the Value List Setup option is set to Custom Query or the following options will become available.

    Image Removed

     

    Image Added


    Metric filter settings

    ...

    Metric filters options only permit you to change the formatting options and set default values. There is no prompt option for metrics.

    Image Removed

     

    filter options are more limited by their nature, but there are still some configuration options. See the tables below for descriptions of both the Display section and the Entry style section.

    Image Added


    Expand
    titleDisplay


    Option

    Description

    Description

    Define the title of the filter.

    Display Filter in Legend

    Show or hide this filter from the filter legend list.

    Filter Requirement

    There are two available options:

    • Allow Omit: allow  allows the user to leave this filter blank.
    • Mandatory: force  forces the user to provide a value for this filter in order to run the report.

    Filter Hierarchy

    Create a hierarchy of filters (eg, filter by country, then by invoiced amount). To use this option, the parent filter must be set to a selection field (this can be done in the Entry Style section of this dialog box, where Value Entry Method should be set to Value List Selection.

    Click on the Specify Parent Filter link to display the Set Parent dialog box, where you can select the parent filter. You can also set two display options:

    • Dependent Values displays only the values related to one parent (in our example of filtering by country then invoiced amount, this field would not be required). 
    • Dependent Display hides the current filter from the user until the parent filter value has been selected (eg, display the invoiced amount filter only when a country has been selected)

    Display Dependent On

    Select a filter for this filter to be dependent on. This will mean that the selected filter will have to have a value selected before the dependent filter displays.
    Note: this option will only be displayed if you have another filter that had cached values.

    See Cached Dependent Filters for more information
    • .

    Remember User Selection

    Remember values applied to this filter for future use.


    ...

    Expand
    titleEntry Style


    Option

    Description

    Value Entry Method

    Define the way the user should provide values for the filter. There are two available three options:

    • Manual User Entry: allows  allows the user to either type in dates into the entry fields, or use the calendar pickerthe metric values.
    • Slider: allow  allows the user to select values using a numeric slider.
    • Range: allows the user will to provide a low and a high value.

    Value List Setup

    Define which method of providing a list of values you will use. There are two options:

    • Manual: the  The user will manually type values for this filter.
    • Custom Query: create  Create a list of values by caching the current contents of the field in the database using a custom SQL query.

    Min

    Define If Value Entry Method is set to Slider or Range, use this field to set the minimum value the user can select for this filter.

    IntervalDefine

    If Value Entry Method is set to Range, use this field to set the increments the value increases by.to display between the Min and Max fields

    Max

    If Value Entry Method is set to Slider or Range, use this field to define

    Max

    Define the maximum value the user can select for this value.

    Colour

    Select the colour for the entry style.

    Default Value

    (Optional.) Define the default value(s) to be used for the filter when the report is initially loaded. (Optional). 

    If the Value List Setup option is set to Custom Query the following options will become available.

    Image Removed

    ...

    Image Added


    horizontalrule

    Styleclass
    ClasstopLink

    ...

    top

    ...

    20709795