Page Context Values
Some of the application parameters may be exposed to the end user via context values. To change the values of those parameters, one may use the "Page Context Values" widget under the "Editors" category.
This is an example from the FRTB Accelerator, where a user has added the desired context value into a dashboard to control the confidence level for the expected shortfall calculation:
The values set in the "Page Values" widget will apply to all widgets of the current page that target the same cube.
Core context values
This section provides the list of selected core context values that are available for ActivePivot 5.7. For an exhaustive and up-to-date list of all context values, please refer to ActivePivot 5 wiki
This section is for advanced users. If you are not familiar with ActivePivot, MDX and OLAP concepts, we recommend that you do not attempt to modify context values.
Those context values can be set at runtime, through the user interface, for a specific query. Whenever the context values need to be applied (independently of the query) for a specific user, a specific role or all users, it is recommended that they should be declared on the backend with the definition of the cube.
If custom context values have been defined within the scope of your project, then they will not be listed here.
MDX
mdx.aggressiveFormulaEvaluation
Formula evaluation during crossjoin should be restricted to tuples existing in the cube, instead of all possible tuples. Turn formula evaluation off if you have a calculated measure that returns a value, even against members with no contributors.COUNT
.
Turning off this flag might drastically affect performance.
Default Value: true
mdx.axisPositionLimit
This is the maximum number of members allowed per axis in the result. If one axis contains more than this limit, an exception will be thrown. If the value is set to -1, no limit is set. This check is performed after evaluating NON EMPTY
, light crossjoin and filters.
Default Value: -1
mdx.caseSensitive
This determines whether the mdx engine is case sensitive. It must be set to true when 2 members have unique names that are 'case insensitive equal'. For instance [Underlyings].[ALL].[AllMember].[EUR] and [Underlyings].[ALL].[AllMember].[eur].
Turning this off is not recommended.
Default Value: true
mdx.cubeFormatter
This value defines the cube's locale.
Default Value: en-US
mdx.defaultMembers
This value maps each hierarchy unique name to a list of possible default members. For example mdx.defaultMembers.[Geography].[City]: [ALL].[AllMember].[Berlin]
Default Value: undefined
mdx.formatters
This maps each measure or level unique name to its formatter. For example: mdx.formatters.[Measures].[contributors.COUNT]:DOUBLE[0.0000]
Default Value: undefined
mdx.hiddenGrandTotals
This provides a comma-separated list of the axis' ordinals to indicate which should be displayed without grand totals. This is equivalent to the Excel feature 'Remove Grand Total'.
For instance:
- to hide the grand total from the column axis:
mdx.hiddenGrandTotals: 0
- to hide the grand total from the column and row axis:
mdx.hiddenGrandTotals: 0,1
Default Value: undefined
mdx.hiddenSubtotals
This supplies a comma-separated list of the level's unique level names, to indicate which should be displayed without sub-totals. This is equivalent to the Excel feature 'Remove Subtotals'.
For instance:
- to hide any axis subtotal from the City level:
mdx.hiddenSubtotals: [Geography].[City].[City]
- to hide any axis subtotal from the City and Desk levels:
[Geography].[City].[City]
:mdx.hiddenSubtotals: [Geography].[City].[City],[Booking].[Desk].[Desk]
Default Value: undefined
mdx.ignoreInvalidMembers
Will prevent the engine from throwing an exception if encountering an invalid (i.e. non-existent) member.
Default Value: true
mdx.lightCrossjoin
When light crossjoin is enabled, the intermediary cross totals of the result set are not computed and not returned.
Example with lightCrossjoin: false
:
[AllMember, A, B] * [AllMember, C, D] = [
(AllMember, AllMember),
(AllMember, C),
(AllMember, D),
(A, AllMember),
(A, C),
(A, D),
(B, AllMember),
(B, C),
(B, D),
];
Example with lightCrossjoin: true
:
[AllMember, A, B] * [AllMember, C, D] = [
(AllMember, AllMember),
(A, AllMember),
(A, C),
(A, D),
(B, AllMember),
(B, C),
(B, D),
];
Default Value: false
mdx.resultLimit
The maximum number of cells allowed in the query result. An exception will be thrown if the result is greater than the defined limit. If set to -1, no limit is set.
Default Value: -1
Drillthrough
drillthrough.behavior
This context value specifies the behavior of the drillthrough engine when an exception occurs during the evaluation of a drillthrough post-processed column. Three behaviors are available: SILENT, WARN, THROW.
- SILENT: the exception is swallowed, and the result of the post-processed column will be "N/A".
- WARN allows to log the exception (WARNING level), but it is still swallowed and the result will still be "N/A".
- THROW allows not to swallow the exception: the drillthrough query will then fail.
Default Value: SILENT
drillthrough.maxrows
Specifies the maximum number of rows that drillthrough queries are authorized to return. If this context value is set and the query engine calculates that a drillthrough query will produce more rows than allowed, an exception is thrown.
Default Value: undefined
Epoch
epoch.id
Perform the query as of a specific epoch, where the epoch is defined by the epoch id. For instance epoch.id: 123
Default Value: undefined
epoch.strict
If this flag is enabled, any query performed with an unknown epoch id will throw an exception. Otherwise, the engine will fallback to the closest available epoch id.
Default Value: false
Miscellaneous
queriesTimeLimit
Any query whose execution time exceeds this limit will be interrupted. Defined in seconds.
Default Value: 30