Versions Compared

Old Version 9

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version 10

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Required

Default

Notes

Ver

unnamed first parameter
or name

(tick)


Name of the parameter.

3.0+

macro body


The default value for the parameter

3.0+

description



The description for the parameter

  • plain text

  • can use any character set supported by your Confluence server – except some reserved characters

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sorttitle
cqllabel = "macro-workflowparameter" and label = "parameter-description" and label = "example" and space = currentSpace ( )

3.0+

edit


false

Should this parameter be editable at the page or blog post level?

Tip: If set to true, the value of the parameter can be used as a normal value reference and can be accessed via the get-metadatamacro.

edit=true can also be required to be set upon transition to a state by setting them in the requiredparams list for that state.

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sorttitle
cqllabel = "macro-workflowparameter" and label = "parameter-edit" and label = "example" and space = currentSpace ( )

3.0.3+

type

(tick)

string

Parameter type

  • string – text

    • Usually plain text, but can contain wiki notation depending on where the parameter value will be used

  • user – a single username or comma separated list of usernames

  • duration – an ISO 8601 duration

  • group – a single Confluence group or comma separated list of group names

  • list – a list of values to choose from – see: options parameter below

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sorttitle
cqllabel = "macro-workflowparameter" and label in ( "parameter-type" , "type-duration" , "type-user" , "type-string" , "type-group" , "type-list" ) and label = "example" and space = currentSpace ( )

3.0+

options

(info)

string

(info) Required if the parameter type is list.

List options

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sorttitle
cqllabel = "macro-workflowparameter" and label = "parameter-options" and label = "example" and space = currentSpace ( )

3.0+

(info) 
Panel
bgColor#DEEBFF
Info

Parameter values and unprocessed content

When adding a space workflow, a parameter reference value may only be available for use by the workflow after a workflow process occurs - such as a transition. For example, the initial state should not include the use of the parameter reference value for a duedate or pre-assigned reviewers for approvals to avoid blocking your workflow as these values may not be available until after a workflow process has taken place

To process content and ensure parameter values are set up, a space admin can also choose to Initialize states on applying a space workflow. This action will process the pages and the workflow parameter value will be available for use by the workflow in the initial state.

...