QMetry Custom Dashboards

Introduction

QMetry Custom Dashboard lists all the dashboards the user has created or are shared with the user. This feature can be accessed from the left panel on the home screen.

Custom Dashboard has two tabs:

• My Dashboard: Displays dashboards created by the user. Users can edit, delete, schedule, and share their dashboards.

• Shared Dashboard: Displays dashboards shared with the user by others. Users can view these dashboards but cannot perform any other operations on them.

The Custom Dashboard offers an easy-to-use interface for organizing custom gadgets in sequence. The dashboard automatically generates "best-fit" charts to display the report data.

A Custom Dashboard can be either Public (shared with other users) or Private (not shared with other users). By default, it remains private when created.

Access Rights

Features

QMetry allows users to perform various operations on custom dashboards, including - adding, sharing, cloning, rearranging, removing, downloading, filtering, editing, scheduling, exporting, and refreshing/syncing.

Add Dashboards

A Custom Dashboard can be created using system gadgets, custom gadgets, or shared gadgets. To add a new dashboard, these are the steps:

1. Click on QMetry Custom Dashboard on the navigation bar.

2. On the ‘My Dashboard’ tab, click on the New button to add a new dashboard.

3. Enter a name for the dashboard, assign access permissions, and click "Create Dashboard."

4. The user can add System Gadgets, Custom Gadgets, or Shared Gadgets to the custom dashboard by navigating the tabs and clicking on the '+' sign.

(A) Add System Gadgets: QMetry System Reports are predefined gadgets that cannot be edited or deleted. The drill-down feature enables the user to view details in a tabular format or download them.

(B) Add Custom Gadgets: Custom Gadgets are user-created gadgets which the user can edit or delete directly from the dashboard. Custom Gadgets can be drilled down to view details in tabular form and downloaded.

Users can perform the following operations in the custom gadget - 

• View Query

• Description of the gadget

• Apply Filter

• Edit, Download, Remove, and Export through the Cog icon ().

(C) Add Shared Gadgets: Shared gadgets are those created and shared by other users. Recipients can view and export these gadgets but cannot edit them.

The logged in user can perform the following operations:

• View query

• View description of the gadget

• Apply filter

• Download, remove, and export using the Cog icon ().

5. Click Close after adding the gadgets.

To add more gadgets to an existing dashboard, open the dashboard and click the Add Gadgets button. Click the + icon to add a gadget to the dashboard. Users can add multiple gadgets at once and can also add the same gadget multiple times.

Share Dashboard with Users

The creator of a dashboard can share it with other users. Once shared, the dashboard will appear under the ‘Shared Dashboard’ tab of the recipients.

Users can share the dashboard from -

(A) Add Dashboard screen

(B) Edit Dashboard screen

Add Dashboard Screen

Users can share a dashboard with other members during its creation by adding their usernames or specifying the project, and role. For more details, refer to the "Add Dashboard" feature mentioned above.

Edit Dashboard Screen

Users can share dashboards from the edit dashboard screen in three ways:

• Share Dashboards by Username: Share the dashboard with individual user.

• Share Dashboards by Project/Roles: Share the dashboard with a group belonging to a particular role/project.

• Share Dashboards through Embedded URL: Share the dashboard with users outside QMetry.

The dashboard edit icon is available on the My Dashboard tab and on the Dashboard Page header.

Clicking the Edit icon will open the Edit Dashboard pop-up, enabling users to modify the dashboard name and share it with others.

Share Dashboard by Adding Users

The dashboard creator can share the dashboard with other users by adding QMetry usernames from the Add Dashboard, Edit Dashboard, or Share Dashboard screens. The steps for sharing the dashboard are consistent across all three screens.

To share dashboard, follow these steps:

1. Select the users tab and click on add users.

2. Search for the users by clicking on search. Select usernames with from the drop-down list.

3. Click on the Add button to add the user.

4. Click on Update Dashboard button.

Share Dashboard by Project/Role

The dashboard creator can share the dashboard with other users by specifying a Project, Role, or a combination of both Project and Role from the add dashboard, edit dashboard and share dashboard screens.

To share a dashboard by Project/Role, these are the steps:

1. Navigate to the Projects/Roles tab.

2. Click on the filter icon to access the filters: Project and Role.

3. Add desired project and role.

4. Click on Update Dashboard.

Here is the logic for sharing a dashboard based on project and role:

Share Dashboard through Embedded URL

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

Super admins can enable this feature from: 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.

If Enabled:

The Embedded URL tab can only be accessed only through edit dashboard screen.

Steps to Generate an Embedded URL:

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

3. 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.

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

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

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.

Disabling the toggle:

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

2. 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).

Use Embedded URL in Confluence

Refer to Add QMetry Custom Dashboard Embedded URL in Confluence for more details.

Share Dashboard with Co-owner Rights

The dashboard creator can assign multiple co-owners to the dashboard. When sharing the dashboard, users or project roles can be designated as either viewers or editors (co-owners).

→ Required Permissions: Shared users or co-owners must have Report and QMetry Insight rights to access the dashboard and its data.

Steps to assign other users as co-owners of the dashboard:

In the add dashboard, edit dashboard or share dashboard pop-up follow these steps:

1. If user is not yet added, then click Add Users.

2. Search the username to add a new user.

3. Select the Co-owner checkbox to designate the user as a co-owner of the dashboard.

Assign Co-owner while Deactivating Users

When deactivating a user, an option is provided to select another user as the co-owner of the deactivated user's dashboards. All private and public dashboards of the deactivated user will be transferred to the selected co-owner.

Clicking the deactivate button will display the following pop-up.

Super Admin Sharing Dashboards

The Super Admin of a QTM instance can access all dashboards. The admin can share the dashboards with individual users, a specific project, certain roles or certain roles within a particular project. The super admin can also grant co-owner status to any user.

The super admin can share a dashboard from -

(A) Add Dashboard screen

(B) Edit Dashboard screen

(C) All Dashboards Tab

The steps to share a dashboard from the Add or Edit Dashboard screen are the same for all users, including the super admin. Refer to the section above for details.

All Dashboards Tab

The "All Dashboards" tab is exclusively accessible to super admins. Super admins can share either a single dashboard or multiple dashboards from this tab.

• Sharing a Single Dashboard: Click the share icon ( ) to share a specific dashboard.

• Sharing Multiple Dashboards: Select the dashboards to be shared from the list and click "Bulk Access."

Both actions will display the "Share Dashboard" pop-up, allowing users to share the dashboard(s) with an individual by username, with a group by specifying the project or roles, or a combination of both.

View Shared Dashboards

Once a dashboard is shared, recipients will be able to view shared dashboard under the Shared Dashboard tab.

Shared Dashboard with co-owner rights

Dashboards with co-owner rights are indicated by a co-owner icon. Users can filter records by Co-owner status (Yes/No). Hovering over the info icon will display the dashboard description.

Co-owners can perform the following operations on the shared dashboards:

A. Edit the dashboard

B. Delete the dashboard

C. Share the dashboard: Click on the Share Dashboard icon to share the dashboard with other users with “View” rights or as co-owners

Unshare a Dashboard

The owner of the dashboard can stop sharing a dashboard for any user or a group of users from the Edit Dashboard screen.

To unshare a dashboard with individual users -

1. Open the Edit Dashboard screen and open the Users tab.

2. Click on the Delete icon for the user to stop sharing the dashboard with that particular user.

To unshare a dashboard with a group of users -

1. Open the Edit Dashboard screen and open the Project/Role tab.

2. Click on the Delete icon for the Project/Role to stop sharing the dashboard with users holding the role in that particular project. The removal will discard the dashboard access to the users who were falling under the selection criteria.

Clone a Dashboard

Users can copy an existing custom dashboard, along with all its gadgets, using the Clone Dashboard feature. This enables users to quickly reuse and modify a dashboard without recreating it or re-adding gadgets. For example, users can clone a dashboard to share with business leaders, updating it with different data points.

The cloned dashboard retains the allocated rights, but users can modify the permissions assigned to users or roles.

To clone a dashboard, these are the steps:

1. Click on QMetry Custom Dashboard on the navigation bar. The QMetry Custom Dashboards screen opens. 

2. On the My Dashboard tab, click on the Clone icon to create a clone of an existing dashboard.

Users can also access the clone icon from the dashboard header after opening the individual dashboard.

3. Users can add or remove Users/Roles for sharing the cloned dashboard.

4. Click on the Clone Dashboard button.

Rearrange and Resize Gadgets in Dashboard

Users can easily rearrange or resize the gadgets for customizing their dashboard view.

• Rearrange Gadgets: Drag the gadget and drop it in preferred spot on the dashboard.

• Resize Gadgets: Drag the edges to resize the gadgets on the dashboard. Users can organize the gadgets by maximizing/minimizing their size.

Remove a Gadget

Users can remove a gadget from the dashboard. If the dashboard is shared with others, the removed gadget will no longer appear in the shared version.

To remove a gadget from the dashboard, click on the Cog icon ( ) and select Remove.

Download Gadget

Users can download a gadget in various formats: graphs can be saved as PNG, JPEG, SVG, or PDF, while tabular data can be exported as XLS.

To download a gadget from the dashboard, click on the Cog icon () for the gadget and select the required download option.

Global Filters

QMetry Custom Dashboards supports Global Filters, allowing users to view and apply common (i.e. shared) filters across all gadgets directly from the top of the dashboard. Instead of configuring filters for each gadget individually, you can set shared filters that apply to all gadgets. However, users still have the flexibility to configure unique filters for individual gadgets.

Here’s how Global Filters Function:

1. When a user applies a global filter, it shall override the current filters on all gadgets.

2. User can edit the global filters as well as unique filters at the gadget level.

3. Users can save global or unique filters based on their preferences.

4. Users can select only one project at a time if a folder-level filter is available in the global filters section.

If a user modifies the Common filter field values at the gadget level and they differ from the Global filter field values, a badge will appear at the gadget level displaying the message: "This gadget uses different filters that don't align with global filters."

If no common filters are shared across the gadgets on the dashboard, the message "There is no common filter available across all gadgets" appears on the screen in place of the global filters.

Filter Gadgets

The values or criteria provided during query execution will be saved and applied as the default for the gadget on the dashboard. If the filter is changed, the updated filter will also apply to other users with whom the dashboard is shared.

1. To modify the default filter, click on the Filter 

   Inline-media-image
   Inline-media-image
   ​ icon for the gadget.

2. Select/deselect filter values and click Apply.

3. Users can also tag the applied filter to identify it.

The filters applied on the gadgets can be viewed on hover over the filter icon in the gadget. The filter count is also displayed.

Edit Gadgets

Click on the cog icon of a gadget and click Edit. Refer to Edit Gadget for more details.

Schedule Custom Dashboard

To schedule one-time or recurring email notifications for a custom dashboard, click the Schedule button for the desired report. The report details will be sent as a PDF to recipients according to the defined schedule.

The scheduler icon (

​ ) is available on the Dashboard list screen and on the dashboard header. Clicking the icon opens a screen with two tabs.

• Schedules: The tab shows a list of the scheduled dashboard.

• Schedule Dashboard: Template to schedule dashboard.

Scheduling Custom Dashboard

Open the Schedule Dashboard tab to fill in details and schedule email notifications with the report in PDF format.

Report details will be sent as a PDF to recipients as per pre-defined schedule, including those outside the QMetry instance.

Once the details are entered, click Submit to schedule the report. The report will be sent as per the set date, time and frequency.

To send the email instantly, click Run Now.

Scheduled Dashboards

Scheduled dashboards will appear on the Schedules tab. Users can edit or delete schedules by clicking the respective icons.

Export Dashboard to PDF

To export the dashboard gadgets to PDF, open the Custom Dashboard and click on the PDF 

​ icon on the header. 

Users can also export all the custom dashboard gadgets through the API call. Refer to the link - API for Reports for more details.

Refresh/Sync Custom Dashboard

To refresh the gadgets on the custom dashboard manually, click on the Refresh 

​icon on the dashboard header. It will sync the gadget data to render the reports with the latest data.