Tutorials

2- Creating the Subworkflows

Updated: February 9, 2017 Page Information Edit on GitHub

This document is part of the Sub Workflow Example project series.

What Will We Do in this Step?

We will create the subworkflows that may be called from the main workflow depending on the document's metadata. We will need two separate workflows as the business logic is different between them. The first workflow will have one Accept/Reject node, the other will have two successive ones.

A single level validation workflow and a two-level validation workflow are both elements we could use again in the future, so we will keep them generic. Allowing a generic workflow design is one of the major assets in the subworkflow functionality.

Prerequisites

Before starting this tutorial step, make sure you create in your Nuxeo Platform Admin Center a user with "Eric" as his username and a user group named "accounting" with at least one member.

Creating the Accounting Validation Workflow

In our case this workflow will be used if the expense is worth less than $100 and not belonging in the "misc" category, but it needs to be reusable in another context as well.

  1. In Nuxeo Studio, go to Workflow > Process definitions and click on the New button.
  2. Fill in the fields:

    • Feature ID: subOneLevelValidation
    • Label: Generic one level validation workflow.
  3. Click on the Ok button. The Definition tab of the workflow is displayed.

Variables Tab

We want to keep this workflow generic, remember? So what we will do is setup a workflow variable to define the assignees. The parent workflow will send us the variable content.

  1. Add a variable named level1Assignees.
  2. Choose the String type.
  3. Check multi-valued (we may have several assignees).
  4. Save your modifications. Look at the result below:

Activation Tab

We do not want anybody to launch this subworkflow directly, so we will set rules to restrain its visibility.

  1. In the "Current document state is" field, type hideThisWorkflow. As this lifecycle state does not exist, this trick will ensure the workflow will never appear in the drop-down list.
  2. Save your modifications. Look at the result below:

Graph Tab

  1. Drag and drop the following nodes on your graph:

    • A Start node,
    • An Accept/Reject node,
    • An end node (Stop).
  2. Link the Start node's output to the Accept/Reject node.
  3. Link the Accept/Reject node's output transitions to the end node. Your graph should look like this:

Edit the Accept/Reject Node

General Tab

Set the following values:

  1. Title: First level validation
  2. Directive: Please review this document.
  3. Assignees expression: Replace the value with the following MVEL expression: @{WorkflowVariables["level1Assignees"]} This calls the corresponding workflow variable that will be set in the parent workflow.
  4. Grant permission to task assignees: Read (in our case we want to make sure the accountants will be able to view the document, not necessarily to modify it).
  5. Look at the result below:

Transitions Tab

  1. In the validate transition, click on the Create button to add a new automation chain.
  2. Name your chain validateDoc.
  3. Set your chain as following:

    Operation Parameters
    Fetch > Context Document(s)  
    Document > Follow Life Cycle Transition Value: approve
  4. Save your modifications.

Creating the Accounting + General Manager (GM) Validation Workflow

In our case this workflow will be used in the other possible situations, but it needs to be reusable in another context as well.

  1. In Nuxeo Studio, go to Workflow > Process definitions and click on the New button.
  2. Fill in the fields:

    1. Feature ID: subTwoLevelsValidation
    2. Label: Two levels validation workflow
  3. Click on the Next button.

Variables Tab

Here comes another generic workflow. This time again we will setup workflow variables to define the assignees and the parent workflow will send us the variables content.

  1. Add a variable named level1Assignees, and another one named level2Assignees.
  2. Choose the String type for both.
  3. Check multi-valued for both. Look at the expected result:
  4. Save your modifications.

Activation Tab

Same goes for this subworkflow:

  1. In the "Current document state is" field, type hideThisWorkflow. As this lifecycle state does not exist, the workflow will never appear in the drop-down list.
  2. Look at the expected result:
  3. Save your modifications.

Graph Tab

  1. Drag and drop the following nodes on your graph:

    • A Start node.
    • Two Accept/Reject nodes.
    • An end node (Stop).
  2. Link the Start node's output to the first Accept/Reject node.
  3. Link the first Accept/Reject node's validate output transition to the second Accept/Reject node.
  4. Link the second Accept/Reject node's validate output transition to the end node.
  5. Link both Accept/Reject node's reject output transitions to the end node. Your graph should look like this:
  6. Save your modifications.

Edit the First Accept/Reject Node

General Tab

Set the following values:

  1. Title: First level validation.
  2. Directive: Please review this document.
  3. Assignees expression: Replace the value with the following MVEL expression: @{WorkflowVariables["level1Assignees"]} This calls the corresponding workflow variable that will be set in the parent workflow.
  4. Grant permission to task assignees: Read (in our case we want to make sure the accountants will be able to view the document, not necessarily to modify it).
  5. Look at the expected result:
  6. Save your modifications in the node and on the graph.

Edit the Second Accept/Reject Node

General Tab

Set the following values:

  1. Title: Second level validation
  2. Directive: Please review this document.
  3. Assignees expression: Replace the value with the following MVEL expression: @{WorkflowVariables["level2Assignees"]} This calls the corresponding workflow variable that will be set in the parent workflow.
  4. Grant permission to task assignees: Read
  5. Look at the expected result:

Transitions Tab

  1. In the validate transition, select the validateDoc chain. Look at the expected result:
  2. Save your modifications in the node and on the graph.

That's it! Our sub workflows are ready, now only remains the one workflow to rule them all, the main workflow.

3 months ago Solen Guitter NXDOC-1087: Use new previous/next navigation
3 months ago GitHub Review list in list
3 months ago Pedro Costa NXDOC-1080: updates review dates
3 months ago Pedro Costa NXDOC-1080: reviewed text and updated some labels
4 months ago Solen Guitter NXDOC-907: user 'lifecycle' instead of 'life cycle
5 months ago Andrew Goodricke Add content-review-lts2016 to labels
6 months ago Kevin Leturc NXP-19481: Update MarkLogic page to detail how to configure range element indexes
2 years ago Manon Lumeau 19
2 years ago Manon Lumeau 18
2 years ago Manon Lumeau 17
2 years ago Manon Lumeau 16 | TOC
3 years ago Solen Guitter 15 | Fixed broken links
4 years ago Solen Guitter 13 | Fixed formatting and typos
4 years ago Solen Guitter 14
4 years ago Bertrand Chauvin 12 | Fixed error
4 years ago Bertrand Chauvin 11
4 years ago Bertrand Chauvin 10
4 years ago Bertrand Chauvin 9
4 years ago Bertrand Chauvin 8
4 years ago Bertrand Chauvin 7
4 years ago Bertrand Chauvin 6
4 years ago Bertrand Chauvin 5
4 years ago Bertrand Chauvin 4
4 years ago Bertrand Chauvin 1
4 years ago Bertrand Chauvin 2
4 years ago Bertrand Chauvin 3
History: Created by Bertrand Chauvin