Data Lists and Directories

Directory and UI

Updated: August 27, 2021

Inside Nuxeo Platform, Directories are used to provide a common abstraction on a set of record

  • that can be stored in different manner
    • SQL, LDAP, Repository, External Service
  • that can be of different nature
    • user, group, simple key/value, complex records

Layouts and Directory

Entries returned by a Directory are technically Documents: documents that have only one schema, but still Document.

This means that you can use Widgets and Layouts system to manage directories entries.

<nxl:layout name="#{currentVoc.layout}" mode="edit" value="#{directoryUIActions.selectedDirectoryEntry}" />

Directory Management UI

The default Nuxeo UI includes management screens for the directories.

For simplicity reasons, the entry inside the Admin Center is called "Vocabularies", but actually it can manage any kind of Directories (i.e. not only the directories using the vocabulary schema).

To make this easily usable, the platform includes a DirectoryUIManager that uses an directories extension point to allow to contribute what directories should be available in the management UI and what layouts should be used.

Suggest Widgets

Directories can be used as a source of data for Suggest Widgets.

See Suggestion Widget Types page for more details.

We'd love to hear your thoughts!

All fields required