| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
In the space tools Document Management dashboard a space admin can select a workflow and make it active on all content in the current space.
The dashboard allows a space admin to
initialize the states for the active space workflow
clear workflow document activity
set the removal of all view and edit restrictions when the content transitions to the final state in the workflow
reindex your workflows
If the current workflow includes a workflow parameter, a space admin can set the value for the workflow parameter.
A space admin can also create (or edit) a workflow using either workflow builder or the JSON editor.
Reindex can be used after importing a space from another cloud instance.
Space Settings Document Management Dashboard
choose Space Settings in the Confluence sidebar
select the Document Management option in Manage Pages
The Document Management dashboard will display the Space Workflow Configuration. This includes
the current workflow for the space with options to disable or enable the workflow; edit the workflow and change the space workflow
Utilities options to clear document activity; reindex workflows and initialize workflow states for all pages
Settings option to enable/disable the removal of page-level user permission restrictions on the workflow transition to the workflow final state
If the current space workflow is disabled, only the Reindex workflows option is visible. All the Utilties and Settings options are only displayed only when the workflow is enabled.
If the current workflow includes one or more workflow parameters, the Set Parameters button is also displayed to open the Parameters dialog box to edit their values for the space.
Change the workflow in the space
Within the space settings of a given space, you can select from three available installed workflows to set as the space workflow and apply to the space:
Check this page to get more information about these workflows| Info |
|---|
Any custom workflows added/created in the space are also available for selection as the space workflow. |
A single workflow can be added to the space settings Document Control workflows dashboard.
By default, the Basic Approval Workflow is added as an inactive space workflow. Once added to the dashboard you can choose to make active enable or disable the application of the workflow across the space content. By default, the Basic Approval Workflow is added as inactive.
moving the tick slider on (green) enables the currently selected workflow for the space
moving the tick slider on or off will activate or deactivate to off (grey) deactivates the currently selected workflow for the spacewhen made active the selected
| Info |
|---|
When enabled the space workflow will be added and applied on every page and blog post |
To select a different workflow, simply click choose the Change Workflow Manage Workflows button.
Choose the workflow you would like to add to as the space Document Management dashboard workflow from the Add workflow picker.
The current space workflow will be replaced by the workflow chosen in the Add workflow picker.
| Tip |
|---|
Scroll down in the Add workflow dialog box to view all available workflows. Choose View Detail for a highlighted workflow to view the workflow visual flowchart and full description. |
Workflow builder visual editor
The current space workflow can be edited using workflow builder visual editor.
choose Edit Workflow button
select Edit with the Workflow Use Visual Builder from the dropdown menu
| Info |
|---|
Editing one of three |
installed space workflows |
creates a custom workflow |
and this edited workflow |
will be saved |
| Info |
|---|
When editing a bundled space workflow the original workflow is not changedas a copy of the installed workflow. The installed workflows cannot be overwritten. You must rename the edited workflow before saving it. |
All saved custom workflows are available to add and enable in the current space. They will be available added to the list of workflows in the Add Workflow picker.
Further edits can be made to
a custom workflows using workflow builder without the need to save with a new name. If you don’t want to overwrite the existing custom workflow edit the workflow name before choosing Save in the visual editor.
If the following error appears renaming the workflow will allow the changes to be saved may appear when saving a workflow, you will need to save the changes in a new custom workflow.
Removing a custom workflow from the space
You can also remove a custom workflow from the space.
When the custom workflow is added to the space an additional option is available in the dropdown menu next to the Change Workflow button.
Choose Remove Workflow.
Confirm the deletion of the custom workflow in the dialog box.
| Note |
|---|
The custom workflow is permanently deleted and will no longer be available in the Add workflow picker. |
| Info |
|---|
The Remove Workflow option is not displayed when one of the |
installed workflows is added as the space workflow. |
Code Editor
The current workflow can be edited using the JSON code editor. The editor can also be used to import other workflows into the current space by copying and pasting the JSON markup code for the workflow from another space.
JSON is a markup programming language used to build the workflow.
| Note |
|---|
You should only use this editor if familiar with JSON. |
Access the JSON code editor by opening the dropdown menu next to the Change Workflow Manage Workflows button.
The JSON code can be edited . in the Workflow schema dialog box
The JSON code editor will validate any changes and warning errors will be displayed with details of the validation.
| Info |
|---|
The application of JSON |
code with validation errors is not allowed by the editor. |
Changes applied to the JSON markup code will be seen in workflow builder visual editor.
JSON triggers can also be added to a workflow using the Triggers option in the Edit workflow panel in workflow builder.
Any queries on importing workflows ode editor or using the JSON editor please contact Comalatech our support team.
Set Parameters
If the current workflow includes a workflow parameter, a space admin can set the value for the workflow parameter for the current added space workflow.
The Set Parameters button is displayed when the current space workflow includes one or more workflow parameters.Choose
.png?version=2&modificationDate=1694771213162&cacheVersion=1&api=v2&width=374)
Choosing Set Parameters to open button opens the Parameters dialog box to edit the available workflow parameters parameter(s) for the current space workflow. The current value for the each workflow parameter will is also be displayed.
For example, the bundled Content Expiry Workflow has the workflow parameter, Expiration expiration.
To change the Expiration expiration parameter value that will be used by the workflow
choose the Set Parameters button
edit the Expiration parameter value displayed in the Parameters dialog box
If the bundled Quality Management System Workflow is the added space workflow, choosing Set Parameters displays the Document User Reviewers and Document Group Reviewers workflow parameters defined in that workflow.
If the value for the workflow parameter is changed in this dashboard, the new value will be used when the workflow is first applied to content.
The updated parameter value will also be used the next time a workflow event occurs that causes the retrieval of the workflow parameter value. For example, if the Expiration expiration parameter value for the Space Administration is updated by the space admin, a subsequent transition to the Approved state will use the new parameter value to set the Approved state expiry.
| Info |
|---|
The value for a workflow parameter can be accessed by adding the parameter name enclosed in the @ symbols. For example, @expiration@. |
| Tip |
|---|
Workflow parameters must be added with a name. You can optionally add a label for clarity. For example the workflow parameter in the Content Expiry Workflow is named as expiration. It is also defined with an optional label - Expiration. When referencing the workflow parameter in the workflow, for example in a trigger, use the workflow parameter name within the @ symbols. In the Content Expiry workflow the workflow parameter is referenced as @expiration@ for the due date in the Approved state. |
Utilities
The utility options allow you to configure the workflow application and the document activity for the content in the space.
Initialize states
Choose one of the workflow states from the dropdown menu to set the space mode workflow to a specific state.
Document Activity
The option CLEAR deletes Clear deletes the workflow document activity of every single page and blog post in the space and resets the workflow state to the initial workflow state.
Reindex Workflows
The option Reindex Workflowsworkflows of imported spaces should be used when you have imported your instance or a space from cloud to cloud.
This is a final step required after importing to update the document states correctly for those pages that you have not visited yet.
There are some circumstances where you may need to reindex your workflows, for example, if your users report issues with workflow states - document states may be shown as 'not initialized' in the Document Report and workflow history. Reindexing your workflows ensures that up-to-date workflow history is displayed for each document.
Reindexing workflows is only used for cloud to cloud migration. It is not required or relevant when migrating content from server or data center.
Workflow Settings
Remove view and edit restrictions
When content reaches a workflow final state the workflow can be set to remove all view and edit restrictions to all users and groups.
