Configuring a Jira Integration

Before creating an integration using Integration Hub, we recommend reading through the following articles to get started.

Creating a Jira Integration

Jira is an incident tracking platform, by building an integration between your Cyara Platform and your Jira deployment, Test Case and Campaign failures within Cyara can be pushed to Jira as Incident Tickets for further investigation. To build an integration with Jira, follow the steps below.

  1. Login to your Cyara Portal.
  2. Click on Tools > Integrations. (If this menu does not appear in the Tools menu, confirm that the user account you're currently logged into is provisioned to use the Integration Hub).
  3. Click the New Integration button.
  4. Select Jira from the Type dropdown menu.
  5. Enter a Name and a Description for the integration.
    mceclip1.png
  6. Enter the API Url and Incident Portal Url that are exposed by your Jira deployment, and the authentication details for the REST request into the Username and Password fields. (Ensure you include the {id} tag in the Url in the following format to include the Jira reference).
    mceclip2.png
  7. In the Field Mapping section, select the New Jira Field to create a pre-formatted field mapping for a set Jira field.
    mceclip0.png
  8. Or click the New Custom Field button to create a new field that is customizable. You will be prompted for the following information.
    1. Field Name - The property name to send to Jira.
    2. Display Label - The display name for this field, shown when a user creates an incident.
    3. Type - The Field type. A Choice for multiple fixed values. A single or multiple line text input, or a Lookup for values that are built using an API call.
    4. Field Value - Enter either a Constant, a Choice formatted as a comma separated list where the first is value is the default or to use a Variable. For more information on Field Values set as Variables, see the Incidence Field Variables table below.
      mceclip3.png
    5. The final checkboxes allow you to configure field properties such as Required, Read-Only and Overridable.
    6. Click Add Field to add the new field to the Field Selection table.
  9. Click Save Details to save your changes, and Enable the integration using the toggle in the top right corner of the integration editing screen.

URL Backlink

By using the $Url field variable in the table below, you can create a link to the Cyara Test Case from your Jira incident ticket. This is useful to allow for quick navigation directly from Jira back to Cyara for troubleshooting. By default Cyara will automatically create a link from the Test Case to your Jira deployment for any incidents raised via the Integration.

Incidence Field Variables

The following table shows possible template values of fields to be pushed to Jira. A template can contain one or more replacement variables from the table below:

Variable

Description

$CampaignName Campaign Name
$DetailedResult Detailed Result
$Result Test Result
$ResultCategory Test Result Category
$StepDescription Failed Step Description
$StepNo Failed Step No
$TestCaseDescription Test Case Description
$TestCaseName Test Case Name
$TestCaseNotes Test Case Notes
$Url The Url to the Portal Detailed Result page
$Username The Username creating the Incident

Was this article helpful?

1 out of 2 found this helpful