/
Add QMetry Custom Dashboard Embedded URL in Jira Dashboard

Back to QMetry All Products Help Page

Add QMetry Custom Dashboard Embedded URL in Jira Dashboard

Owned by Mrunalini Potnis
Last updated: Aug 22, 2024

Introduction

The creator of a custom dashboard can generate and share an embedded URL, providing read-only access to live report data for users without direct access to QMetry. This link enables sharing the dashboard with other users or integration with third-party systems.

Generating Embedded URL

Users can generate embedded URLs for sharing a dashboard with users outside QMetry.

Notes:

  • The super admin must activate the setting "Allow Users to Generate Embedded URL for Sharing Reports Outside QMetry."

  • By default, this feature is enabled for Super Admins.

Super admins can enable this feature from:

  1. Home > Customization > General Settings & Audit

When enabled, the dashboard creator can generate an embedded URL for all types of dashboards like co-owned, shared, cloned etc.

image-20240624-123158.png

If Enabled:

The Embedded URL tab can only be accessed through edit dashboard screen from the QMetry Custom Dashboards.

image-20240725-192729.png

Navigate to:

  1. Home > QMetry Custom Dashboards > My Dashboard

Steps to Generate an Embedded URL:

  1. Ensure the generate embedded URL toggle is enabled.

  2. Click on the Edit Dashboard icon. (Refer below image for reference).

image-20240710-111405.png

  1. Generate URL: In the Edit Dashboard pop-up, go to the Embedded URL tab and click Generate. This will create an embedded URL for the dashboard.

image-20240710-115700.png

  1. Share URL: Copy the embedded URL and share it via any communication channel.

image-20240710-104148.png

  1. Access the dashboard: Users outside QMetry receive view-only access to the dashboard, with tags and applied filters visible on hover.

image-20240710-104652.png

The embedded URL can be used for third-party integrations.

If Disabled:

The Super Admin can disable embedded URL sharing by toggling off Allow Users to Generate Embedded URL for Sharing Reports Outside QMetry.

image-20240710-104350.png

Disabling the toggle:

  1. Hides the embedded URL option in the edit dashboard.

image-20240710-104512.png

  1. Previously shared embedded URLs will be deleted and become inaccessible. Users attempting to access these URLs will receive an error message (refer to the image below).

image-20240710-104748.png

Re-enabling the toggle will not reactivate the URLs; users need to regenerate new URLs and reshare.

This setting allows Super Admins to control the availability of dashboard embedded URLs, ensuring both security and functionality. It restricts external sharing and viewing of dashboards, enhancing overall security.

Embedded URL gives access over live reports - graphical as well as tabular.

Using Embedded URL in Jira Dashboard through iFrame

The Embedded URL can be used in JIRA to view QMetry reports on Jira Dashboard page. Users without QMetry access can view these reports in read-only mode within Jira.

Steps For Jira Cloud

This section describes the Prerequisites and Steps required to embed Iframes into Jira Dashboards for Jira Cloud edition.

Any Jira app that enables displaying iframe in Jira gadgets will allow you to render the QMetry custom dashboard on your Jira dashboard through the embedded URL.

Pre-requisites:

  • Iframes for Jira Cloud or any other similar Jira app should have been installed on the Jira instance.

  • There should be connectivity between QMetry and Jira.

Steps to embed an iframe into a Jira Dashboard:

1. Go to your Jira dashboard and click on the Edit button.

image-20240822-084020.png

2. On the Add a Gadget panel, search for “iframe” and click Add to add the gadget to the dashboard.

image-20240822-084139.png

The Iframe gadget is added on the screen.

3. Provide the QMetry dashboard embedded URL in the URL parameter.

4. Adjust the Height as per requirement.

5. Click Save.

image-20240822-085845.png

The QMetry Custom Dashboard is displayed on the Jira Dashboard.

image-20240822-085415.png

Steps For Jira Server

This section describes the Prerequisites and Steps required to embed Iframes into Jira Dashboards for Jira Server edition.

Pre-requisites:

  • QMetry Application and Jira server both should be configured on https or http.

  • There should be connectivity between QMetry and Jira.

Steps to embed an iframe into a Jira Dashboard:

Users can use the provided Text-Gadget to enter arbitrary HTML. Ensure that the Text-Gadget is enabled by the JIRA Administrator.

  1. Navigate to:

  1. Settings > Add-ons > Manage-Addons > System Add-ons > Expand.

  1. Search for - “Atlassian Jira - Plugins - Gadgets Plugin”.

  2. Expand the Modules and enable 'Text (text-gadget)'.

  1. After making the relevant changes, navigate to: Jira Dashboard > Create Dashboard > Add Gadget (ensure all gadgets are loaded).

  2. Search for “Text,” then select Add Gadget.

  3. In the HTML text field, the user needs to specify the embedded URL (under the “src” tag) using the following format (refer to the attached example).

    • Replace the QMetry Custom Dashboard Embedded URL in the “src” tag (highlighted in the given example).

    • Width of iframe (recommended: 1200)

    • Height of iframe (recommended: 3000)

    • Example:
      <iframe src="https://testmanagement.qmetry.com/#/qmetry-dashboards/A0IqbS1R/embedded?key=6c8ebb03f0e6cac383832e1c34d681af42ea" style="height:3000;width:1200;"></iframe>

  4. Click on Save.

Users will see that the iframe has been added to the page, displaying the QMetry report in read-only mode.

image-20240704-100119.png

 

Back to QMetry All Products Help Page