Custom Dashboards
Custom Dashboard lists all the dashboards that 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 own 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
Note
The Dashboard access depends upon the package purchased. Packages are mentioned in the table below.
User Role and Rights:
Custom Dashboard module will only be visible if the user has the View rights for Report.
You can create, edit and clone dashboards only if they have the Modify rights for Report.
Package | View Custom Dashboard | Add System Gadgets to Custom Dashboard | Add Gadgets created using QMetry Insights (Custom Gadgets) |
|---|---|---|---|
Base | Y | Y | N |
Advanced Report | Y | Y | Y |
Features
QMetry allows you to perform various operations on custom dashboards, including - adding, sharing, cloning, rearranging, removing, downloading, filtering, editing, scheduling, exporting, and refreshing or syncing.
Add Dashboards
You can create a Custom Dashboard using system gadgets, custom gadgets, or shared gadgets. To add a new dashboard, perform the following steps:
Go to QMetry Custom Dashboard.
On the My Dashboard tab, click New.
Enter the name of the dashboard, assign access permissions, and click Create Dashboard.
Note
QMetry Custom Dashboards cannot be created with duplicate names.
To share the dashboard, add users in the ‘Access’ section by entering their usernames in the "User" tab or by specifying a project or role in the 'Project/Role' tab to grant group access.
The user can add System Gadgets, Custom Gadgets, or Shared Gadgets to the custom dashboard by navigating the tabs and clicking on the '+' sign.
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.
Adding System Gadgets:
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.
Adding 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.
Note
The drill-down functionality is implemented only for Visual Reports. Cross-project charts are not supported for drill-down.
You 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 (:settings:).
Adding 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 (:settings:).
Sharing 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.
Note
The shared dashboard will reflect the filters applied by the creator.
It will be in read-only mode for recipients and cannot be edited via UI or API.
The shared dashboard can be exported in PDF. Individual gadgets on the dashboard can further be exported as CSV.
Users can switch the display view between chart and tabular formats, but these changes will not be saved.
Users can share the dashboard from:
Add Dashboard Screen
Edit Dashboard Screen
Add Dashboard Screen
You can share a dashboard during its creation by adding usernames or specifying the project, and role.
Edit Dashboard Screen
You 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 opens the Edit Dashboard pop-up, enabling users to modify the dashboard name and share it with others by entering their usernames or specifying their projects and roles.
Sharing 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:
Select the Users tab and click Add Users.
Search for the users by clicking search. Select usernames with from the drop-down list.
Click Add.
Click Update Dashboard.
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:
Go to the Projects/Roles tab.
Click on the filter icon to access the filters: Project and Role.
Add desired project and role.
Click Update Dashboard.
Here is the logic followed while sharing a dashboard based on project and role:
Is Project selected? | Is Role selected? | Dashboard is shared with |
|---|---|---|
Y | Y | All the users with the assigned Role in a particular Project |
Y | N | All the users of all the assigned Projects |
N | Y | All the users with the assigned Role in all the Projects |
Generating Embedded URL
Users can generate embedded URLs for sharing a dashboard with users outside QMetry.
Note
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:General Settings & Audit under Customization.
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:
Click Edit Dashboard icon.
Generate URL: In the Edit Dashboard pop-up, go to the Embedded URL tab and click Generate. This creates an embedded URL for the dashboard.
Share URL: Copy the embedded URL and share it via any communication channel.
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:
Hides the embedded URL option in the edit dashboard.
Previously shared embedded URLs are deleted and become inaccessible. Users attempting to access these URLs will receive an error message.
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.
Note
Co-owners can edit or delete the dashboard, add or remove gadgets, modify gadget filters, share the dashboard, schedule, or clone the dashboard.
The grid view displays the details and timestamp of the last user who updated the dashboard, helping identify editors among multiple co-owners.
Dashboard deletions are recorded in the Audit Log report.
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:
If user is not yet added, then click Add Users.
Search the username to add a new user.
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.
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.
Note
The Super Admin can view all dashboards but must assign themselves as a co-owner to edit the dashboards or generate embedded URL for any dashboard.
The super admin can share a dashboard from -
Add Dashboard Screen.
Edit Dashboard Screen.
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.
Note
When the super admin adds a new user by username, the co-owner checkbox is checked by default. To restrict co-owner access, the super admin must uncheck this checkbox.
Super admin can give co-owner rights to any user or all users in a project/role by checking the co-owner checkbox.
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.
Note
Co-owners can edit or delete the dashboard, add or remove gadgets, modify gadget filters, share the dashboard, schedule, and clone it.
Co-owners can perform the following operations on the shared dashboards:
Edit the Dashboard
Delete the Dashboard
Share the Dashboard: Click 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 -
Open the Edit Dashboard screen and open the Users tab.
Click the Delete icon for the user to stop sharing the dashboard with that particular user.
To unshare a dashboard with a group of users -
Open the Edit Dashboard screen and open the Project/Role tab.
Click 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.
Note
Permissions Required: Users with Report "Modify" rights for the project can create a clone of the dashboard.
To clone a dashboard, these are the steps:
Go to Custom Dashboard.
On My Dashboard tab, click Clone.
You can also access the clone icon from the dashboard header after opening the individual dashboard.
You can add or remove Users/Roles for sharing the cloned dashboard.
Click Clone Dashboard.
Rearrange and Resize Gadgets in Dashboard
You can 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.
Removing a Gadget
You 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 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 (:settings:) 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.
Note
Only filters that are common across all gadgets added to a dashboard will appear in the Global Filter section.
If a user accesses the dashboard via an embedded URL without co-owner permissions, the user will only be able to view the common dashboard filters with the applied settings and will not have the ability to modify the filters.
Here’s how Global Filters Function:
When a user applies a global filter, it overrides the current filters on all gadgets.
User can edit the global filters as well as unique filters at the gadget level.
Users can save global or unique filters based on their preferences.
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.
To modify the default filter, click the Filter icon for the gadget.
Select ordeselect filter values and click Apply.
You 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.
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.
Note
Only graphical reports can be emailed using Schedule Report. For tabular reports, users must export them individually as CSV files and share with the recipients.
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 PDF icon on the header.
Note
Only graphical reports can be exported as PDFs.
Tabular reports must be exported individually in CSV format.
All reports are exported in the UTC time zone.
You can also export all the custom dashboard gadgets through the API call.
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.