Quick User Guide for TCO - Europa...Quick User Guide for TCO EDAMIS 3.3 Author Eurostat Unit B5:...

12
Quick User Guide for TCO EDAMIS 3.3 Author Eurostat Unit B5: Data and metadata services and standards Release 1.0 Status Final Reference GUI 2016-04-20 GUI (Quick User Guide for TCO) F.doc

Transcript of Quick User Guide for TCO - Europa...Quick User Guide for TCO EDAMIS 3.3 Author Eurostat Unit B5:...

  • Quick User Guide for TCO

    EDAMIS 3.3

    Author Eurostat Unit B5: Data and metadata services and standards

    Release 1.0

    Status Final

    Reference GUI 2016-04-20 GUI (Quick User Guide for TCO) F.doc

  • Quick User Guide for TCO EDAMIS 3.3 - 2 -

    TABLE OF CONTENTS

    1 INTRODUCTION ......................................................................................................................................... 3

    2 HOW TO ACCESS EDAMIS VIA THE WEB PORTAL? ....................................................................... 5

    3 HOW TO MANAGE USER INFORMATION AND RIGHTS ................................................................ 6

    3.1 THE MANAGE USERS FORM ....................................................................................................................... 6 3.2 THE MANAGE RIGHTS BY DOMAIN / DATASET .......................................................................................... 9

    4 THE MANAGE ORGANISATIONS AND PERSONS FORM .............................................................. 10

    5 HOW TO MANAGE USER’S PREFERENCES AT ONCE ................................................................. 11

    6 HOW TO ASK MORE RIGHTS OR REMOVE EXISTING RIGHTS ................................................ 12

    TABLE OF FIGURES

    Figure 2: EDAMIS trees and gardeners ..................................................................................... 3 Figure 4: EWP login form .......................................................................................................... 5 Figure 5: EWP welcome page .................................................................................................... 5

    Figure 6: Manage Users form ..................................................................................................... 6 Figure 7: Manage List of users – Menu ..................................................................................... 6

    Figure 8: Manage users – User management ............................................................................. 7 Figure 9: Manage Users – Rights (org) ...................................................................................... 7

    Figure 10: Manage Rights– List of domains/datasets ................................................................ 9 Figure 11: Manage Rights – List of user with rights by dataset ................................................ 9

    Figure 12: Manage organisations and persons ......................................................................... 10 Figure 13: Manage organisations and persons – Users by organisations list ........................... 10 Figure 14: Manage organisations and persons – Create a user ................................................ 11

    Figure 15: Manage Users Preferences ...................................................................................... 11 Figure 16: My rights – screen .................................................................................................. 12

    TABLE OF TABLES

    Table 1: Possible rights in relation with the organisation roles ................................................. 8 Table 2: Possible values for the feedback .................................................................................. 8

  • Quick User Guide for TCO EDAMIS 3.3 - 3 -

    1 INTRODUCTION

    The target audience of this Quick User Guide is the Transmission Coordinators working

    with the EDAMIS Rights and transmission in their organisation. It shows in a easy way

    how to use the EDAMIS Web Portal, including managing user’s rights, user’s preferences,

    creating and updating their own organisation. For more information on these specific

    subject, the user can consult the GUI 2015-05-13 GUI (User Manual for TCO) D.

    EDAMIS is an environment which implements the concept of the Single Entry Point (SEP)

    and delivers received files to the Eurostat production environment. EDAMIS enables an

    easy sending of data files to Eurostat together with explanatory notes and comments

    when needed.

    The support of transmission is the dataset inventory.

    The model of the EDAMIS inventory can be seen as two main trees. Eurostat is the

    gardener of the first tree, which defines the hierarchical structure from the statistical

    theme to the datasets, while countries are the gardeners of the second tree, defining

    relationships between countries, organisations and users and is managed by TCO (see

    Figure 1).

    Figure 1: EDAMIS trees and gardeners

    Two gardeners are the main actors. The domain managers (DMA) and the co-responsible

    domain managers (DCR) at Eurostat manage datasets and users’ links in their respective

    statistical domains and within their production units.

  • Quick User Guide for TCO EDAMIS 3.3 - 4 -

    The transmission coordinators (TCO) in organisations (mainly NSIs) manage users and

    their rights (Sender = SEN; Receivers = REC; Data preparer = DAP; Informed = INF;

    Sender/Receiver = S/R) within their organisation. When there is no transmission

    coordinator in an organisation, the domain manager and the domain co-responsible are

    by default the actors who manage the users’ rights in that organisation.

    EDAMIS Help Centre and Support

    Note A set of comprehensive documents is available at the EDAMIS Help Centre.

    They cover a wide range of topics such as the available software tools

    (including technical aspects: advice to select the best method to fit the

    requirements and the installation procedures). The EDAMIS Help Centre can

    be accessed through the following link:

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

    The EDAMIS support team is available to help you in case of questions,

    resolving incidents or problems encountered when using the data

    transmission tools. The support team can be contacted at the following

    address.

    Email: [email protected]

    Tel: (+352) 4301-33213

    https://webgate.ec.europa.eu/edamis/helpcenter/website/index.htmmailto:[email protected]

  • Quick User Guide for TCO EDAMIS 3.3 - 5 -

    2 HOW TO ACCESS EDAMIS VIA THE WEB PORTAL?

    To access the EDAMIS Web Portal, enter the following address in your web browser:

    https://webgate.ec.europa.eu/edamis

    EDAMIS is also available via a link on Eurostat intranet: go to the ‘Statistics’ >> ‘Data

    transmission’ page.

    The Login page appears (see Figure 2):

    Figure 2: EWP login form

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

    For the purpose of this guide it is assumed that the reader (Transmission

    Coordinator) has an ECAS user account in the domain of “External”. 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 successful authentication you are back on the EDAMIS Welcome page (see

    Figure 3).

    Figure 3: EWP welcome page

    The Welcome page displays 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 and Logout) and some links (e.g. the Sitemap,

    the EDAMIS Help Centre). Information about details not discussed in this guide is

    available in the EDAMIS Help Centre.

    https://webgate.ec.europa.eu/edamis

  • Quick User Guide for TCO EDAMIS 3.3 - 6 -

    3 HOW TO MANAGE USER INFORMATION AND RIGHTS

    The users’ information and their rights can be managed in two menu items:

    Manage Users screen,

    Manage Rights by Domain / Dataset screen.

    3.1 The Manage Users form

    Select Users/Rights in the navigation bar and select Manage Users from the drop-

    down list (see Figure 4).

    Figure 4: Manage Users form

    Use the country group, country and organisation filters to find the user. Searching is also

    possible using the user’s name (‘Pattern name’), profile or user status.

    When the filters are set up, press the [View] button to get the list of matching users (see

    Figure 5).

    Figure 5: Manage List of users – Menu

    The users are shown with a colour background indicating their status:

    White background: the user is active.

    Orange: the user has sent a guest request and is waiting for granting or

    approval.

    Grey: user has been created in the EDAMIS inventory, but not activated.

  • Quick User Guide for TCO EDAMIS 3.3 - 7 -

    Red: user has sent a request but there is a problem with it.

    Light yellow: user has been created, but the rights have been granted only

    partially: some accepted, but others refused.

    Black yellow: the user has sent a request and is waiting for granting or

    approval.

    Click on the user’s last name to update the parameters (see Figure 6). 5 sections are

    available: Information, Organisation, Rights (Org), Preferences and Emails.

    Figure 6: Manage users – User management

    The Information tab allows TCO to update the user profile and to change specific

    information related to the user (Tél, Name, Adress,…).

    In the Organisation Tab, It is possible to move a user from one organization to another

    (both organization must be managed by the TCO).

    In the Rights (org) tab, TCO can approve/disapprove a requested right or update an

    existing right. It is the most important used tab (see Figure 7).

    Figure 7: Manage Users – Rights (org)

  • Quick User Guide for TCO EDAMIS 3.3 - 8 -

    The possible rights depend of the organisation role. Table 1 presents the possible rights in relation with the organisation roles.

    Organisation

    roles

    Rights

    Sender Receiver Informed Sender/

    receiver

    Data

    preparer

    Sender/

    receiver

    X X X X X

    Sender X X X

    Receiver X X

    Table 1: Possible rights in relation with the organisation roles

    In the last 2 tabs (Preferences and Email, the TCO can update the setting for several

    messages sent by the application. Regarding email triggers the following types of

    messages can be configured.

    Acknowledgement: sent upon reception of the data file at Eurostat, indicating

    that processing in EDAMIS has started.

    Notification: sent upon delivery of the data file to the production environment.

    Reminder: sent according to the dataset settings to warn the sender that the

    deadline is approaching, has been reached or already passed. Sent also to

    receivers for information.

    The possible and default values in function of user roles are displayed in the table below.

    Type of

    feedback Acknowledged Notified Reminded

    Possible

    values

    “No”, “Sent(1)”,

    “All(2)” “No”, “Sent(1)”, “All(2)” “Yes”, “No”

    Roles/Profiles Default Other Default Other Default Other

    INF No All All No Yes No

    DAP All No No All Yes No

    SEN All Sent No Sent, All Yes No

    TCO Sent All No Sent, All Yes No

    REC Sent No, All All Sent, No Yes No

    SEN/REC Sent No, All All Sent, No Yes No

    Sent (1): Receive Acknowledgements and Notifications only for the files the user sent.

    All (2): Receive Acknowledgements and Notifications for all the files under the user’s

    responsibility, even if sent by another user.

    Table 2: Possible values for the feedback

  • Quick User Guide for TCO EDAMIS 3.3 - 9 -

    3.2 The Manage Rights by Domain / Dataset

    Select Users/Rights in the navigation bar and select Manage Rights by

    Domain/Dataset from the drop-down list (see Figure 8).

    Select the domain, dataset and country where you want to manage the rights. Click on

    [View] to see the selected domain and datasets (see Figure 8).

    Figure 8: Manage Rights– List of domains/datasets

    The colour indicates the role of the country/organisation.

    Yellow: Sender/receiver;

    Blue: Sender;

    Red: Receiver.

    Click on the country name to manage the rights on the dataset. The screen shows

    persons/groups and their rights (see Figure 9).

    Figure 9: Manage Rights – List of user with rights by dataset

    The users are shown with a colour background indicating their status. The code of colour

    is the same than the one used in the Manage Users form.

    On this screen, TCO have the possibility to update an existing right, approve /disapprove

    an requested right, give another right or remove an existing right

    Update an existing right: by changing the role in the ‘granted’ column and clicking

    on the [Save Rights] button.

    Approve/disapprove a requested right: By select the requested role in the column

    ‘Granted’ and clicking on the [Save] button.

    Giving another rights: After clicking the [Add right] button, the user access to

    another screen and have the possibility to select an role for specific user to give him a specific right.

    Remove an existing right: TCO can select the use and click on the [Remove

    Rights] button.

  • Quick User Guide for TCO EDAMIS 3.3 - 10 -

    4 THE MANAGE ORGANISATIONS AND PERSONS FORM

    Select Users/Rights in the navigation bar and select Manage Organisations and

    Persons from the drop-down list (see Figure 10).

    Figure 10: Manage organisations and persons

    Select the country group and country. Click on the [View] button to show the list of root

    organisations.The list also shows the number of users in each organisation.

    Click on the organisation name to show information about the Organisational Units and

    the attached users (see Figure 11).

    Figure 11: Manage organisations and persons – Users by organisations list

    The form has three sections showing the following details; General information about the

    organisation, The list of users linked to the organisation, Details of the dataset country

    specifications.

    In the first part of the screen, TCO has the possibility to update general information

    related to the organisation, to delete the organisation or to create a sub organisation.

    The second part allows TCO to delete, update or to create users. To create an user, click

    on the [create] button, fill in the different fields presented in the Figure 12 and save.

    Part 1

    Part 2

    Part 3

  • Quick User Guide for TCO EDAMIS 3.3 - 11 -

    Figure 12: Manage organisations and persons – Create a user

    5 HOW TO MANAGE USER’S PREFERENCES AT ONCE

    TCO can manage the preference of his organisation though 2 specific menus;

    Users/Rights>Manage Users and Users/Rights>Manage User Preferences.

    The first menu has been presented in the chapter 3. The second menu is presented in the

    figure below.

    Figure 13: Manage Users Preferences

    On this screen, TCO can manage the preferences of all users belonging to his

    organisations. The parameters Notification, acknowledgement and reminder can be

    updated by modifying the values in the checkboxes.

  • Quick User Guide for TCO EDAMIS 3.3 - 12 -

    6 HOW TO ASK MORE RIGHTS OR REMOVE EXISTING RIGHTS

    If a user has rights on specific datasets, he can ask for more. To do it, he must click on

    the menu Preferences>My rights.

    Figure 14: My rights – screen

    The user must select the role he wants for another dataset and click on the ‘Save’ button

    The request is sent to DMA of the new dataset and/or to TCO if the checkbox TCO is

    selected. The DMA/TCO should be able to grand the requested rights.