Difference between revisions of "Web Application Scheduler Portlet"

From Gcube Wiki
Jump to: navigation, search
(→‎Scheduler Portlet)
(→‎Assumptions and More ...)
 
(46 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<!-- CATEGORIES -->
 +
[[Category:Developer's Guide]]
 +
<!-- END CATEGORIES -->
 
= Scheduler Portlet =
 
= Scheduler Portlet =
  
−
The scheduler portlet is an interface implemented for the client with the general purpose of scheduling transfers. The client has also the option of monitoring and canceling the transfer. In addition there are two more operations for getting the outcomes of a transfer and getting the transfer from the database.  
+
The scheduler portlet is an interface implemented for the client with the general purpose of scheduling transfers. The client has also the option of monitoring and canceling a transfer. The Scheduler Portlet also provides statistics about the agent nodes so that the user can choose the most beneficial agent.<br>
−
This is how it looks :
+
<br>
−
//
+
[[File:Scheduler_portlet_4-6.png|650px|thumb|center|Scheduler Portlet v 2.0.0]]<br>
−
On the left side there is the main form where depending on the command the client should also fill the appropriate fields. The commands are: schedule,monitor,cancel,get outcomes and get transfers. When the client submit the command a pop up window shows the result except the schedule command where the submit button leads the user on the right form so as to choose the files/URI's he wants to transfer.
+
<br>
  
−
The right side is for the schedule details.  
+
== Main Form ==
−
There are three source types: workspace, datasources, URI's.
+
<br>
−
The first one is for choosing files from a given folder by the portlet. This folder is relevant to the current user.  
+
On the left side, there is the main form where the user can choose between several ways of scheduling such as 'direct', 'manually' by giving the specific time instance and 'periodically' by giving the frequency and the start time instance.<br>
−
//
+
<br>
−
With the second one we choose the datasource and then the files we want to schedule.  
+
[[File:SchedulerPortlet-main.png|650px|thumb|center|Main Form]]<br>
−
The last one if for scheduling the files represented from URI's.  
+
<br>
−
//
+
== Source & Destination ==
−
The already submitted scheduled transfers can be seen in the bottom form.  
+
<br>
−
//
+
On the right side, there are two panels. The one contains the toolbar for selecting source and destination type and the other contains the source and destination stores.<br>
 +
Source types are the '''treeBased''' (tree collections stored in the IS), '''Workspace''', '''MongoDB''', '''DataSource''', '''Agent''''s node and the '''URI''''s. <br>
 +
Destination types are the '''treeBased''' (tree collections stored in the IS), '''MongoDB''', '''DataStorage''' and the '''Agent''''s node.
 +
<br>
 +
[[File:SchedulerPortlet-toolbar.png|650px|thumb|center|Toolbar]]<br>
 +
<br>
 +
When the user chooses the source, several files from the source are shown in the source panel. The user can select the files he wants to transfer via dragging and dropping them in the target panel on the right. Notice that the destination/target panel can contain only files and not folders.<br>
 +
<br>
 +
There are four buttons here:<br>
 +
*hide main in order to see the right panel full width<br>
 +
*refresh source so as to reload the source store<br>
 +
*reset target to clean the already selected files and<br>
 +
*schedule for scheduling a transfer.<br>
 +
Depending on the destination type there may be more buttons. <br>
 +
In case we having mongoDB as a destination type there will be two more buttons: <br>
 +
*create folder so as to create a new folder in mongoDB<br>
 +
*delete target folder<br>
 +
While when we have treeBased as a destination type there will be two more buttons: <br>
 +
*create tree source<br>
 +
*delete target tree source<br>
 +
<br>
 +
[[File:SchedulerPortlet-panels.png|650px|thumb|center|Source & Destination Panels]]<br>
 +
<br>
 +
 
 +
== Schedule Details Panel ==
 +
<br>
 +
On the bottom, there is a form which shows information about the user's scheduled transfers. Information provided is: id,status type and submitted date. The user is able by double-clicking on one of them to submit a command for this specific transfer. Available commands are: monitor, get outcomes, and cancel.<br>
 +
<br>
 +
Two tool-buttons here<br>
 +
*refresh for reloading the transfers and<br>
 +
*view agent statistics <br>
 +
<br>
 +
[[File:SchedulerPortlet-grid.png|650px|thumb|center|Schedule Details]]<br>
 +
<br>
 +
 
 +
== Selecting the Source Type ==
 +
<br>
 +
1: Clicking on the source type button, a pop up windows appears in order to select one of the given option. <br>
 +
<br>
 +
[[File:SchedulerPortlet-sourceType.png|650px|thumb|center|Source Type PopUp Window]]<br>
 +
<br>
 +
2: In case of 'workspace' the files of the root folder are added in the source panel.<br> In case of 'datasource' a second pop up window appears for selecting one of the available datasources. <br>
 +
<br>
 +
[[File:SchedulerPortlet-datasource.png|650px|thumb|center|Selection:Datasource]]<br>
 +
<br>
 +
Selecting the third option of URI, the new pop up window gives user the possibility to add his own URI's and transfer files from public links. <br>
 +
<br>
 +
[[File:SchedulerPortlet-uri.png|650px|thumb|center|Selection:URI]]<br>
 +
<br>
 +
 
 +
== Selecting the Destination Type ==
 +
<br>
 +
1: Clicking on the destination type button, a pop up window appears in order to select one of the given options. <br>
 +
<br>
 +
[[File:SchedulerPortlet-destinationType.png|650px|thumb|center|Destination Type PopUp Window]]<br>
 +
<br>
 +
2: In case of 'agent's node', the user has to select the agent node from the new pop up window. <br>
 +
<br>
 +
[[File:SchedulerPortlet-agent.png|650px|thumb|center|Selection:Agent's node]]<br>
 +
<br>
 +
In addition it is possible to see the agent statistics and make his choice from the statistic panel. <br>
 +
<br>
 +
[[File:SchedulerPortlet-agentStatistics.png|650px|thumb|center|Agent Statistics]]<br>
 +
<br>
 +
In case of 'MongoDB', if you are an admin VO/VRE user you will be asked to fill the MongoDB details in a new pop up window and select the node which is going to make the operation(agent). Regarding the MongoDB details there is also the option for the admin to click the checkbox for the default values. If you are a simple user the MongoDB bucket is the one regarding the shared folder of the current VRE and you will be not asked to fill this type of information.<br>
 +
<br>
 +
[[File:SchedulerPortlet-mongoDB.png|650px|thumb|center|Selection:MongoDB]]<br>
 +
<br>
 +
In case of 'DataStorage', the user selects the remote node from the new pop up window and then the agent.<br>
 +
<br>
 +
[[File:SchedulerPortlet-datastorage.png|650px|thumb|center|Selection:DataStorage]]<br>
 +
<br>
 +
<br>
 +
 
 +
== Assumptions and Known Issues ==
 +
<br>
 +
*If the source type is 'workspace' the user will be asked to give the password when submit a transfer.
 +
*If the source type is tree-based the destination type must be also tree-based and the other way around.
 +
*The portlet takes into consideration only the DATASOURCES and DATASTORAGES whose name starts with "HTTP" or "FTP".
 +
*The portlet is flexible enough and it can be resized with min width 800 pixels.
 +
*The source store/panel contains the directory tree starting from the root of datasource or workspace you selected. In case of URI's the source store/panel has the URI's you selected as files.  
 +
*Sometimes the 'back' folder of the source is not properly loaded. Such issue can be resolved by just double click on the 'back' element and you will load the parent source folder. Generally any issue about the source tree can be resolved by reloading again the current source folder. Just click on the refresh button of the source panel.
 +
*The overwrite option is applied in case of transferring to Agent/DataStorage while the unzip option is applied only in case of transferring to Agent's node.

Latest revision as of 17:40, 25 February 2014

Scheduler Portlet

The scheduler portlet is an interface implemented for the client with the general purpose of scheduling transfers. The client has also the option of monitoring and canceling a transfer. The Scheduler Portlet also provides statistics about the agent nodes so that the user can choose the most beneficial agent.

Scheduler Portlet v 2.0.0


Main Form


On the left side, there is the main form where the user can choose between several ways of scheduling such as 'direct', 'manually' by giving the specific time instance and 'periodically' by giving the frequency and the start time instance.

Main Form


Source & Destination


On the right side, there are two panels. The one contains the toolbar for selecting source and destination type and the other contains the source and destination stores.
Source types are the treeBased (tree collections stored in the IS), Workspace, MongoDB, DataSource, Agent's node and the URI's.
Destination types are the treeBased (tree collections stored in the IS), MongoDB, DataStorage and the Agent's node.

Toolbar


When the user chooses the source, several files from the source are shown in the source panel. The user can select the files he wants to transfer via dragging and dropping them in the target panel on the right. Notice that the destination/target panel can contain only files and not folders.

There are four buttons here:

  • hide main in order to see the right panel full width
  • refresh source so as to reload the source store
  • reset target to clean the already selected files and
  • schedule for scheduling a transfer.

Depending on the destination type there may be more buttons.
In case we having mongoDB as a destination type there will be two more buttons:

  • create folder so as to create a new folder in mongoDB
  • delete target folder

While when we have treeBased as a destination type there will be two more buttons:

  • create tree source
  • delete target tree source


Source & Destination Panels


Schedule Details Panel


On the bottom, there is a form which shows information about the user's scheduled transfers. Information provided is: id,status type and submitted date. The user is able by double-clicking on one of them to submit a command for this specific transfer. Available commands are: monitor, get outcomes, and cancel.

Two tool-buttons here

  • refresh for reloading the transfers and
  • view agent statistics


Schedule Details


Selecting the Source Type


1: Clicking on the source type button, a pop up windows appears in order to select one of the given option.

Source Type PopUp Window


2: In case of 'workspace' the files of the root folder are added in the source panel.
In case of 'datasource' a second pop up window appears for selecting one of the available datasources.

Selection:Datasource


Selecting the third option of URI, the new pop up window gives user the possibility to add his own URI's and transfer files from public links.

Selection:URI


Selecting the Destination Type


1: Clicking on the destination type button, a pop up window appears in order to select one of the given options.

Destination Type PopUp Window


2: In case of 'agent's node', the user has to select the agent node from the new pop up window.

Selection:Agent's node


In addition it is possible to see the agent statistics and make his choice from the statistic panel.

Agent Statistics


In case of 'MongoDB', if you are an admin VO/VRE user you will be asked to fill the MongoDB details in a new pop up window and select the node which is going to make the operation(agent). Regarding the MongoDB details there is also the option for the admin to click the checkbox for the default values. If you are a simple user the MongoDB bucket is the one regarding the shared folder of the current VRE and you will be not asked to fill this type of information.

Selection:MongoDB


In case of 'DataStorage', the user selects the remote node from the new pop up window and then the agent.

Selection:DataStorage



Assumptions and Known Issues


  • If the source type is 'workspace' the user will be asked to give the password when submit a transfer.
  • If the source type is tree-based the destination type must be also tree-based and the other way around.
  • The portlet takes into consideration only the DATASOURCES and DATASTORAGES whose name starts with "HTTP" or "FTP".
  • The portlet is flexible enough and it can be resized with min width 800 pixels.
  • The source store/panel contains the directory tree starting from the root of datasource or workspace you selected. In case of URI's the source store/panel has the URI's you selected as files.
  • Sometimes the 'back' folder of the source is not properly loaded. Such issue can be resolved by just double click on the 'back' element and you will load the parent source folder. Generally any issue about the source tree can be resolved by reloading again the current source folder. Just click on the refresh button of the source panel.
  • The overwrite option is applied in case of transferring to Agent/DataStorage while the unzip option is applied only in case of transferring to Agent's node.
Retrieved from "https://wiki.gcube-system.org/index.php?title=Web_Application_Scheduler_Portlet&oldid=21131"