Nuxeo EP 5
Evaluation Guide
Last modi cation Project Code Document ID Copyright
11/13/2006 NUXE O NUXE O_EvalGui de Copyright © 2006 Nuxeo. All Rights Reserved.
Versioning
Version 0.0 1.0 1.1 1.2 Date 13/11/06 15/11/06 16/11/06 17/11/06 Participant(s) · Solen Gui tter · Solen Gui tter · Solen Gui tter · Stéfane Fermigier · Solen Gui tter 1.3 1.4 1.5 1.6 20/11/06 23/11/06 06/02/07 31/10/07 · Solen Gui tter · Solen Gui tter · Solen Gui tter · Solen Gui tter Integration of NXThe mes Corrections Update for 5.0 release Update for 5.1.2 release Comment s Creation Update Corrections and update Update and corrections
Table of Contents
1 Introduct ion.................................................................................................................................................................................................. ... .4 2 Nuxeo EP 5......................................................................................................................................................................................................... 5 2.1 Installi ng Nuxeo EP 5....................................................................................................................................................................... ... ... 5 2.2 Launching a Nuxeo EP 5 site......................................................................................................................................................... ... ... 5 3 Content creation................................................................................................................................................................................. ... ... ... ... 7 3.1 Creating a domain............................................................................................................................................................................. ... .. 7 3.2 Creating a workspace........................................................................................................................................................................ ... .8 3.3 Creating a document ............................................................................................................................................................ ... ... ... ... ... .9 4 Content manageme nt.................................................................................................................................................................... ... ... ... ... 12 4.1 Modifying a document ....................................................................................................................................................................... 12 4.2 Creating relations bet ween document s......................................................................................................................... ... ... ... ... .14 5 Content validation........................................................................................................................................................................ ... ... ... ... ... 16 5.1 Submi tting a document to an appr obat ion review............................................................................................................. ... .16 5.2 Appr oving a document ................................................................................................................................................................... ... 20 6 Content publ ishing................................................................................................................................................................................... ... 22 6.1 Submi tting a document to publ icati on............................................................................................................................ ... ... ... ..22 6.2 Appr oving a publ icati on submi ssion....................................................................................................................................... ... ..23 7 Rights manageme nt............................................................................................................................................................................ ... ... ..26 8 Theme management ................................................................................................................................................................................... 28 9 Concl usion........................................................................................................................................................................................... ... ... ... .. 30
Nuxeo EP 5 I Evaluation Guide
1 Introduction
Nuxeo EP 5 is Nuxeo's brand new, Java-based ECM solution. It obviously 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 EP 5 also inte grates new features, such as:
· · ·
the domains, a new level above workspaces and sections, that makes it possible to make your site organization always more accurate and t your needs; relations between the documents; life cycle and associated work ows.
The purpose of this Evaluation Guide is to present the global functioni ng of Nuxeo EP 5 and to enable you to evaluate Nuxeo EP 5. To this end, this guide describes the following processes:
· · · ·
content creation (workspace, document), content management, content validation, rights management.
Guide I All Rights Reserved. I Page 4/30
Nuxeo EP 5 I Evaluation Guide
2 Nuxeo EP 5
Nuxeo EP 5 is available at http://www.nuxeo. org/secti ons/downl oads/ . Nuxeo EP 5 requires a Java 5 Java Runtime Environment (JRE) or Software Development Kit (SDK), available from http://java.sun.com/.
2.1 Installing Nuxeo EP 5
Thanks to its installer, Nuxeo EP 5 is very easy to install on your computer. Just execute the nuxeo-ep-5.1.2. GA-installer-1. jar le and follow the instructions displayed.
When the installation is complete, you can launch Nuxeo EP 5 (see next section).
2.2 Launching a Nuxeo EP 5 site
1. Go to your installation directory, for instance C:\Program Files\nuxeo-5.1.2. GA. 2. In the "bin" directory, start the application using the appropriate "run" le:
· ·
run.sh under Unix, Linux and MacOS, run.bat under Windows.
Guide I All Rights Reserved. I Page 5/30
Nuxeo EP 5 I Evaluation Guide
A terminal window opens. The creation of the site can take several minutes. When the window scroll bar is down and the text "Started in" is displayed, the creation of the site is complete.
This terminal window is essential for the site to work. Do not close it until you are nished with using Nuxeo EP 5. 3. Open your browser and type the following address: http:/ /localhost :8080/ nuxeo . 4. Use the information below to log in:
· ·
User Name: Administrator Password: Administrator.
Guide I All Rights Reserved. I Page 6/30
Nuxeo EP 5 I Evaluation Guide
3 Content creation
Nuxeo EP 5 is organized in domains, which can be de ned as sites within the Nuxeo EP 5 platform. They are composed of Workspaces, Templates and Sections, in which you can create and manage your documents.
3.1 Creating a domain
1. Click on the icon 2. Click on the until you arrive on the page "Domains on default server". "Create a new domain" button.
3. Fill in the creation form.
4. When done, click on the "Create" button.
Guide I All Rights Reserved. I Page 7/30
Nuxeo EP 5 I Evaluation Guide
A con rmation message is displayed and the domain's content is displayed. Root section, template and workspace are automatically created in the domain.
3.2 Creating a workspace
1. In the domain, click on "Workspaces" to enter the root workspace.
2. Click on the "Create a new workspace" button.
Guide I All Rights Reserved. I Page 8/30
Nuxeo EP 5 I Evaluation Guide
You can also use the wizard to help you create your workspace. 3. Fill in the creation form.
4. When done, click on the "Create" button. The Content tab of the workspace is displayed.
3.3 Creating a document
1. In a workspace, click the "New Document " button.
Guide I All Rights Reserved. I Page 9/30
Nuxeo EP 5 I Evaluation Guide
2. On the content types page, click on a content type. In this case, we create a le.
3. Fill in the creation form.
4. When done, click on the "Create" button. The document is displayed in the workspace as below.
Guide I All Rights Reserved. I Page 10 /30
Nuxeo EP 5 I Evaluation Guide
Nuxeo EP 5 includes Drag & Drop features. Install the extension corresponding to your browser. Then, just drag your document from your desktop and drop it in the workspace. It is automatically loaded in the application.
Guide I All Rights Reserved. I Page 11 /30
Nuxeo EP 5 I Evaluation Guide
4 Content management
4.1 Modifying a document
1. Click on the document name to open it. 2. Click on the "Modify " tab.
3. Modify the document's properties. In this case, we change the document's description.
Guide I All Rights Reserved. I Page 12 /30
Nuxeo EP 5 I Evaluation Guide
4. Indicate if you want to update the document's version.
5. When done, click on the "Save" button. The "Summary" tab of the document is displayed.
Guide I All Rights Reserved. I Page 13 /30
Nuxeo EP 5 I Evaluation Guide
4.2 Creating relations between documents
1. Click on the document name to open it.
2. Click on the "Relations" tab.
3. Click on "Add a new relation"
Guide I All Rights Reserved. I Page 14 /30
Nuxeo EP 5 I Evaluation Guide
4. Fill in the relation creation form.
Click on the search button to search a Nuxeo EP 5 document. 5. When done, click on the "Add" button. The new relation is displayed in the Relations tab, in the "Outgoing Relations" part of the page.
Guide I All Rights Reserved. I Page 15 /30
Nuxeo EP 5 I Evaluation Guide
5 Content validation
Nuxeo EP 5 documents have a life cycle composed of the following states:
· · ·
project, valid, obsolete.
The life cycle state determines which actions are available on the document. For instance, publication can be only available for approved documents. To change the life cycle state of a document, you need to do speci c actions, for instance you need to submit the document to a review, that is to say a work ow. There are three dif ferent worklows:
· · ·
parallel work ow, serial work ow, approbation work ow.
Only the approbation work ow enables you to change the life cycle state of a document.
5.1 Submitting a document to an approbation review
The submission of a document to a review is made of two steps: 1. the de nition of the review's properties, 2. the declaration of the users who participate to the review. To create an approbation review: 1. Click on the document name to open it. 2. Click on the "Work ow" tab.
Guide I All Rights Reserved. I Page 16 /30
Nuxeo EP 5 I Evaluation Guide
3. Fill in the review properties form.
4. When done, click on the "Start" button. You now need to add reviewers to the work ow.
Guide I All Rights Reserved. I Page 17 /30
Nuxeo EP 5 I Evaluation Guide
5. Fill in the reviewer declaration form to add a reviewer and click on the "Add" button.
The user is added on the review's roadmap.
6. Repeat step 5 as many times as you need to declare all the reviewers.
Guide I All Rights Reserved. I Page 18 /30
Nuxeo EP 5 I Evaluation Guide
7. When done, click on the "Start the work ow" button.
The work ow participants can now approve the document.
Guide I All Rights Reserved. I Page 19 /30
Nuxeo EP 5 I Evaluation Guide
5.2 Approving a document
When you submit a document to a review, you assign users to this review and give them a directive to validate the document. The documents the users need to review are listed in their dashboard. When all the users have approved the document, the work ow is automatically terminated and the document automatically gets into the output life cycle state de ned upon review creation. To approve a document: 1. Click on the "Dashboard" link in the upper right corner of the page to open your dash board.
2. In your dashboard, click on the document's name to open it.
You arrive on the "Work ow" tab.
Guide I All Rights Reserved. I Page 20 /30
Nuxeo EP 5 I Evaluation Guide
3. Type a comment and click on the "Approve" link.
The next reviewer becomes the current reviewer and has to approve the document. When all the reviewers have approved the document, the review is automatically terminated and the document gets into the output life cycle state you de ned when you started the review.
Guide I All Rights Reserved. I Page 21 /30
Nuxeo EP 5 I Evaluation Guide
6 Content publishing
When the documents are ready for di usion, you must publish them in sections. Sections are spaces devoted make content available for a wider audience. Publishing is submitted to approval. To be able to submit a document to publication, you must have writing rights in the workspace and reading or writing rights in the selected section. To approve or reject pending documents, you must have management rights in the section.
6.1 Submitting a document to publication
To submit a document to publication in a section: 1. Click on the document name to open it. 2. Click on the "Publish " tab.
3. Select the section in which you want to publish the document and click on the " Publish" button.
Guide I All Rights Reserved. I Page 22 /30
Nuxeo EP 5 I Evaluation Guide
The version number of the document is displayed in front of the section's name, to indicate what version is pending or published.
The document is not available to users with reading rights in the section.
6.2 Approving a publication submission
To approve a document that has been submitted to publication in a section : 1. Click on the "Dashboard" link in the upper right corner of the page to open your dash board.
Guide I All Rights Reserved. I Page 23 /30
Nuxeo EP 5 I Evaluation Guide
2. Click on the document's name to open it.
The pending document's opens in the section. 3. Type a comment and click on the "Publish" button.
Guide I All Rights Reserved. I Page 24 /30
Nuxeo EP 5 I Evaluation Guide
The document is published.
The document is now available for all the users who have reading rights in the section.
Guide I All Rights Reserved. I Page 25 /30
Nuxeo EP 5 I Evaluation Guide
7 Rights management
The access rights are determined for a whole domain or space, and are inheri ted in their childr en spaces. The "Access Rights" tab enables you to give or deny rights to the site users. You can thus customize the access to the content and make it more accurate. 1. In a workspace, click on the "Access Rights" tab to manage the workspace access rights.
2. In the "Add a new security rule" part of the screen, select the user you want to give access to the workspace and the rights you want to give him or her. In this case, we give John Doe (jdoe) writing rights on the workspace content.
Guide I All Rights Reserved. I Page 26 /30
Nuxeo EP 5 I Evaluation Guide
The "Action"select box enables you to grant or deny the selected right. 3. When done, click on the "Add permissi on" button. The "Content" tab of the workspace 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.
In this case, John Doe, the user we just gave writing rights in the "Documentation" workspace, is displayed the tabs corresponding to his rights. In the workspace, he is not dis played the "Access Rights" tab.
Guide I All Rights Reserved. I Page 27 /30
Nuxeo EP 5 I Evaluation Guide
8 Theme management
You can customize Nuxeo EP 5's look with the theme management module, NXThemes. A theme is the appearance of the Nuxeo EP 5 site. NXThemes is a module that is integrated to Nuxeo EP 5 and enables you to modify the content of the page and the way this content is displayed. To access NXThemes, click on "Themes management". A Nuxeo EP 5 page is composed of fragments that display content. This content can be an image, a text or a menu, for instance. To insert a fragment in a page, use the " Add fragments" button : just drag and drop a fragment from the "Fragments" box to create a new fragment.
You can the edit this fragment to determine its properties, such as the page(s) it is dis played on, the users who can see this portlet. You can also customize the look of the fragment, that is to say its fonts and colors. To edit a fragment, use the "Edit canvas" button and click on the fragment you want to modify.
Guide I All Rights Reserved. I Page 28 /30
Nuxeo EP 5 I Evaluation Guide
When you edit a fragment, you can use the di erent perspectives available to check what the di erent categories of users will see. When you modify a theme, you automatically create a new one. This new theme can be exported as an XML document using the "Export theme" button, so that you can integrate it in a new package.
Guide I All Rights Reserved. I Page 29 /30
Nuxeo EP 5 I Evaluation Guide
9 Conclusion
Nuxeo EP 5 is an ECM platform that enables you to create and share documents. This guide presented its main features, so that you can discover and evaluate Nuxeo EP 5. A mailing list dedicated to Nuxeo EP 5 is available. You can subscribe here. Do not hesitate to give us feedback! For more information about Nuxeo EP 5, please contact us at contact @nuxeo. com.
Guide I All Rights Reserved. I Page 30 /30