Data Functions Overview
Data scope related functions
-
Exec(scope, expression)
- executes the specified expression in the given parent data scope. Used with aggregate expressions as a second parameter; this function allows changing of the data scope in which the expression is evaluated. The scope parameter is the name of the parent (one or more levels up the hierarchy) data scope relative to the current data scope we need to evaluate the expression against. For example the expression=Fields.LineTotal / Exec('Report1', Sum(Fields.LineTotal))
used in the detail section will return theLineTotal
amount as a percentage from the whole report. -
Exec(scopeByColumns, scopeByRows, expression)
- executes the specified expression in the context of the referenced body scope. A body scope is determined from the cross-section of a rows and columns axes data scope. Both specified scopes should be parent scopes relative to the current body scope. The function applies only to an item located in a body data scope. Used mostly with aggregate expressions as a third parameter; For example, the expression=Sum(Fields.LineTotal) / Exec('Year', 'Category', Sum(Fields.LineTotal))
used in the body section of a crosstab will return theLineTotal
value accumulated for the current scope as a percentage from theLineTotal
value accumulated for the whole current year for the current category. -
Previous(scope, expression)
- executes the specified expression in the context of the previous data member relative to the referenced scope by rows or columns. If the scope parameter is omitted, the expression gets executed in the context of the previous data member relative to the current data member. In that case, the current data scope cannot be a body scope (a body scope is determined from the cross-section of a rows and columns axes data scope). With 'scope' provided, the 'expression' should be an aggregate function. The default one isFirst
.-
Example 1: the expression
=Previous(Fields.LineTotal)
used in the detail section of a Report will return the previousLineTotal
value for the current group andNull
if the previous value doesn't exist. -
Example 2: the expression
=Previous('Year', Sum(Fields.LineTotal))
used in the body of a Crosstab will return theLineTotal
value accumulated for the whole previous year. If there is no previous year, i.e. currently we are in the context of the first group instance of 'Year', the expression will returnNull
. -
Example 3: the expression
=Previous(Fields.LineTotal)
used in the body of a Crosstab returnsNull
. The reason is that it is ambiguous as it is in a cross-section of a rows and columns axes data scope.
-
Example 1: the expression
RunningValue(scope, aggregateFunction)
- the value forRunningValue
resets to 0 for each new instance of the specified parent scope. If a group is specified, the running value is reset when the group expression changes. If a data item is specified, the running value is reset for each new instance of the data item. Restrictions forRunningValue
are determined by the aggregate function specified in the function parameter.RunningValue
cannot be used in a filter or sort expression.-
IsMergedData()
- determines if the current data context is of a merged data point. Returns a boolean. Can be used when applying conditional formatting to the merged data point of the Graph item. Example of a filter expression that determines if the data point is of merged data:= IsMergedData() | Operator.Equals | = True
. For additional information, check Merging Small Slices on a Pie Chart section.
The set of data specified in the expression must have the same data type. To convert data that has multiple numeric data types to the same data type, use conversion functions like CInt, CDbl, etc.
Report sections / table rows(columns) running count
These functions return a running count of the current data scope occurrences within the current instance of the specified data scope in the function parameter. For example, if the expression =RowNumber("Year")
is used within the scope of group "Month" that has a parent group "Year", the expression will eval to 1, 2, 3,.., 12 for each instance of the "Month" data scope inside the current particular year, and for the next year instance will be reset to 1, 2, 3,... Effectively, the counter gets reset for each subsequent instance of the specified scope. When omitted, the parent data scope is used as default.
To get a running count in a parent group's occurrences, the function should be combined with Exec function usage. For example, in the setup above, the expression =Exec("Year", RowNumber("DataItemName")) used in the "Month" scope will get evaluated to 1, 1, 1,.., 1 for all 12 occurrences of the "Month" scope inside the first instance of the "Year" scope and then to 2, 2, 2... for the second occurrence of the "Year" data scope.
Function | Description |
---|---|
RowNumber(scope) |
Returns a running count of all rows inside the current instance of the specified parameter scope. |
ColumnNumber(scope) |
Returns a running count of all columns inside the current instance of the specified parameter scope |
Data scope functions cannot be nested. Data scope functions are evaluated on demand. This means that in some cases (using
RowNumber()
/ColumnNumber()
functions) their results might vary according to the order of report actions execution.