Documentation Center for Nuxeo Platform IDE

Creating a Custom Nuxeo Package

Updated: January 11, 2017 Page Information Edit on GitHub

Nuxeo IDE is being replaced by the Nuxeo Generator and won’t be maintained any longer. You can take a look at the page Start customizing the Nuxeo Platform to discover how to use the Nuxeo Generator.

Nuxeo IDE enables you to create Nuxeo Packages for your Nuxeo project. A Nuxeo Package is the easiest way to distribute a plugin, as it contains all the bundles, libraries and runtime properties that would be required to make your new plugin work, all in one single ZIP file.

The whole Nuxeo Package structure and metadata are detailed on the page Creating Nuxeo Packages.

Please note that this functionality may not be fully compliant on Nuxeo IDE versions 1.2.1 to 1.2.3 included when using a Nuxeo Platform 5.8 SDK. For users using this configuration, an upgrade to Nuxeo IDE 1.2.4 is recommended. A workaround can also be found in the following JIRA ticket: Allow marketplace package generation with Nuxeo Platform 5.8 / Maven 3

To create your Nuxeo Package in Nuxeo IDE:

  1. If you haven't yet, create a new Nuxeo plugin in your Eclipse.
  2. From the Wizard options, choose Marketplace Project.
  3. On the Marketplace creation form, define:
    • The id for your Nuxeo Package
    • A namespace package for your Java test classes
    • Project binding to attach your Nuxeo plugin to the Marketplace package
  4. On the Marketplace information form, specify the Nuxeo Package metadata such as:
    • The distribution type (cap, dm, dam...)
    • The Nuxeo Package version, license, description
    • The Nuxeo Package deployment options (need to restart the instance...)
    • The functional tests deployment (WebDriver, Selenium and FunkLoad)
  5. Click on the Finish button to create your Nuxeo Package project. Here is what you get:

    • One project is created for whole Nuxeo Package (link) container
    • One project for each test framework selected (included WebDriver tests in Java).
  6. To generate the actual Nuxeo Package:
    1. Make sure the bound POM file contains all necessary dependencies. You can right click on your project and choose "Nuxeo / synchronize POM" to ease the process.
    2. From the bound project, use Maven to compile and install the project's JAR file into your local repository (mvn clean install command)
    3. From the Eclipse Marketplace project, use Maven to generate the Nuxeo Package (mvn clean package command)
      Since Nuxeo IDE 1.2.1, Maven 3 is being used to compile projects and generate Nuxeo Packages. Refer to the Use Maven 3 JIRA ticket for more information about switching from Maven 2 to Maven 3 impacts.
7 months ago Solen Guitter NXDOC-962: Add message about Nuxeo Generator, fix redirect, fix lists in tables
9 months ago Solen Guitter NXDOC-900: fix ugly formatting
2 years ago Solen Guitter 13
2 years ago Manon Lumeau 12
2 years ago Manon Lumeau 11
2 years ago Julien Carsique 10
3 years ago Bertrand Chauvin 8
3 years ago Bertrand Chauvin 9
3 years ago Bertrand Chauvin 7 | Added instructions on generating the actual marketplace package
3 years ago Bertrand Chauvin 6 | Fixed typo
3 years ago Solen Guitter 5
4 years ago Solen Guitter 4
4 years ago Solen Guitter 3
4 years ago Vladimir Pasquier 2
4 years ago Vladimir Pasquier 1
History: Created by Vladimir Pasquier