Getting Started with the Nuxeo Platform

This addon adds content and configuration to follow the "Getting Started With the Nuxeo Platform” tutorial (

For Nuxeo Platforms Pattern(s): server-11.*


This addon brings the following custom elements, required for the Getting started with the Nuxeo Platform tutorial. This plugin is not intended to be used in a business context but to execute the sample API calls of the tutorial.

  • The portfolio document type (BCPortfolio) holds the contracts of a customer. Its holds properties about the customer: the company name, industry and size, and the customer’s juridical contact information.

  • The contract document type (BCContract) have several properties: an owner (an application user), some dates (signature, start, expiration dates), a type, an amount. It inherits customer information from its portfolio.

  • Some vocabularies are used to populate the portfolio and contract metadata (companySize, contractType and industry)

  • Contracts have a specific lifecycle, so they can evolve though the states draft, approval, running, renegociation, void, deleted and restored

  • Some business logic through automation chains and event handlers make contracts inherit properties from its portfolio, and evolve following its lifecycle


The Getting Started with the Nuxeo Platform addon requires the installation of the corresponding Nuxeo package.


This addon requires no additional configuration step.

Compatible Target Platforms

Nuxeo Platform LTS 2021 Nuxeo Platform 11.x Nuxeo Platform LTS 2019 Nuxeo Platform LTS 2017
  • Install 1.4.0
  • How to install nuxeo-platform-getting-started 1.4.0

    This package is only available to Nuxeo Online Services customers.

    To download or install this package, please login to your Nuxeo Online Services account or contact us to learn more.

About this Package
Other Versions
1.3.3 1.2.3