Desktop and Mobile

Nuxeo Drive

Updated: March 8, 2017 Page Information Edit on GitHub

Functional Overview

Nuxeo Drive is a Nuxeo addon that enables the synchronization of folders or workspaces from the Nuxeo Platform with local folder on your computer.

Here is the big picture of how Nuxeo Drive works: on the Nuxeo Platform web interface, you mark some workspaces or folders to synchronize. After you installed the Nuxeo Drive client on your computer and bound it to a Nuxeo server, documents are saved on your computer so you can access them and work on them offline. And the next time you have an Internet connection, changes in your local folder are uploaded to the Nuxeo Platform. Changes on the server are also automatically downloaded to your computer. Nuxeo Drive also enables to edit synchronized documents locally from your computer.

Please note that the main purpose of Nuxeo Drive is to allow synchronization between a file system and some mount points of a Nuxeo repository. Nuxeo Drive is neither a bulk import tool, nor a repository backup / synchronization tool.

Synchronizing Content

Nuxeo Drive Synchronization Status

Here are the different statuses of Nuxeo Drive:

Icon Status
Synchronization is disabled (offline mode or suspended synchronization).
Nuxeo Drive has successfully synchronized.
Nuxeo Drive is synchronizing with the Nuxeo Platform.
Your credentials are incorrect.

Accessing the Nuxeo Drive Folder

When you install Nuxeo Drive on your computer, it creates a "Nuxeo Drive" folder on your computer, from where you will be able to access the synchronized documents. This Nuxeo Drive folder is located:

  • in C:\Users\USER\Documents\ on Windows
  • in /Users/USER/ on Mac OS X
  • in /home/USER/ on Linux

Quick access to this folder is possible at any time using the Nuxeo Drive icon:

  1. Right-click on the icon (in the top menu bar on Mac OS X, in the system tray on Windows).
  2. Click on the icon . The Nuxeo Drive opens like any folder. You can now browse the Nuxeo synchronized folders from your desktop.

Marking Workspaces and Folders for Synchronization

Nuxeo Drive enables the synchronization of the document types below and their content:

  • Workspace
  • Folder
  • Ordered folder

In the rest of this documentation, we'll call them all "folder".

Synchronizing a Folder

Starting from Nuxeo Platform 6.0, you can synchronize spaces on which you have at least Read permissions. For older versions of the Nuxeo Platform, you need at least Edit permissions to be able to synchronize a space.

JSF UI

To synchronize a space, in the Nuxeo Platform, click on the icon . The icon becomes green. Documents inside the synchronized space have an icon and a Drive local edit icon .

The folder and all its content is now available in your local Nuxeo Drive folder. You can now create, edit, delete documents from your computer. If you only have Read permissions, documents are in read-only mode.

On your Home Nuxeo Drive tab, the space is displayed in the "Synchronization root" section. This is where you can see all the spaces you have synchronized with Nuxeo Drive.

Web UI

To synchronize a space, in the Nuxeo Platform, click on the icon . The icon becomes orange . Documents inside the synchronized space have a Drive local edit icon .

The folder and all its content is now available in your local Nuxeo Drive folder. You can now create, edit, delete documents from your computer. If you only have Read permissions, documents are in read-only mode.

On your Home Nuxeo Drive tab, the space is displayed in the "Synchronization root" section. This is where you can see all the spaces you have synchronized with Nuxeo Drive.

Suspending Synchronization

If a synchronized folder holds big document or a large amount of documents, synchronization can take some time and some computer resources. It is then possible to prevent this by suspending synchronization until a more convenient time.

To suspend synchronization:

  1. Click on the Drive icon in the system tray.
  2. Click on the icon and click on the Suspend menu item. If Nuxeo Drive is currently synchronizing, synchronization is completed before suspending Nuxeo Drive. The Drive icon becomes grey as long as synchronization is suspended: .

To resume synchronization:

  1. Click on the Drive icon in the system tray.
  2. Click on the icon and click on the Resume menu item. The Drive icon becomes blue again and synchronization is available again.

Unsynchronizing a Folder

There are two ways to desynchronize a folder.

  • From the server, when you desynchronize a folder all its content is desynchronized from all the devices where you use Drive.
  • From the client, when you desynchronize a folder you can do it in detail and choose to locally deactivate synchronization of different folders for the current device.

Deactivating Synchronization Locally (Client)

By default, once you have synchronized a folder all its content (files and folders) are synchronized. But you can deactivate synchronization locally on some folders. This feature enables you to manage the storage space dedicated to the synchronization, which is especially useful if you use a device with a low-storage capacity.

Clicking on the Select sync folders button in the Settings window shows the Nuxeo Drive Filters windows from which you can unselect folders to unsynchronize. Unselected folders remain displayed to you can easily reselect and synchronize them back. They are still marked as synchronized on your web UI.

Unsynchronizing Folders (Server)

JSF UI

Unsynchronizing a folder is only possible from the Nuxeo Platform web interface. You can only unsynchronize the whole synchronized space, i.e. from the synchronization root : it is not possible to unsynchronize a child . Clicking on the icon brings you back on the space from which the synchronization is done.

To unsynchronize a space, in the Nuxeo Platform interface, click on the icon . The icon becomes gray, indicating that the space is no longer synchronized. The folder and its content is no longer available from your Nuxeo Drive folder and from the Home Nuxeo Drive tab.

Web UI

Unsynchronizing a folder is only possible from the Nuxeo Platform web interface. You can only unsynchronize the whole synchronized space, i.e. from the synchronization root .

To unsynchronize a space, in the Nuxeo Platform interface, click on the icon . The icon becomes gray, indicating that the space is no longer synchronized. The folder and its content is no longer available from your Nuxeo Drive folder and from the Home Nuxeo Drive tab.

Managing Documents

Creating Documents

From the Platform

When you create a new document in a Drive-synchronized folder from the Platform, it is automatically created in your Drive folder at the next synchronization. If you created a file or a picture, what is in the Drive folder is the attachment (mydoc.doc for instance for Nuxeo document whose title could be "My document").

From the Local Nuxeo Drive Folder

Adding a new document in a Drive-synchronized folder from your computer will create the document in the Platform workspace at the next synchronization. The document title is the name of the original file, and no metadata is filled in.

Here are some examples of most commonly used item types and their output in Nuxeo:

Item type Document created in Nuxeo
Microsoft Office file File
OpenOffice.file File
.txt file Note
Picture (.jpg, .png, etc) Picture

Editing Documents

Versioning

When you edit a document, either from your Nuxeo Drive folder or using the online editing, a new version is automatically created on the Platform and the version number is updated:

  • If you are not the last contributor of the document
  • Or if your last edit is more than an hour ago

Then, if your document's version was 1.0 before modification for instance, it automatically becomes 1.1+ after you edited it from the Nuxeo Drive folder and the 1.1 is archived as it is created. Otherwise, a simple modification is done on the document and logged in the document's History.

See the page How to Customize Nuxeo Drive Versioning Policy to change this behavior.

Editing a Locked Document

In the Nuxeo Drive folder, no indication is available if a document has been locked from the Nuxeo Platform interface. Nuxeo Drive won't prevent you from working on a document, but it will not update the locked document on the server if you are not the locker.

Managing Conflicts

It can happen that a document is edited by several users locally at more or less the same time. Or that a user edits a document locally in offline mode, and that the same document is modified during that offline period. When Nuxeo Drive tries to synchronize the document it detects that there may be a conflict between the different modifications of the document.

Clicking on the conflict message shows you the details and how to resolve the conflicts.

  • Use local: The document in your Nuxeo Drive folder overrides the document on the server.
  • Use remote: The document on the server is downloaded in your Nuxeo Drive folder and overrides your local version.
  • Duplicate files: A new document is automatically created for the offline edited document. Its title is suffixed with __1: "my document__1.odt" for instance. Two documents are now available in the Nuxeo Platform and in the local Nuxeo Drive folder.

Online Editing with Direct Edit

Direct Edit enables you to edit any of your document's content from their Summary tab even if they are not synchronized. To be able to use correctly Direct Edit you need the Drive addon on your server and you must turn on Drive on your computer. This saves you the fastidious steps of opening your document, modify it and reimport it on your platform.

Direct Edit icon

JSF UI:

Web UI:

To edit a document locally from the web interface:

  1. On the document in the Nuxeo Platform, click on the Direct Edit icon on the Summary tab on JSF UI and on document View on Web UI. The document opens in its native application (OpenOffice.org for an .odt file for instance).

    If you plan to work on the document for some time, you can easily lock it from the Metadata edit popup (see the section Metadata Edit).

    Note that depending on your OS and the file format, the document can be automatically locked.This is still a beta feature of Direct Edit, known to currently work on OS X and Windows.

  2. Edit the document and save the modifications. Modifications are saved in the Nuxeo Platform directly.
  3. Close the document.

Direct Edit Limitations

  • Prior to Nuxeo Platform 6.0, online editing is available only in synchronized folders.
  • Under Windows, nothing happens if you click on the Direct Edit icon without having Drive installed and running on your computer.

Renaming Documents

Renaming a document from the server, i.e. changing the document's title, has no impact on the file's name in your Nuxeo Drive folder, which is the document's attachment.

Renaming a document from the Nuxeo Drive folder renames the document and its attachment on the server if they have the same name. If the document title is different from the attachment's, then only the attachment is renamed.

Editing Metadata

Metadata edit is available starting from Nuxeo Platform 6.0.

Metadata Edit allows you to edit the metadata of your document from your desktop.

  1. Go to your Nuxeo Drive folder on your computer.
  2. Right-click on the name of the document that you want to edit.
  3. Click on Nuxeo Drive. A window pops up where you can also locked the document, get the permanent link or add your document to your favorites.
  4. Click on Edit and modify your document,
  5. Click on Save.

Moving Documents

You can move documents either from your local Nuxeo Drive folder or from the Platform. When you move documents between two synchronized spaces, the move is done on the other side, whether you move documents from the Platform or from your Drive folder.

When you move a document from a Drive-synchronized folder to an unsynchronized one, the behavior is different if you move the document from the Platform or from your local folder.

  • If you move the document from the Platform, the document is not available anymore in your local folder.
  • If you move the document from your local folder, the document is deleted on the Platform and moved into the folder's trash. In the document's history, the deletion is tagged with the Nuxeo Drive category.

Deleting Documents

When you delete documents from the Platform, they are deleted from your local Drive folder at the next update.

When you delete a document from your local Drive folder, the document is deleted on the Platform and moved into the folder's trash. In the document's history, the deletion is tagged with the Nuxeo Drive category.

Unauthorizing a Drive Client to Access the Nuxeo Platform

When you start Nuxeo Drive on your computer for the first time, you need to provide your credentials so the Drive client can communicate with the Nuxeo Platform. This creates an authentication token on the Platform, that is displayed on the Nuxeo Drive tab in the Home on JSF UI and on the Nuxeo Drive part of User Settings on Web UI.. If you want to unauthorize a Drive client to access the Nuxeo Platform using your credentials, for instance because you changed your computer, you can revoke this authentication token. The Nuxeo Drive client will then require the credentials to be updated to connect to the Nuxeo Platform.

To revoke an authentication token:

  1. On the Nuxeo Platform, click on the Nuxeo Drive tab (see locations above).
  2. Click on the Revoke button of the token to be revoked. Several elements are displayed to help you identify the right token:

    • the device description: whether it is a Mac OS client, Windows client, Linux client;
    • the creation time: date and time at which the token was created, i.e. the date and time at which you provided it with your credentials.
  3. In the window that pops up, click on OK to confirm. The Nuxeo Drive client cannot communicate with the Nuxeo Platform and switches to offline. When you click on the Drive icon, it says "Update credentials (required)".

Customization

You can override classes to implement your own Nuxeo Drive following the developper guide.

3 months ago Manon Lumeau fix pictures on multiexcerpt
5 months ago Solen Guitter Remove userdoc drive page, move assets, update assets paths and drive userdoc urls, move drive faq page to nxdoc
5 months ago Anne Jubert add web ui on drive page
6 months ago Solen Guitter Fix conflict
6 months ago Solen Guitter Fix some links, fix paragraph that was repeated on all tabs
6 months ago Remi Cattiau Drive review
6 months ago Anne Jubert requirements update
6 months ago Anne Jubert add requirements for nuxeo drive
6 months ago Andrew Goodricke Add content-review-lts2016 to labels
7 months ago Kevin Leturc NXP-19481: Update MarkLogic page to detail how to configure range element indexes
8 months ago Solen Guitter 142 | se tab
a year ago Manon Lumeau 141
a year ago Solen Guitter 140
a year ago Solen Guitter 139
a year ago Rémi Cattiau 138
a year ago Solen Guitter 137 | Add default value column, Remove section about beta update site set up though nuxeo.conf
a year ago Solen Guitter 136 | Add configuration parameters section
a year ago Manon Lumeau 135
a year ago Manon Lumeau 134
a year ago Manon Lumeau 133
a year ago Manon Lumeau 132
a year ago Manon Lumeau 131 | Merge ADMINDOC with NXDOC
2 years ago Solen Guitter 130
2 years ago Solen Guitter 129
2 years ago Solen Guitter 128
2 years ago Solen Guitter 127
2 years ago Solen Guitter 126
2 years ago Solen Guitter 124
2 years ago Solen Guitter 125
2 years ago Antoine Taillefer 123
2 years ago Antoine Taillefer 121
2 years ago Antoine Taillefer 122
2 years ago Solen Guitter 120 | replacing links to Jenkins by latest release
2 years ago Solen Guitter 119 | fix broken links
3 years ago Antoine Taillefer 118
3 years ago Antoine Taillefer 117
3 years ago Antoine Taillefer 116
3 years ago Manon Lumeau 115
3 years ago Manon Lumeau 114
3 years ago Antoine Taillefer 113
3 years ago Antoine Taillefer 112
3 years ago Solen Guitter 111
3 years ago Solen Guitter 110
3 years ago Antoine Taillefer 109
3 years ago Antoine Taillefer 108
3 years ago Antoine Taillefer 107
3 years ago Antoine Taillefer 106
3 years ago Antoine Taillefer 105
3 years ago Antoine Taillefer 104
3 years ago Antoine Taillefer 103
3 years ago Antoine Taillefer 102
3 years ago Antoine Taillefer 101
4 years ago Antoine Taillefer 100
4 years ago Solen Guitter 99 | Fixed broken link
4 years ago Solen Guitter 98
4 years ago Solen Guitter 97 | Removed related topics from TOC
4 years ago Solen Guitter 96 | Moved other"
4 years ago Solen Guitter 94 | Fixed typo
4 years ago Solen Guitter 95 | JIRA Issue macro params updated with additional server info
4 years ago Antoine Taillefer 93
4 years ago Antoine Taillefer 92
4 years ago Antoine Taillefer 91
4 years ago Antoine Taillefer 90
4 years ago Antoine Taillefer 89
4 years ago Antoine Taillefer 87
4 years ago Antoine Taillefer 88
4 years ago Antoine Taillefer 86
4 years ago Antoine Taillefer 85
4 years ago Florent Guillaume 84
4 years ago Solen Guitter 83
4 years ago Solen Guitter 82 | Added TOC and fixed typos
4 years ago Antoine Taillefer 81
4 years ago Antoine Taillefer 80
4 years ago Antoine Taillefer 79
4 years ago Antoine Taillefer 78
4 years ago Antoine Taillefer 77
4 years ago Antoine Taillefer 76
4 years ago Antoine Taillefer 75
4 years ago Antoine Taillefer 74
4 years ago Antoine Taillefer 73
4 years ago Antoine Taillefer 72
4 years ago Antoine Taillefer 71
4 years ago Antoine Taillefer 70
4 years ago Antoine Taillefer 69
4 years ago Antoine Taillefer 68
4 years ago Antoine Taillefer 67
4 years ago Antoine Taillefer 66
4 years ago Antoine Taillefer 65
4 years ago Antoine Taillefer 64
4 years ago Antoine Taillefer 63
4 years ago Antoine Taillefer 62
4 years ago Antoine Taillefer 61
4 years ago Antoine Taillefer 60
4 years ago Antoine Taillefer 59
4 years ago Antoine Taillefer 58
4 years ago Antoine Taillefer 57
4 years ago Antoine Taillefer 56
4 years ago Antoine Taillefer 55
4 years ago Antoine Taillefer 54
4 years ago Antoine Taillefer 53
4 years ago Antoine Taillefer 52
4 years ago Antoine Taillefer 51
4 years ago Antoine Taillefer 50
4 years ago Antoine Taillefer 49
4 years ago Antoine Taillefer 48
4 years ago Antoine Taillefer 47
4 years ago Antoine Taillefer 46
4 years ago Antoine Taillefer 45
4 years ago Antoine Taillefer 44
4 years ago Antoine Taillefer 43
4 years ago Antoine Taillefer 42
4 years ago Antoine Taillefer 41
4 years ago Antoine Taillefer 40
4 years ago Antoine Taillefer 39
4 years ago Antoine Taillefer 38
4 years ago Antoine Taillefer 37
4 years ago Antoine Taillefer 36
4 years ago Antoine Taillefer 35
4 years ago Antoine Taillefer 34
4 years ago Antoine Taillefer 33
4 years ago Antoine Taillefer 32
4 years ago Antoine Taillefer 31
4 years ago Antoine Taillefer 30
4 years ago Antoine Taillefer 29
4 years ago Antoine Taillefer 28
4 years ago Antoine Taillefer 27
4 years ago Antoine Taillefer 26
4 years ago Antoine Taillefer 25
4 years ago Antoine Taillefer 24
4 years ago Antoine Taillefer 23
4 years ago Antoine Taillefer 22
4 years ago Antoine Taillefer 21
4 years ago Antoine Taillefer 20
4 years ago Antoine Taillefer 19
4 years ago Antoine Taillefer 18
4 years ago Antoine Taillefer 17
4 years ago Antoine Taillefer 16
4 years ago Antoine Taillefer 15
4 years ago Antoine Taillefer 14
4 years ago Antoine Taillefer 13
4 years ago Antoine Taillefer 12
4 years ago Antoine Taillefer 11
4 years ago Antoine Taillefer 10
4 years ago Antoine Taillefer 9
4 years ago Antoine Taillefer 8
4 years ago Antoine Taillefer 7
4 years ago Antoine Taillefer 6
4 years ago Antoine Taillefer 5
4 years ago Antoine Taillefer 4
4 years ago Antoine Taillefer 3
4 years ago Antoine Taillefer 2
4 years ago Antoine Taillefer 1
History: Created by Antoine Taillefer