Nuxeo Enterprise Platform - Version 5.1 and 5.2 the Reference Guide

Total Page:16

File Type:pdf, Size:1020Kb

Nuxeo Enterprise Platform - Version 5.1 and 5.2 the Reference Guide Nuxeo Enterprise Platform - Version 5.1 and 5.2 The Reference guide 5.1 / 5.2 Copyright © 2000-2008, 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 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 .............................................................................................................2 1.5. About Open Source .................................................................................................... 2 2. Introduction ..........................................................................................................................3 2.1. Enterprise Content Management .................................................................................. 3 2.1.1. Why ECM? .....................................................................................................3 2.2. The Nuxeo ECM platform .......................................................................................... 3 2.3. Introduction FAQ ....................................................................................................... 3 2.3.1. What are Nuxeo EP 5, Nuxeo EP and Nuxeo RCP? ........................................... 3 2.4. Intended audience ...................................................................................................... 3 2.5. What this book covers ................................................................................................ 3 3. Getting Started ...................................................................................................................... 5 3.1. Prerequisites .............................................................................................................. 5 3.2. Setting up your Eclipse ............................................................................................... 5 3.2.1. Enabling Maven project loading ....................................................................... 5 3.2.2. Enabling Subversion checkout .......................................................................... 5 3.3. Learning from the project sample ................................................................................ 6 3.3.1. Checkout project ............................................................................................. 6 3.3.2. Understanding sample code .............................................................................. 7 3.3.3. Declaring book document type ......................................................................... 7 3.3.4. Regulating book states ..................................................................................... 8 3.3.5. Displaying book documents ............................................................................. 8 3.3.6. Making book documents indexable and searchable .......................................... 10 3.3.7. Enabling drag&drop creation ......................................................................... 11 3.3.8. Listening for events ....................................................................................... 11 3.4. Starting a new project ............................................................................................... 12 3.5. Using Documentation ............................................................................................... 12 3.6. Other IDEs: IntelliJ IDEA and NetBeans ................................................................... 12 3.6.1. IDEA ............................................................................................................ 12 3.6.2. NetBeans ...................................................................................................... 12 4. General Overview ............................................................................................................... 14 4.1. Introduction ............................................................................................................. 14 4.1.1. Architecture Goals ......................................................................................... 14 4.1.2. Main concepts and design .............................................................................. 17 4.2. Nuxeo Runtime: the Nuxeo EP component model ...................................................... 19 4.2.1. The motivations for the runtime layer ............................................................. 19 4.2.2. Extensible component model .......................................................................... 20 4.2.3. Flexible deployment system ........................................................................... 23 4.2.4. Extension points and Nuxeo 5 ........................................................................ 24 4.3. Nuxeo EP layered architecture .................................................................................. 25 4.3.1. Layers in Nuxeo EP ....................................................................................... 25 4.3.2. API and Packaging impacts ............................................................................ 27 4.3.3. Illustration of the layered architecture ............................................................. 27 4.4. Core Layer overview ................................................................................................ 27 4.4.1. Features of Nuxeo Core ................................................................................. 28 4.4.2. Nuxeo Core main modules ............................................................................. 29 4.4.3. Schemas and document types ......................................................................... 29 4.4.4. Life cycle associated to documents ................................................................. 30 4.4.5. Security model .............................................................................................. 31 4.4.6. Core events system ........................................................................................ 32 4.4.7. Query system ................................................................................................ 32 4.4.8. Versioning system ......................................................................................... 32 4.4.9. Repository and SPI Model ............................................................................. 33 Nuxeo EP 5.1 / 5.2 ii Nuxeo Enterprise Platform - Version 5.1 and 5.2 4.4.10. DocumentModel .......................................................................................... 33 4.4.11. Proxies ........................................................................................................ 34 4.4.12. Core API ..................................................................................................... 34 4.5. Service Layer overview ............................................................................................ 34 4.5.1. Role of services in Nuxeo EP architecture ....................................................... 34 4.5.2. Services implementation patterns .................................................................... 35 4.5.3. Platform API ................................................................................................. 36 4.5.4. Adapters ....................................................................................................... 36 4.5.5. Some examples of Nuxeo EP services ............................................................. 37 4.6. Web presentation layer overview ............................................................................... 37 4.6.1. Technology choices ....................................................................................... 37 4.6.2. Componentized web application ..................................................................... 37 5. Schemas and Documents ..................................................................................................... 40 5.1. Introduction ............................................................................................................. 40 5.1.1. Concepts ....................................................................................................... 40 5.2. Schemas .................................................................................................................. 40 5.3. Core Document Types .............................................................................................. 41 5.4. ECM Document Types ............................................................................................. 41 5.4.1. Label and Icon .............................................................................................
Recommended publications
  • EPA Enterprise Records Management Market Research
    US General Services Administration - Internal Use Only - EPA Enterprise Records Management Market Research 1 On September 26, 2018, the US General Services Administration issued a Request for Information on behalf of the US Environmental Protection Agency. The RFI was issued to conduct market research related to EPA Enterprise Records Management. The RFI was issued under Schedule 36, Special Item Number 51 600, Electronic Record Management Solutions. The RFI closed on October 17, 2018. The scope of the RFI requirement was described as follows, additionally, a Statement of Objectives was attached to the RFI for feedback from industry. Summary of Objective: The United States Environmental Protection Agency’s Enterprise Records Management Division (ERMD) within the Office of Environmental Information’s (OEI) Office of Enterprise Information Programs (OEIP) provides leadership and direction in managing records that support EPA’s mission. ERMD, in collaboration with other Agency records management experts, is in the initial stages of gathering input and defining requirements for EPA’s future records management capabilities. EPA is trying to understand commercial ERM solutions that meet the attached EPA records management objectives, as well as the National Archives and Record’s Administration’s (NARA) universal ERM requirements. Therefore, we are requesting interested parties capable of providing solutions to respond to this request for information. Electronics Record Management Solutions - Schedule 36 SIN 51 600 Summary: Electronic Records Management Solutions Electronic Records Management Solutions provide a comprehensive capability to solve the complex challenges posed by the movement, manipulation, archiving, security, and management of electronic records. The vendor provides professional management and administrative support personnel with the necessary skills to perform effective record management services for both classified and/or unclassified records.
    [Show full text]
  • Nuxeo Enterprise Platform - Version 5.1 the Administration Guide
    Nuxeo Enterprise Platform - Version 5.1 The administration guide 5.1 / 5.2 Copyright © 2000-2008, 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 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 .............................................................................................................2 1.5. About Open Source .................................................................................................... 2 2. Introduction ..........................................................................................................................3 2.1. Enterprise Content Management .................................................................................
    [Show full text]
  • Download Files from Server Javascript Download Files from Server Javascript
    download files from server javascript Download files from server javascript. JavaTpoint offers too many high quality services. Mail us on [email protected], to get more information about given services. Website Designing Website Development Java Development PHP Development WordPress Graphic Designing Logo Digital Marketing On Page and Off Page SEO PPC Content Development Corporate Training Classroom and Online Training Data Entry. Training For College Campus. JavaTpoint offers college campus training on Core Java, Advance Java, .Net, Android, Hadoop, PHP, Web Technology and Python. Please mail your requirement at [email protected] Duration: 1 week to 2 week. Authenticated File Download in JavaScript. Not long ago, I presented a webinar on CMIS where I demonstrated a standalone Web application that used CMIS to access content from a Nuxeo repository. One particular feature I was excited to show was the ability to download a rendition of a document living in the Nuxeo Content Services Platform. Much to my embarrassment I discovered later that this example did not work at all unless I was already logged in to the Nuxeo application. Kind of defeats the purpose of building a standalone web application! So I set about rectifying this oversight. It turned out to be a difficult problem to research, but with a pretty simple solution. Since the issue is not really Nuxeo-specific, I decided to handle it in a separate blog. This information should benefit anyone needing to download files that require authentication from JavaScript code. Note: I will be blogging about my CMIS client in a future post as well. User Story. I want to be able to download the PDF rendition of a Nuxeo document via CMIS using a single-page Web application.
    [Show full text]
  • Exploring the Nuxeo REST API ENABLING RAPID CONTENT APPLICATION CRAFTSMANSHIP CHAPTER 1 the Nuxeo REST API
    Exploring the Nuxeo REST API ENABLING RAPID CONTENT APPLICATION CRAFTSMANSHIP CHAPTER 1 The Nuxeo REST API What do the words craftsmanship and artistry make you think of? Beautiful handmade objects? Remarkable works of art? What about… Enterprise application development? Maybe that one doesn’t come to mind quite as readily, but we at Nuxeo think it should. Just as a true work of art can have a transformative effect on the viewer, Nuxeo empowers developers to create truly business-transforming content-driven applications. A key way we make this happen is through our REST API—the “canvas” for developers to rapidly craft the next killer business app. 1 A REST API as Flexible and Powerful as Purpose, Target Audience, and the Nuxeo Platform Itself Organization of this eBook The Nuxeo Platform is a highly flexible and extensible system for This ebook will provide you with a technical overview of the enterprise content management (ECM), digital asset manage- Nuxeo REST API and explain what sets it apart from other HTTP/ ment (DAM) and case management, capable of handling the HTTPS APIs. most demanding content-driven enterprise business processes: You will also discover plentiful resources available to help you un- • Benchmarked at processing one billion documents derstand and master the use of the Nuxeo REST API, including technical references, blog articles with code examples, videos • Utilizes MongoDB as a NoSQL option for content storage and online documentation. Descriptions of these resources with • Includes tight, native integration with Elasticsearch content excerpts are provided, as well as links to the original ma- terial. • Supports custom workflows and rich content objects contain- ing advanced data structures and custom metadata This ebook is targeted primarily at the developer community, of- fering resources and guidance in the development of content- And yet, the Nuxeo Platform offers organizations even more: Un- driven web services for the Nuxeo Platform based on RESTful like other content-related tools, the Nuxeo Platform provides a principles.
    [Show full text]
  • Content Repository White Paper
    WHITE PAPER SOLVING COMPLEX CONTENT CHALLENGES Replacing Obsolete Systems with a Modern Content Management Platform As global organizations embrace digital transformation, the company’s workforce, business processes, and mission-critical applications strategically align to improve operational performance. These digital initiatives are leading organizations to take a hard look at their existing enterprise applications and determine if its possible to achieve their desired business results with the existing infrastructure. The ROI and business value of traditional enterprise content management (ECM) applications must be evaluated, specifically when they can no longer keep up with organizational changes and growth. In a recent Gartner business software strategy survey on high-priority IT projects, modernizing existing enterprise applications was the most common priority. (1) A modern content management platform enables today’s increasingly mobile, global workers and teams to easily access, collaborate and act upon key business content on demand - anytime, anywhere. These enterprise capabilities provide the building blocks for mission-critical business applications. Three common use cases covered in this paper include: • Repurposing enterprise content with a schema-flexible content model • Processing complex content-driven transactions and creating advanced workflows • Integrating enterprise content and building native mobile apps © NUXEO NUXEO.COM CORE REPOSITORY WHITE PAPER [email protected] This paper explores how modern content management
    [Show full text]
  • Developer Documentation
    Developer Documentation Nuxeo Platform 5.5 Table of Contents 1. Technical Documentation Center . 4 1.1 Overview and Architecture . 5 1.2 Overview . 6 1.3 Architecture . 9 1.3.1 Architecture overview . 9 1.3.2 About the content repository . 12 1.3.2.1 VCS Architecture . 21 1.3.3 Platform features quick overview . 30 1.3.4 Component model overview . 32 1.3.5 API and connectors . 36 1.3.6 UI frameworks . 39 1.3.7 Deployment options . 42 1.3.8 Performance management for the Nuxeo Platform . 47 1.4 Customization and Development . 53 1.4.1 Learning to customize Nuxeo EP . 54 1.4.2 Document types . 55 1.4.3 Document, form and listing views . 62 1.4.3.1 Layouts (forms and views) . 62 1.4.3.1.1 Manage layouts . 63 1.4.3.1.2 Document layouts . 70 1.4.3.1.3 Layout display . 71 1.4.3.1.4 Standard widget types . 72 1.4.3.1.5 Custom templates . 73 1.4.3.1.6 Custom widget types . 85 1.4.3.1.7 Generic layout usage . 93 1.4.3.2 Content views . 93 1.4.3.2.1 Custom Page Providers . 100 1.4.3.2.2 Page Providers without Content Views . 101 1.4.3.3 Views on documents . 102 1.4.4 Versioning . 104 1.4.5 User Actions (links, buttons, icons, tabs) . 105 1.4.6 Events and Listeners . 108 1.4.6.1 Scheduling periodic events . 113 1.4.7 Tagging .
    [Show full text]
  • Nuxeo Platform Release Notes
    Nuxeo Platform 8.10 Release Notes For Users Nuxeo Mobile 8.3 Nuxeo Mobile provides an out of the box mobile experience with any customized Nuxeo Platform server. It lets you access content stored on Nuxeo Platform servers on your phone. Nuxeo Mobile provides a seamless experience on essential features such as searching, browsing, previewing documents (typically images, videos, text documents and notes), and managing favorite documents. Nuxeo Mobile is available for iOs and Android . Nuxeo Web UI Beta 8.3 8.10 A new UI is being written for the LTS 2016. Purpose is to move to more recent standards and technological stack (Web Components and Polymer) and to take the opportunity to reboot the user experience. Some important steps around configurability are missing before reaching the 1.0 version. Yet a large part of the feature scope is implemented and robust. We encourage you to check it out yourself: Content browsing, with great new features in comparison with JSF UI, like recently seen documents Content capture, including batch metadata edition and Live Connect Workflows Search, including new asset search screens Document lists a.k.a Queues Analytics Preview and more. Final release for LTS 2016 is to be expected for April 2017. Nuxeo Web UI is already available on the marketplace and you can check its documentation for more details. Instant Share 8.1 A new feature allows to invite users to a given folder of the Nuxeo Platform with either Read or Edit permission, by email. Invited users do not have an account on the Nuxeo Platform instance.
    [Show full text]
  • Studio Documentation
    Studio Documentation 12/09/2014 Table of Contents 1. Nuxeo Studio Documentation Center . 4 1.1 Getting Started in Studio . 4 1.1.1 Studio Overview and Concepts . 4 1.1.1.1 What can be achieved with Nuxeo Studio? . 5 1.1.1.2 What do you need to know about Nuxeo applications? . 5 1.1.1.2.1 About documents . 6 1.1.1.2.2 About layouts and content views . 7 1.1.1.2.3 About workflows and business logic . 7 1.1.1.2.4 Plugins and extensions with the Nuxeo Platform . 11 1.1.1.3 How To Get Started . 12 1.2 Working in Studio . 12 1.2.1 Resources . 12 1.2.2 Branding . 13 1.2.2.1 Branding Configuration . 13 1.2.2.1.1 Migrating My Branding to 5.5 New Branding System . 18 1.2.2.2 Create multiple themes . 19 1.2.3 Content Model . 19 1.2.3.1 Schemas . 19 1.2.3.2 Documents . 20 1.2.3.3 Life cycle . 24 1.2.3.4 Structure Templates . 25 1.2.4 Listings & Views . 26 1.2.4.1 Content Views . 26 1.2.4.1.1 Content View: Query & Form Tab . 29 1.2.4.1.2 Content View: Results . 32 1.2.4.1.3 Content View: Enablement . 33 1.2.4.2 Form Layouts . 33 1.2.4.3 Search / Advanced Search . 38 1.2.4.4 Tabs . 39 1.2.4.5 Virtual Navigations . 43 1.2.5 Workflow . 44 1.2.5.1 Workflow screens .
    [Show full text]
  • Cloud-Native Digital Asset Management for the Digital Workplace
    CLOUD-NATIVE DIGITAL ASSET MANAGEMENT FOR THE DIGITAL WORKPLACE PROVIDE ACCESS TO CONTENT ANYTIME, ANYWHERE i ENABLING THE DIGITAL WORKPLACE: Break Down the Content Boundaries Business success today requires a new digital workplace technology approach. Your workforce must be able to seamlessly access, create, share and act upon content - anytime, anywhere, across departmental and geographic boundaries. This eBook explores the key technologies that make this possible and provides further resources to help you make a true digital workplace a reality in your organization. 2 The Digital Workplace is a Must-Have The digital workplace is still evolving, so technology platforms must also be future-proof - with a dynamic, extensible, API-first A recent Gartner research note, Content Is a Critical Dimension to infrastructure to integrate with current and future enterprise Digital Workplace Success, declared the old “centralized systems and information sources. command and control” mindset for enterprise application development is no longer enough: Nuxeo Enables the Digital Workplace IT leaders must respond to employee needs for more This eBook explores three key digital workspace technologies intuitive and flexible tools for creating, accessing and essential for digital workplace success (listed below). sharing content... anywhere and anytime... across You will also discover how these capabilities can be accessed departmental, geographic and corporate boundaries. directly from the Nuxeo Platform for content-centric application development, testing and deployment at massive scale. New digital workplace strategies and toolkits are required to • Cloud-Native design to integrate all content. Because the adequately support the needs of today’s increasingly dispersed, Nuxeo Platform was built for the cloud, it integrates with your mobile and digitally savvy workforce.
    [Show full text]
  • The Content-Centric Web Framework
    Not another old web framework!fashioned Engine unveiled Web Nuxeo The content-centric web framework “Nuxeo WebEngine is a lightweight, content-centric web framework to quickly build and deliver slices of web” what the web really is about? URL HTML CSS RSS / ATOM JavaScript URL HTML CSS RSS / ATOM JavaScript content content content why WebEngine? because URLs matter because you have content to expose on the web because you want more than web publishing content repository ecm platform many services and features flexible and modular components everywhere do you need anything else to create your content- oriented web apps? sure! dynamic horizontal scaling easy programing model designed for the web and what about that? lightweight framework content-centric extensible with scripting components architecture lightspeed startup Nuxeo WebEngine less abstraction, more control Overview Easier and faster development for content-oriented web applications leverage a complete ECM platform ...and a powerful component model less abstraction focus on content built on REST (HTTP means something) no JSF, EJBs, Java EE required no magic more control the browser is a platform widgets are the key to expose your content scripting for business logic fast code/test cycle smart & elegant Designed by web’s children, for the web you like Content is king URL matters REST everywhere, because the web has a soul and... in developers we trust WebEngine Essentials easy MVC smart URL dispatcher flexible views on content powerful templating language — Freemarker scripting for
    [Show full text]
  • Nuxeo Server LTS 2017 Release Notes
    Home (/) > Developer Documentation Center (/nxdoc/) > Nuxeo Server (/nxdoc/nuxeo-server/) > Nuxeo Server LTS 2017 Release Notes Nuxeo Server LTS 2017 Release Notes Updated: January 8, 2018 (https://github.com/nuxeo/doc.nuxeo.com- content/tree/master/src/nxdoc/nuxeo-server/nuxeo-server-release- notes.md) This page relates to the release notes of Nuxeo Server and related addons for the 9.10 cycle, a.k.a LTS 2017 cycle. It will list the improvements and features that are successively shipped with the 9.1, 9.2, 9.3 and LTS 2017 releases. Evolutions are grouped by components. You can also find detailed JIRA release notes: 9.1 JIRA release notes (https://jira.nuxeo.com/secure/ReleaseNote.jspa?projectId=10011& version=17991) 9.2 JIRA release notes (https://jira.nuxeo.com/secure/ReleaseNote.jspa?projectId=10011& version=18236) 9.3 JIRA release notes (https://jira.nuxeo.com/secure/ReleaseNote.jspa?projectId=10011& version=18310) 9.10 JIRA release notes (https://jira.nuxeo.com/secure/ReleaseNote.jspa?projectId=10011& version=18106) We also provide instructions for upgrading (/nxdoc/upgrade-from-lts-2016-to-lts-2017/) to the latest release. Nuxeo Server Runtime Runtime Components Lifecycle Refactored The runtime behavior has been refactored so as to provide a cleaner lifecycle to its components. This (big) change is pretty transparent for now but will allow to provide new features to the runtime in the next releases. ! More on JIRA ticket NXP-19326 (https://jira.nuxeo.com/browse/NXP-19326). Change in Runtime Reload Strategy Runtime reload strategy has been set by default to standby and can be changed with the property org.nuxeo.runtime.reload_strategy .
    [Show full text]
  • Lessons Learned Developing the Nuxeo EP Open Source, Component-Based, ECM Platform
    Lessons learned developing the Nuxeo EP open source, component-based, ECM platform Stefane Fermigier, Thierry Delprat, Olivier Grisel, Florent Guillaume { Nuxeo SA∗ November 22, 2010 Abstract ECM, a concept that emerged in the early 2000s, represents the inte- grated enterprise-wide management of all forms of non-structured (and sometimes, semi-structured) content, including their metadata, across their whole lifecycle, supported by appropriate technologies and adminis- trative infrastructure. Nuxeo EP is a commercial open source ECM platform developed in an open and collaborative fashion since 2006, with the goal of enabling the whole spectrum of ECM applications, from horizontal applications such as Document Management and Digital Assets Management, to more specific applications focused on the needs of a given industry or corporation. This paper presents the main original business-driven goals for the project, their impact on the functional and technical requirement for the platform and its architecture, and the solutions that were devised to ad- dress them. It reflects upon the benefits and challenges of developing the project both based on open source libraries and frameworks, and itself in an open source fashion. We found that existing open source Java frameworks, libraries and tools provide sufficient building blocks for enterprise software, as long as a proper architecture and development process are set in place to address the software quality needs of this kind of project. keywords: enterprise content management, electronic document man- agement, open source, software architecture, OSGi, component-based soft- ware engineering. 1 Introduction According to AIIM1, \Enterprise Content Management (ECM) is the strategies, methods and tools used to capture, manage, store, preserve, and deliver content and documents related to organizational processes.
    [Show full text]