This site has moved to the integrated Appfire documentation and information site for our apps.
From February 2024 this site is no longer updated.
Take a look here! If you have any questions please email support@appfire.com
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 space level, on a space-by-space basis – see: Configuration - Space Tools
You can also configure Security options. This includes the option to set the spaces where workflows can be applied or restricted.
Setting | Options | Notes |
|---|---|---|
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 would otherwise normally be able to view the content. |
Anybody | Anyone who could normally view the content will be able to 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 new state | Default: Recommended for most use cases. Incomplete tasks will be 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 comment must be added 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 published version if available, otherwise use latest version regardless of workflow state. |
Disabled | Show 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. |
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 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 usage data to be collected and stored by the Comala Document Management Migration Assessment. These can be copied and added to a support request.
Setting | Options | Notes |
|---|---|---|
Enable Usage Statistics | Checkbox (Default: checked) | When enabled, anonymous usage statistics will be sent to Comalatech to help improve the product. |
Enable Migration Assessment data storage | Checkbox (Default: checked) | When enabled, usage statistics will be collected and stored by the Comala Document Management Migration Assistant |
User Onboarding
User Onboarding only works for a new installation of the Comala Document Management app.
Check the box to enable an app tour and tips for new users.
Setting | Options | Notes |
|---|---|---|
User Onboarding | Checkbox (Default: checked) | When enabled introductory information and tips will be shown to new users: User Onboarding |
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. Note: After a workflow is imported, it can be used just like any other workflow; the restriction only applies to the action of importing, not subsequent use. Make sure you enter a valid user group name. |
Email Any AddressWhich email addresses can be used in the {send-email} macro? See also: | Disabled | Recommended in most use cases. Only email addresses associated with a registered user account |
Enable | Any email address can be used |
Loop Watchdog
These settings are used to detect infinite loops and terminate any offending workflows. It's recommended to leave the default values.
Likely causes of infinite loops include:
cyclic or recursive use of the set-state macro
cyclic use of the
duedateparameter 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 Maximum Events is exceeded for this amount of time, it will be treated as an infinite loop and the process will be terminated. | Number | Default: |
Administrative Events Logging
Comala Document Management events are now logged in the Confluence Audit log.
Enable/display workflow translator
v7.1.0 Data center v6.18.0 Server
Check this option to disable the display of the workflow translator option in workflow builder for all users in the instance using workflow builder visual editor./
By default, workflow translator is displayed when accessing workflow builder in the global workflows templates dashboard; space workflows dashboard and when editing a workflow added as a page workflow.