Legacy Workflows Documentation

Looks like you followed an old link. Comala Workflows is now Comala Document Management.

Please access our latest documentation here Welcome to Comala Document Management

Documentation for other versions of Comala Workflows are available too.

(info) This space is no longer being updated.

Purpose

The workflowparameter macro is used to define custom parameters within a workflow. When a workflow containing parameters (either by adding them to a page or via this macro in a Space Workflow) the parameter's (default) values are stored within the context of the space. These workflow parameters can be used as value references.

Note

To edit the workflowparameter values after they have been saved in the workflow, please see Space configuration.

Syntax

{workflowparameter} Syntax
{workflowparameter:[name=]parameter_name[|type=string/user/duration/group/list][|options=user_option1,user_option2, ...][|edit=true/false]}
   [default_value]
{workflowparameter}

Parameters

Parameters

Mandatory

Default

Description

unnamed first parameter  or name

Yes

Name of the parameter.

type

No

string

The type of the parameter: string, user, duration, group, or list.

options

Yes if type is list

A list of user-defined options for the of parameter.

edit

No

false

Whether or not the parameter is editable within the context of a page. If set to true, the parameter value is stored on the page itself and can be referred to as value reference in the workflow or retrieve anywhere on the page using the {get-metadata} macro.

body of macro

No

The default value for the parameter. This value is overwritten by any setting made via space configuration.

Examples

The example below is taken from the Lightweight Requirements Management workflow and illustrates different uses of workflow parameters. This workflow can be imported for use.

{workflow:name=Lightweight Requirements Management workflow|key=com.comalatech.sdlc.requirements.01|label=requirement}
    {description}
        A simple lightweight workflow for managing Software Requirements. For each requirement page you can select the priority, category and owner, as well as to define links to the actors.
    {description}
    {pageheader}
        || State | {get-metadata:state>name} |
        || Priority | {get-metadata:Priority} |
        || Category | {get-metadata:Category} |
        || Owner | {get-metadata:Owner} |
        || Actor | {get-metadata:Actor} |
    {pageheader}
    {workflowparameter:Categories|description=List of categories}
        Category 1, Category 2, Category 3
    {workflowparameter}
    {workflowparameter:Category|type=list|options=@Categories@|edit=true}
        Category 1
    {workflowparameter}
    {workflowparameter:Priority|type=list|options=High, Medium, Low|edit=true}
        High
    {workflowparameter}
    {workflowparameter:Owner|type=user|edit=true}
        @creator@
    {workflowparameter}
    {workflowparameter:Actor|edit=true}
        [Home]
    {workflowparameter}
    {state:Not Started|submit=In Progress|taskable=true}
    {state}
    {state:In Progress|submit=Complete|taskable=true}
    {state}
    {state:Complete|approved=Approved|rejected=Rejected|taskable=true}
        {approval:Approval}
    {state}
    {state:Approved|taskable=true}
    {state}
    {state:Rejected}
    {state}
    {trigger:labeladded|label=requirement|initial=true}
        {set-state:Not Started}
    {trigger}
{workflow}

  • No labels