Outline

The =parameter(); Scripting Engine function is a function that takes static or variable input and retrieves a selected parameter value or constructs a total parameter token based on input properties

Aliases

=parameter();
=param();

Properties

The parameter function has complex input:

Examples

=param("id":"233a028b-620a-4927-94f1-2aa7c36d862e");
=param("id":"233a028b-620a-4927-94f1-2aa7c36d862e", "output": "total");
=param("id":"233a028b-620a-4927-94f1-2aa7c36d862e", "prefix": "or", "colref":"dateCol", "dateFormat": "I", "output": "total");

[ALL]
[empty-string] (blank)
[empty-string] (blank)

year
and column between ('2011-01-01 00:00:00' and '2011-12-31 23:59:59')
or dateCol between ('2011-01-01 00:00:00' and '2011-12-31 23:59:59')

=param("id":"75ed8d1b-00bb-4859-9632-2ce314bee362");
=param("id":"75ed8d1b-00bb-4859-9632-2ce314bee362", "colref":"newColumn", "operator": ">=", "output": "total");
=param("id":"75ed8d1b-00bb-4859-9632-2ce314bee362", "output": "proc");

[ALL]
[empty-string] (blank)
[ALL]

12
and newColumn >= 12
12

12,16
and newColumn in (12,16)
'12|16'

alloutput property

"alloutput":"[allOutputStringForCompIdx0]|[allOutputStringForCompIdx1]|[allOutputStringForNoNodesSelectedAtAll]"

ATTN2:
Alloutput does not validate/use the other properties such as prefix, colref etc.
In scenarios where alloutput is evaluated, the string provided as alloutput will be returned as a raw/static string.

Output property

There are currently four different output types available:

"output": "val"
"output": "total"
"output": "proc"
"output": "startperiod"
"output": "endperiod"

prefix property

ATTN: This property is used in conjunction with output type set to total only!

The setting is a simple string that will be placed first in the condition line:

and columnA = 5

Default prefix is and, but you can set it to any string that would make your query syntax valid.

Often used prefixes are: or, where (attn: remember that this line is not rendered if all-option is selected!)

"prefix": "or"

colref property

ATTN: This property is used in conjunction with output type set to total only!

The setting controls the name of the column which the parameter should reference

"colref": "columnA"  =>  and columnA = 5

If the parameter is a hierarchyal composite parameter and the composite index is default (-1), this colref property needs to include column references to all refrenced columns (separated by pipe):

"colref": "colA|colB"

operator property

ATTN: This property is used in conjunction with output type set to total only!

This setting controls the operator of the expression.

"operator": "="  =>  and columnA = 5

ATTN: Always use single value operators. The Scripting Engine parser will automatically reformat the expression to multivalue statements when needed:

= [values] becomes in ([values])
!= [values] becomes not in([values])

Use = or != even if you expect multiple values

dateFormat property

"dateFormat": "I"
"dateFormat": "U"

customDateFormat property

"dateFormat": "CUSTOM", "customDateFormat": "yyyy"

period property

If the parameter is a period parameter, this property controls if the standard period or the trend period should be returned.
Standard and Trend are valid values.
See timesheet documentation for further details.

"period": "standard"
"period": "trend"

compIdx property

If current parameter has a composite key this property lets you return only the desired index of the key of the selected option.
The selected value is split by the composite key seperator provided in the parameter definition and the zero based index of the resulting array is returned. eg: compIdx 0 is the first option.

New in 4.2.1:
If the parameter has a composite key and the compIdx is not provided or set to -1 all composite dimensions will be parsed in one go using a autogenerated output template.

Given selected value in parameter = 2_5:

"compIdx": 0  =>  2
"compIdx": 1  =>  5

quotes property

"quotes": "'"

templ property

New in 4.2.1:
This property is used to supply a template on how the parameter values should be used in the filter statement. The property will only be used on composite parameters with output=total and compIdx=-1 (default).

When output=total, compIdx=-1 and this is a composite parameter, the colref property should contain all columns that you need to reference seperated by a pipe (|):

"colref": "col0nm|col1nm"

Given the above colref and there is no template provided through the templ property there will be autocreated a template like this:

({COL0}{COL1:OR:COL0})

Breaking it down:
First the template is wrapped in parantesis since it is a OR-statement inside which forces the expression inside the parantesis to be parsed in whole before evaluating the output with other parameters.

Next there is a {COL0} string which is the placeholder for the first column (with compIdx=0)

Second there is a {COL1:OR:COL0} string which is the placeholder for the second column (with compIdx=1).
This string has also the :OR:COL0 section which means that the column-value section for COL1 should be prefixed with a OR-operator IF COL0 is present (not set to [ALL])

Given the colref-property and autogenerated template above the parsing will be as the following

:If this auto generated template is not appropriate for your usage, you can provide your own template through this templ property.

An example could be that you need to use AND between the column references:

"templ": "({COL0}{COL1:AND:COL0})"

ATTN: Remember that you can also provide composite alloutputs for all composites and for the total