How To Manually Create A Jira WebHook

  1. Login to your Jira instance with an admin account.
  2. Press on the gear on the top-right corner and choose ‘System’.

1a

 

 

 

 

 

 

 

  1. Choose ‘WebHooks’ on the left menu (under ‘Advanced’).
  2. Click on ‘Create a WebHook’.
  3. Fill the field as follow:

Name: “Applause Notification Hook for ” and your product name.

URL:  “https://bts.applause.com/api/applause/v1/jira?apikey=” and set the apikey you get on the WebHook creation dialog when saving an Applause product with 2-way integration enabled.

Events:  1. check the issue updated event.

  1. In the text box enter a JQL for filtering by your project and issue type.

It should be like: “project = YOUR_PROJECT_KEY_HERE & issueType = YOUR_ISSUE_TYPE_HERE”

For most our customers the issue type is ‘Bug’.

The Webhook form should look like:

jira_webhook

  1. Click on ‘Create’ button.

How To Integrate DX With JIRA

This page is specific to the Applause DX platform. If you are looking for Jira integration steps using our Applause In-The-Wild platform, please refer to this documentation.

Overview

The Applause DX Bug Tracking System integration offers users the ability to turn the Applause platform into a direct extension of their own backend BTS. Applause DX supports JIRA (REST API) Versions 5.0 or later.

Customers can access the BTS settings page from the settings drop-down menu, locating in the top-right corner.

An Applause BTS Connector is a configuration that allows Issues to be exported to your Jira server.

Supported Operations

  • Test/Refresh Connection: After entering all the required fields for a new connector, or, if you’ve updated information about a previous connector:  (e.g. URL, Username, Password, Project Key), click the ‘Test Connection’ button. For a pre-existing connector, click the ‘Refresh Connection’ button. This will allow Applause to (re)test the connection and pull in any custom fields and custom values that may exist within your BTS implementation.
  • To enable/disable a pre-existing connector: click on the ‘Enable’ or ‘Disable’ button.
  • To edit a connector: click on the ‘Edit Credentials’ button for a newly added or pre-existing connector.
  • Required vs Optional Fields: For a newly added connector if the connection has been tested, or for a pre-existing connector, Applause will populate the ‘JIRA Field Mapping’ section with all required/optional fields for JIRA. Required fields can NOT be removed. Option fields can be removed by clicking on the ‘x‘ icon to the right of that field.

What if my Bug Tracking System is behind a firewall?

If your BTS sits behind a firewall, please configure your firewall or security settings to permit the following IPs for the Applause platform to access your bug tracking system remotely:

  • 73.216.29
  • 21.127.192/28 (CIDR notation) OR 23.21.127.192 to€“ 23.21.127.206 (range notation)

Getting Started: Creating a BTS Connector

To create a new BTS connector, first enter the Jira URL, Jira credentials, and Jira Project information. Then, click “Test Connection” to verify that Applause can reach your Jira server. Once a connection is successful, any mandatory Jira fields will be displayed for you to configure. Finally, click “Save” to persist the connector so it can be used to export issues.

Helpful Hint:  For easier tracking, create a new user within your user system with Applause in the name. This will help you quickly locate bugs exported from Applause into JIRA. It is important to assign project visibility in JIRA to the account being used for the connection in order for bugs to appear.

  • URL: Configure your web-based access to JIRA, less than 200 characters.
  • User: Case sensitive. Requires the username to have create and save permissions within the JIRA system.
  • Password: Case sensitive.
  • Project Key: Case sensitive, and needs to exist within the JIRA system prior to seeing up a new connector.  Assign where you would like Applause SDK-exported bugs to be located in the JIRA system. For example, if your Jira tickets appear as ABC-123, then ABC is your project key.
  • Issue Type: Case sensitive, the default issue type for bugs sent from the Applause platform.
  • Enable SNI: Enables SNI (Server Name Indication) for JIRA server. Use this option if your BTS server has TLS SNI enabled.

Add/Update JIRA Field Mappings

For a newly added connector if the connection has been tested, or for a pre-existing connector, Applause will populate the ‘JIRA Field Mapping’ section with all required/optional fields for JIRA.

Adding Fields

Adding fields is very easy. Simply click on the ‘+ Add Field’ button, and select from a list of available fields.

Note:  If you have recently added new fields  to your JIRA implementation but do not see them listed as options, you may need to refresh the connector’s database by clicking the ‘Refresh Connector’  button.

Note:  As a reminder, any fields that have an ‘x‘ icon to the right of them are optional and can be deleted. Fields with star in the name or lacking the icon are required and can not be removed.

Setting Values

To send a static value for a particular field, simply click on the drop down menu and select the static value you would like to post to that field.

Note that this value will be sent for ALL bugs sent from Applause.

Note:  If you have recently added new value options to your JIRA implementation but do not see them listed as options for a particular field, you may need to refresh the connector’s database by clicking the ‘Refresh Connector’  button.

 

Updating an Existing BTS Connector

If your Jira project has changed, such as you’ve added new fields or new hires, you can “Refresh” your connection to get the new fields and/or options. Then, you can edit the appropriate field mappings. Finally, “Save” the connector to persist your changes.

 

Exporting your DX Issues

There are two ways to export issues to Jira:

  1. From the project results “Issues” tab, you can select one to many issues at a time (use checkboxes to select), click the Actions menu, and choose “Send selected to BTS”

You will get a confirmation screen:

Once you click OK, the status of those Issues will update to “Queued”, and then ultimately will update to reflect the Jira ticket ID in the bug tracking system (e.g., UDU-142 below). That ID will be a link to the actual Jira ticket.

 

  1. The other way to export an issue to Jira, is from the individual issue detail view. From the issues list, click on any Issue you want to view detail for.  Then, from the Actions menu at top right, click “Send to BTS”.  The “Export Status” will update to “Queued” and ultimately to the Jira ticket ID when it’s successfully exported. Note: You may have to refresh you page to see the status updated.

Adding Statuses In My Jira For 2 Way Integration

For creating a 2-way bug tracking system integration between Applause and your Jira, you will need to provide the following statuses :

  1. Jira status that will mark the equivalent Applause bug as ‘Ready to verify’.
  2. Jira status that will resolve the equivalent Applause bug.
  3. Jira status that will be set on your Jira issue when the equivalent Applause bug verified successfully.
  4. Jira status that will be set on your Jira issue when the equivalent Applause bug failed verification.

2wayjira_flowdiagram

Editing Active Jira Workflows

If you are editing an existing, active Jira project, it is suggested that you copy or make a backup of the workflow.

Some versions of Jira may block adding outgoing transitions if the workflow is in “Draft” status (editing an active workflow). To add the transitions, you can make a copy of the workflow (under Jira Administration > Issues > Workflows). The newly copied workflow will be Inactive and will support adding the statuses and transitions described below.

Once you are done adding the transitions, you can set the Project’s Workflow to the new copy: Under Jira Administration > Projects, click the project name and to reach the Product Settings page. Then, click Add Workflow > Add Existing and select the new workflow name and the issue types (i.e. Bug). Then, Publish the changes.

 

Adding Statuses

For adding a new status in your Jira instance do the following:

  1. Login to Jira with an admin user.
  2. Press on the gear on the top-right corner and choose ‘Issues’.

1

  1. Choose ‘Statuses’ on the left menu.
  2. Click the ‘Add Status’ button.
  3. Fill the new status details in the dialog.

2

 

Adding Transitions

Now, you need to setup the transitions to/from these statuses as follows.

First, make sure that a transition exists that leads into the “Ready to Verify” status (or its equivalent in your system) from your usual workflow (i.e. “Code Merged” to “Ready to Verify”). If a transition does not exist, add it according to the directions below.

Second, add transitions between your “Ready to Verify” status (or equivalent) to the “Verify Passed” status (or its equivalent) and between your “Ready to Verify” status to the “Verify Failed” status if they are not specified. It is suggested that you disable the “Allow all statuses to transition to this one” option for both the “Verify Passed” and “Verify Failed” statuses in the workflow (so that you maintain control of when approved fix verification results trigger a transition).

Third, in case of a mismatch in the bug verification results (Passed for one tester, but then failed for a different tester), Applause will update your Jira issue status twice: once for the passed verification and second for the failed one. For supporting this functionality your Jira needs to have ‘Transitions’ between your Passed verification status and your Failed verification status.

To create a transitions between statuses, do the following:

  1. Login to Jira with an admin user.
  2. Press on the gear on the top-right corner and choose ‘Issues’.
  3. Choose ‘Workflows’ on the left menu.
  4. If you have a workflow for your project press on ‘Edit’ next to it, otherwise create a new workflow and then edit it.
  5. Click on the ‘Diagram’ button.
  6. Example: Add transition from Passed to Failed verification:
    1. Click on the ‘Add transition’ button.
    2. In the dialog, choose your verified passed Jira status as the ‘From status’ and the failed Jira status as the ‘To status’.
    3. Name the transition and press on ‘Add’.

3

  1. Example: Add transition from Failed to Passed verification:
    1. Click on the ‘Add transition’ button.
    2. In the dialog, choose your verified failed Jira status as the ‘From status’ and the passed Jira status as the ‘To status’.
    3. Name the transition and press on ‘Add’.

 

For instructions on how to set up 2 Way Jira Integration in the Applause Customer App see the help page: New Applause Platform