DuraCloud Sync Tool

Introduction

The Sync Tool is a utility which was created in order to provide a simple way to move files from a local file system to DuraCloud. To get started with the Sync Tool, read on, or watch videos of the process here.

Download and Install

Graphical Interface

The Sync Tool defaults to a graphical user interface.

• The Sync Tool provides a web-browser-based application user interface which begins with a configuration wizard, then provides a dashboard display showing the current status of the sync process. This interface is the default and is started by running selecting any of the shortcuts created by the installer.
• Once running, this interface will be continually available at this address: http://localhost:8888/sync.

Operational Notes

• Closing the browser window will not stop the Sync Tool. It will continue to run and transfer files.
• Getting back to the Sync Tool
  
  • Once the Sync Tool is started, it will continue to run in the background, even if you close your browser. You can also get back to the UI by pointing your browser to: http://localhost:8888/sync (hint: bookmark this page).
  • Selecting any of the shortcuts created by the installer will bring up the Sync Tool UI.
• Stopping the Sync Tool
  
  • Within the UI there are options to stop and start the sync. This will allow you to stop syncing for a time, and start it up again later.
• Stopping the Sync Tool process
  
  • If you would like to completely shut down the Sync Tool process, such that the UI is no longer available:
    
    • On Windows: Look for a DuraCloud Sync icon in the task tray, right click on it, select Exit
    • On Mac: Look for a DuraCloud Sync icon in the menu bar, right click on it, select Exit
    • On Ubuntu: Look for a DuraCloud Sync icon in the task bar, right click on it, select Exit
• Work Directory
  
  • The work directory is named duracloud-sync-work, and can be found under your home directory (C:\Users\[username] on Windows, /Users/[username] on Mac, /home/[username] on Linux)
  • In the work directory you will find: 
    
    • A configuration file which includes the data you entered when configuring the tool
    • A logs directory with log files containing runtime status information of the Sync Tool. These can be helpful when diagnosing a problem the tool may have had.

Command Line Interface

The Sync Tool provides a command line interface which can be executed directly, used in scripts, or used for scheduling sync activities (such as within a cron job.)  The command line interface provides access to all feature of the Sync Tool, some of which are not available (yet) in the graphical interface.

• More information about using the command line interface can be found here.

Metadata

As the Sync Tool transfers files to DuraCloud, it will attempt to capture certain types of metadata about each file, and include that information as part of the content item added to DuraCloud. The list below describes the metadata that is captured automatically. You have the option to add, update, or delete the properties of each file after it has been transferred to DuraCloud.

• Mime Type
  • The content type of the file.

  • As the Sync Tool transfers your files to DuraCloud, it attempts to determine the mime type of each file based on the file's extension. If it cannot determine a mime type for a given file, that file's type is set to "application/octet-stream", which is a generic mime type for binary data. Select the "Edit" button on the DuraCloud web interface to change a file's mime type.

  • If you find that files with certain extensions are not being mapped as you would prefer, you can always change the value on uploaded files from within DuraCloud. If you would like to make sure that files with a given extension are given your preferred mime type during upload, you simply need to update the mapping file. The mapping of file extension to mime type is determined by a file included in your Java installation called content-types.properties. This file is usually located in the "lib" folder under your Java runtime installation directory. After making a copy of the original file as a backup, simply update it following the formatting conventions used throughout the file to include the mappings you prefer, then save the file. After making changes, you will need to re-start the Sync Tool to ensure that the changes are picked up properly.

• Space
  
  • The space in which a content item is stored. This field cannot be edited.
• Size
  
  • The size of a content item. This field cannot be edited.
• Modified
  
  • The date on which the file was added to DuraCloud. This value is updated when a file is added or updated.
• Checksum
  
  • The MD5 checksum of the file. This field cannot be edited.
• Creator
  
  • The creator is the DuraCloud user who transferred the file into DuraCloud storage.
• Content file path
  
  • The full path of the file in its original storage location
• Content file created
  
  • The date when the file was created, as determined by the originating file system. This information may not be available from all file systems.
• Content file modified
  
  • The date when the file was last modified, as determined by the originating file system. This information may not be available from all file systems.
• Content file last accessed
  
  • The date when the file was last accessed, as determined by the originating file system. This information may not be available from all file systems.