Nuxeo Online Services

Tutorials

Updated: September 18, 2017 Page Information Edit on GitHub

Welcome on the tutorials sections of Nuxeo Studio.

The goal of this section is to provide ready to use examples. They can be followed step by step to learn how to use Studio on practical use cases. The section also aims at providing solutions to commonly encountered situations.

The configuration changes you will make in Nuxeo Studio require Development Mode to be enabled. Development Mode can be enabled on your Nuxeo server by going to Admin Center > Update Center > Nuxeo Studio and clicking the Development mode Enable button.

Nuxeo Studio Features How-Tos

Customization How-Tos Using Nuxeo Studio

Title Excerpt Topics Level Tool
Ajax Forms and Actions Learn the tips and tricks when working with Ajax forms or actions. JSF, Ajax Advanced Code
Ajax4jsf Best Practices Learn the best practices of Ajax4JSF to ensure correct rendering, HTML and testing. JSF, Ajax Advanced Code
Branding Learn how to customize your application. Theme, JSF UI Beginner Studio
Deploying as a Standard Static WAR This page provides instructions to generate a static WAR distribution and deploy it in a Tomcat server. Distribution, Static WAR Advanced Terminal
Develop with Nuxeo Platform Learn how to start working with Nuxeo CLI. Automation, Layout Intermediate Nuxeo CLI, Nuxeo Studio
Double Click Shield Learn how to use the "Double Click Shield" feature. JSF, Ajax, jQuery Advanced Code
Getting Started with Nuxeo Studio Learn how to start working with Nuxeo Studio. Document type, Style Beginner Nuxeo Studio
HOWTO: Create Custom Dashboard Entries Learn the basics of a Nuxeo module and is IDE agnostic. Bundle Advanced Code
HOWTO: Create and Reuse a Custom element Learn how to create and reuse a custom element in Studio Designer. Web UI Advanced code
HOWTO: Customize Dashboard Learn how to customize the Web UI dashboard Web UI Advanced code
HOWTO: Customize Document Layouts Learn how to use document layouts with Web UI and Studio Designer Web UI, Studio Designer Intermediate Studio Designer, code
HOWTO: Customize Nuxeo Mobile Metadata Layout This how-to explains how to customize Nuxeo Mobile metadata layout. Nuxeo Mobile Intermediate JSON Extention
HOWTO: Customize Nuxeo Mobile Themes This how-to explains how to customize Nuxeo Mobile themes. Nuxeo Mobile Intermediate JSON Extention
HOWTO: Customize Searches Learn how to create a new search screen with Studio Designer. Web UI, Studio Designer Intermediate Studio Designer, code
HOWTO: Customize Slots Learn how to use Nuxeo Slots with Web UI. Web UI Advanced code
HOWTO: Customize Theme Learn how to customize themes in Nuxeo Web UI. Web UI Advanced code
HOWTO: Customize Workflow Tasks Learn how to customize your workflow tasks Web UI Advanced code
HOWTO: Deploy Web UI Within a Nuxeo Server Learn how to deploy Web UI within a Nuxeo server. Web UI Advanced code
HOWTO: Develop with React Redux Learn how to develop with React Redux. REST API Advanced Code
HOWTO: Insert a New Pill Learn how to insert a new pill on your custom document type Web UI Intermediate Designer
HOWTO: Insert a User Action Learn how to insert a new user action using the Studio Designer Web UI, Studio Designer Intermediate null
HOWTO: Manage Translations Learn how to manage translations in Nuxeo Web UI. Web UI Advanced code
HOWTO: Nuxeo API Playground Learn how to use the API Playground and leverage the Nuxeo REST API. REST API Advanced Code
HOWTO: Translate the Nuxeo Platform Learn how to translate the Nuxeo Platform Labels, Localization, Translation Advanced Crowdin
HOWTO: Upload a File in Nuxeo Using REST API Learn how to import a file using the Batch processing endpoint of the REST API. Import, REST API Advanced Code
How to Activate UI Development Mode Learn how to activate the UI development mode to get details about elements in the UI. JSF UI Beginner Code
How to Add Complex Fields on Your Document Type Learn how to add complex fields on a document type. Document type, Schema Beginner Studio
How to Add Custom LDAP Fields to the UI Learn how to add a custom LDAP fields to the User interface using XML extensions. Authentication, LDAP Advanced XML extension
How to Add Field Validation Learn how to create a validator on a field with Nuxeo Studio and Nuxeo IDE. Layout, JSF, Validation Advanced Studio, Nuxeo IDE
How to Add New Fields to the User Profile or Group Profile This page provides a turnkey solution to add new fields to the user profile or group. LDAP, Multidirectory Intermediate XML configuration
How to Add New Relation Types Learn how to customize the relations predicates and add new types of relations. Vocabulary Beginner Nuxeo Platform
How to Add a Button in the JSF UI Learn how to add new buttons at different locations in the JSF UI using user actions and automation (in a document contextual tools or on a document Edit form for instance). Automation, Extension, Tab, User action, JSF UI Beginner Studio, XML extension
How to Add a JSF Form Validation Learn how to add a JSF form validation to a JSF component to validate a field. Layout, JSF UI, Validation Advanced Code
How to Add a New Action Category on a Document Tab This page explains how to create new actions categories to add links or buttons on the custom tab of documents, using Nuxeo Studio. Document type, Tab, User action, Widget Beginner Studio
How to Add a New Virtual Navigation Entry Learn how to configure a virtual navigation view with Nuxeo Studio. Content View, Virtual Navigation, Vocabulary Intermediate Studio
How to Add a New Vocabulary Learn how to create a vocabulary using Nuxeo Studio. Vocabulary Beginner Studio
How to Add a New Widget to the Default Summary Layout Learn how to insert a new widget to the default Summary layout so that's displayed on all document Summary pages. Layout, JSF UI Advanced Studio
How to Automatically Convert a Document to PDF Learn how to convert automatically a document into PDF using Nuxeo Studio. Document type, Automation, Conversion Intermediate Studio
How to Bubble Errors from the Core Layer in the JSF UI Learn how to bubble errors from the core layer in the  UI. JSF UI Advanced Code editor
How to Change Context Path The Nuxeo Platform offers the capability to change the context path, i.e. /nuxeo in the URL of your application. Server configuration, URL Intermediate
How to Collaborate on a Studio Project Learn how to use the advanced branch management feature of Nuxeo Studio to collaborate on a Studio project. Branch Management, Studio Tags Beginner Studio
How to Complete a Workflow Task Programmatically Learn how to complete a workflow task programmatically. Workflow, Task Advanced Studio
How to Configure a Multidirectory for Users and Groups This page provides a turnkey solution to configure a multidirectory. LDAP, Multidirectory Intermediate XML configuration
How to Configure a New Default Search Form in the Search Tab Learn how to add a new search search Content View, Elasticsearch, Query Beginner Studio
How to Configure a New Directory Cache Learn how to define a new directory cache and use it in your directoy. Directory, Vocabulary Intermediate XML Extension
How to Configure a Search Filter With Facets and Other Aggregates Learn how to use the Elasticsearch aggregate widgets. Content View, Elasticsearch, Query, Widget Intermediate Studio
How to Contribute Picture Conversions Learn how to contribute new picture conversions. Conversion, DAM Advanced XML Extension
How to Contribute a Command Line Converter Learn how to contribute a new command line converter. Conversion Advanced XML Extension
How to Contribute a New "User Registration Request" Document Type Learn how to contribute new request types to the add-on. User registration Intermediate Studio
How to Contribute a New Video Conversion Learn how to contribute a new video conversion to convert a video to WebM format. Conversion, DAM Advanced XML extension, Code
How to Contribute to an Extension Lean how to create an XML extension in Nuxeo Studio, with the Nuxeo CLI and how to override a Nuxeo contribution. Extension point Intermediate Nuxeo CLI, Studio
How to Control the Display Mode of a Widget Learn how to be able to control the display mode of a widget. Nuxeo Studio enables you to implement your requirements using an expression when you configure your widget. Layout, Widget Advanced Studio
How to Create an Automation Chain This how-to explains the different steps to create and configure an automation chain using Nuxeo Studio. Automation, Event handler, User action Beginner Studio
How to Customize Document Validation Leans how to customize the document validation error messages and how to add new references validation on document types. Document Type, Validation Advanced Code Editor
How to Customize Email Templates Learn how to create new alert email or override existing alert emails with Nuxeo Studio. Alerts Beginner Studio
How to Customize Nuxeo Drive Versioning Policy This how-to explains how to change Nuxeo Drive's default versioning policy. Nuxeo Drive, Versioning Intermediate XML Extention
How to Customize Startup Redirection Learn how to customize startup redirection so users are displayed the default Nuxeo dashboard. JSF UI Advanced Code editor
How to Customize the Bulk Edit Form Learn how to customize the bulk edit form using Nuxeo Studio. Bulk edit, JSF UI Intermediate Studio
How to Customize the Bulk Import Form Learn how to customize the bulk import form using Nuxeo Studio. Bulk import, JSF UI Intermediate Studio
How to Customize the Dashboard Learn how to customize the dashboard by adding new entries or completely override the default dashboard. JSF UI Advanced Studio, Code
How to Customize the Default Content and Trash Listings Learn how to customize the default content and trash listings using Nuxeo Studio. Content View Intermediate Studio
How to Customize the Drive Metadata Edit Layouts Learn how to use a customized layout on the Metadata edit of Nuxeo Drive. Layout, Nuxeo Drive Intermediate Studio
How to Customize the Error Pages Learn how to customize the error pages. Theme, JSF UI Advanced Code editor
How to Customize the HTML5 Drag and Drop Import with Metadata Form Learn how to customize the drag and drop HTML5 import with metadata form. Drag and Drop, Layout Beginner Studio
How to Customize the Info-View Pop-Up Learn how to customize the info-view pop-up using an XML extension or Nuxeo Studio. Info-view, JSF UI Advanced Code editor
How to Customize the Login Page Learn how to customize the login page using an XML extension. Theme, JSF UI Beginner Code editor
How to Customize the Versioning and Comment Widget on Document Edit Form Learn how to customize the versioning and comment widget using XML extensions. These examples can be contributed in Nuxeo Studio (Advanced Settings > XML Extensions) or with Nuxeo CLI. Layout, Versioning, JSF UI, Widget Intermediate XML extension, Nuxeo CLI, Studio
How to Debug Slow Page Rendering Learn how to debug slow page rendering. JSF UI Advanced Code
How to Declare the CSS and JavaScript Resources Used in Your Templates Learn how to declare and add the CSS and JavaScript ressources in your templates. Theme Advanced Code editor
How to Define Public Pages (Viewable by Anonymous Users) Learn how to make some pages visible by anonymous users. Access rights Advanced Code
How to Define a Document Type Learn how to create a new document type using Nuxeo Studio. Document type Beginner Studio
How to Define a New Content View Learn how to configure a new content view with Nuxeo Studio. Content View Beginner Studio
How to Disable by Coverage and by Subjects Virtual Navigations Learn how to disable the existing By Coverage and By Subjects virtual navigations with Nuxeo Studio. Content View, Virtual Navigation Advanced Studio, XML extensions
How to Display Non-Folderish Documents (Files, Note, ...) in the Left Tree Learn how to display non-folderish documents in the left tree with Nuxeo Studio. Content View Advanced Studio, XML extensions
How to Display a Button/a Tab Only When a Workflow Is Started Learn how to display a tab or a button when a workflow is started. Workflow Intermediate Studio
How to Enable Add-Ons Features on Custom Document Type Learn how to apply features provided by add-ons on your document type. Document type Intermediate Studio
How to Enable CSV Import on a Custom Document Type If you installed the Nuxeo CSV add-on from the Nuxeo Marketplace, you'll probably want to enable CSV import on the document types you defined. Here is how to do that. Document type, Nuxeo CSV Beginner Studio
How to Enable Drag and Drop and New Button on a Custom Content View Make a custom content view look like the default Content tab. Content view, Tab, JSF UI, UI Beginner Studio
How to Enable Quotas on Document Types Learn how to enable Nuxeo Quota features on document types other than domains and workspaces. Document type, Nuxeo Quota, Statistics Beginner Nuxeo Studio
How to Enable the Trash Feature Learn how to enable the trash feature on your document type using Nuxeo Studio. Document type, Life cycle Beginner Studio
How to Estimate Volume Usage Get some guidelines to estimate the required size for disk and database. Database Intermediate
How to Export Data Using Document Template and Automation Learn how to generate a CSV file listing all the documents of your Nuxeo Platform repository. Automation, Document template Beginner Studio
How to Fetch Documents with a Query on Date Parameters Learn how to make it possible to process documents depending on a date parameter. Automation, Content view Intermediate Studio
How to Fetch a Document by Its ID or Path Learn how to use the operation Document.Fetch to get a document by its ID or its path. Automation Intermediate Studio
How to Follow a Transition If User Is Member of a Group Learn how to follow a transition if the user is member of a particular group. Workflow, Transition Advanced Studio
How to Force Locale Learn how to force the locale by removing other locales support Localization Advanced XML extensions
How to Grant the Edit Permission without the Remove Permission Learn how to override the default Edit permission so it does not include Remove by default, and set a new ReadWriteAndRemove permission. Permissions Intermediate XML Extension
How to Hide a Tab, a Link or a Button for a Group or a User Learn how to hide an action for a group or a user. Filter, User action, JSF UI Advanced Code editor
How to Impact Another JSF Component from a Command or Select Learn how to impact another JSF component from a Command or Select. Layout, JSF UI Advanced Nuxeo IDE
How to Implement Features Using Branches Learn how to use the advanced branch management features of Nuxeo Studio to get a production and a feature branch. Branch Management, Studio Tags Intermediate Studio
How to Implement Local Groups or Roles Using Computed Groups Learn how to let managers of a workspace determine who is part of locally defined groups (local to the workspace). Permissions Advanced Studio
How to Inherit Metadata from a Parent Document In this how-to, we will implement an event handler that will listen to the creation of documents. When the created document matches some predefined criteria, the listener will execute a content automation chain. The chain will copy the "source" metadata value from the workspace to the created document. Automation, Event handler Beginner Studio
How to Make Web UI the Default UI Learn how to make the new Web UI the default UI instead of the JSF UI. Web UI, JSF UI Beginner XML Extension
How to Make a Page Provider or Content View Query Elasticsearch Index Learn how to make a content view query Elasticsearch instead of the Core API. Content view, Elasticsearch, Query Beginner Studio
How to Make a Selection Based on the Value of Another Value in a Layout Use the extensibility features of the Select2 widget to make a selector which can suggest values based on a different widget's value Layout Intermediate Studio
How to Make a Simple Task Assignment to One or Many Users Learn how to create a task and assign it to one or many users. Workflow, Automation, Task Intermediate Studio
How to Make the New Button Appear on a Custom Folderish Document This page explains how to add the New button on the default Content tab and on a custom tab. Document type, Tab, User action Beginner Studio
How to Modify a Workflow Variable outside of Workflow Context Learn how to modify a workflow outside of the workflow context. Workflow, Event, Listener Advanced Studio
How to Override Existing Document Types Learn how to override an existing document type in Nuxeo Studio. Document type, Override Beginner Studio
How to Override a Default Style Learn how to override a default style. Here's an how-to taking as example the override of the "feedback message" styling. Theme, Style Advanced Code editor
How to Override a Seam Component Learn how to override a seam component. JSF UI, Seam JSF Webapp Advanced Nuxeo CLI, code
How to Override a Template Learn how to override a Nuxeo template. JSF UI Advanced Code
How to Override the Login Page Learn how to override the login page. Theme, JSF UI Advanced Code editor
How to Query Workflow Objects Learn how to query workflow objects using NXQL. Workflow, NXQL, Query Advanced Studio
How to Quickly Generate a PDF Using Document Template Learn how to get a PDF printable version of the data stored on your document as properties using Nuxeo Studio. Automation, Conversion, Document template Beginner Studio
How to Refresh the Task Widget on the Summary Tab Learn how to refresh the task widget on the Summary tab. Workflow, Widget Advanced Studio
How to Register a JSF Tag Library Learn how to use the JSF tag library registration. JSF Advanced Code
How to Set Up a Tasks Dashboard Learn how to manage a tasks dashboard. Workflow, Dashboard Advanced Studio
How to Set a Default Date on a Field at Document Creation Learn how to set a default date on a field at document creation using Nuxeo Studio's event handlers and automation chains. Layout, Event Advanced Studio, Nuxeo CLI
How to Set a Default Value on a Date Field of a Task Form Learn how to set a value by default on a date field. Workflow Advanced Studio
How to Tag or Release Your Nuxeo Studio Project Learn how to use the tags and releases features of Nuxeo Studio. Branch Management, Studio Tags Intermediate Studio
How to Translate a Vocabulary Learn how to translate an existing vocabulary. Vocabulary Beginner Studio
How to Unit Test a Studio Bundle Learn how to unit test a Studio Bundle Nuxeo Studio, Unit test Advanced Code, Nuxeo Studio
How to Upload Labels Translations in Nuxeo Studio (i18n) Learn how to upload your own translation of labels in Nuxeo Studio. Labels, Localization, Translation Advanced Studio
How to Use PDF conversion operations with Nuxeo Studio Learn how to use all operations that offers PDF tools operations from Nuxeo Studio: Watermarks, page numbers, document merging... Document type, Automation, Conversion Intermediate Studio
How to Use Plug-Ins in TinyMCE Editor Learn how to customize TinyMCE by adding new plug-ins. We will use the textcolor plug-in as an example. Plug-ins, TinyMCE, JSF UI Intermediate Code
How to Use a Generic Widget in Layouts Learn how to use a generic widget in Studio. Layout, Widget Advanced Studio
How to Work with Maintenance Branches Learn how to use the advanced branch management feature of Nuxeo Studio to get a production and a maintenance branch. Branch Management, Studio Tags Intermediate Studio
How to Write Reusable Automation Chains Learn how to factorize similar automation chains. Automation Intermediate Studio
How to create an empty bundle Learn the basics of a Nuxeo module and is IDE agnostic. Bundle Advanced Code
JSF and JavaScript Learn how to get a tag client using DOM. JSF, JavaScript Advanced Code
JSF troubleshoot Discover the troubleshooting issues that can be encountered with JSF. JSF Advanced Code
Query Endpoint (Deprecated) This how-to provides an example of how to use the REST API to query the Nuxeo repository. Query, REST API Advanced Code
Search Resource Endpoints This how-to provides some examples of how to use the REST API to query the Nuxeo repository, as well as to save these queries and later reproduce them. Query, REST API Advanced Code
Using CMISQL from Java Learn how to make CMISQL queries from Java code inside a Nuxeo bundle. CMIS, Query Advanced Code
Web UI Customization Tutorial Learn how to customize Web UI and deploy your customization. Web UI Advanced code
Workflow and Task Resources Endpoints This how-to provides an example of how to use the workflow REST API. Worklow, REST API Advanced Code

 

 

a month ago GitHub Fix formatting
3 years ago Solen Guitter 9
3 years ago Solen Guitter 8
3 years ago Solen Guitter 7
3 years ago Solen Guitter 6
4 years ago Harlan Brown 5
5 years ago Frédéric Vadon 3
5 years ago Frédéric Vadon 4
5 years ago Alain Escaffre 2
5 years ago Alain Escaffre 1
History: Created by Alain Escaffre