Approval Properties in Jira Workflows

Platform Notice: Cloud - This article applies to Atlassian products on the cloud platform.

Summary

When an approval step is added to a workflow, several properties are automatically added to the status.

Understanding these properties requires basic knowledge of workflow approvals. For more details, see our documentation in Add an approval step to a workflow.

What are these Properties?

Eight Properties are added to a status when approval is triggered. 

  1. When an approval step is added, the Include approval step is selected. 

    KeyValueDescription
    approval.activetrueTrue when include approval step is checked;
    False when it is unchecked. 
  2. In the pop-up for approval, the first page lets you select the Number of approvers and Approver source


    KeyValueDescription
    approval.condition.type

    number

    (or)

    Percent

    (or)

    numberPerPrincipal

    Determines the type of approval based on the field selected. 

    number - when a specific number of people should approve (when multiple user picker field is used)

    percent - when a percentage of people should approve (when everyone is selected).

    numberPerPrincipal - when a specific number of people from each group should approve (when a multi-group picker field is used).

    approval.condition.value2the value corresponding to the condition type. For example, 2 if two people should approve.
    approval.pre-populated.field.idcustomfield_xxxxxxused when Affected Services is used as an Approver source. The custom field ID selected is the value for this key.
    approval.field.idcustomfield_xxxxxxused when the Jira field is used as an Approver source. The custom field ID selected is the value for this key.



  3. The second page lets you select transitions for approval results and approvers to exclude

    KeyValue Description
    approval.transition.approved123Corresponds to Select transition if approved. The selected transition's transition ID is the value for this key. For example, 123 is the transition ID for the transition 'Approved'.
    approval.transition.rejected123Corresponds to Select transition if declined. The selected transition's transition ID is the value for this key. For example, 123 is the transition ID for the transition 'Rejected'.
    approval.exclude

    assignee, reporter

    They are used to exclude approvers. Options added in the field will be added as values to the key. 
  • Manual Addition: Adding these properties manually is not recommended as it may lead to workflow issues.
  • Editing Properties: Existing approval properties cannot be edited or deleted once set.




Last modified on Aug 15, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.