Quick User Guide How to update metadata. GENEDI Generic EDI toolbox Version 2.1. European Commission 2005 Page 1

Size: px

Start display at page:

Download "Quick User Guide How to update metadata. GENEDI Generic EDI toolbox Version 2.1. European Commission 2005 Page 1"

Cora Johnson
5 years ago
Views:

1 GENEDI Generic EDI toolbox Version 2.1 Quick User Guide How to update metadata European Commission 2005 Page 1

2 Table of contents Introduction... 3 How to update configuration files... 4 How to import new domains... 6 How to create or update codelists... 7 How to create or update validation rules... 7 How to create or update dataset and dataset structures European Commission 2005 Page 2

3 Introduction This document aims to supply GENEDI users with guidance on how to update metadata (configuration files). Users who do not have specific skills in computing should be able to operate the update or creation of metadata for GENEDI with the help of this document. GENEDI has been designed to operate on a large variety of systems including among others MS/Windows and UNIX. All along this document, the explanations are given for these two types of the operating system. Note that this document doesn t describe specific operating system features; it only covers functionalities included in GENEDI installation package. European Commission 2005 Page 3

How to update configuration files If new versions of configuration files (code lists "CL_xxxxx.txt", validation rules "DATASETID_validation.txt", ".ini" files or dataset structure files ".cod" or ".

4 How to update configuration files If new versions of configuration files (code lists "CL_xxxxx.txt", validation rules "DATASETID_validation.txt", ".ini" files or dataset structure files ".cod" or ".zip" files that can contain several configuration files) available on CIRCA ("EDI and Statistics" Interest Group) and/or given by domain managers have to be taken into account in GENEDI, the following approach should be adopted: 1. Launch GENEDI 2. In the menu bar, click on Updates 3. Select option Update Configuration files 4. In the dialog box displayed, select first at the bottom the type of file you are using Then browse on your Hard Disk and select the file. Finally, click on Open. European Commission 2005 Page 4

5. Tick off the Domain(s) where the file should be updated (a same file can be use by several domains). Then, click on OK. 6. Click OK when the message of confirmation appears. 7.

5 5. Tick off the Domain(s) where the file should be updated (a same file can be use by several domains). Then, click on OK. 6. Click OK when the message of confirmation appears. 7. Click OK when the message of execution is displayed 8. If validation rules have been updated, restart GENEDI Note: When you want to update several configuration files at the same time, you have to create a Zip archive that MUST be built as follows: One folder entitled codelists (that contains the code lists and the structures), one sub directory per domain. One folder entitled validation (that contains the validation rules files), one sub directory per domain. European Commission 2005 Page 5

6 How to import new domains 1. Launch GENEDI 2. In the menu bar, click on Updates 3. Select option Import New Domain 4. In the dialog box displayed, select the ZIP archive file you are using and browse on your Hard Disk to select the file. Finally, click on Open. 5. Click Ok at each confirmation message. 6. Restart GENEDI European Commission 2005 Page 6

7 Note: The Zip archive MUST be built as follows: One folder entitled codelists (that contains the code lists and the structures), one sub directory per domain. One folder entitled validation (that contains the validation rules files), one sub directory per domain. How to create or update code lists To update code lists manually, go to GENEDI root folder, then select folder codelists and the sub folder of the statistical domain concerned by the update. Open with a text editor (e.g. Notepad) the code list entitled CL_xxxx.txt you want to update. To create a new code list, open a new text file in folder GENEDI root\codelists\xxx, where GENEDI root is the path where GENEDI is installed, XXX the short name of the statistical domain (e.g. MRTM for Maritime, AIR for Aviation ). In the text editor, insert one code per line. If you want to add a comment to a code, add a semicolon after the code and write your comment. You can also add general comments, for example in the heading lines of the file, by starting the line with #. # Aircraft type B747;Boeing 747 Once the code list is created and saved into folder GENEDI root\codelists\xxx, you need to update the dataset structure and the validation rules (see next paragraphs) to take it into account. How to create or update validation rules Validation rules are stored in folder GENEDI root\validation\xxx, where GENEDI root is the path where GENEDI is installed, XXX the short name of the statistical domain (e.g. MRTM for Maritime, AIR for Aviation ). Files that contain the validation rules in a format readable by the user are entitled YYY_validation.txt, where YYY is the European Commission 2005 Page 7

dataset ID (e.g. AIR_A1_A). It is not sufficient to modify the file "YYY_validation.txt", you must restart GENEDI after update in order that it can take them into account.

8 dataset ID (e.g. AIR_A1_A). It is not sufficient to modify the file "YYY_validation.txt", you must restart GENEDI after update in order that it can take them into account. How to create or update validation rules via the GENEDI configuration tab (only applies to fields with one single validation rule) To create a new validation rule with the GENEDI interface: 1. Launch GENEDI 2. Select the Configuration tab 3. In the left frame, click on GENEDI, then click on the domain 4. You can see now the list of dataset implemented for the current domain 5. Click on one dataset 6. You can see the list of fields in the dataset 7. Click on one field and set the validation rules for it, and the corresponding parameters. Type: Alphanumeric Min number of characters: 2 Max number of characters: 2 8. Click on Save and select the next field 9. When the updates are achieved, exit and restart GENEDI. European Commission 2005 Page 8

How to create or update validation rules in the configuration files directly (to be used in case several validation rules apply for one single field) To create or update a new validation rule in the

9 How to create or update validation rules in the configuration files directly (to be used in case several validation rules apply for one single field) To create or update a new validation rule in the configuration file directly: 1. Select the folder GENEDI root\validation\xxx, where GENEDI root is the path where GENEDI has been installed, and XXX the short name of the statistical domain concerned by the update (for example: C:\GENEDI\validation\AIR). 2. Edit the file YYY_validation.txt, where YYY is the dataset identifier (for example: AIR_A1_A_validation.txt). You can use the Windows Notepad for that operation. 3. The file is structured as follows: ##FIELD_NAME RuleName1, list of parameters RuleName2, list of parameters ##END This text block is repeated for each field that required a control. Fields free of controls are not present in the file. Please consult the Configuration Guide to see the details about the RuleNames and their parameters. Create or update the validation rules in the text blocks of the concerned fields. 4. Save the file 5. Go in the GENEDI root folder and double click on file Description_generator.bat. Then, click on Yes when the window below appears. You will see GENEDI converting all the validation rules. 6. You can then launch GENEDI European Commission 2005 Page 9

10 How to create or update dataset and dataset structures The files relevant to the dataset definitions and structures are stored in folder GENEDI root\codelists\xxx, where GENEDI is installed, XXX the short name of the statistical domain (e.g. MRTM for Maritime, AIR for Aviation ). To update manually a dataset definition, open the file GENEDI root\codelists\xxx\xxx_dataset_id.cod, where XXX the short name of the statistical domain. This file contains the list of the dataset definitions implemented. Each line corresponds to one dataset definition. The line has three parts; the first one is the dataset identifier, the second one is the key family structure and the third one is the textual definition. AIR_A1_A;ESTAT_SAIR_A1;Flight stages database Annual You can add or remove a line. In case a line is added with a new key family structure, the the file GENEDI root\codelists\xxx\xxx_dataset_structure.cod should be updated. To update automatically an existing dataset structure file, see the first paragraph. To update manually a dataset structure, open the file GENEDI root\codelists\xxx\xxx_dataset_structure.cod, where XXX the short name of the statistical domain. This file contains the list of the dataset structures implemented. The first line corresponds to the key family structure. Then arrives the list of duplicate key records followed by two optional position of the field corresponding to the year in the dataset, position to the field corresponding to the period in the dataset. The possible cases case when only the year is available in the case when the year and the period are available in the period value 1, user period value 1, GESMES period value 2, user period value 2 For example for The following lines are devoted to the dataset structure. Each line corresponds to one field and starts with the field name in the key family structure. Then, separated by semicolons, you have the textual definition and in a third place the optional name of the codelist in which the field takes its values. RCOUNT;Reporting country;cl_country European Commission 2005 Page 10

11 The definition of structure ends by a semicolon. After a new structure definition can be added following the same model above-mentioned. END OF DOCUMENT European Commission 2005 Page 11

GENEDI Generic EDI toolbox Version 2.1. User Guide

GENEDI Generic EDI toolbox Version 2.1 Table of contents 1 Introduction... 4 1.1 Objectives... 4 1.2 Audience... 4 1.3 Outline... 4 1.4 Terminology... 5 2 Application overview... 6 2.1 Introduction...