Versions Compared

Key

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

Overview

Excerpt
hiddentrue

Value references are placeholders for values stored elsewhere.

...

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

...

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

Child pages (Children Display)
sorttitle
excerptTypesimple

Where can I use them?

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

  • The

    the type of reference determines which macros it can be used in

  • The

    the macro used 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.

Comala Document Management includes

Workflow parameters are used as placeholders for example, for users who are reviewers for approvals; for duration periods for the expiry of your content, or for labels to be added to your documents. This allows the creation of a workflow that can be used for different teams or projects but these workflow parameters values are set within a space or for a specific document. The values are retrieved by the workflow on the application of the workflow or on a workflow event.

Value reference retrieval order

...

Excerpt
nameretrievalorder
  • Confluence page properties macro
    1. Comala Metadata which include workflow parameters with edit=true that have been saved and metadata set using Comala Document Management set-metadata macro

    2. Confluence page properties macro

    3. Communardo Metadata

    4. Workflow parameters saved at the space level - without edit=true

    5. Page references

    6. Suppliers (

    ServiceRocket
    1. Reporting app, Workflows, Metadata)

    This order is important when there are conflicts in value reference names.

    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 around 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 that uses the reference is activated, the reference gets replaced with the username of the person who most recently created or edited the content.

    Code Block
    languagetext
    themeRDark
    {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

    Filter by label (Content by label)
    showLabelsfalse
    max100
    showSpacefalse
    sorttitle
    excerptTypesimple
    cqllabel = "concept-value-references" and label = "example" and space = currentSpace ( )

    See also

    Workflow Authoring Guide:

    Integration Guides: