Difference between revisions of "Workspace"

From Gcube Wiki
Jump to: navigation, search
m (→‎Glossary)
(→‎Specific actions)
 
(50 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{{UnderUpdate}}
 
−
 
 
This is the help documentation for Workspace Portlet
 
This is the help documentation for Workspace Portlet
  
−
==Workspace overview==
+
== Workspace Overview  ==
−
Workspace represents a collaborative area in which users can store Baskets and Subworkspaces.
+
−
Each portal user owns a default workspace.
+
  
 +
A workspace represents a collaborative area where users can exchange and organize information objects (''items'') according to their specific needs. Every user of any Virtual Research Environment is provided with this area for the exchange of workspace objects with other users.
 +
Such an area is further organized in ''workspaces'' as to resemble a classic folder-based file system.
  
−
[[Image:workspace_interface.png|frame|The user workspace]]
+
The added value of this collaborative area is represented by the item types it can manage in a seamless way. They range from binary files to compound information objects representing tabular data, species distribution maps, time series. Every item in the workspace is equipped with a rich metadata including bibliographic information like title and creator as well as lineage data.
 +
 +
[[Image:workspace_interface.png|thumbnail|right|600px| [F1] The user workspace is organized in three areas: filtering (2), explorer (1) and view (3)]]
  
−
This portlet is divided in four areas:
 
−
* on the top, there is the '''address bar''' which shows you the current location
 
−
* on the left, there is the '''workspace tree''' which shows your workspace with a tree
 
−
* on the center, there is the '''list view''' which shows the content of a single ''folder'' in a list
 
−
* on the bottom, there is the '''details panel''' which shows the details about workspace items
 
  
−
===Glossary===
+
There are two possible options to populate a workspace. The first is the dragging of iMarine documents (or part of them). The second is the upload of files from its desktop.
−
There some terms used on this help:
+
−
* '''workspace area''': is the working area for an user
+
−
* '''basket'''([[Image:basket.png]]): is a folder that can contain objects saved from a research or uploaded by the user
+
−
* '''basket item''': is an object inside a basket
+
−
* '''workspace'''([[Image:workspace.png]]): is a folder that can contain others workspace or basket (windows like folder)
+
−
* '''item''': can be a folder (workspace or basket) or a basket item
+
  
−
There is a list of all basket items supported by the workspace area:
+
The workspace user interface is organized in three main areas [F1]:
−
{| class="wikitable" border="1"
+
−
|+ Basket Items
+
−
|-
+
−
!  Icon
+
−
!  Name
+
−
!  Description
+
−
|-
+
−
|  [[Image:external_file.png]]
+
−
|  External File
+
−
|  A file uploaded from the user Desktop.
+
−
|-
+
−
|  [[Image:external_pdf.gif]]
+
−
|  External PDF
+
−
|  A PDF file uploaded from the user Desktop.
+
−
|-
+
−
|  [[Image:external_image.gif]]
+
−
|  External Image
+
−
|  An Image file uploaded from the user Desktop.
+
−
|-
+
−
|  [[Image:external_url.png]]
+
−
|  External Url
+
−
|  An url created by the user.
+
−
|-
+
−
|  [[Image:query.png]]
+
−
|  Query
+
−
|  An search query saved by the user.
+
−
|-
+
−
|  [[Image:report.png]]
+
−
|  Report
+
−
|  A report.
+
−
|-
+
−
|  [[Image:report_template.png]]
+
−
|  Report Template
+
−
|  A report template.
+
−
|-
+
−
|  [[Image:metadata.png]]
+
−
|  Metadata
+
−
|  An object metadata.
+
−
|-
+
−
|  [[Image:document.png]]
+
−
|  Document
+
−
|  A d4science object.
+
−
|-
+
−
|  [[Image:pdf_document.png]]
+
−
|  PDF Document
+
−
|  A d4science PDF object.
+
−
|-
+
−
|  [[Image:image_document.png]]
+
−
|  Image Document
+
−
|  A d4science Image object.
+
−
|-
+
−
|  [[Image:url_document.png]]
+
−
|  Url Document
+
−
|  A d4science Url object.
+
−
|}
+
  
−
All item names can contain any chars, slash excluded.
+
* the '''filtering area''' (2), located on the top, contains:
−
Two items in the same folder cannot have the same name.
+
** the '''path breadcrumb''' - shows the "current location". It allows users to keep track of their locations within the workspace. The path breadcrumbs are dynamic and show the path that the user has taken to arrive at a workpace item;
 +
** the '''search field''' - to research item in the workspace.
  
−
==Workspace Operations==
+
* the '''explorer area''' (1), located on the left, contains the following areas:
−
To perform operations on the Workspace Portlet, users should be familiar with the right-click mouse button (on Mac use ctrl and mouse click).
+
** '''workspace tree''' - which displays the workspace structure in a tree view.
−
In fact a mouse right click on any item in the portlet shows the context menu.
+
 
−
[[Image:workspace_context_menu.png|frame|Workspace context menu]]
+
* the '''view area''', on the center, displays the '''items area'''.
−
The available actions depends on the selected item.
+
** The '''items area''' - show a toolbar with the possible operations (i.e. "Rename", "Delete", etc.) on workspace items and the grouped list (of "currents"  items) which show the content of a single folder or the result of a search (on items).
 +
 
 +
Through this interface, the following elements can be easily identified and managed:
 +
* '''workspace''', i.e. the overall workspace supporting the user activities;
 +
* '''item''', i.e. a constituent of a workspace area.
 +
** An item can be a ''workspace folder'' or a ''folder item'';
 +
** Every item has a name comprising any char but slash ('''/''');
 +
** An items container (''workspace folder'') prevent to have two items with the same name;
 +
* '''workspace''' [[Image:workspace.png]], i.e. an item supporting the organisation of the items as to form a hierarchy. Each workspace might contain the following workspace items: 
 +
* '''folder item''', i.e. any item belonging to a workspace folder. These items are of various nature. The currently supported folder items are:
 +
** '''External File''' [[Image:external_file.png]], i.e. a generic file uploaded from the user Desktop;
 +
** '''External PDF ''' [[Image:external_pdf.gif]], i.e. a PDF file uploaded from the user Desktop;
 +
** '''External Image''' [[Image:external_image.gif]], i.e. an image file uploaded from the user Desktop;
 +
** '''External URL''' [[Image:external_url.png]], i.e. an URL created by the user;
 +
** '''Document''' [[Image:document.png]], i.e. a [[Basic_Concepts#Content.2C_Information_Objects.2C_and_Collections|D4Science compound object]] comprising all its metadata, the alternative representations and all its the parts;
 +
** '''PDF Document''' [[Image:pdf_document.png]], i.e. a PDF file belonging to a D4Science document;
 +
** '''Image Document''' [[Image:image_document.png]], i.e. an Image belonging to a D4Science document;
 +
** '''URL Document''' [[Image:url_document.png]], i.e. an URL object belonging to a D4Science document.
 +
 
 +
==Workspace Operations ==
 +
To perform operations on the Workspace Portlet, users should be familiar with the '''right-click mouse button''' (on Mac use ctrl and mouse click).
 +
In fact a mouse right click on any item in the portlet shows the context menu (see [F3]).
 +
 
 +
[[Image:workspace_context_menu.png|frame| [F3] Workspace context menu]]
 +
 
 +
The available actions depends on the selected item. The F3 example shows the use case where the selected item is a folder.
  
 
===Common actions===
 
===Common actions===
−
* '''Rename an item''': Selecting ''Rename'' the user can insert the new item name.  
+
 
−
If the name inserted is invalid a signal is showed like the one in figure.
+
 
−
[[Image:workspace_invalid_name.png|frame|Workspace invalid name]]
+
* '''Get Info''': By selecting ''Get Info'' the user can view the properties of an individual item.
−
An item can be also renamed using the details panel. Using the details panel the user can also change the item description.
+
 
 +
* '''History''': By selecting ''History'' the user can view the change history of an individual item.
 +
 
 +
* '''Read''': By selecting ''Read'' the user can view the history of downloads of an individual item.
 +
 
 +
* '''Rename an item''': Selecting ''Rename'' the user can insert the new item name.
 +
 
 
* '''Deleting an item''': By selecting ''Delete'' a confirm message is shown and, if the user confirms, the item is deleted.
 
* '''Deleting an item''': By selecting ''Delete'' a confirm message is shown and, if the user confirms, the item is deleted.
−
* '''Cloning an item''': By selecting ''Clone'' the user can insert the cloned item name. If the name is invalid a message is shown like if you would rename an item.
+
 
 +
* '''Copy and Paste''': By selecting ''Copy'' the user can copy an item and paste it to another location of the workspace (this operation create a copy of the item)
 +
 
 +
* '''Share and Unshare (New Shared Folder)''': By selecting ''Share'' the user can share a folder to other users.
 +
 
 
* '''Download an item''': By selecting ''Download'' the browser asks for the location where to save the content. The content file type is based on the item type, specifically:
 
* '''Download an item''': By selecting ''Download'' the browser asks for the location where to save the content. The content file type is based on the item type, specifically:
 
** Single items, such as external file (pdf and images) are proposed as simple files;
 
** 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).
 
** 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.
 
** Folders: are proposed as zip folders.
 +
 +
* '''Create an external url''': on workspace context menu select ''add url''. The workspace portlet show a windows where insert the url data: name, description and url value.
 +
 +
* '''Create a new folder''': On the workspace tree right click on the parent folder and select ''New Folder'' action. Insert the item name and then press enter. A new folder is created.
 +
 +
* '''Upload a file into a folder''': on workspace context menu select ''upload file''. The browser asks for a file to upload from your local file system. A the end of operation a confirm message is shown.
 +
 +
* '''Upload an archive into a folder''': on workspace context menu select ''upload archive''. The browser asks for a file to upload from your local file system. A the end of upload operation a confirm message is shown. The zip file is processed following this rules:
 +
** the zip file is considered a folder.
 +
** if a folder (the zip file) contains subfolders and files these are transformed into a workspace folders and files recursively;
 +
 +
* '''Refresh Folder''': By selecting ''Refresh Folder'' the user can refresh the content of a folder.
  
 
===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. A the end of operation a confirm message is shown.
+
* '''Execute a DataMiner Task''': on workspace context menu select ''Execute DM Task''. The workspace portlet will use the [https://gcube.wiki.gcube-system.org/gcube/GCube_Widgets_Store#Workspace_Task_Executor Workspace Task Executor] widget to allow the user to create on the selected workspace item (file or folder) a DM Task configuration (to run an algorithm) and then execute it from the Workspace. In case of file, creating the Task Configuration the widget will fill automatically the parameter FILE of the algorithm with the public link of the selected file (however, the 'publicLink' parameter can be edited by the user).
  
 
===Drag and Drop Actions===
 
===Drag and Drop Actions===
−
The workspace tree and the list view support drag and drop actions.
+
The workspace tree view support drag and drop action: d&d (of an workspace item) is possible from an item (or folder)  to a folder in the tree
−
In the list below you can find the supported operations:
+
 
−
* 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.
+
[[Category:User's Guide]]
−
* 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.
+

Latest revision as of 11:19, 27 July 2018

This is the help documentation for Workspace Portlet

Workspace Overview

A workspace represents a collaborative area where users can exchange and organize information objects (items) according to their specific needs. Every user of any Virtual Research Environment is provided with this area for the exchange of workspace objects with other users. Such an area is further organized in workspaces as to resemble a classic folder-based file system.

The added value of this collaborative area is represented by the item types it can manage in a seamless way. They range from binary files to compound information objects representing tabular data, species distribution maps, time series. Every item in the workspace is equipped with a rich metadata including bibliographic information like title and creator as well as lineage data.

[F1] The user workspace is organized in three areas: filtering (2), explorer (1) and view (3)


There are two possible options to populate a workspace. The first is the dragging of iMarine documents (or part of them). The second is the upload of files from its desktop.

The workspace user interface is organized in three main areas [F1]:

  • the filtering area (2), located on the top, contains:
    • the path breadcrumb - shows the "current location". It allows users to keep track of their locations within the workspace. The path breadcrumbs are dynamic and show the path that the user has taken to arrive at a workpace item;
    • the search field - to research item in the workspace.
  • the explorer area (1), located on the left, contains the following areas:
    • workspace tree - which displays the workspace structure in a tree view.
  • the view area, on the center, displays the items area.
    • The items area - show a toolbar with the possible operations (i.e. "Rename", "Delete", etc.) on workspace items and the grouped list (of "currents" items) which show the content of a single folder or the result of a search (on items).

Through this interface, the following elements can be easily identified and managed:

  • workspace, i.e. the overall workspace supporting the user activities;
  • item, i.e. a constituent of a workspace area.
    • An item can be a workspace folder or a folder item;
    • Every item has a name comprising any char but slash (/);
    • An items container (workspace folder) prevent to have two items with the same name;
  • workspace Workspace.png, i.e. an item supporting the organisation of the items as to form a hierarchy. Each workspace might contain the following workspace items:
  • folder item, i.e. any item belonging to a workspace folder. These items are of various nature. The currently supported folder items are:
    • External File External file.png, i.e. a generic file uploaded from the user Desktop;
    • External PDF External pdf.gif, i.e. a PDF file uploaded from the user Desktop;
    • External Image External image.gif, i.e. an image file uploaded from the user Desktop;
    • External URL External url.png, i.e. an URL created by the user;
    • Document Document.png, i.e. a D4Science compound object comprising all its metadata, the alternative representations and all its the parts;
    • PDF Document Pdf document.png, i.e. a PDF file belonging to a D4Science document;
    • Image Document Image document.png, i.e. an Image belonging to a D4Science document;
    • URL Document Url document.png, i.e. an URL object belonging to a D4Science document.

Workspace Operations

To perform operations on the Workspace Portlet, users should be familiar with the right-click mouse button (on Mac use ctrl and mouse click). In fact a mouse right click on any item in the portlet shows the context menu (see [F3]).

[F3] Workspace context menu

The available actions depends on the selected item. The F3 example shows the use case where the selected item is a folder.

Common actions

  • Get Info: By selecting Get Info the user can view the properties of an individual item.
  • History: By selecting History the user can view the change history of an individual item.
  • Read: By selecting Read the user can view the history of downloads of an individual item.
  • Rename an item: Selecting Rename the user can insert the new item name.
  • Deleting an item: By selecting Delete a confirm message is shown and, if the user confirms, the item is deleted.
  • Copy and Paste: By selecting Copy the user can copy an item and paste it to another location of the workspace (this operation create a copy of the item)
  • Share and Unshare (New Shared Folder): By selecting Share the user can share a folder to other users.
  • Download an item: By selecting Download the browser asks for the location where to save the content. The content file type is based on the item type, specifically:
    • 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.
  • Create an external url: on workspace context menu select add url. The workspace portlet show a windows where insert the url data: name, description and url value.
  • Create a new folder: On the workspace tree right click on the parent folder and select New Folder action. Insert the item name and then press enter. A new folder is created.
  • Upload a file into a folder: on workspace context menu select upload file. The browser asks for a file to upload from your local file system. A the end of operation a confirm message is shown.
  • Upload an archive into a folder: on workspace context menu select upload archive. The browser asks for a file to upload from your local file system. A the end of upload operation a confirm message is shown. The zip file is processed following this rules:
    • the zip file is considered a folder.
    • if a folder (the zip file) contains subfolders and files these are transformed into a workspace folders and files recursively;
  • Refresh Folder: By selecting Refresh Folder the user can refresh the content of a folder.

Specific actions

  • Execute a DataMiner Task: on workspace context menu select Execute DM Task. The workspace portlet will use the Workspace Task Executor widget to allow the user to create on the selected workspace item (file or folder) a DM Task configuration (to run an algorithm) and then execute it from the Workspace. In case of file, creating the Task Configuration the widget will fill automatically the parameter FILE of the algorithm with the public link of the selected file (however, the 'publicLink' parameter can be edited by the user).

Drag and Drop Actions

The workspace tree view support drag and drop action: d&d (of an workspace item) is possible from an item (or folder) to a folder in the tree

Retrieved from "https://wiki.gcube-system.org/index.php?title=Workspace&oldid=31415"