USER MANUAL

Preface

This guide is oriented to anyone who wants to use the Open Web Component (OWC) application, the new Graphical User Interface for the DHuS, based on Google Polymer library.
This new GUI offers the same functionalities of the traditional one, with additional features devoted mainly to increase the application configurability. OWC development is a continuous process, so in the next releases there will be both improvements on existing functionalities and new features implementation.
As the whole DHuS application, the OWC project is Open Source, with the goal of creating a community of developers interested in implementing new web components suitable to the dissemination of EO products. Thanks to the modularity and extensibility principles o which OWC is based, components implemented by Open Source community can be dynamically imported in OWC according to the users' needs.

Prerequisites and Constraints

Since OWC application is based on the Web Components standard, currently not supported yet on all browsers, OWC GUI works only with recent distribution of Google Chrome.

Application Menu

OWC main page shows the application menu on a configurable background image.

main labeled

main labeled

All panels are displayed horizontally on the screen according to the order they are requested by end users (clicking on the proper menu icon).
This navigation system choice makes possible to present data efficiently providing to the user an intuitive way to navigate among components.
One of the main benefit brought by OWC’s navigation system is the chance to compare search results.
It is possible to close a panel clicking on the close icon on the top right-hand corner of each panel, while the escape key allows closing the last panel displayed on the right of the screen.
The default configuration of OWC application foresees the following menu options: - Login panel, which allows users to: * perform login (if already registered); * subscribe to application (if not yet registered); - User profile panel, which allows users to: * perform log-out; * access list of favourite products; * access list of saved searches; - Search container, which provides: * full text search functionality; * product footprint visualization on map; * product list; - Statistics container, which allows accessing the calendar of the Product Availability, reporting the publication density of products published on the DHuS with a sensing period covering the last 13 weeks. - Client settings, which allows users to configure: * application language; * application theme; * the list of map layers visualized on search container map; * product metadata to be shown in product list; - About panel, showing general information about the application.

Application access

Application access is free and allowed to all users registered to the Data Hub Service.
Already registered users can play with OWC GUI after performing log-in by means of Login Panel.
Not registered users can access OWC GUI after performing self-registration by means of Signup Panel.

Login

Login Panel is displayed on the browser clicking on application menu login icon login_button

002

002

Registered users insert their username and password in the proper fields and then click on the LOGIN button.
If credentials are correctly inserted, a message "Logged in Successfully" appears in the bottom of the screen.
If credentials are not correctly inserted (i.e. wrong username or password) an error message appears on the Login Panel ("The username and password you entered don't match.")

Signup

Signup Panel is displayed on the browser by clicking on the SIGNUP button of the Login Panel. This button is visible on all the DHuS instances on which self-registration to service is allowed.

self-registration

After filling all the fields of the registration form, the user has to click on the REGISTER button to send the registration request.
If the registration form is not filled correctly, wrong fields are marked in red to inform user about registration failure.
If the registration form is filled correctly, a message "Registration successful: An email was sent to let you validate your registration." appears in the bottom of the screen.
As reported in both Signup Panel and notification message, on completion of the registration process, new users will receive an e-mail with a link to validate the account. Clicking on the link reported in the e-mail, the account is enabled, so new users can start to play with the DHuS through OWC GUI.

Please note that the following special characters are not allowed for the generation of the username:

‐ & | ! ( ) { } [ ] ^ " ~ * ? : \ $ ' <blank space>

The registration process cannot be completed when: - a field of the form is not filled in; - the username contains a special character; - the password is too short (minimum length: 8 characters); - the password typed in the "Confirm Password" field is not identical to the one typed in the corresponding "Password" field; - the e-mail typed in the "Confirm E-mail" field is not identical to the one typed in the corresponding "E-mail" field.

Known registration issues:

Username already existing in the database
If a username is already existing in the Data Hub database a new account with the same username cannot be created. In this case, a generic error is notified to the user.

No e-mail for registration confirmation is sent to the user
Registration e-mails are usually received within two minutes from registration. It is therefore suggested to try with a different username.

User credentials are not sent via e-mail
Current Data Hub system does not send e-mails to the user with the username and password defined during the registration process. Please take care of writing down your credentials for future reference.

Search container

Search Container is displayed on the browser by clicking on application menu search icon search
It is possible to show 2 instances of search container at a time, allowing users to compare 2 searches results more easily.
If a user requests a new Search Container when there are already 2 containers displayed, a message appears in the bottom of the screen as notification that no more instances can be created for the specified component ("Reached maximum number of component's instances").

The Search Container is composed by 3 panels, which are collapsible and expandable clicking on the icon reported in the top left-hand corner of each panel: - Search panel - Product list - Map

combo

combo

Search panel

Search panel contains a search bar used to insert text query to perform.

searchbar

searchbar

Search request is executed clicking on the search icon in the end of the search bar.

The text query displayed in the search bar can be saved in a list of user's favourite searches, clicking on save icon saveicon.
If the text query is saved successfully, a message appears in the bottom of the screen ("User search saved successfully")

The text query displayed in the search bar can be also cleared, with all search filters, clicking on clear icon closeicon.

Some text queries examples that can be typed in the full-text search bar, with available wildcards, operators and keywords, can be found at the following link: https://scihub.copernicus.eu/userguide/3FullTextSearch

The Search panel contains a section with sort and ordering criteria and with different search fields.

Available sort criteria are: - sort by product index, meaning that search results are displayed on the basis of the value of the selected index. Available indexes are: - Ingestion date, i.e. product publication date; - Sensing date, i.e. product acquisition date; - Cloud Coverage, i.e. product cloudiness percentage. - ascending or descending order, which, combined with the sorting criteria, allows to show search results: - from the more recent to the older one (DESCENDING) or viceversa (ASCENDING) in case of temporal index (e.g. Ingestion date or Sensing Date); - from the greater to the smaller value (DESCENDING) or viceversa (ASCENDING) in case of numeric index (e.g. Cloud Coverage).

In this section it's also possible to specify a date range for the following parameters: - Ingestion Date, in order to get all products published in the defined period. With regard to Ingestion time, the following convention is used: * Publication time equal or greater than 00:00:00 (hh:mm:ss) of the first selected date; * Publication time equal or less than 23:59:59 (hh:mm:ss) of the second selected date; - Sensing Date, in order to get all the products whose sensing dates are included in the defined period. With regard to sensing time, the following convention is used: * Sensing start time equal or greater than 00:00:00 (hh:mm:ss) of the first selected date; * Sensing stop time equal or less than 23:59:59 (hh:mm:ss) of the second selected date.

For both Ingestion Date and Sensing Date search criteria, the following rule is applied: - if only the first date is specified, the query will return all products with Ingestion/Sensing Date equal or greater than 00:00:00 (hh:mm:ss) of the specified date; - if only the second date is specified, the query will return all products with Ingestion/Sensing Date equal or less than 23:59:59 (hh:mm:ss) of the specified date; - if both first and second date are specified, the query will return all products with Ingestion/Sensing Date equal or greater than 00:00:00 (hh:mm:ss) of the first date and Ingestion/Sensing Date equal or less than 23:59:59 (hh:mm:ss) of the second date.

The date can be selected clicking on calendar icon calendaricon.
The date can be cleared clicking on clear date icon clearcaledaricon.

These search fields can be used singularly or in combination with: - the full-text search bar content; - a selected geographic area.

Product list

The Product list provides all the products matching the submitted search query. Each result consists of: - product thumbnail, when available; - product main attributes, which are configurable by users on the basis of their needs. The configuration of product attributes is detailed in List settings section; - a set of available actions, such as: - open product details panel, clicking on show icon reported in list item; - download a product, clicking on download icon reported in list item; - open the panel containing the list of auxiliary data files used to process a product, clicking on adf icon reported in list item; - open the panel containing the list of auxiliary data files retrieved from another DHuS instance and useful for product re-processing, clicking on processing_icon icon reported in list item. This action is available only if the feature is enabled. The procedure useful to enable this feature and to configure properly OWC application is described in the document available at http://sentineldatahub.github.io/DataHubSystem/administration.html; - add or remove product to/from user cart, clicking on the star icon staricon shown in list item. If star icon is black coloured, this means that the product is not present in the user cart, so, clicking on the icon, the product is added to the user cart. If star icon is blue coloured, this means that the product is present in the user cart, so, clicking on the icon, the product is removed from user cart.

This component implements an "infinite scroll". This means that after submitting a query, the list is populated with a number of products equals to a pre-defined page size (which is fixed to 25), but, as user scrolls product list, a new search is performed, according to the following rule: - if user scrolls down, a next product page (if any) is loaded; - if user scrolls up, a previous product page (if any) is loaded.

Product details

Product details panel is shown clicking on show icon in the product list.

new_details

new_details

This panel contains: - full product name; - link for product download; - product quicklook, if any; - list of product metadata, listed in alphabetical order and grouped by category.

Auxiliary File List

Auxiliary File List panel is shown clicking on adf icon reported in list item.

aux_new

aux_new

This panel contains the list of Auxiliary Data File used to process a product, obtained by means of product inspection via OData.
At present this feature is available only for Sentinel-1 and Sentinel-3 products.

Auxiliary File Search panel is shown clicking on processing_icon icon reported in list item.

This icon is visible only if Auxiliary File Search feature is enabled in OWC application. The procedure useful to enable this feature and to configure properly OWC application is described in the document available at http://sentineldatahub.github.io/DataHubSystem/administration.html

adf_search_list

adf_search_list

Auxiliary File Search feature is designed to allow retrieving Auxiliary Data Files (ADF) which could be used to “re-process” a product, if they are better than the ones originally used.
Obviously, the usefulness of this feature is related to the availability of a significant dataset of Auxiliary Data Files.
These files are retrieved from a DHuS instance able to ingest ADF.
However, please note that it is possible to ingest Auxiliary data files and products in the same DHuS instance.

The comparison between the Auxiliary File List and the Auxiliary File Search is useful to understand whether it is appropriate to process a product with different Auxiliary Data Files.

adf_comparison

adf_comparison

At present this feature is available only for Sentinel-3 Level 1 and Level 2 products, but it is designed to be easily extended to support new product types and missions.

If an user click on the processing processing_icon icon of a not supported product type, a notification message is shown on the bottom of the screen.

operation_not_supported

operation_not_supported

Map

Map section of Search Container shows footprints of the products matching the search query.
NOTE: the map shows only the footprints of the products in the current search list page. To widen results, users have to scroll product list in order to trigger new product request.

This component contains a set of tool useful to: - define a region of interest, drawing a bounding box on the map. This feature is enabled if draw region icon selector is visible on the map. If drag icon pan is visible instead, click on it to enable drawing feature. - drag map, by means of mouse click. This feature is enabled if drag icon pan is visible on the map. If draw region icon selector is visible instead, click on it to enable dragging feature. - select or deselect available map layers, making them visible on not visible on the map. The list of available map layers is shown clicking on map layers icon layerswitcher.

User Profile

User Profile panel is displayed on the browser clicking on application menu user icon, which is visible only after performing login usericon.

015

015

This panel allows user to: - log-out from application, by clicking on LOGOUT button; - access list of favourite products, by clicking on PINNED LIST button; - access list of user's saved searches, by clicking on SAVED SEARCHES button.

Cart (Pinned List)

The Cart Panel shows the list of user's favourite products.
From this panel it is possible to: - download a metalink file containing Internet locations of all the products in the cart, by clicking on bulk icon reported in the top of the panel. This metalink file, handled by a download manager, allows a bulk download of products saved in user cart - remove all products from cart, clicking on clearcart; icon reported in the top of the panel - remove a single product from cart, clicking on star icon reported in the top right-hand corner of list item; - open product details panel, clicking on show icon reported in list item; - download a single product, clicking on download icon reported in list item; - open the panel containing the list of auxiliary data files used to process a product, clicking on adf icon reported in list item; - open the panel containing the list of auxiliary data files retrieved from another DHuS instance and useful for product re-processing, clicking on processing_icon icon reported in list item. This action is available only if the feature is enabled. The procedure useful to enable this feature and to configure properly OWC application is described in the document available at http://sentineldatahub.github.io/DataHubSystem/administration.html;

cart2

### Saved Searches The Saved Searches Panel shows the list of user's saved searches.

016

016

From this panel is possible to: - execute a saved search, by clicking on the search icon search. This action implies that a Search container is displayed on the screen, showing saved search results, if any, in the product list and in the map. - activate or deactivate notification on updates related to a saved search. This operation is performed clicking on the e-mail icon emailicon reported in the list item - delete a saved search, if no more useful, by clicking on the delete icon deleteicon shown in the list item.

It is also possible to perform a bulk deletion of saved searches, clicking on CLEAR SAVED SEARCHES button displayed in the bottom right-hand corner of the panel.

Statistics container

Statistics container is displayed on the browser clicking on application menu statistics icon statisticsicon

This panel contains link to access the following components: - Product density calendar, showing at a glance the publication density of products published on the DHuS with a sensing period covering the last 13 weeks;

Product density calendar

Product density calendar panel spans the previous 3-month (91 days) sensing period for the satellite and reports, for each sensing date on the calendar, the number of products which have been published on the corresponding Data Hub instance from that sensing date.

calendar

calendar

The user can click on a coloured day of the calendar to get the list of products sensed that day. This product list is based on the same component used for Search container product list, so it is based on infinite scroll too and provides the same feature of the previous one, i.e.: - show product details panel; - download product; - show auxiliary list panel; - add or remove product to/from user cart; - add or remove product quicklooks to/from map.

calendar_new

calendar_new

The colour shading in the calendar indicates the publication density for each day, i.e. the darkest days in the calendar are the sensing dates on which the greatest number of products were published.

Client settings

Client settings panel is displayed on the browser clicking on application menu settings icon settingsicon.

This panel allows users to configure: * application language; * application theme; * the list of map layers visualized on search container map; * product metadata to be shown in product list.

Application language

User can choose application language, selecting one option from the Language combo and then clicking on save icon.

Available languages are: - Italian; - English; - French.

language

language

Once the preferred language has been configured, it is necessary to reload the OWC application to make the settings effective.

Application theme

Theme Editor is displayed on the screen by clicking on the Theme button reported in the Client settings panel.

theme

theme

Using this editor it is possible to configure: - application title, which is shown in the application main menu; - application logo, adding an url with logo information in the Logo Url input text. Please note that: - Logo Url must be such that it can be reached via browser; - chosen logo should be square to be displayed properly in the application menu; - application background color, using theme editor color selector; - background image, adding an url with image information in the Background Image Url input text. Please note that: - Background Image Url must be such that it can be reached via browser; - chosen image should be great enough to be displayed properly as background.

Theme settings are saved on browser local storage by clicking on the SAVE button.

Users can restore default theme settings by clicking on the RESTORE DEFAULT button.

It is necessary to reload the OWC application to make the settings effective.

Map settings

Map settings is displayed on the screen by clicking on the Map settings button reported in the Client settings panel.

map_settings

map_settings

This panel allows configuring the list of map layers which can be added in the application map, by specifing, for each layer: - if the layer is visible or not in the Search container map; - HTTP url of the web map server exposing the layer of interest; - a title, i.e. an identifier of the layer, which is shown in the list of available map layers when clicking on map layers icon layerswitcher; - layers name separated by comma (e.g. name1, name2, name3).

This configuration is saved on the browser local storage clicking on the SAVE button.

It is possible to add a layer by clicking on the add icon reported in the top left-hand corner of the panel.

It is possible to remove a layer by clicking on the deletion icon reported in the top right-hand corner of each layer section.

List settings

List settings is displayed on the screen by clicking on the List settings button reported in the Client settings panel.

metadata

metadata

This panel allows editing the schema used for the mapping between data model retrieved from the server when performing a query and information shown in the Product list.
At this stage of the OWC implementation, it is necessary to know the data model coming from the server to be able to make changes visible on the products list.

This configuration is saved in the browser local storage by clicking on the SAVE button.
Users can restore default list settings by clicking on RESTORE DEFAULT button.

Some examples are provided below to give indication about how to proceed with this configuration.

Add title to list item

This example shows how to add a title in the list item.
Add the following code in “model” section

{
    "@id": "title",
    "@type": "String",
    "valueExtractor": {
        "relativePath": "identifier"
    }
}

Click on the SAVE button and perform new search to see the result.

listsettings_ex1

listsettings_ex1

Add a new attribute to list item

This example shows how to add a new attribute “Satellite” that is taken from the model starting from the “indexes” array searching inside it the key "summary" that returns an array of Children's from which we extract "Satellite".

From product model:

[-,- {
    "id": 1683253,
    "uuid": "2eb3f85a-a2a7-4f5a-b16a-c6fdd88816be",
    .
    .
    .
    .

    "indexes": [{
        "name": "product",
        "children": [{
            "name": "Acquisition Type",
            "value": "NOMINAL"
        },
        .
        .
        .
        .
        ]
    }, {
        "name": "summary",
        "children": [{
            "name": "Date",
            "value": "2017-02-10T07:45:45.878Z"
        }, {
            "name": "Filename",
            "value": "S1B_IW_GRDH_1SDV_20170210T074545_20170210T074612_004235_007579_811E.SAFE"
        }, {
            "name": "Identifier",
            "value": "S1B_IW_GRDH_1SDV_20170210T074545_20170210T074612_004235_007579_811E"
        }, {
            "name": "Instrument",
            "value": "SAR-C"
        }, {
            "name": "Mode",
            "value": "IW"
        }, {
            "name": "Satellite",
            "value": "Sentinel-1"
        }, {
            "name": "Size",
            "value": "1.68 GB"
        }]
    },
    .
    .
    .
    .
    ],
    .
    .
    .
    .
},

In order to make visible the "Satellite" attribute in the product list, add this code snippet in “attributes” section

{
                        "@id": "Satellite",
                        "@type": "Object",
                        "valueExtractor": {
                            "@type": "Array",
                            "relativePath": "indexes",
                            "findWhere": {
                                "name": "summary"
                            },
                            "valueExtractor": {
                                "@type": "Array",
                                "relativePath": "children",
                                "findWhere": {
                                    "name": "Satellite"
                                },
                                "valueExtractor": {
                                    "relativePath": "value"
                                }
                            }
                        }
                    }

Click on the SAVE button and perform new search to see the result.

listsettings_ex2

listsettings_ex2

About

the About panel is shown on the screen by clicking on application logo.

about - labelled

about - labelled

This panel shows general information about the DHuS, software version and partners' logos.