| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A widget is an extension to the main dashboard user interface, where data and content can be added inside of it for a specific purpose. For example, a bar chart to show the most accessed security audits per user would be a widget example.
Use the table of contents on top to navigate this section.
Widgets Section
From the navigation, click Widgets. A page like this displays:
...
Data Displayed
KPI | Description | Data Type | ||
|---|---|---|---|---|
Id | The widget id. | Numerical | ||
Name | The name of the widget.
| Text | ||
Type | The type of widget. Please see the following table below. | Text | ||
Created By | The person who created the widget. Their display name and email are shown. | Text | ||
Created Date | The date created. | Date | ||
Modified By | The person who made the last modification. Display name and email displays here. | Text | ||
Last Modified Date | The date last modified. | Date |
...
The report brings in the data needed for the widget.
A preview shows is shown below:
...
| Info |
|---|
Important: Depending on the type of report selected for the widget, the columns and values displayed in the preview will change. |
| Tip |
|---|
Tip: When selecting a report that includes JSON values, the preview will allow users to select JSON or JSON_ARRAY in their respective columns to expand the information. See the images below. |
...
| Note |
|---|
Warning: All newly created Dashboards, Widgets, and Filters must have unique names/titles. In case the user tries to save a widget with a name/title that has already been used, a message will show on screen. At this point, select a different title for the widget. |
...
Visualization
...
In the Visualization tab, users can select the type of widget from one of the four categories:
Collections
Table
Tree
List
Charts
Column Chart
Line/Area
Bar Chart
Pie
Combined Chart
General
KPI
Progress Bar
Text
Notices
Alerts
Badges
Circle
...
Changing the type of widget will now save the configurations made to columns etc and bring them to the new widget visualization.
Actions
The Actions tab allows users to add action buttons to widgets. These buttons allow the users to assign different actions. When switching to the Actions tab, Select the Add Action Button to add a first action button.
...
From here, users can either adjust the settings for the button, delete that button, or add additional buttons to the widget.
To adjust the settings of the action button, click on the wordButton.
...
The following screen shows:
...
Button type | Allows the user to select the type of button from
 |
Icon | Allows the user to select from various icons for the button. |
Text | Allows the user to customize the text of the button and rename it. For example, instead of the button displaying the word Button, it could show the word Metrics. |
Actions | Allows the user to add an Action to the Button. |
To add an action to a button, click on + Add action.
...
From here, users can click on Action to customize what action the button will perform.
...
Job Process Type | Functionality |
|---|---|
Asynchronous | The job will execute eventually after picking from the queue. |
Synchronous | The job will execute at the same time. |
Once the Job Process Type has been selected, the Required Parameters for the selected handler should be configured:
Edit the various labels to be used in the User Submit Form.
Configure the Widget Parameters. The available fields will vary depending on the columns of the chosen report.
It is also possible to adjust the Availability of the action button by adding a condition or a condition group, depending on the user’s needs.
...
To delete a widget, from the main widgets page, click on the hamburger icon of the widget you wish to delete.
...
If the widget is not currently being used in any Dashboard, the following prompt will show:
...
Select Delete to confirm the widget deletion. Alternatively, select Cancel to abort the deletion process and go back to the main Widget page.
If the widget is currently being used in one or more Dashboards, the following prompt will show:
...
| Tip |
|---|
TIP: To find out where the widget is currently being used, click on the hamburger icon and select Where Used. |