Accordion

Accordion is a Sisense certified add-on. This means that it comes installed together with Sisense and you do not need to perform any separate download or installation. However, it is disabled by default, and you must enable it (instructions are below) in order to use it.

Overview

Accordion enables you to toggle between different sub-dashboards on demand by clicking an Indicator widget.
This is useful for providing large amounts of information within a limited space.


Enabling Accordion

Only administrators can enable Accordion. To enable Accordion:

  1. Select the Admin tab.

  2. Select Server & Hardware > Add-ons.

  3. In the accordionPlugin row, toggle the switch on.

Creating Accordions (Sub-dashboards)

  1. On an Indicator widget, click to enter Edit mode.

  2. Select > Accordion settings.

    The Accordion Settings window opens.

  3. Set the Enable Accordion toggle to determine whether or not this Accordion can be displayed. It is enabled by default, but it only takes effect if the dashboard was defined. If not, it does not have any effect. It is possible to disable it and save the settings for when you may want to enable it later.

  4. Select the Target Dashboard. This is the sub-dashboard that will open as an Accordion. You can select it by Name or by URL:

    • Name - When selecting a target dashboard by Name, only dashboards with the accordion prefix ("_accrd_") are displayed. This prefix is a global setting and can be changed by an administrator in the Accordion global configuration file.

    • Dashboards with this prefix are not displayed to end users from the dashboard panel. They cannot be accessed separately, and will only be visible as sub-dashboards of Indicators when Accordions are set up.

      To customize the prefix:

      1. Open Admin > App Configuration > File Management.

      2. In the Plugins>accordionPlugin folder, open the config.6.js file and modify the "targetDashboardsPrefix" parameter value.

    • URL - If a dashboard was already selected by name, its URL is automatically displayed. If not, any URL leading to a dashboard can be used, and does not necessarily have to be a dashboard whose name begins with the accordion prefix.

  5. If you want the Accordion to be automatically displayed when the page is loaded, select the Open Accordion on page load checkbox. When you set this option for multiple Indicator widgets, the sub-dashboard is opened automatically for the last (lowest and right-most) widget in the dashboard.

  6. You can customize the color of the Accordion frame by selecting the desired color in the Accordion Frame field. By default it is set to the main color from the applied system theme. For preexisting Accordions whose frames were colored green, the green color is kept. However, they can be changed if desired; alternatively, new Accordions can also be made green to maintain consistency.

  7. Select which filters to apply to the target dashboard in the "Apply filters to target dashboard" section. All current dashboard filters are listed, and all filters are selected by default. If you do not change anything, all filters from the current dashboard and from the current indicator widget will be passed to the target dashboard whenever it is opened. Clear the checkboxes for any filters that you do not want to be passed to the target dashboard.
    Select the All dashboard filters checkbox to select all filters, or clear the checkbox to deselect all.
    If this checkbox is selected, whenever a new filter is added to the dashboard, even after the settings have been saved, it will be also passed to the Accordion dashboard. If this checkbox is not selected and only some of the filters are defined to be passed, then, if new filters are added, they will not be passed unless you specifically select them in your Accordion settings. And the same goes for widget filters. If there are no filters when creating or updating an Accordion, the respective filter list will be empty but you still can select or clear this checkbox. Specifically, if you want any future filters to be passed, keep it selected.

  8. Selecting or clearing the All widget filters checkbox has the same functionality as the "All dashboard filters" checkbox described above, but on the widget level instead of the dashboard level.

  9. Click Save. The "Accordion updated" message is displayed.

  10. Exit the widget Edit mode (the Accordion settings are already saved, so it does not matter whether you click Apply or Cancel).

  11. Refresh the dashboard.

  12. You can now see the icon indicating that an Accordion exists, and you can display more data in the sub-dashboard by clicking the widget.

In the image above, you can see the Accordion in action, including how it displays the data with the applied filters.

Deprecation of Editing Accordion via Script

In previous versions, Accordions were configured via a widget script. That functionality has been deprecated, and the configuration is now done via the UI, as described above. Accordion configuration parameters in the script will now be ignored and not executed.

For existing Accordions, their settings are automatically converted to the relevant UI settings upon upgrading to Sisense version L2024.2 Service Upgrade 2 or newer:

Script Parameter

UI Setting

Description

default

Open Accordion on page load (checkbox)

Open Accordion automatically on dashboard load

dashboardURL

Target Dashboard:

  • URL

URL of the Accordion sub-dashboard

dashboardFiltersSelection

Apply filters to target dashboard – individual filter checkboxes (below ‘All dashboard filters’)

Dashboard filters which should be passed to the target dashboard

dashboardFiltersInheritance

All dashboard filters (checkbox)

Apply all of the filters from the parent dashboard to the target dashboard

widgetFiltersInheritance

All widget filters (checkbox)

Apply all of the widget filters from the Indicator widget to the target dashboard

If you now try to edit the widget script that defines an Accordion by clicking > Edit Script, the script opens, and displays a warning message that this functionality has been deprecated.

However, you can still use the script to configure changes to the Indicator widget itself.