Versions Compared

Key

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

State content transitions

Excerpt
hiddentrue

State transitions include transition on completion of a content review, transition on expiry of a due date on content and on the completion of tasks

These transitions are actioned by changes to the content e.g. page edits; reaching the state expiry date; content approval or rejection, completing or the completion of added tasks.

Table of Contents
maxLevel2
minLevel2
excludeState content transitions

See also: StatesAdministrator state override, Tasks, Content reviews

Transitions

Child pages (Children Display)
pageTransitions

Using Workflow Builder

User Guide

Lesson 3 Transitions

  • States
  • Content

    Reviews
  • Tasks
  • Content

    review transitions

    Similar to a state selection transition, but the focus is on reviewing content rather than choosing a state (the workflow determines which state to go to depending on outcome of the review).

    The user chooses to Approve or Reject, and the workflow transitions to the appropriate state (as defined in the approved and rejected parameters). Approve and Reject buttons in the Workflow Popup.

    Code Block
    theme
    languagetextRDark
    {workflow:name=Content review}
      {state:A|approved=C|rejected=B}
         {approval:Review}
      {state}
      {state:B}
      {state}
      {state:C}
      {state}
    {workflow}
    Image RemovedImage Added
    Image RemovedImage Added

    In workflow builder, the approved and rejected transitions for the content review are only available when a content review (

    aopproval

    approval) has been added to the state.

    Image Removed
    Image Added

    If the approval is added to the state but the Approved and Rejected transitions are not added

    • the workflow popup will still display the Approve and Reject buttons

    • if a user rejects or approves the content the workflow will simply remain in the current state

    • no transition will occur

    • any approval decision will still be recorded in the page activity report

    You do not need to add both the Approved and the Rejected transition.

    Info
    Note that a

    A content review transition may also occur when a trigger listens for an

    event and

    event and uses one of the following action macros to approve or reject the content.

    Action macros related to approvals:

     {}
    {}
    {}
    {}

    The following events are related to approvals

    .

    :

    Events
    • pageapprovednewsapprovedpagerejectednewsrejectedpageapprovalassignednewsapprovalassignedapprovalunassigned

    See also: Reviews

    Macros{state}{approval}

    Content expiry transition

    States

    A state can be given an expiry date, after which a transition can occur.

    If the state expires whilst it is active

    • the duedate parameter determines the expiry date

    • the expired parameter specifies which state to transition to 

    An expiry indicator appears in the workflow popup.

    Code Block
    languagetextthemeRDark
    {workflow:name=State expiry}
      {state:A|duedate=P1W|expired=C}
      {state}
      {state:B}
      {state}
      {state:C}
      {state}
    {workflow}
    Image RemovedImage Added
    Image RemovedImage Added


    The state expiry transition can be added to the state in the transition editor using workflow builder.

    Image AddedImage Removed
    Info

    The transition

    will

    only

    occur

    occurs if a due date has been added to the state and the Expired transition was added before the due date.

    Any other of the state transitions can be added with the Expired transition.

    Macros

    Related macros:

     {}
    {}

    Eventsstateexpired

    See also: 

    The following events are related to expiry:

    • stateexpired

    Related documentation:

    Updated content transition

    States can automatically transition should content be updated (edited).

    The updated parameter specifies the state to transition to if the content is updated.

    If used on a state that has final=true parameter, the workflow popup will show a message about the publishing process, otherwise, it will be empty.

    Code Block
    languagetextthemeRDark
    {workflow:name=Content update}
      {state:A|updated=C|final=true}
      {state}
      {state:B}
      {state}
      {state:C}
      {state}
    {workflow}
    Image RemovedImage Added
    Image RemovedImage Added

    The state Updated transition can be added to the state in the transition editor using workflow builder.

    Image AddedImage Removed
    Info

    The transition

    will occur

    occurs when the content is edited and the changes saved.

    Any other of the state transitions can be added with the Updated transition.

    Macros

    Related macros:

     {}
    Events

    Related events:

    •  pageupdatednewsupdatedpagemovedattachmentschangedattachmentaddedattachmentupdatedattachmentremoved,attachmentversionremoved

    See also

    Related documentation:

     

    Tasks completed transition

    States can automatically transition should all workflow tasks be completed.

    The completed parameter specifies the state to transition to when all tasks are completed. Tasks are listed in the Tasks popup.

    Code Block
    theme
    languagetextRDark
    {workflow:name=Task completion}
      {state:A}
      {state}
      {state:B|completed=C}
        {task:name=Complete this task|note=Task completion will cause transition to state C.}
      {state}
      {state:C}
      {state}
    {workflow}


    Image RemovedImage AddedImage Removed
    Image Added

    The task popup will need to be accessed to complete one or more workflow assigned tasks. Image Removed

    Image Added

    On completion of the task(s) the workflow will transition from state B to state C.

    The state Tasks Completed transition can be added to the state in the transition editor using workflow builder.

    Image AddedImage Removed
    Info

    Before the transition occurs all tasks must be completed - workflow added tasks and user added tasks.

    This includes any uncompleted tasks added in other workflow states and still awaiting completion when the workflow transitions into this state.

    Any other of the state transitions can be added with the Tasks Completed transition.

    Macros

    Related macros:

     {}
    {}
    Events

    Related events:

     

    - taskcreatedtaskassignedtaskcompletedtaskexpired

    See also

    Related documentation: