Nuxeo Platform User Documentation

Editing Content

Updated: April 26, 2017 Page Information Edit on GitHub

Editing a document means modifying its content (i.e. the attached file of a file document, the text of a note, etc.), or simply editing the title, description or any metadata of the document. You can edit documents individually using an edit form or apply modifications to several documents using the bulk edit form.

Content and Metadata Edit Form

To edit a document, you can:

  • Click on the Edit tab of the document
  • Right click on the document and click on Modify

Both ways show you the document's Edit tab that displays a form to edit the content of the document and its metadata.

In the Edit tab type your modifications and indicate if you want to update the document's version. Type a comment if you want to indicate why you modified the document (this comment is logged in the document's history and helps other users know what has been changed on the document). Once it's done, click on Save.

Edit Form Customization

The Edit form can be customized to show your business metadata, using the Edit layout. You can define your Edit tab to show organized groups of metadata and make some fields editable depending on a user property or document property.

Metadata Overview

Metadata are information describing some properties of the workspace, so that they are more accurately referenced. Some metadata are automatically filled in by the system, but most of them need to be filled in by users. When you create a document (file, note, workspace, section, or any other document type), its metadata are empty.

The Nuxeo Platform uses Dublin Core metadata by default. They are listed below:

FieldDescription

Nature

Nature of the document. Values come from the nature vocabulary.

Subjects

Topic(s) of the document. Values come from the I10nsubjects vocabularies.

Rights

Information about the reproduction rights of the document. Rights informations often encompass Intellectual Property Rights and Copyright.

Source

The references of the resource from which the document's content is derived (totally or partially).

Coverage

Information about the geographic reach of the document. Values come from the I10ncoverage vocabulary.

Created at

Date automatically filled in by the system when the document is created.

Last modified at

Date automatically filled in by the system when the document is modified.

Format

Format of the document, if any is preferred.

Language

Language used in the document.

Expire on

Date on which the document stops being valid. Click on the calendar icon to select a date. This date is not indexed in the system. It is just in indication for users but it is not processed by the application.

Author

User who created the document. This field is automatically filled in by the system.

Contributors

Users who modified the document. This field is automatically filled in by the system.

Last contributor

Last user who modified the document. This field is automatically filled in by the system.

Although metadata are not mandatory, filling them in will make your documents easier to find using Nuxeo search engine.

Virtual navigation

Coverage and subjects are used for virtual navigation, available as an addon.

To fill in or change the metadata of the document, just edit the document.

Safe Edit

The Nuxeo Platform includes a safe edit mechanism that prevents you from inadvertently leaving an edit form without saving. This mechanism consists in displaying a popup for you to confirm you really want to quit without saving when you edit a document and try to quit the edit form or close the browser's window without clicking on the Save button.

In browsers that allow it, a draft is automatically saved for recovery.

Bulk Editing

It is possible to edit several documents at the same time. When you bulk edit documents, you can edit a set of their metadata. You can bulk edit documents from:

  • A folder Content tab
  • Search results, whatever the search you are using
  • A virtual navigation list of documents

To edit several documents at the same time, select the documents to edit using the checkboxes on the documents list and click on Edit at the bottom of the page. Fill in the relevant metadata and leave other values empty by default. Note that if you edit metadata for which the document(s) already had a value, the previous value will be replaced by the one you select on the bulk edit form. Once it's done, click on Save.

It is possible to change the default bulk edit versioning policy. See the page Bulk Edit in the developer documentation.

You can also use, Nuxeo Spreadsheet to edit several documents at the same time in your repository as if you were in a spreadsheet-like grid, like copy and paste by dragging the cell's value.

Document selected in other pages remain selected

When you navigate from page to page, your selection is not lost and you can bulk-edit documents that are not on the same page.

There is a drawback: You must make sure to bulk-edit only the correct documents (i.e. there are no checked documents in other pages that, in fact, you don't want to edit.).

Versioning Overview

Document versions enable you and other users to easily revert to a specific version of the document if needed, without having to edit the document. The Nuxeo Platform offers both automatic and manual versioning of documents.

Every document holds a version number, which is a piece of information about the evolution of the document. A version number (V.v) is composed of a major version number (V) and a minor version number (v). When a document is created, its version number can be 0.0, 0.1 or 1.0 depending on automatic versioning rules. Minor version increment are typically used for secondary changes. Major version increment is usually reserved to significant modifications. When a document is edited without a new version being created, the version number is suffixed with a + (0.1+ for instance), to indicate that the version was modified since it was created.

Version number 0.0
Version number 0.0 is considered as a draft of the document, which will need to be saved into a first version, either minor or major. Draft version 0.0 is not archived.

Automatic Versioning

Two automatic versioning behaviors are applied by default: one for files (and associated document types) and one for notes.

  • Files and other document types with schema file:file, like pictures, are created in version 0.0. A new minor version is automatically created when you edit a document that was last modified by another user. This minor version holds the modifications of the previous contributor, so that no data is lost. Your changes are applied on top of this version, the version number becoming for instance 0.1+. When you edit a document that was last edited by yourself, no version is automatically saved. You can however decide to manually create a new version of the document.

  • For notes, a new version is created for every modification, whether you are the last contributor of the note or not. The created version holds the your changes. When they are created, notes have a version number of 0.1.

This automatic versioning applies in case of:

  • Modification of the main file or its attachments using drag and drop
  • Manual edit of the attachments
  • Modification of the document (main file, properties, attachments) via bulk edit

The following actions don’t trigger the automatic versioning of the document:

  • Tagging the document
  • Adding the document to a collection
  • Changing the relations of the document
  • Commenting the document

Version number 0.0
Automatic versioning is disabled on CMIS connector due to conflict between our specifications and CMIS specifications.

Manual Versioning

You can decide to manually create a new version of the document.

In case of a file document types the automatic version is done first and then the manual version. So if you edit the document and select the option “Increment major version”, a minor version is created and then a major version: the minor version is the automatic one holding the previous contributor’s work, and the major one is the manual version with your modifications. If you select “Increment minor version”, two minor versions are created following the same principle. And if you chose “Skip version increment”, only the automatic versioning behavior is applied and the document version number is 0.1+ for instance.

For notes, if you use the Edit form, only the manual versioning rules applied. Selecting “Increment major version” save your changes in a major version, “Increment minor version” saves them in a minor version and choosing “Skip version increment” doesn’t create a new version and the version number is +ed (0.1+ for instance).

To create a new version of your document:

  1. Click on the Edit tab of the document.
  2. At the bottom of the form, in the Update version, select your versioning option and click Save.
    Versions are accessible from the History tab of the document.

The automatic versioning after the modification of the document won't work in a JSF application.

Nuxeo Drive Versioning Policy

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.

Relations

Relations are information that connect the application's documents with other documents or external resources. Documents are thus part of a coherent and organized structure.

Available relations are:

  • reference relation (references, is referenced by),
  • basis relation (is based on, is base for),
  • replacement relation (replaces, is replaced by),
  • requirement relation (requires, is required by),
  • compliance relation (conforms to, has conform).

A summary of the document's relations is displayed in the Summary tab.

You can also see all the document's relations in the Relations tab of the document. In Relations tab, relations are sorted by outgoing and incoming relations. Outgoing relations are relations that were created from the current document. Incoming relations are relations which were created from another document and to the current document.

The objects of the relation are hyperlinks: Click on the object's name to consult it.

Managing Relations

You need to have editing or management permissions to add or delete relations on a document.

You can create a relation from a document to:

  • Another document on the application
  • An external document (using URI)
  • A text

You can create relations between documents from different workspaces or domains.

When you add a relation on a document, it creates what we call an "outgoing" relation. The document to which you added the relation automatically has an "incoming" relation. You can delete outgoing relations only.

To create a relation:

In the Relations tab of the document, click on Add a new relation link, fill in the relation creation form and click on Add.

The relation is displayed as an outgoing relation, under the relation creation form. An incoming relation is automatically created in the target document's Relations tab, that directs to the source document of the relation and Relations are also displayed in the Summary tab of the document.

To delete a relation:

In the Relations tab of the document, click on the Delete link corresponding to the relation. The relation is deleted and does not appear in the table anymore. It is also removed from the incoming relations of the target document.

If you want to go further, you can follow this How to Add New Relation Types.

Copying and Moving Documents

Copying and moving documents requires to have at least Read permission on the original document and Edit permission in the target workspace. Copy and move are possible in workspaces and workspaces templates. To copy a document in a section you need to publish it in the new section. To move it from a section to another, you need to unpublish it from the first section and publish it in the second one.

Copying and Moving are done using the clipboard and worklist, which are located in the left part of the screen, below the navigation tree.

Clipboard and Worklist

What is the difference between the clipboard and the worklist?

Both are used to select documents and apply actions on these documents. Possible actions are:

It is possible to add your own actions in the clipboad or the worklist.

There are two differences between the clipboard and the worklist:

  • The clipboard is a one-shot selection: when you select one or several documents and add them to the clipboard, it replaces the previous selection. On the contrary, putting documents to the worklist adds them to the existing selection.
  • The worklist content is kept when you log out: your selection is still available when you log back in, until you remove documents from the worklist. The clipboard selection is lost when you log out.

Copying Documents

There are two ways to copy documents:

  • If you need to copy one document or more from the same workspace, use the clipboard.
  • If you need to copy several documents from different workspaces, use the worklist.

From the Same Workspace

In the workspace Content tab, check the box(es) corresponding to the document(s) you want to copy and click on Copy button below the table. The selected documents are added to the clipboard, which is displayed instead of the worklist. You can now go to the workspace where you want to copy the document(s) and click on the Paste button in the Content tab or the Paste in current folder link in the clipboard.

From Different Workspaces

To do that, you need to add documents to your worklist instead of copying them. Go in a workspace, check the box(es) corresponding to the document(s) you want to copy and click on the Add to worklist button below the table. Repeat these steps as many times as you need. Once you have added all the documents you need to your worklist, go in the workspace where you want to paste the documents and click on the Paste button in the Content tab or the Paste in current folder link in the worklist.

Moving Documents

From the Same Workspace

To move one or several documents from a single workspace at the same time, you can use either the clipboard or the worklist. Check the box(es) corresponding to the document(s) you want to move and click on the Copy button below the table. Go to the workspace where you want to move the document(s) and click on the Move in current folder link in the clipboard.

You can also move documents one by one by dragging their icon from the Content tab to the target workspace in the navigation tree.

From Several Workspaces

To move several documents from different workspaces at the same time, check the box(es) corresponding to the document(s) you want to move and click on the Add to worklist button below the table. Repeat these steps as many times as you need. Go to the workspace where you want to move the document(s) and click on the Move in current folder link in the worklist.

4 months ago manonlumeau NXDOC-1137: add new versioning system documentation
4 months ago manonlumeau Update versioning docs with 9.1 new behaviors
5 months ago GitHub Fix multiexcerpt
6 months ago Solen Guitter Use excerpts to avoid duplicated content
6 months ago Manon Lumeau Added screenshots on Web UI User doc
6 months ago Manon Lumeau Web UI user doc update
6 months ago Manon Lumeau Update User doc with Web UI
2 years ago Manon Lumeau 70 | Fix links to 7.10
2 years ago Manon Lumeau 71 | everted from v. 6
2 years ago Solen Guitter 69
2 years ago Solen Guitter 68
2 years ago Solen Guitter 67
2 years ago Solen Guitter 66
2 years ago Solen Guitter 65
2 years ago Solen Guitter 64
2 years ago Manon Lumeau 63
2 years ago Solen Guitter 62 | Fix broken screenshot
2 years ago Manon Lumeau 61
2 years ago Solen Guitter 58 | Add relations screenshots
2 years ago Solen Guitter 59
2 years ago Solen Guitter 60
2 years ago Manon Lumeau 57
2 years ago Solen Guitter 56
2 years ago Manon Lumeau 55
2 years ago Manon Lumeau 54
2 years ago Solen Guitter 53 | Add a section about Edit form customization, reorganize sections order
2 years ago Manon Lumeau 52 | Reverted from v. 50
2 years ago Manon Lumeau 51
2 years ago Manon Lumeau 50
2 years ago Solen Guitter 49
2 years ago Solen Guitter 48
3 years ago Solen Guitter 47 | link to virtual nav addon
3 years ago Manon Lumeau 46
3 years ago Manon Lumeau 45
3 years ago Manon Lumeau 44
3 years ago Solen Guitter 43 | Link update
3 years ago Solen Guitter 42
3 years ago Solen Guitter 41
3 years ago Solen Guitter 40
4 years ago Solen Guitter 39
4 years ago Solen Guitter 38 | Added note about draft version 0.0
4 years ago Solen Guitter 37 | Removed related topics from TOC
4 years ago Solen Guitter 36 | Added link to bulk edit dev doc and dev related doc
4 years ago Solen Guitter 35 | Reorganization
4 years ago Thibaud Arguillere 34
4 years ago Solen Guitter 33 | Updated bulk edit screenshot for 5.8
4 years ago Solen Guitter 32 | Added details on safe edit
4 years ago Solen Guitter 31
4 years ago Solen Guitter 30
4 years ago Solen Guitter 29
4 years ago Solen Guitter 28
4 years ago Solen Guitter 27 | Added new 5.7.1 bulk edit feature
4 years ago Solen Guitter 26 | Added safe edit feature
5 years ago Solen Guitter 24
5 years ago Solen Guitter 25 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 20 | Fixed broken link
5 years ago Solen Guitter 21 | Migrated to Confluence 4.0
5 years ago Solen Guitter 22 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 23 | Migration of unmigrated content due to installation of a new plugin
6 years ago Solen Guitter 19
6 years ago Solen Guitter 18 | Fixed broken link
6 years ago Solen Guitter 17 | Updated screenshot
6 years ago Solen Guitter 16
6 years ago Solen Guitter 15 | Corrected wrong label
6 years ago Solen Guitter 14
6 years ago Solen Guitter 13 | Added last contributor metadata
6 years ago Solen Guitter 12 | Added link to virtual navitation
6 years ago Solen Guitter 11 | Added toc and related pages
6 years ago Solen Guitter 10
6 years ago Solen Guitter 9 | fixed brocken link
6 years ago Solen Guitter 8
6 years ago Solen Guitter 7
6 years ago Benoit Delbosc 6
7 years ago Solen Guitter 5
7 years ago Solen Guitter 4 | update new default version number
7 years ago Solen Guitter 3 | added new "nature" metadata
7 years ago Solen Guitter 2 | fixed broken links
7 years ago Solen Guitter 1
History: Created by Solen Guitter