Booklet Parameter Syntax

User Guide › Reports › Report Types › Booklets Overview › Creating a Booklet › Creating Booklets in .docx Format › Booklet and Contract Export Tags › Parameterized Booklets › Booklet Parameter Syntax

The syntax in the booklet template resembles the syntax for passing parameters to Free-form reports.

Notes regarding syntax:

The name of the parameter is taken from a list of predefined, UPPERCASE, names - not free text (except for Freeform parameters which *are* free text).
The value of the parameter is either free text or a context value. When there is no contract context, the context values are not passed.
Value is case-sensitive.
When passing more than one value for the same parameter and the parameter is not defined as multi-select, or when passing the same parameter more than once, the last value to appear in the template is passed.
When passing no value (either missing VALUE keyword or <<VALUE=>>), the booklet passes null as the value. This removes the original filter value as if it was not in the favorite report (similar to “All”).
Passing a parameter name that does not exist has no effect.

Parameter values are merged with the original favorite filter where booklet parameters have priority over the original filter. If you pass a parameter to a filter that already exists in the report, the filter uses the parameter from the booklet.

If you define multiple select or wild cards, declare it using the SELECT_TYPE keyword. Values can be: MULTI, WILDCARD or SINGLE.
If you have a multiple selection of resources or resource groups, you can only select one type. You must declare which one you used in the parameter by using the IS_GROUP keyword. The value can be YES or NO.
When defining multiple select, you must define the entity’s full path separated with ‘/". When selecting multiple metrics, you can skip defining the full path and the contract context is used to get the relevant information.
Compound and Group Favorites have the same syntax as Normal. For compound reports, the parameter values are passed to each of the series. For group reports, a value is passed to each member of the group (free-form reports too). If there are compound reports inside the group, the parameter values are passed to each of the series in each of the members.

Booklet Parameter Syntax Example

<<BEGIN_FAVORITE=Normal favorite name>>

<<BEGIN_PARAMETER>>
<<NAME=AGGREGATION>><<VALUE=Sum>>
<<END_PARAMETER>>

<<BEGIN_PARAMETER>>
<<NAME=CONTRACT>><<CONTEXT_VALUE=SLA_NAME>>
<<END_PARAMETER>>

<<BEGIN_PARAMETER>>
<<NAME=SERVICE>><<VALUE=Service 1>>
<<END_PARAMETER>>

<<BEGIN_PARAMETER>>
<<NAME=RESOURCE>><<IS_GROUP=NO>><<VALUE=Resource 1>>
<<END_PARAMETER>>

<<BEGIN_PARAMETER>>
<<NAME=metric >>
<<SELECT_TYPE=MULTI>>
<<VALUE=Contract Party/Contract/metric 1>>
<<VALUE=Contract Party/Contract/metric 2>>
<<VALUE=Contract Party/Contract/metric 3>>
<<END_PARAMETER>>

<<NAME>>
<<CHART>>
<<DATA>>
<< END_FAVORITE>>