Versions Compared

Key

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

Overview

Excerpt

Triggering events when a read confirmation is created, updated, or acknowledged, or inline comments are created overdue for the final state in a workflow

In the following simple examples, we show how to create a custom notification when

  • a read confirmation is requested

...

  • when a read confirmation becomes overdue

...

  • when a user confirms a read confirmation

...

  • when a

...

  • read confirmation is completed (all readers confirm the read confirmation)

...

Read confirmation created

...

...

Workflow markup with a readconfirmation event trigger

Code Block
languagetext
themeRDark
{workflow:name=A Simple Read Confirmation}
    {state:Review|approved=Approved}
        {approval:Approve}
    {state}
    {state:Approved|final=true|updated=Review}
    {state}
    {read-ack}
    {trigger:confirmationrequested}
        {set-message}A read confirmation was requested for the published content for the @state@ state{set-message}
    {trigger}
{workflow}

Read confirmation overdue

...

Workflow markup with a confirmationdue event trigger

Code Block
languagetext
themeRDark
{workflow:name=A Simple Read Confirmation}
    {state:Review|approved=Approved}
        {approval:Approve}
    {state}
    {state:Approved|final=true|updated=Review}
    {state}
    {read-ack:user=user1|duedate=P3D}
    {trigger:confirmationdue}
        {send-email:user=user1|subject=Your read confirmation is past due!}
             Please visit @title@ and complete your read confirmation.
        {send-email}}
    {trigger}
{workflow}

Read confirmation acknowledged

...

...

Workflow markup with a confirmationacknowledged event trigger

Code Block
theme
languagetextRDark
{workflow:name=A Simple Read Confirmation|key=7177234}
    {state:Review|approved=Approved}
        {approval:Approve}
    {state}
    {state:Approved|final=true|updated=Review}
    {state}
    {read-ack}
    {trigger:confirmationacknowledged}
        {set-message}A read confirmation was confirmed by @user@ on @date@ for @pagetitle@ for the published @state@ state{set-message}
    {trigger}
{workflow}

Read confirmation completed

...

Workflow markup with a confirmationcompleted event trigger

Code Block
languagetextthemeRDark
{workflow:name=A Simple Read Confirmation}
    {state:Review|approved=Approved}
        {approval:Approve}
    {state}
    {state:Approved|final=true|updated=Review}
    {state}
    {read-ack}
    {trigger:confirmationcompleted}
        {send-email:user=@author@|subject=The requested read confirmation is complete for @pagetitle@}
             Please visit @title@ to view the confirmed readers.
        {send-email}}
    {trigger}
{workflow}

...