D21.4 Certification Toolkit User Manual

taupesalmonInternet και Εφαρμογές Web

21 Οκτ 2013 (πριν από 3 χρόνια και 9 μήνες)

97 εμφανίσεις


REPORT

Copyright © 2011
ESA

and other members

of

the SCIDIP
-
ES Co
nsortium, www.scidip
-
es.eu



SCIDIP
-
ES EC Grant Agreement n°.
283401


1






D
21
.
4

Certification Toolkit

User Manual


Work package

WP
21

Services/Toolkits Development and Adaptation




Task




Author (s)

Brian Ritchie
,

Shirley Crompton

STFC

Author (s)

Christian Ceprani

ACS

Author (s)

Holger Brocks

ICT

Author (s)

Yannis Marketakis

FORTH

Author (s)

Felix Engel

FTK

Author (s)

Jinsongdi Yu

JU

Author (s)

Luigi Briguglio
, Pasquale Andriani

ENG

Authorized by



Reviewer

Name Surname

Company

Doc Id


Dissemination Level

CONFIDENTIAL/PUBLIC

Issue

1.0

Date

09/04
/201
3





REPORT

Copyright © 2011
ESA

and other members

of

the SCIDIP
-
ES Co
nsortium, www.scidip
-
es.eu



SCIDIP
-
ES EC Grant Agreement n°.
283401


2

Abstract
:

This document represent
s

the User Manual for the
Certification Toolkit

developed in the frame of
SCIDIP
-
ES project. This document

contains
all useful information on how to
install (if applicable),
configure and
use the
Certification Toolkit
.


SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


4


Document Log

Date

Author

Changes

Version

Status

04/02
/201
3

Shirley Crompton
,
Brian
Ritchie
, Christian
Ceprani, Holger
Brocks, Yannis
Marketakis, Felix
Engel, Jinsongdi Yu,
Pasquale Andriani
and
Luigi Briguglio

First draft for internal
review

0.1

Draft

09/04
/2013

Brian Ritchie

Initial draft

0.2

Draft










SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


5



TABLE OF CONTENTS


................................
.....................

1

1

INTRODUCTION

................................
................................
................................
................................
...........................

6

1.1

P
URPOSE AND
S
COPE

................................
................................
................................
................................
................

6

1.2

W
HO SHOULD READ THIS
DOCUMENT
................................
................................
................................
......................

6

1.3

S
YSTEM
C
ONTEXT

................................
................................
................................
................................
.......................

6

1.4

R
ELEASE
N
OTES

................................
................................
................................
................................
..........................

6

2

INSTALLATION GUIDE

................................
................................
................................
................................
.............

6

2.1

O
VERVIEW

................................
................................
................................
................................
................................
.....

6

2.2

P
REREQUISITES

................................
................................
................................
................................
...........................

6

2.2.1

S
OFTWARE PREREQUISITE
S

................................
................................
................................
................................
..................

6

2.2.2

H
ARDWARE PREREQUISITE
S

................................
................................
................................
................................
.................

7

2.3

OSS/COTS

I
NSTALLATION

................................
................................
................................
................................
.......

7

2.4

C
ERTIFICATION
T
OOLKIT
I
NSTALLATION

................................
................................
................................
................

7

2.4.1

D
ATABASE CONFIGURATIO
N

................................
................................
................................
................................
..................

7

2.4.2

W
EB APP CONFIGURATION

................................
................................
................................
................................
.....................

7

2.
5

U
NINSTALLATION

................................
................................
................................
................................
.........................

8

3

USING SCIDIP
-
ES CERTIFICATION TOO
LKIT

................................
................................
................................

8

3.1

O
PENING THE
C
ERTIFICATION
T
OOLKIT

................................
................................
................................
.................

8

3.2

L
OGGING IN

................................
................................
................................
................................
................................
...

8

3.3

T
HE
A
SSESSMENT
F
ORM

................................
................................
................................
................................
...........

9

3.3.1

T
HE
Q
UESTIONS AND
A
NSWERS

................................
................................
................................
................................
.......

11

3.3.2

T
HE
R
EFERENCES PAGE

................................
................................
................................
................................
......................

12

4

TROUBLESHOOTING COMM
ON ISSUES

................................
................................
................................
.......

13

4.1

S
ESSION TIMEOUTS

................................
................................
................................
................................
...................

13

ANNEX A.

FIGURES AND TABLES
................................
................................
................................
..........................

14

A.1.

L
IST OF
F
IGURES

................................
................................
................................
................................
......................

14

A.2.

L
IST OF
T
ABLES

................................
................................
................................
................................
........................

14

ANNEX B.

TERMINOLOGY

................................
................................
................................
................................
..........

15





SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


6

1

Introduction

1.1

Purpose and Scope

This document provides an overview of the

M18 release of the

Certification Toolkit

focusing in
particular to its installation and usage.

1.2

Who should read this document

Users who may want to understand and operate the
Certification Toolkit
.

1.3

System Context

The Certification Toolkit is used independently within the Scidip
-
es infrastructure
to support
repositories that wish to perform a self
-
assessment for trustworthy repository status in line with ISO
16363 specification
1
.

1.4

Release Notes

This release demonstrates the assessment form UI and the ability to store and retrieve answers and
inform
ation about reference documents to and from the database. Future releases will:



Support a richer user / project / assessment model



Support user registration and the provision of a role
-
based authorisation model.



Allow storage of reference documents in the
database



Link references directly to particular answers



Provide a
template
-
based custom
report generation capability


2

Installation
Guide

The Certification Toolkit is a web application that uses a MySQL database to store users’ assessment
data in preparatio
n for ISO16363 certification. Its current design assumes that the web server and
database are hosted on the same server, but this may be relaxed in future.



2.1

Overview

The Certification Toolkit requires an initial database to be created in MySQL using a pro
vided
DDL
load
script. The toolkit itself is packaged as a WAR file to be deployed in Tomcat7.


2.2

Prerequisites

2.2.1

Software prerequisites

Software prerequisites respect SCIDIP
-
ES guidelines and include:



Tomcat version 7
2




1

http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=56510

2

Tomcat
version

7
-

http://tomcat.apache.org/tomcat
-
7.0
-
doc/



SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


7



MySQL 5.5

The web application is based on Java Server Faces
(JSF)
and the PrimeFaces extension library. These
should already be included in WEB
-
INF/lib in the main project. (Maven should
supply these during the
build if they are not provided
.)

Note that initial cre
ation and population of the database is not yet added to the maven configuration;
for the moment, this will have to be done
manually

before the web

app
lication

can be deployed.

In the next section it will be assumed that the
$
TOMCAT_HOME is
configured
.

2.2.2

Ha
rdware prerequisites

None.

2.3

OSS/COTS Installation

None.

2.4

Certification Toolkit

Installation

2.4.1

Database c
onfiguration

The Certification Toolkit uses a database called “repocert” to
store
both static and dynamic data. The
static data includes the set of
ISO16363

questions and
content
page/section structure and ordering;
the dynamic data includes users, projects, assessments and answers.

Database management scripts are contained in the RepoCert
-
Data project in the
Scidip
-
es
sourceforge
site. Normally, it should on
ly be necessary to run the initial load script. Other scripts are defined to
create
/
drop the tables, and to populate the static tables. The latter script does not include the
ISO16363 q
uestions, which should be loaded from three csv files (questions
-
page[2
-
4].csv) using the
appropriate SQL statements from sample
-
queries.sql.

Use the file repocert
-
load.sql to create the database, tables and
populate the
initial data, by running
the following command line in a standard shell:


shell> mysql < repocert
-
load.sql

At present, the database connection details are hard
-
wired into both the script and the web
application code, as:


Connection string: jdbc:mysql://localhost/repocert


Username: certuser


Password: cujimmy25


2.4.2

Web app configuration

Assuming that Tomcat is
install
ed and

running:

1.

Copy
certification
-
toolkit
.war

in $TOMCAT_HOME/webapps


SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


8

It should now be possible to visit:

http:/
/localhost:8080/certification
-
toolkit/

in a web browser; this should go to the Toolkit’s Login page.


2.5

Uninstallation

The Certification
Toolkit

can be uninstalled by undeploying the war packages
certification
-
toolkit
.war

and
dropping
the
repocert

database in MySQL.

3

Using SCIDIP
-
ES
Certification Toolkit

3.1

Opening the Certification Toolkit

Visiting the URL:

http:/
/localhost:8080/certification
-
toolkit/

in a web browser; this should go to the Toolkit’s Login page.


Figure 1
: Certification Toolkit login page

3.2

Logging in

There is only one user at present, with username and password both set to
guest
, who has a single
project, and a single assessme
nt under that project. (The database design supports multiple users,
projects and assessments, but there is no UI to manage them yet; this is pending the gathering of
requirements for the desired user / project / assessment model.)


SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


9

Once logged in,

the

gues
t’s homepage appears, listing the

predefined

single project and assessment.
Click on the Edit button next to open the main assessment completion form.


Figure 2: User’s homepage

3.3

The Assessment Form

The assessment is presented as a number of tabs along the top of the page.
In the initial view, the first
tab is shown. This contains notes on how to prepare for an ISO16363 assessment.


SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


10


Figure 3: First page of the assessment form

The second, third and fourth tabs contain
other sections of

assessment questions and answers. The
final tab contains a list of (details about) documents referred to in the user’s answers to the
assessment.

Each page of questions is split into multiple sec
tions, presented as “accordion” panels. Only
one
section can be open at a time. Clicking on the heading of a collapsed section will open it and collapse
the currently
-
open section (if any). Clicking on the open section’s heading will collapse it.


SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


11


Figure
4: initial view of the second page of the assessment, showing the first question

The questions within each section are also presented as collapsible accordion panels, but multiple
questions can be open at the same time.


Figure 5: Assessment page 2, showi
ng all sections, with the first expanded (all questions collapsed)

3.3.1

The Questions and Answers


SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


12

Each question
(see Figure 4 above)
consists of:



A short title (sometimes just a section number)



A “metric” that describes the question in detail



A “supporting text
” that explains the need for this question



One or more examples of evidence / explanation / documents that could be used to
support the answer

Beneath each question are text areas into which the user should enter some descriptive evidence and
explanation.

Each question / answer section has buttons labelled “Save this answer” and “Reset this answer”.
Clicking on

Save


updates the answer in the database (
i.e.
replacing any previously

saved answer).
Clicking on

Reset


will reload the answer data from the dat
abase, thus overwriting any unsaved
changes.


Note that
neither operation can be undone, nor

is
there any

confirmation dialog.

Similar commands to Save or Reset the entire assessment form are at the top of the page.

3.3.2

The References page

This page contains a

table giving details of
the
documents that the user
has provided

as
certification
evidence. The

existing

data
matches those

listed in the original ISO16363 spreadsheet

that the
Certification Toolkit is based on
.


A
n input form

below the table

allows new d
ocuments to be added.


Figure 6: The References page

The current implementation does not support

edit
ing

or remov
al of

references once they have been
added.

The functionality will be provided for the next iteration.



SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


13

4

Troubleshooting Common Issues

4.1

Session timeouts

The user session will time out i
f the application is left
unattended for a predefined duration
.


It is
recommended that user should
save changes frequently, rather than to attempt to complete the
entire form and then save at the end.

Once
the session has timed out, the user will have to re
-
visit the top
-
level URL in order to restart the
application.



SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


14

Annex A.

Figures and Tables

A.1.

List of Figures

Figure 1


Orchestration Service component model

................................
...

Error! Bookmark not defined.

Figure 2


Orchestration Service Artifacts

................................
...................

Error! Bookmark not defined.

Figure 3


Orchestration Service main menu

................................
..............

Error! Bookmark not defined.

Figure 4


Add a Topic

................................
................................
..................

Error! Bookmark not defined.

Figure 5


Add Topic result

................................
................................
..........

Error! Bookmark not defined.

Figure 6


Add a Subscriber
................................
................................
..........

Error! Bookmark not defined.

Figure 7


Add Subscriber result

................................
................................
..

Error! Bookmark
not defined.

Figure 8


Subscriber & Topic hierarchy

................................
......................

Error! Bookmark not defined.

Figure 9


Add a Publisher

................................
................................
...........

Error! Bookmark not defined.

Figure 10


Add Publisher result

................................
................................
..

Error! Bookmark not defined.

Figure 11
-

Publisher & Topic hierarchy

................................
.......................

Error! Bookmark not defined.

Figure 12


Send Notification

................................
................................
.......

Error! Bookmark not defined.

Figure 13


Browse Alert view

................................
................................
.....

Error! Bookmark not defined.


A.2.

List of Tables

Non è stata trovata alcuna
voce dell'indice delle figure.




SCIDIP
-
ES

SCIence Data Infrastructure for Preservation


Earth Science


SCIDIP
-
ES EC Grant Agreement n°.
283401


15

Annex B.

Terminology

ACRONYM

DESCRIPTION

AIP

Archival Information Package

ARK

Archival Resource Key

CDMI

Cloud Management Interface

DDL

Data Definition Language

ES

Earth Science

GIS

Gap Identification Service

KB

Knowledge
Base

OS

Orchestration Service

OWL

Web Ontology Language

PI

Persistent Identifier

PNM

Preservation Network Model

PURL

Persistent Uniform Resource Locator

RDF

Resource Description Framework

RepInfo

Representation Information

SNIA

Storage Networking
Industry Association

SWKM

Semantic Web Knowledge Middleware

VM

Virtual Machine

WP

Work Package

XAM

eXtensible Access Method

XML

eXtensible Mark
-
up Language