Nuxeo 5
User Guide

Dernière modification Project Code Document ID Copyright

02/06/2007 NXP NXP_UserGuide_EN Copyright © 2007 Nuxeo. All Rights Reserved.


Versioning
Version 1.0 1.1 1.2 Date 02/06/07 02/08/07 03/12/07 Participant(s) · Solen Guitter · Solen Guitter · Solen Guitter Comments Creation For publication Modifications and corrections


Nuxeo 5 I User Guide

Table of Contents
1 Introduction...................................................................................................................................................................................................5 2 First steps with Nuxeo 5............................................................................................................................................................................6 2.1 Connecting to Nuxeo 5.....................................................................................................................................................................6 2.1.1 Logging in.................................................................................................................................................................................6 2.1.2 Logging out..............................................................................................................................................................................6 2.2 Moving around.....................................................................................................................................................................................7 2.2.1 Navigation tree.......................................................................................................................................................................7 2.2.2 Breadcrumb trail.....................................................................................................................................................................7 2.2.3 Tabs.............................................................................................................................................................................................. 7 3 Domains, workspaces and sections......................................................................................................................................................8 3.1 The spaces..............................................................................................................................................................................................8 3.1.1 Domains.....................................................................................................................................................................................8 3.1.2 Workspaces............................................................................................................................................................................... 9 3.1.3 Sections...................................................................................................................................................................................... 9 3.2 Managing spaces.................................................................................................................................................................................9 3.2.1 Creating a space.....................................................................................................................................................................9 3.2.2 Modifying a space...............................................................................................................................................................10 3.2.3 Editing the metadata of a space....................................................................................................................................11 3.2.4 Deleting a space...................................................................................................................................................................12 4 Access rights................................................................................................................................................................................................14 4.1 The different access rights.............................................................................................................................................................14 4.1.1 Reading rights.......................................................................................................................................................................14 4.1.2 Writing rights......................................................................................................................................................................... 4 1 4.1.3 Administration rights.........................................................................................................................................................14 4.2 Managing access rights................................................................................................................................................................... 5 1 4.2.1 Granting access rights........................................................................................................................................................ 5 1 4.2.2 Denying access rights........................................................................................................................................................16 4.2.3 Remove a user from the local rights.............................................................................................................................16 5 Managing documents.............................................................................................................................................................................. 8 1 5.1 Creating a document.......................................................................................................................................................................18 5.1.1 Creating a note.....................................................................................................................................................................19 5.1.2 Creating a file......................................................................................................................................................................... 0 2 5.1.3 Creating a folder...................................................................................................................................................................22 5.2 Reading a document........................................................................................................................................................................23 5.3 Modifying a document...................................................................................................................................................................23 5.4 Editing the metadata of a document........................................................................................................................................25 5.5 Copying a document.......................................................................................................................................................................26 5.6 Managing your clipboard and your worklist..........................................................................................................................28 5.6.1 Managing clipboard...........................................................................................................................................................28 5.6.2 Managing the worklist.......................................................................................................................................................28 5.7 Consulting the document's history...........................................................................................................................................29 5.8 Deleting a document.......................................................................................................................................................................29 6 Manage relations.......................................................................................................................................................................................31 6.1 Creating a relation............................................................................................................................................................................. 1 3 6.2 Consulting the relations of a document..................................................................................................................................32 6.3 Deleting a relation............................................................................................................................................................................33 7 Managing reviews.....................................................................................................................................................................................34 7.1 Consulting your dashboard........................................................................................................................................................... 4 3 7.2 Managing a serial review................................................................................................................................................................35 7.2.1 Starting a serial review....................................................................................................................................................... 5 3 7.2.2 Managing the reviewers of a serial review................................................................................................................36 7.2.3 Approving a document.....................................................................................................................................................37 7.2.4 Rejecting a document........................................................................................................................................................38 7.2.5 Ending a serial review........................................................................................................................................................38 Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 3/51


Nuxeo 5 I User Guide 7.3 Managing a parallel review...........................................................................................................................................................38 7.3.1 Starting a parallel review..................................................................................................................................................39 7.3.2 Managing the reviewers of a parallel review............................................................................................................40 7.3.3 Approving a document.....................................................................................................................................................41 7.3.4 Rejecting a document........................................................................................................................................................42 7.3.5 Ending a parallel review....................................................................................................................................................42 7.4 Managing an approbation review..............................................................................................................................................42 7.4.1 Starting an approbation review.....................................................................................................................................42 7.4.2 Managing the reviewers of an approbation review...............................................................................................44 7.4.3 Approving a document.....................................................................................................................................................44 7.4.4 Rejecting a document........................................................................................................................................................45 7.4.5 Ending an approbation review.......................................................................................................................................45 7.5 Abandoning a review....................................................................................................................................................................... 5 4 8 Nuxeo 5 tools............................................................................................................................................................................................... 7 4 8.1 Search engine.....................................................................................................................................................................................47 8.2 Directories............................................................................................................................................................................................47 8.2.1 Find a user............................................................................................................................................................................... 8 4 8.2.2 Find a group........................................................................................................................................................................... 9 4 9 Commercial contact.................................................................................................................................................................................50 10 License.........................................................................................................................................................................................................51

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 4/51


Nuxeo 5 I User Guide

1 Introduction
Nuxeo 5 is Nuxeo's new Java-based open source ECM solution, based on the Nuxeo EP ECM platform. It provides a similar set of ECM functions as CPS (the previous, Zope-based, ECM platform developed by Nuxeo), such as the content creation, the status history and versioning. But Nuxeo 5 also integrates new features, such as:
·

the domains, a new level above workspaces and sections, that makes it possible to make your site organization more accurate; relations between the documents; life cycle and associated workflows.

· ·

Documents are created in workspaces, in which users can make them evolve through collaborative work. When they are ready for distribution, the documents are published in sections. Both workspaces and sections are grouped in domains, that you create to meet your own criteria. Permission to access the documents and the actions available are determined by access rights. Some users can modify the documents and submit them to review, when other users can only read the workspace's content. Through modifications, the documents evolve. Content management workflows, called reviews, are used to validate the evolution of documents. All the modifications and reviews make the document constitute the document's life cycle. Users can see the workflows they participate to in their dashboard. All actions are transparent to the users, who sees the copied documents in his or her clipboard, as well as the documents he or she reserves in his worklist. This guide presents how to use the default functionalities of Nuxeo 5 and helps you get comfortable with the application.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 5/51


Nuxeo 5 I User Guide

2 First steps with Nuxeo 5
Nuxeo 5 is an ECM platform that enables you to create and distribute documents. Access to the application is secured with a password and navigation is done using tabs.

2.1 Connecting to Nuxeo 5
Only authenticated users can access Nuxeo 5. That is to say that they must have a user name and a password.

2.1.1 Logging in
To access the site and its content, you need to log in to the site. Logging in is done using a user name and its associated password. When you type the Nuxeo 5 site's address in your browser, you automatically get on the authentication page. 1. Type your user name and password in the corresponding fields.

2. Click on the "Log in" button.
·

Logging in succeeds. The page "Domains on the default server" is displayed.

·

Logging in fails. An error message is displayed. Try again to log in. If logging in fails again, contact your site administrator.

2.1.2 Logging out
When you are finished on the site, you need to log out before closing your browser. To log out, click the "Log out" link in the upper right corner of the page. You are immediately logged out and need to log in to work in Nuxeo 5 again.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 6/51


Nuxeo 5 I User Guide

2.2 Moving around
To navigate from a workspace to another, you can use:
· ·

the navigation tree, the breadcrumb trail.

In a document, use the tabs to access the available actions.

2.2.1 Navigation tree
The navigation tree displays the different workspaces and sections of a domain (see chapter 3 Domains, workspaces and sections, p.8). It is displayed on the left column of the page. Using the navigation tree, you can go from a workspace to another, for instance, without going back to the domain root. The navigation tree displays workspaces and sections of a same domain, as well as folders. Conversely, documents are not displayed there.

2.2.2 Breadcrumb trail
The breadcrumb trail is the list of links located above the document's name. It indicates the document's location from the site root. You can use it to move back on the site.

2.2.3 Tabs
Spaces and documents have several tabs. The tabs give access to the available actions on a domain, a workspace or a document. Only the tabs corresponding to your access rights are displayed (see chapter 4 Access rights, p.14).

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 7/51


Nuxeo 5 I User Guide

3 Domains, workspaces and sections
Nuxeo 5 is organized in domains, that contain workspaces and sections. The documents are created and distributed in these workspaces and sections.

3.1 The spaces
There are three types of spaces: domains, workspaces and section.

3.1.1 Domains
A domain is a thematic space created by the site administrator at the site root. Domains contain workspaces and sections. They enable you to make your site organization more accurate and precise. When you log in to the site, you are directed to a page where the list of the available domains is displayed.

Only the site administrator can create new domains. Once he or she has created a domain, he or she can grant users access rights (see chapter 4 Access rights, p.14). When the site administrator creates a domain, two root spaces are automatically created inside it:
· ·

Workspace, Section .

You must create your workspaces and sections in these root spaces (see section 3.2.1 Creating a space, p.9).

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 8/51


Nuxeo 5 I User Guide

3.1.2 Workspaces
Workspaces are dedicated to content creation and modification. A workspace's content is meant to be shared and modified through the participation of the workspace's members. Once the documents are ready for distribution, they must be published in a section. You must create workspaces in the root space called Workspace. You can add as many sub-workspaces as you wish and organize them the way you want.

3.1.3 Sections
Sections are the areas where you place the documents created in a workspace when they are ready for distribution to the public or a wider audience. Documents published in a section can only be read. You cannot create or edit documents in sections. You must create sections in the root space called Section. You can add as many sub-sections as you wish and organize them the way you want.

3.2 Managing spaces
Domains, workspaces and sections are managed the same way.

3.2.1 Creating a space
Users with writing or administration rights on the domain Workspaces are created in the root Workspace of a domain, sections in the root Section. You can also create sub-workspaces and sub-sections in a regular workspace or section. Domains can only be created by the site administrator. To create a workspace or section: 1. In Workspace or Section, click on the "Create a new workspace" or "Create a new section" button.

2. Fill in the creation form.
Field Description

Title Description

Type the space's name. Type the text that explains the purpose of the space.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 9/51


Nuxeo 5 I User Guide

Field

Description

Content

Click on the "Browse" button to select a file to be used as the space's logo instead of the site's logo. The logo size should be 194*99 pixels.

3. Click on the "Create" button. The space's "Content" tab is displayed.

3.2.2 Modifying a space
Users with writing or administration rights on the domain Modifying a domain, a workspace or a section means modifying its properties. To modify a space: 1. Click on the "Modify" tab of the space. 2. Edit the modification form's fields.
Field Description

Title Description Content

Modify the space's name. Modify the text presenting the content or the purpose of the space. This fields is only displayed for workspaces and section. Click on the "Browse" button to select a file to be used as the new space's logo. The logo size should be 194*99 pixels.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 10/51


Nuxeo 5 I User Guide

3. Click on the "Save" button. The space's "Content" tab is displayed with the modifications you just saved.

3.2.3 Editing the metadata of a space
Users with writing or administration rights on the domain Metadata are informations describing certain properties of the space, so that it is more accurately referenced. Some metadata are automatically filled in by the system, but most of them need to be filled in by the users. When you create a domain, a workspace or a section, its metadata are empty. To edit the metadata of a space: 1. Click on the "Metadata" tab of the space. 2. Edit the metadata modification form.
Field Description

Subjects Rights

Topic of the domain or space. Hold down CTRL key and click to select several subjects. Informations about the reproduction rights of the space. Rights information often encompasses Intellectual Property Rights and Copyright. The references of the resource from which the space's content is derived (totally or partially). Informations about the scope of the content of the space. It can either be a spatial location, a temporal period or a jurisdiction. Date automatically filled in by the system when the space is created. Date automatically filled in by the system when the space is modified. Format of the documents created in the space, if any is preferred.

Source Coverage

Created at Last modified at Format

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 11/51


Nuxeo 5 I User Guide

Field

Description

Language Expire on

Language used in the domain or space. Date on which the space's content should be unpublished. Click on the button date. to display a calendar and select a

Owner Contributors

User who created the space. This field is automatically filled in by the system. Users who modify the space. This field is automatically filled in by the system.

3. Click on the "Save" button. The domain's or space's "Content" tab is displayed.

3.2.4 Deleting a space
Users with writing or administration rights on the domain When you delete a workspace or a section, you also delete its content. This action is permanent: you cannot undelete a workspace or a section. Only the site administrator can delete a domain. To delete a workspace or a section: 1. In the "Content" tab of the parent workspace or section, check the box corresponding to the workspace or section to delete. Buttons appear under the content list. 2. Click on the "Delete" button.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 12/51


Nuxeo 5 I User Guide

3. In the window that pops up, click on the "OK" button. The parent workspace's or section's "Content" tab is displayed.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 13/51


Nuxeo 5 I User Guide

4 Access rights
Access rights are permissions granted to users in the different spaces of the application. These access rights determine the actions available to the users. Access rights can be defined for a whole domain, but also just for a workspace or a section. The rights granted or denied in a space are applied to all its content, including the subspaces. This is called the rights inheritance. Rights inheritance spares you the declaration of access rights in every single space of the application.

4.1 The different access rights
There are three different types of access rights:
· · ·

reading rights, writing rights, administration rights.

4.1.1 Reading rights
A user who is granted reading rights can read the documents created in the space. He can also read the content's meta-data and history.

4.1.2 Writing rights
Writing rights enable users to consult, create and modify content in the space. For instance, a user with writing rights create relations on a document, or start a review.

4.1.3 Administration rights
Users with administration rights can consult, create and modify content, but they also manage the access rights of the space.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 14/51


Nuxeo 5 I User Guide

4.2 Managing access rights
Users with administration rights You can give or refuse access rights to all the users of the application.

4.2.1 Granting access rights
To grant access rights: 1. Click on the "Access rights" tab. 2. In the "Local Rights" part of the screen, select the user or the group of users you want to give access rights to and the rights you want to give him or her.

3. Click on the "Add permission" button. The "Content" tab is displayed. If you click on the "Access Rights" tab, the user and its rights are displayed in the "Local Rights" part of the screen.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 15/51


Nuxeo 5 I User Guide

4.2.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. To deny access rights: 1. Click on the "Access rights" tab of the current space. 2. In the "Local Rights" part of the screen, select the user or the group of users you want to deny access rights and the rights you want to deny him or her.

3. Click on the "Add permission" button. The "Content" tab is displayed. If you click on the "Access Rights" tab, the user and its denied rights are displayed in the "Local Rights" part of the screen.

4.2.3 Remove a user from the 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 "Access rights" tab of the current space.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 16/51


Nuxeo 5 I User Guide

2. In the "Local Rights" part of the screen, check the box corresponding to the user you want to remove. Buttons appear under the list.

3. Click on the "Remove permission(s)" button. The "Content" tab is displayed.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 17/51


Nuxeo 5 I User Guide

5 Managing documents
Nuxeo 5 is an ECM platform. That is to say that you can create, modify and share documents on the platform. The documents available on Nuxeo 5 are:
· · ·

note: a text typed in a RTF editor integrated to Nuxeo 5; file: an attached file; folder: a repertory that contains several documents.

The evolution of a document as the contributors modify its constitute it life cycle. This life cycle is composed of the following states:
· · · ·

project: the document has been created and it can be modified; review: the document is submitted to a review; valid: all the reviewers have approved the review; obsolete: the document is not accurate anymore and, for instance, has been replaced by a new version.

To change the life cycle state of a document, you need to submit it to a review (see chapter 7 Managing reviews, p.34).

5.1 Creating a document
Users with writing or administration rights on the workspace There are two ways to create a document:
·

by using the buttons displayed in the "Content" tab of the workspace,

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 18/51


Nuxeo 5 I User Guide ·

by dragging a file from your computer and dropping it into the workspace, using the Drag&Drop function. The document is then automatically created in the workspace and its title is the name of the original file.

To create documents using drag & drop, you need to install the extension corresponding to your browser. Extensions are available on the authentication page.

5.1.1 Creating a note
The note is a document that consists in a text displayed in the "Summary" tab of the document. The note is usually created using the integrated RTF editor, displayed in the note creation form. This editor allows layout modifications on the text. To create a note: 1. In the "Content" tab of the workspace, click on the "New document" button. 2. On the page "Available document types", click on "Note".

3. Fill in the creation form.
Field Description

Title Description

Type the note's name. Type a text that explains what the note is about.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 19/51


Nuxeo 5 I User Guide

Field

Description

Content

Type the text of the note in the editor displayed.

4. Click on the "Create" button. The "Summary" tab of the note is displayed.

You can also create a note from a .txt file, by dragging and dropping it into the "Content" tab of the workspace.

5.1.2 Creating a file
A file document is composed of an attached file that you upload on the application. You can upload files of any format. You can create a file document:
· ·

by using the "New document" button, by using the "New file" button.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 20/51


Nuxeo 5 I User Guide

To create a file using the "New document" button: 1. In the "Content" tab of the workspace, click on the "New document" button. 2. On the page "Available document types", click on "File".

3. Fill in the creation form.
Field Description

Title Description Content

Type the document's name. Type a text that explains what the document is about. Click on the "Browse" button to select the file to be uploaded.

4. Click on the "Create" button. The "Summary" tab of the document is displayed.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 21/51


Nuxeo 5 I User Guide

To create a file using the "New file" button: 1. In the "Content" tab of the workspace, click on the "New file" button. 2. Click on the "Browse" button to select the file to be uploaded. 3. Click on the "Create" button. The "Summary" tab of the document is displayed. It automatically takes the name of the uploaded file as its title. The "Description" field of the document is not filled in. you need to modify the document to fill in this field (see section 5.3 Modifying a document, p.23).

You can also drag and drop a file into the "Content" tab of the workspace. The file is automatically uploaded on the application.

5.1.3 Creating a folder
A folder is a repertory in which you can group several documents, either by creating them directly in the folder or by pasting them in it. Unlike workspace, you can only create documents in folder. You cannot create sub-folders. To create a folder: 1. In the "Content" tab of the workspace, click on the "New document" button. 2. On the page "Available document types", click on "Folder". 3. Fill in the creation form.
Field Description

Title

Type the name of the folder.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 22/51


Nuxeo 5 I User Guide

Field

Description

Description

Type a text explaining the purpose of the folder.

4. Click on the "Create" button. The "Content" tab of the folder is displayed.

5.2 Reading a document
Users with reading, writing or administration rights on the workspace or section You can access documents directly in the workspace or section or from your dashboard. To read a document, click on its title. The document's "Summary" tab is displayed.

5.3 Modifying a document
Users with writing or administration rights on the workspace Document modification means modifying or changing the attached file of a file document, modifying the text of a note, or simply editing the description or the title of the document. Every time you modify a document, you have to determine how the version number is updated. Indeed, each document has a version number, which is a piece of information about the evolution of the document. A version number (VV.vv) is composed of a major ver-

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 23/51


Nuxeo 5 I User Guide

sion number (VV) and a minor version number (vv). When a document is created, its version number is 01.00. To modify a document: 1. Click on the "Modify" tab of the document. 2. In the modification form displayed, type your modifications. The fields of the modification form are the same as in the creation form (see section 5.1 Creating a document, p.18). 3. On the same form, indicate if you want to update the document's version.

4. Click on the "Save" button. The document's "Summary" tab is displayed.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 24/51


Nuxeo 5 I User Guide

5.4 Editing the metadata of a document
Users with writing or administration rights on the workspace Metadata are informations describing certain properties of the document, so that it is more accurately referenced. Some metadata are automatically filled in by the system, but most of them need to filled in by the users. When you create a document, its metadata are empty. Modifying the document's metadata does not update the version number. To edit the metadata of a document: 1. Click on the "Metadata" tab of the document. 2. Edit the metadata modification form.
Field Description

Subjects Rights

Topic of the document. Hold down CTRL key and click to select several subjects. Informations about the reproduction rights of the document. Rights information often encompasses Intellectual Property Rights and Copyright. The references of the resource from which the document content is derived (totally or partially). Informations about the scope of the content of the document. It can either be a spatial location, a temporal period or a jurisdiction. Date automatically filled in by the system when the document is created. Date automatically filled in by the system when the document is modified. Format of the file attached. Language used in the document. Date at which the document should be unpublished. If you select a date, unpublication will be automatic. Click on the button date. to display a calendar and select a

Source Coverage

Created at Last modified at Format Language Expire on

Owner Contributors

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

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 25/51


Nuxeo 5 I User Guide

3. Click on the "Save" button. The document's "Summary" tab is displayed.

5.5 Copying a document
Users with writing or administration rights on the workspace When you copy a document, it is placed in the clipboard. For more details about the clipboard, see section 5.6 Managing your clipboard and your worklist, p.28. The pasted document has the same life cycle state as the original document. However, it has its own version number and history. You can copy a document from a domain and paste in another one. To copy a document: 1. In the "Content" tab of the workspace, check the box in front of the document's name. Buttons appear under the documents list.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 26/51


Nuxeo 5 I User Guide

2. Click on the "Copy" button. The document's name appears in the clipboard on the left column of the page and a "Paste" button appears in the "Content" tab.

3. Go into the workspace where you want to paste the document. You can only paste a document in a workspace in which you have writing or administration rights. 4. There are two ways to paste the document:
·

Click on the "Paste" button located in the destination workspace. The document is displayed in the content list of the workspace.

·

Click on the clipboard's "Paste in current folder" link. The document is displayed in the content list of the workspace.

The document is not removed from the clipboard (see section 5.6.1 Managing clipboard, p.28 to remove a document from the clipboard).

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 27/51


Nuxeo 5 I User Guide

5.6 Managing your clipboard and your worklist
The current user The clipboard and the worklist are two functionalities that enable you to see documents that you have selected and reserved to pasted them in another workspace. The clipboard is just meant to store copied documents to be pasted in another workspace. If you copy a first document and then copy a new document before you have pasted the first one, the second copied document replaces the first one in the clipboard. The clipboard can store several documents if they are copied at the same time. The worklist enables you to reserve several documents from different workspaces, on which you plan to work later.

5.6.1 Managing clipboard
To add content to clipboard, you need to copy a document (see section 5.5 Copying a document, p.26). When the copied document has been pasted, you can remove it from the clipboard. To remove a document from the clipboard, click on the "Remove all" link in the clipboard.

5.6.2 Managing the worklist
The worklist enables you to select and reserve several documents. You can then:
· ·

paste the documents in a workspace or a folder, export the documents on your computer in a single ZIP folder.

5.6.2.1 Add documents to worklist
To add a document to your worklist: 1. Check the box in front of the document's name. Buttons appear under the documents list. You can select several documents to add several documents at the same time.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 28/51


Nuxeo 5 I User Guide

2. Click on the "Add content to worklist" button. The document's name appears in the worklist on the left column of the page.

5.6.2.2 Paste documents from the worklist
To paste the worklist content, click on the "Paste in current folder" link in the worklist. The documents are pasted in the current workspace.

5.6.2.3 Export the worklist
You can export your worklist as a ZIP folder to work on the documents from your computer. To export your worklist, click on the "Zip export" link in the worklist.

5.7 Consulting the document's history
Users with reading, writing or administration rights All the actions that are done on the document are registered in the document's history, with several informations, such as the date and time, the user, the comment, etc. To consult the document's history, click on the "History" tab.

5.8 Deleting a document
Users with writing or administration rights on the workspace Deleting a document is a permanent action. You cannot undelete it afterwards. To delete a document: 1. In the "Content" tab of the workspace, check the box in front of the document's name. Buttons appear under the documents list. 2. Click on the "Delete" button.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 29/51


Nuxeo 5 I User Guide

3. On the window that pops up, click on the "OK" button. The document is deleted and does not appear in the workspace's content list.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 30/51


Nuxeo 5 I User Guide

6 Manage relations
Users with reading, writing or administration rights on the workspace Relations are informations that connect the application's documents with other documents on the application or with 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).

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

6.1 Creating a relation
You can create a relation from a document to:
· · ·

another document on the application, an external document, a text.

To create a relation: 1. Click on the "Relations" tab of the document. 2. Fill in the creation form.
Field Description

Predicate Object

Select the type of relation. Text: type the text to which the document is related. Resource Uri (Uniform Resource Identifier): type the reference or address of the resource. Document: click on the "Search" button to find the document of the application you want to create a relation to.

Comment

Type a comment to add details on the relation.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 31/51


Nuxeo 5 I User Guide

3. Click on the "Add" button. The relation is displayed as an outgoing relation, under the relation creation form.

6.2 Consulting the relations of a document
When you consult the relations of a document, relations are sorted into 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 whose object is the current document. To consult the relations of a document, click on the "Relations" tab of the document. The outgoing and incoming relations are displayed under the relation creation form.

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

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 32/51


Nuxeo 5 I User Guide

6.3 Deleting a relation
All the users You can delete outgoing relations only . To delete a relation: 1. Click on the "Relations" tab of the document. 2. In the "Operation" column of the outgoing relations table, click on the "Delete" link corresponding to the relation. The relation is deleted and does not appear in the table anymore.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 33/51


Nuxeo 5 I User Guide

7 Managing reviews
All the documents evolve according to a determined life cycle. This life cycle is composed of the following states: project, review, valid and obsolete. To change the document's life cycle state, you have to submit it to a review. A review is a workflow, that is to say a process to validate a document. It determines a chain of users who review and approve or reject the document. When a document is submitted to a review, the users that participate to the review have an indication of what they need to do on the document. This is the directive. To end the review, all the reviewers must approve the document. Then, the document gets into its destination life cycle state. There are three types of review:
· · ·

approbation review, serial review, parallel review.

To see the reviews they participate to, the users use a dashboard that shows them all the documents they have to review and the directives associated to them.

7.1 Consulting your dashboard
The current user You dashboard displays the documents you have to review. It also displays the list of the documents that you have created and the list of the last modified documents of the domain. You can access your dashboard from any page of the application. To consult your dashboard, click on the "Dashboard" link in the upper right corner of the page.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 34/51


Nuxeo 5 I User Guide

In your dashboard, click on a document's name to open and read it.

7.2 Managing a serial review
A serial review is an ordered review that does not make the life cycle state change. The reviewers must approve or reject the document one after the other.

7.2.1 Starting a serial review
Users with writing or administration rights on the workspace When you start a review, you define several parameters such as the modification possibilities. To start a serial review: 1. Click on the "Review" tab of the document. 2. Fill in the form "Start a review".
Field Description

Review type Versioning management

Select "Serial review". Select how the document's version should be managed in case of document modification:
· ·

no increment: the version number won't change, automatic increment: the system increases the version number or not, depending on the modifications. Case dependent: when you modify the document, you specify if the version number needs to be updated or not.

·

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 35/51


Nuxeo 5 I User Guide

3. Click on the "Start" button. The review is started. You are automatically declared as the first reviewer. You must declare the other reviewers (see section 7.2.2 Managing the reviewers of a serial review, p.36).

7.2.2 Managing the reviewers of a serial review
The review creator and the current reviewer

7.2.2.1 Adding reviewers
Reviewers can add new reviewers as long as they are the current reviewer. They can only add reviewers at the end of the reviewers list. To add a reviewer: 1. Click on the "Review" tab of the document. The review is displayed, with a form to add reviewers. 2. Fill in the form "Select a reviewer".
Field Description

Username Directive

Select a user in the drop down list. Select a directive in the list.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 36/51


Nuxeo 5 I User Guide

Field

Description

Due Date Comment

Click on the button to choose the date at which the reviewer must have approved or rejected the document. Type a comment explaining to the reviewer what he or she has to do on the document.

3. Click on the "Add" button. The new reviewer appears at the end the workflow table. The document is now displayed in his or her dashboard.

7.2.2.2 Deleting reviewers
You cannot delete reviewers on a serial review. If, afterwards, you do not want a user to be a reviewer, you must abandon the review (see section 7.5 Abandoning a review, p.45) and start a new one.

7.2.3 Approving a document
The current reviewer When you consult your dashboard, you see the documents you have to review. You see the documents as soon as you are declared as a reviewer, even if you are not the current reviewer of the document. To approve a document: 1. Click on the "Review" tab of the document. 2. In the "Workflow" section of the page, type a comment in the "Comment" field.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 37/51


Nuxeo 5 I User Guide

3. Click on the "Approve" link in the workflow table. If you are not the current reviewer, there is no link displayed. A green icon indicates that you have approved the document and the next reviewer becomes the current reviewer.

7.2.4 Rejecting a document
The current reviewer To reject a document: 1. Click on the "Review tab" of the document. 2. In the "Workflow" section of the page, type a comment in the "Comment" field. 3. Click on the "Reject" link in the workflow table. A red icon is displayed in front of your name to indicate that you have rejected the document. The previous reviewer becomes the current reviewer. He or she needs to modify the document and approve it again so that you can review it again and approve it.

7.2.5 Ending a serial review
The serial review is automatically ended when all the reviewers have approved the document.

7.3 Managing a parallel review
A parallel review is an unordered review that does not make the life cycle state change. The reviewers can approve or reject the document as soon as they like.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 38/51


Nuxeo 5 I User Guide

7.3.1 Starting a parallel review
Users with writing or administration rights on the workspace When you start a review, you define several parameters such the modification possibilities. To start a parallel review: 1. Click on the "Review" tab of the document. 2. Fill in the form "Start a review".
Field Description

Review type Versioning management

Select "Parallel review". Select how the document's version should be managed in case of document modification:
· ·

no increment: the version number won't change, automatic increment: the system increases the version number or not, depending on the modifications. Case dependent: when you modify the document, you specify if the version number needs to be updated or not.

·

3. Click on the "Start" button. The review is started. There are no reviewers on the review. You must declare the users who will participate (see section 7.3.2 Managing the reviewers of a parallel review, p.40). You are not automatically declared as a reviewer of the document. If you want to participate to the review, you need to add yourself as a reviewer.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 39/51


Nuxeo 5 I User Guide

7.3.2 Managing the reviewers of a parallel review
When you start a parallel review, there is no reviewer on the review.

7.3.2.1 Adding reviewers
The review creator and the reviewers Reviewers can add new reviewers as soon as the review is started. To add a reviewer: 1. Click on the "Review" tab of the document. The review is displayed, with a form to add reviewers. 2. Fill in the form "Select a reviewer".
Field Description

Username Directive Due Date Comment

Select a user in the drop down list. Select a directive in the list. Click on the button to choose the date at which the reviewer must have approved or rejected the document. Type a comment explaining to the reviewer what he or she has to do on the document.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 40/51


Nuxeo 5 I User Guide

3. Click on the "Add" button. The new reviewer appears in the workflow table.

7.3.2.2 Deleting reviewers
The review creator You can delete reviewers at any time during the review. To delete a reviewer: 1. Click on the "Review tab" of the document. 2. In the "Workflow" section of the page, type a comment in the "Comment" field. 3. Click on the "Delete" link corresponding the reviewer you want to delete in the workflow table. The reviewer is deleted. He or she cannot participate to the review anymore.

7.3.3 Approving a document
Any reviewer To approve a document under review: 1. Click on the "Review tab" of the document. 2. In the "Workflow" section of the page, type a comment in the "Comment" field. 3. Click on the "Approve" link in the workflow table. A green icon is displayed in front of your name to indicate that you have approved the document.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 41/51


Nuxeo 5 I User Guide

7.3.4 Rejecting a document
Any reviewer To reject a document: 1. Click on the "Review tab" of the document. 2. In the "Workflow" section of the page, type a comment in the "Comment" field. 3. Click on the "Reject" link in the workflow table. A red icon is displayed in front of your name to indicate that you have rejected the document. You must then modify the document or have it modified until you are satisfied with it and approve it.

7.3.5 Ending a parallel review
The parallel review is automatically ended when all the reviewers have approved the document.

7.4 Managing an approbation review
An approbation review is an ordered review that makes the life cycle state change. The reviewers must approve or reject the document one after the other.

7.4.1 Starting an approbation review
Users with writing or administration rights on the workspace When you start an approbation review, you define several parameters such as the outgoing life cycle state or the modification possibilities. To start an approbation review: 1. Click on the "Review" tab of the document. 2. Fill in the form "Start a review".
Field Description

Review type Destination life cycle state after review

Select "Approbation review". Select the output life cycle state of the document. The available life cycle state are displayed according to the current life cycle state.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 42/51


Nuxeo 5 I User Guide

Field

Description

Versioning management

Select how the document's version should be managed in case of document modification:
· ·

no increment: the version number won't change, automatic increment: the system increases the version number or not, depending on the modifications. Case dependent: when you modify the document, you specify if the version number needs to be updated or not.

·

3. Click on the "Start" button. The review is started. You must declare the users that will participate (see section 7.4.2 Managing the reviewers of an approbation review, p.44).

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 43/51


Nuxeo 5 I User Guide

7.4.2 Managing the reviewers of an approbation review
The review creator and the current reviewer

7.4.2.1 Adding reviewers
Reviewers can add new reviewers as long as they are the current reviewer. To add a reviewer: 1. Click on the "Review" tab of the document. The review is displayed, with a form to add reviewers. 2. Fill in the form "Select a reviewer".
Field Description

Username Directive Due Date Comment

Select a user in the drop down list. Select a directive in the list. Click on the button to choose the date at which the reviewer must have approved or rejected the document. Type a comment explaining to the reviewer what he or she has to do on the document.

3. Click on the "Add" button. The new reviewer appears at the end of the workflow table.

7.4.2.2 Deleting reviewers
You cannot delete reviewers on an approbation review. If, afterwards, you do not want a user to be reviewer, you must abandon the review (see section 7.5 Abandoning a review, p.45) and start a new one.

7.4.3 Approving a document
The current reviewer When you consult your dashboard, you see the documents you have to review. You see the documents as soon as you are declared as a reviewer, even if you are not the current reviewer of the document. To approve a document:

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 44/51


Nuxeo 5 I User Guide

1. Click on the "Review tab" of the document. 2. In the "Workflow" section of the page, type a comment in the "Comment" field. 3. Click on the "Approve" link in the workflow table. The next reviewer becomes the current reviewer.

7.4.4 Rejecting a document
The current reviewer To reject a document: 1. Click on the "Review tab" of the document. 2. In the "Workflow" section of the page, type a comment in the "Comment" field. 3. Click on the "Reject" link in the workflow table. A red icon is displayed in front of your name to indicate that you have rejected the document. The previous reviewer becomes the current reviewer. He or she needs to modify the document and approve it again so that you can review it again and approve it.

7.4.5 Ending an approbation review
The approbation review is automatically ended when all the reviewers have approved the document. The document automatically gets the life cycle state that the review initiator defined when he started the review.

7.5 Abandoning a review
The review creator Abandoning a review means canceling it. When you abandon a review, the life cycle state of the document does not change.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 45/51


Nuxeo 5 I User Guide

The abandon process is the same for the three different reviews. To abandon a review: 1. Click on the "Review" tab of the document. 2. In the "My tasks" section of the page, type a comment in the "Comment" field.

3. Click on the "Abandon workflow" button. The review is canceled. The life cycle state of the document does not change.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 46/51


Nuxeo 5 I User Guide

8 Nuxeo 5 tools
Beside the document creation and management functionalities, Nuxeo 5 integrates a search engine and directories.

8.1 Search engine
Nuxeo 5 has its own search engine, designed to recognize all the specific parameters the application provides. Simple search can be accessed from any site page. At any time, you can search a document by typing your keywords in the search box located at the upper right corner of the page and clicking the "Search" button.

The results of the search are displayed in a table. Just click on the document's name to open it.

8.2 Directories
Nuxeo 5 automatically creates directories in which all users are registered. Any user can search the different directories to find the contact informations of a site member. There are two directories:
· ·

the member directory contains all site members, the group directory contains the existing groups and their members.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 47/51


Nuxeo 5 I User Guide

8.2.1 Find a user
To find a user and consult his or her directory card, click on "Members management" in the upper right corner of the page. The user directory is displayed. All the users of the application are displayed.

If you do not find the user in the list, type his or user name, first name or last name in the search box and click the "Search" button. The results are displayed in a table.

To consult a user's card, click on his or her user name.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 48/51


Nuxeo 5 I User Guide

8.2.2 Find a group
To make rights management easier, the site administration can create groups of users. Thus, you can give right access to a whole group instead of each group member individually. You can consult the card of group, to see which users are members of the group. To consult the card of a group, click on "Members management" in the upper right corner of the page. The user directory is displayed. You can then:
·

click on the "Group" tab to see the list of the groups.

Click on a group name to see its members.
·

Type the group name in the search box displayed in the "User" tab and click on the "Search" button. The results are displayed in a table. Click on the group name to see its members.

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 49/51


Nuxeo 5 I User Guide

9 Commercial contact
Nuxeo 5 is developed and published by Nuxeo SAS, a company with offices in France, UK, Romania and Senegal. Through our commercial offer, Nuxeo Connect, we deliver enterprise-grade functional & technical support, certified software patches and updates, and management tools that assist you during every stage of the application life-cycle - from design and development, throughout testing and deployment, to operations and monitoring. Nuxeo Connect helps reduce business and technical risks, increase productivity, speed time to deployment and improve your success rate for all Nuxeo-based projects. We're also happy to work with partners, IT Integrators or ISVs, to deliver the best possible applications to customers. Contact information: Nuxeo SAS 18-20, rue Soleillet 75020 Paris - France Tel: +33 1 40 33 79 87 Fax: +33 1 43 58 14 15 Mail: contact@nuxeo.com Web: http://www.nuxeo.com/

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 50/51


Nuxeo 5 I User Guide

10 License
This document is Copyright (c) Nuxeo SAS. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2; with Invariant Section "Commercial Support", no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is available at the URL: http://www.gnu.org/copyleft/fdl.html

Nuxeo 5 User Guide I All Rights Reserved. See license section for more information I Page 51/51