Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Excerpt
namecontentexpiryworkflow_descrip&graphic

The Content Expiry Workflow is designed to help keep your content fresh, the approved pages will expire after a set period of time, so that it can be reviewed again.

The workflow consists of four states

  • Review - while the page is awaiting review

  • Rejected - when the page is rejected

  • Approved - when the page has been approved, this state will automatically transition to Expired once the deadline is reached

  • Expired - when the page previously determined date is exceeded. You can always approve this version if the content is still valid

Image RemovedImage Added

Each time the page is edited in either the ApprovedRejected or Expired state the workflow will transition back to the Review state (an updated transition).

E-signatures can be required for reviewers on each individual approval in the Review, Expired and Rejected states. The credentials requirement can be set for each approval using workflow builder visual editor.

On this page

Table of Contents


Info

A Comala Document Management workflow can be applied to pages and blog posts.

Approved state expiry due date

Excerpt

The Approved state is configured with a due date period. The value for the due date period is set as the value of a workflow parameter named expiration.

The due date period is added on the applied workflow transition to Approved state and is displayed in workflow builder visual editor when viewing the Approved state for the Content Expiry Workflow.

Image Removed

the workflow popup on the page.

cdmc_wfpopup_approvedstate_cew_wf_5monthsexpiry.pngImage Added
Info

The value for the expiration parameter is referenced by the applied Content Expiry Workflow using the value reference format @expiration@.

The expiration workflow parameter value used for the Approved state due date can be amended by a space admin in the space tools Document Management dashboard.

Image Removed
cdmc_cew_wf_enabled_documentmanagementdashboard_extract.pngImage Added

The

value set in the space configuration is used by the workflow

@ Parameters button option for the Content Expiry Workflow is displayed when the workflow is

first applied to a page or blog post. Changing the value in the space configuration will not change the value used on pages where the workflow has already been applied.

The due date period for the content in the Approved state is set each time the workflow transitions to the Approved state.

button option to edit

made active (enabled) in the dashboard. The button displays the number of workflow parameters defined in the workflow.

Choose the @ Parameters button option to open the Parameters dialog box.

Image Added
Info

The default value for the expiration parameter value is a Period of time five months set from the date of the transition.

Choose the Set Parameters

The Parameters dialog box is used to set the value for

Expiration.Image RemovedThe Parameters dialog box can be used to set the

the expiration workflow parameter. The expiry period for the Approved state is set to the current value for the expiration

workflow parameter.

parameter every time a transition to the Approved state occurs.

The parameter can also be set to use different formats for the due date value including setting the value as a

  • Period of years/months/hours/minutes

  • Fixed date

  • ISO_8601 value for a period of time, for example P1Y6M

  • Value Reference used to for parameter value (this can be another workflow parameter)

The expiry period for the Approved state will be set to the current value for the expiration parameter every time a transition to the Approved state occursvalue set in the space configuration is used by the workflow when the workflow is first applied to a page or blog post. Changing the value in the space configuration does not change the value used on pages where the workflow has already been applied.

Viewing the expiry due date on the page

Excerpt
namecontentexpiryworkflow_onpageapprovedpopup

On the page, the workflow popup in the Approved state displays the expiry due date period lozenge.

Image RemovedImage Added
Tip

The workflow popup displays a countdown of the current remaining time period. Each time the page transitions to the Approved state the expiration is reset to 5 months.

Image RemovedImage Added

Once this due date period is exceeded, the page is transitioned to the Expired state.

Image RemovedImage Added

If a user edits the content in the Expired state and saves the changes, the workflow will automatically transition the Updated content to the Review state.

The current expired content can also be reviewed in the Expired state:

  • if the content is "stale", a Reject decision will transition transitions the content to the Rejected state for updating

  • if the content is considered to be still current and appropriate, an Approve decision will return returns the content to the Approved state

The due date for the Approved state expiry will be is reset to the value stored for the workflow parameter in the space tools dashboard.

User setting of due date

Users can amend the expiry date when the content is in the Approved state.

Choose the expiry clock icon in the workflow popup.

Image RemovedImage Added

Choose the current expiry date to open the calendar.

Image RemovedImage Added

Choose a date and select Save to amend the Approved state expiry date.

Image RemovedImage Added

Email notifications

Excerpt
namecontentexpiryworkflow_triggertext

Once a page is expired, the Content Expiry Workflow will automatically send sends email notifications to page-watchers. This custom notification is created by a workflow trigger included in the workflow.

Existing and additional workflow triggers can be added/edited to a custom workflow using the workflow visual editor or the code editor.

The bundled Content Expiry Workflow cannot be overwritten or edited.

If you need to amend the workflow, the bundled workflow must be duplicated in the space document management dashboard.

cdmc_documentmanagementdashboard_cew_wf_duplicatebutton_extract.pngImage Added

This copy can be edited and applied to the pages and blog posts.

cdmc_documentmanagementdashboard_cew_wf_copy_extract.pngImage Added

The trigger code in the workflow copy can be viewed and edited in the workflow builder visual editor in the Edit Workflow panel.

Image Removed

Existing and additional workflow triggers can be added/edited to a custom workflow using the workflow visual editor or the code editor.

You cannot edit the bundled Content Expiry Workflow. If you need to amend the workflow, the bundled workflow must be duplicated in the space document management dashboard.

cdmc_documentmanagementdashboard_cew_wf_duplicatebutton_extract.pngImage Added

This copy can be edited and applied to the pages and blog posts.

cdmc_documentmanagementdashboard_cew_wf_copy_extract.pngImage Added

The trigger code in the workflow copy can be viewed and edited in the workflow builder visual editor in the Edit Workflow panel.

cdmc_wfbuilder_edit_wf_trigger_cew_wf_copy.pngImage Added

Related pages

Child pages (Children Display)
pageApplying workflows