The CodaBox SyncTool is a synchronisation tool that allows you to collect CODA files from CodaBox and save them locally.


INSTALLATION


Download and install the CodaBox SyncTool software on your device or server
You can download the software via this link
Note: The software takes on the language of your Windows Operating System. If necessary, you can change the language (after installation) via the settings.
Once the application has been installed, it is automatically updated when the SyncTool is launched: after an update, you just need to restart the software to get the latest, secure version.


Important: You must have local Windows administrator rights to install the Synctool (if you have any doubts about this, contact your IT administrator).
  • Click the link above to download the zip file 'CodaBox-SyncTool-0.3.11.Setup.exe’ 
  • Open/double click the installation file to complete the installation
  • The following window will appear while the software is installing:
  • After installation, the software opens automatically.
Installation ongoing icon
Note about file synchronization:
For file synchronization to occur automatically, the computer on which you installed the CodaBox SyncTool must be powered on AND the user account, which you used to execute the installation, must be active. 
➟  Are you installing the SyncTool on a Server? Make sure you install it with the user account that is most often active on your Server.


OPENING AND CLOSING OF THE SOFTWARE


Opening the software
You can open the software via
  1. the shortcut on the Desktop or 
  2. the Windows Start menu or 
  3. the notification area of the Windows taskbar (to the left of the clock).

Open CodaBox SyncTool


Open CodaBox SyncToolOpen CodaBox SyncTool


Closing the software

You can close the software via:

  • the menu: Actions > Quit application
  • the system tray of the Windows taskbar: right-click on the icon of the CodaBox SyncTool and select 'Quit application'

You can also minimize the software to continue to run in the background and automatically download files when new ones are available. This can be done by clicking the 'x' at the top right of the application. Once minimized, you can open the application again by clicking on the icon in the system tray.Close CodaBox SyncTool


The menus


CONFIGURATION


To download the files, you must first configure your software with the username and password you received from CodaBox. If you didn’t receive this, please contact Helpdesk 


Add a new connection

Add new connection button

A connection is a combination of a username, password and a download folder.

You can add different connections so that you can download the files from different FTPs, each in a different folder on your computer.

  1. Click the Add new connection button in the main window.
  2. In the new window, enter the username and password you received from CodaBox.
  3. Click the folder icon to choose where you want to download the files. 
  4. If you want to, you can name the connection via the optional field 'Connection name'.
    Add a new CodaBox SyncTool connection
  5. Click Confirm. The saved connection will appear in the main window.SyncTool connections overview


Test the connection
Test connection icon
Once the connection has been added, you can check whether or not it’s active. This can be done by clicking the Test connection icon:Test SyncTool connection

When the connection is successful:

  • The Test connection icon changes to a green V checkmark for 5 seconds
  • The date and time of the last successful connection is shown under 'More info'
Succesful connection SyncTool

When the connection has failed:

  • The Test connection icon changes to a red ! exclamation mark for 5 seconds
  • A pop-up appears with the reason of failure

Below you can find a list of the most common error messages and their solution


Edit a connection

Edit connection icon

In case you made a mistake entering the details, or you want to change the destination folder for the downloads, you can click the Edit connection icon (next to the connection you want to change).Edit SyncTool connection

A window will appear with the data already entered, so that you can easily adjust it. When you're done, click Confirm.


Delete a connection
Delete connection icon
You can also delete an existing connection by clicking the Delete connection icon. After an additional confirmation, this connection is removed.Delete a SyncTool connection


ATTENTION! 

The files you already downloaded locally will not be deleted if you remove the connection in the CodaBox SyncTool. If you also want to remove them, you will have to do it manually on your computer


Download files

Download files icon

Once the connection is established, the CodaBox SyncTool will check every 2 hours if new files are available, and also download them in the specified folder.


You can also check and download files at any time, if they are available on the server. Click the Download files icon.Download files from SyncTool


Browse the download folder
Browse downloads icon
The download folder can be accessed via the folder icon.Browse the downloaded files


More info about file delivery in our article 'Where are the CodaBox files delivered via FTP?'


MOST COMMON ERROR MESSAGES


If an error occurs, you will see a window with the description of the error. In this chapter you can find an overview of the most common errors and what you can do about them.


I can't connect
Login error SyncTool
  1. Login or password incorrect
    Use the login and password that you received from CodaBox.
  2. Firewall problems
    If you are using a correct login and password, but still fail to connect to the CodaBox server, there could be several other reasons. Therefore, always check with your IT department first: it may be that the problem lies with the firewall you are using. They can easily solve this for you.


My files are not downloaded
Download error SyncTool
  1. No access to the folder
    You have a working connection, but the files are not coming into the folder you selected. Perhaps you do not have permission to write files to that folder. Check with your IT department, they can solve this problem for you.
  2. Not enough space
    You may not have enough storage space on the disk where the folder is located. In this case you will have to free up space by deleting or moving other files.


Other error messages
You've read the most common error messages above but the problem persists? Go to the logs, the solution to your problem may be there. 
The logs are organized by date/connection and can contain very useful information about what happened. They are available in the window displaying your connections, via the Open logs button: Show logs SyncTool
Issue not solved? Please contact Helpdesk, we will be happy to assist you!