null


Skip to end of banner
Go to start of banner

Space Administration

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 Next »

Overview

The space settings document Management dashboard displays all the workflows available in the current space. In the dashboard, a space admin can select a single workflow and make it active on all content in the current space.

cdmc_spacedocumentdashboard_extract_withonecustomwf.png

The dashboard allows a space admin to

  • view the visual flowchart for each workflow in the space

  • select and enable the workflow to be applied to all the pages and blog posts in the space

  • create new custom workflows in the space

  • customize a copy of the workflows installed with the app

  • edit custom workflows in the dashboard using the visual editor or the code editor

All workflows in the space document management dashboard are available for a user to add as page workflow if no workflow is active in the dashboard.

The dashboard includes configuration options to

  • reindex your workflows

  • 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

If the current workflow includes one or more workflow parameters, a space admin can set the value(s) for these workflow parameters.

Reindex can be used after importing a space from another cloud instance.

space admin icon image

Space settings document management dashboard

Choose Space Settings>App links in the Confluence sidebar

  • or choose Space Settings and select the Comala Document Management option in App links

The Comala Document Management dashboard displays the available space workflows in the space.

cdmc_spacesettings_documentmanagementdashboard_bunbdled_wfs_no_active_wf.png

By default

  • no workflow is enabled for the space

  • all workflows included with the app are displayed in the dashboard

The included workflows cannot be overwritten and are identified by the Template tag.

A configuration option to Reindex Workflows in the space workflows can be accessed using the dashboard ellipsis menu.

cdmc_documentmanagementdashboard_ellipsis_reindex_workflows.png

Reindex Workflows is used after migrating or importing a space from another cloud site.

Applying a space workflow

To add and apply one of the workflows to all the pages and blog posts in the space

  • select and click on the grey slider next to the workflow name

cdmc_dashboard_extract_active_wf_baw.png

The slider button moves to the right and turns blue and the workflow is added and applied to all the pages in the space.

A workflow that is enabled in the space document management dashboard is applied in preference on any page that has a page workflow applied.

When a workflow is enabled, utility options can be accessed using the dashboard ellipsis menu.

cdmc_spacesettings_documentmanagementdashboard_ellipsis_menu_options_enabled_wf_in_space.png
  • Reindex Workflows (after a cloud space or site import)

If there is no active space workflow, only the Reindex workflows option is visible.

  • Clear Document Activity to remove the history of all workflow events and actions from each page and blog post in the space

  • Initialize States to set the current workflow state for all pages and blog posts in the space

In addition, the Settings -Remove Restrcitions option is enabled. This is used to enable/disable the removal of page-level user permission restrictions on the applied workflow transition to the workflow final state.

If the currently enabled workflow includes one or more workflow parameters, the @ Parameters button is also displayed.

cdmc_documentmanagementdashboard_extract_cew_wf_enabled_parameter_button.png

The number in the @ Parameters button is the number of parameters defined by the workflow.

Choosing the @ Parameters button opens the Parameters dialog box to edit the workflow parameters values for the space. These values are used by the workflow when applying the workflow.

Change the active workflow in the space

Within the space settings of a given space, you can select the workflow to set as the space workflow and apply it to all the documents in the space using the grey slider next to each workflow name.

cdmc_spacedashboard_custom_wf_enabled.png

You can choose to enable or disable the application of the space workflow across the space content by

  • clicking the grey slider (blue) - enabling the workflow for the space and is applied to all the pages and blog posts in the space

  • clicking the blue slider to off (grey) - disabling the workflow for the space and the workflow is removed from all the pages and blog posts in the space

Choosing to enable another workflow in the space disables any existing active workflow.

When enabled the space workflow is added and applied on every page and blog post.

When the space workflow is disabled, any previously added page workflows become active again on the individual page(s) to which they were applied.

Bundled workflows

Three workflows are bundled with the app and are available and displayed by default in each space document management dashboard

The bundled workflows cannot be overwritten or removed from the space document management dashboard.

A space administrator can view information for each of these workflows using the View detail icon option.

cdmc_documentmanagementdashboard_extract_baw_viewoption.png

View detail displays the workflow description and visual flow diagram.

cdmc_viewdeatils_baw_workflowvisualdiagram.png

The workflow does not need to be enabled to view the details.

Workflow options - bundled workflows

There are two tool options for the included workflows (tagged as Template).

View detail

Duplicate

cdmc_dashboard_viewdetails.png

Displays the visual workflow diagram and description for the workflow.

cdmc_dashboard_duplicate.png

Creates a copy of the workflow in the dashboard. By default, creates the new workflow using the existing name appended with Copy

This copy is a custom workflow and can be edited and renamed by the space administrator.

Custom workflows

Additional workflows can be added to the space - these are defined as custom workflows and can be edited in the dashboard by the space administrator.

A custom workflow can be added to a space by

  • copying an existing workflow (including using a copy of one of the bundled workflows)

  • choosing Create New Workflow button to create a new custom workflow using the visual editor

  • copying and pasting the cloud-compatible JSON code for a workflow using the code editor

Create New Workflow

A new custom workflow can be created in the space dashboard.

  • choose the Create New Workflow button

cdmc_create_new_workflow_button.png

This opens a simple two-state workflow in the workflow builder visual editor that is the starting point for your new custom workflow.

cdmc_create_new_workflow_builder.png

You must add a valid unique name for the workflow and choose Apply to allow you

  • to edit the workflow states and other workflow elements

  • Save and Exit to save the new custom workflow and add it to the current space document management dashboard

Workflow options - custom workflows

There are five tool options for a custom workflow.

View detail

Duplicate

Edit with Visual Builder

Edit with Code Editor

Remove

cdmc_dashboard_view_custom.png

Displays the visual workflow diagram and description for the workflow.

cdmc_dashboard_duplicate_custom.png

Creates a copy of the workflow in the dashboard. By default, creates the new workflow using the existing name appended with Copy.

cdmc_dashboard_duplicate_copy_dialog_custom.png

This copy is a custom workflow and can be edited and renamed by the space administrator.

cdmc_dashboard_visualeditor_custom.png

Opens the current workflow in the workflow builder visual editor.

Changes are saved to the current workflow.

When saving, if the name is changed, a new custom workflow is created and added to the dsahboard.

cdmc_dashboard_codeeditor_custom.png

Opens the current workflow in the code editor.

Changes are saved to the current workflow.

When saving, if the name is changed, a new custom workflow is created and added to the dsahboard.

cdmc_dashboard_vremove_custom.png

Delets the current workflow and removes it from the dashboard.

Dialog box requests confirmation as this is not reversible.

cdmc_dashboard_remove_dialog_custom.png

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 @ Parameters button is displayed when the enabled space workflow includes one or more workflow parameters.

cdmc_documentmanagementdashboard_extract_cew_wf_enabled_parameter_button.png

Choosing @ Parameters opens the Parameters dialog box to edit the available workflow parameter(s) for the current space workflow. The current value for each workflow parameter is also displayed.

For example, the bundled Content Expiry Workflow has the workflow parameter, expiration.

To change the expiration parameter value that is used by the workflow

  • enable the workflow in the dashboard

  • choose the @ Parameters button

  • edit the Expiration parameter value displayed in the Parameters dialog box

If the bundled Quality Management System Workflow is the enabled space workflow.

cdmc_qms_wf_enabled_documentmanagementdashboard.png

The @ 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 is used when the workflow is first applied to content.

The updated parameter value is also used the next time a workflow event occurs that causes the retrieval of the workflow parameter value. For example, if the expiration parameter value for the parameter is updated by the space admin, a subsequent transition to the Approved state uses the new parameter value to set the Approved state expiry.

The value for a workflow parameter can be accessed by adding the parameter name enclosed in the @ symbols. For example, @expiration@.

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.

Choose the dashboard ellipsis menu to access the utilities.

cdmc_spacesettings_documentmanagementdashboard_ellipsis_menu_options_enabled_wf_in_space.png

Initialize states

Choose one of the workflow states from the dropdown menu to set the space workflow to a specific state on the applied pages and blog posts.

cdmc_initializestates_dialogbox.png

When the checkbox Override preexistent states is not checked, the process sets the workflow state only for unprocessed pages - these are pages with an applied workflow but no workflow event or actions have occurred since the workflow was applied. Usually, these are in the initial state of the workflow.

Check Override preexistent states to set ALL states in the space to the same state. This may be to move all content to a review state for an annual review to check if content is stale for example.

Document Activity

The Clear Document Activity option 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.

cdmc_cleardocumentactivity.png

Reindex Workflows

The option Reindex workflows of imported spaces should be used when you have imported your instance or a space from cloud to cloud.

cdmc_reindexworkflows.png

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.

Settings - Remove Restrictions

When content reaches a workflow final state, the workflow can be set to remove all page-level view and edit restrictions to all users and groups.

cdmc_removerestrictions.png

To enable the setting

  • choose the grey slider

  • confirm the setting in the displayed dialog box

cdmc_confirm_remove_restrictions.png

When enabled the setting slider is blue.

cdmc_removerestrictions_enabled.png

Once set as enabled, Remove Restrictions is enabled automatically when any workflow is active the dashboard.

Remove Restrictions option is not available unless a workflow is set as active in the space.

Related pages





  • No labels