Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel2
minLevel2
absoluteUrltrue
typeflat
separatorpipe

Content Expiry workflow

Image Removed

Comala Document Control workflows

Child pages (Children Display)
pageComala Document Control workflows

If you choose
Image Added


Choose the Content Expiry Workflow to keep your content fresh, the approved document

will expire

expires after a set period of time, so that it can be reviewed again.

The workflow consists of four states

:

  • Review -

while
  • the document content is awaiting review

  • Rejected -

when
  • the document content is rejected

  • Approved -

when
  • the document

has been approved, this state will automatically transition
  • is approved

Info

The Approved workflow state automatically transitions to Expired once

the deadline

the set deadline is reached.

  • Expired -

when
  • the

document 
  • approved document’s previously determined expiry date is exceeded

.
Tip

You can always approve this

version

document content in the Expired state if the content is still valid. This transitions the document to the Approved state and resets the expiry period.

Each time the page is edited in either the ApprovedRejected or Expired state the workflow

will transition

transitions back to the Review state

(an updated transition)

.

Image Removed Adding or removing a label or attachment does not action the updated transition when the content is in the ApprovedRejected or Expired state. This transition only occurs if the content is edited and published (changing the Confluence page version).

Setting a due date period using the workflow

The value for the expiration due date

can be

used by the workflow in each space is amended by a space admin in the space tools

Document Control

document control dashboard.

Image Removed
cdcc_spacedocumentcontroldashboard_cew_wf_active_paramterslozneg_highlighted.pngImage Added

The expiration period is set when the workflow transitions to the Approved state

It is set by default to

The default value is five months from the date the transition occurs.

The Expiration period

can be set by a space admin

is amended using the drop-down menu

:

Image Removed

This sets the value for the expiration parameter used by the workflow.

Choosing the Reset button will change the expiration period back to the last saved value in the space.

The

in the Parameters dialog box.

  • make the Content Expiry Workflow active in the space

  • choose the @Parameters lozenge

  • edit the parameter value using the options in the Parameters dialog box

cdcc_parameters_edit_expiration_cew_wf_dropdownoptionsdisplayed.pngImage Added

The updated value is retrieved by an applied workflow when there is a related workflow event. For example, the expiry period for the approved content

will be

is set to the current value in this dashboard every time a transition to the Approved state occurs.

The Approved state expiry is reset to the current date at the time of the transition PLUS the expiry period value.

  • Space workflow

    • due date workflow parameter value is changed by editing the workflow parameters in the space tools Document Control dashboard

    • updated value is used on the next transition to the Approved state

  • Page workflow

    • value is set when initially adding the workflow

    • value can be amended using the Manage Page Parameters option in the page tools menu

Viewing the due date on the page

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

Image Removed
Image Added

The workflow popup

will show

displays the current time left to the due date.

Image Removed
Image Added

Once this date is exceeded, the document is transitioned to the Expired state.

Image Removed

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 by a user
Image Added

For content in the Expired state is available for review

  • 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
  • the Approve decision

will return
  • returns the content to the Approved state. The expiry

will be
  • is reset using the value stored for the workflow in the space tools dashboard

If a user edits the content in the Expired state and saves the changes, the workflow transitions the updated content to the Review state.

User setting of expiry due date

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

Choose the expiry clock icon in the workflow popup.

Image Removed
Image Added

Choose the current expiry date to open the calendar.

Image Removed
Image Added

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

Image Removed

Image Added

Amending the due date on the page using the workflow popup option does not affect the workflow parameter value.

Email notifications

When a document expires in the Approved state, the Content Expiry workflow

will

automatically

send

sends an email notification to page-watchers. This notification is created by the workflow listening for the state expiry event.

Comala Document Control workflows

Child pages (Children Display)
pageComala Document Control workflows