Control Export Options
FAQs
Is it possible to restrict viewers from exporting in specific formats for certain widgets within a dashboard?
Yes, it is possible to customize export options for individual widgets. In the widget menu for each widget, you'll find an option named 'Allowed Exports.' Within this menu, there is a submenu listing all supported export formats for that widget, such as CSV, Excel, PDF, etc. Designers can selectively choose the desired format(s) from this list, limiting viewers to exporting the widget only in the selected format(s).
How can I restrict viewers from exporting all the widgets in CSV format within a dashboard?
In the dashboard menu, there is a menu item named 'Allowed Exports.' Within this menu, you will find a list of all supported export formats for widgets, including CSV. To restrict viewers from exporting any widget in the dashboard in CSV format, simply deselect the CSV option in the 'Allowed Exports' menu. It's important to note that if you have manually overridden the selection for CSV at the widget level, that specific widget will retain its manual selection. To ensure consistent restrictions, manually deselect CSV for each widget where necessary.
I have restricted viewers from exporting in certain formats, but they can still see all the formats. Can I hide the restricted formats from users?
Yes, it is possible to show only the allowed formats to viewers. To achieve this, you need to update the 'showRestrictedOptions' parameter in the configuration file and set it to false. When this option is set to true, viewers will be able to see all available formats supported by a widget. However, if a viewer lacks permission for a specific format, a popup will display upon selection. Setting 'showRestrictedOptions' to false ensures that only the allowed formats will be visible to viewers for each widget.
About the Plugin
The Control Export Options plugin for Sisense is a powerful tool designed to provide granular control over the export capabilities of widgets within a dashboard. With this plugin, dashboard designers can tailor the export options for each widget by specifying the supported formats, such as CSV, Image, PDF, and Excel. This level of customization ensures that sensitive or proprietary information within certain widgets can be protected by restricting viewers from downloading them in specific formats. Additionally, the plugin offers the flexibility to configure export options at the dashboard level, allowing designers to enforce a standardized export policy across all widgets within a given dashboard.
Usage Instructions
To utilize the Control Export Options plugin in Sisense, designers can access the functionality through the dashboard and widget menus.
Dashboard Menu Option
In the dashboard menu, an option labeled 'Allow Exports' is available, featuring a submenu listing all supported export file formats, such as CSV, Excel, PDF, PNG, and Pulse. Designers can selectively enable or disable support for these formats across all widgets in the dashboard by choosing from the list. Furthermore, designers can establish default selections for export formats at the dashboard level through a configuration file, ensuring consistent export settings across all dashboards.
Widget Menu Option
At the widget level, the same 'Allowed Exports' menu is present in the widget menu. This menu provides designers with the flexibility to configure export options specific to each widget, allowing them to override the dashboard-level selections. The available file formats in the 'Allowed Exports' menu for widgets may vary based on the type of widget, as not all widgets support the same set of formats. This detailed level of configuration empowers designers to fine-tune export permissions, tailoring them to the specific needs and capabilities of individual widgets within the dashboard.
In scenarios where a viewer attempts to export a widget in a format for which they have no permission, a popup window will promptly appear, delivering a customizable message configured in the plugin's associated configuration file. This message, often set to 'Not Allowed,' serves as a clear indication to the viewer that export privileges for the chosen format are restricted.
Plugin Global Configurations
Options: This section allows administrators to define default settings for each export format, specifying whether it should be enabled or disabled by default across all dashboards.
showRestrictedOptions: This option provides flexibility in determining the visibility of export formats for viewers. When set to true, viewers will be able to see all available formats supported by a widget. However, if a viewer lacks permission for a specific format, a popup will display upon selection. When set to false, only the allowed formats will be visible to viewers for each widget.
notAllowedTitle: This parameter allows administrators to define the text that will be displayed as the title of the popup window. This title appears when a viewer attempts to export in a format that is not allowed.
notAllowedText: This parameter enables administrators to set the text that will be displayed in the body of the popup window. The content of this window is shown when a viewer attempts to export a widget in a format for which they do not have permission.
dashboardHeaderText: This setting allows you to define the text that will be displayed to viewers in the dashboard header when specific limitations are enforced on the dashboard. If left empty, nothing will be shown in the header.
Last updated
