Nuxeo Document Management - Version 5.3 The Reference guide 5.3 Copyright © 2000-2010, Nuxeo SA. 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 Table of Contents I. Introduction ..................................................................................................................................1 1. Preface .................................................................................................................................2 1.1. What this Book Covers ............................................................................................... 2 1.2. What this book doesn't cover ....................................................................................... 2 1.3. Target Audience ......................................................................................................... 2 1.4. About Nuxeo .............................................................................................................3 1.5. About Open Source .................................................................................................... 3 2. Introduction ..........................................................................................................................4 2.1. Enterprise Content Management .................................................................................. 4 2.1.1. Why ECM? .....................................................................................................4 2.2. The Nuxeo ECM platform .......................................................................................... 4 2.3. Introduction FAQ ....................................................................................................... 4 2.3.1. What are Nuxeo EP 5, Nuxeo EP and Nuxeo RCP? ........................................... 4 2.4. Intended audience ...................................................................................................... 4 2.5. What this book covers ................................................................................................ 4 3. Getting Started ...................................................................................................................... 6 3.1. Overview ...................................................................................................................6 3.2. Prerequisites .............................................................................................................. 6 3.3. Eclipse Plugins v Command Line ................................................................................ 7 3.4. Learning from the project sample ................................................................................ 7 3.5. Setting up the sample project ...................................................................................... 7 3.5.1. Some handy environment settings ..................................................................... 7 3.5.2. Checking the sample project out of mercurial .................................................... 8 3.5.3. Initialize the Eclipse workspace ........................................................................ 8 3.5.4. Setting up your project for importing into Eclipse .............................................. 8 3.5.5. Importing the sample project into Eclipse .......................................................... 9 3.5.6. Running JUnit tests on the sample code ............................................................ 9 3.5.7. Building the jar file from the sample project ...................................................... 9 3.5.8. Deploying the jar file to the Nuxeo server ......................................................... 9 3.5.9. Starting the nuxeo server .................................................................................. 9 3.5.10. Viewing your changes via the UI .................................................................. 10 3.5.11. Using Ant ................................................................................................... 11 3.6. Understanding the sample code ................................................................................. 12 3.6.1. Two types of changes .................................................................................... 12 3.6.2. The layout of our sample project .................................................................... 12 3.6.3. A bit about extension points ........................................................................... 13 3.6.4. Declaring the 'Book' document type ................................................................ 14 3.6.5. Displaying book documents ........................................................................... 17 3.6.6. Actions, tabs and behavior ............................................................................. 22 3.6.7. Making book documents indexable and searchable .......................................... 24 3.6.8. Enabling drag&drop creation (plus creating our own extension points) ............. 26 3.6.9. Regulating book states ................................................................................... 29 3.6.10. Workflow .................................................................................................... 30 3.6.11. Listening for events ..................................................................................... 30 3.7. Starting a new project ............................................................................................... 32 3.8. Using Documentation ............................................................................................... 33 3.9. Other IDEs: IntelliJ IDEA and NetBeans ................................................................... 33 3.9.1. IDEA ............................................................................................................ 33 3.9.2. NetBeans ...................................................................................................... 33 4. General Overview ............................................................................................................... 34 4.1. Introduction ............................................................................................................. 34 4.1.1. Architecture Goals ......................................................................................... 34 4.1.2. Main concepts and design .............................................................................. 37 4.2. Nuxeo 5 Architecture Overview ................................................................................ 39 4.3. Nuxeo Runtime: the Nuxeo EP component model ...................................................... 40 4.3.1. The motivations for the runtime layer ............................................................. 40 4.3.2. Extensible component model .......................................................................... 41 Nuxeo EP 5.3 ii Nuxeo Document Management - Version 5.3 4.3.3. Flexible deployment system ........................................................................... 44 4.4. Nuxeo EP layered architecture .................................................................................. 45 4.4.1. Layers in Nuxeo EP ....................................................................................... 45 4.4.2. API and Packaging impacts ............................................................................ 47 4.5. Core Layer overview ................................................................................................ 47 4.5.1. Features of Nuxeo Core ................................................................................. 48 4.5.2. Nuxeo Core main modules ............................................................................. 49 4.5.3. Schemas and document types ......................................................................... 49 4.5.4. The life cycle associated with documents ........................................................ 50 4.5.5. Security model .............................................................................................. 51 4.5.6. Core events system ........................................................................................ 51 4.5.7. Query system ................................................................................................ 52 4.5.8. Versioning system ......................................................................................... 52 4.5.9. Repository and SPI Model ............................................................................. 52 4.5.10. DocumentModel .......................................................................................... 52 4.5.11. Proxies ........................................................................................................ 53 4.5.12. Core API ..................................................................................................... 54 4.6. Service Layer overview ............................................................................................ 54 4.6.1. Role of services in Nuxeo EP architecture ....................................................... 54 4.6.2. Services implementation patterns ...................................................................