System Parameters

Global Parameters

You can add customer-specific global parameters to the system. These parameters can be used, for example, in the user interface task definitions, input and report templates and definitions, TR drill-down definitions, and in the names of external workbooks added to the input and report templates.

Clausion includes a number of internal parameters, which can be used in the input and report templates. For instructions about using the internal parameters, refer to Input and Report Template Variables in Clausion Input and Report Template Parameters.

Customer-specific global parameters are set on the Custom Parameters sheet of the Parameters custom template.

1. If you want to add a new parameter, add a new row to the template.

2. In the Parameter column, type a name for the parameter (without the % characters). We recommend that the customer-specific parameter names start with "U_".

   If you add a global parameter with the same name that is already in use for an internal parameter, it will be overridden with the value of the global parameter. So, for example, in the header data of a template the value of the internal parameter is shown to the user.

3. In the Value column, type a value for the parameter.

   In Desktop Client, the maximum length of a parameter is 255 characters and in Web Client the maximum length is 1000 characters.

Default global parameters

%ALLDOCS%

The document series for the basic Clausion task for calculating the input data are by default fetched from the data of the global parameter %ALLDOCS%. It is recommended to add a list of all document series in the environment as the value of this parameter, thus getting all series calculated by default.

%DDTEMPLATE%

The %DDTEMPLATE% parameter is the drill-down template defined in all Clausion default templates.

%INTEGRATION PERIOD% and %INTEGRATION YEAR%

The %INTEGRATION PERIOD% and %INTEGRATION YEAR% parameters (without values) are included in the template by default. These parameters are used by default in some example user interface task definitions (see Example task settings under Managing UI Blocks, Folders, and TasksExample task settings under Managing UI Blocks, Folders, and Tasks). You can add year and period IDs that exist in the database as values for the parameters.

When a global parameter is used, it is not necessary to change the value for every task separately. For example, if you set the value 2 for INTEGRATION PERIOD, which usually is February, all tasks that use the %INTEGRATION PERIOD% parameter open with February selected by default. For the next month's reporting, the period value needs to be changed only in the global parameter settings for all tasks to open with March by default.

All tasks that use the %INTEGRATION PERIOD% or %INTEGRATION YEAR% parameter then open with this period or year selected by default, and it is not necessary to set the value for every task separately. The parameters can be used, for example, in the user interface task definitions, input and report templates and definitions, TR drill-down definitions, and in the names of external workbooks added to the input and report templates.

%GLOBAL PERIOD% and %GLOBAL YEAR%

The %GLOBAL PERIOD% and %GLOBAL YEAR% parameters (without values) are included in the template by default. These parameters are used by default in some example user interface task definitions (see Example task settings under Managing UI Blocks, Folders, and TasksExample task settings under Managing UI Blocks, Folders, and Tasks). You can add year and period IDs that exist in the database as values for the parameters.

When a global parameter is used, it is not necessary to change the value for every task separately. For example, if you set the value 2 for GLOBAL PERIOD, which usually is February, all tasks that use the %GLOBAL PERIOD% parameter open with February selected by default. For the next month's reporting, the period value needs to be changed only in the global parameter settings for all tasks to open with March by default.

All tasks that use the %GLOBAL PERIOD% or %GLOBAL YEAR% parameter then open with this period or year selected by default, and it is not necessary to set the value for every task separately. The parameters can be used, for example, in the user interface task definitions, input and report templates and definitions, TR drill-down definitions, and in the names of external workbooks added to the input and report templates.

%HEADER1%

The %HEADER1% parameter defines the header row of Clausion default templates. The default value for the parameter is 'Clausion FPM'. If the parameter already exists in the database, the value will not change in the system update.