This documentation is for the downloadable version of Herzum Approval 3.X 

Not using this? See the documentation for other versions.

 

Overview

The Approval Administration screen allows specifying simple or composed definition of the approvals. Those definitions are reusable in one/more steps of your Workflow. 

An approval can be associated to a single entity (Simple Approval) or multiple entities (Advanced Approval).

Approval entities include: Project Roles, Groups, Users, Group Picker Field, User Picker Field, Reporter, Assignee, Project Lead. 

When multiple entities are needed you must specify the relation between them via the And/Or operators. You can also express a negative clause so that an entities is always excluded (e.g. Not Reporter also if the user belong to the approvers group).

Creating a new Approval

To create a new approval, follow the steps below.

1

Navigate to the Add-Ons Panel within your JIRA installation and

Click on Approval Administration to manage Approvals

Administration → Add-Ons → Herzum Approval → Approval Administration


Herzum Approval add-on panel

2

Click on Add new Approval to create a new approval based on a single entity.

Approvals management screen

2.1

Enter Approval properties::

  • "Approval Name" (required)
  • "Approval Description" (optional)
  • select or check one of following fields (required):
    • one or more "Roles"
    • one or more "Groups"
    • one or more "Users"
    • "Reporter"
    • "Assignee"
    • "Project Lead"
    • User Picker Custom Field
    • Group Picker Custom Field


Same examples of Approvals set with User/Group picker custom fields can be reviewed on:

Configuring an Approval via user and group picker custom fields


Approval Configuration screen

3Click on Add new Advanced Approval to create a new approval based on multiple entities.

Approvals management screen

3.1

Enter Advanced Approval properties:

  • "Approval Name" (required)
  • "Approval Description" (optional)
  • select values or check at least two of following fields (required):
    • one or more "Roles"
    • one or more "Groups"
    • one or more "Users"
    • Group Picker Field or User Picker Field
    • "Reporter"
    • "Assignee"
    • "Project Lead"

  • check NOT to exclude Approver/s

    This setting requires that at least another property must be set by having NOT unchecked.

  • "Operator" (required, OR is the default ):
    • And - Approver/s must validate all Properties
    • Or - Approver/s must 
      • validate at least one of the Properties having Not unchecked
      • validate all Properties having Not checked


Same examples of Advanced Approval configurations can be reviewed on:

Advanced Approval Configuration screen

Editing an existing Approval

You can edit an existing approval by simply clicking the related buttons on the Approvals management screen.

The Approval name is not updatable.

 

Deleting an existing Approval

You can deleting an existing approval by simply clicking the related buttons on the Approvals management screen.
If the approval is used in some Workflow, an alert, asking to confirm the action, is displayed.