Difference between revisions of "Common Functionality"

From Gcube Wiki
Jump to: navigation, search
(Quick Search)
(Search Profile Settings)
 
(269 intermediate revisions by 15 users not shown)
Line 1: Line 1:
Describe the common functionality provided by any Community Web Portal for searching a collection, browsing the results, managing the content etc.
+
==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.  
  
== Search ==
+
[[Workspace | Click here for more information]]
  
Search is the most important functionality in the gCube system.
+
== Login to VO/VRE ==
You can perform different kind of searches, depending on the results you want to have and how generic or specific your search wants to be. The different kinds are: ''Combined Search'', ''Simple Search'', ''Quick Search'', ''Google Search'', ''Collections browsing'' and ''Generic Search''. Each one of them will be described below. <br>
+
Independently of the search type all results are displayed to the Results portlet.
+
  
=== Combined Search ===
+
See [[Log in User Guide]].
  
In Combined Search you have to select the collections you want to search in at the left panel. Then in the right panel you select the Combined Search header and you can type as many keywords as you like.
+
== Search ==
You can select where each one of the keywords should exist. Depending on the common schema of the selected collections and the indexes that the back-end supports there are choices like title, language, creator, description and 'Terms' (which means that you want to search for this keyword anywhere in the selected collections).
+
  
 +
See [[Search User Guide]].
  
[[Image:Artesearch1.png]]
+
== 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.
  
You can add a new condition by pressing the '''Add Condition''' button.
+
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.
If you have more than one conditions you can select if all terms must exist at the results, or if any of these terms. You can do this by selecting one of the below radio buttons. The default choice is: ''match any condition''
+
  
 +
Depending on the mimetype of the annotated object, the visualization of its content may differ.
  
[[Image:Conditions.png]]
+
In most cases, the content is displayed in a specified part of the portlet.
  
You can delete any of the conditions by pressing the '''"X"''' button or you can clean the whole form by pressing the '''Reset''' button. Notice here that if there is only one condition and try to delete it a warning message will appear and the condition will not be deleted.
+
For a zip file, its entries are displayed and the user is able to download any of them.  
 
+
=== Simple Search ===
+
 
+
In Simple search you can search for the keywords you type at the text area, in the collections you have selected on the left panel.
+
When you use the simple search, a full text search is performed, which means that the keywords you have typed can exist in the title, or in the description or anywhere in the collection.
+
 
+
[[Image:Simplesearch.png]] <br>
+
 
+
=== Collections Browsing ===
+
In Collections Browsing search you can browse all the contents of the collections you have selected on the left panel. You can choose by which type the results will be sorted. Depending on the collection's schema the sorted types are different.
+
 
+
 
+
[[Image:BrowseCollections.png]]
+
 
+
=== Quick Search ===
+
 
+
In Quick Search you can perform a generic search in the gCube system. No selection of collections, neither any logical operator is required in order to search using this feature. The system automatically identifies the most appropriate collections to search taking into account terms specified by the user.
+
You can also perform a Google search, which results are displayed in the Results portal. Due to google's restrictions the system returns at most 10 results.
+
 
+
[[Image:QuickArte.png]] <br>
+
 
+
== Result Browsing ==
+
Available functionality for browsing the search results
+
 
+
=== The Basket ===
+
 
+
'''The Basket is thought as a personal user DL dependent area.'''
+
The user can save its own preferred results by dragging them on it.
+
 
+
 
+
[[Image:DragRecordInBasket.jpg|frame|none|Example of dragging record in the Basket]]
+
 
+
 
+
It is even possible to drag images in the basket (if they are retrieved results).
+
Indeed in the results page it is possible to drag whether records or images. The possibility is also thought for using them in the report generation and courses management.
+
 
+
[[Image:4_DragAndDrop_FromResults.jpg|frame|none|Example of dragging an image in the Basket]]
+
 
+
 
+
Once you have chosen your results you have the possibility to '''make them persistent''' by giving the basket a name and saving it on the server.
+
 
+
[[Image:14_GaliciaResults_And_SaveBasket.jpg|frame|none|Example of saving a Basket]]
+
 
+
 
+
You can always '''load your saved basket''' using the dropdown list placed on the top of the Basket.
+
 
+
[[Image:LoadBasket.jpg|frame|none|Load Basket example]]
+
 
+
By accessing the File menu besides the dropdown list it is possible to '''save the basket, to clean it or delete it'''.
+
Be aware that the delete command will phisically remove your saved basket from the server without any possibility to have it back.
+
 
+
[[Image:BasketMenuFile.jpg|frame|none|Load Basket example]]
+
 
+
 
+
 
+
Once you have your chosen items in the basket it is possible to access to all the actions you had in the results record page such as accessing metadata, add annotations, save or view the content. If the item is an image you can access to a small preview of it.
+
 
+
[[Image:7_All_Collection_Search_-_ViewContent.jpg|frame|none|Record actions from basket]]
+
[[Image:4 GeoSpatial Results inBasket with Preview.jpg|frame|none|Image Preview from basket]]
+
 
+
=== Common Browsing Activities ===
+
 
+
== Annotations ==
+
  
Annotations’ management is performed by Annotation Front-End/ Portlet. This is a graphical user interface which provides an easy and sufficient way to annotate gCube resources. Annotation Front-End can be invoked by selecting to manage the annotations of an object in Results portlet.
+
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).
  
Then the user is moved to the generic annotation portlet where he is able to see the title, the mimetype, the content of the selected object as well as its generic annotations sorted by their creation date.
+
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.
  
Depending on the mimetype of the annotated object the visualization of its content may differ. For the majority of the objects which are supported from browsers, the content is displayed in a specified part of the portlet. For zip files, its entries are displayed and the user is able to download it. 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 behaviour of the browser (normally a plug-in is required).
+
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.
  
On the other hand, the annotations are shown up as a list where their title, the author’s user name and their creation/ modification date are posted up. The user is able to select which annotations (comments or associations) he wants to see just by clicking on the available checkboxes. The content of the annotations is shown below this list. In the case of associations, the title of the associated object as well as a link to its content is displayed.
+
All the changes made by the user are persisted when s/he presses the "Save Changes" button.
  
The user may perform three operations. He can add an annotation by clicking on the “Add Annotation” 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 basket as an associated object in the case of associations. He may also delete or edit an annotation.
+
<!--If anchored annotations are supported for the annotated object the user can choose to be moved to the appropriate portlet by clicking on the “Go to anchored mode” button. Three portlets for anchored annotations are provided, namely, cover images, text and video documents.-->
  
If anchored annotations are supported for the annotated object the user can choose to be moved to the appropriate portlet by clicking on the “Go to anchored mode” button. Three portlets for anchored annotations are provided which are cover images, text and video files.
 
  
 +
[[Image:AnnotViewThreads.png|frame|none|Annotation Portlet]]
  
[[Image:GenericAnnotationScaled.png|frame|none|Generic Annotation Portlet]]
 
  
  
In image annotation portlet a user is able to add an annotation to a specific part of the image file. The user selects a space fragment which can be a rectangular area or a specific point (with a pin) 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.
 
  
 +
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.
  
[[Image:ImageAnnotationScaled.png|frame|none|Image Annotation Portlet]]
 
  
 +
[[Image:AnnotCreateNew.png|frame|none|New annotation with fragment]]
  
In text annotation portlet there is the capability of adding an annotation on a selected text fragment of the file. The selection of the text fragment is done in a very user friendly way as the user has only to choose the part of the text file with his mouse. The text fragments are shown with a different background in order to be distinguishable and by clicking on one of them the content of the annotation is displayed.
+
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
  
 +
[[Image:AnnotEdit.png|frame|none|New annotation with fragment]]
  
[[Image:TextAnnotationScaled.png|frame|none|Text Annotation Portlet]]
 
  
 +
<!-- In text annotation portlet there is the capability of adding an annotation on a selected text fragment of the textual document (e.g. plain text, xml documents). The selection of the text fragment is done in a very user friendly way as the user has only to choose the part of the text document with his mouse. The text fragments are shown with a different background in order to be distinguishable and by clicking on one of them the content of the annotation is displayed.
  
In video annotation portlet (still under construction) a user is able to select a time fragment which means a part of the video file that is defined by its starting and ending moment. Video annotation portlet has although some requirements as it needs Java Media Framework installed on the user’s computer.
 
  
 +
In video annotation portlet (still under construction) a user will be able to select a time fragment which means a part of the video file that is defined by its starting and ending moment. Video annotation portlet has although some requirements as it needs Java Media Framework installed on the user’s computer. -->
  
[[Image:VideoAnnotationScaled.png|frame|none|Video Annotation Portlet]]
 
  
== Metadata Management ==
+
== Content Viewer ==
View and Edit metadata are the two functionalities that gCube offers to its users concerning the Metadata Management. These are described below.
+
  
=== Metadata Viewing ===
+
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.
  
The Metadata Viewing Portlet is a graphical user interface that displays the metadata which are associated with a specific information object. This interface displays the object’s metadata in a graphical way which depends on their schema.
+
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
  
Furthermore the portlet provides the ability for each user to change the way the metadata are displayed. If a user wants to manage the layout of the metadata viewing portlet, he may choose one layout of the available. This selection can be done in the user profile editing portlet.
+
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.<br>
 +
The main object is displayed as you can see at the image below<br>
  
 +
[[File:CVMain.png]]
  
[[Image:MetadataViewingScaled.png|frame|none|Metadata Viewing Portlet]]
+
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.<br>
  
=== Metadata Editing ===
+
[[File:CMDisMetadata.png]]
  
Metadata’s editing is performed by Metadata Editing Portlet. This is a graphical user interface which can be invoked by selecting to edit the metadata of an object in Results portlet. Depending on the schema of the metadata different editors can be displayed. There are two visual editors for dc and eiDB schemas and a generic one for the rest. However, for some collections, it is forbidden to change the metadata, something that is stated on screen with a relevant message.
+
To view any of the alternative objects that are related to this object click on them<br>
  
The visual metadata editors provide an easy and user friendly way of editing the metadata. Adding, deleting and editing elements can be performed by clicking on the appropriate buttons and filling in text fields. When the user completes his desired changes, he has to apply the changes he has done by clicking on the “Save Changes” button.
+
[[File:CVDisAlt.png]]
  
 +
=== Transforming the selected object ===
  
[[Image:MetadataEditingScaled.png|frame|none|Visual Editor]]
+
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. <br>
  
 +
[[File:CVTransformMain.png]]
  
The generic editor provides two options. The first one is to edit the bare xml in a text editor and the second one is to upload an xml file as metadata. However, these options require the user to have sufficient knowledge of XML.
 
  
 +
=== Search Profile Settings ===
  
[[Image:MetadataEditingGenericScaled.png|frame|none|Generic Editor]]
+
The Search Profile portlet can be accessed by all users that have a portal account. Each user has his/her own search profile and he/she can view and/or edit its content through this portlet.
== User Profile Management ==
+
By editing the search profile's contents you have several options that affect the search results or the presentation of the results and their metadata.
  
The User Profile Management in gCube provides the functionality to the end-user to view and/or edit its profile. It also provides the functionality to the system's administrator to manage the user's profiles.
+
<!-- * <b>Personalize the search results:</b>
 +
** Change the language using the drop-down list. The language in the profile affects the results that will be retrieved. The results will be only contain content in the preferred language.
 +
** <b>EngineType:</b> InternalEngine
 +
EngineType element specifies the desired type of the engine that will be
 +
employed for executing plans produced by the search engine. The value
 +
type of this element is string. Currently these types are supported:
 +
  InternalEngine: Search internal execution engine
 +
  ActiveBPEL: ActiveBPEL engine
 +
  OSIRIS: OSIRIS execution engine
 +
* <b>Persistence:</b> false
 +
Persistence refers to the ability of the execution engine to
 +
persist its runtime state, in order to perform execution reincarnation,
 +
multiple executions, execution logging and analysis, etc.
 +
The value type of this element is boolean (true or false).
 +
* <b>FaultTolerance: </b>false
 +
FaultTolerance refers to
 +
the ability of the execution engine to recover from errors. The value
 +
type of this element is boolean (true or false).
 +
<br>
 +
-->
  
=== User Profile Editing ===
 
  
The User Profile Editing portlet can be accessed by all user's that have a portal account. Each user has his own profile and it can view and/or edit its content through this portlet.
+
* <b>Personalize the presentation of the results and their metadata:</b>
By editing the profile's contents the user can change the language it prefers to search within the selected collection in the Search portlet, it also can also select the presentation and metadata xslts, in order to view the results and the metadata the way he/she likes.
+
** 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.
In order to apply the changes you have to press the '''Save profile''' button.
+
** 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.
  
[[Image:UserProfile2.png]]
+
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.
  
=== Profile Administration ===
+
== Report Management ==
 +
See [[Report Management]] page.
  
The Profile Administration portlet can be accessed only by the portal's administrator. Using this portlet, the administrator can create and/or delete a user profile by typing the user's username.
+
== Time Series ==
The Administrator is also responsible by uploading the DefaultUserProfile on the DIS as a generic resource. This can be done through this portlet. The DefaultUserProfile should be a valid XML document.
+
[[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.
  
[[Image:ProfileAdmin.png]]
+
[[AquaMaps | Click here to visit the AquaMaps Suite guide]]

Latest revision as of 14:23, 8 April 2015

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

See Log in User Guide.

Search

See Search User Guide.

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


Search Profile Settings

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


  • 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.

Report Management

See Report Management page.

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