Rules Engine Designer data processing on original scenarios

Introduction¶

Rules Engine Designer on original Scenarios is a data processing that, starting from input data on IC amounts, gross amounts, entity journals and consolidation journals, identified by a certain dimensional set (tuple), allows rows to be generated on a tuple of output dimensions by applying the rules defined by the Consolidator user.

Data processing applies specific rules and generates the following:

A row on the input dimensions that writes off the amount on input data itself (if the Writing off option is selected).
A row on the input dimensions with the same amount as that on the input data.

IMPORTANT: the data processing cannot be activated in processes using the 'Database' consolidation engine.

CCH Tagetik processes the rules defined for each original scenario and Entity in the Rules Engine Designer execution plan on Original Scenarios specified in the process definition.

Execution Plan Requirements¶

The following must be specified for each original period scenario:

the entity or node of entities to be processed
the node of rules for every entity/node of entities to be processed

IMPORTANT: If the same Entity and original scenarios/period are contained in several rows of the execution plan definition, only the last one is considered.

Data processing on entity¶

The Rules Engine Designer data processing on Entity is run immediately after the Basic calculation Logic data processing. The Gross Amount, IC Amount and Entity Journal rules are processed as per the following diagram:

For Gross Amount rules, the rows of Gross Amounts, IC amounts and Entity journals to be processed by Original Amount Type are read, and output rows on Gross Amounts with Original Amount Type are generated.
For the IC Amounts rules, the rows of IC amounts to be processed are read from the Original amount, and output rows are generated on the IC amounts of the Original amount type.
For the Entity journal rules, the rows of gross amounts, IC amounts and entity journals to be processed are read from the Original amount type and rows are generated on entity journals with Original amount type.

The data processing for Entities and on the original scenarios defined in the execution plan processes the rules contained in the nodes by reading input combinations on the Input category and generates rows on the Output category.

Entities with Deconsolidation Type equal to Deconsolidate only initial balances or Deconsolidate from previous period are excluded, consistently with the behaviour of the other processes on the original.

IMPORTANT: No order of priority applies to the rules. All rules are processed concurrently, without any execution sequence.

For each rule, the final balance is calculated in Entity currency and in transaction currency for the following elements:

Entity
Account
Managed custom dimensions
Ctp Entity
Custom dimension 2 of the Ctp Entity (for Processes with Relationship type Entity/Custom dimension 2)
Company currency
Transaction currency
Category

The Markup percentage (default 100%) is applied to the obtained amounts and the obtained amount is managed as follows:

If the Write off input data option is selected on the rule, the amount is written off from the input tuple at issue.
In other cases, the amount is allocated to the tuple specified in the output dimensions.

For rules that have the Enable carry forward Writing off for normal and detail accounts option enabled , for balance sheet, Guaranties & Commitments or other stock and normal/detail type accounts, the amount of the input data considered includes the value of the carry-forwards. Therefore, for the Entity Journals rules, rows with origin 'Carry forward - Rules Engine Designer' are written off. The write-off is carried out even if the rule definition rows have input accounts of variation type and output accounts of normal/detail type.

On the contrary, for rules that do not have the Enable carry forward Writing off for normal and detail accounts option enabled, rows with origin 'Carry forward - Rules Engine Designer' are not written off. This option is useful in cases where, in the rule definition for a given account, only part of the variation accounts belonging to a specific control group are reclassified to another account.

For Gross Amount and IC Amount rules, the Notes field of the generated rows is filled in with the code and description of the generating rule.

Journal header¶

For the Entity Journal rules, the data processing generates a journal with the same rule / output category and Entity.

The headers of the journals are identified by the journal number comprising the prefix REDORIG_ followed by the code of the rule, the output category and the entity. The Notes field shows the description of the rule.

The new headers are created by assigning the default attributes defined on the rule in the Journal attributes tab:

Enable carry forward
Tax calculation method
Reverse journal type

The pre-existing headers, generated by previous runs of the data processing, are updated every time it is run with the default attributes defined on the rule when the data processing is run. Journals having the option Override journal parameters selected are not updated.

Generated journals¶

For the Entity journal rules that read as input gross amounts data and IC amounts data, the data processing generated as output Entity journals where such data are expressed in a different way than the way they are saved in the tables of original data of gross amounts and IC amounts. In particular, the gross data is stored in the Gross amounts and the intercompany declarations are stored in the IC amounts as an “of which” of the gross data. Whereas, on the Entity journals data are written by counterparty. To obtain the gross figure, you must add up all the rows present on the journal, including those with an undefined counterparty, which represent the portion to minorities.

IMPORTANT: for the entity journal rules, if the output account has not the IC Management flag enabled, the row generated on that output account will not include the Ctp Entity.

For rules that have the Ctp Entity dimension enabled, the setting of the option Allow intercompany declarations towards same Entity in the IC Amount rules is not considered. Thus, the data processing may generate IC declaration rows to the same declaring Entity.

Data processing on group¶

The Rules Engine Designer data processing on Group is run immediately after the Basic calculation Logic data processing. The Consolidation journals rules are processed by reading the rows of Gross Amounts, IC Amounts, Entity journals and Consolidation journals to be processed from the Original amount type and generating rows on Consolidation journals with Original amount type.

For rules that read from consolidation journals, only consolidation journals that do not have the Many to many relationship option selected are processed. Journals in which at least one of the two header entities has its Deconsolidation Type equal to Deconsolidate only initial balances or Deconsolidate from previous period are excluded.

For the rules reading from Amounts and Entity journals, Entities with Deconsolidation Type equal to Deconsolidate only initial balances or Deconsolidate from previous period are excluded.

The data processing for Entities and on the original scenarios defined in the execution plan processes the rules contained in the nodes by reading input combinations on the Input categories and generates rows on the Output categories.

IMPORTANT: No order of priority applies to the rules. All rules are processed concurrently, without any execution sequence.

For each rule, the final balance is calculated in journal currency, in Entity currency and in transaction currency for the following items:

Journal number (for rules reading from consolidation journals)
Entity
Account
Managed custom dimensions
Ctp Entity
Custom dimension 2 of the Ctp Entity (for Processes with Relationship type Entity/Custom dimension 2)
Ctp Entity for Segment
Ctp Custom Dimension 2 for Segment (for Processes with Entity / Custom dimension 2 relationship type)
Journal currency
Entity currency
Transaction currency
Category

The Markup percentage (default 100%) is applied to the obtained amounts and the obtained amount is managed as follows:

It is allocated to the tuple indicated in the output dimensions.
If the Write off input data option is selected on the rule, the amount is written off from the input tuple at issue.

For rules that have the Enable carry forward Writing off for normal and detail accounts option enabled , for balance sheet, Guaranties & Commitments or other stock and normal/detail type accounts, the amount of the input data considered includes the value of the carry-forwards. Therefore, rows with origin 'Carry forward - Rules Engine Designer' are written off. The write-off is carried out even if the rule definition rows have input accounts of variation type and output accounts of normal/detail type.

On the contrary, for rules that do not have the Enable carry forward Writing off for normal and detail accounts option enabled, rows with origin 'Carry forward - Rules Engine Designer' are not written off. This option is useful in cases where, in the rule definition for a given account, only part of the variation accounts belonging to a specific control group are reclassified to another account.

IMPORTANT: In order to take full advantage of the possibility of deactivating the write-off, even if the 'Write in same journal header' functionality is used, the note field of the rows produced by the RED must contain the information about the rule that generated them. For this purpose, it is necessary to ensure that in the Carry-forward Rules the 'Journals rows aggregation type' field is set with the options 'Don't aggregate' or 'Aggregate according to dimensions and notes'

Journal header¶

For rules reading from consolidation journals, the data processing generates a journal with the same output rule/category and source journal. The headers of the journals are identified by the journal number comprising the prefix REDORIG_ followed by the code of the rule, the output category and the source journal number. The Notes field shows the description of the rule.

For rules reading from amounts and Entity journals, the data processing generates a journal with the same output rule/category, Entity and Ctp Entity. Journal headers are identified by the journal number formed by the prefix REDORIG_ followed by the rule code, the output category, the Entity and the Ctp Entity.

If the process has relationship type by Entity/Custom dimension 2, the header shows also the fields Custom dimension 2 and Ctp Custom dimension 2.

IMPORTANT: For input rows that do not have ctp Entities, the header has Entity 2 equal to Entity 1.

If the Write Off option is disabled and the Dimension definition row has outpout Ctp Entity equal to 'Remove ctp', the header has Entity 2 equal to Entity 1.

The attributes of the new headers created by the data processing are assigned based on the definition in Journal attributes of the rule:

For rules reading from consolidation journals, if the Define Manually option is not selected, the header is created with the same attributes as the input journal.
Otherwise, the header is created with the attributes specified on the rule.

The following attributes are available:

Proportional calculation method
Minorities calculation method
Equity evaluation method
Tax calculation method
Reverse journal type
Enable carry forward

The Exclude reclassifications and NER option is set to the value defined on the output category.

The pre-existing header attributes, generated by previous runs of the data processing, are updated every time it is run, as for the new headers, based on the setup present when the data processing is run. The update is not run for the journals having the Override journal parameters option selected.

The behaviour described above also applies to the Ctp Custom dimension 2 field.

IMPORTANT: In the event of a change of parametrization of the input/output dimensions of the rules between the scenario to be processed and the previous one, it is necessary to manually write off, meaning to override, the carry-forward rows on the dimensions entered in the previous parametrization.

Origin¶

The origin generated by this data processing is ‘PROC_RED’.

For rows generated in the previous year and carry forward to the subsequent year, the origin generated by the carry forward data processing is ‘PREL_RESTORE_RED’.

Data Processing Requirements¶

The following conditions must be fulfilled for this data processing to take place:

In the Data Processing section of the process, the following items are selected
Rules Engine Designer > on Entity Processes Gross Amount, IC Amount and Entity Journal rules
Rules Engine Designer > on group Processes the Consolidation journal rules
There is an execution plan with at least one Entity and one rule node containing at least one rule parameterised with the following:
at least one input dimensions record
at least one input categories record
Rules can only be run if the following conditions are met:
The output account belongs to the process.
for the IC Amount rules, have IC Management enabled in the list of elements
The Custom dimension is enabled in the Data Entry rules. For the Gross Amount and IC Amount rules, the custom dimension must be enabled in the data entry rules of Gross and IC Amounts; for the Entity journal and Consolidation Journal rules, the custom dimension must be enabled in the Journal data entry rules.
The elements of the Custom Dimension on which to generate output rows meet the restrictions of the output accounts.
Ctp Custom Dimension 2, if enabled on the rule, is handled in the Process(Relationship Type other than Entity).
Input categories are set to Run.
Output categories belong to the process.
If the process type is by account/category, the output account/category pair must be eligible for the Process Types linked to the Entities to be processed.

Cases where no output rows are generated¶

In these cases, the data processing does not generate write-off rows or output rows, even if input tuples are present:

The output account id not present in the Process Type of the Entity
The output Category is not enabled in the process
The account/category pair is not enabled in the Entity’s process type.
The rule defined for an unmanaged Custom Dimension on the process for amounts (for IC Amounts rules) of Gross Amounts or for journals (for Entity journal rules).
The management of the Ctp Custom Dimension 2 is enabled for the rule, while the process relationship type is by Entity.
The rule contains rows that do not consist of the dimension definition or definition rows with undefined input dimensions (active in the header).
The conditions in the rule are not fulfilled.
For consolidation journals where it is not possible to swap between the Entity and the Ctp Entity. In the consolidation journals , it is possible for the Ctp Entity to be different from the two header Entities even if the Many-to-many Relationship option is disabled. This may occur if the Manage Counterpart regardless of header relationship option is enabled in the journal rules. In this case, input data rows that have Ctp Entity other than the two header Entities are not processed based on the rule definition rows that have the Ctp Entity dimension active and Selection = Swap Entity with Ctp Entity. The swap cannot be performed because the Entity cannot be parametrized differently from the two header Entities. In case of Entity /Custom dimension 2 relationship type, the input rows with Ctp Entity / Ctp Custom dimension 2 different from the two Entity /Custom Dimension 2 header pairs are excluded.

Further conditions on the application rule¶

Below are the options available for each condition that the input data must fulfil in order for the rule to be applied.

Condition	Options
Entity - Deconsolidation Method	- Not to deconsolidate - Initial balances - From previous period - From current period
CTP Entity - Deconsolidation Method	- Not to deconsolidate - Initial balances - From previous period - From current period
CTP Entity for Segment - Deconsolidation Method	This condition is only managed for the Consolidation journal rules. - Not to deconsolidate - Initial balances - From previous period - From current period

Period of application of the conditions¶

For all conditions, an application period can be defined. For this purpose, the following options are available:

Current Period: the condition is checked in the Entity parameters on the original data processing scenario/period.
Opening Period: the condition is checked in the Entity parameters on original scenarios of the carry-forward scenario/period.

Conditions application specificities¶

For input data rows with Ctp Entity undefined, the condition 'CTP Entity - Deconsolidation Method' cannot be fulfilled as it is based on the Ctp Entity .

Moreover, for the Entity and CTP Entity for Segment the options of the Deconsolidation Method Initial Balances and From Previous Period, combined with the Current Period option, are not applied because the data processing excludes Entities to be deconsolidated with these Deconsolidation Methods in the data processing period.