Parameters
Parameter functionality¶
In general, designing a form means defining filters on the data in the operational database, on several levels. If fixed filters are defined, to display different elements of a specific dimension it would be necessary to change the form structure, or design several copies of the same form, every time. To make forms easier to read and allow them to be reused, the user can set parameters, i.e. filters whose value is not defined when the form is designed, but when it is run. Thus, the form can be run to show different data without its structure being changed, because parameters allow you to select the desired dimensional elements and/or aggregation structures on a dynamic basis. When running, the form therefore only shows the data that the user has chosen via the parameter. For more details on configuring parameters when a form is opened, see Parameters Configuration window.
Parameters can also be used in forms as row/column filters, matrix filters or tab filters. Using parameters to design forms makes increases flexibility when updating the form structure as every change made to the set of elements included in the parameter is automatically taken into account by the same parameter.
It is possible to use system parameters, managed by CCH Tagetik, or ad hoc or shared custom parameters, managed by the user.
Details of the existing types of parameters are provided below.
Supported types of data¶
Parameters can be based both on dimensional data and on non-dimensional data.
| Parameter | Description |
|---|---|
| Dimensional | The value obtained from a set of elements of a specific dimension: - Dimension: element or node of a CCH Tagetik dimension/hierarchy - Advanced Financial Statement Template: parameter for advanced FSTs structured by account/custom dimension and/or control type - Standard Financial Statement Template: Parameter for standard FSTs structured by account |
| Non-dimensional | Parameters used for specific configurations typical of advanced selection scripts. - Flag - Date: date parameter selected from a calendar - Dictionary: dictionary item parameter - Numeric: number parameter - Text: free text parameter - Process: process parameter (see ) |
System parameter details¶
System parameters are created automatically when forms are deployed (Application database > General deployment tile > select Forms > Detailed selection >select Data model > Other tables > Forms > Update Reporting dimension parameters). These parameters allow you to choose any element of the dimensions or any of the nodes of the aggregation structures.
System parameters are available in the dimensions tree (in blue) and have a code generated in accordance with the following rule:
- Parameters related to elements of a dimension: $ +
+ _P . For example, the code of the parameter related to the entity dimension is $AZI_P, while the code of the origin scenario is $SCE_P. - Parameters related to nodes of an aggregation structure: $ +
+ _ + . For example, the code of the parameter related to entity hierarchy G01 is $AZI_G01_P, while the code of the group of scenarios is $SCE_$_P.+ _P
The description of a parameter corresponds with the description of the dimension or aggregation structure from which it originated.
System parameters are identified with the prefix $ and cannot be created, modified or deleted manually.
When the data model is modified, e.g. a new hierarchy is created, the application needs to be deployed in order to use the new system parameter.
Specific features of custom parameters¶
Custom parameters are created by the user and can contain hierarchy nodes and/or selected individual elements of a dimension. The user can choose a subset of a dimension’s elements or nodes, e.g. all of a hierarchy’s nodes except for one, lowest level elements only, certain specific elements and nodes, and so on. Creating custom parameters therefore means that you do not have to create specific system hierarchies for individual forms.
Custom parameters are available for all users and can be:
- shared, can be used on all forms.
- ad hoc, can only be used in the forms in which they have been defined.
When the custom parameter is created or modified, the application needs to be deployed in order to use the new parameter or updated parameter.
Specific features of ad hoc parameters¶
Ad hoc parameters have the same characteristics as shared parameters but they can only be used in the forms in which they were defined.
The use of parameters is only advisable in the following contexts:
- The parameter is not needed in other forms, e.g. due to overly specific restrictions.
- The form contains a high number of shared parameters and the parameter in question is only necessary for the specific form.
- The parameter does not need to be shared with another form.
In ad hoc parameters, process parameters or dimensional parameters that allow OR clauses cannot be defined on the period, because they are not supported by forms.
Restrictions on parameters¶
Certain restrictions can be defined on parameters, allowing you to fine tune the behaviour of the specific parameter.
| Element | Description |
|---|---|
| Standard restrictions | These allow you to restrict the elements that can be selected as the parameter value when the form is opened. In particular, standard limitations allow you to do the following: - defined whether it is possible to select lowest level elements, nodes or several OR elements - select values manually from a dimensions tree, specifying them as explicit restrictions - exclude any restrictions defined at the process level on the dimension to which the parameter is linked |
| Dynamic restrictions | These allow you do define the list of values that can be assigned to the parameter. In particular, dynamic limitations allow you to do the following: - Define the list of values using a dynamic rule (e.g. insert children, insert lowest level elements). - Set dependent parameters using advanced selection script (see Details of advanced selection scripts for calculating the default value). |
The concept of dependency allows you to restrict the set of values for a given parameter depending on the value taken on by another parameter.
Note: the parameter selection window shown when the form is opened (see Parameters window) undoes the selection of a dependent parameter when the parameter on which it depends is changed. Dependent parameters are shown below the parameters on which they depend.
When a system parameter is automatically generated from a time-dependet hierarchy, the parameter selection window that appears when the form opened allows you to select only hierarchy nodes , even if the lowest level elements option is enabled in the parameter configuration.
In this case, the lowest level elements setting does not affect the list of values available in the drop-down menu, but only determines how the data is shown in the report, including or excluding the lower-level elements of the selected node based on the temp-variant structure.