Studio

Tutorials

Updated: September 11, 2020

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
3 - Develop with Nuxeo Platform Learn how to start working with Nuxeo CLI. Automation, Layout Intermediate Nuxeo CLI, Nuxeo Studio
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
Double Click Shield Learn how to use the "Double Click Shield" feature. JSF, Ajax, jQuery Advanced Code
HOWTO: Activate UI Development Mode - JSF UI Learn how to activate the UI development mode to get details about elements in the UI. JSF UI Beginner Code
HOWTO: Add Complex Fields on Your Document Type Learn how to add complex fields on a document type. Document type, Schema Beginner Studio
HOWTO: Add Field Validation - JSF UI Learn how to create a validator on a field with Nuxeo Studio and Nuxeo IDE. Layout, JSF, Validation Advanced Studio, Nuxeo IDE
HOWTO: 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
HOWTO: Add New Relation Types Learn how to customize the relations predicates and add new types of relations. Vocabulary Beginner Nuxeo Platform
HOWTO: Add a "Save Work in Progress" Option on a Task Learn how to implement a "save work in progress" option without completing a workflow task. Workflow, Tasks Intermediate Studio
HOWTO: Add a Button - 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
HOWTO: 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
HOWTO: Add a New Action Category on a Document Tab - JSF UI 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
HOWTO: Add a New Virtual Navigation Entry Learn how to configure a virtual navigation view with Nuxeo Studio. Content View, Virtual Navigation, Vocabulary Intermediate Studio
HOWTO: Add a New Vocabulary Learn how to create a vocabulary using Nuxeo Studio. Vocabulary Beginner Studio
HOWTO: Add a New Widget to the Default Summary Layout - JSF UI 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
HOWTO: Assign a Task to the User Manager This page provides the instructions to assign a task according to the task performer properties. LDAP, Workflow Intermediate Studio
HOWTO: Automatically Convert a Document to PDF Learn how to convert automatically a document into PDF using Nuxeo Studio. Document type, Automation, Conversion Intermediate Studio
HOWTO: Bubble Errors from the Core Layer - JSF UI Learn how to bubble errors from the core layer in the  UI. JSF UI Advanced Code editor
HOWTO: 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
HOWTO: 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
HOWTO: Complete a Workflow Task Programmatically Learn how to complete a workflow task programmatically. Workflow, Task Advanced Studio
HOWTO: Configure Searches Learn how to create a new search screen with Studio Designer. Web UI, Studio Designer Intermediate Studio Designer, code
HOWTO: Configure Web UI Global Settings Learn how to configure global Web UI settings. Web UI Advanced code
HOWTO: Configure a New Default Search Form in the Search Tab Learn how to add a new search search Content View, Elasticsearch, Query Beginner Studio
HOWTO: Configure a New Directory Cache Learn how to define a new directory cache and use it in your directoy. Directory, Vocabulary Intermediate XML Extension
HOWTO: Configure a Search Filter With Facets and Other Aggregates Learn how to use the Elasticsearch aggregate widgets. Content View, Elasticsearch, Query, Widget Intermediate Studio
HOWTO: Contribute Picture Conversions Learn how to contribute new picture conversions. Conversion, DAM Advanced XML Extension
HOWTO: Contribute a Command Line Converter Learn how to contribute a new command line converter. Conversion Advanced XML Extension
HOWTO: 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
HOWTO: Contribute to an Extension Learn 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
HOWTO: Contribute to the REST API Learn how to contribute to the REST API. REST API Advanced Code
HOWTO: Control the Display Mode of a Widget - JSF UI 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
HOWTO: Create Custom Buttons Learn how to execute UI functions after business logic execution Web UI Advanced code
HOWTO: Create Custom Dashboard Entries Learn the basics of a Nuxeo module and is IDE agnostic. Bundle Advanced Code
HOWTO: Create Themes Learn how to customize themes in Nuxeo Studio. Themes Beginner Nuxeo Studio
HOWTO: Create a N-Level Select Widget - JSF UI Learn how to create a selection widget with 3 levels by contributing a "template widget" in Studio. Layout, Widget Advanced Studio
HOWTO: Create a Service Learn how to create a service and define your own extension points Extension point Intermediate Nuxeo CLI, Studio
HOWTO: Create an Actions Menu Learn how to create an actions menu. Web UI Advanced code
HOWTO: 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
HOWTO: Create an Empty Bundle Learn the basics of a Nuxeo module raw creation. 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: Create and Use Document Facets Learn How to Create and Reuse Document Facets in Nuxeo Studio Facets Intermediate Nuxeo Studio
HOWTO: Customize Dashboard Learn how to customize the Web UI dashboard Web UI Advanced code
HOWTO: Customize Default Rendition in Web UI Learn how to customize the default rendition used in Web UI. 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 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
HOWTO: Customize Email Templates Learn how to create new alert email or override existing alert emails with Nuxeo Studio. Alerts Beginner Studio
HOWTO: Customize Slots Learn how to use Nuxeo Slots with Web UI. Web UI Advanced code
HOWTO: Customize Startup Redirection - JSF UI Learn how to customize startup redirection so users are displayed the default Nuxeo dashboard. JSF UI Advanced Code editor
HOWTO: Customize Theme Learn how to customize themes in Nuxeo Web UI. Web UI Advanced code
HOWTO: Customize Workflow Tasks Learn how to configure your workflow tasks Web UI Advanced code
HOWTO: Customize the Bulk Edit Form - JSF UI Learn how to customize the bulk edit form using Nuxeo Studio. Bulk edit, JSF UI Intermediate Studio
HOWTO: Customize the Bulk Import Form - JSF UI Learn how to customize the bulk import form using Nuxeo Studio. Bulk import, JSF UI Intermediate Studio
HOWTO: Customize the Creation Form Learn how to configure the creation form to display long document type titles Web UI, Studio Designer Intermediate null
HOWTO: Customize the Dashboard - JSF UI Learn how to customize the dashboard by adding new entries or completely override the default dashboard. JSF UI Advanced Studio, Code
HOWTO: Customize the Default Content and Trash Listings - JSF UI Learn how to customize the default content and trash listings using Nuxeo Studio. Content View Intermediate Studio
HOWTO: Customize the Default Document View Learn how to update the default Nuxeo document view. Web UI Advanced code
HOWTO: Customize the Error Pages - JSF UI Learn how to customize the error pages. Theme, JSF UI Advanced Code editor
HOWTO: Customize the HTML5 Drag and Drop Import with Metadata Form - JSF UI Learn how to customize the drag and drop HTML5 import with metadata form. Drag and Drop, Layout Beginner Studio
HOWTO: Customize the Info-View Pop-Up - JSF UI Learn how to customize the info-view pop-up using an XML extension or Nuxeo Studio. Info-view, JSF UI Advanced Code editor
HOWTO: Customize the Login Page - JSF UI Learn how to customize the login page using an XML extension. Theme, JSF UI Beginner Code editor
HOWTO: Customize the Versioning and Comment Widget on Document Edit Form - JSF UI 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
HOWTO: Debug Slow Page Rendering - JSF UI Learn how to debug slow page rendering. JSF UI Advanced Code
HOWTO: Declare the CSS and JavaScript Resources Used in Your Templates - JSF UI Learn how to declare and add the CSS and JavaScript resources in your templates. Theme Advanced Code editor
HOWTO: Define a Document Type Learn how to create a new document type using Nuxeo Studio. Document type Beginner Studio
HOWTO: Define a New Content View - JSF UI Learn how to configure a new content view with Nuxeo Studio. Content View Beginner Studio
HOWTO: Deploy Web UI Within a Nuxeo Server Learn how to deploy Web UI within a Nuxeo server. Web UI Advanced code
HOWTO: Disable Trash Actions, Tab and Search Learn how to disable trash and set up hard delete Web UI Intermediate code
HOWTO: 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
HOWTO: Display Non-Folderish Documents (Files, Note, ...) in the Left Tree - JSF UI Learn how to display non-folderish documents in the left tree with Nuxeo Studio. Content View Advanced Studio, XML extensions
HOWTO: Display User Information Learn how to display user information on Web UI Web UI Intermediate code, Studio
HOWTO: 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
HOWTO: Display a Children Documents Listing Learn how to create a listing displaying custom properties of the documents contained in a given space. Page Providers Intermediate Studio
HOWTO: Enable Addons Features on Custom Document Type Learn how to apply features provided by addons on your document type. Document type Intermediate Studio
HOWTO: Enable Drag and Drop and New Button on a Custom Content View - JSF UI Make a custom content view look like the default Content tab. Content view, Tab, JSF UI, UI Beginner Studio
HOWTO: Enable Package Specific Features in Studio for DAM or Virtual Navigation? Learn how to Enable Package Specific Features in Studio for DAM or Virtual Navigation. Application Definition Beginner Studio
HOWTO: 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
HOWTO: Expose Elasticsearch Hint as Extension Point Learn how to expose Elasticsearch hints as extention points. Elasticsearch Advanced Code
HOWTO: 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
HOWTO: 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
HOWTO: Filter Data in Suggestions Learn how to Filter the data in a nuxeo-directory-suggestion element. Web UI Intermediate code
HOWTO: 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
HOWTO: Force Locale - JSF UI Learn how to force the locale by removing other locales support Localization Advanced XML extensions
HOWTO: 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
HOWTO: Hide a Tab, a Link or a Button for a Group or a User - JSF UI Learn how to hide an action for a group or a user. Filter, User action, JSF UI Advanced Code editor
HOWTO: 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
HOWTO: 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
HOWTO: 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, Authentication Advanced Studio
HOWTO: 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
HOWTO: Insert a New Tab Learn how to insert a new tab 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: Make JSF UI the Default UI Learn how to make JSF UI the default UI instead of Web UI. Web UI, JSF UI Beginner XML Extension
HOWTO: 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
HOWTO: Make a Selection Based on the Value of Another Value in a Layout - JSF UI 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
HOWTO: 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
HOWTO: Make the New Button Appear on a Custom Folderish Document - JSF UI 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
HOWTO: Manage Relations on a Document Learn how to display relations on a document. Automation Intermediate Studio
HOWTO: Manage Translations Learn how to manage translations in Nuxeo Web UI. Web UI Beginner Studio
HOWTO: Modify a Workflow Variable outside of Workflow Context Learn how to modify a workflow outside of the workflow context. Workflow, Event, Listener Advanced Studio
HOWTO: Override Existing Contributions Learn how to override Web UI Default contributions with Nuxeo Studio Nuxeo Studio Intermediate Nuxeo Studio
HOWTO: Override Existing Document Types Learn how to override an existing document type in Nuxeo Studio. Document type, Override Beginner Studio
HOWTO: Override a Default Style - JSF UI 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
HOWTO: Override a Seam Component - JSF UI Learn how to override a seam component. JSF UI, Seam JSF Webapp Advanced Nuxeo CLI, code
HOWTO: Override a Template - JSF UI Learn how to override a Nuxeo template. JSF UI Advanced Code
HOWTO: Override the Login Page - JSF UI Learn how to override the login page. Theme, JSF UI Advanced Code editor
HOWTO: Populate a Directory With a CSV File Learn how to populate a directory with a CSV file. Directory, Vocabulary Beginner Code
HOWTO: Prepopulate Metadata at Creation Learn how to prepopulate metadata in the document creation layout Nuxeo Studio Beginner Nuxeo Studio
HOWTO: Programmatically test a workflow Learn how to programmatically test a workflow. Workflow, Tasks, Test Advanced Studio, Node.js
HOWTO: Query Workflow Objects Learn how to query workflow objects using NXQL. Workflow, NXQL, Query Advanced Studio
HOWTO: 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
HOWTO: Refresh the Task Widget on the Summary Tab Learn how to refresh the task widget on the Summary tab. Workflow, Widget Advanced Studio
HOWTO: Register a JSF Tag Library Learn how to use the JSF tag library registration. JSF Advanced Code
HOWTO: Review Nuxeo Studio Configuration Learn how to use the branch management features of Nuxeo Studio to set up a configuration process review. Branch Management Intermediate Studio
HOWTO: Set Up a Tasks Dashboard Learn how to manage a tasks dashboard. Workflow, Dashboard Advanced Studio
HOWTO: Set a Default Date on a Field at Document Creation - JSF UI 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
HOWTO: 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
HOWTO: 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
HOWTO: Translate a Vocabulary Learn how to translate an existing vocabulary. Vocabulary Beginner Studio
HOWTO: Translate the Nuxeo Platform Learn how to translate the Nuxeo Platform Labels, Localization, Translation Advanced Crowdin
HOWTO: Trigger an Automation From a Dialog Learn how to trigger an automation chain or an automation scripting from a Web UI Dialog. Automation Intermediate Designer
HOWTO: Unit Test a Studio Bundle Learn how to unit test a Studio Bundle Nuxeo Studio, Unit test Advanced Code, Nuxeo Studio
HOWTO: Upload Labels Translations in Nuxeo Studio (i18n) Learn how to upload your own translation of labels in Nuxeo Studio Modeler. Labels, Localization, Translation Advanced Studio
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
HOWTO: 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
HOWTO: Use Plug-Ins in TinyMCE Editor - JSF UI 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
HOWTO: Use Web UI Internal Events Learn how to use Web UI internal events. Web UI Advanced code
HOWTO: Use a Generic Widget in Layouts - JSF UI Learn how to use a generic widget in Studio. Layout, Widget Advanced Studio
HOWTO: Use the Runtime Java API Learn how to use the Runtime Java API. Runtime Advanced Code
HOWTO: Use the Trash Feature Learn how to use the trash feature in Nuxeo Platform. REST API Advanced Code
HOWTO: Validate a Document Type Layout Learn how to validate a document type layout. Web UI Advanced code
HOWTO: 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
HOWTO: Write Reusable Automation Chains Learn how to factorize similar automation chains. Automation Intermediate Studio
HOWTO: Write a Bundle Manifest Learn how to write a Bundle Manifest. Runtime Advanced Code
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 Configure a Multidirectory for Users and Groups This page provides a turnkey solution to configure a multidirectory. LDAP, Multidirectory Intermediate XML configuration
How to Contribute a New "User Registration Request" Document Type Learn how to contribute new request types to the addon. User registration Intermediate Studio
How to Define Public Pages (Viewable by Anonymous Users) Learn how to make some pages visible by anonymous users. Access rights, Authentication Advanced Code
How to Enable CSV Import on a Custom Document Type If you installed the Nuxeo CSV addon 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 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 Estimate Volume Usage Get some guidelines to estimate the required size for disk and database. Database Intermediate
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
Web UI Translations Learn how translations are managed technically in Nuxeo Web UI. Web UI Advanced code
Workflow and Task Resource Endpoints This how-to provides an example of how to use the workflow REST API. Worklow, REST API Advanced Code

 

 

We'd love to hear your thoughts!

All fields required