|
Samples for Complex Parameters
General Information
Complex Parameters need to be used when for example the report which is called is making use of MDX queries. These require input parameters in a different format, and this format may alter from report to report.
The Parameters define the format for the URL which is passed into BI, and they can consist of up to three parts:
- Prefix:
A hard-coded value, which prepends the parameter values. An example would be (please note the '.' at the end, which needs to be included):
[ToDate].
- Format String:
This part will define the format of the URL. An example would be:
{0,mdxDate,month}
The format usually does not contain actual value. Typically, you will use "variables", which then will be replaced with the correct value/attribute as defined in the third field.
Only if the input field is a Component Lookup, you will need to add "Variables" as follows. They are always
- numbers, with the first item being referenced by the value of 0 (zero).
- formatted with a leading '{'
- Format Attributes
Attributes will be used to replace the variables in the Format String, for example:
bms_9999999_1131
If you have more than one attribute, separate the list with a comma. The first entry will be used for the variable No. {0}, the second for No. {1}, and so on.
Format Attributes will always refer to a column on a database table.
It is therefore important to use the exact name as the table is stored on the table. For example, the relationship for a Parent Department is stored as bms_FK_9999999_118_ID.
The above example would result in the following parameter being used for the report:
[ToDate].[2015].[Q1].[Feb]
Parameters for MDX Queries - Input Type is a Date Picker
|
NOTE:
- It is important that the following will be adhered to when creating date parameters for MDX:
- Days must not have a leading zero.
- Months must be abbreviated to 3 characters - The MDX examples used will construct the date parameter in the correct format.
- Please click here for a list of valid Format Strings.
|
To create a Parameter for
|
Examples
|
Date Parameter, selecting a Quarter
|
Prefix:
[DateMeasure].
Format String:
mdxDate,quarter
Format Attribute:
N/A
Example for resulting URL:
[DateMeasure].[2015].[Q1]
|
Date Parameter, selecting a Month
|
Prefix:
[DateMeasure].
Format String:
mdxDate,month
Format Attribute:
N/A
Example for resulting URL:
[DateMeasure].[2015].[Q1].[Feb]
|
Date Parameter
|
Prefix:
[DateMeasure].
Format String:
mdxDate,[yy].[##].[MMM].[d]
Format Attribute:
N/A
Example for resulting URL:
[DateMeasure].[15].[Q1].[Feb].[4]
|
Parameters for MDX Queries - Input Type is a Component Lookup or a Lookup
To create a Parameter for
|
Examples
|
Time Period to return the "To" date.
|
Input type for this example:
Time Period Component Lookup
Prefix:
[ToDate].
Format String:
{0,mdxDate,month}
Format Attribute:
bms_9999999_1730
Example for resulting URL:
[ToDate].[2015].[Q1].[Feb]
|
A hierarchical Component
(here: Department)
|
Input type for this example:
Tree View Selection List for Department
Prefix:
[Department].
Format String:
*{0,[{1}].}[{1}]
Format Attribute:
bms_FK_9999999_118_ID,bms_9999999_1139
In generic terms, you will need to define the following format attributes:
- For {0}: the relationship back to the Parent record
(here: Parent Department)
- For {1}: the field containing the required filter value
(here: Department Name)
Example for resulting URL:
[Department].[Parent Department].[Mining]
|
A Lookup Field
|
Input type for this example:
A single lookup field for Priority.
Prefix:
[Priority].
Format String:
N/A
Format Attribute:
N/A
Example for resulting URL:
[Priority].[High]
|
A "Base State" Field (status of a record being either Open or Closed)
|
Input type for this example:
A single lookup field for Status.
Prefix:
[System - Base State].
Format String:
N/A
Format Attribute:
N/A
Example for resulting URL:
[System - Base State].[Open]
|
A "System Status" Field (status of a record being either Open or Closed)
|
Input type for this example:
A single lookup field for Status.
Prefix:
[System - Status].
Format String:
N/A
Format Attribute:
N/A
Example for resulting URL:
[System - Status].[Closed]
|
Complex Parameters for other Purposes
In addition for MDX queries, you can also Complex Parameters to further 'fine' tune the URL if required.
To create a Parameter for
|
Examples
|
A date field in a different format.
|
Input type for this example:
Date Picker
Prefix:
N/A
Format String:
date,yyyy-MM-dd
Format Attribute:
N/A
Example for resulting URL:
2015-05-06
|
|
