EDAMIS Web Forms - Europa...2014/08/26 · August 2014 Page 1 EDAMIS Web Forms User guide for domain managers Project EDAMIS Author Eurostat Unit B3, IT for statistical production

August 2014 Page 1

EDAMIS Web Forms User guide

for domain managers

Project EDAMIS Author Eurostat Unit B3, IT for statistical production Release 3.0 Status Draft Reference QUG-03-2014-08-26 QUG (EDAMIS Web Forms user guide for

domain managers) D6.doc

August 2014 Page 2

TABLE OF CONTENTS

1 INTRODUCTION ......................................................................................................................................... 6

1.1 BACKGROUND INFORMATION .................................................................................................................... 6

2 BEFORE STARTING, READ THIS FIRST! ............................................................................................. 7

3 PHASE I: CHECKS AND PREPARATION .............................................................................................. 9

3.1 STEP 1: CHECK THE DATASET STATUS IN THE EDAMIS INVENTORY ...................................... 9 3.1.1 Section ‘Transmission’ .................................................................................................................. 11 3.1.2 Section ‘Timelines’ ........................................................................................................................ 12

3.2 STEP 2: CHECK DATASET LINKS WITH COUNTRIES AND ORGANISATIONS ......................... 15 3.3 STEP 3: CHECK THE DATASET TIMETABLE .................................................................................. 16 3.4 STEP 4: MANAGE GROUPED DATASET .................................................................................................... 17 3.5 STEP 5: PREPARE YOURSELF TO CREATE THE WEB FORM ....................................................... 19

3.5.1 Layout of the Web Form ................................................................................................................ 19 3.5.2 Check list of elements to collect and questions to answer before starting .................................... 22

4 PHASE II: THE WEB FORM CREATION ............................................................................................. 28

4.1 STEP 1: CREATE CODE LIST .............................................................................................................. 28 4.1.1 Create a Code list .......................................................................................................................... 28 4.1.2 Create codes for Code Lists .......................................................................................................... 33 4.1.3 Associate codes to Code Lists ....................................................................................................... 35 4.1.4 Import of Code Lists ...................................................................................................................... 37

4.2 STEP 2: CREATE A WEB FORM WITH NO DSD ............................................................................... 40 4.2.1 Wizard with a DSD - step 0: Choose a DSD ................................................................................. 43 4.2.2 Wizard without a DSD - step 1: Provide general information ...................................................... 43 4.2.3 Wizard without a DSD - step 2: Define table ................................................................................ 47 4.2.4 Wizard without a DSD - step 3: Define Code Lists position in the Web Form (row and columns)48

4.3 CREATE A WEB FORM USING A DSD .............................................................................................. 52 4.3.1 Wizard with a DSD - step 0: Choose a DSD ................................................................................. 53 4.3.2 Wizard with a DSD - step 1: General Information ........................................................................ 54 4.3.3 Wizard with a DSD - step 2: Define table ..................................................................................... 58 4.3.4 Wizard with a DSD - step 3: Define Code List position in the Web Form (row and columns) ..... 59

4.4 STEP 3: EDIT THE WEB FORM ........................................................................................................... 63 4.4.1 Define all cells formats ................................................................................................................. 63 4.4.2 Define simple arithmetic expressions ............................................................................................ 65 4.4.3 More complex expressions ............................................................................................................ 66 4.4.4 Define validation rules .................................................................................................................. 67 4.4.4.1 Adding a validation rule in a cell .................................................................................................. 67 4.4.4.2 Removing a validation rule from a cell ......................................................................................... 68 4.4.4.3 Editing an existing validation rule ................................................................................................ 68 4.4.4.4 Importing validation rules in Web Forms ..................................................................................... 69 4.4.5 Changing cell format and using cell locking ................................................................................. 69 4.4.6 Import of estimated data in Web Forms ........................................................................................ 70

4.5 STEP 4: PUBLISH THE WEB FORM ................................................................................................... 71 4.5.1 Publish the new Web Form for all users ....................................................................................... 71

5 PHASE III: PUBLISHING AND INSTANTIATING WEB FORMS . ................................................... 72

6 PHASE IV: WEB FORM MAINTENANCE ............................................................................................ 78

6.1 MAINTAINING A WEB FORM ............................................................................................................ 78 6.1.1 Codes ............................................................................................................................................. 78 6.1.2 Code List ....................................................................................................................................... 78 6.1.3 Define export structure.................................................................................................................. 79 6.1.4 Modifying Web Form titles ............................................................................................................ 80 6.1.5 Translation .................................................................................................................................... 81

7 GLOSSARY ................................................................................................................................................. 83

August 2014 Page 3

TABLE OF FIGURES

Figure 1: The EWF roadmap ...................................................................................................... 7 Figure 2: EWF example ............................................................................................................. 8

Figure 3: EWF login form .......................................................................................................... 9

Figure 4: EWF welcome page .................................................................................................. 10 Figure 5: Manage datasets menu .............................................................................................. 10 Figure 6: Manage datasets page ............................................................................................... 11 Figure 7: Manage datasets form ............................................................................................... 11 Figure 8: Manage datasets form - Transmission ...................................................................... 11 Figure 9: Manage datasets form - Timelines ............................................................................ 12 Figure 10: Manage links datasets and countries menu ............................................................. 15 Figure 11: Manage links datasets and countries form .............................................................. 15 Figure 12: Manage datasets - Detailed timetable by occurrences input form .......................... 16

Figure 13: Manage datasets – Detailed timetable by occurrences ........................................... 16 Figure 14: EWF – Layout area ................................................................................................. 20 Figure 15: Manage Code lists - Menu ...................................................................................... 28 Figure 16: Manage Code Lists menu ....................................................................................... 29 Figure 17: Manage Code Lists – Filtered by theme ................................................................. 29 Figure 18: Manage Code Lists –Code Lists List ...................................................................... 31 Figure 19: Manage Code List - Form ....................................................................................... 32 Figure 20: Manage Code Lists – Codes Association ............................................................... 32 Figure 21: Codes & Translations ............................................................................................. 33 Figure 22: Codes & Translations – EN/FR/DE ........................................................................ 34 Figure 23: Message from webpage .......................................................................................... 34 Figure 24: Manage Code Lists – Codes Association – New code ........................................... 34

Figure 25: Manage Code Lists – Codes Association – New code selected ............................. 35

Figure 26: EDAMIS message from webpage .......................................................................... 35 Figure 27: Manage Code Lists – Code Lists list ...................................................................... 35 Figure 28: EDAMIS message from webpage – Code List ....................................................... 36 Figure 29: EWF layout – Code List ......................................................................................... 37 Figure 30: Import Code List page ............................................................................................ 37 Figure 31: Linear Code List sample ......................................................................................... 38 Figure 32: Hierarchical Code List sample ................................................................................ 39 Figure 33: Form Templates - Menu ......................................................................................... 40 Figure 34: Form Templates - Form .......................................................................................... 40 Figure 35: Form Template created without any DSD- Step 0 .................................................. 43 Figure 36: Form Wizard – Step 1 of 3 – General information ................................................. 43 Figure 37: Form Wizard – Step 1 of 3 – General Information – List of year .......................... 46

Figure 38: EWF layout – Result from the wizard step 1 of 3 .................................................. 46 Figure 39: Form Wizard – Step 2 of 3 – Table Information .................................................... 47 Figure 40: EWP layout - Example ........................................................................................... 48 Figure 41: Form Wizard – Step 3 of 3 – Code List Information 1/1 ........................................ 48

Figure 42: Form Template – Template Summary .................................................................... 49 Figure 43: Form Templates - Menu ......................................................................................... 52 Figure 44: Form Templates - Form .......................................................................................... 52 Figure 45: Form Template created without any DSD .............................................................. 53 Figure 46: Form Template created using a DSD ...................................................................... 53 Figure 47: Information corresponding to the DSD .................................................................. 54 Figure 48: Confirmation message after providing a link to a DSD ......................................... 54

Figure 49: Form Wizard - Step 1 of 3 - General information - DSD file used ........................ 55

Figure 50: Form Wizard using a DSD: Step 1 of 3 - General Information .............................. 55

Figure 51: Form Wizard – Step 2 of 3 – Table Information .................................................... 58

August 2014 Page 4

Figure 52: Form Wizard – Step 3 of 3 – Code List Information 1/1 ........................................ 59

Figure 53: Form Template – Template Summary .................................................................... 59 Figure 54: EWF – Editing a Web Form template .................................................................... 63 Figure 55: EWF – Web Form tool box .................................................................................... 64 Figure 56: EWF –Formatting tools .......................................................................................... 64 Figure 57: EWF – Validation tool box ..................................................................................... 64 Figure 58: Selection of the cell where the arithmetic expression will be entered (cell B6) ..... 65

Figure 59: Arithmetic expression entered in the function tool bar for cell B6 ........................ 65

Figure 60: EWF – Complex function available ....................................................................... 66 Figure 61: EWF - Validation rule tool box sample .................................................................. 67 Figure 62: EWF- JAVA window allowing specifying the rule constraints for a cell .............. 67

Figure 63: EWF- Validation rule tool box allowing selecting rule to be removed .................. 68

Figure 64: EWF - JAVA window allowing editing of a rule ................................................... 68 Figure 65: EWF - JAVA window allowing input of validation rules Web Forms .................. 69

Figure 66: EWF - Editing tool box........................................................................................... 69 Figure 67: Past and future reference period’s edition .............................................................. 70 Figure 68: EWF – Publishing a Web Form .............................................................................. 71 Figure 69: EWF – Instantiating a Web Form ........................................................................... 72 Figure 70: Web Form Entry – New Form ................................................................................ 73 Figure 71: Web Form Entry – New Form – Reference period (year) ...................................... 73

Figure 72: Web Form Entry – New Form – Available languages ........................................... 74

Figure 73: Web Form Entry – New Form – Accept ................................................................. 75 Figure 74: EWF – Web Form instance ..................................................................................... 75 Figure 75: Applet signature ...................................................................................................... 76

Figure 76: JAVA applet download ........................................................................................... 76 Figure 77: Second Security Warning ....................................................................................... 77 Figure 78: Form template for refreshing Code List ................................................................. 78 Figure 79: Define export structure ........................................................................................... 79 Figure 80: Selection of table to be exported ............................................................................ 79 Figure 81: Code definition screen for the export table structure .............................................. 80 Figure 82: Form Templates – Modify titles ............................................................................. 81 Figure 83: Form Templates – Modify titles window ............................................................... 81 Figure 84: Main menu for Web Form translation administration ............................................ 81

Figure 85: Web Forms – Codes & Translations ....................................................................... 82 Figure 86: Web Forms – Codes & Translations Form ............................................................. 82

August 2014 Page 5

TABLE OF TABLES

Table 1: Transmission settings to use Web Forms ................................................................... 12 Table 2: Timelines settings to use Web Forms ........................................................................ 13 Table 3: EWF layout area description ...................................................................................... 21 Table 4: Web Form check list .................................................................................................. 27 Table 5: Manage Code Lists – Filter criteria ............................................................................ 29 Table 6: Manage Code Lists – Filter by Code List .................................................................. 30 Table 7: Manage Code Lists –Code List description ............................................................... 30 Table 8: Manage Code Lists – Action buttons ......................................................................... 31 Table 9: Codes & Translations form ........................................................................................ 33 Table 10: Linear Code List Upload – Field description ........................................................... 38 Table 11: Hierarchical Code List Upload – Field description ................................................. 39 Table 12: Form Template – Filters ........................................................................................... 40 Table 13: Form Template – Field description .......................................................................... 41 Table 14: Form Template – Action buttons ............................................................................. 42 Table 15: Form Wizard – General Information - Field description ......................................... 45

Table 16: Form Template – Template Summary - Field description – Part 1 ......................... 49


Table 18: Form Template – Template Summary – Action buttons – Part 1 ............................ 51


Table 20: Form Wizard – General Information - Field description ......................................... 57





August 2014 Page 6

1 INTRODUCTION This manual was created for domain managers using EDAMIS Web Forms. It contains everything a domain manager needs to know in order to use EDAMIS Web Forms. It encompasses basic information on the EDAMIS Web Portal, including how to register in order to send data. It illustrates how to create, publish and maintain Web Forms.

This manual was made available to assist Eurostat production units in the Web Forms implementation phase.

1.1 Background information

EDAMIS : the electronic Data file Administration and Management Information System is the integrated environment for data transmission and for the Single Entry Point for data arriving at Eurostat. It is visible through the following tools:

EWA: The EDAMIS Web Application is installed in the National Statistical Institutes and used for sending statistical data files to Eurostat. Interactive, semi-automated and full-automated transmissions are supported.

EWP: The EDAMIS Web Portal is installed at the European Commission and used for managing the dataset inventory, managing the user rights related to the transmissions, sending statistical data files to Eurostat (as an alternative to EWA) and monitoring the traffic through its Management Information System.

EDAMIS Web Forms is a component of the EDAMIS Web Portal that can be used for transmitting low volumes of data. It offers all the basic functions of EWP and does not require any installation on the PC of the user. EDAMIS Web Forms are typically of interest for the collection of data in statistical domains, in which:

• data volumes are low;

• data collection is currently taking place via spreadsheet-based questionnaires;

• a certain level of data validation before transmission is preferred;

• software installation on client PCs is forbidden;

• a data sharing agreement with international organisations exist.

Local Coordinators: In each National Statistical Institute (NSI), a Local Coordinator (LC) is the main contact point with Eurostat for the effective implementation of electronic data transmission and a contact point for members of their own organisation.

Transmission Coordinators: In each National Statistical Institute (NSI), a Transmission Coordinator (TCO) is responsible for the management of users' rights within EDAMIS. The TCO is in charge of managing and giving rights to users inside its organisation. In NSIs, the TCO is usually the Local Coordinator, while in non-NSIs, a TCO can be nominated. A TCO can be allowed to coordinate users in several organisations of the country, provided that an agreement exists between the organisations concerned.

Data sender and EDAMIS: In each National Statistical Institute, the installed EWA allows the data provider to send data to Eurostat. If the data sender works in another organisation, then the EWP should be used instead. EDAMIS Web Forms are accessible via the EWP. In all cases, the data sender should have an ECAS user-ID and should register with EDAMIS. Further details for EDAMIS and ECAS registration are publicly available in the EDAMIS Help Centre (accessible without login on EWP home page).

August 2014 Page 7

2 BEFORE STARTING, READ THIS FIRST! The roadmap for the development of a new Web Form can be compared to a small project divided in four main phases. Domain managers will be mostly concerned by phases I, II and IV (see Figure 1).

Phase I

Checks and Preparation

Start Here

Step 1: Check the dataset status in the

inventory

1. Dataset transmission mode

Transmission mode: All or web form

entry

Data format: XML

2. Timeline reporting

Max delay should be set

3. DSD and Validation rules

No effect on web form

4. Collect

Active dataset

Step 2: Check dataset links with

countries and organisations

1. For the reporting countries, the link

between the dataset, the country and

the organisation must exists

Step 3: Check the dataset time-table

1. For each country linked the dataset, a

time-table is generated depending on

the dataset transmission frequency

Step 4: Manage grouped Datasets

1. If necessary, create a grouped

dataset.

Step 5: Prepare yourself for creating

the Web Form

1. Collect Code List, codes, translations,

labels, validation rules

2. Prepare the layout and the format of

the future web form

End

Phase II

Web Form Creation

Start Here

Step 1: Create Code List

1. Create Code List

2. Create Label for Code List

3. Associate label to Code List

Step 2: Create a Web Form

1. Wiz 1: Provide general information

2. Wiz 2: Define table

3. Wiz 3: Define Code List position

Step 3: Edit the Web Form

1. Define all cells format

2. Define simple arithmetic expressions

3. Define validation rules

Step 4: Publish the Web form

1. Publish the web form to all users

End

Phase III

Active Web Form

Start Here

Step 1: Instantiate a Web Form

1. Instantiation a web form

Step 2: Enter data in the Web Form

1. Fulfilling the web form instance

Step 3: Sending data

1. Performing an official transfer

2. Instantiation of the next reporting

period

End

Phase IV

Web Form Maintenance

Start here

Maintaining a Web Form

1. Add, modify, copy Code List, label,

table, form

2. Add, modify, copy validation rules

3. Change layout and format

End

Figure 1: The EWF roadmap

Phase I concerns all checks and preparations required before starting the creation of a new Web Form. It is divided into four linear steps, in which steps 1 to 4 identify the needed requirements at the level of the EDAMIS inventory, while the final step concerns the layout of the Web Form, the validation rules to be applied, the structure of the Web Form, the used Code Lists, the use of flags and special values and the future relationships with the data production system of the production unit. Therefore, to avoid pitfalls, it is important to spend enough time on phase I and especially on step 4 of this phase.

August 2014 Page 8

Phase II addresses the definition of the identified components of the new Web Form. It explains again in four steps: how to create Code Lists and associated codes (step 1), how to create a new Web Form based on the newly created or already existing Code Lists (step 2) and how to edit the new created Web Form in order to define cells format, simple arithmetic expressions and validation rules (step 3). The last step is related to the publication of the Web Form, which makes it available to the data providers’ community. At the end of this phase, the defined Web Form will look like the example below (see Figure 2) and this is the way it will be seen by data providers.

Figure 2: EWF example

During phase III, the data providers will start to send instances of Web Forms. On the other hand, domain managers will collect and monitor the sent data, validate and process the data content. This phase is looping, until the data collection process comes to an end or until an update of the Web Form is done.

Phase IV explains how to maintain existing Web Forms, update Code Lists and how to maintain codes translation.

In the following lines, the reader will recognise the structure, as presented in figure 1 with detailed information related to each individual step. It is supposed that domain managers have a basic knowledge of the EDAMIS inventory and its management but also that they are acquainted with EDAMIS principles and the vocabulary used in this context.

Further details can be found in the EDAMIS Help Centre (see note).

� EDAMIS Help Centre and Support

Note A set of comprehensive documents are available at the EDAMIS Help Centre. You can access the EDAMIS Help Centre through the following link:

https://webgate.ec.europa.eu/edamis/helpcenter/website/index.htm

The support team will be happy to help if you have any questions or should you want to report any incidents. Mail to: [email protected] Tel: (+352) 430133213

August 2014 Page 9

3 PHASE I: CHECKS AND PREPARATION Throughout this phase, the domain manager will find out how to check the status of the dataset, to which the new Web Form will be attached, what the initial questions to answer are and what the initial material required is before starting to create the new Web Form online.

3.1 STEP 1: CHECK THE DATASET STATUS IN THE EDAMIS INVENTORY

In order to develop Web Forms, some initial parameters at the level of the dataset should be correctly defined. The transmission mode, the data format, the maximum delay are the minimal conditions (the dataset should be active), which should at least be met. In most cases, these conditions already exist and the domain manager should only verify them.

To access the EDAMIS Web Portal, type in the following URL into the address bar of your web browser and press ENTER:

https://webgate.ec.europa.eu/edamis The site appears, as follows (see Figure 3):

Figure 3: EWF login form

Click on the [ECAS authentication] button; you will be redirected to the ECAS login page.

For this guide’s purpose, it is assumed that the reader (EDAMIS Domain Manager) has an ECAS user account in the domain of “European Commission”. If it is not the case or you are not familiar with ECAS, please contact the EDAMIS support for further instructions.

Enter your ECAS username (or email address) and password, click on the [Login] button and after having been authentified successfully, you are back on the EDAMIS Interface.

The Welcome page now appears (see Figure 4):

August 2014 Page 10

Figure 4: EWF welcome page

The Welcome page presents you with a summary table of recent data transmissions via the Web Portal, a number of user menu options (Transmission, Reports, Inventory, Workflow, User/Rights, Administration, Preferences, Sitemap and Logout) and some links (e.g. the EDAMIS Help Centre). Some information about these various features of the Portal is given in the EDAMIS Help Centre. But to use and maintain the Web Forms, the only important feature at that point is the Inventory menu.

Select Inventory in the navigation bar and select Manage Datasets from the drop-down list (see Figure 5).

Select Manage Datasets

Figure 5: Manage datasets menu

The Manage Dataset page now appears. By default, the Dataset drop-down box is set to your own pre-defined scope depending on the unit and the domains of the domain manager (see Figure 6). The icon labelled ‘A’, which is behind the dataset name, indicates that the dataset is active. It means that everything was set up correctly in EDAMIS for data collection. If the dataset is not active, the domain manager must tick the box related to the dataset and must click on the ‘Request Activate’ button. This action will inform the EDAMIS administrator that the dataset must be activated.

August 2014 Page 11

Figure 6: Manage datasets page

In the dataset list, one Domain Manager can click on the dataset name in order to get the manage dataset form, in which the correct setting of the Web Forms dataset parameters could be verified(see Figure 7). The manage datasets form is composed of six sections that the DMA must check, i.e. the dataset identification (see Figure 7), the transmission (see Figure 8), the timelines (see Figure 9).

Figure 7: Manage datasets form

The parameters of the dataset that the domain manager must check for the Web Forms usage are linked to the transmission and to the timelines panels. Only these 2 panels are presented below. To have more information related to the dataset, the specialised user guide for DMA should be consulted.

3.1.1 Section ‘Transmission’

The DMA will use this section to specify the ‘Obligation to send/receive’ flag, the ‘Possible exceptions’, the data ‘transmission mode’ (see Figure 8) and the ‘Do not allow forced transmission for this dataset’ flag.

Figure 8: Manage datasets form - Transmission

For the usage of Web Forms, the transmission mode and the delivery format must be checked.

1 Transmission mode

Send data This transmission mode is used for normal data transmissions, when using the EDAMIS Web Portal. It allows the transmission of any data

August 2014 Page 12

file of any format.

Web Form This transmission mode is selected, when Web Forms are used for data transmissions.

All Allows both transmission mode ‘Send data’ and ‘Web Form’.

The choice of ‘All’ or ‘Web Form’ will enable the Web Form functionalities in the EDAMIS Web Portal. ‘All’ will avoid problems for providers that cannot send data via Web Forms.

2 Delivery format

CSV This is the output format which will be used for data delivery in the production units.

XML As Web Form are based on SDMX-ML, the output format of delivered data in the production unit should be SDMX-ML compliant.

Max Web Form table

This number corresponds to the maximum sheets which can be contained in the Web Form.

XML must be chosen as data format in order to work with Web Forms and it is recommended to use only one table per Web Form, which will further allow a better monitoring of the transmissions.

Table 1: Transmission settings to use Web Forms

3.1.2 Section ‘Timelines’

This section allows the DMA to specify all required information, which enable EDAMIS to calculate the timetable of occurrences for a dataset. It is also the section, which permits the DMA to send automatic reminders based on calculated deadlines (see Figure 9).

Figure 9: Manage datasets form - Timelines

For the usage of Web Forms, the ‘First reference period’, the ‘Last reference period’, the ‘Time table calculated for the next’, the ‘End of the first reference period’ and the ‘Maximum delay’ must be carefully checked.

1 First reference period

Unit/Year The first reference period of the dataset will set the lowest limit of the

August 2014 Page 13

timetable. It is composed of a ‘Unit’, which depends on the periodicity of the dataset and a ‘Year’. For example, for a quarterly dataset, the first reference period could be ‘Q1’ – ‘2009’.

The first reference period must be set in order to populate the time table.

2 Last reference period

Unit/Year The last reference period of the dataset will set the highest limit of the timetable. It is composed of a ‘Unit’, which depends on the periodicity of the dataset and a ‘Year’. For example, for a monthly dataset, the last reference period could be ‘Dec’ – ‘2019’.

The first reference period must be set in order to populate the time table.

3 Timetable calculated for the next

Year The complete population of the time table depends on the spread defined by the first reference period (lowest limit) and the last reference period (highest limit). As this spread could be set as large in order to optimise calculation of the time table, it is possible to partially populate the time table for one or two year(s) or more inside the spread.

At the end of each year, the timetable will automatically be extended to another year, provided that the next year is located inside the spread defined by the first and last year of the reference period.

The time table must be calculated at least for the following year. It must be noted that the time table could be calculated beyond the limit defined by the last reference period depending on other parameters which serve to determinate the dates of the time table.

4 End of first reference period

Unit/Year This parameter sets the end of the first reference period of the dataset. By default, EDAMIS sets it to the end of a entire period, e.g. end of the month, end of the quarter or end of the year. By setting this parameter to a different value, it introduces a shift in the calculation of the time table.

The end of the first reference period is usually left to its default value as proposed by EDAMIS.

5 Maximum delay

Month/Day The maximum delay should be set to a not null value for the generation of the time table which is required for the use of Web Forms.

The maximum delay should be set to any, but not null, value in order to populate the time table.

Table 2: Timelines settings to use Web Forms

The [Timetable preview] button gives a graphical preview of the calculated time table based on dataset parameters.

The automatic reminders, when they are used, warn the data senders before the deadline, on the day of the deadline and several times after the deadline, inviting them to send the data file corresponding to the dataset occurrence.

August 2014 Page 14

August 2014 Page 15

3.2 STEP 2: CHECK DATASET LINKS WITH COUNTRIES AND ORGANISATIONS

Select Inventory in the navigation bar and select Manage Links Datasets and Countries from the drop-down list (see Figure 10).

Select Manage Links Datasets and Countries

Figure 10: Manage links datasets and countries menu

The Manage Links Datasets and Countries page now appears. By default, the Eurostat Unit is preset to the unit of the domain manager. The domain and dataset drop-down boxes are set to ‘--- all domains ---’ and ‘--- all datasets ---’ depending on the domains and datasets, for which the domain manager is responsible (see Figure 11).

Figure 11: Manage links datasets and countries form

The domain manager can create a new link dataset country, by clicking on the [New] button and fill in the form. It must be noted that only the Sender and Sender/Receiver organisation were able to send the web form. To have more information related to the link dataset and country functionality, the specialised user guide for DMA should be consulted.

August 2014 Page 16

3.3 STEP 3: CHECK THE DATASET TIMETABLE

In the Manage Dataset form, section ‘Timeline’ (see Figure 9), by clicking on the [Detailed Timetable by occurrences] button, the Manage Datasets page appears (see Figure 12).

Figure 12: Manage datasets - Detailed timetable by occurrences input form

By default, drop-down lists are populated with ‘--- all countries ---’, ‘--- all organisations ---’ and ‘--- all years ---’. By clicking on the [View] button, the domain manager gets the complete time table. This can be narrowed by specifying a country and/or a year before clicking on the [View] button (see Figure 13). The country drop-down list of the dataset occurrences timetable form is populated according to the existence of the link between the dataset, the country and the reporting organisation. If a country is not in the list, it must be added via the creation of a link dataset with the country and the organisation, as described in step 2 of phase I.

Figure 13: Manage datasets – Detailed timetable by occurrences

The time table above was generated automatically by EDAMIS on the basis of several dataset parameters. It contains information which will be used as the basis to trigger events, such as reminders, in the calculation of calendars or as the basis for the calculation in reports (data file traffic report). It is based on several parameters, such as the periodicity of transmissions, the end of the reference period, the maximum delay and it generates indicative deadlines.

The domain manager can adjust each line of the timetable, if required, by entering a new indicative deadline. Finally, the [Save] button should be clicked to store the updated timetable. It should be noted that no timetable is generated for non-periodic datasets (very limited cases) and hence no use of Web Forms for this type of dataset is possible.

August 2014 Page 17

3.4 STEP 4: Manage grouped dataset

This functionality allows the user to create datasets groups. The groups are used in the EWF application, allowing the user to send templates not only for each dataset separately but for a group of datasets all together. The datasets to be associated will now have to:

• belong to the same domain • have the same data periodicity • not be already associated to another grouped dataset • have the same transmission mode (only “WF only” or ‘ALL’ transmission mode) • have a template where a single table is defined or no template at all • have the same periodicity of transmission • have the same maximum delay • have the same end of reference period

Users supposed to use grouped dataset should have the same rights on all the dataset of the group. Otherwise, they won’t be able to use it. To access to the related menu, select Inventory in the navigation bar and select Manage Grouped dataset from the drop-down list (see Figure 14: Manage Grouped Datasets – Grouped Dataset list).

Figure 14: Manage Grouped Datasets – Grouped Dataset list

The Manage Grouped Datasets page now appears.

The domain manager can create a new grouped dataset by clicking on the [Insert a new grouped dataset form] button and fill in the form (the free Text, the periodicity for data and the description). (See Figure 15).

August 2014 Page 18

Figure 15: Manage Grouped Datasets – Edit or create Grouped Dataset

When the fields are filled in, the DMA clicks on the [Associate] button. A new form is displayed and the selection of the dataset can be done by checking the boxes near the dataset and clicking again on the [Associate] button (see Figure 16 ).


The DMA can now associate or dissociate other datasets to the group. If the datasets are definitively selected, he clicks on the [Save] button (see Figure 17 and Figure 18).

August 2014 Page 19

Figure 17: Manage Grouped Datasets – Edit or create Grouped Dataset


To update a grouped dataset, the user must select it from the list and click on its name. The Update form is displayed. The Update form is the same as the “Add new” form, but all the values are already pre-filled. The user can modify:

• the Free text; • the Periodicity (if no datasets are associated with this group only); • the Description.

The user can also associate or dissociate datasets, similarly as when creating new grouped datasets. To delete a group, the user has to select it from the list (check the box) and press the “Delete” button.

3.5 STEP 5: PREPARE YOURSELF TO CREATE THE WEB FORM

3.5.1 Layout of the Web Form

This is a very important step in the definition process of a new Web Form. The Web Form is composed of several areas, as presented below (see Figure 19). During the phase II, the domain manager will successively create and populate the Web Form template associated to the dataset.

August 2014 Page 20

1

2

3

45

6

7

89

10

11

12

13

14

15

Figure 19: EWF – Layout area

1 Header area

The Header area will contain all the applicable reference information for the opened web form instance.

2 Columns of the form

These are the columns headings of the form, combined with rows; it refers to each individual cell position in the form (e.g.: B6).

3 Reporting reference periods

These are the reporting reference periods of the form.

4 Rows of the form

These are the rows headings of the form, combined with columns; it refers to each individual cell position in the form (e.g.: B6).

5 Position of a cell in the form containing a value

This is the position of cell B5 and it contains the value ‘14.169’. Note that the period is used as a decimal code.

6 Data entry area for a reporting period

The data entry consists of a fixed number of data entry cells, each defined by its row and column headings.

7 Vertical scroll bar

This allows to perform a vertical scrolling in the form.

8 Code List

August 2014 Page 21

This is a list of all the various characteristics captured in the field of ‘Slaughterhouses’.

9 Flagged data

Flags can only be entered in the flag column. Only one flag can be assigned to each flag cell.

10 Horizontal scroll bar

This allows an horizontal scrolling in the form.

11 Footnote area containing admitted special values and flags

This area contains a description of the permitted special values and flags and their descriptions.

12 Tabs

Defines the various tables that may exist in a form.

13 Control bar

The control bar consists of four separate components: two information fields and two function buttons.

14 Task buttons

There are nine different task buttons, each of which has a function.

15 Status bar

This is the location, where the server puts messages to the attention of the user. For instance, it confirms that a form has been saved or officially transferred.

Table 3: EWF layout area description

August 2014 Page 22

3.5.2 Check list of elements to collect and questions to answer before starting

There are several necessary elements to consider before starting to develop Web Forms. In the check list below, the domain manager will find questions and answers which will facilitate the preparation for the creation of a new Web Form. All questions in this check list might not be relevant to all domains and all units. They only intend to open the mind and so, to be a basis for the preparation.

Are there elements in the official regulations, which would influence the design and the content of the Web Form, the code lists used, the codes, the reserved names, the validation rules, special values to consider, flags to be used, colour code convention…?

� Check carefully what could impact the Web Form.

Are there official lists, which will be used for the code lists creation? Do I have all codes and corresponding labels? Is this available on paper or in an electronic format?

� Web Forms use Code lists, which will serve as rows and / or columns headers. Code lists are composed of codes ID and codes, which provide the textual description of the code.

1. The length of the description should not be too long, as it will appear as such in the Web Form on the horizontal and/or vertical axis.

2. The number of items contained in the Code lists should not exceed a reasonable number, even though there is no technical limit, but it will influence the presentation of the Web Form for the end-user.

3. It is possible to use up to five Code lists in the same Web Form. However, it should be kept in mind that the number of cells in the Web Form for one reporting period is the result of the cardinal product of the number of items in each Code lists. For example, five Code lists, containing ten items each, will result into one hundred thousand cells! There is no technical limit, except the capacity of the end-user PC memory to load all data, but in practise, the presentation of the Web Form to the end-user should be considered. If such a situation appears, it is highly recommended to publish several smaller Web Forms with one or two Code lists.

4. Each Code lists will equate to a dimension of the Web Form, except the Code lists special values and flags.

5. It is possible to create a new Code lists via the importation of data from a file formatted in a CSV format (see paragraph ‘4.1.4 Import of Code Lists’ – Page 37).

August 2014 Page 23

Does the Web Form contain special values and / or flags? If, yes, do I have a complete list of special values and flags used in the Web Form?

� Flags are special characters, which will be displayed behind a cell of the Web Form in a drop-down list box (for example, it can be ‘C’ for confidential data, ‘p’ for provisional data and so on). As it is allowed to enter special values directly in a cell of the Web Form, it is, for instance, possible to find a colon ‘:’ or more generally, a symbol not consisting in a figure.

In both cases, these Code lists do not count as a dimension of the Web Form.

What are the sizes and the type (linear, hierarchical, code list) of the used Code lists?

� There are five different types of Code lists: linear, hierarchical, flags, special values and list of codes. For linear Code lists, one code corresponds to one code and all elements have the same weight.

For hierarchical Code lists, it is nearly the same: a code corresponds to one code but items of the Code list are ranked. It is possible to sum up items ranked at lower levels with higher ranked items. For example, the sum of values for codes 1.1 and 1.2 of a Code list can be made available under code 1, which is a level hierarchically above codes 1.1 and 1.2.

Lists of codes appear in the form of a drop-down list box of limited values. It can be something like ‘YES’ or ‘NO’, ‘10’ to ‘20’. It is not possible to enter another value than the one, which was declared in the List of codes.

Special values represent a set of allowed values that can be used in a cell, such as “NA” for “Not Applicable” or “ND” for “Not Defined”.

Flags represent additional information that can be added to a value. In a form template, an additional column is created for each column of data. We can add this value in this new column.. Flags also appear in the form of a drop-down list box of limited values.

In any case, the domain manager should keep in mind that the Code lists will have a direct incidence on the future design of a Web Form but also thatthe ergonomic aspects for the end-user in terms of size and of used Code lists will be affected.

August 2014 Page 24

Will the used Code lists be generic for the statistical theme, for the domain or specific to the dataset?

� Code lists can be generic, i.e. available for all Web Forms at the Eurostat level or can be attached to a statistical theme, which will make them usable for all datasets linked to the statistical domain or assigned to a domain and finally associated to a particular dataset. To guarantee an easy management, it is recommended to give a name to a Code list according to the object it is attached to. For example, ‘65-ANI-SLAUGHT_M_A-FLAG-SERIE1’ might indicate that this Code list should be defined for a particular dataset, but there is no obligation. A dedicated report of EDAMIS provides the list of existing Code lists and the level, to which there are attached.

Once a Code list is attached to a published Web Form , the Code list can be updated and can be refreshed at the level of the Web Form. Nevertheless, this action could have peripheral effects in terms of calculation of validation rules and formats of the Web Form, especially if an item is inserted or deleted in the Code list. Therefore, it is recommended to attach special cares to the Code list definition, before publishing the Web Form.

Will the Web Form contain more than one table? Will these tables use the same Code lists?

� In a Web Form, there might be several tables. Each table corresponds to a Web Form inside the same dataset. Each table could use its own Code list or could use the Code list of another table. For reporting purposes, it is recommended to attach one Web Form to a dataset using only one table. It should be noted that table name could not contain numbers, blanks and spaces.

Will the Web Form contain mandatory values (cells)?

� The domain manager should identify all the cells that are mandatory in the Web Form. Later, when the Web Form is published, this will have an influence on the [official transfer] button, which means that the data sender will not be allowed to leave these cells empty.

Will there be arithmetic operations performed in the Web Form?

� As it occurs in spreadsheets, arithmetic operations are possible in Web Form. The domain manager should identify all formulas, which will further be used in the Web Form.

August 2014 Page 25

Will validation rules be used in the Web Form? If yes, when a rule is not fulfilled, will the error be ‘basic’ or ‘critical’ and what will be the error message to be provided to the data provider?

� Validation rules can be declared in a Web Form. These rules are linked to a cell and might be different from country to country. Whenever a validation rule is defined and the rule is not fulfilled, an error status is generated. The error might be ‘basic’ or ‘critical’.

Once it is ‘basic’, the data sender will be informed via a message that the validation rule is broken, but the data sender will be able to overrule by providing a ‘justification’.

Once it is ‘critical’, the data sender will be informed via a message that the validation rule is broken, but in this case, the data sender will not be able to overrule by providing a ‘justification’ and the [Official transfer] button will be disabled (greyed). The data sender will have to fulfil the validation rule.

Domain manager should have a clear view of what will be ‘basic’ or ‘critical’; which validation rules will be used for which cell and for which country and which message will be provided to the end-user in case a rule is not fulfilled.

Are these validation rules all the same for all reporting countries?

� Validation rules are attached to a cell of a Web Form and are country dependent. This allows the domain manager to define adapted validation rules for particular countries, if it is needed. For example, threshold can be different, error can be basic or critical; or simply the rule does not apply for one or two or several countries.

The domain manager is invited to have a clear view of the exceptions, in which validation rules are used.

Will there be estimated data to be filled in the Web Form before publishing it?

� In certain cases, it might be interesting to provide ‘estimated’ data to the data providers. If this is the case, the domain manager should include this data in the Web Form. This can be done manually or via an import function (see paragraph ‘4.4.6 Import of estimated data in Web Forms’ – Page 70).

When the Web Form is published, it will appear in a pre-filled shape, with the values given by the domain manager. After the instantiation of the Web Form, a status ‘estimated’ instead of ‘draft’ appears. The data sender will be able to see the estimated values and to modify them.

August 2014 Page 26

Does the Web Form design require particular attributes in terms of used colour and fonts? Are there special conventions?

� As it is possible to give attributes to a cell or to the several components of the Web Form, i.e. colours, fonts type, fonts size, bold, italic, underlined and so on, one can imagine that these attributes have a meaning and therefore, that the domain manager should define a ‘code’ (for example, totals in a Web Form can be in cells with a yellow background with black fonts in bold and underlined). All these conventions should be defined. It is also recommended to verify whether the used colours do not alter the readability of the Web Form, esp. when the Web Form is printed in black and white.

Will the design of the Web Form be optimised in terms of used cell?

� In some cases, it might be necessary to adapt existing spreadsheets to the Web Form, esp. if several Code lists are used, if the spreadsheet contains a huge amount of cells, etc.. There are no rules in this area: it differs from domain to domain.

The most important criteria to keep in mind are the following:

1. the response-time for the end-user: the higher the amount of data to be loaded, the longer it will need to download;

2. the complexity of the Web Form, which will be presented to the end-user: the simpler the Web Form, the beter it is;

3. the screen size is limited: the browser is loaded and inside the applet displaying the Web Form, the Web Form is itself divided in several area (see Fig 14).

Will the data collected via Web Form be exported to a production database and are the export codes the same as the default codes of the Code list?

� Once the Web Forms are transferred to EDAMIS, it is possible for domain managers to export the content of the Web Form in order to load the exported data in the production environment of the unit. In that case, the domain manager should take care of the existing import procedures and should know which codes will be used for loading the exported file. By default, when creating a Code list, the code, which is displayed in the Web Form, and the code used for the export of the data are the same. When the codes are different, they need to be defined, when the Code list is created.

August 2014 Page 27

Will the Web Form be published in more than one language and if so, do I have access to the translations of the used codes, end-user messages (validation)?

� It is possible to use several languages, when using the Web Forms. This implies to have all the required translations before the creation of the Code lists and the Web Form. It has also an impact on the layout of the Web Form, as the description of used codes could significantly increase according to the used language. Descriptions in English are usually shorter than these in French or German, which will influence the display of the Web Form.

Table 4: Web Form check list

August 2014 Page 28

4 PHASE II: THE WEB FORM CREATION

The creation of a new Web Form consists of four steps; each step being recursive whenever necessary. With all the prepared material, the domain manager can start to build the new Web Form. It starts with the definition of at least one Code list, with default codes and codes associated to it. Then, the creation of the Web Form will take place where general information about the Web Form will be given, tables will be defined (at least one) and finally, the Code list will be placed in the Web Form in row or in column. This will complete the Web Form definition and its global presentation.

Once this is done the Web Form will be edited, all cells attributes will be set, all needed simple arithmetic expressions and validation rules will be defined and at the end of the creation process, the Web Form will be published. The following text explains how it flows.

4.1 STEP 1: CREATE CODE LIST

4.1.1 Create a Code list

Select Inventory in the navigation bar and select Manage Code Lists from the drop-down

list (see Figure 20: Manage Code lists - Menu).

Select Manage Code lists

Figure 20: Manage Code lists - Menu

The Manage Code Lists page now appears. By default, the theme, the domain and the dataset drop-down boxes are set to ‘--- all themes ---’, ‘--- all domains ---’ and ‘--- all datasets ---’ (see Figure 21). The list of Code lists can be narrowed by selecting a theme, a domain and a dataset or by filtering according to the Code Lists name or description. The number of available pages is indicated at the bottom right of the page. The domain manager can navigate by clicking on the arrows located at the bottom left of the page or by entering directly a chosen page number in the ‘Go to:’ and by clicking on the ‘[Go!]’ button.

August 2014 Page 29

Figure 21: Manage Code Lists menu

For example, one DMA can select theme ‘6.04’ or chose to go on page 5 (see Figure 22).

Figure 22: Manage Code Lists – Filtered by theme

1 Selection area

The selection area allows the domain manager to shorten the list of Code Lists by means of filters on theme, domain and dataset.

Table 5: Manage Code Lists – Filter criteria

August 2014 Page 30

1 Code Lists filter

The selection area allows the domain manager to shorten the list of Code Lists by entering the Code Lists name or description. The page must be refreshed by clicking on the [Code List filter] button.

Table 6: Manage Code Lists – Filter by Code List

1 Check box

These check boxes enable the selection of one or several Code Lists, on which an operation will be performed. To copy a Code List, only one box should be checked; to delete several Code Lists, several boxes can be checked.

2 Code Lists

This is the name of the Code List. The name uniquely identifies a Code List. It is recommended to use a name, which informs about the content of the Code List (for example, theme number, domain name, dataset name, content description). This will facilitate the recognition of the Code List later on.

3 Theme

This indicates the theme, to which the Code List is attached. When there is no theme attached to the Code List, this means that the Code List is generic and used at the level of Eurostat.

4 Domain

This indicates the domain, to which the Code List is attached. When there is no domain attached to the Code List, this means that the Code List is available for all domains under the theme.

5 Dataset

This indicates the dataset, to which the Code List is attached. When there is no dataset attached to the Code List, this means that the Code List is available for all datasets under the domain.

6 Type

This provides information about the type of Code List, linear, hierarchical, special values or flags.

7 Number of lines

This indicates the number of codes that are contained in the Code List. This allows to anticipate the final size of the Web Form in terms of number of cells. This helps to see whether several Code Lists can be combined without exploding the number of cells used in the Web Form.

Table 7: Manage Code Lists –Code List description

1 [Import Code List] button

August 2014 Page 31

This allows to import Code Lists from a structured CSV-formatted file. This functionality is particularly interesting when the Code List contains a lot of items or when the Code List is translated in several languages (see paragraph ‘4.1.4 Import of Code Lists’ – Page 37).

2 [Copy] button

This function allows to copy an existing Code List with all its codes. The copy of the Code List can be edited and updated and once saved be used in Web Forms.

3 [Insert a Code List] button

This function allows to create a completely new Code List of any type.

4 [Delete] button

This function allows to delete obsolete Code Lists.

Table 8: Manage Code Lists – Action buttons

By clicking directly on the hyperlink of the name of the Code List, the domain manager can edit it and manage the associated codes.

From the manage Code List (see Figure 22), the domain manager clicks on [Insert a Code List] button and at that point, it is possible to create a new Code List. Depending on the level, to which the Code List must be attached, the domain manager will specify the theme, the domain and the dataset. If these parameters are omitted, the Code List will then be generic for all Eurostat units. If the theme is specified, the Code List will then be available for all units using this theme, and similarly for the domain and dataset.

Then, a name will be given to the Code List, the name is unique and mandatory, as indicated by the red asterisks (see Figure 23) as well as the type and the description of the Code List.

Figure 23: Manage Code Lists –Code Lists List

Once the form is complete, the domain manager can ‘save’ the empty Code List by clicking on the [Save] button or can directly start to populate the Code List by associating codes using the [Associate code] button (see Figure 24).

August 2014 Page 32

Figure 24: Manage Code List - Form

Let’s choose “Associate code” to directly associate codes to the Code List by clicking on the [Associate code] button, which generates the page ‘Manage Code Lists – Codes Association’ (see Figure 25).

Figure 25: Manage Code Lists – Codes Association

At the top of this page, the Code List information is displayed and is disabled. The [Code filter] button allows to narrow the list of codes.

The domain manager can choose to use defined codes by selecting the check boxes in front of them and clicking on the [Associate] button to directly associate selected codes to the new Code List or can decide to create new codes by clicking on the [Insert a code] button.

August 2014 Page 33

4.1.2 Create codes for Code Lists

Being in the ‘Manage Code Lists – Code Association’ page, the domain manager chooses to click on the [Insert a code] button, which opens the page ‘Codes & Translations’ (see Figure 26).

Figure 26: Codes & Translations

1 Code

This is the code name. EDAMIS suggests the first part of the name but the domain manager is free to keep it or not.

2 Default Code

This is the default code associated to the code name.

3 Default Export Code

This is the default export code associated to the code name.

4 Active check box

This activates the field for the description of the code in the available languages. In this example, there are three languages available. The other languages will appear if they were defined previously in the Administration main menu (see paragraph ‘6.1.5 Translation’ – Page 81).

5 Language

This provides the list of possible languages to be used.

6 Description

This extensively describes the code. As the code description is a part of the Code List, it will appear in the Web Form. Therefore, it is recommended to limit the length of the description to a reasonable number of characters. This will have a direct impact on the layout of the Web Form.

7 Save

Once the ‘Codes & Translation’ page is competed, the domain manager then clicks on the [Save] button to complete the code definition.

Table 9: Codes & Translations form

August 2014 Page 34

In the example (see Figure 27), the name of the code was given and descriptions in English, French and German were provided.

Figure 27: Codes & Translations – EN/FR/DE

By clicking on the [Save] button, EDAMIS confirms that the code is created (see Figure 28).

Figure 28: Message from webpage

The code appears now in the list of codes (see Figure 29).

Figure 29: Manage Code Lists – Codes Association – New code

� Repeated operation

Note The step 1, ‘create Code List’ might be repeated several times until all Code Lists and all codes are created. The import Code List in structured CSV-formatted files avoids these repetitive tasks.

August 2014 Page 35

4.1.3 Associate codes to Code Lists

Once the Code List and the codes are defined, it is possible to associate the codes to the Code List by selecting one or several required codes in the ‘Manage Code List – Codes association’ list and by clicking on the [Associate] button (see Figure 30).

Figure 30: Manage Code Lists – Codes Association – New code selected

EDAMIS confirms that a code was associated to the Code List (see Figure 31). Now, to complete the creation of the Code List, a default code and an export code (by default the same as the code) must be provided (see Figure 32).

Figure 31: EDAMIS message from webpage

Figure 32: Manage Code Lists – Code Lists list

August 2014 Page 36

By default, the code is available for ‘ALL’ countries, as indicated in the bottom right corner. Nevertheless, it is possible to associate a code to a Code List only for one or more countries by selecting the corresponding country in the drop-down list box. In practice, this means that this code will only be seen in the Web Forms using this Code List by countries that are present under the column ‘Country’.

Once completed, the domain manager clicks on the [Save] button, which finalizes the creation of the Code List. EDAMIS confirms this by an end-user message (see Figure 33).

Figure 33: EDAMIS message from webpage – Code List

� Dissociate code

Note This [Dissociate code] button allows the withdrawal of a code from a Code List. It deletes neither the code nor the dataset.

August 2014 Page 37

At the end of the process of Code List creation with the code, description and order, the item 8 of Figure 19 will be ready (see Figure 34).

8

Figure 34: EWF layout – Code List

4.1.4 Import of Code Lists

From the main menu bar, select ‘Inventory’ and then, sub-menu ‘Manage Code List’ to get the Manage Code List page. Then, by clicking on the [Import Code List] button, the import Code List page is served (see Figure 35), which invites the domain manager to browse the local directory and to provide the structured CSV-formatted file, in which the Code List is defined.

Figure 35: Import Code List page

Once the file is selected, by clicking on the [Upload] button, the file will be imported and the corresponding Code List will be created.

The file consists of a single header line containing information to define the Code List, followed by a number of lines containing information to define codes associated with the Code List. Each line contains data items separated by semi-colons.

August 2014 Page 38

The header line has the following format: THEME, DOMAIN, DATASET, CODE LIST CODE, TYPE, DESCRIPTION and COMMENTS.

1 THEME

The code for the theme associated with the Code List.

2 DOMAIN

The code for the domain associated with the Code List.

3 DATASET

The code for the dataset associated with the Code List.

4 CODE LIST CODE

The code to identify the imported Code List.

5 TYPE

The type of the Code List. One of the values L, H, F, C, S, representing respectively a Linear Dimension, a Hierarchical Dimension, Flags, Codes List or Special Values.

6 DESCRIPTION

The description for the Code List (in English).

7 COMMENT

Comments for the Code List.

Table 10: Linear Code List Upload – Field description

For example, a linear Code List would look like this (see Figure 36).

Figure 36: Linear Code List sample

� Empty value for the header line.

Note In the header line of the Code List, for the fields THEME, DOMAIN and DATASET, when the Code List is not associated to a theme, a domain or a dataset, the corresponding fields might be empty.

� Import functionality only available in English.

Note The import Code List procedure currently restricted to Code Lists in English.

August 2014 Page 39

Each code line has the following format: CODE, DESCRIPTION, SORT ORDER, DEFAULT CODE, EXPORT CODE and COUNTRY CODES/SUM.

1 CODE

The code (i.e. the key to the translated value).

2 DESCRIPTION

A description for the code. If an existing code is to be used, this value must be empty.

3 SORT ORDER

The sort order. This is important for hierarchical dimensions. The hierarchy is represented as, for example: 1 1.1 1.1.1 1.1.2 1.2 2 2.1 etc

The code lines in the import file must be sorted in the hierarchical order.

4 DEFAULT CODE

The code for the data item.

5 EXPORT CODE

The export code for the data item.

6 COUNTRY CODES

This contains a list of two-letter country codes for the countries associated with the code. The country codes must be separated by commas.

7 SUM (optional)

For a Hierarchical Dimension, this contains Y if the code is linked to a summation or N, if not.

Table 11: Hierarchical Code List Upload – Field description

For example, a hierarchical Code List would look like this (see Figure 37).

Figure 37: Hierarchical Code List sample

August 2014 Page 40

4.2 STEP 2: CREATE A WEB FORM WITH NO DSD

Select Inventory in the navigation bar and select Form Template from the drop-down list (see Figure 38).

Select Form Templates

Figure 38: Form Templates - Menu

The Form Template page now appears. By default, the theme, the domain and the dataset drop-down boxes are set to ‘--- all themes ---’, ‘--- all domains ---’ and ‘--- all datasets ---’, unless there is only one existing dataset (see Figure 39).

Figure 39: Form Templates - Form

The number of available pages is indicated at the bottom right of the page. The domain manager can navigate by clicking on the arrows located at the bottom left of the page or by entering directly a chosen page number in the ‘Go to:’ and by clicking on the ‘[Go!]’ button.

The tables below describe the Form Template, i.e. the filters (see Table 12), the fields description (see Table 13) and the possible actions (see Table 14).

1 Selections

This populates the Form Template list on the basis of the selections for the theme, domain, grouped datasets and dataset.

Table 12: Form Template – Filters

August 2014 Page 41

1 Form template check box selection

This allows to select one or more forms templates in the list, before performing an authorised action: the deletion of several forms templates for example.

2 Dataset

This is the dataset name, as it is defined in the EDAMIS inventory.

3 Form template

This is the form template name associated to the dataset.

4 DSD

Specifies the name of the DSD used in the Form Template (if a DSD is used).

5 Lock

The form template can be ‘locked’ or not. When a form template is ‘locked’, which is indicated with a small red lock in the column, only the owner can access the form template in order to manage it. All other users will only be able to edit the form in a ‘read only’ mode, to copy the form template or to edit it.

When the form template is published and active, it is automatically ‘unlocked’.

6 Creation

This is the date time group, which indicates when a user created the form template.

7 Modification

This is the date time group, which indicates when a user modified the form template.

8 Active

This flag informs when the form was published and is visible by the data providers’ community. Only one form template can be published at a given time.

9 Used

This meter counts the number of times that the form template was used, i.e. the number of times this form template was initiated. The higher it is, the more it is used. This gives an indication of the probable consequences, if the form template was changed or remains unpublished.

Table 13: Form Template – Field description

1 [Modify titles] button

The [Modify titles] button allows to update both titles 1 and 2 of the selected form template.

August 2014 Page 42

2 [Lock]button

The [Lock] button allows to lock a form template by a user in order to be able to manage the corresponding form template; otherwise it is editable in a ‘read only’ mode.

3 [Unlock] button

The [Unlock] button allows to unlock a form template and make it available for other users who may lock it again.

4 [Copy] button

The [Copy] button allows to copy a form template in order to modify it.

5 [Copy to another dataset] button

The [Copy to another dataset] button allows to copy a form template in order to associate it to another dataset.

6 [Insert a form] button

The [Insert a form] button allows to create a new form template from scratch.

7 [Delete] button

The [Delete] button allows to delete one or several forms templates, as selected by the form template check box selection.

Table 14: Form Template – Action buttons

August 2014 Page 43

4.2.1 Wizard with a DSD - step 0: Choose a DSD

The first screen displayed before the wizard runs allows the user to create a Form Template using or not using a DSD (See Figure 40). This section describes the wizard when the option “No DSD used” is selected.

Figure 40: Form Template created without any DSD- Step 0

4.2.2 Wizard without a DSD - step 1: Provide general information

The first wizard (see Figure 41) allows the domain manager to attach a Web Form to a dataset. It also defines the name of the Web Form, which is usually the same as the name of the dataset (but can be different). It determinates the first reporting period, the number of periods, which will be displayed in the Web Form, the sort order, the form style, which will be applied and it also specifies whether the Web Form will contain ‘estimated data’.

Figure 41: Form Wizard – Step 1 of 3 – General information

1 Grouped dataset

August 2014 Page 44

This is the name of a group of datasets. This allows to use one Web Form with one table per dataset. When the group opens, it allows to open all the datasets belonging to the group.

2 Dataset

This is the dataset name, to which the Web Form will be linked.

3 Form name

This is the name of the Web Form as it will appear in all pages for the data providers.

4 Data periodicity

This is the periodicity of the data (for example, a monthly, quarterly, yearly, etc. periodicity ), as it is inherited from the dataset definition.

5 First Period

This is the first period, for which a reporting reference period will be entered in the Web Form.

6 Number of periods

This is the periodicity of the data (for example, on a monthly, quarterly, yearly, etc. basis ) as it is inherited from the dataset definition.

7 Fixed / Floating

When set on ‘Fixed’, the Web Form remains the same for all reporting reference period (all instances of a Web From). The data provider will see the time interval from the first period to the last period. For example, a monthly dataset, with a period number equals to 12 will provide a monthly display from January to December of the year, as defined in the ‘First period’ of the Web Form, for all each monthly reporting reference period.

Whereas, when it is set on ‘Floating’, the increment of one reporting period automatically shifts the Web From to the next period. The data provider will see a time interval of 12 months starting or ending with the current reporting reference period being at the right or at the left of the Web Form, as defined by the sort order ‘Ascending’ or ‘Descending’.

8 Sort order

Defines the way, in which the Web Form will be displayed in terms of reporting reference period.

9 Use Custom DSD

If the checkbox is on, the form template structure file will be generated from the imported DSD. This option is only available if we do not use a DSD as a direct form template structure file (see Step 0).

10 Estimated data

If this check box is ticked, this means that the domain manager at Eurostat intends to fill in the Web Form with estimated data, before creating an instantiation of a Web Form. At this moment, the instantiation of a Web Form will be published with a status ‘Estimated’, instead of ‘Draft’.

August 2014 Page 45

11 Form style

It is possible to use style sheets at the Web Form creation, which, in that case, will pre-format the layout of the Web Form. For example, it can be defined that the colour of the flagged cells will be in ‘orange’, that the value cells will be in ‘yellow’ and that the font used will be ‘Times New Roman 11 pt’. Therefore, the data manager will not have to take care of the whole formatting of the Web Form, as the style sheet does it.

Table 15: Form Wizard – General Information - Field description

� Usage of Form style

Note There are no tools for the design of the Form style. If a Form style should be common to all Web Form of a Unit, a new Web Form should be edited and formatted and, once this is done, the Form style sheet can be derived for another new Web Form. Domain managers are invited to contact the EDAMIS support at this end.

August 2014 Page 46

The domain manager specifies the name of the Web Form (e.g. ‘MyForm’), completes the first period, where the list of year(s) depends on the number defined in the field ‘Timetable calculated for the next’ field as in ‘Manage dataset Form’, section ‘Timelines’ (see Figure 9), period number (e.g. ‘12’). He also chooses a ‘fixed’ mode but also ‘Ascending’ for the sort order, decides if there is a DSD to be used for the structure import, decides if the Web Form must be completed with estimated data and selects the Form style template (see Figure 42).

Figure 42: Form Wizard – Step 1 of 3 – General Information – List of year

Then, the domain manager clicks on the [Next] button to fulfil the step 2 of the wizard programme. So far, the area, which is framed in red, was defined (see Figure 43).

Figure 43: EWF layout – Result from the wizard step 1 of 3

If the check box ‘Estimated data’ has to be checked, as in Figure 42, the status, as in Figure 43, would have to turn to ‘Estimated’.

August 2014 Page 47

4.2.3 Wizard without a DSD - step 2: Define table

The second step of the Form Wizard consists in creating the tables, which will be used in the Web Form. The domain manager will provide the table name, the dimension of the table corresponding to the number of linear and/or hierarchical Code Lists which will be used in the corresponding table. The special values and the flags Code Lists, if used, will be indicated in the ‘Form Wizard – Table Information’ (see Figure 44).

Figure 44: Form Wizard – Step 2 of 3 – Table Information

The code ID for the titles, the header and the footer are proposed by EDAMIS. The domain manager can keep them or change these codes ID, as whished. The descriptions of these codes ID are optional, but, as they will appear in the Web Form when a data provider will open it, it is better to give them a clear description. These descriptions will appear in the Web Form in a place, where there will have no major impact on the layout of the Web Form.

Now, the domain manager clicks on the [Next] button to fulfil the step 3 of the wizard.

� Description of titles, header and footer.

Note These descriptions are optional.

Table name

Note The table name must contain neither spaces nor figures.

August 2014 Page 48

In this example (see Figure 44 and Figure 45), ‘MyTable2’ was the “table name” given by the domain manager. There is one dimension used, which means one Code List and there are special values and flags Code Lists. Codes IDs were kept as proposed by EDAMIS and the description completed.

Figure 45: EWP layout - Example

4.2.4 Wizard without a DSD - step 3: Define Code Lists position in the Web

Form (row and columns)

In the step 3 of the form wizard, the domain manager will position all needed Code Lists in the Web Form and will hence define the final layout of the Web Form. In the example below, the domain manager will choose to position the Code List with the name ‘CL_User_Guide’ on the vertical axis of the Web Form (see Figure 46). By default, all reporting reference periods will always be put on the top of the horizontal axis. There is a check box ‘Total’ allowing to calculate the total of the sum of the values entered in the Web Form for the reporting reference period.

Figure 46: Form Wizard – Step 3 of 3 – Code List Information 1/1

Footer

Title 1 Title 2 Header

August 2014 Page 49

Once the 3rd step of the wizard programme is complete, the ‘Form Template Summary’ page appears with all the provided information (see Figure 47).

Figure 47: Form Template – Template Summary

The fields described below are the result of the information provided in the pages filled beforehand. Most of them are described in Table 13.

1 Future reference period as read only

When this check box is ticked, it will freeze all reporting reference periods after the current one.

2 Past reference period as read only

When this check box is ticked, it will freeze all reporting reference periods before the current one.

Table 16: Form Template – Template Summary - Field description – Part 1

At this stage, the domain manager usually accepts all values and only completes the Form description, the future and the past reference periods as read only check boxes according to the needs.

� Publish form button

Note Once the Web Form template is published, it is ready for use by the data provider. At that moment, the only way to modify the Web Form template, will be to make a copy of it, to give it a new name, to perform all the needed changes and once it is ready, to publish it again.

Note It should be kept in mind that only ‘one’ Web Form template can be used at a given time. Therefore, the [Publish form] button is chosen at the very latest stage, i.e. once all definitions and validation rules are satisfactory.

1 Selection check box for a table

August 2014 Page 50

This allows to select one or more tables, on which an authorised action will be performed (e.g. a deletion).

2 Change order table in Web Form

This allows to reorganize the presentation order of the tables in the Web Form.

3 Table name

This is the table name, which will appear in the Web Form. The table name should only be composed of characters. But no figures and no spaces are allowed in the table name.

4 Dimension

This figure provides the number of Code Lists contained in the Web Form.

5 Special values

This is a Code List containing a special value, which can be entered in a cell of the web form being different from a digit. (e.g. #). This Code List does not count as a dimension in the Web Form.

6 Flags

This is a Code List, containing flags, which is entered next to a cell of the web form. It gives information on the value, which is contained in the cell directly at its right and is different from a digit(e.g. c: stands for confidential). This Code List does not count as a dimension.

7 Code List ID in a table of a Web Form

This is an identification given by EDAMIS to a Code List, which is contained in a table of a Web Form.

8 Axis

This icon indicates on which axis the Code List in the web form will be presented, either vertically (by default) or horizontally.

9 Code List

This is the name of the Code List, attached to the table, which will appear in the web form. It contains codes and its descriptions, as well as default code, export code, and hierarchical levels.

10 Total

Informs if a total is calculated or not for this Code List.


August 2014 Page 51

In the following list, one can find the buttons, which will perform an action on one or several elements of the Web Form template.

1 [Refresh Code List] button

The [Refresh Code List] button permits to apply changes made in a Code List in a given Web Form. This function is covered more in details in the phase IV related to the Web Form maintenance.

2 [Define export structure] button

The [Define export structure] button permits to determinate the way exported files will be built (e.g. export codes in view of importing data into a database in a forthcoming future).

Table 18: Form Template – Template Summary – Action buttons – Part 1

1 [Save] button

The [Save] button allows to save all changes made in the Form Template. Until this stage, the domain manager is able to make any kind of action on the saved Web Form template and to save it again, which is not the case anymore once the Web Form is published.

2 [Publish form] button

The [Publish form] button will be used for publishing the Form Template and making it available to the data providers for instantiations. Before using this button, the domain manager should have finalized the Web Form definition by using the [Edit form] button, as indicated in the next item.

3 [Edit form] button

The [Edit form] button will be used before publishing the Web Form Template. It will be possible to create all validation rules and to format all the cells of the Web Form. This will be used to test the created Web Form, before releasing it by its publication.


August 2014 Page 52

4.3 CREATE A WEB FORM USING A DSD

Select Inventory in the navigation bar and select Form Template from the drop-down list (see Figure 59).

Select Form Templates

Figure 48: Form Templates - Menu

The Form Template page now appears. By default, the theme, the domain and the dataset drop-down boxes are set to ‘--- all themes ---’, ‘--- all domains ---’ and ‘--- all datasets ---’ unless there is only one existing dataset (see Figure 60).

Figure 49: Form Templates - Form

The [Insert a form] button allows to create a new form template using or not using a DSD. The following sections will describe the steps that are necessary to create a form template using a DSD.

August 2014 Page 53

4.3.1 Wizard with a DSD - step 0: Choose a DSD

The first screen displayed when running the wizard is to allow the user to choose whether the Form Template to create should use or not use a DSD (See Figure 50 and Figure 51). If the dataset is already linked to some DSDs, these links are displayed in the form (See Figure 51).

If the screen does not display any DSD (See Figure 50), the user has the possibility to add one by clicking on the button [New DSD Link].

Figure 50: Form Template created without any DSD

If the screen displays existing links to DSDs (See Figure 51), the user has the possibility to use one existing DSD or to add another one by clicking on the button [New DSD Link].

Figure 51: Form Template created using a DSD

When the user creates a new link to a DSD, a form is displayed to specify information corresponding to the DSD and to create the link to the DSD stored in the SDMX Registry (See Figure 52).

August 2014 Page 54

Figure 52: Information corresponding to the DSD

A confirmation message is displayed, when the DSD is correctly linked (See Figure 53).

Figure 53: Confirmation message after providing a link to a DSD

4.3.2 Wizard with a DSD - step 1: General Information

There are two possibilities to create a Form Template using a DSD:

• Use the option “No DSD” in step 0 and add the path of a DSD file in the form “General Information”; The first wizard (see Figure 54) allows the domain manager to attach a Web Form to a dataset. It also defines the name of the Web Form, which is usually the same as the name of the dataset (but can be different). It determinates the first reporting period, the number of periods which will be displayed in the Web Form, the sort order, the DSD to be used for the import of the structure, the form style which will be applied and it specifies if the Web Form will contain ‘estimated data’.

August 2014 Page 55

Figure 54: Form Wizard - Step 1 of 3 - General information - DSD file

used

• Use the link to a DSD in Step 0. When the link to the requested DSD is chosen in step 0, then, the wizard is launched. The first wizard (see Figure 55) allows the domain manager to attach a Web Form to a dataset. It also defines the name of the Web Form, which is usually the same as the name of the dataset (but can be different). It determinates the first reporting period, the number of periods which will be displayed in the Web Form, the sort order, the form style which will be applied and it specifies if the Web Form will contain ‘estimated data’.

Figure 55: Form Wizard using a DSD: Step 1 of 3 - General Information

August 2014 Page 56

1 Grouped dataset

This is the name of a group of datasets. This allows to use one Web Form with one table per dataset. When the group opens, it allows to open all datasets belonging to the group.

2 Dataset

This is the dataset name, to which the Web Form will be linked.

3 Form name

This is the name of the Web Form, as it will appear in all pages for the data providers.

4 Data periodicity

This is the periodicity of the data (for example, a monthly, quarterly, yearly, etc. Periodicity), as it is inherited from the dataset definition.

5 First Period


6 Number of periods

This is the periodicity of the data (for example, on a monthly, quarterly, yearly, etc. basis), as it is inherited from the dataset definition.

7 Fixed / Floating

When set on ‘Fixed’, the Web Form remains the same for all reporting reference period (all instances of a Web From). The data provider will see the time interval from the first period to the last period. For example, a monthly dataset, with a period number equals to 12 will provide a monthly display from January to December of the year, as defined in the ‘First period’ of the Web Form, for all each monthly reporting reference period.

When it is set on ‘Floating’, the increment of one reporting period automatically shifts the Web From to the next period. The data provider will see a time interval of 12 months starting or ending with the current reporting reference period being at the right or at the left of the Web Form, as defined by the sort order ‘Ascending’ or ‘Descending’.

8 Sort order

Defines the way the Web Form will be displayed in terms of reporting reference period.

9 First period


10 Use Custom DSD

If the checkbox is on, the form template structure file will be generated from the imported DSD. This option is only available if the DSD is not used as a direct form template structure file (see Step 0).

11 Use Custom Styles, rules and formulas

The checkbox ‘Use custom styles, rules and formulas’ is displayed, when a DSD is used to create the Form Template. When the checkbox ‘Use custom styles, rules and

August 2014 Page 57

formulas’ is checked, the user has the possibility to browse his file system and select a file to be imported. The format of this file should correspond to the current webform file format containing styles, rules and formulas and be in relation with the previously selected DSD.

Example: the option “Display periods from 2004” is selected and a web form instance is created for the reference period 2006. The periods 2004, 2005 and 2006 will be displayed in the web form.

12 Estimated data

If this check box is ticked, this means that the domain manager at Eurostat intends to fill in the Web Form with estimated data before creating an instantiation of a Web Form. At this moment, the instantiation of a Web Form will be published with a status ‘Estimated’, instead of ‘Draft’.

13 Form style

It is possible to use style sheets, at the Web Form creation, which in that case will pre-format the layout of the Web Form. For example, it can be defined that the colour of the flagged cells will be in ‘orange’, that the value cells will be in ‘yellow’ and that the font used will be ‘Times New Roman 11 pt’. Therefore, the data manager will not have to take care of the whole formatting of the Web Form, as the style sheet does it.

Table 20: Form Wizard – General Information - Field description

� Usage of Form style

Note There are no tools for the design of the Form style. If a Form style should be common to all Web Form of a Unit, a new Web From should be edited and formatted and, once this is done, the Form style sheet can be derived for another new Web Form. Domain managers are invited to contact the EDAMIS support to this end.

August 2014 Page 58

The domain manager specifies the name of the Web Form (e.g. ‘MyForm’), completes the first period, where the list of year(s) depends on the number defined in the field ‘Timetable calculated for the next field as in ‘Manage dataset Form’, section ‘Timelines’ (see Figure 9), period number (e.g. ‘12’). He also chooses a ‘fixed’ mode, but also ‘Ascending’ for the sort order, decides if there is a DSD to be used for the structure import, decides if the Web Form must be completed with estimated data and selects the Form style template.

4.3.3 Wizard with a DSD - step 2: Define table

The second step of the Form Wizard consists in creating the tables, which will be used in the Web Form. The domain manager will provide the table name, the dimension of the table corresponding to the number of linear and/or hierarchical Code Lists which will be used in the corresponding table. The special values and the flags Code Lists, if used, will be indicated in the ‘Form Wizard – Table Information’ (see Figure 56).

Figure 56: Form Wizard – Step 2 of 3 – Table Information

The code ID for the titles, the header and the footer are proposed by EDAMIS. The domain manager can keep them or change these codes, as whished. The descriptions of these codes are optional, but, as they will appear in the Web Form when a data provider will open it, it is better to put a clear description there.

Now, the domain manager clicks on the [Next] button to fulfil the 3rd step of the wizard.

� Description of titles, header and footer.

Note These descriptions are optional.

DSD Filename

Note The DSD file must be obtained from the Eurostat SDMX registry.

Table name

Note The table name must contain neither spaces nor figures.

August 2014 Page 59

4.3.4 Wizard with a DSD - step 3: Define Code List position in the Web Form

(row and columns)

In the step 3 of the form wizard, the domain manager will position all needed Code Lists in the Web Form and will hence define the final layout of the Web Form. In the example below, the domain manager will choose to position the Code List with the name ‘CL_User_Guide’ on the vertical axis of the Web Form (see Figure 57). By default, all reporting reference periods will always be put on the top of the horizontal axis. There is a check box ‘Total’ allowing to calculate the total of the sum of the values entered in the Web Form for the reporting reference period.

Figure 57: Form Wizard – Step 3 of 3 – Code List Information 1/1

Once the step 3 of the wizard is complete, the ‘Form Template Summary’ page appears with all the provided information (see Figure 58).

Figure 58: Form Template – Template Summary

August 2014 Page 60

The fields described below are the result of information provided in the pages filled beforehand. Most of them are described in Table 13.

1 Future reference period in read only

When this check box is ticked, it will freeze all reporting reference periods after the current one.

2 Past reference period in read only

When this check box is ticked, it will freeze all reporting reference periods before the current one.


At this stage, the domain manager usually accepts all values and only completes the Form description, the future and the past reference periods as read only check boxes according to the needs.

� Publish form button

Note Once the Web Form template is published, it is ready for use by the data provider. At this moment, the only way to modify the Web Form template will be to make a copy of it, to give it a new name, to perform all changes needed and once it is ready, to publish it again.

Note It should be kept in mind that only ‘one’ Web Form template can be used at a given time. Therefore, the [Publish form] button is chosen at the very last stage once all definitions and validation rules are satisfactory.

1 Selection check box for a table

This allows to select one or more tables, on which an authorised action will be performed (e.g. a deletion).

2 Change order table in Web Form

This allows to reorganise the presentation order of the tables in the Web Form.

3 Table name

This is the table name, which will appear in the Web Form. The table name should only be composed of characters. However, no figures, nor spaces are allowed in the table name.

4 Dimension

This figure provides the number of Code Lists contained in the Web Form.

5 Special values

This is a Code List containing a special value, which can be entered in a cell of the web form being different from a digit. (e.g. #). This Code List does not count as a dimension in the Web Form.

6 Flags

This is a Code List containing flags, which is entered next to a cell of the web form. It gives information on the value which is contained in the cell directly at its right and is different from a digit. (E.g. c: stands for confidential). This Code List does not count as a dimension.

August 2014 Page 61

7 Code List ID in a table of a Web Form

This is an identification given by EDAMIS to a Code List, which is contained in a table of a Web Form.

8 Axis

This icon indicates on which axis the Code List in the web form will be presented, either vertically (by default) or horizontally.

9 Code List

This is the name of the Code List, attached to the table, which will appear in the web form. It contains codes and its descriptions, as well as code, export code, and hierarchical levels.

10 Total

Informs if a total is calculated or not for this Code List.


In the following list, one can find the buttons, which will perform an action on one or several elements of the Web Form template.

1 [Refresh Code List] button

The [Refresh Code List] button permits to apply changes made in a Code List in a given Web Form. This function is covered more in details in the phase IV related to the Web Form maintenance.

2 [Define export structure] button

The [Define export structure] button permits to determinate the way exported files will be built, e.g. export codes in view of importing data into a database later on.

3 [Delete table] button

The [Delete table] button permits the deletion a table in the Web Form.

4 [Copy table] button

The [Copy table] button permits the copy of all tables and Code Lists as defined in the Web Form. Then, after being modified, the Form Template can be saved.

5 [Add table] button

The [Add table] button permits the addition of a new table in the Web Form.


1 [Save] button

August 2014 Page 62

The [Save] button allows to save all changes made in the Form Template. Until this stage, the domain manager is able to make any kind of action on the saved Web Form template and to save it again, which is not the case anymore when the Web Form is published.

2 [Publish form] button

The [Publish form] button will be used for publishing the Form Template and making it available to the data providers for instantiations. Before using this button, the domain manager should have finalized the Web Form definition by using the [Edit form] button, as indicated in the next item.

3 [Edit form] button

The [Edit form] button will be used before publishing the Web Form Template. It will be possible to create all validation rules and to format all the cells of the Web Form. This will be used to test the created Web Form, before releasing it by its publication.


August 2014 Page 63

4.4 STEP 3: EDIT THE WEB FORM

Once the template and all its components are defined, the domain manager will edit the Web Form before publishing it. While editing the Web Form, the domain manager could manage the presentation of the Web Form (font size and colours, cell background colour, lock cells, spacing, alignment) and could define all validation rules required.

By clicking on the [edit] button, the JAVA applet is started and after a while, the Web Form template appears at the screen, in the JAVA window (see Figure 59).

Figure 59: EWF – Editing a Web Form template

4.4.1 Define all cells formats

In order to promote the formatting and validation tools in the JAVA windows, the domain manager must click on the promoting tool box little icons located at the bottom left-hand side of the edited Web Form. This action will open up the Web Form tool box, as shown below (see Figure 60).

� Promoting the tool box

Note By clicking for a second time on the promoting tool box icons, the tool box will be displayed in a full sized JAVA window.

August 2014 Page 64

Figure 60: EWF – Web Form tool box

The Web Form tool box is divided in two parts: the first concerns the formatting tools, while the second relates to the validation tools (see Figure 61 and Figure 62).

Figure 61: EWF –Formatting tools

Each cell or group of cells can be formatted, as wished. The domain manager can specify the font name, the attribute (bold, italic), the size, the alignment, the cell width and height, the locking, the format, the cell background and the font colour and the list of codes which can be used. The behaviour of the formatting tool box is similar to standard word processor and there are tooltips popping-up when the mouse pointer goes over the icons.

The code drop-down box is populated with the Code List type ‘code’.

Figure 62: EWF – Validation tool box

Each cell or group of cells could contain validation rules. The validation tool box allows the creation of validation rules on a cell by cell basis. For larger Web Forms, if necessary, there is the possibility to directly import the validation rules from a structured formatted file (See the advanced functionalities section).

August 2014 Page 65

4.4.2 Define simple arithmetic expressions

The domain manager could for each cell define simple arithmetic expressions. As a result, when the Web Form will be published and instantiated by a data sender (or by the domain manager), as soon as a value is entered for a particular cell, it has immediate consequences for the calculation applicable to that cell (‘calculation on the fly’).

In practice, the arithmetic expression can be entered in the function tool bar, after having selecting the corresponding cell (see Figure 63 and Figure 64).

Figure 63: Selection of the cell where the arithmetic expression will be entered

(cell B6)

Figure 64: Arithmetic expression entered in the function tool bar for cell B6

In this example, cell B6 will be equal to 4πR² (surface of a sphere) and translated into 4 * (22/7) * B4 * B4 which is the equivalent, where π was calculated with 22/7 and where cell B4 will be the input cell for the rayon of the sphere. Once entered, the domain manager will confirm by clicking on the button and finally, on the [Save] button to save the edited Web Form on the EDAMIS server.

As a result, once published, when the data sender will fill in cell B4, the surface will automatically be calculated based on the arithmetic expression (formula) provided in cell B6. The same is done for the cell B8 (Volume) and a ratio, which calculates the percentage of increase (or decrease) of the surface and the volume will also be computed (cells C7 and C9).

� ‘NaN’ or ‘Infinity’ in a calculated cell

Note

Cell C7 is the result of ((C6-B6)/B6)*100, which expresses the percentage of increase (or decrease) of cell C6 compared to cell B6. In the above example, as there are no provided values for cells B4 and C4, EDAMIS cannot calculate the ratio, which is translated with a ‘NaN’ value in the depending cells. It might be possible that in some circumstances, a division by zero occurs. In this case, EDAMIS will complete the calculated cells with ‘Infinity’, which is the mathematical result of the calculation of a limit of a division by zero.

August 2014 Page 66

4.4.3 More complex expressions

More complex expressions can be set up using special statistical functions, as listed below (see Figure 65) by clicking on the function icon in the validation tool box or else by right-clicking on the mouse button. By moving the mouse cursor on a function, the corresponding help appears in the bottom of the ‘insert function’ box.

It is possible to copy and paste data, arithmetic expressions or validation rules within a Web Form using [CTRL]-[C] and [CTRL]-[V] . Simply select the cell, or group of cells you wish to copy, hold down simultaneously the [CTRL] and [C] keys to copy, then select the cell or group of cells you wish to paste to, and hold down simultaneously the [CTRL] and [V] keys to paste. It is also possible to copy and paste from an external file (Excel, for example) using [CTRL]-[C] and [CTRL]-[V].

Another way of copying and pasting data is using the contextual menu by right-clicking the selected cell or group of cell and choosing the ‘Copy’ function.

Figure 65: EWF – Complex function available

� Copy and Paste restrictions

Note

In the current version of EDAMIS Web Form, the copy/paste function does not take relative and absolute positions of cells into account. For example, if cell B6 contains the arithmetic expression ‘= B5 * B4’, when copying and pasting this formula into cell C6, the expression will remain ‘= B5 * B4’instead of ‘= C3 * C4’. This will be further improved in a next version of EDAMIS Web Forms.

August 2014 Page 67

4.4.4 Define validation rules

Similarly to the definition of arithmetic expressions, the domain manager could, for each cell, define several validation rules. As a result, when the Web Form will be published and instantiated by a data sender (or by the domain manager), as soon as a value is entered for a particular cell, it has immediate consequences for the validation rules applicable to that cell (‘validation on the fly’).

Validation rules will be defined with the validation rule tool box. It is possible to define several validation rules for each cell of the Web Form (see Figure 66).

Figure 66: EWF - Validation rule tool box sample

Validation rules could be ‘added’, ‘removed’, ‘edited’ or ‘imported’ by using the appropriate button of the validation tool box.

4.4.4.1 Adding a validation rule in a cell

When the domain manager clicks on the [Add] button of the validation tool box, it pops up a JAVA window allowing to add a rule for the selected cell (see Figure 67).

Figure 67: EWF- JAVA window allowing specifying the rule constraints for a cell

� ‘Basic’ or ‘Critical’ error

Note This error type applies to constraints ‘Mandatory’, ‘Range’ and ‘Expression’. A ‘basic’ error does not prevent to send a Web Form, while a ‘Critical’ error does.

In our example with the sphere, the rule number one ‘THIS>=0’ for the cell B4, which is mandatory and critical imposes a value for the sphere radius that must be present and strictly

Select the country to apply the rule

The rule is mandatory

Cell value range from X to Y

Current validation rule number

Arithmetic or Boolean Expression to evaluate

Error message displayed to the user if the rule is broken

Activate/deactivate the rule The rule is attached to cell B4

Type of generated error when a rule is broken ‘Basic’ or ‘Critical’

August 2014 Page 68

positive. Note that even if the validation rule for this cell is fulfilled, it could generate a new (broken) validation rule for another cell, which might depend on it.

There are two types of error status, when a validation rule is not fulfilled, ‘critical’ or ‘basic’. Whenever the error status of the broken rule is ‘critical’, the official transfer cannot be carried out. Conversely, when the error status of the broken rule is ‘basic’, the data sender must provide a justification, before carrying out the official transfer. As soon as the value is entered in a cell, corresponding validation rules that were initially displayed in the validation window for that cell (as they were initially broken) will disappear.

4.4.4.2 Removing a validation rule from a cell

To remove a rule, the domain manager has to select the rule in the validation rule tool box and then, must click on the [Remove] button (see Figure 68).

Figure 68: EWF- Validation rule tool box allowing selecting rule to be removed

Note that the domain manager should carefully check whether removing the selected rule will not have any impact on other rules, which might have dependencies. Instead of completely removing a rule, the domain manager can simply de-activate it by un-checking the ‘Active’ flag.

4.4.4.3 Editing an existing validation rule

After a rule was selected in the validation rule tool box, the domain manager can click on edit to update this rule (see Figure 69).

Figure 69: EWF - JAVA window allowing editing of a rule

August 2014 Page 69

4.4.4.4 Importing validation rules in Web Forms

Once pressing the [Import] button of the validation tool box, a JAVA window pops up (see Figure 70).

Figure 70: EWF - JAVA window allowing input of validation rules Web Forms

The domain manager can select the file where the validation rules have been defined and then click on [Open] button to import the rules.

4.4.5 Changing cell format and using cell locking

The domain manager can format cells by selecting the font name, the font arguments (normal, bold or italic), the font size, the font alignment, and the cell width and cell height. He can also lock the cell for edition and chose the format number of a cell, the font colour and the cell background colour (see Figure 71).

Figure 71: EWF - Editing tool box

This is applicable to each individual cell or to a group of cells.

� Cell lock

Note

The cell lock has no relation with the locking mechanism of the Web Form. It only prevents a data sender to modify a cell where for instance, arithmetic expressions entered. By definition for these specific cells, the result is calculated on the basis of the data sender input in other cells. This cell lock can also be used if, for some periods, the cell value is irrelevant or should not be provided for specific reasons.

August 2014 Page 70

4.4.6 Import of estimated data in Web Forms

The domain manager can pre-fill the edited Web Form with estimated values. The result of this will be that once the Web Form is published, when the data sender will instantiate a reporting period for the Web Form, all estimated figures will be present. The data sender will always have the possibility to update these figures with the ones of the country.

When designing the Web Form, if the domain manager allowed to update previous and future reporting periods of the Web Form. Then, the data sender will also be able to update them (see Figure 72).

Figure 72: Past and future reference period’s edition

In the above example, the domain manager did not allow to modify past and future reporting reference period.

� Draft or Estimated?

Note For the data sender, the status of a Web Form will be set to ‘Draft’ for new instances, but this will turn to ‘Estimated’, if the domain manager ticked the ‘estimated’ check box at the Web Form creation.

August 2014 Page 71

4.5 STEP 4: PUBLISH THE WEB FORM

Now that the domain manager completed the revision of the layout, the formats and the definition of the validation rules and now that the whole system works as expected, the domain manager can promote the Web Form template to the EDAMIS community.

4.5.1 Publish the new Web Form for all users

By clicking on the [Publish] button, the domain manager will open the new Web Form to the EDAMIS community that is allowed to use it (see Figure 73).

Figure 73: EWF – Publishing a Web Form

August 2014 Page 72

5 PHASE III: PUBLISHING AND INSTANTIATING WEB FORMS

The information contained in this section is a quick overview of how a domain manager could instantiate a Web Form for a country. The domain manager will find complete and detailed information in the ‘EDAMIS Web Form user guide for data provider’, available at the EDAMIS Help Centre.

Typically, when a data sender wishes to send data for a particular reference period, a new Web Form instance needs to be created for that reference period and for this country. This process is known as instantiation.

To instantiate a Web Form, the domain manager first selects the appropriate dataset from the drop-down dataset list in the Web Form Entry table (e.g. the dataset COSAEA_ALI3_A "Economic Accounts for Agriculture - Labour Input - Final - Annual" – see Figure 74). The domain manager then clicks on the [Insert] button beneath the table on the left-hand side.

Figure 74: EWF – Instantiating a Web Form

� When not to instantiate

Note There are some circumstances when there is no need to instantiate a new Web Form. A draft Web Form for the reference period may already exist, either created by a domain manager at Eurostat or by another data sender in the organisation. In addition, for some datasets, Eurostat may initially provide data estimates for the data sender. In such cases, Web Forms with Estimated status were already created by Eurostat and must be completed by the data sender for the reference period in question, so again there is no need to instantiate a new draft.

August 2014 Page 73

Clicking on the [Insert] button opens the Web Form Entry – New Form window (see Figure 75):

Figure 75: Web Form Entry – New Form

In the New Form window the Web Form template field indicates the current dataset, the Web Form template used by Eurostat for the dataset selected (COSAEA_ALI3_A, the Web Form template for the dataset COSAEA_ALI3_A in the example above). This is for informative purposes only. It was pre-defined by the domain manager, when creating the Web Form template.

In the Country field, the domain manager can select the country, for which the instantiation will be done (LU in the example above). The drop-down list is populated on the basis of the existing links between the dataset, the country and the organisation.

Below this, two fields appear side by side in order to define the Reference period. The first field allows the data sender to select the instantiation year. Clicking on the drop-down arrow in the first reference period field allows to display the available years, for which a Web Form can be instantiated (see Figure 76). The domain manager simply selects the desired year.

Figure 76: Web Form Entry – New Form – Reference period (year)

August 2014 Page 74

The second field for the reference period allows the data sender to select the frequency (Annual, Monthly or Quarterly). The listbox is populated with values corresponding to the chosen dataset. In the previous example, only the value “Annual” exists for the used dataset.

In case the user can choose the value “Monthly”, or “Quarterly”, another list box is displayed to allow the data sender to select the quarter or month that he wishes to instantiate, for quarterly and monthly datasets respectively.

Next, the language is chosen. Click on the Available languages field to display the options (see Figure 77). For this Web Form German, English and French are currently available. Simply click on a language to select it (e.g. English in the example below).

Figure 77: Web Form Entry – New Form – Available languages

� Languages

Note Although EDAMIS Web Forms can be created by Eurostat in several languages, this varies from one domain to another. English is used for most datasets, but this is regularly completed with French and German.

August 2014 Page 75

Finally, after selecting the reference period and language, click on the [Accept] button (see Figure 78).

Figure 78: Web Form Entry – New Form – Accept

Clicking on [Accept] automatically starts the downloading process of the Java applet, which is at the core of EDAMIS Web Forms. This Java applet automatically recreates the Web Form's structure, formatting and contents (including previously-transmitted data where applicable – see Figure 79).

Figure 79: EWF – Web Form instance

It might happen that, depending on Eurostat's IT security settings, the domain manager will be asked to verify the access to a potentially insecure web site. Click on [Run] (see Figure 80).

August 2014 Page 76

Figure 80: Applet signature

Next, you will be prompted to block or not block the application. As soon as you accept to run the application, the Java Applet starts running and the Java symbol appears (see Figure 81).

Figure 81: JAVA applet download

For security reasons, the user will be prompted to block or not block the application (see Figure 82). To continue, you have to click on the “Don’t Block” button. Then, after a short loading time, the Web Form opens and is ready for use.

August 2014 Page 77

Figure 82: Second Security Warning

� Java Applet running time

Note The first time a Java Applet is run on a PC, it may take some time to open (20-30 seconds is typical, but it can be longer in some organisations, depending on the IT environment). Some additional security clearance may also be requested (select [Run] to proceed). However, once the Java Applet is run for the first time and the initial software download is made, the application subsequently runs much quicker.

August 2014 Page 78

6 PHASE IV: WEB FORM MAINTENANCE

6.1 MAINTAINING A WEB FORM

6.1.1 Codes

The only way to modify a code ID is via the ‘Web Forms – Codes & Translations’ screen (see paragraph ‘6.1.5’ – Page 81 - Figure 90).

6.1.2 Code List

The domain manager can refresh the Code List of a Web Form in the Form Template screen by clicking on the [Refresh Code List] button (see Figure 83).

Figure 83: Form template for refreshing Code List

This reloads the Code Lists, for the selected table, to update the template, in case an element was added to or removed from a Code List. This action will be allowed only if the template has never been instantiated, i.e. used by a data provider in a CNA.

If the template has already been instantiated, it is possible to update the form by making a copy (create a new version) and publishing the copy.

August 2014 Page 79

6.1.3 Define export structure

The domain manager can define an export structure for further use of Web Form content. For instance, when there is a need to import data of the Web Form in a database or in a data warehouse. In the Form Template screen, the domain manager will click on the [Define export structure] button (see Figure 84).

This will open a window to define the structure, for the selected table of the codes exported during the export to the DB phase and the structure of the flat file generated.

Figure 84: Define export structure

When there are several tables in a Web Form, before being able to click on the [Define export structure] button, the domain manager should select one table, for which an export structure is required (see Figure 85).

Figure 85: Selection of table to be exported

August 2014 Page 80

Once the table was selected, the domain manager can click on the [Define export structure] button and the screen, allowing to define the export codes, appears (see Figure 86).

Figure 86: Code definition screen for the export table structure

In this window, the domain manager has the possibility to define the structure of the export code (e.g. Fame) used to link data from the table with data into the destination database during the exportation. The Fame code is the concatenation of different elements, where some of them are variable and others are fixed (see Figure 86).

The domain manager has to choose these different elements and must order them. The result is the concatenation of these elements. Fixed elements are made of different free text zones and variable elements come from the Code Lists (export codes associated to them) or from the country (extract from the instance of the form you want to export). A preview of the code is displayed in the lower part of the group “Code definition”.

In the second part of the window, the domain manager defines the separator characters between columns, enters the header and footer. Once the structure is defined, it will be used during the export to DB for all countries using this form.

As this export procedure generates a flat file, it is always possible to do manually some minor modifications to cover exceptions.

6.1.4 Modifying Web Form titles

It is possible to modify header, titles and footer of a Web Form, by selecting the Web Form and then, by clicking on the [Modify titles] button (see Figure 87). Modifying titles can be used at any time, even if the Web Form was published or instantiated.

It is not required to ‘lock’ the Web Form template to proceed with the ‘Modify title’ action.

August 2014 Page 81

Figure 87: Form Templates – Modify titles

This will open a window, which will allow to modify the description of the title1, of the title2, of the header and of the footer of the concerned Web Form. Modifications will be possible for all defined languages (see Figure 88).

Figure 88: Form Templates – Modify titles window

Once all descriptions were modified, the domain manager must click on the [Save] button.

6.1.5 Translation

From the EDAMIS Web Form main menu, the domain manager selects the ‘Administration >> Codes and Translation’ (see Figure 89).

Figure 89: Main menu for Web Form translation administration

Then, the domain manager can select the theme (6.04), the domain (EWF) and click on the [View] button. The page ‘Codes & Translations’ is displayed (see Figure 90).

August 2014 Page 82

Figure 90: Web Forms – Codes & Translations

The domain manager can use the arrows at the bottom right of the screen to navigate and to see the other pages.

This screen is also used for deleting codes and its corresponding languages, provided that the code is not used anymore in any Web Form. Domain manager should be careful when deleting codes, which might be attached to another level than the level of the datasets owned by the domain manager.

By clicking on the code ID, it is possible to update the languages (See Figure 91).

Figure 91: Web Forms – Codes & Translations Form

Active language allows the data sender to choose a language. If the check box flag is not ticked by the domain manager, then the data sender will not be able to use the corresponding language.

� Language

Note The presented languages are defined by the EDAMIS administrator.

� Code ID

Note The only way to modify a code ID is via the ‘Web Forms – Codes & Translations’ screen.

August 2014 Page 83

7 Glossary

Concept Definition

CSV Comma-Separated Values file format.

Data file Physical transmitted data file, which should normally correspond to an instance of a dataset (a physical instance of a dataset occurrence).

Dataset Dataset structure with a specific periodicity and to which a deadline for transmission is usually linked. The data content of a dataset is homogeneous.

Dataset naming convention

Convention used by all production units at Eurostat in order to name a dataset uniformly. It is composed of the domain name, the statistical table name and the periodicity, all separated by an underscore. The dataset naming convention is recognised by all third-party applications at Eurostat.

Dataset occurrence Occurrence of a dataset for one country and one period or time series or sequence. For Web Forms, it is called a ‘Web Form instance’.

Dataset structure Concept of one single data structure associated to one or several statistical tables (closely linked to the same statistical domain).

Domain Consistent group of datasets that are closely linked together (belong to the same statistical area and based on the same legal act(s) or voluntary agreements).

EDAMIS Electronic Data files Administration and Management Information System.

EWA EDAMIS Web Application.

EWP EDAMIS Web Portal.

SDMX-ML XML format for the exchange of SDMX-structured data and metadata. The SDMX format (Statistical Data and Metadata Exchange) is the result of the cooperation between the BIS, the ECB, Eurostat, the IMF, the OECD and the UN to explore common e-standards and ongoing standardisation activities that could afford more efficiency in the field of statistical information.

Table Statistical table as defined in a legal act or a voluntary agreement (with fields-made records).

Theme Theme of the Statistical Programme.

Documents

EDAMIS Web Forms - Europa...2014/08/26 · August 2014 Page 1 EDAMIS Web Forms User guide for domain managers Project EDAMIS Author Eurostat Unit B3, IT for statistical production