Chapter 7. Functional Management of Nuxeo DM

Table of Contents

7.1. Managing spaces
7.1.1. Managing domains
7.1.2. Managing workspaces, templates and sections
7.1.3. Managing access rights
7.1.4. Managing a space's trash
7.1.5. Applying a pre-defined look to a space
7.2. Managing users
7.2.1. Managing users
7.2.2. Managing groups
7.3. Managing vocabularies
7.3.1. Consulting the vocabularies
7.3.2. Modifying a vocabulary
7.4. Managing themes

Administrators and users granted with management rights can create the application structure. They also supervise access to content and can modify the application layout.

7.1. Managing spaces

Space management (either domains, sections, templates or workspaces) includes the possibility to manage its content, the access rights to the space and its layout.

7.1.1. Managing domains

By default, only administrators can manage domains, but all users can access them, providing they have at least reading rights. Then, administrators can give users the rights to create or manage domains.

7.1.1.1. Accessing a domain

You need to have at least reading rights in the domain to access it. By default, application members have reading rights on the whole application.

To access a domain:

  1. Click on the icon located at the beginning of the breadcrumb trail until you arrive on the page Domains on the default server.

    Tip

    The icon only makes you go up one level. It doesn't lead the page Domains on the default server directly.

  2. Click on a domain's name to open it.

    The domain's root is displayed.

7.1.1.2. Creating a domain

By default, only administrators can create new domain. Then administrators can give writing or management rights to users, who will then be able to create a new domain.

To create a domain:

  1. Log in to the application.

  2. Click on the icon to access the Domains on the default server page.

  3. Click on the Create a new domain button.

  4. Fill in the domain creation form.

     Field Description
    TitleType the space's name.
    DescriptionType the text that explains the purpose of the space.
  5. Click on the Create button.

    The Content tab of the new domain is displayed. By default, all users have reading rights on the new domain.

7.1.1.3. Modifying a domain

Only users with management rights in the domain can modify it.

When you modify a domain, you modify its title, its description and its metadata.

Metadata are informations describing some properties of the documents, so that they are more accurately referenced and easier to find using Nuxeo DM search engine or virtual navigation. Some metadata are automatically filled in by the system, but most of them need to be filled in by users. When you create a domain, its metadata are empty. Default metadata are listed below.

To modify a domain:

  1. Click on the Edit tab of the domain.

  2. Edit the modification form's fields.

     FieldDescription 
    TitleModify the domain's name.
    DescriptionModify the text presenting the content or the purpose of the domain.
    Subjects

    Topic of the domain.

    RightsInformations about the reproduction rights of the domain. Rights informations often encompass Intellectual Property Rights and Copyright.
    SourceThe references of the resource from which the domain's content is derived (totally or partially).
    CoverageInformations about the scope of the content of the domain. It can either be a spatial location, a temporal period or a jurisdiction.
    Created atDate automatically filled in by the system when the domain is created.
    Last modified atDate automatically filled in by the system when the domain is modified.
    FormatFormat of the documents created in the domain, if any is preferred.
    LanguageLanguage used in the domain.
    Expire on

    Date at which the domain's content stops being valid. Click on the button to display a calendar and select a date.

    This date is not indexed by the system.
    AuthorUser who created the domain. This field is automatically filled in by the system.
    ContributorsUsers who modify the domain. This field is automatically filled in by the system.
  3. Click on the Save button

    The domain's Content tab is displayed with the modifications you just saved.

7.1.1.4. Deleting a domain

By default, only administrators can delete a new domain. Then administrators can give writing or management rights to users, who will then be able to delete domains.

When you delete a domain, it is moved into the application's Trash. Thus, deletion is not permanent right away and you can restore the domain if it shouldn't have been deleted.

The trash tab is displayed to users with management rights.

Domain deletion process is the same as document's and occurs in two steps:

  1. A user moves the domain to trash.

  2. Users with management rights delete it permanently.

7.1.2. Managing workspaces, templates and sections

Workspaces, templates and sections are managed alike. In this section, we describe the management of workspaces as an example, but the management of sections and templates is the same as for workspaces. When a type of space requires a specific functioning, the particular procedure is described beside the generic workspace behaviour.

7.1.2.1. Accessing a workspace

You must have at least reading rights in a workspace, template or section to access it. You can only see workspaces, templates and sections you can access.

To access the workspaces, templates and sections of a domain:

  1. Click on the corresponding root space (Workspaces, Templates or Sections).

    The list of workspaces, templates or section is displayed in the Content tab.

  2. Click on the name of the workspace, template or section you want to access.

7.1.2.2. Creating a workspace

Only users with writing or management rights can create a workspace.

Workspaces are created in Workspaces, sections in Sections and templates in Templates. You can also create sub-workspaces and sub-sections in a regular workspace or section.

Creating a workspace from workspaces root

To create a workspace or section at the root of Workspaces or Sections:

  1. In Workspaces or Sections, click on the Create a new workspace or Create a new section button.

  2. Fill in the creation form.

     Field Description
    TitleType the workspace's or section's name.
    DescriptionType the text that explains the purpose of the workspace or section.
    Template to base creation on

    Select the template you want to base the workspace creation on. The workspace created from a template will automatically get all the template's content.

    This fields is only displayed on workspace and templates creation form, if templates have been created.
  3. Click on the Create button.

    The workspace's or section's Content tab is displayed.

Creating a workspace into a regular workspace

To create a workspace or a section in a regular workspace or section:

  1. In the workspace or section, click on the New Document button.

  2. On the Available document types window, click on the Workspace or Section link.

  3. Fill in the creation form.

     Field Description
    TitleType the workspace's or section's name.
    DescriptionType the text that explains the purpose of the workspace or section.
    Template to base creation on

    Select the template you want to base the workspace creation on. The workspace created from a template will automatically get all the template's content.

    This fields is only displayed on workspace and templates creation form, if templates have been created.
  4. Click on the Create button.

    The Content tab of the new workspace or section is displayed.

Creating a template

Template creation is very close to workspace creation, with few minor differences. To create a template:

  1. In Templates, click on the New Document button.

  2. Click on the Workspace link to create a workspace template.

    You can only create workspaces at Templates root.
  3. Fill in the creation form.

     Field Description
    TitleType the template's name.
    DescriptionType the text that explains the purpose of the template.
    Template to base creation on

    Select the template you want to base the workspace creation on. The template created from a template will automatically get all the template's content.

  4. Click on the Create button.

    The template's Content tab is displayed.

7.1.2.3. Modifying a workspace

Users with writing and management rights can modify a workspace.

Modifying a workspace, a template or a section means modifying its properties, i.e. its title, description or any of its metadata.

Metadata are informations describing some properties of the workspace, so that they are more accurately referenced and easier to find using Nuxeo DM search engine or virtual navigation. Some metadata are automatically filled in by the system, but most of them need to be filled in by users. When you create a domain, its metadata are empty. Default metadata are listed below.

To modify a workspace:

  1. Click on the Edit tab of the workspace.

  2. Edit the modification form's fields.

    Field Description 
    TitleModify the workspace's name.
    DescriptionModify the text presenting the content or the purpose of the workspace.
    Subjects

    Topic of the workspace.

    RightsInformations about the reproduction rights of the workspace. Rights informations often encompass Intellectual Property Rights and Copyright.
    SourceThe references of the resource from which the workspace's content is derived (totally or partially).
    CoverageInformations about the scope of the content of the workspace. It can either be a spatial location, a period of time or a jurisdiction.
    Created atDate automatically filled in by the system when the workspace is created.
    Last modified atDate automatically filled in by the system when the workspace is modified.
    FormatFormat of the documents created in the workspace, if any is preferred.
    LanguageLanguage used in the workspace.
    Expire on

    Date on which the workspace's content stops being valid. Click on the button to display a calendar and 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.
    OwnerUser who created the workspace. This field is automatically filled in by the system.
    ContributorsUsers who modify the workspace. This field is automatically filled in by the system.
  3. Click on the Save button

    The workspace's Content tab is displayed with the modifications you just saved.

7.1.2.4. Deleting a workspace

Only users with writing or management rights in the parent workspace can delete a workspace.

When you delete a workspace, you also delete its content. This action moves the workspace into the parent's trash, from which users with management can revert deletion or delete it permanently.

To delete a workspace:

  1. In the Content tab of the parent workspace, check the box corresponding to the workspace to delete.

  2. Click on the Delete button.

  3. In the window that pops up, click on the OK button.

    The parent workspace's Content tab is displayed: the deleted workspace is not displayed anymore.

7.1.3. Managing access rights

Only users with management rights can manage the access rights of a space.

Managing access rights means granting or denying access rights in a space. The access rights management screen is available as a sub-tab in the Manage tab of the space.

The access rights management sub-tab is accessible composed of three parts:

  • the Inherited rights part displays rights that were granted or denied in a parent space;

  • the Local rights part displays the rights that were granted or denied in the current space;

  • the form to grant or deny access rights in the current space.

7.1.3.1. Granting access rights

To grant access rights:

  1. Click on the Manage tab of the space.

    The Access Rights sub-tab is displayed.

  2. In the form, type the username of the user you want to grant rights to.

    Tip

    To give access rights to a group, type the group's name.

    The names of the users or groups corresponding to the typed characters are automatically displayed as you type.

  3. Click on the user you want to give access rights to.

  4. Select the right to grant.

  5. Click on the Add permission button.

    The user and its rights are displayed in the Local Rights part of the screen.

  6. Save local rights modification by clicking on the Save local rights button.

    Local rights are saved and applied.

7.1.3.2. Denying access rights

If a user has inherited rights that you don't want him to have in the current space, you can deny him these rights. If you want to deny access rights to a large number of users, block rights inheritance and give access rights only to the users you want to be able to access the workspace or section.

To deny access rights:

  1. Click on the Manage tab of the space.

    The Access Rights sub-tab is displayed.

  2. In the form, type the username of the user you want to grant rights to.

    Tip

    To deny access rights to a group, type the group's name.

    The usernames corresponding to the typed characters are automatically displayed.

  3. Click on the user you want to deny rights to.

  4. Select the right to deny.

  5. Click on the Add permission button.

    The user is in the Local rights form. The denied rights is displayed in the Denied permissions column.

  6. Save local rights modification by clicking on the Save local rights button.

    Local rights are saved and applied.

7.1.3.3. Remove a user from local rights

If you want to refuse rights to a user, and that these rights have been granted in the current space, you can remove the user from the local rights.

To remove a user from the local rights:

  1. Click on the Manage tab of the space.

    The Access Rights sub-tab is displayed.

  2. In the Local Rights part of the screen, check the box corresponding to the user you want to remove.

  3. Click on the Remove permission(s) button.

    The user is removed from the Local Rights table.

7.1.3.4. Blocking rights inheritance

The rights that are granted or denied in a space are applied to the space's content, including its sub-spaces. You thus have the same rights in the sub-spaces as in the parent space. That is called rights inheritance.

You can block this inheritance. It enables you to block the access of a sub-workspace to the workspace's users, for instance, or to deeply modify the access rights in the sub-workspace.

To block rights inheritance :

  1. Click on the Manage tab of the space of whichyou want to the access rights.

    The Access Rights sub-tab is displayed.

  2. Check the box Block permissions inheritance located under the Inherited Rights table.

    The inherited rights table is not displayed anymore.

    You are added in the list of the local rights, like the administrators group.

    In the Access Rights tab of the possible sub-workspaces of the workspace whose rights are blocked, a group Everyone is denied all rights.

You can now grant access rights to users.

7.1.4. Managing a space's trash

When they are deleted by users with writing rights, documents are moved into the Trash tab of the parent folder (domain, workspace, folder, etc). They are not erased from the application. Users with management rights can still restore them or delete them permanently.

7.1.4.1. Restoring documents

Only users with management rights can restore documents.

When they are deleted by users with writing rights, documents are moved into the Trash tab of workspaces or folders. They are not erased from the application and can still be restored, i.e. moved back into the Content tab of the workspace.

To restore a document:

  1. Go on the Trash tab of the workspace.

  2. Check the box in front of the document's name.

  3. Click on the Restore button.

  4. On the window that pops up, click on the OK button.

    The document is moved back into the Content tab of the workspace. It takes the project life cycle state, even if its life cycle state before deletion was approved or obsolete.

7.1.4.2. Permanently deleting documents

Only users with management rights can manage the trash of a space and delete documents permanently.

To delete a document permanently, you need to delete it from the Trash tab:

  1. Go on the Trash tab of the workspace.

  2. Check the box in front of the document's name.

  3. Click on the Permanent delete button.

  4. On the window that pops up, click on the OK button.

    The document is permanently erased from the application. It cannot be restored.

    The relations from and to the deleted document are updated and are displayed as a URI relation: the deleted document is displayed as an external document, identified by its reference (URI).

7.1.5. Applying a pre-defined look to a space

Administrators can easily apply a pre-defined theme to a workspace, template or section. You can apply a theme to spaces only. For instance, you can change the theme of sections, so that they look different from workspaces, but you cannot change the look of a document.

The new space's theme is not applied to the sub-spaces, but it is applied to the documents it contains.

When you choose to apply a theme to a workspace, for instance, you can refine what is displayed on the page by applying a perspective on the theme. A perspective is a fragment visualisation mask that determines that some parts of the page, like the clipboard and worklist, are not displayed to the user if specified conditions are met. The default application has only one perspective.

To change the theme of a workspace:

  1. Click on Manage tab of the space.

  2. Click on the Theme sub-tab.

  3. Select the theme, page and perspective you want to apply.

  4. Click on the Save button.

    The page is displayed with the selected look.

7.2. Managing users

Only administrators can manage users and groups. They can create new users and groups, modify their properties or delete them. It is also possible to connect Nuxeo DM to an external directory (LDAP directory for instance). This procedure is explained in the Nuxeo EP Reference Guide.

Users can only consult users and groups directories.

7.2.1. Managing users

Users can be created and their properties modified directly in Nuxeo DM.

7.2.1.1. Creating users

Only administrators can create new users.

By default, Nuxeo DM has one user, called Administrator. This user is the administrator. You must use this user to create new users and give them administrator rights then.

To create a user:

  1. Click on the Users & groups link in the page header.

    The members management interface opens on the user directory search form.

  2. Click on the Create a new User button.

  3. Fill in the user creation form.

    Tip

    Mandatory fields are indicated by a red asterisk.

    Field Description 
    UsernameType the name that will identify the user on the Nuxeo DM application.
    First nameType the user's first name.
    Last nameType the user's last name.
    CompanyType the name of the company of the user.
    EmailType the email of the user. This address will be used for notifications.
    PasswordType the password of the user.
    Password (verify)Type the password again to confirm it.
    Groups for this user

    Type the name of a group. The matching group names are displayed as you type in autocompletion.

    The new user must at least be part a the "members" group or one of its sub-groups to be able to access the application's content.
  4. Click on the Save button.

    The card of the new user is displayed. You can modify its properties and its password.

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

7.2.1.2. Modifying users cards

Only administrators can modify other users' cards. But every user can modify his or her own card.

To modify a user's card:

  1. Click on the Users & groups link in the page header.

    The members management interface opens on the user directory search form.

  2. Search a user and click on the user's name to open his or her card.

    The user's card is displayed.

  3. Click on the Edit tab.

  4. Modify the fields in the modification form.

  5. Click on the Save button.

    The View tab is displayed with your modifications.

7.2.1.3. Modifying a user's password

Only administrators can modify other users' password. However every user can modify his or her own password.

To modify a user's password:

  1. Click on the Users & groups link in the page header.

    The members management interface opens on the user directory search form.

  2. Search a user and click on the user's name to open his or her card.

    The user's card is displayed.

  3. Click on the Change password tab.

  4. Type the new password and confirm it.

  5. Click on the Save button.

    The View tab is displayed. The user must use his or her new password the next time he or she logs in.

7.2.1.4. Deleting users

Only administrators can delete users.

Deleting a user is a permanent action.

To delete a user:

  1. Click on the Users & groups link in the page header.

    The members management interface opens on the user directory search form.

  2. Search a user and click on the user's name to open his or her card.

    The user's card is displayed.

  3. Click on the Delete button.

    A window pops up.

  4. Click on the OK button.

    The user is deleted. He or she cannot log in to the Nuxeo DM application.

7.2.2. Managing groups

Groups of users can be created and their properties modified directly in Nuxeo DM. Groups of users are used to manage access rights more easily.

There are two default groups in Nuxeo DM:

  • administrators: the members of this group are administrators of the application. They can manage users, vocabularies and documents.

  • members: the members of this group by default have reading rights on all the content of the application.

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 access rights you give to the group.

7.2.2.1. Creating groups

Only administrators can create groups of users.

To create a group of users:

  1. Click on the Users & groups link in the page header.

    The directory opens on the Users tab.

  2. Click on the Groups tab.

    A search form and the list of the existing groups is displayed.

  3. Click on the Create a new Group button.

  4. Fill in the creation form.

    Field Description 
    Name of the groupType the name of the group.
    Groups membersType the name of a user. The matching user names are displayed as you type in autocompletion.
    Sub-groupsType the name of a group. The matching group names are displayed as you type in autocompletion.
  5. Click on the Save button.

    The View tab of the group's card is displayed.

7.2.2.2. Modifying groups

Only administrators can modify groups.

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

  1. Click on the Users & groups link in the page header.

    The directory opens on the Users tab.

  2. Click on the Groups tab.

    A search form is displayed.

  3. Search a group and click on its name to open its card.

    The card displays the members and sub-groups of the group in the View tab.

  4. Click on the Edit tab.

    The modification form is displayed.

  5. Modify the group's members and click on the Save button.

    The View tab of the group is displayed with the modifications you just made.

    The new group members are immediately granted the group's access rights. The users who are no longer members of the group are denied group's access rights. However they still have their individual access rights.

7.2.2.3. Deleting groups

Only administrators can delete groups.

To delete a group:

  1. Click on the Users & groups link in the page header.

    The directory opens on the Users tab.

  2. Click on the Groups tab.

    A search form is displayed.

  3. Search the group to delete and click on its name to open its card.

    The card displays the members and sub-groups of the group in the View tab.

  4. Click on the Delete button.

    A window pops up.

  5. Click on the OK button.

    The group search form is displayed. The group is displayed and its members lose the group's access rights.

7.3. Managing vocabularies

Only administrators can consult and manage vocabularies.

Vocabularies are the lists of terms 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. First level is Topic. Second level is Subtopic and each entry is linked to a Topic entry.

Functional administrators can only modify or delete vocabularies. They cannot create a new vocabulary.

7.3.1. Consulting the vocabularies

You can consult the vocabularies from any page of the application.

7.3.1.1. Consulting a vocabulary

To consult a vocabulary:

  1. Click on the Vocabularies link, located in the top right corner of the page.

    The list of the application vocabularies is displayed.

  2. Click on the Modify button corresponding to the vocabulary you want to consult.

    The vocabulary entries are displayed.

7.3.1.2. Consulting a vocabulary entry

To consult a vocabulary entry:

  1. Consult a vocabulary.

  2. Click on the View button of the entry you want to consult.

    Default vocabulary entry labels are listed together with their translation in properties files in source code. Thus, by default, the label displayed on the form is the field ID in the properties file.

7.3.2. Modifying a vocabulary

When you modify a vocabulary, you can add new entries, edit or delete them.

7.3.2.1. Add a new vocabulary entry

To add an entry to a vocabulary:

  1. Consult the vocabulary to add an entry to.

  2. Click on the Add a new vocabulary entry link.

    The entry creation form is displayed under the link.

  3. Fill in the entry creation form.

    Field Description 
    IDType a unique identifier for the vocabulary entry. The ID is not displayed to users.
    ParentThis field is only displayed on hierarchical vocabularies second level. Type the ID of parent entry.
    LabelType the value of the entry that will be displayed to users on the application.
    ObsolescenceSelect Yes if the entry should not be displayed. Select No if the entry should be displayed.
    OrderType a number indicating the rank of the entry in the vocabulary.
  4. Click on the Add button.

    The new entry is displayed in the list of the vocabulary entries.

7.3.2.2. Modify a vocabulary entry

To modify a vocabulary entry:

  1. Consult the vocabulary to add an entry to.

  2. Click on the Modify button corresponding to the entry you want to modify.

    The entry modification form is displayed.

  3. Modify the form.

  4. Click on the Modify button.

    The list of the vocabulary entries is displayed.

7.3.2.3. Delete a vocabulary entry

Deleting a vocabulary entry is a permanent action. You cannot cancel the entry deletion.

To delete a vocabulary entry:

  1. Consult the vocabulary to delete an entry from.

  2. Click on the Delete button of the entry to erase.

    The entry is permanently erased. The list of the vocabulary entries is displayed.

7.4. Managing themes

The look and feel of the application can be modified. It is defined by the themes that are applied on the different pages of the application. A theme is a preset package that determines the graphical appearance of the site. There are several pages pre-defined. For instance, the default theme has four pages:

  • default page: the page used for content view;

  • pop-up page: the page used for pop-up windows, such as the relation search window;

  • user dashboard page: the page used to display the dashboard;

  • print page: the page used to print the page content.

Only administrators can deeply modify the look of the application by modifying the themes. However, users with management rights can easily apply a theme created by an administrator to a workspace or a section.

Theme management is explained in the Nuxeo EP Reference Guide.