Create Widget
You can create custom widgets using CQL queries to visually represent information using different chart types based on specific parameters. You can also customize your widget by selecting attributes for the chart, modifying axis labels, and grouping data based on specific parameters. You can add these widgets to your custom dashboards.
Before you Start
Ensure you have the Create/Update permissions for Dashboards.
Steps
To create a widget, follow these steps:
Go to Menu > Dashboards.
Select an existing custom dashboard, and click More > Edit. You can also create a new custom dashboard and add a widget. To know more on how to create a custom dashboard, see Create Custom Dashboard.
Hover over Add Row and select the number of columns to add.
In the Information Widget Section, click + in an empty information widget.
Click Create New Widget and enter the following details:
Note
The following steps are applicable in Respond v3.4.3 onwards.
In the text box, enter a title for the widget.
In Widget Data, select a module. Enter a CQL query to create widget data and then click Enter or click the Search icon.
Select a chart type to visualize the data. The following chart types are available for widgets:
Column
Bar
Line
Area
Table
Bubble
Heatmap
Pie
Donut
Numeric
Note
By default, the Column chart is selected.
You can view data based on the selected chart type. The preview will display data from the last 30 days.
Note
When you add a widget to a dashboard, it displays data based on the date range you have selected for the dashboard.
In charts, you can plot attributes, customize the labels, group the data, and more.
In Plot Data, you can plot the following data:
Y-axis (Vertical): Select a field to plot on the y-axis to visualize the value you want to analyze. For example, Incident.
X-axis (Horizontal): Select a field to plot on the x-axis to group the information. For example, Assigned User.
Note
In the Bar chart, the X-axis is an integer field, and you can select a parameter to plot on the Y-axis.
Count: Select an aggregation method for the data such as Count, Minimum, Maximum, Average, or Sum to analyze the information. For example, you can view the average number of users impacted by incidents.
Stack by: Stack data by selecting a parameter, this allows you to group and compare different categories within the chart. For example, stack incidents by their severity level.
Group by: Select a parameter to organize and group the data for analysis. For example, Assigned Group.
In Customize, you can modify the following:
Y-axis (Vertical): Enter a label for the y-axis in the graph to indicate what the vertical axis represents on the chart. For example, Incident Count.
X-axis (Horizontal): Enter a label for the x-axis in the graph to indicate what the horizontal axis represents on the chart. For example, User names.
Show Legends: Select Show Legends to view legends. This displays the colors and labels used to distinguish the information in the graph.
Reference Lines: Select Reference Line to add reference lines showing minimum, average, and maximum values of the information for the selected parameters.
Note
The option to select a reference line is only available when no field is selected in Stack by or Group by based on the selected chart.
For chart types such as Column, Bar, Line, and Area, you can plot data on both the X-axis and Y-axis, and select options for Count and Stack by. Additionally, you can customize the X-axis and Y-axis labels, and choose to view reference lines or legends.
In the Table chart type, you can view the results of the CQL query entered in tabular format. You can view the columns based on the selected module and the CQL query.
For chart types such as Bubble, Pie, Donut, and Numeric, you can select the options for Value, Count, and Group by. Additionally, you can choose to view legends.
Click Create.
You can view the created widget in the widget library, and you can add the widget to other dashboards as needed.
Custom Widget Examples
Some of the example for custom widgets are:
View the Number of Open Incidents per User, Stacked by Severity Level
To track the number of open incidents assigned to each user, stacked by severity level, you can follow these steps:
Select a chart type such as Column, Bar, Line, or Area.
In the Widget Data section, select the Incident module and enter the CQL query "Status" = "Open" AND "Assigned Group" = "Soc Analyst" AND "Resolution SLA Breach" = "Yes".
For the Y-axis, select Incidents, and for the X-axis, select Assigned User. Use the Stack by option to group incidents by Severity, which creates a visual distinction between incident severities across users.
Evaluate Average Time Taken to Detect Incidents
To evaluate the average time taken to detect incidents, follow these steps:
Select the Numeric chart type.
In the Widget Data section, select the Incident module and enter the CQL query "Status" = "Open" AND "Assigned Group" = "Soc Manager".
In the Value field, select Time to Detection to view the detection time data. In the Count field, select Avg.
Configure Default Legends for Custom Widgets
After you create a custom widget, you can configure default legends for a chart. This ensures that when you share a dashboard with others, the predefined legends will automatically appear on the chart.
Note
You can update or delete the widget only if you are the creator.
To configure default legends for custom widgets, follow these steps:
Note
This feature is available in Respond v3.4.3 onwards.
Go to Menu > Dashboards.
Select a custom dashboard and go to the custom widget to configure default settings.
Click More and select Set Default.
Configure Legends for the X-axis, Y-axis, and Stack by as required.
Using the Order by dropdown, select an option such as Alphabetical or Count to arrange the legends in the chart.
Click Save. In the confirmation pop-up, click Save.
When you open a custom dashboard, you can view the configured default legends for the custom widget.