Routines page
Admin | 
ETL > ETL Domains > Routines link
Note: if the ETL domain is locked, the window will open in read-only mode.
Purpose of the page¶
This window allows you to define the routines of ETL domains
Actions on this page
| Element | Description |
|---|---|
| This filters the data shown on the page. | |
| This adds a row in order to insert a new routine | |
| This duplicates the selected row with all the information inserted, except for the code. | |
| Deletes the element contained in the selected row. | |
| Enables/Disables the grid modify function. This allows you to change the characteristics of the selected elements directly in the table, and to hide the configuration tabs. | |
| Enables multi-row selection to allow mass changes. | |
| Selects the columns to be shown/hidden in the table and those to be locked when scrolling the table. | |
| Exports the data in Excel format so they can be edited and reimported into CCH Tagetik. | |
| Imports data from a previously prepared Excel file. |
Attributes tab
Please find below the most important fields.
| Field | Description |
|---|---|
| Code | Routine code to be used in the loading task. Mandatory |
| Description | - Routine description. Mandatory |
| Process | If activated, this tells the routine that it must request a filter on the process in the execution step. It must be activated for routines that manage “value” data and have a CCH Tagetik table as the loading destination. Thus, the system can run all the necessary editability checks to understand whether or not a data item can be loaded; |
| Store extraction | If activated, this tells the routine that, at the end of the extraction step, it must save the data contained in the staging table on the extracted data storage table. The data are saved by ETL domain/routine/user and potentially by the extraction storage parameters defined in the routine. This is useful: - to be able to subsequently run queries on the extracted data and have full traceability, over time, of what data have been extracted, by whom, and when; - to be able to run a routine in partial mode, starting with the transformation phase or considering data saved on a the storage table of a previous execution as the data to be extracted |
| Store transformation | If activated, this tells the routine that, at the end of the transformation step, it must save the data contained in the staging table on the transformed data storage table. The data are saved by ETL domain/routine and potentially by the transformation storage parameters defined in the routine. This is useful: - to subsequently run queries on the transformed data and have full traceability, over time, of what data have been transformed, by whom, and when; - to run a drill-through query within a form to understand in detail how a data item from ETL originated. For example, suppose we extract data from the payments and salaries subsystem, that in this subsystem the data are detailed by sector, and that we load them onto CCH Tagetik, but on a single Salaries account. After the Routine has been executed on the Salaries account, the amount will be, for example, 1,000 but, as we have stored the extraction data, by carrying out a drill-through query within a form, we can see how the number 1,000 originated, and each sector’s contribution to the total of 1000; - to be able to run a routine in partial mode, starting with the loading step or considering data saved on a the storage table of a previous execution as the data to be transformed; |
| Error management | - If activated, this tells the routine that, where there are errors, the system must intercept them, continue with the execution, and only at the end allow them to be displayed using the indicators (coloured traffic lights) associated with each step of the routine. If deactivated, however, where there are errors in the routine execution step, user will be presented with the stack trace of the error as soon as it is detected and the execution will be stopped; |
| Warnings management | Allows you to set how the routine must behave if warnings (yellow traffic light) are returned in the execution step. The possible behaviours are as follows: - None: the routine is not stopped; - Show: the routine is stopped and the user can decide whether to continue with its execution; - Lock: the routine is stopped and does not allow the user to continue with its execution |
| Show detailed warnings | If activated, this tells the routine to show, in detail (non-grouped pre-loading records), any warnings generated in the loading onto CCH Tagetik step for the insertion and updating of grouped data operations. |
| Step | in the loading onto CCH Tagetik tables step related to Amounts, Intercompany values and Adjustments, you can partialise the data to be inserted /deleted based on the Account. If activated, this tells the routine to load only data which make reference to accounts that are present in the steps (which will be specified in the execution step) of the process being run; |
| Account hierarchy | in the loading onto CCH Tagetik tables step related to Amounts, Intercompany values and Adjustments, you can partialise the data to be inserted/deleted based on the Account. If activated, this tells the routine to load only data which make reference to accounts that are related to nodes (which will be specified in the execution step) of the Account hierarchy indicated in the field of the same name (this value can also be specified in the execution step). |
| Declaration | This contains the links to access the management of the following tasks: Extractions Transformations Loading |
| Submit entities | If activated, this tells the routine that the data are submitted automatically at the end of the loading step. In particular, if this option is set to: - Don't submit, the system will not run data submission at the end of the loading step; - Submit all steps. the system will automatically submit all steps of the process run for all scenarios, period and entities proceed as parameters; - Submit all previous steps to the IC matching step. the system will automatically submit all steps strictly lower than the step in which the first intercompany matching cockpit is present, for all scenarios, period and entities processed as parameters Note: Once activated, in order for the option to work correctly, in the execution step a process must be indicated and the routine must use parameters related to Dimensions which have Scenario, Period and Entity as their “Identity”. Thus, the scenarios, periods and entities to be submitted are indicated. |
| Declare IC insertion complete | If activated, this tells the routine that, after the data loading step, the insertion of intercompany entries is automatically declared as finished for all the intercompany matching cockpits belonging to the process run for all scenarios, periods and entities processed as parameters; Note: Once activated, in order for the option to work correctly, in the execution step a process must be indicated and the routine must use parameters related to Dimensions which have Scenario, Period and Entity as their “Identity”. Thus, the scenarios, periods and entities to be submitted are indicated. |
| Application deployment | If activated, this tells the routine that, before every loading task on CCH Tagetik “values” tables, it must run the necessary deployments deriving from other loading tasks run by the same routine on CCH Tagetik “structure” tables. If the routine does not contain any loading task on “structure” tables, the deployment is never run regardless of how this option has been set. The possible values are: - Never. Deployments must be run manually after the routine has been executed; - Execution on demand. The user will tell the system whether it must run the necessary deployments when the routine is executed; - Always. The system will automatically run the necessary deployments. |
| Automatic setup | - If active, this tells the routine to automatically create the user rights related to the loaded “structural” data (entities, custom dimensions, categories, etc.). This is useful if the routine requires loading onto “value” tables using those elements, thus avoiding errors related to editability checks; |
| Calculation logics | If active, this tells the routine that the data processing is run at the end of the loading step - “Entity data processing - Standard formulas” - “Entity data processing: Formulas”. on Calculation logics defined in the field of the same name. Note: the data processing is run for the original scenarios, periods and entities selected in the routine execution step via ETL parameters that have related dimensions whose identity is Scenario, Period and Entity. |
Extraction storage parameters tab
Please find below the most important fields.
| Field | Description |
|---|---|
| Extraction - Parameter 1....9 | If the routine manages the storage of extracted data, up to nine parameters can be defined for each operation. The parameters, together with the routine ID, filter the deletion of the storage table and the subsequent insertion of data from the staging table. |
Transformation storage parameters tab
Please find below the most important fields.
| Field | Description |
|---|---|
| Transformation - Parameter 1....9 | If the routine manages the storage of transformed data, up to nine parameters can be defined for each operation. The parameters, together with the routine ID, filter the deletion of the storage table and the subsequent insertion of data from the staging table. |
Relationships tab
Please find below the most important fields.
| Field | Description |
|---|---|
| Nodes | This tab allows you to view and edit the grouping nodes to which the selected routine is related. Every new routine inserted will automatically be associated with the grouping nodes indicated as to be related by default. |