Tutorials

Getting Started with Nuxeo Studio

Updated: February 27, 2017 Page Information Edit on GitHub

This page explains how to start customizing the Nuxeo Platform using Nuxeo Studio. It will guide you through the steps to:

  • Get a Nuxeo Studio project using Nuxeo Online Services
  • Get a running Nuxeo Platform instance
  • Change the logo of your Nuxeo Platform instance
  • Create a new Contract document type in Nuxeo Studio

Nuxeo Studio is a Nuxeo tool provided as part of the Nuxeo Online Services subscription offer. If you are a Nuxeo customer, you should already have a username/password to connect and access to your Studio project. Otherwise, we provide a 30-day trial offer so you can discover Nuxeo Studio and its configuration capabilities.

Step 1 - Get a Nuxeo Platform Instance

The Nuxeo Platform is available in different packages. Here we will use the ZIP archive.

Installing the Nuxeo Platform using the .zip package installs the Nuxeo Platform only. External dependencies must be installed separately.

To install and start the Nuxeo Platform ZIP archive:

  1. Unzip the .zip archive using your favorite tool.

  2. Double click on the Start Nuxeo.command file (or the Start Nuxeo.bat file for Windows users) to start the server.

  3. In a browser, go to http://localhost:8080/nuxeo.

  4. Fill in the information in the configuration wizard steps.

  5. At the Nuxeo Online Services step, provide your Nuxeo Online Services credentials if you already have a Nuxeo Online Services account or register to the 30-day trial offer.

    1. Provide a valid email address or else registration will not be completed.
    2. Confirm registration by clicking on the link sent to the email address you provided.

      Your Online Trial account is created. You can now access Nuxeo Studio by clicking on the link provided in the last email received.

  6. At the Modules step, select Nuxeo JSF UI.

  7. Click on Start at the final step.

    Your application is ready to use. Now, you need to activate development mode so as to enjoy the hot reload of your Nuxeo Studio configuration.

To activate development mode:

  1. When the application is started, log in with the Administrator / Administrator credentials.

  2. Click on Admin Center > Update Center.

    The Nuxeo Studio tab is displayed.

  3. Click on the Enable button to activate development mode.

  4. Click on the Restart Server button displayed on top of the Admin Center.

    The Nuxeo Platform instance restarts. You can then enjoy your Nuxeo Studio configuration without restarting your server.

Once your project registered on Online Services, you can start customizing your Nuxeo Application. The first customizations occurs in Nuxeo Studio, where you can easily create new document types, content views, etc. Here, we will change the logo and then create a document type named "Contract".

You can now access Nuxeo Studio from Online Services by clicking on this link: connect.nuxeo.com/nuxeo/.

Goal is to change the logo displayed in the banner of the Nuxeo Platform application. You must preliminary have a logo in the PNG or JPG format.

Studio Customization

Change the logo:

  1. In Studio's left menu, click on the Branding section.

  2. Click on the New button.

  3. In Feature ID field, type "MyBranding" and click on the Next button.

  4. In Main Pages tab:

    1. Check-box "Set as default branding" must be checked.

    2. Click on the Select Resource button of the "Logo image" field.

      A "Select Resource" window pops up. It shows a list of images available by default, imported with the "Default Nuxeo Platform Configuration" template.

    3. Click on Choose File and select an image from your desktop.

    4. Click on the Upload button.

      The selected image is uploaded to Studio, added to the list of available images and selected.

  5. Click on the Ok button at the bottom of the popup window.

    The path to the uploaded image is displayed next to the Select resource button.

Deploying Changes on Your Nuxeo Platform Instance

  1. Go to your Nuxeo Platform instance, typically available at http://localhost:8080/nuxeo.

  2. Connect as Administrator with Administrator password.

  3. Click on Admin Center > Update Center > Nuxeo Studio.

  4. Click on the Update button.

    Your logo is updated.

Step 3 - Create a Contract Document Type

Here we want to create a document type named "Contract" that will hold specific metadata related to the notion of contract: contract owner, starting date, policy.

Studio Customization

  1. Unfold the Content Model item of the Studio tree, click on Document Types and click the New button.

  2. Fill in the creation form and click on Next:

    • ID: Contract
    • Extends: File
    • Label: Contract
    • Description: Contract document type for internal use.

    Your document type is created.

  3. Fill in the Definition tab:

  4. Fill in the Schema tab with the following metadata:

  5. Specify the form that will be used to create the document (aka creation layout):

    1. Click on the icon to remove the WARNING and Description widgets.

    2. Drag and drop the fields "Owner", "Start" and "Policy" from the schema Contract to the grid.

    3. Click on  if you want to edit their label and click on the popup Save button.

  6. On the Edit layout (the form used to update the metadata of the document):

    1. Click on the button Import Layout and select Import 'create' layout.

    2. Click on the button Add Row.

    3. Drag and drop the field Reminder from the schema Contract to the grid.

    4. Click on  if you want to edit the widget label and click on the popup Save button.

  7. On the View Layout click on the button Import Layout and select Import 'edit' layout.

  8. Click on Save.

Deploying Changes on Your Nuxeo Platform Instance

  1. Go to your Nuxeo Platform instance, typically available at http://localhost:8080/nuxeo.

  2. Connect as Administrator with Administrator password.

  3. Click on Admin Center > Update Center > Nuxeo Studio.

  4. Click on the Update button.

  5. Go in a workspace and create a new Contract.

You are now ready to use Nuxeo Studio! You can:

23 days ago Arnaud Kervern NXDOC-1116: Rename getting started page
a month ago Manon Lumeau fix image on quick overview page
7 months ago Solen Guitter 26
7 months ago Solen Guitter 25 | NXDOC-857: remove nuxeo.io
a year ago Manon Lumeau 24
a year ago Manon Lumeau 23
a year ago Solen Guitter 22 | Update Studio menu labels
a year ago Solen Guitter 21 | Fix links
a year ago Manon Lumeau 20 | Fix links
a year ago Julie Allouch 19
a year ago Solen Guitter 18
a year ago Solen Guitter 17
a year ago Bertrand Chauvin 16 | Update titles to fix anchor links
a year ago Manon Lumeau 14
a year ago Manon Lumeau 15
2 years ago Solen Guitter 13
2 years ago Manon Lumeau 12
2 years ago Manon Lumeau 11
2 years ago Manon Lumeau 10
2 years ago Manon Lumeau 8
2 years ago Manon Lumeau 9
2 years ago Manon Lumeau 7
2 years ago Manon Lumeau 5
2 years ago Manon Lumeau 6
2 years ago Manon Lumeau 4
2 years ago Manon Lumeau 3
2 years ago Manon Lumeau 2
2 years ago Manon Lumeau 1
History: Created by Manon Lumeau