Nuxeo Platform User Documentation

Administration

Updated: March 2, 2017 Page Information Edit on GitHub

This Administration menu presents three different submenus:

Analytics

This section of the Administration tab enables administrators to have information and statistics on how the application is used.

The default Activity subtabs are:

  • Document Distribution:

  • Repository Content: Provides statistics on the repository, the top downloads, the document created per week, etc. You can filter these statistics on a specific time period.

  • Search: Provides statistics on the queries done by users and how search filters are used.

  • Workflow: Provides statistics on tasks, like the average duration of a workflow, the actions per users, etc.

Users & Groups

Only administrators and power users can create, edit and delete users and groups. They can create new users and groups, modify their properties or delete them. It is also possible to connect the Platform to an external directory (LDAP directory for instance). Users can only consult users and groups directories.

Managing Users

By default, the Nuxeo Platform has one user, called Administrator, who is the administrator. You must use it to create new users and delegate them permissions.

Users must be at least in "administrators" or "members" group, or one of their sub-groups to be able to browse the application's content.

Users's Parameters

The whole set of information about users consists of the items below:

Field Description
Username The name the user will use to log in.
First name First name of the user
Last name Last name of the user
Company Company or organization of the user
Email email of the user This address is used for alerts.
Password User's password
Password (Verify) User's password
Groups for this user Groups of which the user is a member. User must be at least in 'administrators' or 'members' group, or one of their sub-groups.

Inviting a New User

Inviting a new user means creating a user account without setting its password, and having the user validate the invitation.

  • To invite a user, go to Administration menu > Users & Groups. Click on the New button and fill in the user creation form and leave Set user password to unactive.
    An invitation email is sent to the user at the email address you filled in. The user account is pending the user validation and the user account is not available in the user search results.
  • To validate the invitation, click on the validation link in the invitation email. Define your password and click on the Submit button. You are redirected to the login page of the Nuxeo Platform: you can now log in and use the Platform.

Creating a New User Account

When you create a new user account immediately, you choose and set the user's password.

To create a user, go to the Administration menu > Users & groups. Click on the New button and fill in the user creation form and active the Set user password.

If you need to create several users check the box Create another next to the Create button at the end of the creation form. The user is saved and the user creation form is displayed so you can immediately create another user.

The user can immediately connect to the Nuxeo application using his or her username and password.

Editing a User's Properties

Only administrators and power users can modify other users' properties. But every user can modify his own properties from their profile card in the Users & Groups menu.

You cannot edit the username, as it is the ID of the user on the application.

When you are using an external directory for users management, the Edit button is not displayed as you cannot edit the users' properties (managed directly from the directory).

To modify a user's properties, go to the Administration menu > Users & Groups. Search a user and click on the user's name to open his or her card. Edit it by modifying the fields in the modification form.

Changing a User's Password

Only administrators and power users can modify other users' password. However every user can modify his or her own password from his/her profile card.

When you use an external directory for users management, the Change password button is not displayed as you cannot edit your password.

To modify a user's password, go to the Administration menu > Users & Groups and click on the Change Password button.

Deleting a User

Only administrators and power users can delete users.

Deleting a user is a permanent action.

To delete a user, go to go to the Administration menu > Users & Groups. Search a user and click on the user's name to open his or her card. Click on Delete at the top-right hand corner and confirm.

Managing Groups

Groups of users can be created and their properties modified directly in the Nuxeo Platform.

To make permissions management easier, you can create groups of users. Instead of giving (or denying) permissions to single users and repeat the same operations several times, you can give several users the same permission in one single manipulation by using a group.

Default groups are:

  • members: Users in this group are the end-users users of the application.
  • power users: Users in this group are the functional administrators of the application. They have a restricted access to the Admin tab, the administration user interface of the Nuxeo Platform, from which they can manage users and groups and edit the vocabularies.
  • administrators: Users in this group are the technical administrators of the application. They have access to all the Admin tab features and are in charge of managing the application. Beside the functional administration features, they can edit the application configuration, install packages on the application, consult the application's statistics, restart the server, etc.

Default groups

Users must be in one of the groups "members" or "administrators" to be able to access content. Power users must be in both the "power users" and "members" groups.

Groups can be composed of users and of sub-groups. Sub-group's members automatically become members of the parent group. Thus, they are granted all the permissions you give to the group. You can create as many groups as needed.

Field Description
Group name The ID of the group. The ID cannot be modified.
Group label The name of the group displayed to users.
Group's members Users that belong to the group.

Creating a Group

Only administrators and power users can create groups of users.

To create a group of users, go to Administration menu > Users & Groups > click on the New button and select Group from the drop down list. Fill in the creation form and save.

If you need to create several groups, check the box Create another next to the Create button. Your group is saved and the group creation form is displayed so you can immediately create another group.

Editing a Group

Only administrators and power users can modify groups.

Modifying groups most often consists in adding or removing members of the group. The name of the group cannot be changed.

To edit a group, go to the Administration menu > Users & Groups. Search a group and click on its name to open its card. Click on the Edit tab, modify the group's members and click on the Save button. The users who are no longer members of the group are denied group's permissions. However they still have their individual permissions.

Deleting a Group

Only administrators and power users can delete groups.

To delete a group, go to Administration menu > Users & Groups. Search the group to delete and click on its name to open its card. Click on Delete and confirm.

Vocabularies

Only administrators and power users can consult and manage vocabularies.

Vocabularies are the lists of labels used in the application, for instance in drop down lists. A vocabulary is composed of several entries, that are the options in the drop down lists. Some vocabularies are hierarchical, i.e. they have several levels. For instance, the Subjects metadata uses a two level vocabulary called I10nsubjects. First level is Topic. Second level is Subtopic and each entry is linked to a Topic entry.

Administrators and power users can only modify or delete vocabularies. They cannot create a new vocabulary from the user interface.

Consulting Vocabularies

All vocabularies editable from the user interface are listed in the vocabularies management interface.

To consult a vocabulary or its entries click on the Administration menu > Vocabularies submenu and select the vocabulary you want to consult in the drop down list.

By default, the labels of default vocabularies entries are the IDs of labels in .properties files of source code.

Vocabulary Entries Parameters

Field Description
ID Unique identifier for the vocabulary entry. The ID is not displayed to users.
Parent This field is only displayed on hierarchical vocabularies second level. It indicates to which first level entry the current value is linked.
Label Value of the entry that will be displayed to users on the application.
Obsolescence Indicates if the entry should be displayed in the available values on edition.
Order Indicates the rank of the entry in the vocabulary. Order is set at 10,000,000 by default.

Adding a Vocabulary Entry

To add an entry to a vocabulary,click on the Add Entry button of the vocabulary, fill in the entry creation form and click on the Save button.

The new entry is displayed in the list of the vocabulary entries. It is immediately available in the corresponding drop down list in the user interface.

Editing a Vocabulary Entry

Editing a vocabulary entry can be changing its label, making it obsolete or changing its order. When you make an entry obsolete, it means that it will not be displayed in the available choices when you edit a document.

Deleting a Vocabulary Entry

Deleting a vocabulary entry is a permanent action.

To delete vocabulary entry, click on the Delete button of the entry to erase and confirm.The entry is permanently erased. The list of the vocabulary entries is displayed.

22 days ago Solen Guitter Improve content reuse on user management
22 days ago Solen Guitter Improve content reuse for vocabularies
24 days ago Manon Lumeau Added screenshots on Web UI User doc
24 days ago Manon Lumeau add pages about personal space and administration
24 days ago Manon Lumeau last pages about web ui
History: Created by Manon Lumeau