Difference between revisions of "Tabular Data Manager: Template Management"
m (→Template) |
m (→Template) |
||
Line 1: | Line 1: | ||
== Template == | == Template == | ||
− | A template is a predefined data structure (characterizing both the data element entities and a set of rules constraining data values) a Tabular | + | A template is a predefined data structure (characterizing both the data element entities and a set of rules constraining data values) a Tabular Resource should comply with. |
− | The main menu enables to | + | |
+ | The main menu enables to create, open or delete a template as well as to use it to characterise a Tabular Resource. | ||
[[Image:tabular_data_manager_template.png|frame|center|Tabular Data Manager, Template tab]] | [[Image:tabular_data_manager_template.png|frame|center|Tabular Data Manager, Template tab]] | ||
Line 8: | Line 9: | ||
A Template can be defined in three steps: | A Template can be defined in three steps: | ||
− | # Definition of metadata | + | # [[#Definition_of_metadata | Definition of metadata]]; |
− | # Definition and Validation of initial structure of the Template | + | # [[#Definition and Validation of initial structure of the Template | Definition and Validation of initial structure of the Template]]; |
− | # Definition of Actions to execute | + | # [[#Definition of Actions to execute | Definition of Actions to execute]]. |
− | + | ||
==== Definition of metadata ==== | ==== Definition of metadata ==== | ||
− | In this | + | In this step the user has to compile the following elements: |
− | * '''TEMPLATE TYPE''' the TabularResource type that the template will create (DATASET, CODELIST or GENERIC) | + | * '''TEMPLATE TYPE''' the TabularResource type that the template will create (DATASET, CODELIST or GENERIC); |
− | * '''NAME''' | + | * '''NAME''' the given name of the templete; |
− | * '''AGENCY''' | + | * '''AGENCY''' the responsible party defining this template; |
− | * '''DESCRIPTION''' | + | * '''DESCRIPTION''' a textual description of the template; |
− | * '''ON ERROR''' the behavior of the execution in case of errors | + | * '''ON ERROR''' the behavior of the execution in case of errors selected among the following possible ones: |
− | ** ''ASK'' | + | ** ''ASK'' to stop the execution; |
− | ** ''DISCARD'' remove all rows with errors and continue the execution; | + | ** ''DISCARD'' to remove all rows with errors and continue the execution; |
− | ** ''SAVE'' | + | ** ''SAVE'' to store all rows with errors in a separate file and continue the execution. |
− | * '''NUMBER OF COLUMNS''' the number of columns of the initial structure | + | * '''NUMBER OF COLUMNS''' the number of columns of the initial structure. |
[[Image:choosetemplete.png|700px|thumb|center|Tabular Data Manager, template type: dataset, codelist, generic]] | [[Image:choosetemplete.png|700px|thumb|center|Tabular Data Manager, template type: dataset, codelist, generic]] | ||
==== Definition and Validation of initial structure of the Template ==== | ==== Definition and Validation of initial structure of the Template ==== | ||
− | In this step the | + | In this step the user chooses the categories and data types for each column. |
Users can see visualized in the guide structure the constraints and the mandatory fields of creating all types of tables: | Users can see visualized in the guide structure the constraints and the mandatory fields of creating all types of tables: |
Revision as of 17:53, 25 May 2015
Contents
Template
A template is a predefined data structure (characterizing both the data element entities and a set of rules constraining data values) a Tabular Resource should comply with.
The main menu enables to create, open or delete a template as well as to use it to characterise a Tabular Resource.
New Template
A Template can be defined in three steps:
- Definition of metadata;
- Definition and Validation of initial structure of the Template;
- Definition of Actions to execute.
Definition of metadata
In this step the user has to compile the following elements:
- TEMPLATE TYPE the TabularResource type that the template will create (DATASET, CODELIST or GENERIC);
- NAME the given name of the templete;
- AGENCY the responsible party defining this template;
- DESCRIPTION a textual description of the template;
- ON ERROR the behavior of the execution in case of errors selected among the following possible ones:
- ASK to stop the execution;
- DISCARD to remove all rows with errors and continue the execution;
- SAVE to store all rows with errors in a separate file and continue the execution.
- NUMBER OF COLUMNS the number of columns of the initial structure.
Definition and Validation of initial structure of the Template
In this step the user chooses the categories and data types for each column.
Users can see visualized in the guide structure the constraints and the mandatory fields of creating all types of tables:
Rules
During definition and validation of a template users can add one or more expressions for data validation (Rules) on a column already defined (with category and data type) only if a rule is allowed for the category selected.
Flow
Flows are a special type of TabularResource that can be created only from a Template. Adding a flow on Template Definition means that every entry resulted from the application of this template will be copied in the selected FLOW. The flow, once created, cannot be modified it can only be cloned or analysed using the Analyse Tab.
User has to fill all the needed metadata (as for the creation of a new TabularResource) and also has to select the behavior in case of duplicate entries.
Definition of Actions to execute
Users can add Actions to be applied to the template defined in step 2.
The available operations are:
- Add Column
- Remove Column
- Create Time Dimension
- Aggregate By Time
- Normalize
Users can show the history of the applied operations selecting History Operations
Add Column
This Action adds a new column to the TabularResource. The new column will be nitialized with the expression defined clicking on the Set Value button.
Create Time Dimension
This Action creates a new column of type TimeDimension using other columns. The user has to select the columns for 'YEAR', YEAR and MONTH, YAR, MONTH and DAY, YEAR and QUARTER depending on what type of TimeDimension columns he wants to be created.
Aggregate By Time
Aggregates a list of columns by time (see the Aggregate By Time operation )
Normalize
Applies the normalization operation (see Normalize operation)
Apply Template
The Apply Template function allows application of a template to the current TabularResource. The TabularResource structure MUST be compatible with the initial structure defined in the template otherwise a TemplateNotCompatible error will be thrown.