QMetry Custom Gadgets
Permissions: QMetry Custom Gadget module will only be visible if the user has the View rights for QMetry Insight. Similarly, users can make any changes within the module only if they have the Modify rights for QMetry Insight.
Introduction
The gadgets created using QMetry Insights will be displayed under QMetry Custom Gadgets. Users can view their owned/shared custom gadgets in QMetry Custom Gadgets.
QMetry Custom gadgets list the following custom reports:
Type of Gadgets | Tab | Owner | Gadget operation(s) | Dashboard operation(s) |
|---|---|---|---|---|
Gadgets created using Visual Reports (drag & drop) | My Gadget | Logged-in user |
|
|
Gadgets created using Advance Query Reports (by writing SQL queries) | My Gadget | Logged-in user |
|
|
Gadgets that are created by other users and shared with the logged-in user. | Shared Gadget | Other users |
|
|
The following operations can be performed on QMetry Custom Gadgets screen:
View Gadget
QMetry Custom Gadget > My Gadget
It lists the gadgets created by a logged-in user; irrespective of the gadget is created using Visual Reports / Advance Query Reports.
The options given below are provided to you on the My Gadget screen.
# | It shows the serial number of the gadget you have saved. |
Gadget Name | It shows the name of the gadget that you have saved. QMetry Custom Gadget can not be created with a duplicate name. Users can still access the shared Gadget which may hold the same name as users' own Gadget. |
Private | This column basically has 2 values; "Yes" and "No".
|
| You can edit the gadget by clicking on this icon. This option launches the gadget either in the drag and drop or Advanced SQL mode (whichever option was used to create a gadget) so that you can easily edit the report and save its changes again. |
| You can remove the gadget clicking on this icon; be aware that the gadgets removed, cannot be recovered back and if the gadget is shared with a user or group of the users (i.e. Project/Role), then it can also get disappear from their dashboards/list. |
| You can share the gadget with any user or user group (i.e. combination of Project/Role) using this option, Shared gadgets are available to users in the "QMetry Custom Gadget ⟶ Shared Gadget" section; Click here to get more information about this option. |
QMetry Custom Gadget > Shared Gadget
It lists gadgets that are shared by other users with the logged-in user.
Edit Gadget
This option allows users to edit the gadgets that are created under the Visual Reports / Advance Query Reports.
1. Open the My Gadget tab.
2. Click on the Edit icon for the gadget that you want to edit. It navigates you to the Visual Reports (drag & drop view) / Advance Query Reports (SQL query builder view) of the QMetry Insight module.
3. Edit the report query in the Visual Reports/Advance Query Reports view.
4. Make the required changes and click on the Update Gadget button to save the changes. The changes will get reflected to all the dashboards where the gadget is shared.
Edit gadget in Visual Reports
Edit gadget in Advance Query Reports
Share a Gadget
A shared gadget allows users to add the gadget to their own dashboards and set the filters as per their needs. Shared Gadget does not allow to change underlined query of that gadget. Only the creator of the gadget can share and change the query of the gadget. Users with whom the gadget is shared can only select the filter values after adding the gadget to their own dashboards.
Users can share gadgets with other users. A gadget can be shared to -
Users
A particular Project
A particular Role in a Project
Steps
1. Click on the share icon for the gadget that you want to share.
The next screen opens with two tabs on it : Users and Project/Role.
Users: To share the gadget to individual users, open the Users tab.
Project/Role: To share the gadget to a particular role/project, open the Project/Role tab.
Sharing gadget with individual Users:
Sharing gadget with Project/Role:
Sharing gadget with Project/Role:
Is Project selected? | Is Role selected? | Gadget 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 |
Once a gadget is shared, the user, with whom it has been shared, will be able to see that gadget under the Shared Gadget tab.
A shared gadget will be read-only for the users with whom it has been shared. Users can view the filters applied to the report query and export the filters as well.
Sharing Gadget with Co-owner Rights
Existing dashboards/gadgets of a user, who is being deactivated, can be assigned to other users as co-owners while deactivating the user. Also, the Super Admin of the QTM instance can access all the gadgets created by users and share QMetry gadgets with other users and make them co-owners of the gadget.
Having co-owners of gadgets give the flexibility to manage the gadgets which were created by the user who is being deactivated from the instance. It saves the time and effort required in creating a new QMetry gadget every time.
→ Required Permissions:
Users with whom the gadget is being shared or who are being assigned as co-owner should have the Report and QMetry Insight rights to access the gadget and gadget data.
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.
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 gadgets/dashboards.
All the private and public dashboards/gadgets of the user that is being deleted will be shared with the user as a co-owner of those dashboards/gadgets.
Super Admin Assigning Co-owner
The Super Admin of the QTM instance can access all the gadgets created by users and share QMetry gadgets with other users and make them co-owners of the gadget who can also edit the shared gadgets. The Super Admin can share the gadget with users or project-roles as viewers or as co-editors of the gadget.
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 gadgets and share them with other users.
Steps:
Open the QMetry Custom Gadget section and go to the All Gadgets tab.
→ Filter: You can search the required Gadget Name and also apply filters on the type of sharing i.e. Private/Public, Created By, and Updated By.
Share a Single Gadget
1. Click on the Share Gadget icon for the gadget you want to share.
2. On the Users tab, click Add Users.
3. Select users on the drop-down list with whom the gadget 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 gadget being shared.
Share Multiple gadgets
Steps:
1. To share multiple gadgets, select the gadgets 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 gadget 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 gadgets.
Share Gadget by Project/Role
Share a Single Gadget
The user who has created the gadget can share it with other users by specifying either Project, Role or the combination of Project & Role in QMetry.
Open the Project/Role tab.
Click on the Add Project(s)/Roles(s) button.
Select Project from the drop-down. The Roles will populate for the selected project(s). Select Role(s) from the drop-down.
Co-owner: Select the checkbox to assign all the users holding the selected Role as co-owners of the gadget.
Share Multiple Gadgets
Select the gadgets that you want to share and click on the Bulk Access button.
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 gadgets.
Co-owner View
If you have been assigned as a co-owner of a gadget, you can view the Co-owner icon before the Gadget Name under the Shared Gadget. The info icon displays the Gadget Description on hover.
A. Edit the Gadget: Click on the Edit icon to edit the gadget. It directly navigates you to the QMetry Insight report from which the gadget has been created.
B. Delete the Gadget
C. Share the Gadget: Click on the Share Gadget icon to share the gadget further with other users with “View” rights or as co-owners.
Unshare a Gadget
The gadgets can be unshared for any user or group of the users by clicking the remove button from "Users" and "Project / Role" tab.
Export Gadget
You can Export System Gadgets and Custom Gadgets.
Note : All gadgets are exported in the UTC time zone.
Go to the Dashboard.
Click on the cog icon for individual gadgets. You can find the different Export option(s) to export the gadget. The Export job is scheduled.
Go to the Scheduled Task section and download the report.
The export options for gadgets saved as Pie chart, Bar chart, Column chart, Line chart, etc are different compare to the gadgets saved in the tabular/cross table; which are indicated in the below screenshots. The gadget details are exported in the CSV file when the option "Export Raw Data" is used whereas the other options will download the chart in its respective image format.
Export options available in the Chart(s)
Export options available in the Cross Table reports
Export option(s) available in the Table reports