Configuration - Global
- Robert Alexander Marshall
- Alain Martínez
Screen Location: Confluence Administration → Comala Document Management section → Configuration
Overview
The global Comala Document Management configuration screen is used to set global configuration options for the behavior of Comala Document Management, including workflow visibility for users.
Configuration
Some of these settings can be overridden at the space level on a space-by-space basis—see Configuration - Space Tools.
You can also configure Security options, including setting the spaces where workflows can be applied or are restricted.
Setting | options | Notes | Version |
|---|---|---|---|
Workflow Activity and Drafts VisibilityWho can see workflow activity and unpublished drafts? See also: | Space Administrators and Page Editors | Default: Recommended for most use cases. Unpublished drafts and activity reports will not be visible to users who can otherwise usually be able to view the content. |
|
Anybody | Anyone who can typically view the content can view drafts and activity reports. They will also be able to take part in Content reviews (v4.6+). |
| |
Default Tasks ModeWho can complete tasks? See also: | Strict | Only the task assignee or task creator. |
|
Lenient | Default: Recommended for most use cases. Any user who can edit the page/blog. |
| |
State's Task BehaviourWhat happens to incomplete tasks from the current state if the workflow transitions to a new state? See also: | If the page state changes, open tasks will be closed | Incomplete tasks will be closed. |
|
If the page state changes, open tasks will be moved to a new state | Default: Recommended for most use cases. Incomplete tasks are copied to the new workflow state. |
| |
Approval CommentMandate reviewer comment when Approving or Rejecting content? See also: | Optional | Default: Recommended for most use cases. Comment is optional. |
|
Required | A reviewer must add a comment during content reviews. |
| |
Page Update Reset ApprovalIf an approval (content review) is in progress, what effect does editing the content have? See also: | Reset | Default: Any existing Approve/Reject decisions will be reset. |
|
Ignore | Existing Approve/Reject decisions will be retained. |
| |
Published View Macro TransformWhich version of content should the include and excerpt-include macros show? See also: | Enabled | Default: Recommended in most use cases. Use the published version if available; otherwise, use the latest version regardless of workflow state. |
|
Disabled | Show the latest version, regardless of workflow state. |
| |
Document Actions Dashboard*When enabled, any pending document actions for the current user are displayed on the Confluence dashboard. | Enabled | Default: Displays the current user's pending document actions (assigned tasks, assigned approval reviews) on the Confluence dashboard. | v6.14.0+ |
Disabled† | The current user's pending document actions are not displayed on the Confluence dashboard. |
| |
* The Document Actions Dashboard is available from Comala Document Management v6.14.0 |
| ||
Enable CDM Actions in Page Tools
| Checked (Enabled)
| Default: Comala Document Management actions are displayed in the page tools menu. These app actions include Add Task, Add Page Workflow, Add Read Confirmation, Edit Parameters, Remove Page Workflow, Remove Read Confirmation, Edit with Workflow Builder, Edit with Markup. | v7.7.0+ |
Unchecked (Disabled) | When the option is not checked, the app actions are not displayed in the page tools menu. | ||
Enable Usage Statistics and Enable Comala Document Management Migration Assessment
By default, anonymous usage statistics are enabled. These are sent to Comalatech to help improve the product.
You can also enable the Comala Document Management Migration Assessment to collect and store usage data, which can be copied and added to a support request.
Setting | Options | Notes |
|---|---|---|
Enable Usage Statistics | Checkbox (Default: checked) | When enabled, anonymous usage statistics are sent to Comalatech to help improve the product. |
Enable Migration Assessment data storage | None | The Comala Document Management Migration Assistant collects and stores usage data. See the Comala Document Management Migration Assistant page for information. |
User Onboarding
Check the Enable Onboarding box to enable an option for a user to undertake an app tour and access tips.
It is accessed using a message notification on a page. The user can turn off the notification using an option in the message box.
Setting | Options | Notes |
|---|---|---|
User Onboarding | Enable Onboarding
Display top bar Link
| When enabled (checked):
|
Show or hide workflow translator
v7.1.0 Data center v6.18.0 Server
Check this option to turn off the display of the workflow translator option in the workflow builder for all users, for example, using the workflow builder visual editor.
Setting | Options | Notes |
|---|---|---|
Workflow Translator | Show the Workflow Translator
| When enabled (checked), the workflow translator option is displayed in the workflow builder. |
Security
Setting | Options | Notes |
|---|---|---|
Space WorkflowsWhich spaces can use Space Mode? | List of spacekey | A list of comma-separated space keys Leave empty for no spaces, or specify |
Page WorkflowsWhich spaces can use Page Mode? | List of spacekey | A list of comma-separated space keys Leave empty for no spaces, or specify |
Workflow Importer GroupSpace admins in the specified group are allowed to import workflows. See also: | User group | Set as confluence-users to allow all space admins to import workflows. |
email Any AddressWhich email addresses can you use in the {send-email} macro? See also: | Disabled | Recommended in most use cases. Only email addresses associated with a registered user account |
Enable | Use any email address |
Loop Watchdog
These settings are used to detect infinite loops and terminate any offending workflows. It's recommended that the default values be left.
Likely causes of infinite loops include:
cyclic or recursive use of the set-state macro
cyclic use of the
due dateparameter on the state macro.
Setting | Options | Notes |
|---|---|---|
Maximum EventsIf this amount of events is exceeded on a single page by a single user, the threshold timer will start (see below). | Number | Default: |
Time Threshold (seconds)If the Maximum number of Events is exceeded for this time, the loop will be treated as infinite, and the process will be terminated. | Number | Default: |
Impersonation group for Refresh Data
Edit the settings to add a Confluence user group with global administrator permissions. This user group is used to impersonate a Confluence admin when running the refresh data process in a space. It lets a space administrator successfully refresh the workflow data for a space, including pages with page-level edit restrictions.
Setting | Options | Notes |
|---|---|---|
Admin user group | Default value: Not set Accepted value: Confluence user group
| When set, a user from the user group is used to impersonate a Confluence admin when running the refresh data process in a space. This ensures the process has access to restricted pages in the space. |
Administrative Events Logging
Comala Document Management events are logged in the Confluence Audit log.