~ubuntu-branches/ubuntu/trusty/arc-gui-clients/trusty

« back to all changes in this revision

Viewing changes to docs/users_guide/build/html/_sources/arcstorage-ui.txt

  • Committer: Package Import Robot
  • Author(s): Mattias Ellert
  • Date: 2013-05-08 22:45:38 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20130508224538-7kfhy97fg7ncfck0
Tags: 0.4.3-1
New release

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
====================
 
2
ARC Storage Explorer
 
3
====================
 
4
 
 
5
The ARC Storage Explorer is a graphical client for access grid storage resources. The client builds on the ARC middlware to support most grid storage protocols. The basic design of the application is a multi-window file browser. Copying between resources are accomplished by drag and drop between file browser windows. To limit and optimise the bandwidth for transferring files, the application implements a file transfer list which can be configured with a maximum number of simultaneous transfers. Most operations in the application are also implemented using threads, to prevent locking up the user interface. However, since many file operations can take a long time to complete some user interface operations disable interaction while operations are ongoing. As the ARC Storage application is a multi-window application, work on different storage resource can be continued by opening an additional storage window.
 
6
 
 
7
Starting ARC Storage Explorer
 
8
-----------------------------
 
9
 
 
10
ARC Storage explorer is started by selecting "Application/Internet/ARC Storage Explorer" in the applications menu in most Linux distributions. The following image shows the start menu in Scientific Linux 6.
 
11
 
 
12
.. image:: images/arcstorage-starting-1.png
 
13
 
 
14
When ARC Storage Explorer starts it will check for a valid proxy certificate. If not found it will show a dialog with options for creating a proxy certificate. 
 
15
 
 
16
Proxy generation
 
17
----------------
 
18
 
 
19
In the proxy dialog, settings for creating different kind of proxy certificates can be selected. In the first tab "Standard" options for the proxy lifetime and proxy type can be set. 
 
20
 
 
21
.. image:: images/arcstorage-proxy-1.png
 
22
 
 
23
By selecting the "Not valid after" shows a calender in which a life time of the proxy can be set. In the "Type" dropdown, the type of proxy can be selected. The default is the option of generating a RFC 3820 proxy. The other option is the generation of a standard GSI proxy. 
 
24
 
 
25
A non-VOMS proxy can be generated at this point by clicking on the "Generate" button in the lower part of the proxy dialog. This brings up a input box asking for the private key passphrase. Enter the passphrase and click OK to generate the proxy certificate. 
 
26
 
 
27
.. image:: images/arcstorage-proxy-6.png
 
28
 
 
29
When the proxy has been generated succesfully, a message box is shown confirming this. If proxy generation fails the application exits. A valid proxy certificate is needed for the application to work.
 
30
 
 
31
.. image:: images/arcstorage-proxy-7.png
 
32
 
 
33
User interface
 
34
--------------
 
35
 
 
36
The user interface of ARC Storage Explorer is designed as a standard file browser. The main window is shown in the following illustration:
 
37
 
 
38
.. image:: images/arcstorage-mainwindow-2.png
 
39
 
 
40
The top part of the window contains the menubar, toolbar and URL bar. In the URL-bar a URL can be entered of the the resource to be opened. beneath the toolbar and URL-bar is the path access bar. This toolbar presents the current URL as a set of buttons representing parts of the URL. By clicking on these buttons changes the current working directory to this part of the URL. This enables quick switching of paths without going forward and backwords in the path. 
 
41
 
 
42
Below the access bar, the directory- and file views can be found. The directory view shows a directory representation of the current working directory. This view enables quick navigation in the directory tree. Clicking on a directory in the view will also update the file view. 
 
43
 
 
44
The file view represents a listing of the current working directory. This is also the main view for file operations such as copying, deleting and viewing files and directories.  
 
45
 
 
46
In the lower part of the main window contains a log view. In this view log messages from the lower level middleware (ARC) will be presented. The verbosity of the logging can be changed in the configuration options.
 
47
 
 
48
Opening a URL
 
49
-------------
 
50
 
 
51
To open a URL in the current window, click on the URL-bar and type the desired URL, then click [Enter] to open the selected URL, as shown in the following figure:
 
52
 
 
53
.. image:: images/arcstorage-opening-url-2.png
 
54
 
 
55
Open a new browser window
 
56
-------------------------
 
57
 
 
58
ARC Storage Explorer is a multi-window application. To copy files between different URL:s requires 2 windows to drag between. There are two ways of opening a new browser window:
 
59
 
 
60
1. Creating a new window with the same URL as the current window.
 
61
2. Opening a URL in a new window.
 
62
 
 
63
Select **File/New window** in the main menu or use the **Ctrl+N** keyboard shortcut, to create a new window with the same URL as the current window. 
 
64
 
 
65
.. image:: images/arcstorage-new-window-1.png
 
66
 
 
67
The newly opened window behaves as a separate independent instance of the main window, except that it does not contain a log view. Also, closing the main window will close all opened child windows. ARC Storage Explorer will store the positions of child windows when closing the main window. When the application is opened again the child windows will also be re-opened.
 
68
 
 
69
The second option of opening a new window is to use the **File/Open new location** menu item or using the **Ctrl-O** keyboard shortcut. This brings up a window asking for a URL for the new window. 
 
70
 
 
71
.. image:: images/arcstorage-new-window-2.png
 
72
 
 
73
Browsing files
 
74
--------------
 
75
 
 
76
There are many ways of browsing the file tree in ARC Storage Explorer. The most used way is to use the file list view together with the **Up** button in the menu and toolbar. Double-clicking on a directory in the file view will change current working directory to the selected directory. 
 
77
 
 
78
.. image:: images/arcstorage-browsing-5.png
 
79
 
 
80
Using the **Up** button will change the current directory to the parent directory.
 
81
 
 
82
Another way of navigating the directory hierarchy is to use the folder view in the left side of the window. Here the directory tree can be explored by either clicking on the folders or using the folder expansion arrows to open any underlying folders. The following images shows how to expand folders in the folder view.
 
83
 
 
84
.. figure:: images/arcstorage-browsing-3.png
 
85
   
 
86
   Selecting the folder expansion icon.
 
87
|
 
88
.. figure:: images/arcstorage-browsing-4.png
 
89
   
 
90
   Expanded folder.
 
91
 
 
92
Displaying file/directory properties
 
93
------------------------------------
 
94
 
 
95
Detailed information on the file can be queried by selecting the file or directory and clicking on the right mouse button and selecting **Properties** in the context menu. This action brings up a property window, displaying the properties (metadata) of the selected file or directory.
 
96
 
 
97
.. figure:: images/arcstorage-metadata-2.png
 
98
 
 
99
   Context menu for selected file.
 
100
   
 
101
.. figure:: images/arcstorage-metadata-1.png
 
102
 
 
103
   Metadata property window.
 
104
   
 
105
Uploading files
 
106
---------------
 
107
 
 
108
Uploading files to the current directory is accomplished using the **Transfer/Upload files** menu or using the **Ctrl-U** shortcut. This opens a file selection dialog in which files that should be uploaded can be selected, as shown in the following figure:
 
109
 
 
110
.. figure:: images/arcstorage-upload-files-1.png
 
111
 
 
112
   Upload files selection dialog.
 
113
   
 
114
The file transfer is started when the **Open** button in chosen in the file selection dialog. The file transfer dialog is shown during the active file transfer. From this dialog all transfers can be monitored and controlled.
 
115
 
 
116
Uploading directories
 
117
---------------------
 
118
 
 
119
Uploading directories to the current directory is accomplished using the **Transfer/Upload directory** menu. This opens a directory selection dialog in which directories to be uploaded can be selected.
 
120
 
 
121
.. figure:: images/arcstorage-upload-directory-1.png
 
122
 
 
123
   Upload directory selection dialog.
 
124
 
 
125
.. note::
 
126
 
 
127
   It is not efficient to store thousands of small files in a directory structure. To archive and upload a larger directory structure please see the next section on how this can be accomplished.
 
128
 
 
129
Upload directory as archive
 
130
---------------------------
 
131
 
 
132
To be able to upload large directory structures, ARC Storage Explorer, provides a special function for automatically uploading an archived version of a directory. To upload a directory as an archive, select **Transfer/Upload directory as archive**. This will display a directory selection dialog.
 
133
 
 
134
.. figure:: images/arcstorage-upload-directory-1.png
 
135
 
 
136
   Upload directory as archive selection dialog.
 
137
   
 
138
When the directory has been selected using the **Open** button, ARC Storage Explorer, will create a compressed tar-archive with the same filename as the selected directory followed by a time stamp.
 
139
 
 
140
Download files and directories
 
141
------------------------------
 
142
 
 
143
Files can be downloaded to the local file system using the **Transfer/Download** menu or **Ctrl-D** shortcut. Selecting **Open**, will start the download. 
 
144
 
 
145
.. figure:: images/arcstorage-download-files-1.png
 
146
 
 
147
   Upload directory as archive selection dialog.
 
148
 
 
149
The file transfer dialog is shown during the active file transfer. From this dialog all transfers can be monitored and controlled.
 
150
 
 
151
Copying URL links
 
152
-----------------
 
153
 
 
154
Sometimes you need to communicate a URL of a specific file. This can be done using the context menu of the file list view. Select a file in the file list and use the right mouse button to show the context menu for the selected file. Select the **Copy URL** item in the menu.
 
155
 
 
156
.. figure:: images/arcstorage-copy-url-1.png
 
157
 
 
158
   Copy full URL of selected file.
 
159
   
 
160
The URL is now available from the clipboard and can be pasted into other applications.
 
161
 
 
162
 
 
163
Creating directories
 
164
--------------------
 
165
 
 
166
Directories are created in the current directory either by using the toolbar button or the menu option in the file list context menu as shown in the following figures.
 
167
 
 
168
.. figure:: images/arcstorage-create-dir-1.png
 
169
 
 
170
   Creating a directory using the toolbar.
 
171
 
 
172
.. figure:: images/arcstorage-create-dir-2.png
 
173
 
 
174
   Creating a directory using the file view context menu.
 
175
   
 
176
Next, a dialog is shown asking for the directory name. Enter a name of the new directory and click **Ok** to create it.
 
177
 
 
178
.. figure:: images/arcstorage-create-dir-3.png
 
179
 
 
180
   Dialog for chosing a name for the new directory.
 
181
 
 
182
Deleting files
 
183
--------------
 
184
 
 
185
Files can be delected by selecting them in the file view and selecting **Edit/Delete** in the menu or using the shortcut **Del**. There is also a option of deleting files from the file view context menu. 
 
186
 
 
187
.. note:: 
 
188
 
 
189
   Currently, ARC Storage Explorer does not support recursive delete operations. Also, directories must be empty before they can be deleted. The next version of the application will support recursive delete operations.
 
190
   
 
191
A confirmation dialog is shown before any file or directory will be deleted.
 
192
 
 
193
 
 
194
 
 
195
Copying files
 
196
-------------
 
197
 
 
198