Topics

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.

This page describes using the SyncTool via the User Interface. The SyncTool can also be used in command line mode.

System Requirements

The system requirements for operating the SyncTool are described here.

Download and Install

Download installers for Mac OSX, Windows, or Linux from the DuraCloud Downloads page. 


The Catalina version of MacOS (v10.15), released on Oct 7, 2019 no longer supports 32-bit applications: https://support.apple.com/en-us/HT208436. The DuraCloud SyncTool installer is 32-bit, meaning that the Mac installer will not work for the latest version of the MacOS. This is a known issue that is expected to be addressed in the next DuraCloud release. More details about work on this issue can be found in the associated ticket.

The work around for this issue is to use the JAR version of the DuraCloud SyncTool on MacOS v10.15+. The JAR can be used to either operate the SyncTool in Command Line mode or launch the SyncTool UI directly.


The Sync Tool requires that Java version 8 or above be installed on your system in order to run. The installers for your operating system will check to make sure that you have the correct version of Java and will prompt you to download and install Java if necessary. If you would like to update Java directly, it can be downloaded from here.

The Sync Tool defaults to a graphical user interface.

In order for the SyncTool to run in UI mode, it must be installed on a machine with a graphical interface. This means that the SyncTool cannot be run in UI mode on "headless" servers. In this case, the tool should be run in command line mode (more details below.)


Operational Notes

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.

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.

Troubleshooting

If you encounter an error when running the Sync Tool, please first consult the list of error messages and suggested fixes below. If the error you are experiencing is not included in the list below, please visit the support system and submit a ticket with a detailed description of the issue you are experiencing (and include screenshots when available).