33
Prepared by ESA SSA SWE Team (original SUM: P. Jacques, C. Noël, P. Beltrami, A. Luginin, U. Martinez) Reference SSA-SWE-SWEP-SUM-0001 Issue 1 Revision 4a Date of Issue 10/08/2018 Status Document Type SUM Distribution ESA UNCLASSIFIED – For Official Use esoc European Space Operations Centre Robert-Bosch-Strasse 5 D-64293 Darmstadt Germany T +49 (0)6151 900 F +49 (0)6151 90495 www.esa.int SSA DC-II SWE Portal Services (WP5) Software User Manual (excerpt 1 ) 1 This document is an excerpt from the original SUM, adapted for the end users of the SWE portal

Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

  • Upload
    others

  • View
    2

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Prepared by ESA SSA SWE Team (original SUM: P. Jacques, C. Noël, P. Beltrami, A. Luginin, U. Martinez)

Reference SSA-SWE-SWEP-SUM-0001

Issue 1

Revision 4a

Date of Issue 10/08/2018

Status

Document Type SUM

Distribution

ESA UNCLASSIFIED – For Official Use

esoc European Space Operations Centre

Robert-Bosch-Strasse 5 D-64293 Darmstadt

Germany T +49 (0)6151 900

F +49 (0)6151 90495 www.esa.int

SSA DC-II SWE Portal Services (WP5) Software User Manual (excerpt1)

1 This document is an excerpt from the original SUM, adapted for the end users of the SWE portal

Page 2: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 2/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

The copyright of this document is vested in the European Space Agency. This document may only be reproduced in whole or in part, stored in a retrieval system, transmitted in any form, or by any means electronically, mechanically, or by photocopying, or otherwise, with the prior written permission of the Agency.

Page 3: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 3/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

Title Software User Manual

Issue 1 Revision 4a

Author ESA SSA SWE Team (original SUM: P. Jacques et al.)

Date 10/08/2018

Approved by Date

ESA SSA SWE Team

Reason for change Issue Revision Date

CDR Delivery 1 0 20/09/2013

Implementation of CDR RIDs 1 1 12/11/2013

Implementation of FAT TRR and FAT RIDs 1 2 20/12/2013

Implementation of AR1 SPRs/SCRs 1 3 12/05/2014

Implementation of AR2 SPRs/SCRs 1 4 24/10/2014

Adaptation of the SUM for the end users of the SWE

portal

1 4a 10/08/2018

Issue 1 Revision 4e

Reason for change Date Pages (in original SUM) Paragraph(s)

Modification of chapter 1:

Move sections 4.1 (“Purpose”) and 4.3

(“Features”) of chapter 4 (“Purpose of the

Software”) to this chapter;

Removal of section 1.2.

10/08/2018 13, 16;

7

4.1, 4.3;

1.2

Removal of chapters 4, 5, 6, and 7 10/08/2018 13, 27, 28, 32 4, 5, 6, 7

Shortening of chapter 8 (“Operational Manual”):

removal of sections 8.5.3, 8.6, 8.7, 8.8, and 8.9

=> new chapter number 4

10/08/2018 58, 71, 71, 73, 74 8.5,3, 8.6, 8.7, 8.8,

8.9

Update of screenshots in chapter 8 10/08/2018 58ff 8

Removal of chapters 9, 10, and 11 10/08/2018 75 9, 10, 11

Page 4: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 4/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

Table of contents:

1 INTRODUCTION ............................................................................................................................. 6 1.1 Purpose ............................................................................................................................................................................... 6 1.2 Features .............................................................................................................................................................................. 6 2 APPLICABLE AND REFERENCE DOCUMENTS ............................................................................... 8 2.1 Applicable Documents .......................................................................................................................................................8 2.2 Reference Documents ...................................................................................................................................................... 10 3 TERMS, DEFINITIONS AND ABBREVIATED TERMS ..................................................................... 11 3.1 Acronyms ........................................................................................................................................................................... 11 3.2 Glossary ............................................................................................................................................................................. 11 4 OPERATIONAL MANUAL .............................................................................................................. 12 4.1 General ............................................................................................................................................................................. 12 4.2 Set-up and Initialisation .................................................................................................................................................. 12 4.3 Getting Started ................................................................................................................................................................. 13 4.4 Mode Selection and Control ............................................................................................................................................ 13 4.5 Normal Operations .......................................................................................................................................................... 14 4.5.1 General SWE Portal Operations .................................................................................................................................... 14 4.5.1.1 Pages View ................................................................................................................................................................... 14 4.5.1.2 User Registration ........................................................................................................................................................ 15 4.5.1.3 User Login ................................................................................................................................................................... 16 4.5.1.4 Start SWE Portal Application ..................................................................................................................................... 18 4.5.2 SWE Portal Application Operations ............................................................................................................................. 19 4.5.2.1 Application Layout ..................................................................................................................................................... 20 4.5.2.2 Search and List Time Series ...................................................................................................................................... 20 4.5.2.3 Show Metadata ........................................................................................................................................................... 23 4.5.2.4 Select a set of Data ...................................................................................................................................................... 23 4.5.2.5 Use Data Viewer .......................................................................................................................................................... 25 4.5.2.5.1 Show Data Viewer ................................................................................................................................................... 25 4.5.2.5.2 Save Data .................................................................................................................................................................26 4.5.2.5.3 Subscribe Alert and Data (currently not available) ...............................................................................................26 4.5.2.5.4 Show Data Metrics (currently not available) .........................................................................................................26 4.5.2.5.5 Table View ............................................................................................................................................................... 27 4.5.2.5.6 Chart View .............................................................................................................................................................. 28 4.5.2.5.7 Binary View .............................................................................................................................................................29 4.5.2.5.8 Case of Merged Data ...............................................................................................................................................29 4.5.2.5.9 Analyse Data .......................................................................................................................................................... 30 4.5.2.6 Modify Domain Preferences ....................................................................................................................................... 31 4.5.2.7 Modify Subscriptions (currently not available) ......................................................................................................... 32 4.5.2.8 View Statistics ............................................................................................................................................................. 33

Page 5: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 5/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

Table of figures:

Figure 1: SWE Portal Home Page .............................................................................................................................................. 13 Figure 2: Registration Request Page.......................................................................................................................................... 15 Figure 3: Login Page ................................................................................................................................................................... 16 Figure 4: Login Failed Page ........................................................................................................................................................ 16 Figure 5: Applications Registration Page .................................................................................................................................. 17 Figure 6: SWE Portal Application Page .................................................................................................................................... 18 Figure 7: SWE Portal Application Home .................................................................................................................................. 20 Figure 8: Data Discovery – Filter Effect .................................................................................................................................... 21 Figure 9: Data Discovery – Maching Time Series .................................................................................................................... 22 Figure 10: Data Discovery – Actions ........................................................................................................................................ 23 Figure 11: Data Discovery – Data Merging Refinement ........................................................................................................... 24 Figure 12: Data Display – Table View ....................................................................................................................................... 25 Figure 13: Data & Alert Subscription ........................................................................................................................................ 26 Figure 14: Metrics ...................................................................................................................................................................... 27 Figure 15: Chart View ................................................................................................................................................................ 28 Figure 16: Chart Zoom ............................................................................................................................................................... 28 Figure 17: Data Display – Binary View ..................................................................................................................................... 29 Figure 18: Data Discovery – Analyse Request .......................................................................................................................... 30 Figure 19: Data Discovery - Analyse ......................................................................................................................................... 30 Figure 20: User Preferences Management - Default User Domain .......................................................................................... 31 Figure 21: User Preferences Management - Personalised User Domain ................................................................................ 32 Figure 22: Subscriptions Management ..................................................................................................................................... 32 Figure 23: Data Provider Statistics ........................................................................................................................................... 33

Table of tables:

Table 1: Applicable Documents ................................................................................................................................................... 9 Table 2: Reference Documents ................................................................................................................................................. 10

Page 6: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 6/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

1 INTRODUCTION

1.1 Purpose

The SWE Portal provides an interactive Web user interface that links applications available in the SWE Data Centre with data sources available from various providers and incorporates a level of analysis capability.

The Portal is the centralized access point that allows users to access data from the SWE Data and Metadata Repository, allows them to customize their user area and perform data analysis on data and service products. Section 1.2 lists the set of features provided by the SWE Portal and its underlying services.

The (DC-II) SWE Portal is coherent with the development of the SN-I SWE Portal. It provides similar Web content with links to Federated Services and EOA Portals.

This document is an excerpt of the Software User Manual (SUM) originally created for Work Package 5 “SWE Portal Services” of the SSA (Space Situational Awareness) DC-II Prototype Tasking & Data Centres project [AD.1]. This Work Package was carried out for ESA by a consortium consisting of SPACEBEL as prime contractor supported by Rhea and etamax as subcontractors.

1.2 Features

The following features are provided by the SWE Portal:

Single sign-on

User and Applications registration

Discovery of data

Visualisation of data

Data analysis

Subscription to data

Definition and subscription to alerts

Display of metrics

Display of data import statistics

Web content management

User preferences management

Links to Federated Services and EOA portals

Display of portal usage statistics

Administration and access control

Page 7: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 7/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

The following features are provided by the user-driven services:

Use of open international standards

Generation of service metadata

Access to data, metrics, and data import statistics

Description of data analysis functions

Execution of data analysis functions

Subscription to data and alerts

The following features are provided by the data-driven services:

Harvesting of data and metadata from providers

Conversion of data formats

Persistence of data and metadata

Access to data and metadata

Distribution of data according to subscriptions

Generation of alerts according to subscriptions

Distribution of alerts according to subscriptions

Generation of metrics on pre-defined forecast data

Page 8: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 8/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

2 APPLICABLE AND REFERENCE DOCUMENTS

2.1 Applicable Documents

The following documents are applicable. The version and date information of these applicable documents can be found in [RD.1].

Ref. Title Code

[AD.1] DC-II Prototype Tasking & Data Centres: Statement of Work Appendix III to ITT

SSA-DC-CF-SOW-0002

[AD.2] DC-II Prototype Tasking & Data Centres: Special Conditions of Tender Appendix III to ITT

[AD.3] DC-II Prototype Tasking & Data Centres: Draft contract Appendix II to ITT

[AD.4] ECSS-E-ST-40C Space Engineering –Software: Tailoring for Ground

Segment Systems

QMS-EIMO-GUID-CKL-9500-

OPS

[AD.5] ECSS-Q-ST-80C Space Product Assurance - Software Product

Assurance: Tailoring for Ground Segment Systems

QMS-EIMO-GUID-CKL-9501-

OPS

[AD.6] ESA Security Directives ESA/ADMIN/IPOL(2008)6,

ANNEX 2

[AD.7] ESA Network Security Policy Implementation of the ESA Network

Security Policy

ESA/ADMIN(99)6

EISD-EPNS-00003

[AD.8] ESA Security Plan Template http://forum.esacert.esa.int/internal-

forum/esacerton/ESASystem-Security-Plan

---

[AD.9] Functional Requirements for a Space Weather Portal for the Pilot Data

Centres

SSA-DC-SW-RD-0002

[AD.10] ESA SSA CO-III Software Quality Model ---

[AD.11] ESA SSA CO-III TN-06 COSIF Development Guidelines and

Requirements

SSA-CS-SW-TN-0011

[AD.12] SSA Software Configuration Management SSA-CS-SW-CMP-001

[AD.13] SSA Preparatory Programme Information and Communication

Technologies Design Solution

---

[AD.14] SSA Systems Specification Document (Option 5) ---

[AD.15] SSA Precursor Services Software Development Baseline Specification SSA-DC-SW-SRB-001

[AD.16] EGOS-GEN-BIRFSW-TN-1002 EGOS-STU-BIRF-ICD-1001

[AD.17] SSA SOA Governance Model SSA-CS-SW-RD-0003

[AD.18] SSA Service and Data Metamodel SSA-CS-ESA-SD-0001

[AD.19] SWE Portal Services – Software Development Plan SSA-SWE-SWEP-SDP-0001

[AD.20] SWE Data Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0001

[AD.21] SWE Importer Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0002

[AD.22] SWE Data Distribution Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0003

[AD.23] SWE Alert Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0004

[AD.24] SWE Metadata Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0007

[AD.25] SWE Product Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0011

[AD.26] SWE Metrics Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0013

[AD.27] SWE User Data Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0020

Page 9: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 9/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

Ref. Title Code

[AD.28] SWE User Product Service – Software Requirements Specification SSA-SWE-SWEP-SRS-0030

[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200

[AD.30] File Service and File Listener – Interface Control Document SSA-CS-GEN-ICD-0002

[AD.31] Notification Service – Interface Control Document SSA-CS-GEN-ICD-0004

[AD.32] Email Service – Interface Control Document SSA-CS-GEN-ICD-0008

[AD.33] Log Service and Log Listener – Interface Control Document SSA-CS-GEN-ICD-0009

[AD.34] SSA DC-I Part 1 – ICT Support to Pilot Data Centre Implementation –

Software Design Document

SSA-DC-SW-SDD-0001

[AD.35] SSA DC-I Part 1 – ICT Support to Pilot Data Centre Implementation –

Single Sign-On and Access Management ICD

SSA-DC-SW-ICD-0001

Table 1: Applicable Documents

Page 10: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 10/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

2.2 Reference Documents

The following list of reference documents is for general guidance only and need not to be applied, but they should be given precedence over other documents covering similar topics. The version and date information of these reference documents can be found in [RD.1].

Ref. Title Code

[RD.1] SSA DC-II SWE Portal Services - Glossary SSA-SWE-SWEP-GLO-0001

[RD.2] SSA DC-II SWE Portal Services - Interface Control Document SSA-SWE-SWEP-ICD-0001

[RD.3] SSA DC-II SWE Portal Services - Software Design Document SSA-SWE-SWEP-SDD-0001

[RD.4] SSA DC-II SWE Portal Services - Software Release Document SSA-SWE-SWEP-SRelD-0002

[RD.5] SSA DC-II Deployment Architecture - Technical Note SSA-CS-GEN-TN-0003

[RD.6] SSA SWE SN-I Portal & Single Sign-On Service - Software User Manual SSA-SWE-PORTAL_SSO-SUM-0001

[RD.7] SWE Data Service User Manual SSA-SWE-SWEP-SUM-0002

[RD.8] SWE Import Service User Manual SSA-SWE-SWEP-SUM-0003

[RD.9] SWE Data Subscription Service User Manual SSA-SWE-SWEP-SUM-0004

[RD.10] SWE Alert Service User Manual SSA-SWE-SWEP-SUM-0005

[RD.11] SWE Alert Subscription Service User Manual SSA-SWE-SWEP-SUM-0006

[RD.12] SWE Metadata Service User Manual SSA-SWE-SWEP-SUM-0007

[RD.13] SWE Metrics Service User Manual SSA-SWE-SWEP-SUM-0008

[RD.14] SWE Dataset Downloader BP Service User Manual SSA-SWE-SWEP-SUM-0009

[RD.15] SWE Data Import BP Service User Manual SSA-SWE-SWEP-SUM-0010

[RD.16] SWE Data Subscription BP Service User Manual SSA-SWE-SWEP-SUM-0012

[RD.17] SWE Alert Subscription BP Service User Manual SSA-SWE-SWEP-SUM-0013

[RD.18] SWE Metrics Generation BP Service User Manual SSA-SWE-SWEP-SUM-0015

[RD.19] SWE User Utility Service User Manual SSA-SWE-SWEP-SUM-0016

[RD.20] SWE User Data Access BP Service User Manual SSA-SWE-SWEP-SUM-0017

[RD.21] SWE User Data Analysis BP Service User Manual SSA-SWE-SWEP-SUM-0018

[RD.22] SWE User Subscriptions BP Service User Manual SSA-SWE-SWEP-SUM-0019

[RD.23] SOA Principles of Service Design by Thomas Erl

http://serviceorientation.com/index.php/whatissoa/P27

ISBN: 0132344823

[RD.24] Liferay Portal Administration Guide

http://docs.liferay.com/portal/6.0/official/liferay-administrator-guide-6.0.pdf

---

Table 2: Reference Documents

Page 11: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 11/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

3 TERMS, DEFINITIONS AND ABBREVIATED TERMS

3.1 Acronyms

Acronyms used in this document and needing a definition can be found in [RD.1].

3.2 Glossary

A glossary of the terms and definitions used in this document can be found in [RD.1].

In this document, the technical term “Offering” used in other documents has been replaced by the term “Time Series” which is more appropriate for the End User. Both terms are equivalent.

Page 12: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 12/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4 OPERATIONAL MANUAL

4.1 General

The SSA DC-II SWE Portal is a major technological evolution of the precursor SSA SN-I SWE Portal, but from the user’s perspective the main visible change is the replacement of the SWENET application (actually a link to the SWENET Portal) by the new SWE Portal Application. Indeed, the user will notice that the “SWENET” link was replaced by the “Data Browsing and Analysis” link in the “My Applications” section of the left-panel.

Therefore, we refer the reader to the SN-I SWE Portal Software User Manual [RD.6] for all the pages that were not affected (i.e. preserved on purpose for consistency) by the SSA DC-II SWE Portal development. The focus of this document is mainly on the new SWE Portal Application.

The SSA DC-II SWE Portal Services Solution is normally operated through its SWE Portal. The underlying services are not exposed to the end user and are, therefore, not covered in this document. However, Service User Manual documents are available for each service (see [RD.7] to [RD.22]) and contain a description of the service interface.

The SWE Portal Application is a Web application available through a standard Web browser.

The application should be accessible as long as the Security means (firewall, etc.) between the user and the Web portal allow the (HTTP) communication.

4.2 Set-up and Initialisation

The following SWE Portal set-up procedures are described in the Software Release Document [RD.4]:

Software build

Software installation

Software configuration

Page 13: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 13/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.3 Getting Started

The portal can be accessed at http://swe.ssa.esa.int/web/guest using one of the following Web browsers:

Internet Explorer version 8 or higher

Firefox version 5 or higher

Chrome version 14 or higher

The first page displayed when accessing the SWE Portal is the Current Space Weather page as shown below.

Figure 1: SWE Portal Home Page

4.4 Mode Selection and Control

In order to access protected resources on the SWE Portal (e.g. SWE Portal Application and EOAs listed under the “My Applications” section of the left-panel), the user must be registered on the SSA Technical Web Portal.

The user may request its registration as explained below in section 4.5.1.2.

Page 14: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 14/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5 Normal Operations

This section first focuses on general user operations, then lists the operations related to the SWE Portal Application, and finally describes administration operations.

4.5.1 General SWE Portal Operations

4.5.1.1 Pages View

A set of HTML pages (some being portal links and some being external pages) are accessible through a site navigation menu located on the left section of every pages. Clicking on the HTML links leads to pages related to Space Weather information, user domains pages, expert service centres, applications, documents, helpdesk or also events.

The top navigation menu links to ESA pages on various portals: ESA, SSA, SWE, SST, and NEO.

Note that every pages mentioned in the later sections are accessible through the left-side navigation menu.

Page 15: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 15/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.1.2 User Registration

The user may request the creation of a user account on the SSA Technical Portal by filling the Registration Request form. The page is accessible in the Site Information section of the left navigation menu.

Figure 2: Registration Request Page

In order to request the registration on the SSA Technical Portal, the user has to fill in the above Request for Registration form. The following fields are mandatory: First Name, Last Name, User Name, Email Address. If approved, the user will receive an email with the username and password when the account has been created.

Page 16: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 16/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.1.3 User Login

From any page of the portal, the user clicks on the “Sign In” link (in the bottom left corner). The user is then redirected to the Authentication Service (SSA Technical Portal) login page.

The user enters the User Name and its personal Password, and then clicks on the Log In button.

Figure 3: Login Page

If the login is successful, the source page (before proceeding to the login) is displayed again with the user name displayed instead of the “Sign In” link.

In case the login fails, the message “Authentication failed” is displayed and the user may retry to log in by clicking on link “Return to Login page”.

Figure 4: Login Failed Page

Page 17: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 17/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

When the user logs in for the first time after registration, the user is redirected to the Application Registration page. The user selects the desired applications, and then clicks on “Send Registration” button.

Figure 5: Applications Registration Page

Page 18: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 18/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.1.4 Start SWE Portal Application

Once the user is logged in, the SWE Portal Application is then accessible by clicking the “Data Browsing and Analysis” link in “My Applications” section of the left-menu.

The following page is displayed:

Figure 6: SWE Portal Application Page

Page 19: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 19/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2 SWE Portal Application Operations

The SWE Portal Application consists in a main user interface view used to browse and analyse the data, and three secondary interface views used to manage and configure additional aspects:

User preferences: allows the user to customize the SWE Portal Application regarding his preferences.

Subscriptions: allows the user to manage, modify, and delete his own data or alert subscriptions.

Statistics: give statistics information about the SWE Data Providers.

This section describes the operations related to the SWE Portal Application.

Page 20: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 20/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2.1 Application Layout

The multiple interface views are accessible from the links present in the top menu of the SWE Portal Application (see figure below).

The main user interface of the SWE Portal Application is composed of three main panels:

Search Filters panel: it helps the user to find specific and relevant data in a wide collection of Time Series.

Search Results panel: it is a list of matching Time Series (a set of observation data) following the user filters query.

Advanced Data Selection panel: it is expanded when the user wants to group multiple data sources into a single request or when only a subset of fields must be selected.

Figure 7: SWE Portal Application Home

4.5.2.2 Search and List Time Series

The user may search for data of interest by filtering the Time Series using the Search Filters panel. Setting a filter reduces the list of data and possible values of other filters (as illustrated in the abstract representation below).

Page 21: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 21/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

Figure 8: Data Discovery – Filter Effect

The Search Data Filters panel includes the following fields:

User Domain: the user preferred domain is initially selected. The user may modify the field value by clicking on the widget and selecting a new available value. Note that for this specific filter, all possible values remain available whatever the value of other filters are.

Measurement Domain: the user may modify the field value by clicking on the widget and selecting a new available value. Note that the “None” value refers to the Time Series which are not linked to any measurement domain.

Provider: the company providing the data. The user may modify the field value by clicking on the widget and selecting a new available value.

Acquisition: the acquisition type (measured, processed, …). The user may modify the field value by clicking on the widget and selecting a new available value.

The Observable Properties filter lists the fundamental data types supported by the matching data. Observable Properties are ordered following the User Domain preferences. Selecting a subset of these observable properties reduces the list of Time Series to the ones that include one of these properties. The user may add or remove properties by adding or removing properties to the right list using the “add” and “remove” buttons.

The keywords filter searches in metadata (in the Time Series description and in the fields descriptions) for the matching Time Series. Keywords shall be separated by blank spaces. The filter matches the Time Series which contain all the entered keywords (not case

sensitive). To trigger the search, the “refresh” icon must be clicked ( ).

The Time Period filters on Time Series which include at least one data within the period. The user may modify the start or end date and time value by clicking on the calendar icon

( ).

By default, filters (except the user domain filter) are set to “All” which means that the considered filter accept any value of the available Time Series.

In the Time Series Results panel, the Time Series matching the filters query are listed in the order configured by the system administrator or user preferences (if configured by the user). The list may

be ordered alphabetically by clicking on the following button: . Then the list may be ordered again

by user domain preferences by clicking on the following button:

The Time Series Results table includes the following columns:

Page 22: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 22/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

Title: a maximum 64 characters title

Type: indicates the nature(s) of data included in the Time Series (a Time Series may include data of multiple types)

Actions: available command buttons

Figure 9: Data Discovery – Maching Time Series

Types are represented by graphical icons described below. A tooltip is displayed when the mouse is moved over the icon.

Text:

Numeric values (a chart maybe generated automatically):

Static plot image:

Map image:

Other kind of images:

The action buttons are illustrated below. A tooltip is displayed when the mouse is moved over the icon.

Display of Time Series metadata:

Display data in a viewer:

Analyse data:

Add the data in the basket (Advanced Data Selection panel):

Remove the data present in the basket (Advanced Data Selection panel):

Page 23: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 23/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2.3 Show Metadata

When clicking on the “display Time Series metada” icon ( ), the available metadata information about the Time Series are displayed to the user, as illustrated on the figure below.

Some sections may be expanded ( ) or collapsed ( ) by clicking on the respective button.

Figure 10: Data Discovery – Actions

The window can be closed by clicking on the close button ( ) or clicking anywhere outside the window.

The window can be moved anywhere in the browser page, by clicking in the window header and doing a drag-and-drop.

4.5.2.4 Select a set of Data

When clicking on the “add data” icon ( ), the Advanced Data Selection panel is expanded, and the Time Series is added to the basket. This basket is intended to define a collection of data in order to merge (compare in a single chart), subscribe (detailed further) or analyse the group of multiple data (as explained above).

Page 24: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 24/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

In the Advanced Data Selection panel, the user may modify the requested observable properties (or more specifically the desired fields) for each Time Series. As illustrated in Figure 11, any field may be selected or unselected. By default, all fields in all observable properties are selected.

When the user selects/unselects a Time Series or a property, all the fields related to the Time Series (or to the property) are also selected/unselected.

When the user is satisfied with the collection of data and the selected fields, the “View” button triggers the visualisation in the viewer, and the “Analyse” button displays the Analyse panel.

Figure 11: Data Discovery – Data Merging Refinement

Note that, when the Portal configuration is not completely fulfilled, some fields may not be categorised by property. In that case, these fields are grouped at the bottom of the list, in an expanded group named “Additional Data”.

Page 25: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 25/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2.5 Use Data Viewer

4.5.2.5.1 Show Data Viewer

When clicking on the “visualise data” icon ( ), the data viewer is displayed.

The View Data panel is a floating window used to visualise any data requested by the user.

In the left side panel, the list of the possible views is displayed:

“Table View (all fields)” displays all the fields in a common table (see Figure 12).

“Chart View (numerical fields)” groups all the numeric fields (integer, float, etc.) in a single chart view.

For any binary field, a dedicated view is also available.

Figure 12: Data Display – Table View

Note that only data corresponding to the time period filter in the search data filter area is retrieved.

The window can be closed by clicking on the close button ( ).

The window can be moved anywhere in the browser page, by clicking in the window header and doing a drag-and-drop.

Up to four viewer windows may be opened at the same time.

Page 26: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 26/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2.5.2 Save Data

When clicking on the save button ( ), the whole XML document returned by the GetData operation is displayed in the browser. The document may be saved on the local machine by using the browser save functionality (usually right-click anywhere on the page then choose “Save” in the displayed options).

Note that the saved data is in the Observation & Measurement format (ISO 19156 or OGC 10-004r3) and is encoded in XML according to the OGC 10-025r1 specification.

4.5.2.5.3 Subscribe Alert and Data (currently not available)

When clicking the subscription button ( ), a pop-up window is displayed (as shown on the figure below).

Figure 13: Data & Alert Subscription

The user shall choose the subscription type (alert or data subscription), the format, the protocols, and the related sub-fields (e.g. Email address for the Email protocol).

In case of an alert subscription, the user should define a set of thresholds based on the field values.

The user subscriptions may be managed on a dedicated Subscriptions Management page of the portal described in a later section.

4.5.2.5.4 Show Data Metrics (currently not available)

The user may display the metrics available for a Time Series by clicking on the metrics button ( ). The list of metrics is displayed in a table.

The metric values and related information are displayed when the user clicks in the specific row of metrics.

Page 27: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 27/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

Figure 14: Metrics

4.5.2.5.5 Table View

In the viewer, the table may be selected by clicking on the following tab:

In the table view, the following functionalities are available:

Sorting: when clicking on the sorting icon ( ), the table is ordered ascendantly (first click) or descendantly (second click).

Filtering: when clicking on the filtering icon ( ), the filtering inputs are displayed

( ) and the table is filtered according to the entered values.

Hiding: when clicking on the hiding button ( ) the column is then removed from the table.

The user may reset the sorting, filtering, and initially displayed columns by clicking on the reset

icon ( ) in the first column.

Note also that it is not possible to filter on the time column.

Page 28: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 28/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2.5.6 Chart View

In the chart view, the single or multiple fields are displayed in the chart.

Any field may be hidden individually by clicking on the icon ( ). The mouse over a field in the list makes the field line to be highlighted.

Figure 15: Chart View

The following options may customize the displayed chart:

Chart Type: the types Line, Bar, Area, Scatter, Stack may be chosen to modify the chart aspect.

Interpolation: the methods Linear, Point-to-point, Cardinal, B-Spines may be chosen to modify the values interpolation.

If the number of values is too high, the user shall navigate through the data using the sliding buttons at the bottom of the panel.

Figure 16: Chart Zoom

Page 29: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 29/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2.5.7 Binary View

In the binary view, the various binary pictures are displayed individually. The user shall navigate through the pictures using the sliding buttons at the bottom of the panel.

The “Play” button triggers an automatic sliding of the pictures. The sliding shall be paused using the “Stop” button.

Figure 17: Data Display – Binary View

4.5.2.5.8 Case of Merged Data

In case of the display of a basket (from the Advanced Data Selection panel), the user may display a merged visualization of the data. The user shall choose between the table view or the chart view.

In the chart view, the user still can hide the various fields and modify the chart options.

Page 30: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 30/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2.5.9 Analyse Data

When clicking on the “analyse data” icon ( ), the user is prompted to specify the analysis process to execute on the data, as illustrated on the figure below.

Figure 18: Data Discovery – Analyse Request

In the case of the Plot function2, the user shall specify the chart style, y-range, y-scaling, the time format and chart title.

Note that the analysis is executed on data corresponding to the time period filter in the search data filter area.

Figure 19: Data Discovery - Analyse

2 Only the gnuplot data analysis function (on a single dataset) is implemented as part of the SSA DC-II SWE Portal

Services project.

Page 31: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 31/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

The user shall click on the “Analyse” button in order to display the result image.

4.5.2.6 Modify Domain Preferences

The SWE Portal Application may be personalised on a dedicated user preferences page of the portal by clicking on the “User Preferences” link in the application header.

Figure 20: User Preferences Management - Default User Domain

The user may select to get all user domain Time Series by clicking “All”, or to select one of the user domains defined in Appendix A of [RD.3], or the “Personalised Domain”. By default, the “All User Domains” is pre-selected for all users.

Depending on the user domain selected, a specific list and order of the observable properties, scientific domains, and data Time Series is applied on the Data Discovery interface.

If the “All User Domains” is selected, all observable properties, scientific domains, and data Time Series are available and the sorting configured (in the User Utility Service) for all user domains is applied.

If one of the user domains defined in Appendix A of [RD.3] is selected, the sorting and list of available observable properties, scientific domains, and data Time Series configured (in the User Utility Service) for that user domain is applied.

If the “Personalised User Domain” is selected, the sorting and list of available observable properties, scientific domains, and data Time Series may be created and modified by the user as shown below in Figure 21.

The user is able also to add (or remove data) Time Series in his data Time Series list by moving the left Time Series list entries to the right (the opposite to remove entries). The user is able to define the sorting by moving up and down the elements of the right selection list.

Page 32: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 32/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

Figure 21: User Preferences Management - Personalised User Domain

The user shall click on “Save” to update the application preferences.

4.5.2.7 Modify Subscriptions (currently not available)

The user may access the Subscriptions Management by clicking on the “Subscriptions” link in the application header.

Each subscription may be selected and modified by the user as shown on the figure below. Note that it is not possible to modify an alert subscription into a data subscription.

After any change of a subscription, the user shall click on the “Update” button. In order to delete a subscription, the user may click on “Delete” button.

Figure 22: Subscriptions Management

Page 33: Software User Manual - ESAswe.ssa.esa.int/DOCS/SSA-DC/SSA-SWE-SWEP-SUM-0001.pdf[AD.29] SWE Portal Services – Software Requirements Specification SSA-SWE-SWEP-SRS-0200 [AD.30] File

Page 33/33

Software User Manual

Date 10/08/2018 Issue 1 Rev 4a

© Copyright European Space Agency, 2012

ESA UNCLASSIFIED – For Official Use

4.5.2.8 View Statistics

To display the Statistics page, the user shall click on the “Statistics” link in the application header.

The Statistics page contains the list of datasets, the update rate, data volume and last update. The list may be filtered by Data Provider.

Figure 23: Data Provider Statistics