Skip to main content
Skip table of contents

Integrate with Comala Document Management

You can integrate Comala Document Management with Scroll Viewport. This gives you the option to only show content that has been approved in a Comala Workflow, and is in the final workflow state. This state can be any Comala Workflow state with the final:true parameter, regardless of the state's name. This guide explains how to integrate Comala Document Management and Scroll Viewport, and how to activate this option.

Initial Steps

Before you start, you must fulfil the following prerequisites:

Show Only Content in the Final Comala Workflow State

Now the additional option Comala Document Management Integration can be activated in the Content tab of the Scroll Viewport Configuration by activating the check box Public Content Only.

If that option is activated, only content, i.e. pages and blog posts, that have been transitioned to the final workflow state will be displayed in the Scroll Viewport view. If there's a piece of content that has a version in the final state, as well as a draft version, your authors will be able to access the draft via the Confluence view, whereas your readers can only see the final state through the Scroll Viewport view. Be aware that if you just start to use Comala Document Management in the respective space there can be a lot of pages that do not have an associated workflow state and thus are treated as if they are in a normal Confluence space, i.e. these pages are visible in Scroll Viewport. Comala Document Management gives you the possibility to initialize states. The same effect occurs if you move pages from a space that does not use Comala Document Management into the space.

The page tree will show all pages of the space (of course respecting Confluence permissions and restrictions) regardless of their workflow state, but if a page is chosen that does not have an approved version yet, the following placeholder is displayed:

When you use the Scroll Help Center theme you can hide such a brand new page using the scroll-help-center-exclude-page for non confidential information. Regardless of the theme you can always hide pieces of content using Confluence restrictions. 

For pieces of content that have been approved before, the last version that has been approved will be shown in the Scroll Viewport view.

Performance Tuning

Comala Document Management stores the page status in a storage object called a 'Content Property', which is a small amount of content that is logically stored under a page (like an attachment). To allow quick access to the these states it is important that your Confluence Cache of type Content Properties (com.atlassian.confluence.core.DefaultContentPropertyManager) is large enough to cache the states, otherwise all page and page tree related operations can become slow.

Limitations

Search results

If the internal Confluence search is used, the search results might show pages that are not accessible if a user searches for a term that's used on a draft page (which is the same behavior as if you'd use Comala Document Management in a vanilla Confluence system).

If the user clicks such a result, the page won't be available.

As a workaround - if your space is available without login - you could use an external search implementation instead of using the built-in Confluence search.

Scroll Versions and Scroll Translations

The integration does not work in spaces that are managed with Scroll Versions or Scroll Translations.

If you want to use Comala Document Management with Versions, please use the Comala integration for Scroll Versions, follow the Private Master Space Approach, and activate Scroll Viewport in the published spaces.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.