Common Functionality

From Gcube Wiki
Revision as of 17:20, 10 December 2012 by Massimiliano.assante (Talk | contribs) (Reports)

Jump to: navigation, search

Workspace

A workspace represents a collaborative area in which users can exchange and organize information objects (items) according to their specific needs. Because of this, every user of any Virtual Research Environment is provided with this area. Such an area is further organized in workspaces and baskets as to resemble a classic folder-based file system. The information objects that can be managed via the workspace range from files to D4Science documents, i.e. compound objects comprising metadata, alternative representations and multiple parts. The modality a workspace is populated range from the dragging of D4Science documents (or part of them) to the upload of files from its desktop and the exchange of workspace objects among users.

Click here for more information

Login to VO/VRE

Once you have signed in to the portal, you can select one of the available VOs/VREs to work on. Each VO is displayed with its name and under it you can see all the available VREs. For each VO/VRE there are 3 status available:

  • The green color, Enter: You have access to the corresponding VO/VRE
  • The blue color Sign up: You don't have access but you can request for it
  • The orange color Pending: Your request for access is not yet approved


SelectVRE.png

In order to sign up to a VO/VRE you have to click on it and a pop-up window appears. You can add any comment there for the administrator and then you click on the 'Confirm Request' button to submit your request

After your request is submitted the status of the requested VO/VRE is turned to orange until the administrator will approve your request VRESignUp.png

For every VO/VRE you can see some information by clicking on the information button. VREInfoPage.png

After logging in to a VO/VRE its description is displayed and all the available functionality divided into tabs and sub-tabs.
LoggedIn.png

Search

Search is one of the most important functionalities in the gCube system. Depending on the collections you want search through you can perform different kinds of searches. The default option is to search for a term anywhere in the selected collections, or you can search for more specific criteria. There is also the option to browse the contents of a collection and their distinct values based on a specific criterion.
After performing a search you can refine its results by searching for more specific terms in the current results. In order to perform a search or a browse, you first have to select collections. For this purpose you have to use the Select Collections portlet. Independently of the search type all results are displayed by the Results portlet.

Select Collections

By using this portlet, you can select the desired collections in order to browse or search them.
The collections are presented in a tree hierarchy. The first level of nodes represents a collection group and each group contains several collections. In the following image, f.i. Aquamaps is a collection group. On the left of each checkbox, there is either a close folder icon or an opened folder icon. If there is a closed folder icon, it means that there are other collections inside this group of collections. By click on it, you can see the underlying collections. On the other hand, if there is an opened folder icon, it means that the node is expaned and you already see the inner collections (like AquaMaps: Class Biodiversity Maps). So, if you click on it, you can hide them.
In order to select/deselect a collection, you have to click on its name or checkbox. Additionally, you can select a group of collections simply by selecting the group of collections they belong to. As you can see below, if you select the Aquamaps collection group, then all the collections that belong to this group are selected.
Collections.png

A full description for each collection is available, if you click on (more) link. A pop up window appears containing a description of the corresponding collection as you can see in the image above. For each collection you can see its name, description (if it exists), number of records and the creation date.

For your flexibility you can search through the available collections for a keyword that may be included in collections name and/or description. The following image displays this functionality. SearchColls.png

The collections that you have already selected, are also selected at the pop-up window with the search results. You can deselect the already selected collections or select new collections. By clicking on the results at the pop-up window this change will also be applied at the collections tree.

Search

The search portlet is divided into 3 different tabs. The 'Search', the 'Browse' and the 'Refine Search' tab. Each tab provides different functionality and will be described below.

Search panel

After selecting the collections you want to search in, the search functionalities are enabled based on the current selections. The Search panel is displayed and there you have two different options. You can type the search terms you want to search for and click on the 'Search' button or you can click on the 'Advanced search options' link which will display the advanced interface. If you use the first option this will search for the given terms everywhere inside the selected collections.

Search.png

If you use the second option, this will enable the advanced search. In the advanced search you can:

  • Choose the language to be used
  • Add as many criteria as you like.
  • Define the field to be used in each criterion. If 'Any' is selected this will search everywhere inside the selected collections.
  • Decide if all or any of your criteria should be matched. The default option is to match any of the given criteria.
  • Click on the 'Search' button to submit the search.
  • Click on the 'Reset' button to reset the current criteria.


AdvancedSearch.png

You can add a new condition by clicking the Add Condition (+) button or you can delete a condition by clicking the Remove Condition (-) button. Notice here that at least one condition is needed. If you try to delete it a warning message is displayed and nothing is happened.

Search2condsandsort.png

Browse panel

If browse panel is enabled you can browse the selected collections by one of the available criteria.
You have two options either to browse the contents of the collections, or to get the distinct values of the selected criterion.

BrowsePanel.png
You can select the order of the results and specify how many results you would like to be displayed per page.
The number of results per page cannot be more than 50. If you try to request for a bigger number a warning message is displayed and the default value is again added

Refine Search panel

The refine search panel is not enabled based on the selected collections. It provides two different functionalities:

  • Refine the results of the searches submitted in the current working session
  • Submit queries you have saved in your workspace
Refine the results of submitted queries

First you should select which of the last results you want to refine. The already submitted queries are added to a drop down list and the latest is preselected.
Then you can add as many criteria as you like and click on the 'Refine' button.

RefineSearchQueryDesc.png

For each selected query you can see the initial query that was submitted and the initial results at the results portlet.
RefineExplainLinks.png

Submit queries from user's workspace

When you submit a search you can save the submitted query to your workspace (This functionality is provided by the results portlet). Then whenever you like you can resubmit any of these queries and see its results.
In the refine search panel choose the Submit Query from basket. The basket with all the saved queries is displayed. Choose one of the queries and click on the 'Search' button to submit the search.
SearchBasket.png


Quick and Google Search

Using Quick Search you can perform a generic search in the gCube system. No selection of collections is required in order to search using this feature. The system automatically identifies the most appropriate collections to search, taking into account the terms specified by the user. You can also perform a Google search, whose results are displayed in the Results portlet. Due to google's restrictions the system returns at most 10 results

QuickSearch.png

GoogleSearch.png


Geospatial Search

For geospatial indexed collections it is possible to use the map located in the center of the page to specify a geographical area to search in.

The Pan Tool situated above the map is the default tool selected to allow the user to drag the map, and to zoom in by double clicking on it.

There are different ways to define the area; a user can define the area:

by selecting the Country / Zone from the dropdown list placed on the top of the map. The list contains many countries all across the world as well as continents and relevant world zones.

Example of selecting an item from the list


by clicking on the rectangular selection tool (in orange on the figure below), thus activating the rectangular selection tool. Once the button is pressed, first click on the map to set the starting point, then move the mouse on the map, second click to close the select operation. The tool will automatically zoom the selected area.

Example of Rectangular Selection tool


by clicking on the polygonal selection tool (in orange on the figure below), thus activating the polygonal selection tool. Once the button is pressed, first click on the map to set the starting point, then 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 will automatically zoom the selected area.

Example of Polygonal Selection tool


Below the map there are some optional parameters you can also add for enriching your query. The geo-coordinates of the selected area are automatically updated depending on the user selection. You can also specify geo-coordinates yourself by entering the values in the textboxes and clickink apply. Clicking on the calendar icon will cause the date picker opening.

Belowmap.jpg

Alert icon2.gif THIS SECTION OF GCUBE DOCUMENTATION IS OUTDATED.

Result Browsing

This portlets aims to provide with common navigational functionality through the results. In addition a set of action can be performed on each result record, like accessing metadata, add annotations, saving or viewing the content, etc.

Common Browsing Activities

You can navigate throughout the results by using the arrows: previous and next.
For each result, you can see a set of information, retrieved from object's metadata. The record's presentation form is user configurable. You can select the prefered layout for results, by using the User Profile Editing portlet.

Each D4Science Information Object may have [Metadata], Alternative representations, Parts and [Annotations] If they exist, a further tab is shown next to the Tab Object.

Figure 1. Single result having Metadata, Alternatives and Annotations associated to it.


When Metadata, Alternative, Parts or Annotation tab is clicked an additional request is sent to the system in order to retrieve additional information. Once the request is complete it is possible to click on the retrieved information; a pop-up will be shown for visualizing the information to the user.

Figure 2. Single result having Metadata tab clicked.

In the case of Figure 2 the system shows that two metadata are associated to the result object, adding the Metadata Schema and Language for both of them. If the user clicks on one of the associated metadata a popup windows is shown displaying the metadata in both HTML Formatted and XML Formatted (as shown in the figure below)

Figure 3. Single associated Metadata clicked, a  popup is shown


set actions on each result by clicking on the D4Science Eye

Moreover, you can perform a set actions on each result by clicking on the D4Science Eye (The Icon on the right):

  1. View Content: Opens a popup window that contains, and displays the content.
  2. Save Content: Forces browser to ask to save the content in you local disk.
  3. Manage Annotations: You can add /remove / edit annotations for this object.






Move page results to basket and Move query to the basket features

Moreover once you get results it is also possible to use Move all the page results to the basket, to move the performed query to the basket and to display the collection name. The correspondent bottons are shown in the figure below:

Figure 4. Move page results to basket, move query to the basket and show collection name



















The Basket

The Basket is thought of as a personal user area, dependent on which VRE is used . The user can save its own preferred results by dragging them on it.

Drag operations can be performed by using the move hand next to each text.


It is also possible to drag a metadata, an alternative representation, a part or annotation (if any) associated to a result.

A Basket with Objects


Once you have chosen your results you have the possibility to make them persistent by clicking the save button on the header. The basket will be saved in your workspace.

Annotations

Annotations’ management is performed by the Annotation Portlet. This is a graphical user interface which provides an easy and sufficient way to annotate gCube information objects. Annotation Portlet can be invoked by selecting the “Manage Annotations” action among the actions associated with any item displayed in the Results portlet.

Then the user is moved to the annotation portlet where s/he is able to see the title, the mimetype, the content of the selected object as well as its annotations sorted by their creation date and grouped into threads.

Depending on the mimetype of the annotated object, the visualization of its content may differ.

In most cases, the content is displayed in a specified part of the portlet.

For a zip file, its entries are displayed and the user is able to download any of them.

Tiff images are transformed into a displayable format (png); video files are available only for download and the visualization of pdf files depends on the behavior of the browser (normally a plug-in is required).

On the other hand, the annotations are grouped into threads, shown up as a list where the title of each thread is the title of the first contained annotation. The user can enter each thread and the annotations of this thread are displayed as a list where the title, their creation/ modification date and the author’s name are posted up. The user is able to select which annotations (comments or associations) s/he wants to see just by clicking on it. The content of the annotations is shown at a pop up window where you can edit it. In the case of associations, the title of the associated object as well as a link to its content is displayed.

The user can either enter a selected Thread or create a new Thread by clicking on the corresponding buttons. By creating a new Thread a new annotation is actually created. After entering a Thread the uses can add an annotation by clicking on the “Add” button and afterwards by filling in the title and text field, in the case of text annotations, or by filling in the title field and selecting an object existing in the basket as an associated object in the case of associations. S/he may also delete or edit an annotation.

All the changes made by the user are persisted when s/he presses the "Save Changes" button.


Annotation Portlet



When the object that is annotated is an image the user is able to add an annotation to a specific part of the image file. The user selects a space fragment and then he fills in the title and text fields. Then the space fragments are shown on the image and by clicking on one of them the content of the annotation is displayed.


New annotation with fragment

The user can edit an annotation be selecting the annotation s/he wants to edit and click on the "Edit" button. A pop up window appears with the content of the annotation

New annotation with fragment



Content Viewer

The content viewer portlet provides the functionality to view a gCube object and all its properties and transform it, if any transformation is available for the object's mime type.

Using this portlet you can:

  • View the content of the selected object
  • View the available metadata of the object
  • View the aternative representations
  • Transform the main object using any of the available transformation programs (if any) and save the result of the transformation as a new object

In order to use this portlet you should select from the results menu the Explore Object option for the object you would like to explore. After selecting this option you will be redirected to the Content Viewer portlet.
The main object is displayed as you can see at the image below

CVMain.png

When you click on the Display button the pop-up window with the all the available properties for this object is displayed. You can select any of the available properties to view. For example you can see at the image below the metadata at the FARM_dc schema for this object.

CMDisMetadata.png

To view any of the alternative objects that are related to this object click on them

CVDisAlt.png

Transforming the selected object

Depending on the available transformations programs you can transform the object to a new object and save it. In the example below the main object can be transformed to a new image with given height and width.

CVTransformMain.png

User Profile Management

The User Profile Management in gCube provides the functionality to the end-user to view and/or edit his/her profile.

User Profile Editing

The User Profile Editing portlet can be accessed by all users that have a portal account. Each user has his/her own profile and he/she can view and/or edit its content through this portlet. By editing the profile's contents you have several options that affect the search results or the presentation of the results and their metadata.

  • Edit your personal information
    • Your fullname and email can be updated
    • The username cannot be changed
  • Personalize the presentation of the results and their metadata:
    • For each available collection you can select any of the available presentable fields that will be used for the presentation of the results from the results portlet when this collection is used in search. If you don't select any field then all the available presentable fields will be displayed.
    • For each available metadata schema you can select one of the available xslts that will be used for the presentation of the metadata. If you don't change anything the default XSLT will be used.
    • A preview is displayed for the current selected schema and XSLT. This helps you to select the desired XSLT.

In order to apply the changes you need to click on the Save profile button. A message is displayed to inform you if the profile was successfully updated.

UserProfilePortlet.png

Report Management

gCube Reporting allows users to create Report Templates and generate different manifestation of it (OpenXML (.docx), HTML) based on retrieved results. gCube template definition is made up of two phases:

  • 1st Phase:
    • You can use the Template Creator Portlet to create a gCube template, which is partially filled out by static information i.e. static images, static text and so on) and by dynamic ones (i.e. dropping image areas). The Template Creator Portlet produces a gCube Template that can be loaded into the Report Portlet.

The aim of creating gCube Templates is the one of creating a basic document structure that can be used successively by actually filling the dynamic parts of the template.


  • 2nd Phase
    • The Report Portlet is the one that generates one or more instances of templates (built in the 1st phase) allowing the end user to add dynamic content. The instance can be successively exported into the final Report as OpenXML (WORD 2007 DOCX), HTML.

The difference between a template and a report is as follows:

  • a template is a way to characterize a class of reports, i.e. identify its structure and its potential constituents;
  • a report is obtained by instancing a specific template, i.e. identify the actual pieces of a report.

You can access Reporting by clicking on the tab "Reporting" once a VRE is loaded.

Templates

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

  • structured and styled text area, you can define different text areas which then go to compose the template structure:
    • Title
    • Headings (Level 1, 2, 3)
    • Simple Text (Body)
  • Images
  • Sections
  • Table
  • Attributes
  • Comments
  • Instructions
  • Table of Contents (TOC)
  • Page Breaks


In the Image below you can see a Structured Template Sample

 Template1.jpg


To Insert a template constituent the either Toolbox or Insert option in the Menu Bar can to be used. It is possible to use the single column layout or a double column layout for placing template constituents in the template.


When inserted a structured and styled text area it is possible to use the rich text toolbar situated the top for applying basic text formatting.

Template constituents (e.g. text, image) are added using top to bottom order if not specified by the user.

To define a new insertion point for a new Template constituent just click in the space gap between two template constituents, a prompt will appear on the left of the section, then you can either go to Insert menu, or click enter to choose the constituent you want to add.

Each Template constituent is equipped with a x icon in its top-right corner. It allows the user to remove it form the section. Each Text constituent is resizable as you type and is also equipped with a lock icon. If clicked the lock get locked. This will make this area not editable once the template is open in the report portlet.

 Lock.png

When inserting an Image area it is possible to specify in the texbox situated in the center a text hint for in it which could act as a suggestion when the template is loaded in the report portlet fot he user which had to fill the report. You can also

  • resize the image area by clicking on the four arrows icon placed in the center of the image area.


 Image t.png
  • It is possible to insert new Sections by clicking on the top bar menu Section > Add New or menu Insert > New Section:

A Section is a way to group a set of template components, Sections can be added, discarded and imported. To operate with sections click on the menu item Section

 Section.png


To Import a Section belonging to a different template into the current one, click on the menu Section > Import from template, the user workspace tree is open, pick the template you want to import from as shown in the picture below:

 Pick.png

The selected template will be imported, and the Import Template Section Dialog will appear as shown below:

 ImportSection2.png

Choose which section import and in where to import in the current template, then click on the import button, the newly added section will be shown on the screen.


  • The file menu allows to Save the template, Rename them (Save As), or open a previously saved template.

Reports

Reports is used to generate one or more instances of templates (built with Templates) allowing the end user to add dynamic content. The instance can be successively exported into the final Report as OpenXML (Word docx) or HTML.

On the left of the portlet the user have a Tree which is the same of the Workspace Portlet Tree.

In the picture below you can see a filled report sample:

RO.png
  • The Report portlet can either open Templates (generated by the template portlet) or previously saved reports.
  • The List of your templates or reports can be accessed by clicking the menu File.


OpenT.png

Note that Template and Report instances are saved in you workspace area, consequently to either open templates or reports the uses has to choose it's location you the workspace tree which is opened by the system.


Open template.gif


Once the template is loaded the user can drag images into the dropping image area from within the baskets.

Drag image.gif

It is possible to generate a OpenXML, HTML Manifestation of the current open report by using the Options Menu as shown in the figure below.

ExportReport.jpg

Note that the exported Manifestation process can take up to 5 seconds, once the process has been completed a popup is shown which confirms the success of operation. Note that the exported Manifestation is saved in your workspace, in your default basket.

Exportopopup.gif

Importing Template or Report Sections works the same way explained in the template part. Report can be saved.

Course Management

Time Series

Click here to visit the Time Series portlet guide

AquaMaps Suite

The AquaMaps suite supports the production of AquaMaps and related data products, i.e. compound objects containing species and biodiversity occurrence predictive maps.

Click here to visit the AquaMaps Suite guide