Welcome on the Nuxeo Studio tutorials.
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.
Hyland University
DEV MODE
The configuration changes you will make in Nuxeo Studio require Development Mode to be enabled.
Branding and Themes
| Title | Excerpt | Level |
|---|---|---|
| Branding | Learn how to create a custom login page. | Beginner |
| HOWTO: Create Themes | Learn how to customize themes in Nuxeo Studio. | Beginner |
| HOWTO: Customize Theme | Learn how to customize themes in Nuxeo Web UI. | Advanced |
Document type and Schemas
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Add Complex Fields on Your Document Type | Learn how to add complex fields on a document type. | Beginner |
| HOWTO: Add New Fields to the User or Group Schema | This page provides a turnkey solution to add new fields to the user or group schema. | Intermediate |
| HOWTO: Create and Use Document Facets | Learn How to Create and Reuse Document Facets in Nuxeo Studio | Intermediate |
| HOWTO: Customize Document Layouts | Learn how to use document layouts with Web UI and Studio Designer | Intermediate |
| HOWTO: Customize Document Validation | Leans how to customize the document validation error messages and how to add new references validation on document types. | Advanced |
| HOWTO: Define a Document Type | Learn how to create a new document type using Nuxeo Studio. | Beginner |
| HOWTO: Override Existing Document Types | Learn how to override an existing document type in Nuxeo Studio. | Beginner |
| HOWTO: Reference an External Document Type | Learn how to reference another document type | Intermediate |
| 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... | Intermediate |
| 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. | Beginner |
| How to Enable Quotas on Document Types | Learn how to enable Nuxeo Quota features on document types other than domains and workspaces. | Beginner |
Layouts
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Contribute Picture Conversion | Learn how to contribute new picture conversions. | Advanced |
| HOWTO: Contribute Video Conversion | Learn how to contribute a new video conversion to convert a video to WebM format. | Advanced |
| HOWTO: Create and Reuse a Custom Element | Learn how to create and reuse a custom element in Studio Designer. | Advanced |
| HOWTO: Customize Document Layouts | Learn how to use document layouts with Web UI and Studio Designer | Intermediate |
| HOWTO: Customize the Creation Form | Learn how to configure the creation form to display long document type titles | Intermediate |
| HOWTO: Define a Document Type | Learn how to create a new document type using Nuxeo Studio. | Beginner |
Vocabularies
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Add New Relation Types | Learn how to customize the relations predicates and add new types of relations. | Beginner |
| HOWTO: Add a New Vocabulary | Learn how to create a vocabulary using Nuxeo Studio. | Beginner |
| HOWTO: Configure a New Directory Cache | Learn how to define a new directory cache and use it in your directoy. | Intermediate |
| HOWTO: Filter Data in Suggestions | Learn how to Filter the data in a nuxeo-directory-suggestion element. | Intermediate |
| HOWTO: Populate a Directory With a CSV File | Learn how to populate a directory with a CSV file. | Beginner |
| HOWTO: Translate a Vocabulary | Learn how to translate an existing vocabulary. | Beginner |
Searches
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Configure Searches | Learn how to create a new search screen with Studio Designer. | Intermediate |
| HOWTO: Display a Children Documents Listing | Learn how to create a listing displaying custom properties of the documents contained in a given space. | Intermediate |
| HOWTO: Insert a New Search Tab | Learn how to insert a new tab on your custom document type | Intermediate |
| HOWTO: Query Workflow Objects | Learn how to query workflow objects using NXQL. | Advanced |
Automation
| Title | Excerpt | Level |
|---|---|---|
| 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). | Beginner |
| HOWTO: Automatically Convert a Document to PDF | Learn how to convert automatically a document into PDF using Nuxeo Studio. | Intermediate |
| HOWTO: Contribute Picture Conversion | Learn how to contribute new picture conversions. | Advanced |
| HOWTO: Contribute Video Conversion | Learn how to contribute a new video conversion to convert a video to WebM format. | Advanced |
| HOWTO: Create Custom Buttons | Learn how to execute UI functions after business logic execution | Advanced |
| HOWTO: Create an Automation Chain | This how-to explains the different steps to create and configure an automation chain using Nuxeo Studio. | Beginner |
| HOWTO: Customize the Default Document View | Learn how to update the default Nuxeo document view. | Advanced |
| HOWTO: Export Data Using Document Template and Automation | Learn how to generate a CSV file listing all the documents of your Nuxeo Platform repository. | Beginner |
| HOWTO: Fetch Documents with a Query on Date Parameters | Learn how to make it possible to process documents depending on a date parameter. | Intermediate |
| 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. | Intermediate |
| 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. | Beginner |
| 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. | Intermediate |
| HOWTO: Manage Relations on a Document | Learn how to display relations on a document. | Intermediate |
| HOWTO: Prepopulate Metadata at Creation | Learn how to prepopulate metadata in the document creation layout | Beginner |
| 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. | Beginner |
| HOWTO: Reference an External Operation | Learn how to reference an external operation | Intermediate |
| HOWTO: Trigger an Automation From a Dialog | Learn how to trigger an automation chain or an automation scripting from a Web UI Dialog. | Intermediate |
| 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... | Intermediate |
| HOWTO: Write Reusable Automation Chains | Learn how to factorize similar automation chains. | Intermediate |
Conversion
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Automatically Convert a Document to PDF | Learn how to convert automatically a document into PDF using Nuxeo Studio. | Intermediate |
| HOWTO: Contribute Picture Conversion | Learn how to contribute new picture conversions. | Advanced |
| HOWTO: Contribute Video Conversion | Learn how to contribute a new video conversion to convert a video to WebM format. | Advanced |
| HOWTO: Contribute a Command Line Converter | Learn how to contribute a new command line converter. | Advanced |
| HOWTO: Customize Default Rendition in Web UI | Learn how to customize the default rendition used in Web UI. | Advanced |
| 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. | Beginner |
| 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... | Intermediate |
Workflow
| Title | Excerpt | Level |
|---|---|---|
| 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. | Intermediate |
| HOWTO: Assign a Task to the User Manager | This page provides the instructions to assign a task according to the task performer properties. | Intermediate |
| HOWTO: Complete a Workflow Task Programmatically | Learn how to complete a workflow task programmatically. | Advanced |
| HOWTO: Customize Workflow Tasks | Learn how to configure your workflow tasks | Advanced |
| 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. | Intermediate |
| 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. | Advanced |
| 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. | Intermediate |
| HOWTO: Modify a Workflow Variable outside of Workflow Context | Learn how to modify a workflow outside of the workflow context. | Advanced |
| HOWTO: Programmatically test a workflow | Learn how to programmatically test a workflow. | Advanced |
| HOWTO: Query Workflow Objects | Learn how to query workflow objects using NXQL. | Advanced |
| HOWTO: Refresh the Task Widget on the Summary Tab | Learn how to refresh the task widget on the Summary tab. | Advanced |
| HOWTO: Set Up a Tasks Dashboard | Learn how to manage a tasks dashboard. | Advanced |
| 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. | Advanced |
Source Control Management
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Collaborate on a Studio Project | Learn how to use the advanced branch management feature of Nuxeo Studio to collaborate on a Studio project. | Intermediate |
| 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. | Intermediate |
| HOWTO: Review Nuxeo Studio Configuration | Learn how to use the branch management features of Nuxeo Studio to set up a configuration process review. | Intermediate |
| HOWTO: Tag or Release Your Nuxeo Studio Project | Learn how to use the tags and releases features of Nuxeo Studio. | Intermediate |
| 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. | Intermediate |
Events
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Create an Automation Chain | This how-to explains the different steps to create and configure an automation chain using Nuxeo Studio. | Beginner |
| HOWTO: Prepopulate Metadata at Creation | Learn how to prepopulate metadata in the document creation layout | Beginner |
| HOWTO: Use Web UI Internal Events | Learn how to use Web UI internal events. | Advanced |
Templates
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Customize Email Templates | Learn how to create new alert email or override existing alert emails with Nuxeo Studio. | Beginner |
| HOWTO: Export Data Using Document Template and Automation | Learn how to generate a CSV file listing all the documents of your Nuxeo Platform repository. | Beginner |
| 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. | Beginner |
Permissions
| Title | Excerpt | Level |
|---|---|---|
| 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. | Intermediate |
| 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). | Advanced |
Users and Groups
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Add New Fields to the User or Group Schema | This page provides a turnkey solution to add new fields to the user or group schema. | Intermediate |
| 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. | Advanced |
| 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). | Advanced |
XML Extensions
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Configure a New Directory Cache | Learn how to define a new directory cache and use it in your directoy. | Intermediate |
| HOWTO: Contribute Picture Conversion | Learn how to contribute new picture conversions. | Advanced |
| HOWTO: Contribute Video Conversion | Learn how to contribute a new video conversion to convert a video to WebM format. | Advanced |
| HOWTO: Contribute a Command Line Converter | Learn how to contribute a new command line converter. | Advanced |
| 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. | Intermediate |
| HOWTO: Customize Default Rendition in Web UI | Learn how to customize the default rendition used in Web UI. | Advanced |
| 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. | Intermediate |
| 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). | Advanced |
| 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. | Beginner |
| How to Enable Quotas on Document Types | Learn how to enable Nuxeo Quota features on document types other than domains and workspaces. | Beginner |
Registries
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Reference an External Document Type | Learn how to reference another document type | Intermediate |
| HOWTO: Reference an External Operation | Learn how to reference an external operation | Intermediate |
UI Elements
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Create Custom Dashboard Entries | Learn the basics of a Nuxeo module and is IDE agnostic. | Advanced |
| HOWTO: Create a Bulk Action Using Nuxeo Studio | Learn how to create an action executing logic in bulk using Nuxeo Studio Designer | Intermediate |
| HOWTO: Create a Bulk Edit Form Using Nuxeo Studio | Learn how to create a bulk edit form using Nuxeo Studio Designer | Intermediate |
| HOWTO: Create an Actions Menu | Learn how to create an actions menu. | Advanced |
| HOWTO: Create an Automation Chain | This how-to explains the different steps to create and configure an automation chain using Nuxeo Studio. | Beginner |
| HOWTO: Create and Reuse a Custom Element | Learn how to create and reuse a custom element in Studio Designer. | Advanced |
| HOWTO: Customize Dashboard | Learn how to customize the Web UI dashboard | Advanced |
| HOWTO: Customize Slots | Learn how to use Nuxeo Slots with Web UI. | Advanced |
| HOWTO: Customize the Default Document View | Learn how to update the default Nuxeo document view. | Advanced |
| HOWTO: Disable Trash Actions, Tab and Search | Learn how to disable trash and set up hard delete | Intermediate |
| HOWTO: Display User Information | Learn how to display user information on Web UI | Intermediate |
| HOWTO: Filter Data in Suggestions | Learn how to Filter the data in a nuxeo-directory-suggestion element. | Intermediate |
| HOWTO: Insert a Button | Learn how to insert a new user action using the Studio Designer | Intermediate |
| HOWTO: Override Existing Contributions | Learn how to override Web UI Default contributions with Nuxeo Studio | Intermediate |
| HOWTO: Trigger an Automation From a Dialog | Learn how to trigger an automation chain or an automation scripting from a Web UI Dialog. | Intermediate |
| HOWTO: Use Web UI Internal Events | Learn how to use Web UI internal events. | Advanced |
| HOWTO: Use the Rich Text Editor (RTE) for Article Publishing | Learn how to leverage the rich text editor to make Nuxeo an articles content repository | Intermediate |
| HOWTO: Validate a Layout Content | Learn how to validate a document type layout. | Advanced |
| Web UI Customization Tutorial | Learn how to customize Web UI and deploy your customization. | Advanced |
Translations
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Customize Document Validation | Leans how to customize the document validation error messages and how to add new references validation on document types. | Advanced |
| HOWTO: Manage Translations | Learn how to manage translations in Nuxeo Web UI. | Beginner |
| HOWTO: Translate a Vocabulary | Learn how to translate an existing vocabulary. | Beginner |
| HOWTO: Translate the Nuxeo Platform | Learn how to translate the Nuxeo Platform | Advanced |
| HOWTO: Upload Labels Translations in Nuxeo Studio (i18n) | Learn how to upload your own translation of labels in Nuxeo Studio Modeler. | Advanced |
| Web UI Translations | Learn how translations are managed technically in Nuxeo Web UI. | Advanced |
Studio Deployment
| Title | Excerpt | Level |
|---|---|---|
| Deploy and Publish | Learn how to package, publish, deploy and hotreload a project. | Intermediate |
| Develop Your Own Java Code | Learn how to start working with Nuxeo CLI. | Intermediate |
| HOWTO: Deploy Web UI Within a Nuxeo Server | Learn how to deploy Web UI within a Nuxeo server. | Advanced |
| HOWTO: Deploy Your Project in Dev Mode | Learn How to Deploy a Nuxeo Studio release | 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 | Advanced |
| HOWTO: Export a Studio Project in Eclipse | Learn how to import Studio files in Eclipse | Advanced |
| HOWTO: Install the Studio JAR Manually | Learn How to Install the Studio JAR Manually | Intermediate |
| HOWTO: Unit Test a Studio Bundle | Learn how to unit test a Studio Bundle | Advanced |
| HOWTO: Work with Maven Integration | Learn how to integrate your Studio project with Maven | Advanced |