Calculation logics

Overview¶

Through the calculation logics users are able to evaluate an account as a formula based on other accounts storing the result into the Tagetik application database.

The calculation logics can be distinguished, according to the calculation type to perform, as follows:

standard logics. Used to value an account as sum (or difference) of other accounts. They are typically used to calculate an account as the algebraic sum of its details (or variations), with basic possibility of acting on the dimension's detail, and on equal scenario / period;
custom multidimensional calculation logics. Used when advanced non-linear operations have to be performed (e.g. multiplying or dividing two accounts, complex formulas), when factors and (or result) need to be read (written) in different scenarios / periods (e.g. reading from previous scenario) or on the dimensions (e.g. bundling on dimensions data to read or to write, reading from a fixed point or overriding the output element on given dimensions).

In both cases calculation logics need to be classified as belonging to one of the following Type:

Basic calculation logics; all system-generated logics are created as Basic. System logics are the ones related to result accounts, control groups, plug accounts and those logics calculating the account gross amount as the sum of its inter-company declarations.
Other calculation logics; user defined logics can be created both as Basic andOther.

The only difference between Basic and Other is the sequence with which they are calculated in the original scenario data processing: first the logics with type Basic are processed, then the type Other. Thus, running on Original Scenarios, calculation logics belonging to the Other type are able to read the results of Basic calculation logics, but not the other way around.

Running on Consolidation Scenarios the Type property is ignored: all logics are processed according to the sorting identified in the Calculation Logic Graph (in the Process settings), and they are able to read data generated from previous logics regardless of their Type.

System-generated logics are marked with a code starting with $ (control groups), $PL and $BS (result accounts), $L (plug accounts) and $IC (IC on gross amounts). System-generated logics cannot be modified in their configuration with the exception of the control group generated ones, where it is possible to add dimensional specifications (filters, fixed points and overrides).

From the Data Processing home page clicking the Account Calculations opens up a contextual menu with following elements:

List, opening the calculation logics elements management screen;
Grouping,opening to the calculation logics grouping structure management screen.

Calculation logics list¶

This screen lists all defined calculation logics, allowing to delete, modify or add new logics. In the right side pane, basing on the logic settings, are grouped the logic Attributes, Filters and Overrides, grouping Relationships and Info.

Attributes Pane¶

Each calculation logic is defined by following properties:

Code; mandatory, this is the rule's unique ID of the rule. Only characters of ISO LATIN type are allowed. The maximum allowed length is 30 characters, it cannot start with $ (reserved for system-generated logics).
Description in all managed languages, mandatory the administration language;
Calculation type. Mandatory, the possible types are:
Sum. The output account is calculated as the algebraic sum of other accounts (input accounts). It is possible to limit the set of data to run through the definition of suitable filters;
Custom MD. Allows you to obtain one or more accounts calculated through a custom script (TGKML Tagetik syntax). Unlike the "Sum" logics that performs simple sums of addenda with coefficient, custom multidimensional logics allow to perform calculations that combine input accounts in advanced formulas and logics, leveraging methods of dimensional manipulation adopted from the OLAP analysis (MDX). The calculation script has to be entered in the Formula attribute of the logic;
IC on Gross amount. Allows you to calculate the output account gross amount as the sum of IC data of one or more accounts (including the output account).

Whether in the accounts table the Gross amount equal to the IC sum option is enabled, running the Generate Gross amounts formulas from IC deploy creates automatically the calculation logics which define an account's gross data from the IC data of the same account.

Net on Gross amount. Allows you to calculate the output account gross amount as the sum of net data (gross data - IC data) of one or more accounts (other than the output account).
Basic calculation logic flag, to mark the logic as Basic logic.
Override sequence field, allowing to specify the calculation logics run sequence. For each data collection process, enabled calculation logics are executed basing on their sequence number: the execution sequence of all the logics sharing the same sequence number is automatically settled by the system basing on their mutual dependencies (i.e. basing on input and output accounts of each of them). The resulting sequencing, based on sequence numbers and dependencies, is created automatically during the process deployment, and it is visible in the process configuration. Although overriding the calculation sequence it is usually not necessary and not advisable as it could affect performances, this could be useful when the input and output accounts identify fake circular dependencies. See the user manual for further details. For further details about how the system defines the dependencies graph, see Enable calculation logic run.
Run on original scenarios. This property defines when to run the calculation logic on the Original Scenarios; possible values are:
No. The calculation logic won't run.
Automatic and Submission. The logic runs automatically together with Formulas (Basic or Other) data processing, and as part of the process step submission.
Automatic. The logics runs automatically together with Formulas (Basic or Other) data processing.
On demand. The logic runs only manually (see User Tools), via data entry form or ETL.
Run on consolidation scenarios. This property defines when to run the calculation logic on the Conslidation Scenarios; possible values are:
No. The calculation logic won't run.
Automatic. The logics runs automatically together with Formulas (Basic or Other) data processing.
On demand. The logic runs only manually (see User Tools), via data entry form or ETL.

These execution options can be overridden by process in order to have different running policy per process (See Process configuration for further details).

When the calculation type is Sum, IC on Gross amount, Net on Gross amount, the Attributes pane shows the section Calculation Details where it is possible do define following properties:

Input details
Output account, defines the account where to write the calculation logic result.
Run on gross amounts. When enabled the calculation logics reads and writes gross amounts. Enabling this option locks the output account for data entry on gross amounts: this can be overridden by process (See Process configuration for further details).
Run on IC amounts.When enabled the calculation logics reads and writes IC amounts. Enabling this option locks the output account for data entry on IC amounts: this can be overridden by process (See Process configuration for further details). Running on IC amounts is possible only when gross amounts are calculated too.
Run on journals. When enabled the calculation logics reads and writes journals. Enabling this option locks the output account for data entry on the journals. Additionally, when running on journals it is possible to specify the properties below:
Compensate Entities on journals. When this option is enabled, P&L result is calculated as the inverse of sum of all the other normal accounts, compensating it on the entities journals to avoid that in costs / revenues eliminations entry the system generates two rows of P&L net result with opposite sign (only per Basic logic types);
Keep CTP on journals: When enabled the detail of the input accounts counterparty is taken into consideration.

When the calculation type is Custom MD, the Attributes pane does not show the section Calculation Details section and in his place shows the Formula field is where to write the MD script. On saving the system checks the script syntax.

Filters and Overrides Pane¶

The Filters and Overrides pane is available only for calculation logics type Sum allowing to detail the logic with dimensional specifications such as:

filtering on dimensions
forcing to write the result to a given dimension element, regardless of the inputs

Whilst overrides are defined selecting a dimension element in the Override combo, filters are specified typing a CodeSet in the Filter text area. On saving the system checks the script syntax.

For further details on how to define Codesets and on how filters and overrides work refer to Definition of a "Sum" calculation logic with dimensional specifications.

Entity dimension does not accept overrides.

Category dimension does accept overrides only if the rule does not run on journals.

Relationships Pane¶

In the Relationship pane, it is possible to link the selected logic with the grouping nodes. It is possible to group the same logic to different nodes.

System logic info Pane¶

In case of selected logic is a system logic the System logic info pane is shown. This pane details the origin of the system logic.

Possible system logic are:

Control Group generated logic; in this case the pane shows the source control group code and a link to direct access the control group management screen.
Plug account generated logic; in this case the pane shows a link to direct access the IC elimination rules management screen, where plug account are defined.
IC on gross amount generated logic; in this case the pane shows a link to direct access the Accounts management screen, where this setting is defined.
Result account generated logic; in this case the pane shows the source result account set code and a link to direct access the result accounts management screen.

For further details on each of the above refer to the related section of the user manual.

Calculation logic, Input details¶

From the link in the attributes pane of the calculation logics elements management screen you can access the Input details management screen and define the input accounts for the selected calculation logic.

This screen lists all the input accounts, allowing to delete, modify or add new ones. In the right side pane are grouped the Attributes defining each input as follows:

Input Account; it can be a single account or an hierarchy node: in this case all the accounts related to that node - at any level - are added as input accounts.
Markup; it specifies a markup to be applied when summing the selected input account (or node).

Basing on the calculation logic settings, and only in case of logic type Sum, available dimension are grouped in two sections: Filters and Fixed Points.

Filters section groups all dimensions where no overrides have been specified for the current logic: filtering an input account on a given dimension filters on reading that account only from the dimension elements identified by the filter.
Fixed Point section groups all dimension having an override in place: defining a Fixed Point forces to read the inputs from the dimension element (or node) specified, regardless of the execution and header filters (i.e. reading from a fixed point can read outside the execution filters).

Filters and Fixed points are specified typing a CodeSet in the related text area. On saving the system checks the script syntax. For further details on how to define CodeSets refer to Definition of a "Sum" calculation logic with dimensional specifications.

Input details, definition results¶

On saving, input definition is automatically deployed and the full list of input and output accounts is available through the Definition Results hyperlink in the input details management screen.

Input and output accounts are listed together with the "cube" where they are read (or written): for further details about the available cube types see Cubes and dimensions.

Input and output accounts are used to identify dependencies between calculation logics.

Dependencies are automatically identified within rules sharing the same sequence number, just taking into consideration what the input and output accounts are for each calculation logic, regardless of dimensional specification. This could lead to fake dependencies that can be solved manually specifying the correct sequencing (Override sequence attribute).

Grouping¶

Calculation logics are managed through an aggregation structure of grouping type.

CCH Tagetik provides a predefined aggregation node (with code $), then the grouping structure can be customized with additional nodes according to any specific need. If needed several nodes can be marked as default relationships for new logics: this will automatically relate newly defined logics to those nodes.

A typical use of grouping nodes is to mark the different logics that need to be executed in different processes (e.g. planning logics, consolidation logics, etc.).

See aggregation structures for further details on managing aggregation structures.