Apps documentation
Actions for Jira Service Management
Actions for Jira Service Management
Documentation
FAQ
Release notes
Articles & Videos
Last updated May 14, 2024

Approvals with comments

This section describes the example of creating approvals with customer comments.

For example, an employee who wants to book an apartment fills in a request form. They choose the amount of accommodation budget, number of rooms, and duration of stay. After creating a request, the approver, for instance, a manager, can approve or reject it and add a comment with reasons. Customer comments on requests improve communication between team members, managers, and organizations.

Warning

Before you start, log in as a user with the Jira Administrators global permissions.

Note

The added Approval field in the Actions for JSM app is unrelated to the Approvals available in Jira Service Management. This means:

  • There are no Approve and Discard buttons in the request detail view - you can see them with the Actions for JSM app.
  • Approvers don’t get e-mail notifications - you can configure notifications with Custom Event and Notification Scheme options.
  • A created request isn’t displayed in the Requests menu in the Approvals section - you can create a filter that will collect requests awaiting approval, and set up e-mail notifications or use a dashboard gadget.

After configuring Approve and Discard transitions with Actions for JSM app, they will be available for users who have a request access, including a reporter. Here, you can use conditions in workflow.

For more information on setting up approvals, see official Atlassian documentation.

Create a transition with approval

Steps

To set configuration:

  1. Choose Projects at the top of the screen.
  2. Choose the service project you want to configure.
  3. Go to the Project settings and create a request type, for example: Business trip, issue type: Task.
  4. Go to Workflows section.
    Go to Workflows section in the Jira Service Management project
    Go to Workflows section in the Jira Service Management project
  5. Click on the workflow (in our example: with Task issue type).
    Go to the Jira Service Management workflow to create a transition with approval
    Go to the Jira Service Management workflow to create a transition with approval
  6. Go to Edit in the top right corner.
    Go to edit Jira Service Management workflow to create a transition with approval
    Go to edit Jira Service Management workflow to create a transition with approval
  7. Create Waiting for approval and Canceled statuses by clicking the +Add status button.
    Create Waiting for approval and Canceled statuses
    Create Waiting for approval and Canceled statuses
  8. Create Approve transition by clicking the +Add transition button. In this example, create transition from Waiting for approval to Open status.
  9. Add conditions for Approve transition.
    Click the Approve transition on the workflow diagram and go to Conditions.
    Click Approve transition and go to Conditions
    Click Approve transition and go to Conditions
    Add Only Assignee Condition and User Is In Group (Managers) conditions, and then publish it.
    Add conditions for Approve transition
    Add conditions for Approve transition
  10. Create Discard transition by clicking the +Add transition button. In this example, from Waiting for approval to Canceled status.
    Click the Discard transition on the workflow diagram and go to Conditions.
    Click Discard transition and go to Conditions
    Click Discard transition and go to Conditions
  11. Add conditions for Discard transition.
    Add Only Assignee Condition and User Is In Group (Managers) conditions, and then publish it.
  12. Existing Create transition should have the destination Waiting for approval status.
    Tip

    To change the destination of the Create transition, click Validators or Post functions and then click Edit.


    Existing Create transition should have the destination Waiting for approval status
    Existing Create transition should have the destination Waiting for approval status

Result

A new configuration is added.

Add a Generic Event post function

Created Generic Event configuration allows to execute an event which sends notifications to users who are responsible for approval decisions.

Steps

To set configuration:

  1. Go to your workflow and click Edit.
  2. Click on the Create transition.
  3. Go to Post Functions.
    Go to Post Functions to create a Generic Event post function
    Go to Post Functions to create a Generic Event post function
  4. Click the pen icon to edit a post function.
    Go to Edit post function
    Go to Edit post function
  5. Choose the Generic Event to fire.
  6. Click Update.
    Choose the Generic Event to fire
    Choose the Generic Event to fire
  7. Publish changes.
  8. Go to Administration > System > Events.
  9. Click on Default Notification Scheme.
    Note

    This configuration allows to send notifications e-mails with information about approval decision.
    Example: In notifications for Generic Event, you should choose users/groups/roles (or even a custom field User Picker value) which will get notifications about waiting for approval requests.

Go to Default Notification Scheme
Go to Default Notification Scheme

10. Check the notifications settings for the Default Notification Scheme.
Check the notifications settings for the Default Notification Scheme
Check the notifications settings for the Default Notification Scheme

Result

Created Generic Event post function is added.

Add an Approve transition

Steps

To set configuration:

  1. Go to Administration > Manage apps.
  2. Select Workflow Actions from the menu in the Actions for JSM section.
  3. Go to Add or Edit transition and configure a transition.
    Note
    Add a required Justification field in transition configuration. To create this custom field, go to Administration > Issues > Fields > Custom fields.
  4. Click Add.
    Add an Approve transition with Actions for Jira Service Management app
    Add an Approve transition with Actions for Jira Service Management app

Result

An Approve transition is added.

Add a Discard transition

Steps

To set configuration:

  1. Go to Administration > Manage apps.
  2. Select Workflow Actions from the menu in the Actions for JSM section.
  3. Go to Add or Edit transition and configure a transition.
  4. Click Add.
    Add a Discard transition with Actions for Jira Service Management app
    Add a Discard transition with Actions for Jira Service Management app

Result

A Discard transition is added.

Create a filter in the Issue Navigator

This configuration allows users responsible for approval decisions to find all tickets waiting for approval - in dashboard gadget or e-mail subscription.

Steps

To set configuration:

  1. Go to the top Jira navigation and click Issues > Search for issues.
  2. Define and run your search.
  3. Click the Save as link above the search results.
  4. Enter a name for the new filter and click Save.
  5. Click on Details > New subscription.
    Create a filter in the Issue Navigator
    Create a filter in the Issue Navigator
  6. Set a filter configuration and click Subscribe.
    Set a filter configuration
    Set a filter configuration

Result

A filter configuration is added.

Result of adding filter configuration
Result of adding filter configuration

Example of using Approve transition on the Customer Portal

  1. Go to Customer Portal and create a request.
  2. Click Approve or Discard. In our example, we click Approve.
    The Approve dialog box appears.
  3. Note a justification and, what is important, you can state the reason for your decision in the Comment section.
  4. Click Approve.
    Note a justification and state the reason for your decision in the customer comment section with Actions for Jira Service Management
    Note a justification and state the reason for your decision in the customer comment section with Actions for Jira Service Management

Result

The Approve decision is chosen.

Result of choosing the Approve action with Actions for Jira Service Management
Result of choosing the Approve action with Actions for Jira Service Management

Need help?

If you can’t find the answer you need in our documentation, raise a support request.
Include as much information as possible to help our support team resolve your issue faster.