K15t Scroll Versions app

Overview

This page describes how to install Scroll Versions app with Comala Document Management.

Open

You will need the following apps

• Comala Document Management (formerly Comala Workflows) version 5.0+

• Scroll Versions for Confluence version 3.7.4+

• Comala Document Management for Scroll Versions version 3.7.6+

In particular, the K15t Scroll Versions and Comala Document Management for Scroll Versions apps must be compatible versions - each version release notes of Comala Document Management for Scroll Versions in the Atlassian Marketplace lists the compatible versions of K15t Scroll Versions.

Benefits

Integrate Scroll Versions with Comala Document Management to let you create the workflows you need, even in spaces with multiple versions and variants.

Scroll Versions and Comala Document Management are both class-leading flagship products in their own right: now, you can combine them in your spaces for ultimate control over version and workflow management:

• Comala Document Management allows you to define customized workflows to create, review, approve and publish your content.

• Scroll Versions is the engine that powers great documentation. It takes management, authoring, and publishing in Confluence to new levels of ease and flexibility. Scroll Versions adds functionality for version management, variant management, permalinks (including duplicate page titles), enhanced content re-use, support for context-sensitive help, and much more.

The following Comala Document Management trigger action macros  are not compatible with the Scroll Versions app. These macros will not work for content that uses the Scroll Versions app and has an applied workflow that uses the macro in a workflow trigger.

• approve-children

• set-state

Step 1: Activate Scroll Versions

Scroll Versions must be activated in your space.

Step 2: Ensure pages are versioned

Make sure all pages you want to be managed by Scroll Versions and Comala Document Management 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:

Open

Step 3: Implement the Workflow

If you don't have a Workflow, you need to create one or edit one of the workflows bundled with the Comala Document Management app.

Step 4: Update the final state in your workflow

Create or customize your workflow – at space level:

• Document Management - Space Tools

Update the state macro in your workflow which has the final=true parameter and rename that parameter to versioncompleted=true. This parameter is specific to the Scroll Versions integration.

An example is shown below:

It is crucial to remove the final=true parameter when using the versioncompleted=true parameter.

Step 5: Enable the workflow

Your workflow must be used in space mode and additionally, must be the only workflow active in that space. If you have any other workflows listed on the Document Management Dashboard, remove them before activating the new workflow.

Step 6: Update Scroll Versions settings

Once the workflow is activated, you can complete the integration by going to Space tools → Scroll Add-ons → Additional Settings, and selecting Advanced Workflow.

The Comala Document Management and Scroll Versions apps are now integrated in your space.

What happens to my pages after the integration?

If you integrated Scroll Versions into an existing Workflows space, all versioned pages in your space will be merged with their already existing Workflows state. Depending on the size of your space this can take a while.

If you integrated Comala Document Management into an existing Scroll Versions space, each versioned page in your space is assigned the Workflow's initial state. Alternatively you can use Initialize States to force all content to a different state.

If you integrated Comala Document Management 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 Workflows state as follows:

See also

External link

• K15t Scroll Versions for Confluence Product Documentation