Nuxeo Eval Guide

Nuxeo EP 5EvaluationGuide

Last modi!cation 11/13/2006

Project Code NUXEO

Document ID NUXEO_EvalGuide

Copyright Copyright © 2006 Nuxeo. All Rights Reserved.

Versioning

Version Date Participant(s) Comments

0.0 13/11/06 • Solen Guitter Creation

1.0 15/11/06 • Solen Guitter Update

1.1 16/11/06 • Solen Guitter Corrections and update

1.2 17/11/06 • Stéfane Fermigier

• Solen Guitter

Update and corrections

1.3 20/11/06 • Solen Guitter Integration of NXThemes

1.4 23/11/06 • Solen Guitter Corrections

1.5 06/02/07 • Solen Guitter Update for 5.0 release

1.6 31/10/07 • Solen Guitter Update for 5.1.2 release

Tableof Contents1 Introduction.................................................................................................................................................................................................. ....4

2 Nuxeo EP 5......................................................................................................................................................................................................... 52.1 Installing Nuxeo EP 5....................................................................................................................................................................... ......52.2 Launching a Nuxeo EP 5 site......................................................................................................................................................... ......5

3 Content creation................................................................................................................................................................................. ............73.1 Creating a domain............................................................................................................................................................................. .....73.2 Creating a workspace........................................................................................................................................................................ ....83.3 Creating a document............................................................................................................................................................ ................9

4 Content management.................................................................................................................................................................... ............124.1 Modifying a document....................................................................................................................................................................... 124.2 Creating relations between documents......................................................................................................................... .............14

5 Content validation........................................................................................................................................................................ ...............165.1 Submitting a document to an approbation review............................................................................................................. ....165.2 Approving a document................................................................................................................................................................... ...20

6 Content publishing................................................................................................................................................................................... ...226.1 Submitting a document to publication............................................................................................................................ ...........226.2 Approving a publication submission....................................................................................................................................... .....23

7 Rights management............................................................................................................................................................................ ........26

8 Theme management................................................................................................................................................................................... 28

9 Conclusion........................................................................................................................................................................................... ...........30

Nuxeo EP 5 I Evaluation Guide

1 IntroductionNuxeo 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 tomake 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 functioning of Nuxeo EP 5and to enable you to evaluate Nuxeo EP 5. To this end, this guide describes the followingprocesses:

• content creation (workspace, document),

• contentmanagement,

• content validation,

• rights management.

Guide I All Rights Reserved. I /30


2 Nuxeo EP 5Nuxeo EP 5 is available at http://www.nuxeo.org/sections/downloads/.

Nuxeo EP 5 requires a Java 5 Java Runtime Environment (JRE) or Software De-velopment Kit (SDK), available from http://java.sun.com/.

2.1 Installing Nuxeo EP 5Thanks 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 site1. 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.


http://www.nuxeo.org/sections/downloads/


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 cre-ation of the site is complete.

This terminal window is essential for the site to work. Do not close it until youare "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.


http://localhost:8080/nuxeo


3 Content creationNuxeo 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 cre-ate and manage your documents.

3.1 Creating a domain1. Click on the icon until you arrive on the page “Domains on default server”.

2. Click on the “Create a new domain”button.

3. Fill in the creation form.

4. When done, click on the “Create”button.



A con"rmation message is displayed and the domain's content is displayed. Rootsection, template and workspace are automatically created in the domain.

3.2 Creating a workspace1. In the domain, click on “Workspaces” to enter the root workspace.

2. Click on the “Create a newworkspace”button.



Youcan also use the wizard to help you create your workspace.



The Content tab of the workspace is displayed.

3.3 Creating a document1. In a workspace, click the “NewDocument”button.



2. On the content types page, click on a content type. In this case, we create a "le.



The document is displayed in the workspace as below.



Nuxeo EP 5 includes Drag & Drop features. Install the extension correspondingto your browser. Then, just drag your document from your desktop and drop it inthe workspace. It is automatically loaded in the application.



4 Contentmanagement

4.1 Modifying a document1. 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.



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.



4.2 Creating relations between documents1. Click on the document name to open it.

2. Click on the “Relations” tab.

3. Click on “Add a new relation”



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.



5 Content validationNuxeo 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 instanceyou 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 reviewThe 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.



3. Fill in the review properties form.

4. When done, click on the “Start”button.

Younow need to add reviewers to the work#ow.



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.



7. When done, click on the “Start the work#ow”button.

The work#ow participants can now approve the document.



5.2 Approving a documentWhen 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 intheir dashboard. When all the users have approved the document, the work#ow is automati-cally 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.

Youarrive on the “Work"ow” tab.



3. Type a comment and click on the “Approve” link.

The next reviewer becomes the current reviewer and has to approve the docu-ment.

When all the reviewers have approved the document, the review is automatically termi-nated and the document gets into the output life cycle state you de"ned when you startedthe review.



6 Content publishingWhen 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, youmust have writing rights in the workspace and reading or writing rights in the selected sec-tion. To approve or reject pending documents, you must have management rights in thesection.

6.1 Submitting a document to publicationTo 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 “Pub-lish”button.



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 submissionTo 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.



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.



The document is published.

The document is now available for all the users who have reading rights in thesection.



7 Rights managementThe access rights are determined for a whole domain or space, and are inherited in their

children spaces. The “Access Rights” tab enables you to give or deny rights to the site users.Youcan 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 accessrights.

2. In the “Add a new security rule”part of the screen, select the user you want to give ac-cess to the workspace and the rights you want to give him or her. In this case, we giveJohn Doe (jdoe) writing rights on the workspace content.



The “Action”select box enables you to grant or deny the selected right.

3. When done, click on the “Addpermission”button.

The “Content”tab of the workspace is displayed. If you click on the “AccessRights”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 “AccessRights” tab.



8 ThememanagementYou 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 toNuxeo EP 5 and enables you to modify the content of the page and the way this content isdisplayed. To access NXThemes, click on “Themesmanagement”.

A Nuxeo EP 5 page is composed of fragments that display content. This content can be animage, a text or a menu, for instance. To insert a fragment in a page, use the “Add frag-ments” button : just drag and drop a fragment from the “Fragments” box to create a newfragment.

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 frag-ment, that is to say its fonts and colors. To edit a fragment, use the “Edit canvas” button andclick on the fragment you want to modify.



When you edit a fragment, you can use the di!erent perspectives available to check whatthe di!erent categories of users will see.

When you modify a theme, you automatically create a new one. This new theme can beexported as an XML document using the “Export theme”button, so that you can integrate itin a new package.



9 ConclusionNuxeo 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 hesi-tate to give us feedback!

For more information about Nuxeo EP 5, please contact us at [email protected].


mailto:[email protected]

http://lists.nuxeo.com/mailman/listinfo/ecm/

Nuxeo Eval Guide

Economy & Finance

Transcript of Nuxeo Eval Guide