Administration - Global Configuration

Owned by
Robert Alexander Marshall
Dec 14, 2023
4 min read
1 Configuration | 2 Usage Statistics | 3 User Onboarding | 4 Security | 5 Notifications Screen | 6 Workflow Notifications | 7 Upgrade Activity

Comala Document Approval global configuration options, found under the Confluence global administration console.

From Comala Document Approval v1.11, a global administrator can choose a Document Activity Upgrade option to run pre-upgrade checks to Comala Document Approval 2 (Data Center Only).

Configuration Screen

Choose one of the Edit buttons on the screen to display the configuration options.

Setting

Options

Notes

Setting

Options

Notes

Configuration

For the visibility of approval activity and draft and final content

Approval Activity and Drafts Visibility

Who can see approval activity and unpublished drafts?

Space Administrators and Page Editors

Recommended for most use cases.

Unapproved drafts and activity reports will not be visible to users who would otherwise normally be able to view the content only. (Not edit)

Anybody

Anyone who could normally view the content will be able to view drafts and activity reports.

Page Update Reset Approval

If an approval (content review) is in progress, what effect does editing the content have?

Reset

Any existing Approve/Reject decisions will be reset.

Ignore

Existing Approve/Reject decisions will be retained.

Published View Macro Transform

Which version of content should the {include} and {excerpt-include} macros show?

Enabled

Recommended in most use cases.

Use the approved version if available, otherwise use the latest version.

Disabled

Show the latest version content, regardless of the approved state version.

Document Dashboard Actions Component

Whether to display the Document Actions Report for the current user on the Confluence dashboard?

Enabled

Show's current user document actions report for pending assigned approvals on the Confluence dashboard.

Disabled

Document actions report is not displayed on the Confluence dashboard.

User Onboarding

Provides a user tour and tips for new users

Enabled/Disabled

Default Enabled provides a tour and tips for new users.

Usage Statistics

Enable Usage Statistics

Checkbox

When enabled, anonymous usage statistics will be sent to Comalatech to help improve the product.

User Onboarding

Enable onboarding

Checkbox

When enabled introductory information and tips will be shown to new users: User Onboarding.

Security

Setting the spaces where page approvals can be added and applied

Space Approvals

Which spaces can have space wide approvals enabled.

List of spacekeys

Check buttons

  • Allowed

  • Restricted

A list of comma-separated space keys.

Leave empty for no spaces, or specify ANY to indicate all spaces.

If

  • Allowed checked then space scope workflows can be added to content in the spaces listed

  • Restricted checked then space-scope workflows can only be added to content in the spaces listed

Page Approvals

Which spaces can use page-level approvals

List of spacekeys

Check buttons

  • Allowed

  • Restricted

A list of comma-separated space keys.

Leave empty for no spaces, or specify ANY to indicate all spaces.

If

  • Allowed checked then page-level workflows can be added to content in the spaces listed

  • Restricted checked then page-level workflows can only be added to content in the spaces listed

Notifications Screen

Setting

Options

Notes

Setting

Options

Notes

Workflow Notifications

Notifications for given workflow events

Approval - Assignee

Checkbox

Send notification emails to approval assignees when they are assigned an approval on a page.

Read Confirmation

Checkbox

Send notification to read confirmation assignee(s) for all read confirmation events for a read confirmation added to a page

Upgrade Activity

Comala Document Approval 2 is data center only and uses a new, improved capability called Document Activity in place of the Page Activity.

  • existing spaces with applied workflow (or workflow activity) will need their workflow data upgraded to use the capabilities of document activity

  • new spaces created after installation of Comala Document Approval 2.0+ (and existing spaces without workflow activity) will automatically use document activity when a workflow is applied

Global administrators can undertake an upgrade check process using the Document Activity Upgrade screen options.

In the Document Activity Upgrade screen choose one or more spaces to run upgrade checks prior to an upgrade to Comala Document Approval 2 (Data Center Only).

This upgrade check identifies any errors in the existing data prior to the upgrade and provides an estimate of the time for the upgrade on a space-by-space basis.

In Comala Document Approval 2.0 the console is used to run the upgrade and pre-upgrade checks together.

Upgrading the data requires Comala Document Approval 2.0+ to be installed and Read Only Mode to be enabled in your data center instance.