/
AssureX for Jira Cloud — Product Guide

AssureX for Jira Cloud — Product Guide

Welcome to the documentation hub for AssureX for Jira Cloud.

AssureX is a test management app for Jira that lets you design test cases, organize plans and sets, execute tests, track coverage, and review history directly inside Jira.

1. Overview

AssureX extends Jira Cloud with:

  • Global configuration pages for test statuses, step statuses, environments, and parameter value lists.

  • Project-level settings to enable AssureX per project and control test coverage.

  • Issue panels for:

    • Test authoring (Test Details)

    • Test execution (Execution Details, Test Run)

    • Test grouping (Test Plan, Test Sets)

    • Preconditions (Precondition details)

    • Coverage (Test Coverage)

  • A project-level AssureX Board to execute and track tests.

  • AssureX History in issue activity.

AssureX consists of:

  • A Forge app that runs inside Jira Cloud.

  • A Node.js backend hosted on AWS, used for test data storage and processing.

2. Installation

You must be a Jira administrator to install AssureX.

Steps

  1. Log in to your Jira Cloud site.

  2. Go to Settings (⚙️) → Apps.

  3. Click Explore apps (or Find new apps).

  4. Search for “AssureX”.

  5. Select AssureX

  6. Click Install and confirm the permissions.

After installation:

  • AssureX appears under Manage apps.

  • Global configuration for AssureX is available to Jira administrators.

 

3. Getting Started

Once installed, there are two key entry points:

3.1 Global Settings (Jira Admin)

  • Navigate to Settings (⚙️) → Apps → AssureX.

  • Use this area to:

    • Define test statuses

    • Define test step statuses

    • Define test environments

    • Configure parameter value lists

    • (Optional) Use import and advanced configuration options

3.2 Project Settings (Project Admin)

  • Open a Jira project.

  • Go to Project settings → Apps → AssureX.

  • Here you can:

    • Enable AssureX for the project

    • Configure project-level test coverage

    • Adjust project-specific settings

 

4. Global Configuration (Admin)

Global configuration is done by Jira administrators and applies across projects (unless scoped per project in the UI).

Key elements:

  1. Test Statuses
    Define overall test execution statuses (e.g., To Do, In Progress, Pass, Fail, Blocked).

  2. Test Step Statuses
    Define outcomes at step level (e.g., Passed, Failed, Blocked).

  3. Test Environments
    Define environments such as QA, UAT, Production for running tests.

  4. Parameter Value Lists
    Create reusable lists (e.g., browsers, regions, user roles) used in test datasets.

 

5. Project Configuration

Each Jira project can be individually configured to use AssureX.

5.1 Enable AssureX for a Project

  1. Open the project.

  2. Go to Project settings → Apps → AssureX.

  3. In Settings, enable the option (e.g.):

    • Allow agile test types to current project

  4. Save changes.

This allows AssureX issue types and panels to work within that project.

5.2 Test Coverage Settings

  1. In Project settings → Apps → AssureX, open Test Coverage Settings.

  2. Select which issue types (e.g. Story, Bug) should display the Test Coverage panel.

  3. Save changes.

6. Using AssureX in Jira Issues

AssureX uses dedicated issue types (for example, TestCase, Test Plan, Test Set, Test Precondition, Test Execution) and adds context-specific panels to each.

6.1 Test Details

Use case: Create and manage manual test cases with steps, data, and expected results.

  • Navigate to an Assure Test issue.

  • Open the Test Details tab/panel.

  • Add steps with:

    • Action

    • Data

    • Expected Result

  • Optionally:

    • Reorder steps

    • Attach files at step level

    • Configure Dataset and Parameters for data-driven testing

 

6.2 Test Plan

Use case: Group tests into a plan for a specific release, sprint, or scope.

  • Navigate to an Assure Test Plan issue.

  • Open the Tests (Test Plan) panel.

  • Add/link tests to the plan.

  • Use table actions (sorting, pagination, navigation) as needed.

 

6.3 Test Preconditions

Use case: Define reusable preconditions that must be satisfied before executing tests.

  • Navigate to an Assure Test Precondition issue.

  • Open the Precondition details panel.

  • Document steps or conditions required prior to running associated tests.

 

6.4 Test Sets

Use case: Group related tests into sets (e.g., smoke tests, regression packs).

  • Navigate to an Assure Test issue.

  • Open the Test Sets panel.

  • Add or remove the current test from one or more Test Sets.

  • Use the grid for sorting and navigation.

 

6.5 Test Run & AssureX Board

Use case: Execute tests and track step-level results.

  1. Navigate to an Assure Test issue.

  2. Open the Test Run panel.

  3. From the list of runs, click the Play (▶) icon to start an execution.

  4. You will be redirected to the AssureX Board, where you can:

    • Execute each step

    • Record step statuses (e.g., Passed, Failed, Blocked)

    • Capture notes and attachments

    • View iterations and environments

 

6.6 Test Coverage

Use case: Track which issues (for example, user stories) are covered by which tests.

  • For configured issue types (by default, Story if not customized), open the Test Coverage panel.

  • Review linked tests and their execution status for that issue.

Coverage behavior is controlled in Project settings → Apps → AssureX → Test Coverage Settings.

6.7 AssureX History

Use case: View AssureX-related activity stream for supported issue types.

  • Open an AssureX-related issue whose type description begins with assure.

  • In the Activity section, select AssureX History.

  • Review recorded test-related activity (such as updates, executions, and status changes driven by AssureX).

7. Troubleshooting

Panels not visible

  • Ensure AssureX is enabled for the project:
    Project settings → Apps → AssureX → Settings → Allow agile test types to current project.

  • Confirm you are using the correct AssureX issue types (e.g., Assure Test for Test Details).

  • Check that your Jira permissions allow you to view the project and the issues.

Test Coverage panel missing

  • Check configuration in Project settings → Apps → AssureX → Test Coverage Settings.

  • If no explicit configuration is provided, coverage typically defaults to the Story issue type.

Errors when saving or executing tests

  • Note the:

    • Jira issue key

    • Time of the error

    • Error message displayed

  • Optionally capture a screenshot.

  • Contact support with these details (see Support ).

8. Release Notes

Release notes, including new features, fixes, and improvements, are maintained here:
Release Notes - AssureX - Confluence

9. Support

For questions, issues, or feature requests related to AssureX :

When contacting support, please include:

  • Jira site URL

  • Project key and issue key(s)

  • Short description of the problem

  • Steps to reproduce

  • Screenshots or logs (if available)