QMetry Custom Dashboards

QMetry Custom Dashboard access depends upon the package you have purchased as mentioned in the table below.

Overview

Custom Dashboard lists all the dashboards that you have created or that are shared with you. Custom Dashboard is divided into two sections:

• My Dashboard: These dashboards are created by self. It allows you to edit, delete, schedule and share self created dashboards.

• Shared Dashboard: These dashboards are shared with you by others. These dashboards are shared just for view purpose. You can not perform any other operations on it.

Custom Dashboard provides an easy-to-use interface that allows you to organize custom gadgets in sequence. Dashboard generates "best-fit" charts for the report data automatically. Users can add System/ Custom gadgets or Shared gadgets to the Dashboard.

A Custom Dashboard can be either Public or Private. By default, it remains private when created.

• Public: When a custom dashboard is shared with other users, it is tagged as "Public".

• Private:  When a custom dashboard is not shared with other users, it is tagged as "Private".

Note: QMetry Custom Dashboard module will only be visible if the user has the View rights for Report. Users can create, edit and clone dashboards only if they have the Modify rights for Report.

You can perform the following operations on Custom Dashboard.

Add Dashboards

You can add new custom dashboards and also modify them as per requirement. A Custom Dashboard can be created using system gadgets, custom gadgets or shared gadgets.

Steps:

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

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

3. Give Dashboard Name, allow users access to the dashboard, and click Create Dashboard. QMetry Custom Dashboard can not be created with a duplicate name. Users can still access the shared Dashboard which may hold the same name as users' own Dashboard. Read more about Share Dashboard in the following sections.

On clicking on the Create Dashboard button, the list of available Gadgets is displayed. A Custom Dashboard can be created using system gadgets, custom gadgets, or shared gadgets.

(A) Add System Gadgets: QMetry System Reports are available to add as System Gadgets. These predefined gadgets can neither be edited nor deleted. System Gadgets can be drilled down to view the details in tabular form and download it.

(B) Add Custom Gadgets: Custom Gadgets are the list of gadgets created by the logged-in user. The owner of the custom gadget can edit the custom query/logic directly from the dashboard. These custom gadgets can be edited as well as deleted.

For an added custom gadget, you can - 

• 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 gadgets that are shared by other users. The user to whom it has been shared can just view the gadget and export it. They can not edit the gadget shared by other users.

Shared are those gadgets whose owner is not the logged-in user but which are shared by other users.

• View Query

• Description of the gadget

• Apply Filter

• Download, Remove, and Export through the Cog icon

Click Close once you are done adding the gadgets.

To add more gadgets to an existing dashboard, open the dashboard and click on the Add Gadgets button. Click on the + icon to add that gadget to the dashboard. You can add multiple gadgets at a time. You can also add a single gadget multiple times.

Share Dashboard with Users

The user who has created a dashboard can share it with other users. Once a dashboard is shared, the user, with whom it has been shared, will be able to see that dashboard under the Shared Dashboard tab. 

• The shared dashboard will appear in accordance with the filters applied to it by the dashboard creator.

• The shared dashboard will be read-only for the users with whom the dashboard has been shared. This dashboard cannot be edited through UI or API.

• The shared dashboard can be exported in PDF as a whole. Individual gadgets on the dashboard can be exported into CSV.

• The shared dashboard will appear in accordance with the view preserved by its owner/creator. The users with whom the dashboard has been shared, will be able to change the display view from chart to tabular & vice versa but that view will not be preserved.

You can share the dashboard from -

(A) Add Dashboard screen

(B) Edit Dashboard screen (Edit icon is available on My Dashboard tab and Dashboard Page header)

(A) Add Dashboard screen

Share Dashboard by Adding Users

The user who has created the dashboard can share it with other users using the user names in QMetry.

1. Open the Share Dashboard icon (either (A) or (B) above), the screen opens with two tabs on it: Users and Project/Role

2. Click Add Users.

3. Select users on the drop-down list with whom the dashboard is to be shared.

4. Click Add.

Share Dashboard by Project/Role

The user who has created the dashboard can share it with other users by specifying either Project, Role or the combination of Project & Role in QMetry.

1. Open the Share Dashboard icon (either (A) or (B) above), the screen opens with three tabs on it: Users, Project/Role and Embedded URL.

2. Click Add Projects/Roles.

3. Open the Filter menu to see two filters: A. Project B. Role.

Once a dashboard is shared with the user, they will be able to see that dashboard under the Shared Dashboard tab.

A shared dashboard will be read-only for the users with whom it has been shared. Users will not be able to apply or view any filters in the reports of the dashboard.

(B) Edit Dashboard screen

The dashboard Edit icon is available on -

My Dashboard tab

Dashboard Page header

On clicking the Edit Dashboard icon, the screen opens with three tabs on it: Users, Project/Role and Embedded URL.

• Users: To share the dashboard to individual users, open the Users tab.

• Project/Role: To share the dashboard to a particular role/project, open the Project/Role tab.

Sharing Dashboard with Co-owner Rights

The user who creates the dashboard can also add multiple co-owners for those dashboards. While sharing a dashboard, the users/project-roles can be allowed to as a viewer or as editors i.e. co-owners.

Use Case: QA Teams across the projects maintain a reporting template and use them for their internal reporting. This feature allows the team to collaborate in managing the dashboard. It also saves the time and effort required in creating a new QMetry dashboard every time for different users.

The dashboard owner can assign single/multiple users as co-owners of the dashboards and can delete the dashboard.

Notes:

• Rights of a Co-owner: Editing, deleting the dashboard, adding/removing gadgets on the dashboard, modifying filters of gadgets, sharing dashboards with users/roles or projects, scheduling, or cloning the dashboard.

• The details of the user who updated the dashboard last are displayed on the grid view of the dashboard with the timestamp. It is useful to identify editors in case of multiple co-owners for the dashboard.

• The dashboard deletion entry is captured in the Audit Log report.

→ Required Permissions:

• Users with whom the dashboard is being shared or who are being assigned as co-owner should have the Report and QMetry Insight rights to access the dashboard and dashboard data.

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

1. Open the QMetry Custom Dashboard section and go to the My Dashboards tab.

2. Click on the Edit icon.

Select the Co-owner check box to make the user co-owner of the dashboard.

Shared Dashboard

In the Shared Dashboard tab, you can see the list of dashboards shared with you. The dashboards shared with co-owner rights display with the co-owner icon. You can also apply a filter on the record with Co-owner (Yes/No).

Co-owner of the dashboard can edit, delete the dashboard, add/remove gadgets on the dashboard, modify filters of gadgets, share dashboards with users/roles or projects, schedule, and clone the dashboard.

Assign Co-owner while Deactivating Users

While deactivating a user an option is provided to select another user who will be the co-owner of the deactivated user's dashboards.

All the private and public dashboards of the user that is being deleted will be shared with the user as a co-owner of those dashboards.

Super Admin Assigning Co-owner

The Super Admin of the QTM instance can access all the dashboards created by users and share QMetry dashboards with other users and make them co-owners of the dashboard who can also edit the shared dashboards. The Super Admin can share the dashboard with users or project-roles as viewers or as co-editors of the dashboard.

Notes:

• The super admin can view all the dashboards but to edit the dashboard, the super admin should assign oneself as the co-owner of the dashboard to perform the edit operation.

→ Required Permissions:

• Users should have Super Admin rights to be able to view all the dashboards and share them with other users.

Steps:

Open the QMetry Custom dashboard section and go to the All Dashboards tab.

→ Filter: You can search the required dashboard Name and also apply filters on the type of sharing i.e. Private/Public, Created By, and Updated By.

Share a Single dashboard

1. Click on the Share Dashboard icon for the dashboard you want to share.

2. On the Users tab, click Add Users.

3. Select users on the drop-down list with whom the dashboard is to be shared.

4. Click Add.

The user gets added to the screen.

Select the co-owner check box to assign the user as a co-owner for the dashboard being shared.

Share Multiple dashboards

Steps:

1. To share multiple dashboards, select the dashboards and click on the Bulk Access button.

2. On the Users tab, click Add Users.

3. Select users on the drop-down list with whom the dashboard is to be shared.

4. Click Add.

The Co-owner checkbox is checked by default for user(s).

Clear the checkbox if you do not want to assign the selected user(s) as co-owners. They will just be able to view the dashboards.

Share dashboard by Project/Role

Share a Single dashboard

The user who has created the dashboard can share it with other users by specifying either Project, Role or the combination of Project & Role in QMetry.

1. Open the Project/Role tab.

2. Click on the Add Project(s)/Roles(s) button.

3. Select Project from the drop-down. The Roles will populate for the selected project(s). Select Role(s) from the drop-down.

4. Co-owner: Select the checkbox to assign all the users holding the selected Role as co-owners of the dashboard.

Share Multiple Dashboards

The Co-owner checkbox is checked by default for project(s)-role(s).

Clear the checkbox if you do not want to assign the user(s) of the selected project-role as co-owners. They will just be able to view the dashboards.

The Co-owner checkbox is checked by default for project(s)-role(s).

Clear the checkbox if you do not want to assign the user(s) of the selected project-role as co-owners. They will just be able to view the dashboards.

Co-owner View

If you have been assigned as a co-owner of a dashboard/dashboard, you can view the Co-owner icon before the dashboard Name under the Shared dashboard. The info icon displays the dashboard Description on hover.

A. Edit the dashboard: Click on the Edit icon to edit the dashboard. It directly navigates you to the QMetry Insight report from which the dashboard has been created.

B. Delete the dashboard

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

Share Dashboard through Embedded URL

The user who has created a dashboard can generate an embedded URL and share the link. This link will allow access to this dashboard without any authentication in View mode. Users with whom the dashboard is shared can view the dashboard with tags and applied filters on hover. This embedded link can be used to share the dashboard with other users or for integration with third-party integrations.

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

Generate Embedded URL:

1. Open the Edit Dashboard screen. The screen opens with three tabs on it: Users, Project/Role, and Embedded URL.

2. Open the Embedded URL tab.

3. Click Generate to generate the embedded URL.

The URL remains valid and active unless it is regenerated or deleted.

The embedded URL generates a dashboard as per the project access of the URL generator.

• Regenerate Embedded URL: If the user who has generated the Embedded URL wants to change the link, they can click on Refresh button to regenerate the link. This will make the older link disabled or invalid.

• Delete Embedded URL: If the purpose of the Embedded URL is over, then the user who has created the dashboard can delete the URL by clicking on the Delete icon.

• Copy Embedded URL: To copy the generated Embedded URL, click on the Copy icon.

The user with whom the embedded URL is shared can view the report.

Use Embedded URL in Confluence

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

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 the existing custom dashboard with all the gadgets added to it. The feature is useful when users want to reutilize the created dashboard with gadgets under it and add more details as per the new specifications. With the Clone Dashboard feature, users do not have to repeat the process of creating a new dashboard and searching and adding the same gadgets all over again. For example, users can create the same dashboard to be shared with Business leadership with different data points.

The dashboard is cloned with allocated rights. You can still modify the permission assigned to users/roles for the dashboard.

Permissions Required: Users with Report "Modify" rights for the project can create a clone of the dashboard.

Steps:

1. Click on QMetry Custom Dashboard on the navigation bar at the left. 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.

You can also access the Clone icon from the dashboard header after opening the individual dashboard.

The Clone Dashboard screen opens.

3. You can add/remove Users/Roles to whom you want to share the cloned dashboard.

4. Click on the Clone Dashboard button.

Rearrange and Resize Gadgets in Dashboard

• Rearrange Gadgets: Drag the gadget by holding the mouse key on the gadget header and drop it to your preferred place on the dashboard.

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

Remove a Gadget

You can remove a gadget from the dashboard. If the dashboard is shared with other users, then the removed gadget will also not be displayed in that shared dashboard.

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

Download Gadget

You can download a gadget with multiple options - if it is a graph, then you can download it in PNG, JPEG, SVG, PDF formats and if it contains tabular data, then you can export the data in XLS.

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

Filter Gadgets

The values/criteria provided during query execution will be saved and will be applied as default to the gadget added on the dashboard. If you change the filter and that dashboard is shared with other users then the filter will also change for that user.

1. To modify the default filter, click on the Filter  icon for the gadget.

2. Select/deselect filter values and click Apply.

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

The filters you applied on the gadgets can be view 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

The custom dashboard can be scheduled one-time/recurring as email notifications. To schedule outbound emails at a particular frequency, click on the Schedule button for the report that you want to share. The report details will be sent in PDF to recipients as per the defined schedule. 

The scheduler icon is provided on the Dashboard list screen with the individual dashboard and on the dashboard header when it is open. Clicking on this icon opens a screen with the two tabs:

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

• Schedule Dashboard: Template to schedule dashboard.

Scheduling Custom Dashboard

The report details will be sent in PDF to recipients as per the defined schedule. The email recipients could be outside the QMetry instance.

Open the Schedule Dashboard tab. It opens a template to fill in the details and schedule the emails to be sent as notifications along with the report in PDF.

Note: Only Graphical reports can be emailed using Schedule Report. For tabular reports, users have to export them individually in CSV and share them with the recipients.

Once you are done entering the details, 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

Once you schedule the dashboards they will be displayed on the Schedules tab. You can edit and delete the schedules by clicking on 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. 

Note:

• Only Graphical reports can be exported through the Export as PDF option. For tabular reports, users have to export them individually in CSV.

• All reports are exported in the UTC time zone.
  
  

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