How-to guides#

This part of the documentation contains directions toward a result. Each guide assumes you already know what you want and shows you how to get it.

If you are meeting the package for the first time, work through Add a second workflow to a content type instead.

Getting set up#

Install the package

Add the backend package and the Volto add-on to a project, and install the profile.

How to install collective.multiworkflow
Install the worked example

Load the worked example and see an additional workflow running end to end.

How to install the worked example
Add to an existing site

Populate the new catalog index on a site that already holds content.

How to add the package to an existing site

Declaring workflows#

Declare additional workflows

Make a behavior contribute workflows to every type that enables it.

How to declare additional workflows for a behavior
Write a composing workflow

Write a workflow definition that composes with the one already in the chain.

How to write a workflow that composes

Working with the states#

Read and transition state

Read a specific workflow's state, and execute a transition belonging to it.

How to read and transition workflow state
Search by workflow state

Find content by its state in any workflow, from code and from a collection.

How to search by an additional workflow state
Audit permission conflicts

Find permissions claimed by more than one workflow, and resolve the overlap.

How to audit permission conflicts

Building an interface#

Consume the REST API

Read the chain, execute a transition, and read the merged history from a REST client.

How to consume the REST API
Customize the Volto components

Restyle the controls, read the chain in a component of your own, and shadow what the add-on ships.

How to customize the Volto components

See also

The Diátaxis framework calls this class of documentation how-to guides.