Difference between revisions of "Usage Scenarios"

From Gcube Wiki
Jump to: navigation, search
(Perform a search and view the metadata of a record)
(Send a workspace area item to another user)
 
(72 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== Usage Scenarios ==
 
== Usage Scenarios ==
 +
 +
=== Login to a portal instance and select a VRE ===
 +
 +
This scenario is describing the required steps for loging in to a portal and selecting one of the available VREs.<br>
 +
 +
# Login to a portal instance. ([https://portal.d4science.research-infrastructures.eu/web/guest https://portal.d4science.research-infrastructures.eu/web/guest])<br>
 +
# Your username and password are required so that you can log in<br>[[Image:FirstLogin.png]]<br>
 +
# After the login select the preferred VRE to load and click "enter"<br>[[Image:SelectVRE.png]]<br>
 +
# FCPPS VRE is selected and you are now logged in to this VRE<br>[[Image:LoggedIn.png]]<br>
 +
# All the available portlets for the selected VRE are now loaded. They are organized into tabs and sub-tabs<br>
  
 
=== Perform a search and view the metadata of a record ===
 
=== Perform a search and view the metadata of a record ===
Line 6: Line 16:
 
<br>
 
<br>
  
# Login to a portal instance. ([http://portal.d4science.research-infrastructures.eu/vre/vre http://portal.d4science.research-infrastructures.eu/vre/vre])<br>
+
# Follow the "[[Usage Scenarios#Login_to_a_portal_instance_and_select_a_VRE|Login_to_a_portal_instance_and_select_a_VRE]]" instructions in order to login to a VRE<br>
# Your username and password are required so that you can log in<br>[[Image:FirstLogin.png]]<br>
+
# All the available portlets for this VRE are now loaded. Click on the "Search" tab to view the search portlets.<br>[[Image:SearchTab.png]]<br>
# After the login select the preferred VRE to load and click "enter"<br>[[Image:SelectVRE.png]]<br>
+
# FCPPS/FCPPS VRE is selected and you are now logged in to this VRE<br>[[Image:LoggedInToVRE.png]]<br>
+
# All the available portlets for this VRE are now loaded. Click on the "Search" tab to view the search portlets.<br>[[Image:SearchTabSelected.png]]<br>
+
 
# Select the collections you want to search through<br>
 
# Select the collections you want to search through<br>
 
# Choose the type of search you want to perform<br>
 
# Choose the type of search you want to perform<br>
# Suppose that you choose the "Combined" search. Add as many conditions as you like and type your keyword for each condition.<br>
+
# Suppose that you choose the "Advanced" search options. Add as many conditions as you like and type the search term for each condition.<br>[[Image:AdvancedSearch.png]]<br>
# Select the sort order and field that will be used for the results and then click the "Search" button<br>[[Image:SelectColsAndTypeKeyword.png]]<br><br> ''In the picture above we have selected 2 collections, combined search and we have typed only one keyword. We asked the results to be sorted by 'Title' in descending order''<br>
+
# After clicking the "Search" button, the query will be submitted, the buttons will be disabled and you will be automatically redirected to "Results" portlet<br>
# After clicking the "Search" button, the query will be submitted, the buttons will be disabled and you will be automatically redirected to "Results" portlet<br>[[Image:SearchButtonClicked.png]]<br>
+
# The rendering of the results will start and you can either perform some actions to the records or you can click the next button so that you will get the next results<br>[[Image:SearchResults.png]]<br>
# The rendering of the results will start and you can either perform some actions to the records or you can click the next button so that you will get the next results<br>
+
# Choose a record, click on the "Metadata" tab of a record and click on any of the available metadata to view them.<br>[[Image:ActionsViewMetadata.png]]<br>
# Choose a record, click on the "Actions" button and select "View Metadata"<br>
+
 
# After selecting this action you will be automatically redirected to the "Metadata Viewing Portlet", where you can see the metadata of this record<br>
+
=== Annotating Information Objects ===
 +
 
 +
# In order to annotate an information object, first a search has to be performed as described above in "[[Usage Scenarios#Perform a search and view the metadata of a record|Perform a search...]]" section.
 +
# An object can be annotated by choosing a result record, clicking on the "Actions" button and selecting "Manage Annotations"
 +
# Afterwords, the annotations of the object are displayed and a variety of options in order to manage them are available. [[Image:AnnotViewThreads.png|frame|none|Viewing Annotations]]
 +
# Managing generic annotations
 +
## '''Adding an annotation:''' In order to create an annotation you can either create a new Thread by clicking on the "New Thread" button, which will create a new Annotation as the first of the thread, or you can enter an existing thread by clicking on the "Enter thread" button (entering a thread can also be done by double clicking on the thread) and then click on the "Add" button in order to create a new annotation. Then there are two choices create a "Text Annotation" or create an "Association" using an object from the basket or by uploading a file from the local disk. [[Image:AnnotCreateNew.png|frame|none|Adding Annotation 1]]
 +
### For Text Annotations the title and the text of the annotation have to be filled in and then the "OK" must be clicked. [[Image:NewTextAnn.png|frame|none|Adding Annotation 2]]
 +
### In order to create an Association, the title field have to be filled in and the associated object must be chosen by the objects existing in basket. [[Image:NewRelationAnn.png|frame|none|Adding Association]]
 +
### In order to upload a file from the local disc and annotate this object using the file, you should click on the "Upload" tab, load the desired file, add a title to the annotation and click the "OK" button. [[Image:UploadAnn.png|frame|none|Annotation by uploading a file]]
 +
## '''Deleting an annotation:''' The delete annotation procedure is simply performed by selecting the annotation you want to delete and click on the "delete" button located at the top panel. [[Image:DeleteAnn.png|frame|none|Deleting an Annotation]]
 +
## '''Editing an annotation:''' In order to edit an annotation you have to selected and click the "edit" button located at the top panel. After performing any changes in the annotation they are applied by clicking the "OK" button.<br/> [[Image:UsageEditAnn.png|frame|none|Editing an Annotation]]
 +
## '''Committing Changes:''' All the changes applied by the previous functions are temporarily kept in the session. In order to persist these changes the "Save Changes" button must be clicked. [[Image:SaveChangesAnn.png|frame|none|Saving Changes]]
 +
<!-- # Managing Anchored Annotations <br/> Anchored annotation is a special type of annotation which means that the annotation is referred to a part of the content of the information object. Anchored annotations are available for image and text documents. For these types of objects the "Go To Anchored Mode" button is displayed which navigates the user to the appropriate portlet. Below we are going to describe just the selection of the part of the document. The rest are similar with the generic annotations.
 +
## For Images there are two options. Specifying a part of an image by surrounding it with a rectangle, or specifying a point by putting a pin onto it. [[Image:USAGE_AFE_ImageAnnotationDisplay.png|frame|none|Viewing Anchored Image Annotations]] [[Image:USAGE_AFE_AddImageAnnotation.png|frame|none|Adding an Anchored Image Annotation]]
 +
## For textual documents the parts are specified by selecting with the mouse the desired part of the text document. [[Image:USAGE_AFE_DisplayTextAnnotations.png|frame|none|Viewing Anchored Text Annotations]] [[Image:USAGE_AFE_AddTextAnnotation.png|frame|none|Adding an Anchored Text Annotation]] -->
 +
 
 +
=== Send a workspace area item to another user ===
 +
 
 +
This scenario describes the required steps a user has to perform in order to send an item from his workspace area to another user's workspace area.
 +
<br>
 +
 
 +
# Follow the "[[Usage Scenarios#Login_to_a_portal_instance_and_select_a_VRE|Login_to_a_portal_instance_and_select_a_VRE]]" instructions in order to login to a VRE
 +
# All the available portlets for this VRE are now loaded. Click on the "Workspace" tab to view the workspace portlet.
 +
# Select the item you wish to send (can be a workspace, a basket or a single item). Right click on the item to send, from the context menu select the "send to" option.[[Image:Workspace_context_menu.png|frame|none|Send to context menu]]
 +
# A popup window is opened. Select the list of users and related VRE you wish to send the item. Press the "send" button to complete the operation.[[Image:Workspace_sendTo_popup.png|frame|none|Send window]]
 +
# The addressed users will be notified about item reception.[[Image:Workspace_receive_items.png|frame|none|Received item notification]]
 +
# Clicking on the message a receive popup window is open. [[Image:Workspace_receive_popup.png|frame|none|Receive popup]]
 +
# You can either accept or decline the an item which was sent to you.
 +
 
 +
[[Category:User's Guide]]

Latest revision as of 12:49, 6 October 2011

Usage Scenarios

Login to a portal instance and select a VRE

This scenario is describing the required steps for loging in to a portal and selecting one of the available VREs.

  1. Login to a portal instance. (https://portal.d4science.research-infrastructures.eu/web/guest)
  2. Your username and password are required so that you can log in
    FirstLogin.png
  3. After the login select the preferred VRE to load and click "enter"
    SelectVRE.png
  4. FCPPS VRE is selected and you are now logged in to this VRE
    LoggedIn.png
  5. All the available portlets for the selected VRE are now loaded. They are organized into tabs and sub-tabs

Perform a search and view the metadata of a record

This scenario will describe all the required steps that a user has to do in order to perform a kind of search, retrieve the results and then view the metadata of a result record.

  1. Follow the "Login_to_a_portal_instance_and_select_a_VRE" instructions in order to login to a VRE
  2. All the available portlets for this VRE are now loaded. Click on the "Search" tab to view the search portlets.
    SearchTab.png
  3. Select the collections you want to search through
  4. Choose the type of search you want to perform
  5. Suppose that you choose the "Advanced" search options. Add as many conditions as you like and type the search term for each condition.
    AdvancedSearch.png
  6. After clicking the "Search" button, the query will be submitted, the buttons will be disabled and you will be automatically redirected to "Results" portlet
  7. The rendering of the results will start and you can either perform some actions to the records or you can click the next button so that you will get the next results
    SearchResults.png
  8. Choose a record, click on the "Metadata" tab of a record and click on any of the available metadata to view them.
    ActionsViewMetadata.png

Annotating Information Objects

  1. In order to annotate an information object, first a search has to be performed as described above in "Perform a search..." section.
  2. An object can be annotated by choosing a result record, clicking on the "Actions" button and selecting "Manage Annotations"
  3. Afterwords, the annotations of the object are displayed and a variety of options in order to manage them are available.
    Viewing Annotations
  4. Managing generic annotations
    1. Adding an annotation: In order to create an annotation you can either create a new Thread by clicking on the "New Thread" button, which will create a new Annotation as the first of the thread, or you can enter an existing thread by clicking on the "Enter thread" button (entering a thread can also be done by double clicking on the thread) and then click on the "Add" button in order to create a new annotation. Then there are two choices create a "Text Annotation" or create an "Association" using an object from the basket or by uploading a file from the local disk.
      Adding Annotation 1
      1. For Text Annotations the title and the text of the annotation have to be filled in and then the "OK" must be clicked.
        Adding Annotation 2
      2. In order to create an Association, the title field have to be filled in and the associated object must be chosen by the objects existing in basket.
        Adding Association
      3. In order to upload a file from the local disc and annotate this object using the file, you should click on the "Upload" tab, load the desired file, add a title to the annotation and click the "OK" button.
        Annotation by uploading a file
    2. Deleting an annotation: The delete annotation procedure is simply performed by selecting the annotation you want to delete and click on the "delete" button located at the top panel.
      Deleting an Annotation
    3. Editing an annotation: In order to edit an annotation you have to selected and click the "edit" button located at the top panel. After performing any changes in the annotation they are applied by clicking the "OK" button.
      Editing an Annotation
    4. Committing Changes: All the changes applied by the previous functions are temporarily kept in the session. In order to persist these changes the "Save Changes" button must be clicked.
      Saving Changes

Send a workspace area item to another user

This scenario describes the required steps a user has to perform in order to send an item from his workspace area to another user's workspace area.

  1. Follow the "Login_to_a_portal_instance_and_select_a_VRE" instructions in order to login to a VRE
  2. All the available portlets for this VRE are now loaded. Click on the "Workspace" tab to view the workspace portlet.
  3. Select the item you wish to send (can be a workspace, a basket or a single item). Right click on the item to send, from the context menu select the "send to" option.
    Send to context menu
  4. A popup window is opened. Select the list of users and related VRE you wish to send the item. Press the "send" button to complete the operation.
    Send window
  5. The addressed users will be notified about item reception.
    Received item notification
  6. Clicking on the message a receive popup window is open.
    Receive popup
  7. You can either accept or decline the an item which was sent to you.