vre exploitation

VRE Exploitation

Panagiota KoltsidaNKUA

Training Event30 4 2009

Rome(Italy)

www.d4science.eu

2

www.d4science.eu

Overview

VRE exploitation30 April 2009, Rome (Italy)

Available portlets How to use the portlets

Description of each different portlet Description of each different functionality

Plans for portlets

3

www.d4science.eu

Available Portlets

Many different portlets have been developed so as to offer the desired functionality

There are portlets acting independent and other portlets that communicate in order to provide the requested functionality

Application logic of all portlets is based on ASL (Application Support Layer) which is based on the gCube system

Some portlets are now going to use the ASL

For accessing the portlets visit the D4Science’s portal at: http://portal.d4science.research-infrastructures.eu/vre/vre


http://portal.d4science.research-infrastructures.eu/vre/vre

4

www.d4science.eu

Login Portlet

The VO/VRE login portlet is the first step for logging in to a VRE

Users can select one of the VREs that they have access and log in to the selected VRE

The available portlets for this VRE are then loaded Depending on user’s roles some portlets may not be displayed


5

www.d4science.eu

Search functionality

Search is the most important functionality in the gCube system

Different types of searches are available. Depending on the desired results users can choose what type of search to perform

Search types Simple search Combined search Geospatial search Quick search Google search Collection’s browsing Search in previous results


6

www.d4science.eu

Search functionality

The combined, geospatial, simple and collection’s browsing require as the first step to select the collections you want to search through

Browsing can be performed only on one selected collection When a collection is selected the portlet dynamically

updates the available metadata schemas, the searchable and sortable fields and the browsable fields

Avoids to search in non valid fields Uses common metadata schemas in multiple selected collections Identifies if simple search is available (full text index existence) Identifies if geospatial search is available (geospatial index

existence)


7

www.d4science.eu

Search functionality – Collections Navigator Portlet

Collections navigator portlet shows the available collections in a tree hierarchy

The first level of nodes represents a collections group and each collection group contains several collections

For the most collections a description is available under it’s name

Full description is available by clicking on the ‘more’ link


8

www.d4science.eu

Collections Navigator Portlet

Using this portlet it is able to Select and unselect collections by clicking on collection’s name or

on the checkbox Search through collections name and/or description for a keyword

• Makes easier to identify the collections you would like to select Refresh the available collections.

• Retrieves again the available collections for this VRE from the gCube system


9

www.d4science.eu



A closed Collection

Group

An open Collection

Group

Click on more link to see the full description

10

www.d4science.eu



Collections that contain the

word “time” in their name or description

11

www.d4science.eu

Search functionality – Search Portlet


The search portlet provides 5 different types of search. Combined search Geospatial search

• Requires the geospatial portlet Simple search Browse a collection Search in previous results

12

www.d4science.eu

Search Portlet – Combined search


Combined search Select as many collections as you like and then type as many

keywords as you like Select the fields you want to search in

• Field: ‘Any’ searches everywhere in the selected collections Add as many conditions as you like by clicking on the ‘+’ icon Remove a condition by clicking on the ‘-’ icon If more than one conditions are available specify if the results

should match all the conditions or any condition• The default value is to match any condition

13

www.d4science.eu



14

www.d4science.eu


2 conditions will be used for this search

The results will be sorted by title in ascending order

The results will match any of the 2 conditions

Selecting the ‘Search per collection’ option the results will be displayed per each collection separately

This option is available when more than one collection is selected


15

www.d4science.eu

Search Portlet – Geospatial search


Geospatial search Available only for collections with geospatial index It is notified by the search portlet to be enabled or disabled

depending on the existence of geospatial indexes Use the map to specify a geographical area to search in Click the ‘Search’ button at the ‘Combined’ search panel to submit a

search Users can either submit a geospatial search only or add also some

conditions at the ‘Combined’ search and then click the ‘Search’ button

16

www.d4science.eu

Geospatial portlet – Select an area


There are 3 ways to select an area Select the Country / Zone from the dropdown list placed on the top

of the map

17

www.d4science.eu



Click on the rectangular selection and activate it Click on the map to set the starting point Move the mouse on the map Second click to close the select operation The tool automatically zooms the selected area.

18

www.d4science.eu



Click on the polygonal selection and activate it Click on the map to set the starting point Move the mouse on the map Each click after the first will specify the next vertex to add

at the polygon Double click to close the select operation The tool automatically zooms the selected area

19

www.d4science.eu



20

www.d4science.eu

Geospatial portlet – Optional parameters


Query Area Selection specifier which has three possible values: inside, intersect, contains

Geo-coordinates of the selected area automatically updated depending on the user’s selection

Calendar tool which allows to specify a date interval for the retrieved documents

Clicking on the calendar icon will cause the date picker opening

21

www.d4science.eu

Search Portlet – Simple search


Simple search Searches everywhere inside the selected collections Choose the metadata schema that it will be used Type as many keywords as you like in the text area

Simple search may not be available when selecting a metadata schema that does not have a full text index.

• An error message appears informing the user about this case

22

www.d4science.eu

Search Portlet – Simple search


23

www.d4science.eu

Search Portlet – Collections Browsing


Browse a collection When only one collection is selected a browse can be performed Users have 2 options for browsing

• Browse all the contents of a colllection• Browse the distinct values of the selected field

Specify the sorting order of the results• Ascending order is the default one

Specify the number of results per page• 10 results per page is the default value• 50 results is the maximum number you can specify

24

www.d4science.eu

Search Portlet – Collections Browsing


• If a user will ask to see more than 50 results then a message appears and the default values is set• Information buttons are available, explaining result of each different type of browse

25

www.d4science.eu

Search Portlet – Search in Previous Results


Search in Previous Results Refines the search results of the previous ‘simple’ and ‘combined’

queries that performed during the current session The previous queries can be browsed again to see the same results The previous queries can be refined by searching for new keywords

in the existing results• Users can add as many conditions as they like• If more than one conditions are available specify if the results

should match all the condition or any condition» The default value is to match any condition

26

www.d4science.eu



27

www.d4science.eu



28

www.d4science.eu

Quick Search Portlet


Quick Search Provides an easy way to search through the available collections

by specifying only the keywords and without selecting any collections

The system automatically identifies the most appropriate collections to search, taking into account the keywords specified by the user

• The collections that are searched are the ones that contain highest number of occurrences of the given keywords

29

www.d4science.eu

Google Search Portlet


Google Search Provides a way to search Google and display the results in the

results portlet Due to Google limitation the system returns at most 10 results

30

www.d4science.eu

Results Portlet


For all types of search the results are displayed by the results portlet

For all types of search except the browsing 10 results per page are displayed

User can change the way the results are displayed by using the ‘UserProfile’ portlet

User can navigate throughout the results User can see a set of information for each result object User can perform a set of actions for each result object

31

www.d4science.eu

Results Portlet


A results page

32

www.d4science.eu

Results Portlet – Navigate through results


The navigation through the results can be done using the next and previous buttons

The total number of results is available as soon as possible The time needed to calculate the total number of results depends

on the size of the results

Total number of results

33

www.d4science.eu

Results Portlet – Get information for a result


For each result object the information below are available

Object’s Metadata Alternative representation Object’s Parts Object’s Annotations

If these information exist, a further tab is shown next to the Tab Object.

34

www.d4science.eu

Results Portlet – View metadata


Click on the metadata tab All the available metadata are shown

By clicking on the metadata a pop window appears showing the specific metadata for this result object

35

www.d4science.eu

Results Portlet – View metadata


• 2 options are available:•View the metadata in a formatted way using the metadata XSLT from user’s profile •View the metadata in XML format

36

www.d4science.eu

Results Portlet – Actions for a result object


For each result object several actions can be performed View Content: It opens a popup window that contains, and

displays the content. Save Content: Forces browser to ask to save the content in you

local disk. Manage Annotations: You can add /remove / edit annotations for

this object. View Metadata: You can view record's metadata. Edit Metadata: You can edit record's metadata.

37

www.d4science.eu



D4Science’s logo icon is the ‘Action’ button. Click this button to see the available actions.

38

www.d4science.eu



Actions related to ‘basket’ can be performed per result object

The ‘basket’ is a personal user area, different for each VRE

A result object can be saved to basket A page with all the results can be saved to basket Object’s metadata, alternative representations, a part or annotation

(if any) associated to a result. Can be saved to basket Everything that is dragged to basket is temporarily saved,

only for the active session. In order to save the basket items permanently the user should click on the ‘save’ button

39

www.d4science.eu



Save a result object to basket The move cross next to each text, highlighted with the red circle in

the figure below, should be used The same icon is available for dragging the metadata, annotations

and alternative presentations

40

www.d4science.eu

Results Portlet – Basket


A basket with several objects The ‘save’ button should be clicked to persist the basket

41

www.d4science.eu

Results Portlet – More Actions


It is possible to save the query that produced the results currently shown by the results portlet

Browse cannot be saved Click on ‘Move Query to basket’ button

For more information about how to use the results portlet click on the ‘See Help’ button

Choose a name for the saved query or use the

proposed one

42

www.d4science.eu

Annotations Portlet


Annotations portlet Provides an easy and sufficient way to annotate gCube information

objects Displays the existing annotations for the information object Provides a way to add a new annotation 3 different types of annotations are available

• Text annotation (Generic annotations)• Associations (Generic annotations)• Anchored annotations

» Available only for images and text objects

43

www.d4science.eu

Annotations Portlet


Display of the existing annotations The existing annotations are displayed by showing the ‘Title’ of

annotation, the author and the creation time An annotation can be edited or deleted by clicking on the

corresponding buttons

44

www.d4science.eu

Annotations Portlet – Display annotations


45

www.d4science.eu

Annotations Portlet – Create Annotations


Create an annotation by clicking the "Add Annotation" button have to be clicked.

Create a ‘Text Annotation’ Create an ‘Association’

46

www.d4science.eu

Annotations Portlet – Add Text Annotation


Add a text annotation Write a ‘Title’ for the annotation Write the ‘Text’ of the annotation Click the ‘OK’ button

47

www.d4science.eu

Annotations Portlet – Add Association


Add an association Write a ‘Title’ for the annotation Select the associated object by the objects existing in basket. Click the ‘OK’ button

48

www.d4science.eu

Annotations Portlet – Delete Annotation


Delete an annotation Click the ‘delete’ button which exists just next to each annotation

49

www.d4science.eu

Annotations Portlet – Edit Annotation


Edit an annotation Click the ‘edit’ button which exists just next to each annotation Click the ‘OK’ button

50

www.d4science.eu

Annotations Portlet – Apply changes


All changes in annotation are temporarily kept in the session

Click on the ‘Apply Changes’ to persist the changes

51

www.d4science.eu

Annotations Portlet – Anchored Annotations


Anchored annotations are annotations which refer to a specific part of the content of the information object

An annotation of that kind can be added to images and text documents

For such objects a ‘Go to Anchored Mode’ button is displayed To add an anchored annotation user has to select the part

of the document first and then follow the same steps as for the other types of annotations.

52

www.d4science.eu



Image anchored annotations Specify a part of an image by surrounding it with a rectangle Specify a point by putting a pin onto it.

53

www.d4science.eu


Select rectangle or pin option to annotate an image

Add the title Add the text Click OK


54

www.d4science.eu



Text anchored annotations Select with the mouse the text to be annotated

55

www.d4science.eu

Metadata Viewing Portlet


Metadata viewing portlet Displays the metadata associated with a specific information object Depending on the metadata schema that is used the portlet

displays the metadata in a different way User can select how the metadata will be displayed by using the

‘UserProfile’ portlet• The customization is done by using different XSLTs

For each result object in the results portlet the user can view it’s metadata

56

www.d4science.eu



57

www.d4science.eu



How to view the metadata of a result object Use the ‘Actions’ button to view the actions menu

58

www.d4science.eu

Workspace Portlet


Workspace portlet offers to users a private area where they can save objects, organize them in baskets and share the objects with other users

For all saved items in the workspace information about the creation date, their name, etc is available

For results objects that are saved in the basket it is possible to view their metadata

59

www.d4science.eu

Workspace Portlet


The address bar on the top shows the current location The workspace tree on the left shows the workspace and all it’s

contents in a tree hierarchy (available in results and reports portlets) The list view in the center shows the content of a single folder in a list The details panel in the bottom shows the details about the selected

workspace item

60

www.d4science.eu

Workspace Portlet – Common Actions


Common actions Rename item: By right click on the item or using the details panel Delete an item: By right click on the item and select Delete Clone an item Download an item: Choose the location where the item will be saved

• Single items, such as external file (pdf and images) are proposed as simple files;

• Complex items, such as gCube documents are proposed as a zipped folder with related metadata (each one of them in a xml file).

• Folders: are proposed as zip folders.

61

www.d4science.eu

Workspace Portlet – Common Actions


Common actions

• Right click on the item to see the available actions

62

www.d4science.eu

Workspace Portlet – Specific Actions


Specific actions Create a new workspace/basket: On the workspace tree right click on the

parent folder and select Add new Workspace or Add new Basket action. Insert the item name and then press enter. A new folder is created.

Upload a file into a basket: on context menu select upload file. The browser asks for a file to upload from your local file system. At the end of operation a confirm message is shown.

Upload an archive into a workspace: select upload archive and choose an archive to upload from your local system

Drag and Drop Actions d&d of basket item between two baskets in the tree, from a basket

in the tree and a basket in the list view and viceversa. d&d of folder between two folders in the tree, from a folder in the

tree and a folder in the list view and viceversa, and between folders in the list view.

63

www.d4science.eu

Workspace Portlet – Specific Actions


The whole workspace can be downloaded to your local system as an archive

An archive can be uploaded to the workspace from your local system

•Right click on the workspace•Select ‘Upload archive’•A pop up window appears so as to select an archive from your local system

64

www.d4science.eu

Workspace Portlet – Share Objects


Share items with other users Use the common actions menu and choose the ‘send to’ option A pop up window appears where you can choose the receivers

65

www.d4science.eu

Workspace Portlet – Share Objects


The receivers will be notified about an item reception They can either accept or decline the request

Information about the sender and the item are displayed at the pop up window

66

www.d4science.eu

Creating Reports


Based on the retrieved results that are saved to user’s basket it is possible to create report Templates and then generate reports (in XML or PDF format)

First create a report template filled it out by static information (images, text) and by dynamic ones (i.e. dropping image areas)

Use this template to generate a report and export it in xml or pdf format

67

www.d4science.eu

Creating Reports – Template Generator


The potential constituents of a template (the ones currently supported) are:

a static text, i.e. a piece of text. It should be used to specify - at the template level - a text that should appear in all instances of such a template

a text area, i.e. an area dedicated to host a piece of text. This area is expected to be filled with specific text whenever a report conforming to the template is created

a static image, i.e. an image. It should be used to specify - at template level - an image that should appear in all instances of such a template

a dropping image area, i.e. an area dedicated to host images. This area is expected to be filled with specific images whenever a report conforming to the template is created.

• It uses a default image if the user wont insert his/her own image

68

www.d4science.eu



Template creator

69

www.d4science.eu



To Insert a template constituent click the corresponding button, then move to the workspace area (white page on the right), and start dragging drawing a rectangle.

Each template constituent can be resized or dragged into the workspace area once it has been created.

To resize it move the mouse pointer over the right or the bottom edge, and drag it.

To Move just drag it like you are used to do in windows.

70

www.d4science.eu



Use the rich text toolbar situated on the top when inserting a static text

It is possible to specify in the textbox situated in the center, a text hint for it which could act as a suggestion when the template is loaded in the report portlet

Insert new pages by clicking on the top bar menu ‘Options > Add New page’

Edit the page’s properties of the template by clicking on the top bar menu ‘Options > Page Properties’

71

www.d4science.eu



Use of the rich toolbar

72

www.d4science.eu



Add a hint to the textbox

73

www.d4science.eu



When the template creation finishes save the template to the basket by clicking on ‘File > Save Template’

Open a saved template and edit it by clicking on ‘File > Open Template’

74

www.d4science.eu

Creating Reports – Report Generator


Generate one or more instances of templates Add dynamic content to templates Export the reports to pdf or xml Reports are also saved to user’s basket

75

www.d4science.eu

User Profile Portlet


Use the User Profile portlet to change the search preferences and personalize the view of the results and metadata

The Preferred Presentation XSLTs refer to the view of the results.

For each metadata schema choose one of the available XSLTs to be used for the HTML representation of the results

The Preferred Metadata XSLTs refer to the view of the metadata of an information object.

For each metadata schema choose one of the available XSLTs to be used for the HTML representation of the metadata

76

www.d4science.eu



Change the XSLTs and preferences and then click on the ‘save’ button to save the changes to the profile

Use the drop down list to choose the preferred XSLT

77

www.d4science.eu



After the changes are saved a new search can be performed and the new XSLT will be used for the presentation of the results

The same is for the metadata

78

www.d4science.eu

Plans for portlets


Search portlet will provide a way to perform queries that are saved to basket using the results portlet

Under development available soon Annotations portlet and the neo basket integration should be

done soon Associations now are not available

The presentation of the results will contain the fields that the user has searched for and some static fields depending on the metadata schema

Under implementation in ASL User Profile portlet will provide a preview for each available

XSLT so that the users can see how the results will be shown

79

www.d4science.eu

Appendix


For more information visit the user’s guide at the gCube wiki

gCube user's guide Sections available at the user’s guide

Functionality provided by each portlet Usage scenarios which describe how to perform an action using

the available portlets

https://technical.wiki.d4science.research-infrastructures.eu/documentation/index.php/User's_Guide

80

www.d4science.eu


Any Questions?

vre exploitation

Technology

tool automatically

user profile

starting point

geospatial

results portlet

search portlet

metadata schema

search portlet