Skip to main content

Using the CoLab Desktop Client

Updated over a week ago

You can create, edit and sync a file tree between your workspace and local documents using the CoLab Desktop Client.

Permissions

You must have file and folder permissions in the workspace equal or higher than the Full Access role to connect to a workspace using the CoLab Desktop Client. For custom roles, this includes:

  • Ability to add, edit and download files

  • Ability to create, edit, and delete folders

Local Folder Setup

Once the CoLab Desktop Client has been installed, set up your local root folder using these steps:

  1. Click 'Choose root folder' and select a root folder in your file browser.
    ​

    Screenshot 2024-07-15 at 12.33.59 PM.png

    Note: The local root folder should be completely empty when initially connecting it to the CoLab Desktop Client. We recommend this folder not be located within a shared drive unless a single user is uploading to it. The selection of a root folder is irreversible.

  2. Confirm the file path of the local root folder and click 'Finish setup'.
    ​

    Screenshot 2024-07-15 at 12.35.16 PM.png

  3. Click 'Continue to sign-in'.
    ​

    Screenshot 2024-07-15 at 12.35.33 PM.png


    A code will be generated in the CoLab Desktop Client and a new tab will open in your browser with a device confirmation message. Ensure the code in the browser matches the code generated in the CoLab Desktop Client; click 'Confirm'.
    ​
    ​

    Screenshot 2024-07-12 at 7.54.23 AM.png

  4. After signing in, your workspaces will appear in the left panel. Workspaces that allow downloading will be clickable. Workspaces where you lack file and folder permissions will be greyed out with a warning icon. Workspaces that do not allow downloading will be greyed out with a prohibited icon.
    ​
    You must click 'Connect local folder' to link each workspace to the local root folder. This action will add a folder for each workspace in your local root folder.
    ​

    Screenshot 2024-07-15 at 12.36.01 PM.png
    Screenshot 2024-07-15 at 11.55.54 AM.png

  5. Verify files in the connected workspace are visible in the 'Workspace' table; these files are not yet present in the local folder and available for download.
    ​

    Screenshot 2024-07-15 at 10.48.55 AM.png

  6. Set up is now complete. You can add files to the workspace folders in your local root folder. These files will be visible in the 'Local' table and are available for upload to the workspace.
    ​

    Screenshot 2024-07-15 at 11.53.47 AM.png

File Details

To view file details, hover over the desired file and select it using the checkbox. Details like the last revision, last revisor, creator and create date can be seen in the right panel for workspace files.

Screenshot 2024-07-15 at 11.56.50 AM.png

Local file details include the last revision and create date.

Screenshot 2024-07-15 at 11.58.45 AM.png

Previously synced files that have been changed will be marked as 'Updated'.

Screenshot 2024-07-15 at 12.00.45 PM.png

Note: CoLab supports independent files and folders with identical names or special characters. Such naming may not be supported by your OS. These files and directories will not be shown in the Workspace table.

Moving Files

If previously synced files are moved in or out of folders, they will be shown as deleted and added using a new path.

Screenshot 2024-07-15 at 12.02.07 PM.png

Uploading Files to CoLab

To upload files to CoLab:

  1. Hover over each local file to see a checkbox.

  2. Check the boxes for the files you want to upload, or click the checkbox next to 'Name' to select all files.

  3. Press 'Upload' in the right panel to upload the selected files.

Screenshot 2024-07-15 at 12.04.07 PM.png

Once uploaded, these files will be considered synced with the CoLab Desktop Client and will no longer be visible under the 'Local' table unless changes are made to them locally.

Downloading Files

Hover over workspace files; a checkbox field will surface for each file. Select all individual files you wish to upload or select the checkbox next to the 'Name' header to select all files. Press 'Download' in the right panel to download all selected files to your local folder.

Screenshot 2024-07-15 at 12.05.35 PM.png

Once downloaded, these files will be considered synced with the CoLab Desktop Client and will no longer be visible under the 'Workspace' table unless changes are made to them in the workspace.

Resolving Conflicts

Conflicts can occur if changes are made in the workspace or local folder that have the potential of overwriting one another.

Screenshot 2024-07-15 at 12.09.25 PM.png

If you try to upload or download files with a conflict, the following warning will be shown. Choosing to continue will typically overwrite the conflict with the selected file.

Screenshot 2024-07-15 at 12.11.22 PM.png

Files moved in the local folder do not create a conflict; they create a separate branch. For details of each conflict case, see the diagram below.

Screenshot 2024-07-15 at 1.05.09 PM.png

Deleting Files

You may delete any file or folder locally.

If you do not have file deletion permission and are uploading deletion changes to your workspace, only files you added to CoLab will be deleted. Similarly, when downloading from the workspace to your local folder, locally deleted files you did not add to CoLab will be repopulated.

If you have file deletion permission, any files and folders deleted locally or in CoLab will be deleted in the workspace or local folder respectively when synced.

Did this answer your question?