Widget Configurations

1 Widgets Section
- 1.1 Data Displayed
2 New Widget
- 2.1 Visualization
- 2.2 Actions
  - 2.2.1 Customizing Actions
- 2.3 Search
3 Deleting Widgets

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

KPI	Description	Data Type
Id	The widget id.	Numerical
Name	The name of the widget. Limited to 255 characters	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 hamburger Icon on each row allows users to Edit the widget, Delete the widget, or see a list of the dashboards in which the currently selected widget is being used.

New Widget

To create a new widget click New Widget. You are brought into the wizard, to the Report tab first.
Select a Report from the list. Click the X clear button to clear the search.

The report brings in the data needed for the widget.

A preview is shown below:

Important: Depending on the type of report selected for the widget, the columns and values displayed in the preview will change.

2b. If starting a dashboard from scratch and not creating a new widget, the user will get the Available Widgets lookup. This allows selecting the Widget that works for use. The Name and description display.

3. Next, click on the Widget tab. This window appears:

From this screen, users can switch between the Base Info, Visualization, Actions, and Search tabs.

Base Info

Users can input relevant information and adjust various settings.

Base Info	If the user is already on this tab, it will be highlighted (as in the screenshot above). If the user is in another tab (Visualization or Actions), select Base Info to change to the Base Info tab.
Visualization	Select to change to the Visualization Tab.
Actions	Select to change to the Actions Tab.
Search	Select to change to the Search Tab.
Icons	Click the lookup arrow to display a list of icons to add. Users can find additional icons after searching.
Widget Title	Users can title the widget according to its function.
Description	Users can write a more detailed description of what the widget does.
Hide Title	Select Yes to hide the widget’s title. Select No to show the widget’s title.
Hide Description	Select Yes to hide the widget’s description. Select No to show the widget’s description.
Allow Full Screen	Select Yes to allow the widget to show in full screen. Select No, to prevent the widget from displaying in full screen.

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

Multiple values for fields can be added to template text.

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 word Button.

The following screen shows:

Button type	Allows the user to select the type of button from Regular Hollow Primary Danger
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.

Multiple actions can be added to the same button. If multiple actions are added to the button, the button icon will become a dropdown so users can select from the various actions available.

Customizing Actions

Once an action has been added to a button, it is possible to customize what the action will be by selecting the desired Handler.

The following four types of action handlers can be selected:

Action	Functionality

Action	Functionality
Remote CheckIn	This API will remote check in a document.
Update Security	This API will update the security of the object.
Remove Object Security	This API will remove security of these selected objects.
Change Default Security	This API will change the default security of the selected objects.

Once a handler has been selected, it is now possible to adjust the Job Process Type:

Job Process Type	Functionality

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.

For each of the conditions, select whether the condition will be based upon a field matching another field, or a field matching a specific input.

Search

The Search tab allows users to set up and customize a search from the report selected for the widget.

The search bar can be freely enabled or disabled by selecting Yes or No. if Yes has been selected, users can customize the placeholder text of the search field, as well as specify the query fields for the search. Users can select as many query fields as needed, from the fields already present in the report used for the widget.

Deleting Widgets

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: