Versions Compared

Key

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


Info
iconfalse

You must have the Jira System Administrators global permission before you can carry out the instructions on this page.


Info
iconfalse

Before you can setup the Project and the Issue Types that involve approval steps, you must set up the users who are involved in approval processes.

The Approval Administration screen allows to assign Approvals to Project Roles, Groups, Users, Group Picker Field, User Picker Field, Issue Reporter, Assignee and Project lead.

You can reuse an Approvals across different Approval Mappings. 

You can define complex configurations concatenating multiple properties.

Furthermore, you can exclude users (E.g. Require approval of users in the group Quality Assurance excluding with the reporter exclusion of the issuereporter).

Info
iconfalse

Table of Contents

Overview

The Approval Administration screen looks like as follows:

Image Removed

The Approval Administration

screen

 screen allows you to add, edit, manage advanced settings, delete and review your approval configurations.

Furthermore, when

The Approval Administration screen looks like as follows:

Image Added


When moving the mouse upon an approval name, a window, explicating the applied settings, shows up.

Image Removed

Image Added

In details:

    • Approval Name: It identifies the approval and once it's created it cannot be renamed;
    • Operator: It's populated only
  • if you choice multiple property
    • case of Approval type Multiple Property and it
  • explain
    • explains which is the relationship between
  • all
    • the properties you chose;
    • Roles: It shows which project roles
  • has
    • have been selected
  • for that approval
    • ;
    • Groups: It shows
  • one or more groups that has
    • which groups have been selected;
    • User: It's
  • the list of the single users that has been chosen
    • which users have been selected;
    • Group Picker:
  • If one or more group picker custom fields has been created, it will show which one
    • It shows which group picker(single or multiple) custom field has been selected
  • into the property
    • ;
    • User Picker:
  • Just like the group picker custom fields but for single users and not a group
    • It shows which user picker(single or multiple) custom field has been selected;
    • Reporter: If the reporter
  • is selected into the approval the
    • has been selected, the flag will show;
    • Assigne: If the assignee
  • is selected into the approval the
    • has been selected, the flag will show;
    • Project Lead: If the project lead

  • is selected into the approval the
    • has been selected, the flag will show;

      Info

      The ! icon appears case of the property identifying users that cannot Approve/Reject also if they satisfy the properties enabling them.

      This option is available only case of Approval type Multiple Property.

How to create an Approval

To require approvals in an Approval Mapping, you need first to create them.

Here's how to do it:

    1. Click Add Approval on the top of the Approval Administration screen
    2. Fill the fields showing up on the Add Approval Configuration screen

  1. Image Removed
    1. :
      1. Approval Name (Required), the name identifying the Approval;
      2. Description (Optional), it's the description;
      3. Type (Mandatory)
        1. choose the option Single Property if your configuration needs a single property (E.g. Can approve users that belongs to the selected Project Roles)

        2. choose the option Multiple Property if your configuration needs multiple properties at the same time (Project Roles, Groups, Users, Group Picker Field, User Picker Field, Issue Reporter, Assignee and Project lead)

      Image Added
    2. Depending by the selected Type, you will display one of the following screens:

      • Approval Configuration screen (Type: Single Property)

  2. Image Removed

Fill out the
      • Here you can fill out one property that users must satisfy to

enable them
      • be enabled to Approve/Reject/Abstain

the approval request
      • .

Image Added

You can select multiple

value

values for a given property.

Image Removed

Image Added

      • Advanced Approval Configuration screen(Type: Multiple Property)

    • Using a multiple property will lead into two different tabs
      • Here you can fill out multiple properties that users must satisfy to be enabled to Approve/Reject/Abstain. 

        The screen provides two tabs:

        • Properties identifying who can approve

        • Properties identifying who cannot approve

        (info) Have a look at this link to see an example:

    • Image Removed

      Fill

Properties identifying who can approve

Here you can fill out the properties that the users must satisfy to enable them to Approve/Reject /Abstain

the approval request
Image Removed
Info

The arrows on the right allows you to expand/collapse the multi-select box for a better view of the available values.

Specify

.

Additionally, you have to specify if the users enabled to Approve/Reject/Abstain must

satisfy

satisfy all

the

 the selected properties

or

or at least one

of

 of them

Image Removed

Image Added

E.g. If you have selected a project role, a group and the reporter, flagging the first option it means that any user that belongs to anyone of those properties selected may approve/reject.

If, instead, you flag the second option the approver can be only an user (or more) that

belong

belong at the same time

to

 to all the properties selected.

InfoTo more details see this example: put link here

Image Added

(info) The arrows on the right allows you to expand/collapse the multi-select box for a better view of the available values.

Properties identifying who cannot approve

: Image Removed InfoWarning:

Here you can fill out the properties that users must not meet in order to be enabled to Approve/Reject/Abstain.

Image Added

(info) If you apply a property to approve, the same property will be unavailable into reject tab and

viceversa. For more details check this example: put link here

vice-versa.

Manage Approval Advanced Settings

Click the cog symbol on the right of the screen and select one of the following advanced settings:

Image RemovedImage Added

Condition Approval Disabling

This optional setting allows to enable the Approval only if the associated conditional rule, evaluated on the specific issue, returns true. 

Image Modified

If 

(info) If None condition is selected the Approval will be enabled always.

Info

(info) This setting is not able to make consistent existing issue requesting already this approval.

Only newly-created approvals will be consistent

Displaying Options

This optional setting allows to choose the information that you want to display in the Approval Column of the Approval History tab.

Image Removed

Image Added

By

(info) By default, the Approval Column displays the the Approval Name and Approval Detail:

Image Removed

Image Added

Sequential Approval Disabling

This optional setting allows to disable the sequential approval for the specific Approval so that if an Approval Mapping requires the Sequential Approval, this specific approval can be approved in any order.  

Image Removed

Image Added

Info

(info) This setting is not able to make consistent existing issue requesting already this approval.

Only newly-created approvals will be consistent

Setup

Sequential

User Picker

Approvals

This optional setting allows you to establish the approval sequence on the selected users case of an Approval based an user-picker custom field.

Image Removed

Image Added

This

(info) This setting can be managed on the Approvals associated to an User Picker Field All property

.This setting is

and is hidden case of Approvals not associated to an User Picker Field All property.

If

(info) If the selected User Picker Field includes any user not included in the Sequential Users Picker list, the user will be sequence independent.

Info

(info) This setting is not able to make consistent existing issue requesting already this approval.

Only newly-created approvals will be consistent.

Editing an Approval

You are able to update an existing approval, including its Name and the applied configuration.

Most of

All the filled fields can be updated, exception made

for the Approval Name and the

for the Category.

The applied changes will  apply contextually on any issue expecting the modified Approval.

Deleting an Approval

When deleting an approval not yet associated to any Approval Mapping or Single Issue Approval Configuration, the application doesn't ask to confirm.

If in any configuration requiring the Approval exists, the application asks to confirm.

Image Removed

Image Added

The applied changes will  apply contextually on any issue expecting the Approval.