Skip to main content

Input Template Calculation Function

The settings for the input template calculation function define the units for which figures are calculated. The most commonly used setting is the branch type generation in which all input units (for which the user has required rights) are generated for input template calculation under the selected level.

Element

Attributes

Possible values

<outlookparameter>

-

 

       <inputcalculation>

-

 

<outlookparameter>

-

 

       <inputcalculationdimensions>

-

 

       <dimensionselector>

-

 

dimensiontype

dim00 ... dim09

generatetype

next, input, selected, branch, all

level

 

hierarchy

hierarchy ID, %DIMnn HIERARCHY%

[v24.08 and later:] hierarchyname

hierarchy name, %DIMnn HIERARCHY NAME% [v24.08 and latercontent ends]

sourceyear

%YEAR CODE%

sourcedatatype

%DATA TYPE CODE%

forceconslevels

true, false

includeselected

true, false (default)

<outlookparameter>

-

 

       <parallelcalccount>

-

 

Elements, attributes, and possible values

<outlookparameter>

Input Template Calculation function/Extra Fields tab/Advanced Options/ tab - path: <outlookparameters><outlookparameter>

<inputcalculation>

Input Template Calculation function - path: <outlookparameter><inputcalculation>

Defines whether the Input Template Calculation button is available for the input task.

Possible values:

  • visible

  • notvisible (default)

<outlookparameter>

Input Template Calculation function/Extra Fields tab/Advanced Options/ tab - path: <outlookparameters><outlookparameter>

<inputcalculationdimensions>

Input Template Calculation function - path: <outlookparameter><inputcalculationdimensions>

This element and its subelement <dimensionselector> are needed if the input template calculation function has been added to the template (<inputcalculation>).

<dimensionselector>

Input Template Calculation function - path: <outlookparameter><inputcalculationdimensions><dimensionselector>

This element and its parent element <inputcalculationdimensions> (see above) are needed if the input template calculation function has been added to the template (<inputcalculation>).

If <multiselect> is in use and a user selects multiple units for a dimension defined by the 'dimensiontype' attribute, the dimension and unit combinations are generated for each unit according to the 'generatetype' settings. If the selected dimension is not included in the 'dimensiontype' settings, the unit selections are passed on to the template and processed according to the template settings.

Attributes

dimensiontype: Defines a dimension to be generated.

Possible values:

  • dim00 ... dim09

generatetype: Defines how units are generated for the dimension.

Possible values:

  • next: Input units to which the user has required rights are generated for input calculation starting from the next level below the selected level. The level attribute is required with value next.

  • input: Only input level units for which the user has required rights are generated for input calculation.

  • selected: Specific selected units for which the user has required rights are generated for input calculation.

  • branch: All input units for which the user has required rights are generated for input calculation under the selected level.

  • all: All input units for which the user has required rights are generated for input calculation.

level: Defines how many levels down from the selected or defined level units in the hierarchy are generated. Required with the 'generatetype' attribute value next.

hierarchy: Defines the hierarchy according to which the units are generated.

Possible values:

  • Hierarchy ID: The units are generated from the defined hierarchy.

  • Variable %DIMnn HIERARCHY%: The units are generated according to the hierarchy selected by the user on the input task's Basic Options tab.

sourceyear: Defines the financial year according to which units are generated.

Possible values:

  • Variable %YEAR CODE%: The units will be generated according to the financial year selected by the user on the input task's Basic Options tab.

sourcedatatype: Defines the data type according to which units are generated.

Possible values:

  • Variable %DATA TYPE CODE%: The units will be generated according to the connections of the data type selected by the user on the input task's Basic Options tab.

forceconslevels: Defines whether consolidation units are always generated for input calculation in the next type generation.

Possible values:

  • true: Consolidation level units are generated for input calculation (in the active data type and year) in the selected branch on the defined level n.

  • false: Consolidation level units are not generated for input calculation (in the active data type and year) in the selected branch on the defined level n.

includeselected: Defines whether the unit selected in the Basic Options is also included in the input template calculation when the <multiselect>  function is in use.

Possible values:

  • true

  • false (default)

<outlookparameter>

Input Template Calculation function/Extra Fields tab/Advanced Options/ tab - path: <outlookparameters><outlookparameter>

<parallelcalccount>

Input Template Calculation function - path: <outlookparameter><parallelcalccount>

Defines the setting for the number of simultaneous calculations in input template calculation.

Possible values:

  • 1–64. If the parameter or value is missing, the default value 3 will be used.

Was this article helpful?

We're sorry to hear that.