Expand all   Collapse all

This documentation relates to the 5.2 release of Comala Workflows

 Documentation for other versions of Comala Workflows is available too.

Overview

Value references allow you to add dynamic information and parameter values to your workflow markup – they are placeholders for information that's located somewhere else.

Each time the reference is encountered, for example in an Action or Condition, the value at that moment in time will be retrieved. This means your workflow can dynamically adapt to changing situations.

Reference types

There are several types of value reference, depending on where the information is stored:

Where can I use them?

Value references can be used in macro parameters, sometimes macro body, and even Conditions. However, the actual availability depends on two factors:

  • The type of reference determines which macros it can be used in
  • The macro determines which parameters support value references

For a full list of places where value references can be used, see: Conditions, Content and Value References – but remember it's the reference type and macro which determine the specifics.

Basic example

In your workflow you might need to refer to the author of a piece of content. You won't know this information in advance. To get round this problem, you can use the @author@ value reference, which is one of the references that the Workflows app creates and updates automatically. When a macro which uses the reference is activated, the reference gets replaced with the username of the person who most recently created or edited the content.

{workflow:Value references}
   {state:Editing|submit=Review}
   {state}
   {state:Review|approved=Published|rejected=Editing}
      {approval:Review}
   {state}
   {state:Published|final=true|updated=Editing}
   {state}
   {trigger:pageapproved|approval=Review|partial=true}
      {send-email:@user@|Subject=Your recent @approvalname@ approval} 
         Thank you for approving @page@ which was created by @author@ 
      {send-email}
   {trigger}
{workflow}

All examples

Content by label

There is no content with the specified labels

See also

Workflow Authoring Guide:

Integration Guides:


AWP-3790

    // approvalCheck Attributes
    REF_SELECTED = "selected";
    REF_APPROVER = "approver";
    REF_REJECTOR = "rejector";
    REF_PENDING_ASSIGNEES = "pendingusers";
    REF_APPROVERS = "approvers";
    REF_REJECTORS = "rejectors";
    REF_COMMENT = "comment";
    REF_SIGNATURE = "signature";

    // state attributes
    REF_ASSIGNEES = "assignees";
    REF_ASSIGNEE = "assignee";