Developer Documentation Center

Creating Nuxeo Packages

This section gives instructions on how to wrap a plugin and its required dependencies into a Nuxeo Package.

To build your custom Nuxeo Packages easily, a wizard is provided by IDEDOC. Detailed explanations are provided in the Creating a Custom Nuxeo Package page.

A package contains usually new features or patches along with installation instructions. Packages can be downloaded from a remote repository and then installed on a running Nuxeo and possibly uninstalled later. A Nuxeo Package is the easiest way to distribute a plugin, as it contains in one single zip file all the bundles, libraries and runtime properties that would be required to make your new plugin work. Nuxeo uses the Nuxeo Package format for distributing all its plugins on Nuxeo Marketplace. We also encourage you to use it for delivering your customization. A Nuxeo Package can be set up either in the admin center on the Nuxeo instance, or using nuxeoctl instructions.

Some packages require the server to be restarted after the install (or uninstall). Each package provides a description of the modifications that should be done on the running platform in order to install a package. We will call "command" each atomic instruction of an install or uninstall process. When Commands are revertible - so that for any command execution there must be an inverse command that can be executed to rollback the modification made by the first command. When designing update packages you must ensure the installation is revertible if needed.

The rollback of an installation is done either when the installation fails (in the middle of the install process), either if the user wants to uninstall the package.

In this chapter we will discuss about the package format, package execution and rollback. 

Package Format

A package is assembled as a ZIP file that contains the bundles, configuration files or libraries you want to install, along with some special files that describe the install process.

Here is a list of the special files (you should avoid to use these file names for installable resources)

  • package.xml - The package descriptor describing package metadata, dependencies and custom handlers to be used when installing. See Package Manifest for more details on the file format.
  • install.xml - A file containing the install instructions. There are two possible formats for this file: either an XML package command file, or an ant script to be used to install the package. Using ant is discouraged, you should envisage to use the package command to describe an installation rather than ant since rollback is ensured to be safe.  See Scripting Commands for more details on the commands file format.
  • uninstall.xml - A file containing the uninstall instructions. When using commands to describe the install process this file will be automatically generated (so you don't need to write it). When using ant for the install you must write the uninstall ant file too. 
  • install.properties - A Java property file containing user preferences (if any was specified during the install wizard). This file is automatically generated by the installer.
  • backup - A directory created by the install process (when using commands to describe the install) to backup the existing files that were modified. The content of this directory will be used by the rollback process to revert changes. See Scripting Commands for more details on rollback.
  • license.txt - A text file containing the license of the software you want to install. This file is optional.
  • content.html - A file containing an HTML description of you package. This file can use references to resources (such as images) located in the package zip - for example you may want to display a set of screenshots for the new feature installed by the package. This file is optional. See Package Web Page  for more details on how to write your package web page.
  • forms - A directory containing custom wizard form definitions. This directory and all the files inside are optional.

    Forms, which are base on the ParametrizedCopy command, are more or less deprecated since they currently work only under the following conditions (NXP-14777):

    • not under Windows,
    • MP is hotreloadable (NXP-8241),
    • and DEV mode is activated.

    Instead, you should use a custom configuration template deployed and activated by the MP, then configured by the server administrator from nuxeo.conf.

    There are three type of wizard forms you can contribute:

    • install.xml - Describe install forms (i.e. forms added to the install wizard for packages that needs user parameterization)
    • uninstall.xml - Uninstall forms (i.e. forms  added to the uninstall wizard for packages that needs user parameterization)
    • validation.xml - Validation forms (i.e. forms used by the install validator if any is needed)

Apart these special files you can put anything inside a package (web resources, jars, Java or Groovy classes etc.). It is recommended to group your additional resources in sub directories to keep a clean structure for your package.

You can see that most of the files listed above are optional or generated. So for a minimal package you will only need 2 files: the package.xml and the install.xml file.

The Package Metadata

The package metadata is stored in package.xml file. Here is the list of properties defining a package:

  • name: The package name. The allowed characters are the ones allowed for Java identifiers plus the dash - character. Example: nuxeo-automation-core
  • version: The package version. Apart the tree digit fields separated by dots versions may contain a trailing classifier separated by a dash. Examples: 1.2.3-SNAPSHOT, 1.2, 3, 0.1.0.
  • id: The package unique identifier. This is automatically generated from the name and the version as follows: name-version. Example: nuxeo-automation-core-5.3.2
  • type: The package type. One of: studiohotfix, or addon.
  • dependencies: A list of other packages that are required by this package. The dependencies are expressed as _packageId:version_range_ where version_range is a string of one or two versions separated by a colon : character.  Example: nuxeo-core:5.3.0 - this means any version of nuxeo-core greater or equals to 5.3.0. Or: nuxeo-core:5.3.0:5.3.2 - any version of nuxeo-core greater or equals than 5.3.0 and less or equal than 5.3.2. 
  • platforms: A list of supported platform identifiers. Examples: dm-5.3.2, dam-5.3.2. 
  • title: The package title to be displayed to the user.
  • description: A short description of the package
  • classifier: The package classifier if any. (You can use it to put tags on the package)
  • vendor: The identifier of the package vendor.
  • home-page: An URL to the home page of the package (or documentation) if any. 
  • installer: A custom Install Task class that will handle the install process. If not specified the default implementation (which is using commands) will be used.
  • uninstaller: A custom Uninstall Task that will handle the uninstall process. If not specified the default implementation (which is using commands) will be used.
  • validator: A custom validator class. By default no validator exists. You can implement a validator to be able to test your installation form the Web Interface.
  • NuxeoValidationState: The state of Nuxeo's validation process. One of: noneinprocess, _primary_validation_,_nuxeo_certified_.
  • ProductionState: One of: proto,testing, _production_ready_.

For more information on the package properties and the XML format see Package Manifest.

The Install Process

Packages are fetched from a remote repository and cached locally. Once they are cached they can be installed. Fetching a package and putting it into the local cache is transparent to the user - this is done automatically when a user enters a package to see the details about the package.

When saved to the local file system the packages are unzipped - so they will be cached locally as directories. Once a package is cached locally it can be installed by the user. When installing a package the package will be first validated - to check if it can be safely installed on the user platform. If this check fails the installation is aborted. If there are warnings - the user should choose if wants to continue or not.

After validating the package an install wizard will be displayed to the user. The wizard will usually show the following pages:

  1. Package license, if any is specified.
  2. Custom install forms, if contributed by the package.
  3. Summary of things that will be installed - this is the last step the user can abort the installation. When clicking install the install process will start.
  4. An install result page. This is either a page of failure either a page of success. In case of success, if the package requires restarting the server then the user is asked whether to restart now or later the server.

Here is a pseudo-code describing how installation is drived by the wizard:

LocalPackage pkg = service.getPackage("package_to_install");

Task task = pkg.getInstallTask();

ValidationStatus status = task.validate();
if (status.hasErrors()) {
  // install task cannot be run. show errors to the user
} else if(status.hasWarnings()) {
  // task can be run but there are warnings. show warnings to the user and let it decide whether or not to run the install task
} else {
  try {
    task.run(userPrefs);
  } catch (Throwabe t) {
    // if an error occurred do the rollback.
    task.rollback();
  }
}
// show install result to the user.
if (task.isRestartRequired()) {
 // ask user to restart
}

Using Ant to Install

When using ant you must define two ant scripts: the install.xml and uninstall.xml files.

Each of these scripts must have at least 2 ant targets. The default target of the install.xml script will be used to execute the installation. The target name is not important - it may have any name but should be the default target. The other required target of the script is a target named rollback which will be called to do the rollback if anything went wrong during the installation (i.e. during the execution of the default target).

The same rule applies for the uninstall.xml script. This ant script must have at least 2 targets: a default one which will be called to do the uninstall and another one named rollback which will be used to perform the rollback if anything went wrong during the uninstall execution.

There is a set of useful properties that will be injected in the ant context and thus are available in ant scripts. See below the list of these properties.

Using ant is not recommended since a safe rollback is difficult to handle.

Using Commands to Install

XML Commands are the default way to describe the installation instructions. The advantage of using commands is that the rollback and uninstall script will be automatically generated - you don't need to code it yourself. Also, you can control commands enabling or validation using EL expressions depending on the state of the target platform were the install is executed.

See Scripting Commands for more details on using commands .

As in ant scripts there is a set of properties you can use in command files to parametrize your commands. Below is the list of available properties.

Context Properties Available in Install Scripts

Here is the list of properties available to install scripts:

  • all the system properties in the running JVM.
  • package.id: The Package identifier.
  • package.name: The Package name.
  • package.version: The Package version.
  • package.root: The root folder of the package (the folder containing the exploded zip).
  • env.server.home: Since 5.5. The Nuxeo server home. ($NUXEO_HOME).
  • env.home: The Nuxeo Runtime Environment home. ($NUXEO_HOME/server/default/data/NXRuntime on JBoss, $NUXEO_HOME/nxserver on Tomcat).
  • env.ear: JBoss only. The nuxeo.ear directory ($NUXEO_HOME/server/default/deploy/nuxeo.ear).
  • env.lib: The Nuxeo lib directory (nuxeo.ear/lib on JBoss, $NUXEO_HOME/nxserver/lib on Tomcat).
  • env.syslib: The host application lib directory ($NUXEO_HOME/lib).
  • env.bundles: The Nuxeo bundles directory (nuxeo.ear/bundles on JBoss, $NUXEO_HOME/nxserver/bundles on Tomcat).
  • env.config: The Nuxeo config directory ([nuxeo.ear/config](http://nuxeo.ear/config) on JBoss, $NUXEO_HOME/nxserver/config on Tomcat).
  • env.templates: Since 5.5. The configuration templates directory. ($NUXEO_HOME/templates).
  • env.hostapp.name: The host application name (Tomcat or JBoss)
  • env.hostapp.version: The host application version (e.g. Tomcat or JBoss version)
  • sys.timestamp: The timestamp when the install task was created - a string in the format yyMMddHHmmss.

 

5 months ago GitHub NXDOC-1386: Fix config instruction
3 years ago Solen Guitter 43
4 years ago Solen Guitter 42
4 years ago Bertrand Chauvin 40
4 years ago Bertrand Chauvin 41
4 years ago Bertrand Chauvin 39
4 years ago Bertrand Chauvin 38
4 years ago Bertrand Chauvin 37 | Added link to NX IDE wizard page
4 years ago Solen Guitter 36
4 years ago Manon Lumeau 35
4 years ago Julien Carsique 34 | NXDOC-122: use configuration template instead of form
4 years ago Julien Carsique 33 | NXDOC-380: JIRA macro is broken
4 years ago Julien Carsique 32
4 years ago Julien Carsique 31 | NXDOC-122: ParametrizedCopy
5 years ago Solen Guitter 30 | Added TOC
5 years ago Alain Escaffre 28
5 years ago Alain Escaffre 29
7 years ago Solen Guitter 26 | replaced 5.4.3 with 5.5
7 years ago Solen Guitter 27 | Migrated to Confluence 4.0
7 years ago Julien Carsique 25 | NXP-6139 - add the templates folder as an env variable to the Update Center installer framework
8 years ago whajeri 24
8 years ago whajeri 23
8 years ago Stéfane Fermigier 22
8 years ago Stéfane Fermigier 21
8 years ago Eric Barroca 20
8 years ago Jane Zupan 19
8 years ago Alain Escaffre 18
8 years ago Bogdan Stefanescu 17
8 years ago Bogdan Stefanescu 16
8 years ago Bogdan Stefanescu 15
8 years ago Bogdan Stefanescu 14
8 years ago Bogdan Stefanescu 13
8 years ago Bogdan Stefanescu 12
8 years ago Bogdan Stefanescu 11
8 years ago Bogdan Stefanescu 10
8 years ago Bogdan Stefanescu 9
8 years ago Bogdan Stefanescu 8
8 years ago Bogdan Stefanescu 7
8 years ago Bogdan Stefanescu 6
8 years ago Bogdan Stefanescu 5
8 years ago Bogdan Stefanescu 4
8 years ago Bogdan Stefanescu 3
8 years ago Bogdan Stefanescu 2
8 years ago Bogdan Stefanescu 1
History: Created by Bogdan Stefanescu

We'd love to hear your thoughts!

All fields required