Document toolboxDocument toolbox

Manage and configure current Activeboard

What permissions do I need?

Apart from the Activeboards (manage) permission required to access the Activeboards area, manage Activeboards, and activate the editing mode, you also need to be granted manage access over specific Activeboards (refer to Share Activeboards for more information).

Having the User resources permissions will grant you full access to the Activeboards area and over all Activeboards in the domain.

Even if you have full access, you still need to activate the editing mode to enable the actions related to sharing and raw configuration (see the labels in the management section below for reference).

Managing your Activeboard

Once you open an Activeboard using the Activeboard manager, you can use its ellipsis menu at the top bar contain, which includes all the options needed to manage the currently open Activeboard. Assuming you have full access to the Activeboard in question, you can find these options:

10_Manage and configure current ActiveboardV2.png

Open in new tab

Viewing mode
Editing mode
View
Manage

Opens a new tab in the browser to show the content of the corresponding Activeboard.

Network manager

Viewing mode
Editing mode
View
Manage

Access a control panel to check the details of all the widgets in the current Activeboard. Each widget in the table includes the following information:

  • Widget - ID of the widget.

  • Status - The current connection status of the widget: 

    • idle - The server has not returned anything yet.

    • error - The query has returned an error. It is either invalid or the syntax contains errors (not having access to the table, fields not existing, incorrect operations...).

    • complete - The query has been completed and successfully returned events to display in the widget.

    • loading: - The widget is receiving data.

    • aborted: - The query has been aborted either on the server or client-side.

  • Query events - The total number of events in the query.

  • Shown events - The number of events shown in the widget with the applied settings.

  • Duration - The time taken to download and process all events in the specified query until the moment they start being represented on the chart.

  • Query - The query that feeds the widget.

  • From and To - The time range specified either for the Activeboard or specifically for the widget (custom date range).

  • Actions - Icons that inform you about further actions you can perform:

    • Query information: click on the info icon to see the details of the widget query.

    • Optimize query (only with the Manage version of the Domain aggregation tasks permission): the rocket icon informs you about the query not being optimized with an aggregation task. Click the icon and select Create aggregation task to do so. To know more about the settings you need to introduce or the process in general click here.

Set as default

Viewing mode
Editing mode
View
Manage

Set the Activeboard as the default one to be shown when accessing the Activeboards area. When no Activeboard is selected as the default, no Activeboard is open upon access, and a message will be displayed prompting you to select one.

35_Manage and filter Activeboards.png

Manage user tags

Viewing mode
Editing mode
View
Manage

Opens a window to create and assign tags. You can perform the following actions:

  • Create a tag: write the desired tag name inside the field, select the Create row that appears below, and click Apply. The tag will be created and assigned to this Activeboard, and will be available to apply to other Activeboards.

  • Assign a tag: click inside the field, select one from the dropdown, and click Apply.

  • Remove a tag: applied tags appear inside the field. Click the cross icon next to them and click Apply. The tag will be removed from that Activeboard. Additionally, it will be deleted in case it was assigned only to that Activeboard.

Applied tags can be seen by expanding the Activeboard info and used to filter Activeboards, as explained in the sections above.

Existing tags

Take into account that the existing tags will remain as an option to select in the dropdown as long as they are applied to at least one Activeboard; if they are removed from that Activeboard you will have to create them again.

User-dependent

Be aware that tags are user-dependent, this means that only you will be able to see and use the ones you create and therefore you cannot see or use the ones created by others.

 

Data loading

Viewing mode
Editing mode
View
Manage

You can select the data fetching method for your Activeboard. This affects all widgets in the Activeboard unless a different option is chosen in their individual settings, which will take priority.

 

Lazy (default)

PERFORMANCE: BALANCED This option strikes a balance between performance and data availability, as it ensures that resources are utilized in a timely manner without manual interaction.

When this option is enabled, widgets will retrieve data only when they enter the screen after scrolling. This means that widgets will not be loaded unless they are within the visible part of the landing screen or enter the screen after scrolling.

On demand

PERFORMANCE: OPTIMAL This option optimizes performance, as it ensures that resources are utilized exactly where and when you need them.

When this option is enabled, widgets will retrieve data only when manually prompted. This means that the widgets are empty after accessing the Activeboard and display a message explaining why, along with a button to manually fetch data.

Widgets will remain unaffected by the Active refresh and will work fine when scheduling Activeboard reports. However, there are implications when exporting the Activeboard to PDF.

When there are widgets configured to load data on demand, the button at the top right will be enabled. This button forces all of them to retrieve data.

Eager

PERFORMANCE: potentially reduced This option might affect performance considerably, as it needs to allocate as many resources as needed to retrieve data instantly.

When this option is enabled, widgets will retrieve data as soon as the Activeboard is accessed.

 

Export to PDF

Viewing mode
Editing mode
View
Manage

You can export the current Activeboard in PDF. The file downloads automatically and contains an easy-to-read snapshot of all the inputs and widgets that make up your Activeboard, showing the data and values on screen at that time.

When a widget or input has the "Load on demand" setting enabled and the data has not been fetched, you will receive a warning. Proceeding will result in the widget appearing empty in the PDF.

This option is always available, whether you activated the Editing mode or not.

Add scheduled report

Viewing mode
Editing mode
View
Manage

You can periodically export the current Activeboard as a PDF and send it to someone automatically (visit Schedule reports for more info).

Permission required

This option is not available if you don’t have the Activeboard report scheduler (Manage) permission.

 

Make Activeboard visible

Viewing mode
Editing mode
View
Manage

This option is the prerequisite for the Share with roles option, which makes and Activeboard ready to share (visit Share Activeboards for more info).

Share with roles

Viewing mode
Editing mode
View
Manage

Select the roles you want to share the Activeboard with (visit Share Activeboards for more info).

 

Edit details

Viewing mode
Editing mode
View
Manage

Edit the Activeboard's name and description.

Edit raw configuration

Viewing mode
Editing mode
View
Manage

Access the current Activeboard JSON in order to edit or share it.
When editing the JSON raw configuration, mistakes will be highlighted, with a message describing the error. Click Save raw configuration to apply any modifications.
You can export the JSON raw configuration using CTRL + e on your keyboard.

Paste widget

Viewing mode
Editing mode
View
Manage

Paste the widget/input copied to clipboard in an Activeboard. To copy one, use the option in the ellipsis menu of the widget/input in question (learn more in Manage widgets and Manage inputs).

You will receive a notification after using this option to let you know it was successfully pasted on your Activeboard.

 

Clone

Viewing mode
Editing mode
View
Manage

Make a copy of the Activeboard.

Delete

Viewing mode
Editing mode
View
Manage

Delete the Activeboard.

Configuring your Activeboard