Document toolboxDocument toolbox

Manage widgets

Understanding icons (top left)

Icon

Description

Icon

Description

 

 

 

 

 

 

Only with the required permission

This icon only appears if you have the Manage version of the Domain aggregation tasks permission.

The rocket icon appears on widgets with a source query that is not optimized, that is to say, an aggregation task has not been defined from the source query of the widget.

Clicking on the icon will open a helper with this information and the option to create one, where you need to introduce the settings. Visit Create a new aggregation task for more information.

15_Manage widgets.png

You can also create an aggregation task using the option in the ellipsis menu as explained in the table below or the option in the Network manager as explained in this article.

The aggregation task will be automatically used in the widgets that are fed with that query.

  • Even though your query is optimized with an aggregation task, you may still see the icon in your widgets. This happens when the date range set for the Activeboard is not within the aggregation task time range. For example, if your aggregation task start date is February 15, 2019 and you set your Activeboard time range to 01/01/2019 - 01/30/2019, your widgets will show the icon.

  • Note that the icon will never appear when you select a period of time of less than one hour for your Activeboard or widget, even though your widget query is not optimized.

In case of any problem, visit the support site for further information.

This icon indicates that the widget has a custom time range. Clicking the icon will open a helper with this information. To learn more about custom time ranges, go to Setting a time range in Activeboards.

When receiving real-time data, data retrieval will be a transparent process you barely notice. However, it might be slightly affected by a number of factors. When this happens, a spinner icon will appear to let you know the process is currently ongoing, together with a percentage to indicate the amount of data already retrieved.

This animation will also appear whenever you apply changes to your widgets, while they load the corresponding new data.

This icon appears when the widget query has been aborted. This occurs whenever the widget loading process is interrupted for whatever reason. Clicking the icon will open a helper with this information.

The most common reasons are user interactions such as changing the time range, data source, or visual settings while the widget is still loading but it might also appear as a result of an error.

If the loading animation appears next to it, it will most likely disappear right after but if it doesn’t, try using the refresh button at the top right of the widget (see header buttons section below).

Managing options (top right)

Header buttons

Button

Description

Button

Description

You can use this button to enable the real-time data retrieval. This will enable the custom time range for the widget and will change the aspect of the button. Visit this article to learn more about the implications of real-time data.

You can use this button to relaunch the widget’s query and restart the real-time feed, if enabled. Visit this article to know more about the implications of refreshing queries.

This button appears instead of the refresh button when the widget’s query is being loaded for whatever reason. You can use it to abort the query and interrupt data retrieval.

Click the ellipsis button and, depending on whether you have activated editing mode or not, you will see the options explained in the table below:

Ellipsis menu

Go to query

Viewing mode
Editing mode

Open a new browser tab to take you to the search window and show you the data table for the query that feeds the widget.

Create aggregation task

Viewing mode
Editing mode

Only with the required permission

This option is enabled only if you have the Manage version of the Domain aggregation tasks permission.

Open a window where you can introduce the settings for a new aggregation task. Visit Create a new aggregation task for more information about each setting as well as the process in general.

This option will be grayed-out if the widget does not need to be optimized, in other words, if the rocket icon does not appear.

Full view

Viewing mode
Editing mode

View the widget in full-screen mode.

View data source

Viewing mode
Editing mode

Access the widget data source to view it.

Edit data source

Viewing mode
Editing mode

Access the widget data source to change it. You need to click Save Changes to apply them (the saving button will be disabled if the syntax is not valid).

Properties

Viewing mode
Editing mode

Access the widget configuration options. You can also access these options by clicking the title bar. Visit widget types for the specific settings of each widget.

Copy

Viewing mode
Editing mode

Copy to clipboard the widget with the exact same settings (data source, custom date range, etc.) so you can paste it in an Activeboard. You will receive a notification after using this option to let you know it was successfully copied to clipboard.

To paste it, you just need to go to the Activeboard in question and use the Paste widget option from the Activeboard ellipsis menu. See this article for more information.

Clone

Viewing mode
Editing mode

Copy the widget in the Activeboard with the exact same settings (data source, custom date range, etc.) but with cloned automatically added to the name. Change the name in the properties of the widget.

Export to CSV

Viewing mode
Editing mode

Download a table with the widget's data in a CSV file.

Change widget type

Viewing mode
Editing mode

A list of widget types appears and you can easily change between widget types.

Alternatively, you can also drag the widget type from the widget gallery directly onto your widget in the Activeboard:

Delete

Viewing mode
Editing mode

Remove the widget from the Activeboard.

Connect a widget to an input

When you add inputs to your Activeboard, the widgets linked to them must reference the input name in their queries to work properly. Depending on the type of data, you need to add a different expression. Learn more here.

By default, widgets connected to an input don't show any data before you enter or select a specific value in the corresponding input. However, you can make them show data (either query data or a specific value) before using the input. This is made by adding a specific operator to the widget query. Learn more here