Home > Nuxeo Platform User Documentation > Working in Workspaces > Working with Documents > Relations
Nuxeo Platform User Documentation

Relations

Updated: October 16, 2020

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.

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.

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).

Adding a Relation

You need to have writing or management rights to add 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.

To create a relation:

  1. Click on the Relations tab of the document.
  2. Click on the Add a new relation link. The relation creation form is displayed under the link.
  3. Fill in the relation creation form.
  4. Click on the Add button. 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.
    Relations are also displayed in the Summary tab of the document.

Deleting a Relation

You need to have writing or management rights to delete the relations of a document.

You can delete outgoing relations only.

To delete a relation:

  1. Click on the Relations tab of the document.
  2. 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.
Related Documentation