Skip to end of banner
Go to start of banner

Adding and Applying Comala Document Approval to a Space

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Current »

Overview

Applying a Comala Document Approval to a space applies the workflow to all the pages and blog posts. When the space approval workflow is active, the approval workflow is automatically applied when new pages and blog posts are created in the space.

The space application of the approval workflow overrides all approvals added and applied to individual pages and blog posts on a page-by-page basis.

Adding approvals to all pages and blog posts in a space

A Comala Document Approval workflow is added and applied to all pages and blog posts in the space by making the approval workflow active in the document approval dashboard in a space.

The addition and application of the space approval workflow is by the space administrator(s).

Open the space document approvals dashboard

Choose Space Settings in the sidebar menu.

In the Confluence sidebar menu

  • choose Space Settings

  • choose App links

cdac_spacesettings_applinks.png
  • select Comala Document Approval

This displays the space settings document approval dashboard.

cdac_spacesettings_documentapprovaldashboard_workflow_inactive.png

The Basic Approval Workflow is listed in the dashboard. This is a simple three-state approval workflow for the Comala Document Approval app.

The Basic Approval Workflow is disabled in the space by default. When disabled a user with edit permission for a page or blog post in the space can add and apply an approval workflow to an individual page or blog post.

To display information details of the basic approval workflow

  • choose the View detail icon

cdac_documentapprovaldashbaord_baw_inactive_extract_viewdetailicon_highlighted.png

A popup displays a visual flowchart and description of the workflow.

cdac_viewdetails_popupdialog_baw_flowchart_description.png

Apply the workflow

Apply the Basic Approval Workflow to all the pages and blog posts in the space by

  • select the toggle slider next to the Basic Approval Workflow name

cdac_documentapprovalsdashboard_extract_baw_inactive_grey_toggleslider.png
  • click on the slider to enable the approval

The workflow is active and enabled as the space approvals workflow.

An on-screen notification confirms that the space configuration has been successfully saved.

The active approval workflow is added and applied to

  • all the pages and blog posts in the space

  • added to any new pages or blog posts created in the space

Comala Document Approval app uses the same approvals workflow (with identical workflow states and transitions) in this space mode of application, and when adding the approval workflow to a page or blog post on a page-by-page basis (page mode of application). 

Configuration and settings

Several options are available to configure the space approval workflow.

In the document approval dashboard

  • choose the ellipsis menu

cda_documentapprovasldashboard_ellipsismenu_allavailable_noappversion.png

When the approval workflow is active, two options are enabled

  • Initialize States - set the approval state for all the space content by initializing the workflow state

  • Clear Document Activity - clears the approval document activity for all the pages and blog posts

The actions for each of these options cannot be undone.

Initialize States

Use the document approval dashboard ellipsis dropdown menu to set the approval state for pages and blog posts in the space.

The Initialize states ellipsis menu option is disabled when the space approval workflow is inactive.

Initializing states causes a page with an applied workflow but no workflow actions or an outdated (obsolete) workflow state to be set to a selected state. The space administrator also has the option to reset the workflow states for all the pages and blog posts.

  • choose Initialize States

cda_documentapprovasldashboard_ellipsismenu_initailizestates_noappversion.png

In the dialog box, a state must be selected for the initialization destination state.

cdac_initializestates_dialogbox_noselected_state.png
  • choose the state from the dropdown menu

cdac_initializestates_dropdownmenu_state_options.png
  • (if required) check the Override preexisting states checkbox to set all the workflow states to the selected state

cdac_initailizestates_overrideexistingstates_option.png
  • choose Initialize

This cannot be undone!

An on-screen notification confirms the completion of the state initialization.

cdac_message_suucessful_states_initailized.png

Override preexistent states is used:

  • on the initial application of the space workflow to reset all the content in the space to a specific state of the approval workflow

  • on a required date to ensure review of all the content in a mature space for example.

Clear Document activity

Choose Clear Document Activity to reset all the workflow events and action history for approvals for this space. This includes all pages and blogposts, approvers, and assigned reviewers.

The Clear Document Activity ellipsis menu option is disabled when the space approval workflow is inactive.

  • choose the document approval dashboard ellipsis menu

cdac_documentapprovaldashboard_ellipsismenu_cleardocumentactivity.png
  • choose Clear Document Activity

In the dialog box

  • choose OK, clear Document Activity

cdac_documentapprovalsdashboard_cleardocumentactivity.png

This cannot be undone!

The clears the Document Activity of all pages and blog posts including document activity from approvals applied on a page-by-page basis.

Disabling the space approval workflow

To disable the space mode application of the approval workflow across the content in a space, in the space settings document approval dashboard

  • click the blue toggle slider next to the Basic Approval Workflow name

cdac_documentapprovaldsahbord_enabled_baw_extract.png

The toggle slider moves to grey.

cdac_documentapprovaldsahbord_disabled_baw_extract.png

Any previous approval workflow added and applied to individual pages or blog posts on a page-by-page basis is re-enabled. The page approval workflow state is the last state before the space approval workflow was disabled.

Users with Edit permissions can add a Comala Document Approval to an individual page or blog post in the space when the space approval workflow is inactive.

Document report

When the space approval workflow is inactive in a space and there are no approvals added on a page-by-page basis, the document report displays a message stating the Comala Document Approval is disabled for the space.

cdac_documentreport_inactivespaceapproval_nopageapprovals.png

When the space approval workflow is disabled, the Document Report displays details of documents with an individual page approval workflow added.


  • No labels