Developer Documentation
From JSF UI to Web UI
Getting Started
Quick Overview
Tutorials
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
First Package With Studio
Develop Your Own Java Code
Deploy and Publish
Use Cases
Bootstrap Your Document Management Project
Bootstrap Your Case Management Project
Best Practices
Choosing How to Import Data in the Nuxeo Platform
Understand Expression and Scripting Languages Used in Nuxeo
Essential Nuxeo Platform Terminology
How-To Index
Server
Installation
Compatibility Matrix
Install Nuxeo with the Docker Image
Quickstart with Nuxeo Platform and Docker
Build a Custom Docker Image
Install Nuxeo With the ZIP Distribution
Installing and Setting Up Related Software
Server Start and Stop
Linux Tutorials
Configuring the Nuxeo Platform as a Daemon with SysVinit
Configuring the Nuxeo Platform as a Daemon with Systemd
Windows Tutorials
Installing the Nuxeo Platform as a Windows Service
Running Multiple Server Instances in Windows
Install in Kubernetes With Nuxeo Helm Chart
Nuxeo Cluster Architecture
Nuxeo Architecture Introduction
Nuxeo Architecture Components
Load Balancers
Reverse Proxy
Nuxeo Server
File Storage
Data Storage
Search Engines
Messaging system
PubSub Service
Nuxeo Reference Architectures
Compact Architecture with Kafka
Distributed Architecture with Kafka
Nuxeo Scalability Options
nuxeoctl and Control Panel Usage
Registering your Nuxeo Instance
Nuxeo Storage Alternatives
How to Estimate Volume Usage
Platform as a Service
Administration
Configuration Parameters Index (nuxeo.conf)
Configuration Templates
Maintenance
Backup and Restore
Purging Audit Logs (NXP_LOGS)
Counting Documents
Garbage-Collecting Orphaned Blobs
Garbage-Collecting Orphaned Binaries (deprecated)
Nuxeo Admin Console
Admin Console Release Notes
Reporting Problems
Hotfixes Installation Notes
JSF UI Admin Tab Overview
Monitoring and Observability
Health Check
Logs
Metrics
Tracing
Profiling
Sensitive Configuration Data Encryption
Performances
Managing Performance
Tracking the Performance of the Nuxeo Platform
Security Recommendations
Setup Best Practices
HTTP and HTTPS Reverse-Proxy Configuration
Internet Information Services (IIS)
File Storage Configuration
Database Configuration
MongoDB
PostgreSQL
MySQL
MariaDB
Oracle
Microsoft SQL Server
Connecting Nuxeo to the Database
H2 Limitations
Search Setup
Kafka
Multiple Repositories Configuration
Implementing Encryption
Trust Store and Key Store Configuration
Set Up Email Notification
WorkManager Dead Letter Queue (DLQ)
Repository Configuration
Ports Usage and Firewall Considerations
VCS Read ACLs
JDBC Datasource
Nuxeo Shell
Nuxeo Shell Command Index
Built-in Commands
Filesystem Commands
Nuxeo Server Commands
Nuxeo Automation Commands
Configuration Commands
Nuxeo Shell Batch Mode
Extending The Shell
Shell Features
Shell Commands
Shell Namespaces
Shell Documentation
HOWTO: Change Context Path
HOWTO: Clean Up Content
Upgrade
Upgrade from LTS 2023 to LTS 2025
How to upgrade to LTS 2025.0
How to upgrade to Jakarta EE 10
How to upgrade to Jakarta RS 3 - WebEngine
How to upgrade to New Search Service
How to upgrade Nuxeo REST Tests
How to upgrade Nuxeo Audit Service
Upgrade from LTS 2021 to LTS 2023
Upgrade from LTS 2019 to LTS 2021
Upgrade from LTS 2017 to LTS 2019
Upgrade from LTS 2017 following Fast Tracks
Upgrade from LTS 2016 to LTS 2017
Upgrade from LTS 2016 following Fast Tracks
Upgrade from LTS 2015 to LTS 2016
Upgrade from LTS 2015 following Fast Tracks
Upgrade from 5.8 to 6.0
Upgrade from 5.6 to 5.8
Upgrade from 5.3.2 to 5.4.0
From the old workflow system to the new 5.4 workflow system
REST API
REST API Endpoints
Document Resource Endpoints
Search Resource Endpoints
Workflow and Task Resource Endpoints
Batch Upload Resource Endpoint
OAuth2 Resource Endpoint
Command 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
Allowed Hosts Configuration
CMIS
Cross-Origin Resource Sharing (CORS)
JSON Marshalling
Default JSON Marshallers
Overriding Existing Marshallers
Creating Your Own Marshaller
Parameterizing and Reusing Marshallers
Document JSON and Extended Fields
Testing JSON Data
WebDAV
REST API HOWTOs
HOWTO: Upload a File in Nuxeo Using REST API
HOWTO: Contribute to the REST API
HOWTO: Develop with Angular2
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
Authentication and User Management Tutorials
How to Add Custom LDAP Fields to the UI
How to Define Public Pages (Viewable by Anonymous Users)
HOWTO: Add New Fields to the User or Group Schema
HOWTO: Assign a Task to the User Manager
How to Configure a Multidirectory for Users and Groups
HOWTO: Implement Local Groups or Roles Using Computed Groups
Data Store
Data Modeling
Field Constraints and Validation
Schema Fields
Versioning
Available Facets
Downloading Files
Audit
Data Lists and Directories
Directory and UI
HOWTO: Add a New Vocabulary
HOWTO: Translate a Vocabulary
HOWTO: Configure a New Directory Cache
HOWTO: Populate a Directory With a CSV File
Tutorials
HOWTO: Export Data Using Document Template and Automation
HOWTO: Define a Document Type
HOWTO: Override Existing Document Types
HOWTO: Add Complex Fields on Your Document Type
HOWTO: Use the Trash Feature
HOWTO: Enable Addons Features on Custom Document Type
HOWTO: Customize Document Validation
Persistence Architecture
File Storage
Visible Content Store (VCS)
Internal VCS Model
VCS Tables
Examples of SQL Generated by VCS
Java Data Structures and Caching
Performance Recommendations
Document-Based Storage (DBS)
DBS Cache
Indexing and Query
NXQL
Full-Text Queries
Page Providers
Page Provider Aggregates
Configuring the Search Mapping
Search Indexing Logic
Search Highlights
Moving Load from Database to Search Engine
Search Passthrough
NXQL Hints Cheat Sheet
HOWTO: Expose OpenSearch/Elasticsearch Hint as Extension Point
Quick Search
Indexing and Querying How-To Index
HOWTO: Fetch Documents with a Query on Date Parameters
HOWTO: Configure a New Default Search Form in the Search Tab
Using CMISQL from Java
HOWTO: Make a Page Provider or Content View Query OpenSearch Index
HOWTO: Configure a Search Filter With Facets and Other Aggregates
Security
ACLs
Nuxeo Security System
Security Policy Service
HOWTO: Grant the Edit Permission without the Remove Permission
File Download Security Policies
Events and Messages
Common Events
Scheduling Periodic Events
Nuxeo Stream
Work and WorkManager
Bulk Action Framework
Bulk Actions Directory
Events and Messages How To Index
HOWTO: Customize Email Templates
Platform Services
Automation
Content Automation Concepts
Operations Index
Automation Chain
Automation Scripting
Contributing an Operation
Use of MVEL in Automation Chains
Calling Automation from Java
Calling Automation Using cURL
Automation Chain Exception
Debugging Automation Chains
Automation Tracing
Contributing New Input-Output Types
Returning a Custom Result with Automation
Document Templates and Automation Rendering
Automation REST Response
Automation Helpers
Automation How-To Index
HOWTO: Manage Relations on a Document
HOWTO: Create an Automation Chain
HOWTO: Fetch a Document by Its ID or Path
HOWTO: Inherit Metadata from a Parent Document
HOWTO: Quickly Generate a PDF Using Document Template
HOWTO: Write Reusable Automation Chains
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
HOWTO: Query Workflow Objects
HOWTO: Modify a Workflow Variable outside of Workflow Context
HOWTO: Complete a Workflow Task Programmatically
HOWTO: Set Up a Tasks Dashboard
HOWTO: Refresh the Task Widget on the Summary Tab
HOWTO: Display a Button/a Tab Only When a Workflow Is Started
HOWTO: Set a Default Value on a Date Field of a Task Form
HOWTO: Programmatically test a workflow
HOWTO: Add a "Save Work in Progress" Option on a Task
HOWTO: Follow a Transition If User Is Member of a Group
HOWTO: Make a Simple Task Assignment to One or Many Users
Conversion
HOWTO: Automatically Convert a Document to PDF
HOWTO: Use PDF conversion operations with Nuxeo Studio
HOWTO: Contribute a Command Line Converter
Conversion How-To Index
File Manager
HOWTO: Change the Default Document Type When Importing a File in the Nuxeo Platform?
Import / Export API
Data Visualization
Collections
Preview
Tagging
Thumbnail
Trash Service
Publisher
Binary Metadata
WebEngine (Jakarta-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
Renditions
Transient Store
Comments / Annotations
Batch Handler
Runtime and Component Model
Understanding Bundles Deployment
Tutorials
HOWTO: Contribute to an Extension
HOWTO: Use the Runtime Java API
HOWTO: Create an Empty Bundle
HOWTO: Write a Bundle Manifest
HOWTO: Create a Service
HOWTO: Define a Runtime XMap Object
Nuxeo Integration
Call an External Application From Nuxeo
Call Nuxeo From an External Application
Nuxeo Server Tutorials
Nuxeo Server LTS 2025 Release Notes
LTS 2025.0 / LTS 2025-HF00
Nuxeo Platform and Data Privacy
Nuxeo Release Cycle
Advanced Topics
Integrating with JPA
Adding an Antivirus
Nuxeo Distributions
Web UI
Web UI Overview
Polymer Guide
Nuxeo Elements
Nuxeo Elements Quality Assurance
Customize Your App with Nuxeo Elements
Notify Behavior
Web UI Performance
Web UI Tutorials
Web UI Layout Elements
Web UI Routing
Web UI Customization Tutorial
Web UI Upload Providers
Web UI Diff
Web UI Translations
Translation Label Conventions
HOWTO: Manage Translations
HOWTO: Add a Header and a Footer to Web UI
Bulk Actions in Web UI
HOWTO: Create a Bulk Action Using Nuxeo Studio
HOWTO: Create a Bulk Edit Form Using Nuxeo Studio
HOWTO: Create an Actions Menu
HOWTO: Create and Reuse a Custom Element
HOWTO: Create Custom Dashboard Entries
HOWTO: Configure Searches
HOWTO: Create Searches With OR Operator
HOWTO: Configure Web UI Global Settings
HOWTO: Customize Dashboard
HOWTO: Customize Document Layouts
HOWTO: Customize Slots
HOWTO: Customize the Creation Form
HOWTO: Customize Workflow Tasks
HOWTO: Customize the Default Document View
HOWTO: Customize Default Rendition in Web UI
HOWTO: Customize Theme
HOWTO: Deploy Web UI Within a Nuxeo Server
HOWTO: Disable Trash Actions, Tab and Search
HOWTO: Display User Information
HOWTO: Display a Children Documents Listing
HOWTO: Create Custom Buttons
HOWTO: Filter Data in Suggestions
HOWTO: Insert a Button
HOWTO: Insert a New Search Tab
HOWTO: Trigger an Automation From a Dialog
HOWTO: Use Web UI Internal Events
HOWTO: Use the Rich Text Editor (RTE) for Article Publishing
HOWTO: Validate a Layout Content
Web UI Release Notes
Version 2025.2.0
Web UI Upgrade Notes
Web UI Accessibility - Section 508, WCAG Conformance VPAT
Web UI Functional Tests
Digital Asset Management
Upload & Store
Manage & Organize
Search & Find
Share & Distribute
Product Overview
Alternative Command Parameters
HOWTO: Contribute Video Conversion
HOWTO: Contribute Picture Conversion
Supported File Formats
Addons
Installing a New Package on Your Instance
Nuxeo Platform Features
Creating Nuxeo Packages
Package Manifest
Packaging examples
Scripting Commands
Amazon S3 Online Storage
Amazon CloudFront
Amazon S3 Direct Upload for Web UI
Nuxeo Mail Amazon SES
Digital Signature
EasyShare
Explorer
Google Storage
Microsoft Azure Online Storage
Nuxeo for Adobe CC
HOWTO: Customize Adobe Connector Default Tabs
Nuxeo AI
Nuxeo Aspera Connector
Nuxeo Aspera Release Notes
Nuxeo Aspera 2021.3.6
Nuxeo Aspera 2021.3.4
Nuxeo Aspera 2021.3.3
Nuxeo Aspera 2021.3.1
Nuxeo Aspera Upgrade Notes
Nuxeo Bulk Document Importer
Nuxeo Cold Storage
Installation and Configuration
Cold Storage FAQ
Nuxeo Compound Documents
Nuxeo CSV
How to Enable CSV Import on a Custom Document Type
Nuxeo Enhanced Viewer
Installation and Configuration
HOWTO: Import Documents With Nev Annotations
HOWTO: Make the Enhanced Viewer the Default Previewer
HOWTO: Use Content Redaction
HOWTO: Use Nuxeo Renditions on Nuxeo Enhanced Viewer
Nuxeo Enhanced Viewer Release Notes
NEV 2.3.0
NEV 2021.1.1
Nuxeo Federation Framework
Nuxeo File System Exporter
Nuxeo Frame.io Connector
Nuxeo Groups and Rights Audit
Nuxeo JSF UI
User Documentation JSF UI
Nuxeo Platform Concepts
User Home
User Preferences
Browsing Content
Collections
Tags
Preview
Managing Permissions
Document Types in JSF UI
Attachments
Using Workspace Templates
Creating Content
Editing Content
Working with WebDAV
Traceability
Deleting Content
Collaborative Features
Searching the Nuxeo Platform
Default Search
Quick Search
Saved Searches
Workflows
Serial Document Workflow
Parallel Document Workflow
Delegating a Task
Reassigning a Task
Abandoning a Workflow
Publishing Content
Exporting Documents
Local Configuration
Managing Your Nuxeo Application
Managing Users and Groups
Managing Vocabularies
HOWTO: Add New Relation Types
Case Management with the Nuxeo Platform
JSF UI Framework
Cross validation with JSF
JSF UI Framework Overview
Upgrade to JSF2
Theme
Theme How-To Index
HOWTO: Override a Default Style - JSF UI
HOWTO: Declare the CSS and JavaScript Resources Used in Your Templates - JSF UI
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
HOWTO: Add Field Validation - JSF UI
HOWTO: Set a Default Date on a Field at Document Creation - JSF UI
HOWTO: Use a Generic Widget in Layouts - JSF UI
HOWTO: Create a N-Level Select Widget - JSF UI
HOWTO: Add a New Widget to the Default Summary Layout - JSF UI
HOWTO: Customize the Versioning and Comment Widget on Document Edit Form - JSF UI
HOWTO: Control the Display Mode of a Widget - JSF UI
HOWTO: Make a Selection Based on the Value of Another Value in a Layout - JSF UI
Content Views
Content Views Display
Content View How-To Index
HOWTO: Define a New Content View - JSF UI
HOWTO: Customize the Default Content and Trash Listings - JSF UI
HOWTO: Display Non-Folderish Documents (Files, Note, ...) in the Left Tree - JSF UI
Documents Display Configuration
Document Views
Document Layouts
Document Content Views
Drag and Drop Service for Content Capture
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
HOWTO: Make the New Button Appear on a Custom Folderish Document - JSF UI
HOWTO: Add a New Action Category on a Document Tab - JSF UI
HOWTO: Hide a Tab, a Link or a Button for a Group or a User - JSF UI
Document List Management
Navigation URLs
Default URL Patterns
URLs for Files
Labels and Translations Management
HOWTO: Force Locale - JSF UI
HOWTO: Upload Labels Translations in Nuxeo Studio (i18n)
Localization and Translation How-To Index
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
HOWTO: Register a JSF Tag Library
JSF troubleshoot
HOWTO: Add a JSF Form Validation
HOWTO: Impact Another JSF Component from a Command or Select
JSF UI How-To Index
HOWTO: Bubble Errors from the Core Layer - JSF UI
HOWTO: Customize the Login Page - JSF UI
HOWTO: Override the Login Page - JSF UI
HOWTO: Customize Startup Redirection - JSF UI
HOWTO: Customize the Dashboard - JSF UI
HOWTO: Customize the Info-View Pop-Up - JSF UI
HOWTO: Customize the Error Pages - JSF UI
HOWTO: Activate UI Development Mode - JSF UI
HOWTO: Override a Template - JSF UI
HOWTO: Use Plug-Ins in TinyMCE Editor - JSF UI
HOWTO: Add a Button - JSF UI
HOWTO: Override a Seam Component - JSF UI
HOWTO: Customize the Bulk Import Form - JSF UI
HOWTO: Customize the Bulk Edit Form - JSF UI
HOWTO: Customize the HTML5 Drag and Drop Import with Metadata Form - JSF UI
HOWTO: Enable Drag and Drop and New Button on a Custom Content View - JSF UI
HOWTO: Debug Slow Page Rendering - JSF UI
HOWTO: Make JSF UI the Default UI
HOWTO: Display a Button/a Tab Only When a Workflow Is Started - JSF UI
Nuxeo Live Connect
Nuxeo Multi-Tenant
Nuxeo Office Online Integration
Nuxeo Outlook Connector
Nuxeo Platform User Registration
How to Contribute a New "User Registration Request" Document Type
Nuxeo Quota
How to Enable Quotas on Document Types
Nuxeo Retention Management
Installation and Configuration
Standard Mode
Strict Mode
Functional Overview
Technical Overview
HOWTO: Ensure File Deletion Audit
HOWTO: Undeclare Records
HOWTO: Retain Multiple Files
Nuxeo Salesforce Connector
Nuxeo Salesforce Release Notes
Nuxeo Sample Project
Nuxeo SCIM 2.0
Nuxeo Showcase Content
Nuxeo Sitecore Connector
Nuxeo Spreadsheet
Nuxeo Tree Snapshot
Nuxeo Virtual Navigation
HOWTO: Add a New Virtual Navigation Entry
HOWTO: Disable by Coverage and by Subjects Virtual Navigations
Nuxeo Zapier Integration
Scan Documents Importer
Template Rendering Addon
Nuxeo 3D
Nuxeo Keycloak
Client SDKs
JavaScript Client
Java Client
Python Client
.NET Client
PHP Automation Client
Tools for the Nuxeo Platform
Nuxeo CLI
Discover Nuxeo CLI by Example
Nuxeo Dev Tools Extension
Nuxeo DevContainer
Contributing to Nuxeo
Is source code needed?
HOWTO: Translate the Nuxeo Platform
How to Submit a Bug Report
Nuxeo Release Notes
Licenses

University Index

Updated: May 7, 2025