Page History
Admins, if you'd like to hide this setting, see our Advanced Configurations page for more details.
Anchor | ||||
---|---|---|---|---|
|
Table of Contents | ||
---|---|---|
|
Overview
The Filter Formatting button contains a number of 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.
When you click on the Filter Formatting button, the general settings will be displayed. These can be updated at any time.
General Filter Formatting Settings
The general formatting options for report filters are 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.
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
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 | ||
---|---|---|
| ||
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.
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
If the Value List Setup option is set to Custom Query or Custom Query Cached on Demand, the following options will become available. Use this to write a custom SQL query. |
Dimension filter settings
When using a dimension as a filter, dimension-specific options are available in the Display and Entry style sections. These options let you define various settings, such as filter caching, custom descriptions and list length (if using an In List operator). Some of these options therefore differ from the ones available when using a metric or a date. See the tables below for descriptions of both the Display section and the Entry style section.
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
If the Value List Setup option is set to Custom Query or the following options will become available. The following tokens can be used within SQL to filter queries under certain circumstances: When using a Cached Query, the SQL can include the following tokens: %CLIENTREFID% - This will insert the client reference Id into the SQL. This should only be used when client source substitution is used, where data for multiple clients may exist in a single database. When using a Cached Query on Demand and a source filter is enabled, the SQL can include these tokens: %CLIENTREFID% - This will insert the client reference Id into the SQL. %REFERENCE_TYPE% - This will insert the Access Filter values for the user who is running a report. For example, an Access Filter reference code named REGION, will have a token named %REGION%. Access Filter values will be inserted as text tokens and will be quoted in the generated SQL. Multiple tokens will be inserted in comma-separated form, so that they can be included in an SQL IN statement. %REFERENCE_TYPE_NUMERIC% - This will insert the Access Filter values for the user who is running a report. For example, an Access Filter reference code named USERID, will have a token named %USERID_NUMERIC%. Access Filter values will be inserted as numeric tokens. Multiple tokens will be inserted in comma-separated form, so that they can be included in an SQL IN statement. |
Metric filter settings
Metric 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.
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
If the Value List Setup option is set to Custom Query the following options will become available. |
horizontalrule |
---|
Styleclass | ||
---|---|---|
| ||