QTM4J Confluence Integration

QTM4J Confluence Integration app offers you a seamless way to integrate your QMetry Test Management for Jira (QTM4J) with Confluence. The app allows the display of QMetry Test Management for Jira (QTM4J) test cases/test cycle/test plan on Confluence pages.

Users can -

  • Display a list of QMetry test assets in a tabular view for reporting.

  • Mention a single test asset with a hyperlink for direct reference on the page.

  • Create a test asset and display it on the same Confluence page without leaving it.

  • Embed QTM4J Assets macro into a Confluence page to display dynamic content by applying filters on test assets of QMetry Test Management for Jira.

Overview

QTM4J Confluence Integration app enables you to insert QTM4J Assets Macro. The macro gives you control over which issues from QMetry Test Management for Jira to display and their appearance on the Confluence page. Teams can fetch the test assets information (test cases, test cycles and test plans) they need to do their job and even track issues effortlessly. The app enables the teams that are live in Confluence to retrieve issues the other teams are working on in QMetry Test Management for Jira, which saves time required in updating teammates.

The app evades the need for context switching between Confluence and Jira. For example, QA Manager is writing a test report, they don’t have to leave the Confluence page to check the test assets in QMetry Test Management for Jira. They can just insert the QTM4J Assets macro as a ready reference to the management to showcase the current state of the testing activity.

Pre-requisites:

  • User should have Admin rights for both Jira and Confluence applications.

  • “View” and “Create” permissions are required for Test Case, Test Cycle and Test Plan on the QMetry Test Management for Jira instance.

Install QTM4J Confluence Integration App

You can install the QTM4J Confluence Integration app through either of the following methods:

  • Installing through Atlassian Marketplace

  • Installing through Confluence

 

Installing through Atlassian Marketplace

Step 1. Go to the QTM4J Confluence Integration app page https://marketplace.atlassian.com/apps/1225227/qtm4j-confluence-integration?hosting=cloud&tab=overview.

Step 2. Select Data Center from the Hosting Options and click on the Get it now button on the page.

Step 3. The pop-up opens highlighting the hosting type selected. Click on the Get it now button for Data Center hosting type.

Step 4. The QTM4JConfluenceIntegration JAR file will be downloaded on your system.

Step 5. Now log in to Confluence with admin credentials.

Step 6. Go to Administration > General Configuration.

Step 7. Select Manage apps on the navigation bar.

Step 8. Click on the Upload app link on the page.

Step 9. Browse the downloaded JAR file and click on the Upload button.

The installation process is initiated.

Once the installation is complete, the success message appears. You can see the install under the Manage app section.

 

Installing through Confluence

Pre-condition: Users should have admin rights for the Confluence instance.

Step 1. Log in to Confluence with admin credentials.

Step 2. Go to Administration > General Configuration.

Step 3. Select Find new apps on the navigation bar.

Step 4. Search for “QTM4J”. The QTM4J Confluence Integration app is listed. Click to open the app page.

Step 5. Click on the Install button for the app.

Step 6. The confirmation screen pops-up. Click on the Accept & install button to proceed with installation.

The app gets installed on the instance.

 

 

Once installed, you can see the QTM4J Confluence Integration under the Manage apps section.

 

Configure QTM4J Application Link with Confluence

Users can create Application links that let them integrate Confluence with QTM4J applications so they can exchange information, resources, and functionalities.

→ Permissions Required: Users should have Admin rights for both Confluence as well as Jira instances.

Steps:

1. Open the Administration menu and open General configuration.

 

2. Then click on the Application Links on the navigation bar.

The Confluence administration screen opens.

3. Click on the Create Link button.

The Create Link pop-up opens.

4. Select “Atlassian Product” as the Application type and click on the Continue button.

 

The Link applications pop-up opens displaying the details of creation of the link from Jira application to the Confluence application.

5. Click on the Continue button to proceed.

You will be then redirected to the QTM4J instance the link of which you have created in Confluence.

6. Enter Administrator password to validate your credentials in QTM4J.

Once logged into Jira, you can see the integrated Confluence on the list.

You will be then navigated back to the Confluence.

You can see the link configuration is in-progress.

The QTM4J application link is configured within Confluence and the two-way connection is established.

Now you can view the data of linked QTM4J application in Confluence.

Integrate QTM4J Assets Macro With Confluence

Once your QTM4J application link is configured with QTM4J Confluence Integration app, you can integrate QTM4J Assets Macro within your Confluence page and start accessing QMetry Test Management for Jira assets.

You can integrate QTM4J Assets macro through the Macro menu on the toolbar.

Step 1 Open the macro drop-down on the Confluence toolbar and select Other macros.

The Select macro pop-up opens.

Step 2 Search for “QMetry” and you will see the QTM4J Assets macro on the screen.

Step 3 Click on the QTM4J Assets macro to insert QTM4J Assets into Confluence.

The Insert QTM4J Assets Macro screen opens.

Note: If you are using QTM4J Assets macro in Confluence for the very first time after configuring the QTM4J application link, then you will be asked for Jira Authentication.

Steps for Jira Authentication

If you are using QTM4J Assets macro in Confluence for the very first time after configuring the QTM4J application link, the Insert QTM4J Assets Macro screen.

1. Follow the Click Here link, which will navigate you to the Jira application for authentication.

The next screen will ask your confirmation to allow Confluence the read and write access to your data on the QTM4J application.

2. Click on the Allow button to grant the permission.

The success message appears. Then you can continue with the operation on Confluence site.

Select QTM4J Assets

You can view test assets of the QMetry Test Management for Jira projects for which you have access rights.

For the ease of selection of test assets, you can search QMetry Test Management for Jira test assets by applying the following criteria:

  • Instance: If there are more than one QTM4J application links are configured on the Confluence, then only the Instance drop-down appears. Select the required QTM4J application instance. In case of a single application instance, the drop-down is not displayed on the screen. By default, users can select Project of the single configured instance only.

  • Project: QMetry Test Management for Jira Test Management project on which you have access rights.

  • Entity Type: Search assets based on their entity type in QMetry Test Management for Jira - Test Case/Test Cycle/Test Plan.

  • Folder: Search test assets on the assets folder to view assets under that particular folder.

  • More Filters: Apart from Key/Summary, you can filter out test assets on other filters like Label, Sprint, Components, Status, Priority, etc.

 

Using filters saved in QMetry Test Management for Jira

You can use filters saved in QMetry for Test Management for Jira.

  • Public filters are available to use for all users even though these filters are saved by other users in QMetry for Test Management for Jira.

  • Private filters can only be used by the users who have saved them.

Click on the More button and select the Filter on which you want to filter the records and click Done.

The Filter panel displays saved filters, if available. Select the Filter name on the drop-down to apply it.

The list of test assets populates as per the applied selection criteria and filter.

The Issue Key is clickable, which opens the issue detail page in QMetry Test Management for Jira.

Select the required assets that you want to insert into Confluence and click on the Insert button at the bottom.

QTM4J Assets panel is inserted into Confluence with the selected test assets. You can insert multiple QTM4J Assets macros on the Confluence page.

To view the result of the inserted macros, publish the Confluence page. You can view the QTM4J assets according to filters applied and selection made in the macro.

Create a New Entity

You can create a new test asset into QMetry Test Management for Jira straightaway from Confluence. It gives you the flexibility to create assets without switching to QMetry Test Management for Jira application. This way you can insert entities on the go and make team refer them quickly.

Follow the steps mentioned below.

Step 1 On the Insert QTM4J Assets screen, open the section of Create New Entity by clicking on it.

The panel at the right displays fields to create a new asset in QMetry Test Management for Jira through Confluence.

Step 2 To create a new entity, mention the following details on the screen.

  • Instance: The Instance drop-down will appear only in case of multiple QTM4J application links configured with Confluence. Users will not see the drop-down if only a single QTM4J application link is configured with Confluence.

  • Project: Select QMetry Test Management for Jira project in which you want to create a new entity.

  • Issue Type: Select the Issue Type you want to create - Test Case, Test Cycle, Test Plan.

  • Enter Summary and Description regarding the entity.

Fill other required details. Fields marked with * mark are mandatory to fill up to create an entity.

Step 3 Click on the Create button.

Step 4 Then click on the Insert button at the bottom.

QMetry Assets panel is inserted into Confluence with the selected test assets.

To view the asset added through the inserted macros, publish the Confluence page. You can view the newly added QTM4J assets from Confluence.

You can edit the inserted QTM4J Assets macro. Refer to the Edit Inserted Macro section for more details.

Display Settings

The Display Settings section lets you configure the view of test assets on Confluence. You can set the preference as to how the test assets should appear on the page.

Note: The Display Settings section gets enabled only after you select a Project and Entity Type on the screen.

  • Display as a Single Issue: The option is enabled only if you have selected a single asset in the Search section on the Insert QTM4J Assets Macro. Note that you can opt to display the selected test asset either as a single issue or in table format.

Update the Confluence page. The selected test asset will be displayed as an individual entity.

  • Display as Table: The selected test assets will be displayed as per the Table configuration done in this section.

    • Page Limit: Define the number of records that you want to display on a single page of the macro. You can define the pagination limit up to 100.

    • List Columns to Display: The field contains default columns selected on it to display on the page. You can add more columns using the drop-down menu or remove selected columns as per your preference. The list displays columns as per the selected Entity Type.

You can also Select All Columns to display on the page. If you want to get back to the default column selection, click on the Reset to Default option.

Update the Confluence page once you insert the Macro onto the page.

The table is generated in accordance with the display settings done for the table.

Editing Inserted Macros

You can edit the inserted QTM4J Assets macro anytime on Confluence. Open the Confluence page in Edit mode.

Follow the steps mentioned below.

Step 1 Click on the QTM4J Assets macro panel inserted on the page. The Edit and Remove buttons become visible.

Step 2 Click on the Edit button to make any changes to the panel.

Step 3 Deselect the selected assets on the screen and you can then search required assets afresh.

Step 4 Select the desired test assets and adjust the Display Settings if required.

Step 5 Click Save to save your changes.

View QTM4J Assets on a Published Page

When the Confluence page on which you have inserted the QTM4J Assets macro is published, it displays test assets as per the applied selection criteria.

The panel has the following options on it.

A. Refresh Results to sync the test assets with QMetry Test Management for Jira.

B. Clickable Jira Issue Key to open the test asset detail page in QMetry Test Management for Jira.

C. Pagination to navigate across the pages.

D. Expand/Collapse toggle option to resize the panel and save space on the page.

Copy Confluence Pages with QTM4J Assets Macro

The following points are applicable to the QTM4J Confluence Integration.

  • If you copy an existing Confluence page, which has QTM4J Assets Macro embedded on it, the original page and copied page remain independent of each other.

  • Any changes done in the inserted QTM4J Macro in either of the pages reflect in the same page only i.e. the changes in QTM4J Assets Macro in the original page do not impact the copied page and vice-a-versa.

Delete QTM4J Application Links from Confluence

Users can remove the linkage of QTM4J Application with Confluence if it is no more required.

Steps:

  1. Open the Administration menu and open General configuration.

  2. Then click on the Application Links on the navigation bar.
    The Confluence administration screen opens.

  3. Click on the configured QTM4J Application link to open the more options and select Delete.

The Confirmation message pops up.

4. Click Confirm to proceed.

Limitation

Currently, the “Export to Word and PDF” Confluence feature is not supported for QTM4J Assets macro.