Open Category List

Integrating With Bug Tracking Systems

6 minutesread

Overview

Working with Applause boosts your products testing with speed, coverage and scale with unparalleled access to a global curated community of available, professional testers and virtually any device configuration out there. Assisted by your Applause team you will be able to test faster, complete more test runs whether structured or unstructured, manual or automated, functional or other, and improve the quality of issues you track and ultimately fix. 

At the same time, the Applause platform is not meant to replace your Bug Tracking System (BTS). Systems like Jira, Rally, Bugzilla, Azure DevOps (TFS), Pivotal Tracker and others will most probably still be utilized by your team to keep track of reported issues, the assignment to engineer, sprint, release etc., as well as fix status, time and effort, and related communication. BTSs are a major efficiency gain when implemented properly, and countless teams rely on them to manage their day-to-day tasks. A key prerequisite for such efficiency gains is the accurate creation and update of issues (or ‘bugs’, ‘defects’, ‘tickets’) with all required data and at a timely manner. This is precisely where integrating the Applause Platform with your BTS comes into play.

Integration Scope

There are two use cases supported by the integration:

  • Issue Export: An outbound integration, allows exporting issues collected by the testing community and vetted by you (or your Applause Team) through triage, into your BTS. A new issue will be created in your BTS, and it’s identifier will be available from the Applause Platform for convenient look-up.  The Issue Export is the basic use case implemented with the integration, and as such supported for all systems we can integrate with (see list below).
  • Issue Handling: A 2-way integration, allows receiving updates from your BTS into the Applause Platform on the issue prioritization and fix status. This, in turn, allows a more accurate in-Platform reporting including your Applause Quality Score as well as driving workflows such as Bug Fix Verification. Learn more about the Applause Quality Score here and about BFV workflow here. The Issue Handling is an advanced use case, and is currently only supported with Jira.

Benefits

By integrating your BTS with Applause you will be able to:

  • Get all your approved issues automatically created in your BTS,
  • Save time and errors from manual upload or copy-paste of issue data between systems,
  • Depending on the integration configuration, automatically assign created issues to teams or engineers, 
  • Automatically drive a Bug Fix Verification workflow (require 2-Way Integration, Jira only), and
  • Optimize the Applause Platform reporting by feeding it with prioritization and status set by your teams.

Prerequisites and Limitations

  • The Applause Platform must be able to communicate with your BTS. Contact your IT resources to ensure this prior to configuring the integration. Learn what to do if your BTS is behind a firewall here.
  • The BTS Integration has 2 ‘flavors’ of implementations:
    • BTS-Specific, where it implements an API published by the 3rd party responsible for the BTS. These integrations tend to be tighter. At the same time, there is clearly a finite list of BTSs we can support. If your specific BTS is not included in the list of supported systems, you may need to use the Generic integrations.
    • Generic, where the integration sends data to an email inbox or a webhook.
  • As in most integration products, the BTS-Specific Integrations implements a set of APIs published by 3rd parties. Thus, functionality is dependent with 3rd party offered options, and as such the integration functionality may slightly differ.
  • For integrations where authentication is enabled, two step authentication is not supported at this time.
  • A single BTS Integration can be set up for each of your products in the Applause Platform. Make sure to work with your Applause Team to define your products in the best way to support this architecture.
  • Please look into the configuration page of each of the Connectors for additional BTS-specific prerequisites and limitations. 

Configuring the BTS Integration

There are 4 main required steps to configure the BTS Integration:

  1. Enabling the BTS Integration and selecting your BTS.
  2. Establishing connection with your BTS.
  3. Defining a connector to map the Applause fields to the BTS’s.
  4. Test the integration

Enabling the BTS Integration and selecting your BTS

To enable the BTS Integration and select your BTS, follow these steps:

To view your product builds:

1. Log in to the Applause Platform and navigate to Products.

2. In the Products page, locate the relevant product by sorting the table or using the search box above it.

3. If the product already exists, click on a product name. Learn more on how to create a new product here.

4. New navigation options will be displayed in the navigation bar. Navigate to Product Details.

5. The Product Details page will be displayed. Click on the Actions dropdown on the top right, and select Edit.

6. The Edit Product wizard will be displayed. Navigate to step 2 – Integrations.

7.  Under Bug Tracking System (BTS), check the box next to Enable BTS Integration for this Product.

8. Additional options will be displayed. Select the name of the BTS you’d like to integrate. By default only a few will be displayed, click on the Other dropdown for the full list.

Note that as you make your selection, the configuration option will be updated.

Establishing connection with your BTS

Once you have enabled the BTS Integration for the product and selected the relevant BTS, you will need to establish connection with your BTS. Establishing connection will ensure that the Applause Platform can communicate with your BTS. In addition, for BTS-specific integrations, the issue settings within your BTS will be returned to the Platform,

To establish connection with your BTS:

1. Provide the connection details to your BTS: URL, username, password or token, project or repository identifier – depending on the BTS requirements.

2. For Jira Connector only: check if SNI (Server Name Indication) is enabled.

3. Once completed, click Test Connection. If all provided details are accurate, and communication is enabled between the Applause Platform to your BTS, you should get a message that the test was successful. If not, check your inputs and/or work with your IT and Applause Team to enable communication.

Defining the BTS Connector to map the Applause fields to the BTS’s

Once connection has been established, your BTS’s issue settings are returned to the Applause Platform. You may now configure what fields you would like to (or must to) send to your BTS to appear in the created issue. On top of field mapping, in some cases you may need to map between specific values, to add a dynamic setting of values in your BTS.

Note: In case the issue settings on your BTS have changed you would need to refresh the connection, and – depending on the change – to edit the field mapping.

Learn more about working with BTS Connectors here.

The Connector Details fields will dynamically update based on the BTS selected. For additional information about a specific BTS, see the links below:

BTS Specific Integration Information

Note: To edit an existing connector, click the pencil icon next to the Connector Details header.

Test the integration

Once the BTS Connector is set, make sure to save the edited product.

It is recommended to test the integration prior to asking other users to use it.

 

0
0
1121
6 minutesread

Related Knowledge Base Posts