Nuxeo Server

Workflow

Updated: September 22, 2017 Page Information Edit on GitHub

Concept

The Nuxeo workflow engine provides the usual features you would expect from a workflow engine and leverages the main modules of the platform: the repository, the Automation service, layouts for all the user interactions and process implementations. It provides high level features regarding task management such as filterable tasks lists, reminders, task reassignment, task delegation, task reminders. You need to understand correctly those concepts before playing with the workflow engine.

A workflow is conceptually defined using a graph. Workflow graphs are configured from Nuxeo Studio.

The workflow engine provides means to implement most of BPMN concepts: Fork, merge, decision, branching point, exclusiveness, inclusiveness, looping, human tasks, services tasks, multiple instances, events, data objects, subprocess, join. Note that those standard concepts are not all exposed as is on the graph editor, but can still be implemented leveraging what is provided.

Understanding Workflow:

Default Available Workflows

The Nuxeo Platform proposes two default workflows that showcase the possibilities of the Workflow.

  • The default serial workflow, called "Serial document review", is an ordered workflow. This means that participants can review the document only when the previous participant in the list has approved the document. It can be used either to approve the document or simply to review it.

  • The default parallel workflow, called "Parallel document review", is an unordered workflow that enables to change the document's state after a consultation step. This means that participants can give their opinion on the document without having to wait for a previous participant to approve it.

They are also available as an application template in Nuxeo Studio so as to enable you to see how they are configured. This application template is called Default Nuxeo Platform Workflows Configuration.

It is possible to import this package from your Studio project : Go to Configuration > External Templates > Default Nuxeo Platform Workflows Configuration and click on Import.

See the pages Serial Document Workflow and Parallel Document Workflow for more details about showcased default workflows.

Configuring a New Workflow

To create a new workflow, simply go to the workflow section of Studio, click New and choose a name.

A workflow can be configured through four tabs:

  • Definition: Where you select the name and label of the workflow.
  • Variables: Where you can manage the Workflow variables that will be used through-out the different steps of the workflow, like comments, user inputs...
  • Availability: Where you define the filter to enable or not the workflow.
  • Graph: Where you define all the workflow steps and their transitions. This is the most important tab. After you create your workflow, it's normal you get validation error, pending the creation of the graph.

Starting the Workflow

A workflow must start with a node for which the "start node" property is checked and have at least one end node with the "end node" property checked. To make it simpler, Studio provides a node template library (on the left), from which a Start node and an Stop node are available.

To start the workflow graph:

  1. Click on the Graph tab.
  2. Drag the Start node and drop it on the graph.
  3. Repeat this operation for every node and transition that you need to create your own workflow. Click on one node to open the editor to edit its properties and add possible transitions. Each possible transition is represented as an endpoint on the node.

Working with Workflow:

Discover More

To go further, read the page Simple Workflow Example, and follow the creation of a workflow step by step with a specific use case.


3 days ago manonlumeau NXDOC-1323: Update BDE doc
a year ago Manon Lumeau 34
a year ago Manon Lumeau 33
a year ago Manon Lumeau 32 | Fix Studio menu label
a year ago Manon Lumeau 31 | Fix Studio menu label
2 years ago Solen Guitter 30
2 years ago Solen Guitter 29
2 years ago Manon Lumeau 28
2 years ago Solen Guitter 27
2 years ago Manon Lumeau 26
2 years ago Manon Lumeau 25
2 years ago Manon Lumeau 24
3 years ago Manon Lumeau 23
3 years ago Solen Guitter 22
3 years ago Alain Escaffre 21
3 years ago Alain Escaffre 20
3 years ago Manon Lumeau 19
3 years ago Manon Lumeau 18
3 years ago Manon Lumeau 17
4 years ago Mariana Cedica 16
4 years ago Solen Guitter 15
4 years ago Alain Escaffre 14
4 years ago Alain Escaffre 13
4 years ago Solen Guitter 12 | Added children pages
4 years ago Alain Escaffre 10
4 years ago Alain Escaffre 11
4 years ago Alain Escaffre 8
4 years ago Alain Escaffre 9
4 years ago Alain Escaffre 7
4 years ago Alain Escaffre 6
4 years ago Alain Escaffre 5
4 years ago Solen Guitter 4
4 years ago Solen Guitter 3
4 years ago Mariana Cedica 2
5 years ago Mariana Cedica 1
History: Created by Mariana Cedica