This documentation corresponds to a historical version of Yellowfin

Icon

Access the latest release, or view a list of available versions of the documentation.

Skip to end of metadata
Go to start of metadata

Overview

The formatting options for filters are now found on the report preview page when in draft mode, along with columns and sections.

Format Menu

The main formatting options for report filters are displayed below.

  1. The User Prompt location allows you to choose where the filter box will appear in relation to the report results, with the options; Top, Bottom, Left, and Right
  2. The Apply link can be moved so that it is displayed at the Top, Bottom or Top and Bottom of the filters box.
  3. The Apply Style allows you to change the formatting of the Apply Filters link between Button and Apply Text.
  4. Filter Width allows you to adjust the width of the text boxes and lists to accommodate longer values.
  5. The Display option allows you to choose if you wish to have a list of filters used to display with the report results, either at the Top or Bottom of the results.

Actions Menu

  1. Automatically Apply Filters: Yes, No
  2. Drill Filters: Hidden, Closed, Open (breadcrumbs)
  3. Minimise Filter Section allows you to collapse or expand the filter box.
  4. Enable Saved Filter Sets will allow users with the required role permissions to use filter sets on the report.

Refresh Menu

This menu is available when cached filters have been used on the report. It allows you to supply a schedule to refresh all filters on the report.

  1. Refresh: Select to either Manually refresh filter values when required, or supply a schedule to be run automatically. If Scheduled is selected, the following options become available:
    1. Schedule: Allows you to provide the basic scheduling settings (frequency of refresh)
    2. Advanced: Allows custom Time Zone settings to be applied to the schedule, rather than using system settings

Dimension Specific Filter Formatting

When using a dimension as a filter you will have dimension specific options available in the Display and Entry Style filter menus. These options will allow you to define various settings, such as filter caching, custom descriptions and list length (if using an In List operand). These options may differ from the ones available when using a metric or a date.

Display Menu

  1. Display Filter
  2. The Description option allows you to change the display text from the default field name to a customised label.
  3. You can choose to let the user skip the current filter by selecting 'Allow Omit', you can have the filter set to 'Omit By Default' or you can make it mandatory, removing the omit option from the filter box.
  4. You can set filters to be dependent on other filters, so they are only displayed when the main filter has a value selected.
    Note: This will only be displayed if you have another filter that had cached values.

    See Cached Dependent Filters for more information.

Entry Style Menu

  1. If User Entry is selected you will be able to define whether you want the prompt list option to be available to the user or not
    Note: It is recommended that the user prompt option be disabled if your data set has many variables that as it may take some time for the values to be returned.
  2. If Drop-Down is selected instead of User Entry then you will get the above menu.
  3. You can either choose to cache the values or you can write a custom query to select values for the filter.

    See Cached Dependent Filters for more information.

  4. The Default Value shows you how the filter will be displayed in the filter box.

Metric Specific Filter Formatting

Metric filters options only permit you to change the title/description, determine the omit option, and set default values. There is no prompt option for metrics.

Display Menu

The display options for metrics are the same as those for dimensions. Please see the previous section for details.

Entry Style Menu

  1. The Entry Style menu for a metric will provide the user with a User Entry display or Slider option. If the Slider option it picked, the following configuration options will be displayed:
  2. You will also have the option of specifying a default value.

Date Specific Filter Formatting

Date filter options allow you to: change the title/description of the filter, enable use of predefined ranges, and cache values.

Display Menu

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

  1. Display Filter
  2. The Description option allows you to change the display text from the default field name to a customised label.
  3. You can choose to let the user skip the current filter by selecting 'Allow Omit', you can have the filter set to 'Omit By Default' or you can make it mandatory, removing the omit option from the filter box.
  4. You can set filters to be dependent on other filters, so they are only displayed when the main filter has a value selected.
    Note: This will only be displayed if you have another filter that had cached values.

    See Cached Dependent Filters for more information.

  5. 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.

Entry Style Menu

  1. Selecting the User Entry option will allow you to set default values for you dates either by selecting a date using the calendar or prompt, or setting a date relative to the current system date.
  2. Selecting the Drop Down option will permit you to cache values, use a custom query or select from a set of predefined date ranges.

See Pre-Defined Date Periods for more information.