...
| Note |
|---|
The Sync Tool requires that Java version 7 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 that is necessary. If you would like to update Java directly, it can be downloaded from here. If you are using a Mac and have questions about Java 7, you will likely find answers here. Due to issues which occasionally arise when attempting to install Java 7 on the Mac platform, an installer is provided which bundles Java 7, removing the need to perform a local installation. If you cannot use Java 7 on your platform now, you have the option of using an older version of either the Sync Tool (which is available here) or the Upload Tool (which is available here). This version of the Sync Tool only includes a command line interface. The Upload Tool provides a graphical interface (a GUI), but is not as full featured as the Sync Tool. |
...
Graphical Interface
The Sync Tool has two interfaces, providing the choice of whether the user prefers a command line or a graphical display.defaults to a graphical user interface.
- The Sync Tool provides Graphical interface
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
- If you would like to completely shut down the Sync Tool process, such that the UI is no longer available:
- 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.
...