Difference between revisions of "Workspace"

From Gcube Wiki
Jump to: navigation, search
(→‎Workspace Overview)
(→‎Specific actions)
 
(37 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
This is the help documentation for Workspace Portlet
 
This is the help documentation for Workspace Portlet
  
−
== Workspace Overview (DRAFT) ==
+
== Workspace Overview ==
  
−
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.
+
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'' and ''baskets'' as to resemble a classic folder-based file system.  
+
Such an area is further organized in ''workspaces'' 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. 
+
  
−
The workspace user interface is organized in three main areas:
+
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)]]
  
−
[[Image:workspace_interface.png|frame|The user workspace is organized in three areas: filtering (2), explorer (1) and view (3)]]
 
  
−
* on the top, there is the '''filtering area''' (2). It's contains:
+
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.
−
** '''navigation bar''' which shows you the current location and it can be used to navigate workspace item;
+
−
** '''view space''' to select the workspace to show;
+
−
** '''search combo''' to research item in the workspace.
+
  
−
* on the left, there is the '''explorer area''' (1). It's contains:
+
The workspace user interface is organized in three main areas [F1]:
−
** '''workspace tree''' which displays the workspace structure in a tree view;
+
−
** '''smart folder''' which display the "virtual folders". These folders let you save a search to reuse in the future;
+
−
** '''messages''' which display the messages tree, with received and sent messages buttons.
+
  
−
* on the center, there is the '''view area''' (3). It's organized in two panels ('''items panel''' and '''messages panel''').
+
* the '''filtering area''' (2), located on the top, contains:
−
** The items panel show a toolbar with the possibles operations (i.e. "Rename", "Delete", etc.) on worspace items and the grouped list (of "currents"  items) which show the content of a single folder or the result of a search (on items).
+
** 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 messages panel (4) show a toolbar with the possible operations (i.e. "Open", "Forward", etc.) on messages and the list of messages (sent or received) or the result of a search (on messages).
+
** 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:  
 
Through this interface, the following elements can be easily identified and managed:  
−
* '''workspace area''', i.e. the overall workspace supporting the user activities;
+
* '''workspace''', i.e. the overall workspace supporting the user activities;
 
* '''item''', i.e. a constituent of a workspace area.  
 
* '''item''', i.e. a constituent of a workspace area.  
−
** An item can be a ''workspace'', a ''basket'' or a ''basket item'';
+
** An item can be a ''workspace folder'' or a ''folder item'';
 
** Every item has a name comprising any char but slash ('''/''');  
 
** Every item has a name comprising any char but slash ('''/''');  
−
** An items container (''workspace'' or ''basket'') prevent to have two items with the same name;  
+
** 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 workspaces and baskets;  
+
* '''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:  
−
* '''basket item''', i.e. any item belonging to a basket. These items are of various nature. The currently supported basket items are:
+
* '''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 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 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 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;
 
** '''External URL''' [[Image:external_url.png]], i.e. an URL created by the user;
−
** '''Query''' [[Image:query.png]], i.e. a specification of a search criteria;
 
−
** '''Report''' [[Image:report.png]], i.e. a [[Common_Functionality#Report_Management|D4Science Report]];
 
−
** '''Report Template''' [[Image:report_template.png]], i.e. a [[Common_Functionality#Report_Management|D4Science Report Template]];
 
−
** '''Metadata''' [[Image:metadata.png]], i.e. a [[Basic_Concepts#Metadata|D4Science Metadata Object]];
 
 
** '''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;
 
** '''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;
 
** '''PDF Document''' [[Image:pdf_document.png]], i.e. a PDF file belonging to a D4Science document;
Line 49: Line 42:
 
** '''URL Document''' [[Image:url_document.png]], i.e. an URL object belonging to a D4Science document.
 
** '''URL Document''' [[Image:url_document.png]], i.e. an URL object belonging to a D4Science document.
  
−
==Workspace Operations==
+
==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).
+
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.
+
In fact a mouse right click on any item in the portlet shows the context menu (see [F3]).
−
[[Image:workspace_context_menu.png|frame|Workspace context menu]]
+
 
−
The available actions depends on the selected item.
+
[[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.
−
* '''Send an item''': By selecting ''Send to'' the user can send a workspace item to another user in the same VRE. The workspace portlet show a window where to select the item addresses, then clicking on send button the item is sent.
 
  
−
===Specific actions===
+
* '''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 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 basket 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.
+
* '''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 an archive into a workspace''': 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:
+
 
 +
* '''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.
 
** the zip file is considered a folder.
−
** if a folder contains a list of files this one is transformed into a basket and the files inserted inside.
+
** if a folder (the zip file) contains subfolders and files these are transformed into a workspace folders and files recursively;
−
** if a folder contains files and subfolder this one is transformed in a workspace; the files are inserted into a new basket created into the workspace. The subfolder are processed following the rules.
+
 
−
* '''Create an external url''': on basket context menu select ''add url''. The workspace portlet show a windows where insert the url data: name, description and url value.
+
* '''Refresh Folder''': By selecting ''Refresh Folder'' the user can refresh the content of a folder.
−
* '''Open a Report ''': on the report context menu select ''Open in Report Generator''. The portal will switch to the Report generator portlet opening the selected report.
+
 
−
* '''Open a Report Template''': on the report template context menu select ''Open in Template Editor''. The portal will switch to the Template Editor portlet opening the selected report template.
+
===Specific actions===
 +
 
 +
* '''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.
+
−
* 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.
+
  
 
[[Category:User's Guide]]
 
[[Category:User's Guide]]

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"