Developer Documentation Center
Getting Started
Quick Overview
Discover Nuxeo Platform APIs
Setting up Your Nuxeo Environment
Setting up Your JavaScript Environment
Manipulating Documents
Handling Permissions
Managing Files
Retrieving Audit Log
Using Renditions
Using Workflows
Using Automation
Configure Nuxeo Platform
Develop with Nuxeo Platform
Best Practices
Bootstrap Your Document Management Project
Bootstrap Your Case Management Project
Platform as a Service
From the JSF UI to Nuxeo Studio
UI Feature Comparison
Choosing How to Import Data in the Nuxeo Platform
Configuration Tips
Locking vs Permission to Restrict Edit Access to a Document
Several Document Types vs One Document Type with a Nature Metadata
Essential Nuxeo Platform Terminology
Performances
Managing Performance
Tracking the Performance of the Nuxeo Platform
Understand Expression and Scripting Languages Used in Nuxeo
Available Variables in Email Templates
Workflow Tutorials
Simple Workflow Example
Sub Workflow Example
1- Creating the Expense Document Type
2- Creating the Subworkflows
3- Creating the Main Workflow
Workflow Escalation Rules Example
Learning with Examples
How to Publish a News Feature in Workspaces
Implement the News Document
Add a News Content View on Workspaces
Implement the News "Publishing" Process
How-To Index
Nuxeo Server
Installation
Compatibility Matrix
Installing and Setting Up Related Software
Installing the Nuxeo Platform on Linux
Configuring the Nuxeo Platform as a Daemon with SysVinit
Configuring the Nuxeo Platform as a Daemon with Systemd
Installing the Nuxeo Platform on Mac OS
Installing the Nuxeo Platform on Windows
Installing the Nuxeo Platform as a Windows Service
Running Multiple Server Instances in Windows
Deploying Nuxeo on Amazon AWS
Deploying as a Standard Static WAR
Configuration Wizard
Server Start and Stop
nuxeoctl and Control Panel Usage
Registering your Nuxeo Instance
Nuxeo Cluster Architecture Introduction
Standard High Availability Nuxeo Cluster Architecture
Nuxeo Cluster Scalability Options
Nuxeo Clustering Configuration
How to Estimate Volume Usage
Nuxeo and Redis
Administration
Configuration Parameters Index (nuxeo.conf)
Configuration Templates
Sensitive Configuration Data Encryption
Security Recommendations
Setup Best Practices
HTTP and HTTPS Reverse-Proxy Configuration
Internet Information Services (IIS)
File Storage Configuration
Database Configuration
PostgreSQL
Oracle
Microsoft SQL Server
MySQL
MariaDB
MongoDB
MarkLogic
Connecting Nuxeo to the Database
H2 Limitations
Elasticsearch Setup
Kafka
Redis Configuration
Multiple Repositories Configuration
Implementing Encryption
Set Up Email Notification
Repository Configuration
Setting up a HA Configuration Using the Nuxeo Platform and PostgreSQL
Ports Usage and Firewall Considerations
VCS Read ACLs
JDBC Datasource
Admin Tab Overview
Nuxeo Shell
Nuxeo Shell Command Index
Built-in Commands
Filesystem Commands
Nuxeo Server Commands
Nuxeo Automation Commands
Configuration Commands
Nuxeo Shell Batch Mode
How to Change Context Path
Monitoring and Maintenance
Metrics and Monitoring
Backup and Restore
Logs Analysis
Purging Audit Logs (NXP_LOGS)
Remote Monitoring through HTTP/S
Remote Monitoring Through a SSH Tunnel
Transactions and Connections
Counting Documents
Monitoring Slow NXQL Queries
Garbage-Collecting Orphaned Binaries
Reporting Problems
Hotfixes Installation Notes for Nuxeo Platform LTS 2017
Upgrading the Nuxeo Platform
Upgrade from LTS 2016 following Fast Tracks
Upgrade from LTS 2016 to LTS 2017
Upgrade from LTS 2015 to LTS 2016
Upgrade from LTS 2015 following Fast Tracks
Upgrade from 6.0 to LTS 2015
Upgrade from 5.8 to 6.0
Nuxeo Platform 6.0 Packaging Changes and Deprecations
Upgrade from 5.6 to 5.8
Query Models and Result Providers Migration to Content Views and Page Providers
Upgrade from 5.5 to 5.6
Upgrade from 5.4.2 to 5.5
Upgrade from 5.4.1 to 5.4.2 with Oracle
Upgrade from 5.3.2 to 5.4.0
From the old workflow system to the new 5.4 workflow system
Upgrade to 5.4 and JBoss 5
Upgrade from 5.3.1 to 5.3.2
Upgrade from 5.3.1 with MySQL to 5.3.2
Upgrade from 5.3.0 to 5.3.1
Upgrade from 5.1.6 with JCR + PostgreSQL to 5.2.0
Upgrade from 5.1.2 to 5.1.3
Runtime and Component Model
Understanding Bundles Deployment
Writing a Bundle Manifest
Using the Java API Server-Side
Tutorials
How to Contribute to an Extension
How to create an empty bundle
Content Repository
Repository Concepts
Schema Fields
Persistence Architecture
File Storage
VCS
Internal VCS Model
VCS Tables
Examples of SQL Generated by VCS
Java Data Structures and Caching
Performance Recommendations
DBS
DBS Cache
Field Constraints and Validation
Versioning
Available Facets
Downloading Files
Deleting Documents
CMIS
WebDAV
Document Type How-To Index
Tutorials
How to Export Data Using Document Template and Automation
How to Define a Document Type
How to Override Existing Document Types
How to Add Complex Fields on Your Document Type
How to Enable the Trash Feature
How to Enable Add-Ons Features on Custom Document Type
How to Customize Document Validation
Indexing and Query
NXQL
Full-Text Queries
Page Providers
Page Provider Aggregates
Configuring the Elasticsearch Mapping
Elasticsearch Indexing Logic
Elasticsearch Highlights
Moving Load from Database to Elasticsearch
Elasticsearch Passthrough
Elasticsearch Hints Cheat Sheet
Quick Search
Indexing and Querying How-To Index
How to Fetch Documents with a Query on Date Parameters
How to Configure a New Default Search Form in the Search Tab
Using CMISQL from Java
How to Make a Page Provider or Content View Query Elasticsearch Index
How to Configure a Search Filter With Facets and Other Aggregates
Authentication and User Management
Authentication Chain Principles
Form-Based Authentication
Basic HTTP Authentication
Anonymous Authentication
LDAP and Active Directory
Generic SSO Authentication
SSO with Portals
SAML 2.0 Authentication
OAuth 2
Using OpenID / OAuth2 in Login Screen
Shibboleth Authentication
Kerberos Authentication
CAS2 Authentication
NTLM and IE Challenge/Response
Nuxeo DuoWeb Two-Factor Authentication
How to Add Custom LDAP Fields to the UI
How to Add New Fields to the User Profile or Group Profile
How to Configure a Multidirectory for Users and Groups
Authentication and User Management Tutorials
How to Define Public Pages (Viewable by Anonymous Users)
How to Implement Local Groups or Roles Using Computed Groups
Automation
Content Automation Concepts
Operations Index
Automation Chain
Automation Scripting
Contributing an Operation
Use of MVEL in Automation Chains
Calling Automation from Java
Automation Chain Exception
Debugging Automation Chains
Automation Tracing
Contributing New Input-Output Types
Returning a Custom Result with Automation
Document Templates and Automation Rendering Service
Automation REST Response
Automation Helpers
Automation How-To Index
How to Create an Automation Chain
How to Fetch a Document by Its ID or Path
How to Inherit Metadata from a Parent Document
How to Quickly Generate a PDF Using Document Template
How to Write Reusable Automation Chains
REST API
REST API Endpoints
Document Resources Endpoints
Search Resource Endpoints
Workflow and Task Resources Endpoints
Batch Upload Resource Endpoint
OAuth2 Resource Endpoint
Command Resource Endpoints
Filtering Exposed Operations
Query Endpoint (Deprecated)
REST API Entity Types
Special HTTP Headers
Content Enrichers
Error Handling
REST API Web Adapters
Request Authentication
Nuxeo API Playground
Cross-Origin Resource Sharing (CORS)
JSON Marshalling
Default JSON Marshallers
Enriching, Extending and Overriding Existing Marshallers
Creating Your Own Marshaller
Parameterizing and Reusing Marshallers
Document JSON and Extended Fields
Testing JSON Data
REST API HOWTOs
HOWTO: Upload a File in Nuxeo Using REST API
HOWTO: Contribute to the REST API
HOWTO: Develop with Angular2
HOWTO: Develop with React Redux
Workflow
Useful Definitions
Workflow Models Packaging
Runtime Instantiation & Execution Logic
Workflow Instance Properties
Workflow Node Properties
Escalation Service
About Tasks
Workflow APIs
Variables Available in the Automation Context
Workflow Audit Log
Workflow Naming Conventions
Workflow Engine FAQ
Workflow How-To Index
How to Query Workflow Objects
How to Modify a Workflow Variable outside of Workflow Context
How to Complete a Workflow Task Programmatically
How to Set Up a Tasks Dashboard
How to Refresh the Task Widget on the Summary Tab
How to Display a Button/a Tab Only When a Workflow Is Started
How to Set a Default Value on a Date Field of a Task Form
How to Follow a Transition If User Is Member of a Group
How to Make a Simple Task Assignment to One or Many Users
Security
ACLs
Nuxeo Security System
Security Policy Service
How to Grant the Edit Permission without the Remove Permission
File Download Security Policies
Audit
Data Lists and Directories
How to Add a New Vocabulary
How to Translate a Vocabulary
Directory & Vocabulary How-To Index
Directory and UI
How to Configure a New Directory Cache
Events and Listeners
Common Events
Scheduling Periodic Events
Event and Listener How To Index
How to Customize Email Templates
Advanced Topics
Integrating with JPA
Adding an Antivirus
Nuxeo Distributions
Available Installers
Trust Store and Key Store Configuration
JSF UI Framework
JSF UI Framework Overview
JSF UI How-To Index
How to Bubble Errors from the Core Layer in the JSF UI
How to Customize the Login Page
How to Override the Login Page
How to Customize Startup Redirection
How to Customize the Dashboard
How to Customize the Info-View Pop-Up
How to Customize the Error Pages
How to Activate UI Development Mode
How to Override a Template
How to Use Plug-Ins in TinyMCE Editor
How to Add a Button in the JSF UI
How to Override a Seam Component
How to Customize the Bulk Import Form
How to Customize the Bulk Edit Form
How to Customize the HTML5 Drag and Drop Import with Metadata Form
How to Enable Drag and Drop and New Button on a Custom Content View
How to Debug Slow Page Rendering
How to Make JSF UI the Default UI
Upgrade to JSF2
JSF and Ajax Tips and How-To Index
Ajax4jsf Best Practices
Ajax Forms and Actions
Double Click Shield
JSF and JavaScript
Configuring the JSF Number of Views
How to Register a JSF Tag Library
JSF troubleshoot
How to Add a JSF Form Validation
How to Impact Another JSF Component from a Command or Select
Theme
Theme How-To Index
How to Override a Default Style
How to Declare the CSS and JavaScript Resources Used in Your Templates
Layouts and Widgets (Forms, Listings, Grids)
Layout and Widget Definitions
Layout Definitions
Widget Definitions
Layout and Widget Modes
Field Binding and Expressions
Standard Layout Types
Standard Widget Types
Default Widget Types Known Limitations
Basic Widget Types
Listing Widget Types
Summary Widget Types
Tab Designer Widget Types
Decoration Widget Types
Suggestion Widget Types
Aggregate Widget Types
Advanced Widget Types
Custom Layout and Widget Templates
Custom Widget Types
Layout and Widget Display
Generic Layout Usage
Layout & Widget How-To Index
How to Add Field Validation
How to Set a Default Date on a Field at Document Creation
How to Use a Generic Widget in Layouts
How to Create a N-Level Select Widget
How to Add a New Widget to the Default Summary Layout
How to Customize the Versioning and Comment Widget on Document Edit Form
How to Control the Display Mode of a Widget
How to Make a Selection Based on the Value of Another Value in a Layout
Content Views
Content Views Display
Content View How-To Index
How to Define a New Content View
How to Customize the Default Content and Trash Listings
How to Display Non-Folderish Documents (Files, Note, ...) in the Left Tree
Documents Display Configuration
Document Views
Document Layouts
Document Content Views
Drag and Drop Service for Content Capture (HTML5-Based)
Actions (Links, Buttons, Icons, Tabs and More)
Actions Overview
Standard Action Types
Custom Action Types
Filters and Access Controls
Actions Display
Incremental Layouts and Actions
Action How-To Index
How to Make the New Button Appear on a Custom Folderish Document
How to Add a New Action Category on a Document Tab
How to Hide a Tab, a Link or a Button for a Group or a User
Document List Management
Navigation URLs
Default URL Patterns
URLs for Files
Labels and Translations Management
How to Force Locale
How to Upload Labels Translations in Nuxeo Studio (i18n)
Localization and Translation How-To Index
Additional UI Frameworks
GWT Integration
Extending The Shell
Shell Features
Shell Commands
Shell Namespaces
Shell Documentation
WebEngine (JAX-RS)
Default WebEngine Applications
Session and Transaction Management
WebEngine Tutorials
Hello World
Using FreeMarker Template Language (FTL)
Web Object Model
Working with Documents
Module Extensibility
Additional Services
File Manager
How to Change the Default Document Type When Importing a File in the Nuxeo Platform?
Nuxeo Core Import / Export API
Conversion
How to Automatically Convert a Document to PDF
How to Use PDF conversion operations with Nuxeo Studio
How to Contribute a Command Line Converter
Conversion How-To Index
Data Visualization
Collections
Preview
Tagging
Thumbnail
Publisher
Binary Metadata
Renditions
Nuxeo Stream
Work and WorkManager
Transient Store
Nuxeo Server LTS 2017 Release Notes
Nuxeo Server Roadmap
Web UI
Web UI Overview
Polymer Guide
Nuxeo Elements
Nuxeo Elements Quality Assurance
Customize Your App with Nuxeo Elements
Web UI Tutorials
Web UI Layout Elements
Web UI Routing
Web UI Customization Tutorial
HOWTO: Customize Document Layouts
HOWTO: Customize Searches
HOWTO: Customize Workflow Tasks
HOWTO: Customize Slots
HOWTO: Customize Dashboard
HOWTO: Create Custom Dashboard Entries
HOWTO: Deploy Web UI Within a Nuxeo Server
HOWTO: Customize Theme
HOWTO: Manage Translations
HOWTO: Create and Reuse a Custom element
HOWTO: Insert a User Action
HOWTO: Insert a New Tab
HOWTO: Use Web UI Internal Events
Web UI Roadmap
Desktop and Mobile
Nuxeo Drive
Nuxeo Drive Installation / Configuration
Nuxeo Drive Core Implementation
Nuxeo Drive Update Site
Nuxeo Drive User Profile Migration
How to Configure Nuxeo Drive Globally
How to Customize Nuxeo Drive Versioning Policy
How to Customize the Drive Metadata Edit Layouts
How to Manually Initialize or Deploy a Nuxeo Drive Instance
Nuxeo Drive FAQ
Nuxeo Drive Roadmap
Nuxeo Mobile
HOWTO: Customize Nuxeo Mobile Metadata Layout
HOWTO: Customize Nuxeo Mobile Themes
Nuxeo Mobile Roadmap
Nuxeo Add-Ons
Installing a New Package on Your Instance
Creating Nuxeo Packages
Package Manifest
Packaging examples
Scripting Commands
Amazon S3 Online Storage
Amazon CloudFront
Digital Asset Management (DAM)
Alternative Command Parameters for ProRes Codec Users
How to Contribute a New Video Conversion
How to Contribute Picture Conversions
Supported File Formats
Digital Signature
EasyShare
Microsoft Azure Online Storage
Nuxeo Adobe CC Connector
Nuxeo Agenda
Nuxeo Bulk Document Importer
Nuxeo CSV
How to Enable CSV Import on a Custom Document Type
Nuxeo Datadog Reporter
Nuxeo Diff
Nuxeo Diff Pictures
Nuxeo Edge Cache
Nuxeo File System Exporter
Nuxeo for Salesforce
Nuxeo Groups and Rights Audit
Nuxeo Jenkins Report
Nuxeo JSF UI
Nuxeo Lambda PictureView Conversion
Nuxeo Live Connect
Nuxeo Media Publishing
Nuxeo Multi-Tenant
Nuxeo Platform User Registration
How to Contribute a New "User Registration Request" Document Type
Nuxeo Quota
How to Enable Quotas on Document Types
Nuxeo Sample Project
Nuxeo Shibboleth Invitation
Nuxeo Spreadsheet
Nuxeo Tree Snapshot
Nuxeo Virtual Navigation
How to Add a New Virtual Navigation Entry
How to Disable by Coverage and by Subjects Virtual Navigations
Nuxeo Vision
Resources Compatibility
Scan Documents Importer
Smart Search
Template Rendering Addon
Nuxeo Connect Report Tools Web
Nuxeo 3D
Client SDKs
JavaScript Client
Java Client
Python Client
.NET Client
iOS Client
Android Client
PHP Automation Client
Using cURL
Deprecated
Java Automation Client
Tools for the Nuxeo Platform
Nuxeo CLI
Discover Nuxeo CLI by Example
Nuxeo CLI Roadmap
Nuxeo Dev Tools Extension
Contributing to Nuxeo
Is source code needed?
HOWTO: Translate the Nuxeo Platform
How to Submit a Bug Report
Nuxeo Roadmap
Licenses

University

Updated: March 31, 2025