Add QMetry Custom Dashboard Embedded URL in Confluence

Add QMetry Custom Dashboard Embedded URL in Confluence

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 be accessed only 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.

Steps to use Embedded URL in Confluence

The Embedded URL can be used in Confluence to display QMetry reports on a Confluence page. Users without QMetry access can view these reports in read-only mode within Confluence.

Pre-requisites:

  • QMetry Application and Confluence both should be configured on https.

  • QMetry URL should be accessible from Confluence.

Steps - For Confluence Cloud

  • In Confluence, create a blank page by clicking on the Create button.

  • Open the + drop-down menu and select View more to search for more macros.

  • Insert the iframe macro in the Confluence page. Refer to this article for more details. Type “iframe” in the search box to search for the iframe macro.

  • Add following settings for the Iframe window - Enter the QMetry Custom Dashboard Embedded URL in URL, Width of iframe (recommended: 1000), Height of iframe (recommended: 3000), Scrolling: Auto. You can Preview the page in the window.

  • Now Publish the confluence page.

  • You can see the iframe is added to the page. QMetry report is rendered on the page in read-only mode.

image-20240704-100115.png

Steps - For Confluence Server

Reference: Refer to this How to put an iframe into Confluence | Confluence | Atlassian Support for more details.

  • Log in as Confluence Administrator, then

    • Go to Manage Apps at > Manage Apps.

    • Search for "Confluence HTML Macros" with "All apps" selected in the dropdown.

    • Under "System apps", click on "Confluence HTML Macros" to expand the app details.

    • Expand the modules in the far-right column.

    • Enable the module called "html (html-xhtml)".

  • In Confluence, create a blank page by clicking on the Create button.

  • Open the + drop-down menu and select “Other macros”.

  • Search for the HTML macro.

  • Paste the following code inside the HTML macro, replacing the QMetry Custom Dashboard Embedded URL in “src”. Modify the other parameters such as width and height as you see fit.

    <iframe src="https://testmanagement.qmetry.com/#/qmetry-dashboards/A0IqbS1R/embedded?key=61fd3ed182b7164be6ffccbfe1190764622505169ae6c136fdf39bfb4ee8c072bb6fc04f54ce3f00f213750bbb907500&lang=en" noborder="0" width="1000" height="3000" scrolling="yes" seamless></iframe>

To access the Report dashboard URL on a Confluence page with the sandbox attribute, users need to include two additional attributes: "allow-same-origin" and "allow-scripts". Add the following code after the src attribute in the code block above:

  • i.e. sandbox="sandbox allow-same-origin allow-scripts"
  • Now Publish the confluence page.

  • Users will see that the iframe is embedded within the HTML macro on the page, rendering the QMetry report in read-only mode.

image-20240704-100115.png