Embedding Dashboards and Widgets
Applicable to Sisense on Linux and Microsoft Windows
You can embed Sisense dashboards and widgets in non-Sisense environments such as in your own websites or applications. Embedding only the Data, Pulse, or Admin tabs isn't supported.
You can embed Sisense in one of three ways:
- Directly via iFrames
- Using the Embed SDK
- With Sisense.JS
See the Sisense Developers’ Guide to learn about the embedding approach that is right for you. Explore information about iFrames, the Embed SDK, and Sisense.JS documentation, as well as API references.
You can also test the three methods of embedding using the Sisense Embedded Playground.
This document covers embedding via iFrames using the UI embed code generator.
Sisenseoffers two embed modes:
- Edit mode: Users can edit the dashboard/widgets directly from the non-Sisense environment. Editing is only allowed for users who have permission to edit Sisense in the regular Sisense environment. Viewer users won't be able to edit the dashboards and widgets, even in Edit mode.
- View mode: All users can view the dashboards and widgets from the host environment. Designer users can resize dashboards, and they can also perform the actions available through the button of the dashboard/widget, such as duplicating and downloading dashboards and renaming and deleting widgets.
Breaking Changes: From version 8.1, Designers won't be able to make any changes in View mode (including the changes listed above). For Designers to make any changes to dashboards and widgets, configure the host environment to Edit mode.
Note: To add the Embed Code option to your dashboard menu, your Administrator must enable it from the Admin tab under Feature Management.
To generate a URL to embed Sisense:
- Click the dashboard or wizard menu and select Embed Code.
- In Mode, select an embed mode: Edit or View.
- In Configuration, select the required configurations.
- In Specify Base URL, indicate your base URL, if you have a different base URL.
- Click Copy Code to copy the URL of HTML code. You can copy the URL code to paste into your HTML tag, or you can copy the HTML code to embed in an iFrame.
Embedding with URLs
You can embed Sisense dashboards and widgets in non-Sisense environments, such as in your own websites or applications, by concatenating parameters to the URL of your dashboard or widget.
To embed Sisense:
- Copy the URL of the dashboard. For a widget, open it in the Widget Designer, and copy the URL of the widget.
Add one of the following to the URL:
- To embed in View mode: add the ?embed=true parameter to the URL of the dashboard or widget
- To embed in Edit mode: add the ?embed=true&edit=true parameters to the URL of the dashboard or widget
You can use this URL to embed the dashboard in an iFrame. For example:
<iframe id="ifm" name="ifm" width="100%" height="100%" frameborder="0" src="http://mysite.com/app/main#/dashboards/536f2b70d093e26c280000d5?embed=true&edit=true" scrolling="auto"></iframe>
Dashboard Within a Folder
If your dashboard is within a folder, delete ?folder= and everything that follows, and then add ?embed=true.
This will open the dashboard without the surrounding Sisense environment.
Dashboard URL for a dashboard within a folder:
Embedded URL for a dashboard within a folder:
Embedding Configuration Options
In View mode, the dashboard/widget appears by default with the Filters panel open. You can hide this panel, or you can enable all users to view other panels, to see the selections made there.
Windows: In Edit mode, when a user edits a widget, the metadata, filter/design, and toolbar panels are displayed. You can hide some (or all) panels to prevent users from making changes to these panels, but you need to explicitly prevent these panels from being displayed.
Linux: In Edit mode, the dashboard/widget appears by default with the panels opens. You can hide some (or all) panels to prevent users from making changes to these panels.
To do so, add the following parameters to the URL of the dashboard/widget following the main parameters ?embed=true or ?embed=true&l=false&r=false&t=false. All the following parameters are optional.
|Parameter||In Dashboards||In Widgets|
&h=true / false
|Show/hide the environment header||Show/hide the environment header|
&t=true / false
|Show/hide the dashboard toolbar||Show/hide the widget toolbar|
&l=true / false
|Show/hide the Navigation Panel to the left||Show/hide the data panel to the left|
&r=true / false
|Show/hide the filter panel to the right||Show/hide the filter and design panel to the right|
For example, if you want to hide the Sisense header from the dashboard, you can add the ?embed=true&edit=true&h=false parameters to the URL of the dashboard to hide the header:
In this example, the embed=true embeds the dashboard into your environment in the view mode. The edit=true parameter allows the users with the appropriate permissions to edit Sisense in your environment. The h=false parameter hides the Sisense header, allowing you to white label the dashboard.
Authentication in Embedded Dashboards and Widgets
All Sisense dashboards and widgets require authentication. When embedding dashboards and widgets outside of the Sisense environment, the usual practice is to use Single Sign-On(SSO) with existing corporate authentication. SSO is more common than using the Sisense environment authentication. To read more on configuring SSO in Sisense, see Introduction to SSO.