How to use widgets

Widgets are out-of-the-box components that are used to create dashboards, and they can be configured to query your data, interact with one another, or help organize the way information is presented in dashboards. They include data visualizations, buttons, lists, and more.


Configuring charts

Charts help you visualize your data in various formats. Types of charts include:

  • Single number

  • Donut

  • Bar

  • Stacked bar

  • Grouped bar

  • Horizontal bar

  • Horizontal stacked bar

  • Horizontal grouped bar

  • Scatter plot

Below is a list of configuration settings and their definitions for charts (not all apply to each chart type).

  • Title: The title is displayed above the widget contents.

  • Query: selecting a query identifies the dataset you wish to use.

  • Filter by attributes: a set of conditions to determine what items to plot.

  • Attribute to group by: compare bars in your chart by this attribute.

  • Attribute to color by: for stacked and grouped bar charts you can choose an attribute to color by, meaning you can compare within each bar by the selected attribute. For example, you may have a stacked bar chart for all your assets where each bar represents the number of assets in a building and within each bar you can see a breakdown of the number of assets by production line.

  • Customize: there are many customization or styling options including color scale, sorting order, min and max values, and more.


Configuring displays

Displays are a type of widget that show attribute information based on a user’s engagement with a data interactions widget (with the exception of a rich text widget). These two types of widgets are connected in their configuration. Types of displays include:

  • Attribute history

  • Attribute list

  • Item history

  • Rich text

Below is a list of configuration settings and their definitions for displays (not all apply to each display type).

  • Title: The title is displayed above the widget contents.

  • Selected item to show attributes: tells the widget what data to retrieve. For example, if you select an asset from a data interactions widget then the selected asset’s data will be shown in the display widget e.g. to show where the asset is located or if it has any vulnerabilities.

  • Start and end time: for certain display widgets such as “Attribute history” you can define the time period using start and end datetime.

  • Query: selecting a query filters the available attributes from which you can choose to display. In the prior example, if you were interested in vulnerabilities for a given asset you could choose “Vulnerabilities” as your query which would then give you a list of related attributes that you can display.

  • Attributes to display: a list of available attributes you can display in the widget based on the query you’ve selected.

  • Customize: you can edit the number of columns you wish to display.


Configuring data interactions

Data interactions are a type of widget that, as the name suggestions, enable customers to interact with the data. For example, you can select an item from a list to get more information, edit attribute values based on a customer’s inputs, and more. Types of data interactions include:

  • Item list

  • Item editor

  • Item data grid

  • Link editor

Below is a list of configuration settings and their definitions for data interactions (not all apply to each data interaction type).

  • Title: The title is displayed above the widget contents.

  • Query: selecting a query identifies the dataset you wish to use.

  • Output ID: a unique name that can be used to reference the selected item from another widget.

  • Filter by attributes: a set of conditions to determine what items to show.

  • Attributes to edit: this only applies to the item editor widget. You can choose which attributes you want to edit based on a customer’s input.

  • Attributes to display: a list of available attributes you can display in the widget based on the query you’ve selected. This only applies to the item data grid widget.


Configuring page controls

Page controls are a set of widgets that enable different actions on the page from triggering an automation to defining the time period for all widgets. Types of page control widgets include:

  • Date range picker

  • Tabs

  • Buttons

Below is a list of configuration settings and their definitions for page controls (not all apply to each page control type).

  • Title: The title is displayed above the widget contents.

  • Output ID: a unique name that can be used to reference the selected item from another widget.

  • Pages: the tab widget allows you to select the pages you want to feature in a navigation bar. This enables you to easily move between dashboards.

  • On click event: the action to trigger based on a button click.

  • Confirmation message: text to show for confirmation of a successful action.

  • Customize: you can edit button text and color.


Configuring network analysis

Network analysis is a type of widget that allows you to understand the activity happening on your network. Note that this information is only available to those customers who have a Perygee Hub [insert link to Hub article] installed on their network. Types of network analysis widgets include:

  • Packet timeline

Below is a list of configuration settings and their definitions for network analysis.

  • Title: The title is displayed above the widget contents.

  • Start and end date variables: define the time period using start and end date outputs that are updated using a date picker widget.

  • Item ID for which traffic data will be shown: variable that is used to identify the item for which traffic data will be shown.

  • The attribute corresponding to the MAC address: this is likely an attribute with the name “MAC” or “MAC Address.”

  • The attribute corresponding to the IP address: this is likely an attribute with the name “IP” or “IP Address.”

  • If provided, will limit the packet reports to only those created by the provided hub: if you have multiple hubs installed, you can indicate which one you wish to isolate for the packet timeline.