Page Comparison

{anchor:top}
{toc: class=contents}
h2. Overview
{styleclass: Class=topLink}[top|#top]{styleclass}
Report filters allow you to limit the amount of data that is returned, to the specific subset you require.

You may decide that you don't want to include all the data in a document. Applying conditions or filters to queries allows you to include only the data you need. The following illustrations show how a condition or filter works.
 
||Without Filter||With Booking Method Filter||
|This table lists each step of the booking process for *all Booking Methods*.|This table has been filtered to only show steps of the booking process where the *Booking Method* is *Email*.|
|!01beforeFilter.png!|!02afterFilter.png!|


h3. Filter Types
There are a number of filter types available when building a report.
||Filter Type||Description||
|*View-Defined Calculated Filter*|This is a calculation defined at the view level. The filter condition has been defined so that the report writer only has to add the field to the report filter list, rather than defining and formatting it for each report.|
|*View-Defined Filter Group*|This is a group of filters defined at the view level. These are designed for commonly used sets of filters, allowing the report writer to simply add the group to the report filter list, rather than defining and formatting them individually for each report.|
|*Report Defined Filter*|This is a field that has been added to the report filter list and had a value defined by the report writer.|
|*User Defined Filter*|This is a field that has been added to the report filter list and set to prompt the report user for a value when viewing the report.|
|*Parameter*|This is a type of field that has been added to the report filter list and prompts the report user for a value. This value is then used by other filters or calculations in the report. Parameters are often used for What If analysis.|
|*Source Filter*|This is a filter that has been defined at the data source connection and applied to the view. Source filters are designed to restrict results of a report based on the report user's credentials.|


h2. Pre-View Defined Calculated FiltersField
{styleclass: Class=topLink}[top|#top]{styleclass}
Pre-View defined filters canare be created to assist users with adding filters or conditions to their reports that ensure the data they require is easy to extract.
The use of pre-defined. These filters isare especially useful in instances where:
# A commonfilter setis ofregularly filters are used by report writers -, such as locationLocation, orBusiness businessUnit, unit;or orDate Range
# If thereThere are particularlyparticulary complex filtersfilter conditions or calculations that cancould be built ahead of time and are commonly used.

Pre-defined once at the view, rather than once per report

View defined filters are indicated by the !rpt_filter.png! icon used inin the Fields List of the dataReport Builder fieldData liststep. To include a pre-view defined filter onin your report, select it from your field list and drag addit tointo the Filters arealist. 
 
!01.png|thumbnail,border=1!

You will not be able to edit the contents of the filter oncethrough it is included in your report.  If you wish to do so then creating a user defined filter is requiredthe report builder as they are defined at the view level.

bq. See [View Defined Calculated Filters] for more information.


h2. Pre-View Defined Filter GroupsGroup
{styleclass: Class=topLink}[top|#top]{styleclass}
View Filterdefined filter Groupsgroups are created to provide the user with common sets of filters when building reports. These filters are formatted and defined at the View levelview to save the user from recreating commonly used filter sets when building reports.

Pre-Defined Filter Groups time rebuilding sets and their possible relationships for each use in a report.

View defined filter groups are indicated by the !view_filtergroup.png! icon used inin the Fields List of the dataReport Builder fieldData liststep. To include a filter setgroup onin your report, select it from your field list and adddrag it tointo the Filters area.

!group.png|thumbnail,border=1!list. You will not be able to edit the contents of the filter set through the report builder as they are defined at the view level.

bq. See [View Defined Filter Groups] for more information.


h2. UserReport Defined FiltersFilter
{styleclass: Class=topLink}[top|#top]{styleclass}
If you wish to create your ownReport defined filters fromare thefields data availableadded to youthe inFilter yourlist viewof thenthe youReport willBuilder haveData tostep createby athe userreport defined filterwriter.  
# The firstwriter step in adding a filter to your report is to drag either a dimension or metric item from the data fields list into the Filters Box as seen below.
# On the filter management page you will then be able to set the values for these filtersthen defines the conditions and values for the filter, not allowing the report user to provide values.


h2. User PromptDefined FiltersFilter
{styleclass: Class=topLink}[top|#top]{styleclass}
User promptdefined filters or parameter driven reports can be created by creating user defined filters.  If you do not specify particular values for the filter as discussed in detail below then the filter will be displayed on the report as a user prompt.

!02.png!
 

h2. Parametersare fields added to the Filter list of the Report Builder Data step by the report writer. The writer then defines the conditions and formatting of the filter, but leaves the values set to *User Prompt*. This means that the report user will provide values for the filters when they run the report. 

bq. See [User Prompt Filters] for more information.


h2. Parameter
{styleclass: Class=topLink}[top|#top]{styleclass}
Parameters are a special type of field, whichdefined allowsin youthe toview, useradded inputto intothe calculatedFilter fieldslist orof havethe aReport singleData userstep prompt for multiple filters requiring by the samereport input valuewriter. The A parameter differs from a standard filter in that the input values can be used for calculations which permit you to do what if analysis.

For example a standard filter for Revenue would limit the result set to a specific revenue value - e.g.  Greater than $100.  However, a parameter could be used to drive a calculation - Multiply current sales units by $100.

Parameter fields are defined at the view but can be applied to report calculations and filters.

Parameter fields are indicated by the icon used in the data field list.  This is indicated by the blue filter icon !rpt_parameter.png!.

should then be referenced by other filters or calculated fields. Parameter settings are defined at the view and cannot be modified in the report builder.

Parameters are designed to prompt the user for a value, much like [User Defined Filters|Filters#User Defined Filter] mentioned above, then pass the value to other components of the report.

bq. See [Parameters] for more information.


h2. AccessSource Filter
{styleclass: Class=topLink}[top|#top]{styleclass}
The access filter is a global filter
Source Filters are defined at the Data Source connection level and then applied to views for use on reports. These are filters designed to restrict results in a report based on the user that is viewing the report at the time.  This filter allows the same report to be distributed / used by many people but will only display data that is relevant for them.

For example an access filter may associate the user as the manager of a particular cost centre.  When that user runs the report they will only see data for the cost - they will not be able to view data for other cost centres.

!07limit1.png!viewing it. For example, A sales person from Australia would see the Business Sales Report filtered by Australia, where a sales manager for Australia & New Zealand would see the report filtered to see Australia and New Zealand sales records.

Source Filters can be disabled/enabled in the Report Builder by advanced report writers who have the appropriate role permission enabled, otherwise the filters are designed to be applied, but not seen by standard writers and users.

bq. See [Source Access Filters] for more information.

\\
\\
{horizontalrule}
{styleclass: Class=topLink}[top|#top]{styleclass}