Difference between revisions of "Digital Archiving and Retrieval Tool Client User Manual"

From GICL Wiki
Jump to: navigation, search
(Summary)
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
 
=== Summary ===
 
=== Summary ===
The DART client is an open-source Windows client application that strives to make the process of archiving files and crucial metadata as easy as possible. The DART system features project management and versioning control. All versions of files archived by the DART client are saved. The DART client requires a username, password, and the URL to the DART server. Files can be archived using DART automatically or manually through a context menu entry, system tray entry, or through the process of drag-and-drop onto the DART Desktop icon.  
+
The [[Digital Archiving and Retrieval Tool Client|DART client]] is an open-source Windows client application that strives to make the process of archiving files and crucial metadata as easy as possible. The DART system features project management and versioning control. All versions of files archived by the DART client are saved. The DART client requires a username, password, and the URL to the [[Digital Archiving and Retrieval Tool Server|DART server]]. Files can be archived using DART automatically or manually through a context menu entry, system tray entry, or through the process of drag-and-drop onto the DART Desktop icon.
 +
 
 
=== System Requirements ===
 
=== System Requirements ===
 
Operating System: Windows 2000, XP, or Vista
 
Operating System: Windows 2000, XP, or Vista
Line 63: Line 64:
 
Note: If you did not set the username, password, or server address correctly the archiving process will not work.  
 
Note: If you did not set the username, password, or server address correctly the archiving process will not work.  
 
Note: In order to archive, a project must be selected. If the user does not belong to any projects, the user will not be able to archive.
 
Note: In order to archive, a project must be selected. If the user does not belong to any projects, the user will not be able to archive.
 +
 
[[Image:dart-info-request.jpg]]
 
[[Image:dart-info-request.jpg]]
 +
 +
==== Modify Folder’s Project ====
 +
This option will modify the project or set the project that a folder refers to.
 +
 +
[[Image:dart-project-selection.jpg]]
 +
 +
==== Check for Update ====
 +
Checks to see if a newer version of the client is available.
 +
 +
==== Master Configuration ====
 +
Allows the administrator to set a default Server URL.
 +
 +
==== User Configuration ====
 +
===== Login / Server =====
 +
Allows a user to set his or her username, password, and custom Server URL (when desired).
 +
 +
===== Automatic Archiving =====
 +
To enable all files that were archived before to be automatically archived every day, check the “Enable Automatic Archiving” checkbox.
 +
 +
Next, set the “Upload Time” to the time of the day when you wish to have your files automatically archived.
 +
 +
If the checkbox “Show Progress Form when Automatically Archiving” is checked, the progress form and loading bar will appear for each project that is automatically archived. This form also appears when you manually archive files. To make the automatic archiving silent, uncheck the checkbox “Show Progress Form when Automatically Archiving”.
 +
 +
Automatic archiving will only take place if the application is running in the system tray.
 +
 +
===== Start Application =====
 +
Check the box “Start the application when this user logs onto Windows” in order to have the application automatically started for the user who is currently logged in. The application will not automatically start for other users.
 +
 +
==== About ====
 +
Clicking on this option shows the application license.
 +
 +
==== Exit ====
 +
Causes the application to exit and disappear from the system tray.
 +
 +
=== Context Menu ===
 +
If you installed the application with the context menu option checked (default), right clicking on files and folders in Explorer, the Desktop, in My Computer, etc. will have two additional options.
 +
 +
==== Archive ====
 +
Archives the selected files and folders, prompting you to set the project if the project was not yet specified.
 +
 +
==== Modify Project ====
 +
Shows a form which allows you to modify the project of the selected files and folders or set the project of the selected files and folders.
 +
 +
[[Image:dart-project-selection.jpg]]
 +
 +
==== Drag-and-Drop Archiving ====
 +
If the desktop icon for DART is available, you can select files you wish to archive by holding the Control key and clicking on files and dragging them on top of the desktop icon. This will archive the files, bringing up a form to select a project if at least one of the files does not have a project set.
  
 
== Conclusion ==
 
== Conclusion ==
 +
The DART client is an open-source Windows client application that aims to make the task of archiving files and crucial metadata as easy as possible. There are a variety of ways to archive files with DART, including the context menu entry, system tray entry, or the Desktop icon.

Latest revision as of 14:01, 6 April 2007

Contents

Introduction

Summary

The DART client is an open-source Windows client application that strives to make the process of archiving files and crucial metadata as easy as possible. The DART system features project management and versioning control. All versions of files archived by the DART client are saved. The DART client requires a username, password, and the URL to the DART server. Files can be archived using DART automatically or manually through a context menu entry, system tray entry, or through the process of drag-and-drop onto the DART Desktop icon.

System Requirements

Operating System: Windows 2000, XP, or Vista

RAM: At least 256 MB

Disk Space: 1MB (for DART client only)

Installing DART

Download the DART Windows client installer from: http://dart.cs.drexel.edu/DART/download.html Download the latest version of the client. When prompted to save or run the application, choose to run the application. You should see the installer dialog:

Dart-setup-1.jpg

Click next to continue.

Dart-setup-2.jpg

You must agree to the terms of the agreement. Click “I Agree” to agree and continue with the installation.

Dart-setup-3.jpg

Afterwards, you must choose the components you wish to install. The only required component is the Application Base. The other components are optional, but recommended. To view a description about each component, move the mouse over the component item.

Dart-setup-4.jpg

You can select a directory to install the application. The default directory is recommended. After choosing the directory, press “Install” to install the application.

Dart-setup-5.jpg

The progress of the installation will be displayed.

Note: The DART client requires the Microsoft .NET Framework version 2.0 to function. The setup will automatically detect if you have it installed and will download it if the .NET Framework version 2.0 is not installed. You must install the .NET Framework to run the DART client.

Note: If the DART Client is already installed, you may get errors about certain files being in use.

Dart-setup-6.jpg

When the installation completes, click “Finish” to exit the installer. Leave the check box checked, which will start the application in the system tray and set the master configuration URL to http://dart.cs.drexel.edu/servlet/org.GICL.Dart.Dart.

Using DART

Setting the Username, Password, and Server Address

To run the DART client, double click on the desktop icon “DART” or find it in: Start, DART, DART.

The first time you run the DART client you will be prompted for your username, password, and server address (if you did not set it to the default value after installation) for archiving. If you do not know this information or do not have an account, contact your system administrator. After you input the username, password, and server address, click the “Test” button to test the connection. Be certain that you are connected to the Internet before clicking on “Test”. You will either get an error message or a success message after clicking “Test”. In order for the DART client to be able to archive files, you must receive notification of success after pressing “Test”:

Dart-auth-success.jpg

After you set the username, password, and server address, the application will run in the system tray. To change your username, password, or server address, right click on the system tray icon and click on “User Configuration”.

System Tray

Accessing the System Tray

To allow the DART client to run in the system tray, double click on the DART icon on your desktop if available.

Archive Folder

This option in the system tray allows the user to archive a folder. Choose the directory you wish to archive from the directory picker dialog. If you never archived the directory before, you will need to set the project that it belongs to. A form will appear with a list of the projects to which the user is a team member. You can optionally enter in a description and tags that will be applied to each file. Note: If you did not set the username, password, or server address correctly the archiving process will not work. Note: In order to archive, a project must be selected. If the user does not belong to any projects, the user will not be able to archive.

Dart-info-request.jpg

Modify Folder’s Project

This option will modify the project or set the project that a folder refers to.

Dart-project-selection.jpg

Check for Update

Checks to see if a newer version of the client is available.

Master Configuration

Allows the administrator to set a default Server URL.

User Configuration

Login / Server

Allows a user to set his or her username, password, and custom Server URL (when desired).

Automatic Archiving

To enable all files that were archived before to be automatically archived every day, check the “Enable Automatic Archiving” checkbox.

Next, set the “Upload Time” to the time of the day when you wish to have your files automatically archived.

If the checkbox “Show Progress Form when Automatically Archiving” is checked, the progress form and loading bar will appear for each project that is automatically archived. This form also appears when you manually archive files. To make the automatic archiving silent, uncheck the checkbox “Show Progress Form when Automatically Archiving”.

Automatic archiving will only take place if the application is running in the system tray.

Start Application

Check the box “Start the application when this user logs onto Windows” in order to have the application automatically started for the user who is currently logged in. The application will not automatically start for other users.

About

Clicking on this option shows the application license.

Exit

Causes the application to exit and disappear from the system tray.

Context Menu

If you installed the application with the context menu option checked (default), right clicking on files and folders in Explorer, the Desktop, in My Computer, etc. will have two additional options.

Archive

Archives the selected files and folders, prompting you to set the project if the project was not yet specified.

Modify Project

Shows a form which allows you to modify the project of the selected files and folders or set the project of the selected files and folders.

Dart-project-selection.jpg

Drag-and-Drop Archiving

If the desktop icon for DART is available, you can select files you wish to archive by holding the Control key and clicking on files and dragging them on top of the desktop icon. This will archive the files, bringing up a form to select a project if at least one of the files does not have a project set.

Conclusion

The DART client is an open-source Windows client application that aims to make the task of archiving files and crucial metadata as easy as possible. There are a variety of ways to archive files with DART, including the context menu entry, system tray entry, or the Desktop icon.