×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Compatibility with Comala Workflows

Roman Serazhiev

Roman Serazhiev Last update: Oct 30, 2018

Scroll Versions' built-in workflow engine cannot currently be customized. If you want to use more complex workflows, we recommend using Comala Workflows in combination with Scroll Versions.

This article will explain how to integrate Comala Workflows with Scroll Versions – the guide is suitable for all users, regardless of which of these add-ons they are currently using.

Initial steps

Before you start, the following add-ons must be installed on your Confluence instance:

Info

Please make sure that you are working with Comala Workflows version 4.14 or later.

Furthermore, Scroll Versions must be activated in your space.

Firstly, make sure all pages you want to be managed by Scroll Versions and Comala Workflows are set as versioned – this is necessary because unversioned pages don’t have a workflow state.

Convert pages to versioned by opening them and clicking Versions > Convert to versioned page:

Info

If you have just activated Scroll Versions, all pages in the space will be unversioned until you convert them yourself or edit them for the first time.

Implementing the workflow

Now, you need to create or customize your Comala Workflow at General configuration > Workflows.

If you don't have a Comala Workflow, you need to create one or use one of the templates included in the add-on. The add-on now includes a 'Scroll Versions Documentation Workflow' which is useful if you are used to using the integrated workflow but need to expand it for more functionality.

If you create your own workflows, replace the final=true property in the state field with versionscompleted=true.

If you already have a Comala Workflow, you need to edit it and replace the final=true property in the state field with versionscompleted=true to make it compatible (if you want to continue to use the existing workflow without Scroll Versions, please create a copy before making these edits).

Note

final=true properties have to be removed from the state field.

Now, you need to add the Comala Workflow to your space and configure it as the Space Workflow. Firstly, go to Space tools > Workflows, and add your workflow to the space using the wizard.

The workflow will now be added to the space – but it will be configured as a Global Workflow. Copy it to create an identical workflow which is configured as a Space Workflow.

Note

Scroll Versions can be used with only one active Comala Workflow per space. Please disable all other workflows in the Space tools > Workflows screen.

Now, remove the Global Workflow, and activate the Space Workflow.

Once the workflow is activated, you can complete the integration by going to Space tools > Scroll Add-ons > Settings, and selecting Advanced Workflow. The Comala Workflows and Scroll Versions add-ons are now integrated in your space.

Info

After you have started working with Comala workflows in your space, you can use the Workflow Report to get an overview of workflow states of pages in a specific version.

What happens to my pages after the integration?

  • If you integrated Scroll Versions into an existing Comala Workflows space, all versioned pages in your space will be merged with their already existing Comala Workflows state. Depending on the size of your space this can take a while.
    (info) Please note, that unversioned pages can not have a Comala Workflow in spaces managed with Scroll Versions.
  • If you integrated Comala Workflows into an existing Scroll Versions space, each versioned page in your space is assigned the Comala Workflow's initial state. You can also use Comala Workflows' built-in initialization task to convert your versioned pages to your desired Comala Workflow state.

  • If you integrated Comala Workflows into an existing Scroll Versions space where the built-in workflow engine is activated, the pages' states are converted from the Simple Workflow state into the Comala Workflows state as follows:

Simple Workflow

Comala Workflow

Draft, Review

Initial state

Complete

State marked with versionscompleted=true

2xlatest
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok