From January 2023, old versions of the PractiTest plugin for Jira (below 3.0), are no longer supported.

PractiTest fully integrates with Jira, allowing you to create a streamlined workflow and experience a complete test management solution. Once the configuration has been completed, you can create, edit, and manage any Jira issue, which will automatically and continuously sync with the PractiTest platform. Interactive dashboards with detailed reporting are displayed inside of PractiTest, resulting in a unified and transparent testing process. As a secondary option, Jira users can opt for a one-way integration to send updates made in PractiTest through to Jira, but without receiving updates in the reverse. Jira customers can choose whichever integration option best suits their needs.

PractiTest also offers a “No Plugin” Integration with Jira Server/Data Center, allowing you to enjoy most of the two-way integration features without any additional installations, and without using any plugins or add-ons for Jira. To learn more about the No Plugin Jira Server/Data Center integration, click here.

Configuring the Integration

Account Integration Settings

In PractiTest:

  • Go to Account settings - Integrations tab - select JiraRA Server and click ‘Create token and continue with Jira Server integration’. Note: you cannot use the same PractiTest account Jira integration for more than one Jira server/Data Center. You can create multiple Jira integrations in your PractiTest account settings for the different Jira servers that are not part of the Data Center. jira-server-select

  • The following screen will appear:

    jira-configuration

    Note: If you would like to use the basic authentication method, check ‘Use Basic Authentication:’ and enter username and password. This option is less recommended.

In Jira, download and configure the plugin:

  • Click on the “Administration” link on the top-right of the screen (Settings). Click on apps, then ‘Find new apps’.’

    find-new-add-ons-jira-marketplace

  • Search for PractiTest in the Atlassian marketplace
  • In the manage apps/add-ons window, click PractiTest - Configure manage-add-ons-jira-marketplace

  • Fill in the API-Token you received in the PractiTest Account Settings - Integrations tab into the Plugin configuration page api-insert

  • By default, all Jira projects will appear as manageable in PractiTest. If you want to include only a part of your Jira projects in the PractiTest integration and exclude others, check “Enable PractiTest addon for the following projects only”, and check the specific projects that you wish to integrate. Any project that you don’t check will not be integrated. api-insert-project-choice

  • In the same page, click Show More api-insert-show-more

  • Fill in the URL fields as follows:
    1. For US prod users, the Host is https://api.practitest.com/. For EU users, the host is https://eu1-prod.practitest.app/.
    2. For US prod users, the Proxy is wss://proxy.practitest.com:443/. For EU users, the proxy is wss://eu1-jira-proxy-prod.practitest.app:443/. api-insert-host-proxy
  • Click save.

  • In Jira Administration Settings, select Applications and then select application links. jira-link-settings

  • In the ‘Enter the URL of the application you want to link’ field, enter the base URL for your PractiTest App. Your app base URL can be found in PractiTest under Account Settings - Integrations.

  • Click ‘Create new link’

    Note: If you’re prompted with the following message: ‘The supplied Application URL has redirected once. Please check the redirected URL field to ensure this is a URL that you trust’, check the ‘Use this URL’ checkbox, click Continue and leave the new URL as is. Fill in the fields with the data below:

    1. Application Name box type: PractiTest

    2. Application Type: use the default value of Generic Application app-link-name

    3. Click Continue

Note: You’ll need to have the Public key, Consumer key and Callback URL from the PractiTest integration settings page

  • Locate the PractiTest Application Link that you created in the previous section and click the Edit (pencil) icon. practitest-app-link
  • In the Configure dialog box, click ‘Incoming Authentication’ on the bottom-left and paste the following in the appropriate boxes:
    • Consumer key: PTOauthKey
    • Consumer Name: PractiTest Application
    • Public Key: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxi5O5khVZEpqaVUG13mQw2PM/SCAdx8b2IvkOIJIBGgQe1UBATCUnENlbfAmU1y5VmzzlLxtnHq4E6gTtwCNQjPzwLtFV60Ys4kQG73j78CHw+oRGuza+PQiHZb6exwbaZmaNXaDbV0TuZzO4J/A3Qxo5vFWKlG0VI4Q3xfrv1fN6WJMeJLBlhbyFuC6qNTcYmXfIxPLMsTvvHvco/9ZjME+lyivUOHUj1YY4pqI4sIotLVjF5RXYfHQrLYJ/+3FBKnH0uAwj4dSyp+mVq3/IB5lI0GSnJo41xr1z0jY0M0bJEri+56rQqc0qs5lDWtDVvuzok4XvaCIy3MDnhOkPQIDAQAB
    • Consumer Callback URL: Please find your Consumer Callback URL in the PractiTest Account Integrations Settings window
  • Click the Save button, and then click Close app-link-dialog-box Note: In case you are not allowed to configure integrations by using application links, use the basic authentication method (less preferred) instead where username and password will be used.

Creating a Webhook in Jira

  • Go to Jira - Administration Settings - System. Scroll down to Webhook. new-webhook

  • Click ‘Create a Webhook’

    1. Paste the Webhook URL you received in the Integration Settings screen in PractiTest
    2. In the same window, scroll down to the Events section - Issue related events. In the JQL text box, insert: project in (“your integrated projects separated by commas”). In the ‘Issue’ column underneath, check ‘updated’. In the ‘Issue Link’ column, check ‘Created’ and ‘Deleted’. In the ‘Comment’ column check ‘created’, ‘Updated’ and ‘Deleted’. webhook-check
    3. Click ‘Create’

Go back to PractiTest - Account Settings - Integrations - and verify that the connection status is ‘Connected’ by pressing “Test Connection”.

Project Settings

Project Mapping

  • In PractiTest, go to Project Settings - Integrations. Click ‘Activate’ on the issue integration section and then press ‘Activate’ again on the Jira integration configured in your account.
  • Add a new row for each of the Jira projects you want to integrate with this PractiTest project, then select the relevant project and issue type. You can add as many rows as you want and map any Jira project with its relevant Jira issue types. jira-project

PractiTest Internal Issues

You can decide to create issues only in PractiTest’s internal issues module, alongside issues that are synced to Jira. These issues will not be synced to Jira. To enable this option, tick the ‘Allow to create Issues in PractiTest that are not linked to Integration’ box.

internal-ids

If you choose this option, you will have the choice to present the PractiTest ID for all issues including the Jira synced issues. If you do not choose to allow PractiTest to create internal issues, PractiTest will present the Jira ID for each issue.

Field Mapping

Note: Field sync needs to be configured for each PractiTest project separately. Note: Linked Issue field (for example “is blocked by” or “relates to”) will be automatically added to the “Fail & Issue” modal box when the project and issue type you choose contain it. In this case, you won’t need to map it here.

In the project Integration settings window, click settings and choose the ‘Jira project mapped fields’ tab.

jira-mapped-fields

  1. Choose the Jira field you want to map. You can choose Text Fields, Single select lists (text, number, users), Multi-lists, Number, Date, or Sprint type fields.
  2. Tick the “Add to ‘Fail & Issue’” box if you want this field to appear when reporting an issue from PractiTest to Jira.
  3. Choose if and where you want to map this Jira field, for example, to a PractiTest dedicated field, or to the description of the PractiTest entity. Note: If you choose to map it to a field, the list of PractiTest fields that will appear will contain only custom fields that match the type of the Jira field you chose (ie. text-text, number-number, etc). Sprint fields can be mapped to list type fields in PractiTest and are also linked to either requirements or issues. If you choose the Jira Priority field, you will be able to map it to the PractiTest Priority system field. If you choose to map Jira fields to the description field of either requirements or issues, you will only be able to update the field on the Jira side.
  4. Once you choose to map to fields, you will need to choose whether to present the data in the issues field, the requirement field, or both. If the PractiTest field you choose is linked to only one of them, then you will have only that option to map to.

Continuous Filter Sync

To continuously sync a Jira filter into PractiTest including any issues, , go to your project integration settings and choose the “Auto-sync filters” tab.

jira-sync-filters

Choose the relevant Jira filter and the PractiTest entity you want to sync it to (ie. requirements or issues). Click “Update issue integration”. Every 4 hours, PractiTest will sync to all the issues in this filter. You can add as many filters as you like, but please note that if the filter contains issues from projects that are not integrated with PractiTest (as defined in the first tab “Jira Project info & issue type”), they will not be synced.

Using the Integration

Syncing Information

Any PractiTest issue or requirement that is linked to a Jira issue will be updated when the value of the Jira issue status, name, description, comment, or any of your synchronized fields are changed or added within Jira. Read about synching more Jira fields here. You can also define fields to be edited in PractiTest and updated accordingly in Jira.

For each user, upon the first action taken in the integration, the PractiTest user will connect to its Jira user so any action in the integration will be recorded under the correct user on any side.

Basic Authentication Method Accounts Note: For basic authentication configured accounts,- there’s no link between a PractiTest user and a Jira user. For each interaction, the service account supplies, username, and password will be used.

Reporting Jira Issues From a PractiTest Run

Note: the first time you report an issue to Jira from a test run, you will see a message to ‘click here to link your Jira User’. Once done, your PractiTest and Jira user will be linked (according to the GDPR).

  1. Run tests normally.

  2. When encountering an issue, click the ‘Fail & Issue’ icon, or prior to that, save the “Step’s Actual Results”. fail-n-issue-run-window
    • If you set up your integration to allow internal PractiTest issue creation to not be created in Jira (as explained here), your “Fail & Issue” button will open two options. The first will create the issue in PractiTest only, and the second will create the ticket in Jira as explained below. fail-n-issue-options
    • Choose the Jira project and issue type you want to report the issue to from the ‘Project’ dropdown list in the modal box. This dropdown is adjusted according to your project integration settings.
    • You will see all the test data already pre-entered, including the summary and description pre-filled with steps you’ve executed, and the failed “Step’s Actual Results” (if this information was already entered in PractiTest).
    • You may add more details to the issue.
    • At the bottom of the modal box you will find:
      • Jira fields that were mapped to PractiTest fields in project integration settings (read how to map Jira fields here)
      • Fields that are set to required in your integrated Jira projects
      • Linked Issues field if the Jira project you are reporting to and the issue type you chose contain this field
    • Click the button to create the issue in Jira. fail-n-issue-popup
  3. You can also link existing issues to your step run. This option allows you to link your failing test step to existing Jira tickets. You can link to more than one issue at a time, using commas between the issue IDs. link-existing-issue-run-window

  4. After creating the Issue, the plugin does the rest.
    • PractiTest will continue updating Jira when you change the value of your synchronized fields or when you add a comment. Read more about synching Jira fields here.
    • Manage issues in PractiTest: All issues connected to Jira can be viewed in PractiTest and automatically synced when changes are made to the name, description, status, synced fields, or comments in Jira.

Importing and Syncing Jira Tickets as PractiTest Requirements

There are four ways to import & sync Jira tickets as requirements to PractiTest:

  1. Import and Sync by ticket IDs from PractiTest: Click on the down arrow next to the “New Requirement” button and select “Sync a new Requirement from Jira”. sync-new-requirement-from-jira In the requirements import modal box, choose import by ticket IDs. You can import either an individual ticket or multiple tickets separated by commas. import-requirements-jira

  2. Import by Jira filters from PractiTest: This action will sync the current issues in the selected filter into PractiTest, but will not continue syncing the filter when changes are made. New issues added to the filter will not be synced. Click on the down arrow next to the “New Requirement” button and select “Sync a new Requirement from Jira”, as written above. In the requirements import modal box, choose ‘Jira Filter Name’ then choose the name of the relevant Jira filter you want to import. The dropdown list of filters that you see in the modal box is a list of filters that you either created or starred. Note: If there are tickets from projects that are not integrated with PractiTest within those filters, they won’t be imported.

  3. Sync PractiTest with a Jira filter to keep updating PractiTest with its issues: To continuously sync a Jira filter into PractiTest including any issues, go to your project integration settings, choose the “Auto-sync filters” tab, and follow the instructions here.

  4. Sync a Jira ticket to a PractiTest requirement from within Jira, and create a new test in PractiTest to cover it: Click ‘Create Test & Link a Requirement’ on the top-right hand side of the PractiTest panel. Note: you may need to scroll down the panel to see the button. create-test-req-from-jira-button The ticket will be automatically imported into PractiTest as a requirement, and you will be redirected to a newly created test that will be linked to this requirement, which can be viewed in the traceability tab. The requirement will also appear under the Requirements module in PractiTest with the ticket name and link to the Jira ticket.

    If you don’t see the ‘Create Test & Link a Requirement’ option in your PractiTest panel in Jira, your PractiTest plugin might not be up-to-date. Please go to Settings > Apps > Manage Apps and click ‘Update’ under the PractiTest plugin.

Importing and Syncing Jira tickets as PractiTest Issues

There are three ways to import existing tickets from Jira as Issues in PractiTest

  1. Import by IDs. Paste the ID of your Jira ticket. You can sync issues in bulk, separated by commas. sync-issue

  2. Import by Jira filters. This action will sync the current issues in the selected filter into PractiTest, but will not continue syncing the filter if changes are made. New issues that will be added to the filter will not be synced. Check the ‘Jira Filter Name’ on the import modal box and then choose the name of the relevant Jira filter to import. The dropdown list of filters that you see in the modal box displays filters that you either created or starred. import-jira-filter

  3. Import by Jira filters and keep updating PractiTest with the filter’s issues. To continuously sync a Jira filter into PractiTest including any issues, go to your project integration settings, choose the “Auto-sync filters” tab and follow the explanation here.

Editing Synced Field Values in PractiTest or Jira

To configure the mapping between Jira fields and PractiTest, follow these simple configuration steps.

Working with mapped fields allows you to update fields from either PractiTest or Jira. When editing a field in a PractiTest requirement or issue, the field value will be reflected in the synced Jira ticket automatically. When updated from Jira, the change will be reflected in PractiTest. In PractiTest, once the mapping is configured between fields, a new section will appear in your requirements and issues. The new section will include the mapped Jira fields. To edit the field values, click on ‘Edit Jira Fields’, enter the relevant values, then click on ‘Update Jira’. The value change will be reflected in PractiTest and the relevant Jira ticket.

field-sync

field-sync-popup

Note: the PractiTest plugin must be updated to version 3.0.5 to support the update Jira fields feature.

Creating New Issues Only in PractiTest

After enabling PractiTest to create issues that are not linked to the integration, you can create new issues in the PractiTest issues module without syncing them to Jira. Use the ‘New Issue’ button on the top left-hand side of the screen or from within a run.

new-issue-button

Inside your run window, you can use the “Fail & Issue” button to report a bug to Jira or only to PractiTest.

fail-n-issue-options

Linking an Internal PractiTest Issue With Jira

To link an issue that was created in the PractiTest issues module to Jira later on, go to the ‘Actions’ section of the issue.

create-issue-in-jira

When clicking the ‘Create issue on Jira’ item, a new modal window will open. Fill in the issue’s information, and click the ‘Create the issue in Jira’ item.

issues-modal-box

The issue will be then created in your Jira project and will be linked with the issue created in PractiTest.

Note: the information you fill in the modal window will override the existing information in the fields that were filled in the internal issues.

Linking Existing PractiTest Requirements With Jira Issues

  1. Select an existing Requirement in PractiTest.
  2. Click on the “Actions” button and then “Link to Jira issue” in the upper-right corner.
  3. Enter the Jira Issue key. * You can choose to unlink or link back any Requirement at any point. link-existing-requirement

PractiTest Information Inside Jira

If you cannot see the panel as described below, Please make sure your PractiTest plugin in Jira is up-to-date. In Jira, go to Settings > Apps > Manage Apps. Click ‘Update’ under the PractiTest plugin.

A Jira ticket can be connected to PractiTest in two ways:

  1. As a user story/requirement covered by tests in PractiTest
  2. As a bug/issue that originated from a test run in PractiTest

In both cases, you will see live updates from PractiTest in your Jira ticket.

Viewing Test Run Information

If the Jira ticket originated in a PractiTest run, you will have the link to the test run and see its details including run date, run status, and run steps colored according to status. Up to five steps will appear, including the step that created the issue (that will be bold), tester and a link to the original test in the test library.

test-run-in-panel

Viewing Covering Tests Information

If the Jira ticket is synced to a PractiTest requirement and covered by tests, you will have a link to the tests covering the requirement and see information including the test steps, last run date, last run status, and test author. test-in-panel

View Comments

All comments from the synced PractiTest issue/requirement will appear in Jira. Any change to a PractiTest comment will be reflected in Jira.

Syncing Jira Tickets to a New PractiTest Requirement and Creating a Relevant Test

Inside this panel, you also have the ability to sync Jira tickets to PractiTest requirements and create a test that covers them. Simply- click the ‘Create Test & Link a Requirement’ button. Read more about it here

create-test-in-panel

Troubleshooting

If you are using an old Jira integration version (up to 2.4), please update the integration to version 3.0.x

Before checking specific issues, please make sure your integration is configured properly, as described above. Before checking specific issues, please make sure you are not using the same PractiTest integration (configured in the Account Settings) for more than one Jira server/Data Center. If you are unsure about this, please contact our Support Team for assistance.

Jira project is not shown in the settings

If you cannot see your JIRA project in the settings, it’s possible that not all your Jira projects are defined for the integration, either from the start or after you defined them, someone removed them from the integration list of projects. Ask your Jira admin to check if your project is excluded from the integration. In your Jira account, go to Settings → Apps/Add-ons → Manage Apps/Add-ons → Configure. Check that the name of your project is ticked.

Receiving an error when reporting an issue from PractiTest to Jira

The problem might be in Jira and not in the integration. Please try to create an issue in your Jira project. If you’re unable to do so, please contact your Jira admin. If you manage to create an issue inside Jira, please look for your specific issue in the following items.

Required fields in Jira do not appear in PractiTest modal box when reporting an issue, and an error message appears

There may be a few different scenarios that could cause this, which are based on the Jira configuration. A common problem is that the required Jira field is not defined for the Jira project the user is working on. This means that you will see the same error message in Jira when trying to create an issue for the same project.

To fix this, go to Jira settings (in Jira, not PractiTest) - Issues field configuration - default field configuration. Find the field that is causing the issue. You will see that your project does not appear with all the screens of this field. Click Screens and tick the screens relevant to your project. Refresh the screens. Now you should no longer receive the error message. If you continue to see this issue, please contact PractiTest Support.

Permission error occurred in Jira when clicking on ‘Fail and Issue’ in PractiTest

When reporting a bug in Jira and you receive a permission error, “Permission error occurred in Jira. Please validate that your Jira user has the right permissions.”, this means that the Jira user associated with your PractiTest user doesn’t have permission to create an issue in Jira. To solve this please try one or both of the following options:

  1. Ask your Jira admin to verify that your user has the following permissions:
    • In Project level permissions (in Jira go to Project Settings → Permissions): Browse Project, Create Issue, Edit Issue
    • In Global Permissions (in Jira Settings → System → Global Permissions): Browse Users
  2. Associate your PractiTest user with a different Jira user: Go to Project → Personal Settings → “Click here to change your personal information” → “Click here to login to JIRA as a different user”. We will review our logs and check if there were any denied calls made to our servers.

“Jira user account is not configured” message received when adding a test from Jira

After configuring the Jira PractiTest integration, the link between your PractiTest and Jira user will be made the first time you report an issue to Jira from a PractiTest run, the first time you import an issue/requirement, or from the project integration settings.

If you haven’t done this yet and you tried adding a test from the Jira panel, you will receive an error message.

sync-requirement-from-within-jira-2

Go to Project - Personal Settings - Click here to change your personal information (including language): ‘Click here to login to JIRA as a different user’.

If you are using the “Jira no-plugin” integration, link the user in the project integration settings.

Issue/Requirement is not synced with Jira

Please check that your Webhook is properly configured.

Unable to sync new issue or sync new requirement

Go to your PractiTest account settings and test the connection. If it doesn’t work there, please check the following:

  1. Plugin is installed correctly: check that you have PractiTest installed under Apps/Add-ons in your Jira administration window. Click configure and make sure the API token used is the correct one. To verify the token, navigate to the account settings - integrations tab.
  2. Application link: make sure the application link has been created properly using the PTOauthKey, Public Key, and Consumer Callback URL that can be found here.

If you checked all the above and still have an issue, please contact PractiTest Support.

Jira fields aren’t updated in PractiTest

If Jira fields in PractiTest are not updated with changes made in Jira, go to Jira system → Webhooks → PractiTest webhook. Verify that the Exclude Body checkbox is unchecked (as it should be by default).

exclude-body-for-troubleshooting

No Plugin Integration

PractiTest offers a two-way integration with Jira that doesn’t involve a plugin installation. To read more about it, visit this help page.

One-Way Integration

In the one- way integration, when clicking on the Fail & Issue link in a test run, a new issue with all the testing data (steps and actual results) is reported to Jira. A link to the issue in Jira is placed in the paired PractiTest issue.

Configuring PractiTest for One-Way Integration With Jira

Configuring PractiTest to integrate with Jira is simple. Follow these instructions:

  1. In PractiTest, go to Settings > Integrations and activate the Issue Integration by clicking the ‘Activate’ button. practitest-settings-integrations

  2. Once you’ve chosen JiraA One Way, enter the URL Prefix that will be used by PractiTest to connect to your JIRA instance. Make sure this URL has access to create bugs in your Jira project
  3. The URL Prefix should look like this: http://your_server_name/
  4. Each project in Jira has its own unique ID, which is usually a number starting from 10,000. You must enter the ID in the “Jira Project ID” field for your configuration. Note: Jira’s project name/project prefix IS NOT its project ID. Jira’s project ID can be found in many places when looking at the URL, for example: When selecting a project in Jira and clicking on the Reports menu → “Workload Pie Chart Report” (first item), the URL follows this format: http(s)://[JIRA PREFIX]/secure/ConfigureReport!default.jspa?selectedProjectId=10000&reportKey=com.atlassian.jira.ext.charting:workloadpie-report So, in this example, the project ID is 10000.
  5. Put the issue type in # format. You can find the issue type number by going to your Jira Issues, clicking the ‘edit’ icon near the relevant issue type, and seeing its number after .jspa?id= in the URL.
  6. Click the “Create Issue Integration” button to activate the integration.

jira-configuration-2

You can set different projects and different issue types to open directly in Jira.

How to configure it:

jira-configuration-multi-project

Running Tests in PractiTest and Reporting Issues to Jira

  1. Run your tests normally. When encountering an issue, write the “Step’s Actual Results”.

  2. If you configured multiple projects, when you place your mouse over ‘Fail & Issue‘, you can select which project or type (based on your previous configuration) will open in Jira. Choose a project and type. choosing-jira-multi-project

  3. Click the Fail & Issue icon: support-seeing-issues-in-jira1

  4. A new browser tab or window (based on the configuration of your browser) will launch, opening your Jira new issue page. You will see all the test data already pre-entered, including the summary and description pre-filled with steps you’ve executed, and the failed “Step’s Actual Results” (if this information was already entered in PractiTest). You may add more details to the issue. Click Save.

  5. After reporting the issue, take note of the new Jira ID and return to PractiTest, where you will enter this ID in the Issue ID field and click the Link to Step button. You can enter multiple issues at once by separating them with commas or spaces.

  6. The Jira issue will be linked to the test step. licking the issue ID will open it in a new window.

Try Two-Way Integration With Jira Server & Data Center to enjoy the additional advantage of automatic synchronization »

See the two-way integration explanatory video.