Versions Compared

Key

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

Overview

Excerpt
hiddentrue

Mark a task as complete

The complete-task macro is used to mark a task as completed.

Where to use it?

Optional.

One or more complete-task macros can be put in a trigger macrotrigger macro.

Parameters

Parameter

Required

Default

Notes

Ver

task

(tick)


Name of the task to complete.

No action will be taken if the task does not exist or is already closed.

3.2.2

comment



The comment to record against the completed task.

3.2.2

Events

The following Events events are associated with task completion:

  • taskcompleted

Example

Code Block
languagetext
themeRDark
{workflow:name=Task completion}
   {state:Test|taskcompleted=Completed}
      {task:Add an attachment}
   {state}
   {state:Completed}
   {state}
   {trigger:attachmentadded}
      {complete-task:task=Add an attachment|comment=An attachment was added}
   {trigger}
{workflow}

...

The page activity will associate the completion of the task and any associated taskcompleted transition with the current user who added the attachment.

oImage RemovedImage Added

See also

Workflow Authoring Guide:

User Guide:

Reporting Guide: