Guides and Tutorials

How-To Index

Updated: July 17, 2023

 

Title Excerpt Topics Level
Ajax Forms and Actions Learn the tips and tricks when working with Ajax forms or actions. JSF, Ajax Advanced
Ajax4jsf Best Practices Learn the best practices of Ajax4JSF to ensure correct rendering, HTML and testing. JSF, Ajax Advanced
Branding Learn how to create a custom login page. Themes Beginner
Double Click Shield Learn how to use the "Double Click Shield" feature. JSF, Ajax, jQuery Advanced
Getting Started with Nuxeo IDE Learn how to start working with Nuxeo IDE. Automation, Layout Intermediate
Getting Started with Nuxeo Studio Learn how to start working with Nuxeo Studio. Document type, Style Beginner
HOWTO: Collaborate on a Studio Project Learn how to use the advanced branch management feature of Nuxeo Studio to collaborate on a Studio project. SourceControlManagement Intermediate
HOWTO: Create Themes Learn how to customize themes in Nuxeo Studio. Themes Beginner
HOWTO: Create and Use Document Facets Learn How to Create and Reuse Document Facets in Nuxeo Studio Doctype Intermediate
HOWTO: Deploy Your Project in Dev Mode Learn How to Deploy a Nuxeo Studio release Deployment Beginner
HOWTO: Develop Faster with Git and Your Nuxeo Studio Project Learn how to synchronize your Studio sources with a local instance and to make the development process of custom elements DevTools, Deployment Advanced
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
HOWTO: Export a Studio Project in Eclipse Learn how to import Studio files in Eclipse Deployment Advanced
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. SourceControlManagement, Studio Tags Intermediate
HOWTO: Install the Studio JAR Manually Learn How to Install the Studio JAR Manually Deployment Intermediate
HOWTO: Override Existing Contributions Learn how to override Web UI Default contributions with Nuxeo Studio UIElements Intermediate
HOWTO: Prepopulate Metadata at Creation Learn how to prepopulate metadata in the document creation layout Automation, Events Beginner
HOWTO: Reference an External Document Type Learn how to reference another document type Registries, Doctype Intermediate
HOWTO: Reference an External Operation Learn how to reference an external operation Automation, Registries Intermediate
HOWTO: Review Nuxeo Studio Configuration Learn how to use the branch management features of Nuxeo Studio to set up a configuration process review. SourceControlManagement Intermediate
HOWTO: Tag or Release Your Nuxeo Studio Project Learn how to use the tags and releases features of Nuxeo Studio. SourceControlManagement, Studio Tags Intermediate
HOWTO: Unit Test a Studio Bundle Learn how to unit test a Studio Bundle Development, Nuxeo Studio, Unit test, Deployment Advanced
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. SourceControlManagement, Studio Tags Intermediate
HOWTO: Work with Maven Integration Learn how to integrate your Studio project with Maven DevTools, Deployment Advanced
How to Activate UI Development Mode Learn how to activate the UI development mode to get details about elements in the UI. Web UI Beginner
How to Add Complex Fields on Your Document Type Learn how to add complex fields on a document type. Document type, Schema Beginner
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
How to Add Field Validation Learn how to create a validator on a field with Nuxeo Studio and Nuxeo IDE. Layout, JSF, Validation Advanced
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
How to Add New Relation Types Learn how to customize the relations predicates and add new types of relations. Vocabulary Beginner
How to Add a Button in the JSF UI Learn how to add new buttons at different locations in the JSF web UI using user actions and automation (in a document contextual tools or on a document Edit form for instance). Automation, Extension, Tab, User action, Web UI Beginner
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, Validation Advanced
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
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
How to Add a New Vocabulary Learn how to create a vocabulary using Nuxeo Studio. Vocabulary Beginner
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, Web UI Advanced
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
How to Bubble Errors from the Core Layer in the JSF UI Learn how to bubble errors from the core layer in the JSF UI. Web UI Advanced
How to Change Context Path Learn how to change the context path of your Nuxeo Platform, i.e. the /nuxeo in the URL of your application. Context Path Beginner
How to Complete a Workflow Task Programmatically Learn how to complete a workflow task programmatically. Workflow, Task Advanced
How to Configure Nuxeo Drive Globally This how-to explains how to configure Nuxeo Drive globally from the Nuxeo server. Nuxeo Drive Intermediate
How to Configure a Multidirectory for Users and Groups This page provides a turnkey solution to configure a multidirectory. LDAP, Multidirectory Intermediate
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
How to Configure a New Directory Cache Learn how to define a new directory cache and use it in your directoy. Directory, Vocabulary Intermediate
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
How to Contribute Picture Conversions Learn how to contribute new picture conversions. Conversion, DAM Advanced
How to Contribute a Command Line Converter Learn how to contribute a new command line converter. Conversion Advanced
How to Contribute a New "User Registration Request" Document Type Learn how to contribute new request types to the add-on. User registration Intermediate
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
How to Contribute to an Extension Lean how to create an XML extension in Nuxeo Studio and in Nuxeo IDE and how to override a Nuxeo contribution. Extension point Intermediate
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
How to Create a N-Level Select Widget Learn how to create a selection widget with 3 levels by contributing a "template widget" in Studio. Layout, Widget Advanced
How to Create a Nuxeo Static WAR This page provides instructions to generate a static WAR distribution and deploy it in a Tomcat or WildFly distribution. Distribution, Static WAR Advanced
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
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
How to Customize Email Templates Learn how to create new alert email or override existing alert emails with Nuxeo Studio. Alerts Beginner
How to Customize Nuxeo Drive Versioning Policy This how-to explains how to change Nuxeo Drive's default versioning policy. Nuxeo Drive, Versioning Intermediate
How to Customize Startup Redirection Learn how to customize startup redirection so users are displayed the default Nuxeo dashboard. Web UI Advanced
How to Customize the Bulk Edit Form Learn how to customize the bulk edit form using Nuxeo Studio. Bulk edit, Web UI Intermediate
How to Customize the Bulk Import Form Learn how to customize the bulk import form using Nuxeo Studio. Bulk import, Web UI Intermediate
How to Customize the Dashboard Learn how to customize the dashboard by adding new entries or completely override the default dashboard. Web UI Advanced
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
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
How to Customize the Error Pages Learn how to customize the error pages. Theme, Web UI Advanced
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
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, Web UI Advanced
How to Customize the Login Page Learn how to customize the login page using an XML extension. Theme, Web UI Beginner
How to Debug Slow Page Rendering Learn how to debug slow page rendering. Web UI Advanced
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
How to Define Public Pages (Viewable by Anonymous Users) Learn how to make some pages visible by anonymous users. Access rights Advanced
How to Define a Document Type Learn how to create a new document type using Nuxeo Studio. Document type Beginner
How to Define a New Content View Learn how to configure a new content view with Nuxeo Studio. Content View Beginner
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
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
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
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
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
How to Enable Drag'n Drop and New Button on a Custom Content View Make a custom content view look like the default Content tab. Content view, Tab, Web UI Beginner
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
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
How to Estimate Disk, Database and Elasticsearch 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
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
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
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
How to Force Locale Learn how to force the locale by removing other locales support Localization Advanced
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
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, Web UI Advanced
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 Advanced
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
How to Inherit a 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
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
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
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
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
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
How to Override Existing Document Types Learn how to override an existing document type in Nuxeo Studio. Document type, Override Beginner
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
How to Override a Seam Component Learn how to override a seam component. Seam JSF Webapp Advanced
How to Override a Template Learn how to override a Nuxeo template. Web UI Advanced
How to Override the Login Page Learn how to override the login page. Theme, Web UI Advanced
How to Query Workflow Objects Learn how to query workflow objects using NXQL. Workflow, NXQL, Query Advanced
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
How to Refresh the Task Widget on the Summary Tab Learn how to refresh the task widget on the Summary tab. Workflow, Widget Advanced
How to Register a JSF Tag Library Learn how to use the JSF tag library registration. JSF Advanced
How to Set Up a Tasks Dashboard Learn how to manage a tasks dashboard. Workflow, Dashboard Advanced
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
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
How to Translate a Vocabulary Learn how to translate an existing vocabulary. Vocabulary Beginner
How to Translate the Nuxeo Platform Learn how to translate the Nuxeo Platform Labels, Localization, Translation Advanced
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
How to Upload a File in Nuxeo Platform Using REST API Batch Processing Endpoint Learn how to import a file using the Batch processing endpoint of the REST API. Import, REST API Advanced
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, Web UI Intermediate
How to Use a Generic Widget in Layouts Learn how to use a generic widget in Studio. Layout, Widget Advanced
How to Write Reusable Automation Chains Learn how to factorize similar automation chains. Automation Intermediate
How to create an empty bundle Learn the basics of a Nuxeo module and is IDE agnostic. Bundle Advanced
How to setup a test SMTP server Learn how to setup a SMTP server for testing purpose. Alerts Advanced
JSF and JavaScript Learn how to get a tag client using DOM. JSF, JavaScript Advanced
JSF troubleshoot Discover the troubleshooting issues that can be encountered with JSF. JSF Advanced
Nuxeo Elements Quickstart Learn how to start working with Nuxeo Elements. Nuxeo Elements, REST API Advanced
Query Endpoint This how-to provides an example of how to use the REST API to query the Nuxeo repository. Query, REST API Advanced
Use Nuxeo API Playground to Discover the API Learn how to use the API Playground and leverage the Nuxeo REST API. REST API Advanced
Using CMISQL from Java Learn how to make CMISQL queries from Java code inside a Nuxeo bundle. CMIS, Query Advanced