Versions Compared

Key

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

Overview

The Content Expiry Workflow is bundled with the app. This 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
    o

On this page

Table of Contents


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.

Info

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

Approved state

expiration periodThe expiration

expiry due date

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

expiration.

The due date is displayed in workflow builder visual editor when viewing the Approved state for the Content Expiry Workflow.

Image Added
Info

The value for the expiration parameter is referenced using the format @expiration@.

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

Image RemovedImage Added

The expiration period due date period for the content in the Approved state is set when each time the workflow transitions to the Approved state. It is set by default to five months

Info

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

occurs

.

Choose the Set Parameters button option to edit the value for Expiration.The Expiration period

Image Added

The Parameters dialog box can be set using the drop-down menu

Image Removed

This sets used to set the value for the expirationworkflow parameter used by the workflow.Choosing the Reset button will change the expiration period back to the last saved value in the space.. 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 occurs.

The actual Approved state due date is reset to the current date of the transition PLUS the expiry period value

.

Viewing the expiry due date on the page

On the page, a user can open the workflow popup in the Approved state to view the current period remaining before the Approved state expires.

The workflow popup will show the current time left to the due date.

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

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 the content to the Rejected state for updating

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

The due date for the Approved state expiry will be 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.

Choose the current expiry date to open the calendar.

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

Email notifications

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

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

Image Added

Triggers can be added/edited using the workflow visual editor or the code editor.

Related pages

Child pages (Children Display)
pageReviewing Content