Share Dashboard View

FAQs

About the Plugin

Usage Instruction

Plugin Global Configurations

FAQs

1. How can I customize the appearance of the 'Share View' button?

   You can easily customize the style of the 'Share View' button by adjusting the parameters in the plugin's global configuration. Simply modify settings such as color, colorHover (for hover effects), and text to match your desired look and feel.

2. Can I share the dashboard view with specific filters applied?

   Yes, absolutely! The 'Share Dashboard View' plugin preserves all filters applied to the dashboard at the moment of sharing. When recipients access the shared URL, they will see the dashboard with the same filters applied, ensuring precise communication of insights.

3. Is there a way to programmatically obtain the dashboard view URL for embedding purposes?

   Yes, developers can leverage the exposed function 'psGetDashboardViewUrl' to obtain the dashboard view URL programmatically. By calling 'prism.psGetDashboardViewUrl()', developers can retrieve the URL of the currently opened dashboard or pass a dashboard object as an argument to generate the URL for a specific dashboard.

About the Plugin

Introducing the "Share Dashboard View" plugin for Sisense, a game-changer in dashboard sharing. This plugin simplifies collaboration by allowing users to instantly generate URLs that capture the current dashboard view, including applied filters, with just a click of a button. Utilizing URI-encoding for compatibility, these URLs can be effortlessly shared with colleagues, stakeholders, or partners, ensuring everyone sees the dashboard exactly as intended. Whether it's internal teams seeking alignment, external partners requiring insights, or stakeholders needing updates, this plugin streamlines communication, fosters collaboration, and accelerates decision-making processes with unparalleled ease and precision.

Usage Instruction

No widgets or additional interfaces are required to utilize the "Share Dashboard View" plugin. Simply install the plugin, and if desired, update the config file to customize the style of the button. Once installed, the "Share View" button will be readily available on all dashboards, seamlessly integrated into the dashboard header.

Leveraging Advanced Functionality

Developers can leverage the exposed function 'psGetDashboardViewUrl' to programmatically obtain the dashboard view URL, including URI-encoded filters. This function, accessible as 'prism.psGetDashboardViewUrl()', returns the URL of the currently opened dashboard. Developers can also pass a dashboard object as an argument to the function to generate the URL for a specific dashboard:

prism.psGetDashboardViewUrl(<dashboard object>);

This functionality is particularly useful when embedding dashboards using iFrames without displaying the header. In such cases, developers can utilize Blox buttons to replicate the functionality of the 'Share View' button.

Blox Button Integration Example

1. Blox Widget Setup:

Create a blox widget and insert the following script:

{
    "style": "",
    "script": "",
    "title": "",
    "showCarousel": true,
    "body": [
        {
            "type": "ActionSet",
            "style": {
                "justify-content": "center"
            },
            "actions": [
                {
                    "type": "copyDashboardView",
                    "title": "Copy Dashboard View"
                }
            ]
        }
    ]
}

1. Custom Action Creation:

Develop a custom action with the following script and name it as 'copyDashboardView' (ensure the action name matches in the blox script):

navigator.clipboard.writeText(prism.psGetDashboardViewUrl());
alert('Dashboard view copied to clipboard');

Reference the Sisense documentation for creating custom actions in blox: Sisense Blox Tutorials

1. Save and Apply:

Save the widget by clicking the 'Apply' button. Your blox button is now ready for use. Click on it to copy the dashboard view URL. Once copied, you'll receive a confirmation message: 'Dashboard view copied to clipboard'.

Plugin Global Configurations

shareViewButton: This option allows you to configure the style of the 'Share View' button. Customize parameters such as color, colorHover, and text to tailor the appearance of the button to your preferences.

window.PS_SHARE_DASHBOARD_VIEW_CONFIG = {

    // Set this flag to true for debugging purposes
    debugLog: false,

    shareViewButton: {
        color: '#58C1EC',
        colorHover: '#1FA6DE',
        text: 'Share View'
    },
};