Notebook Embedding via iFrames

Sisense Notebooks can be quickly and easily embedded in your web application using an iFrame element.

Authentication

Embedded Notebooks require SSO authentication, usually using the existing corporate SSO authentication. To learn more about configuring SSO, see Using SSO to Access Sisense.

How to Embed a Notebook

To implement this feature you must identify:

The URL of the Notebook you are planning to embed. (See below, Get the Notebook URL for Embedding.)
Which URL embedding parameters you want to use. (See below, Parameters for Notebook Embedding.)

Once you have this information, include it in the src attribute of an iFrame element and add the iFrame to your webpage.

Example:

<iframe

  id="ifram_id"

  name="ifram_name"

  width="100%"

  height="100%"

  frameborder="0"

src="https://notebooks.yourcompany.com/app/notebooks/<notebook ID>?embed=true&edit=true&l=true&h=false&r=true&t=true"

  scrolling="auto"

></iframe>

Get the Notebook URL for Embedding

Open your Notebook and copy the URL of the Notebook, up to and including the Notebook ID.

For example, for this Notebook URL:

http://notebooks.yourcompany.com/app/notebooks/6400706dbbe5400011591272/create

You only need this part:

http://notebooks.yourcompany.com/app/notebooks/6400706dbbe5400011591272

Once you have the URL, you can add the desired URL parameters at the end.

For example, to embed a Notebook so that it can be edited, you must add these parameters:

?embed=true&edit=true

Another approach is to add all of the available URL parameters, and then set them to true or false, depending on whether or not you need them:

http://notebooks.yourcompany.com/app/notebooks/6400706dbbe5400011591272?embed=true&edit=true&l=true&h=false&r=true&t=true

Parameters for Notebook Embedding

The following parameters are supported when embedding Notebooks via an iFrame:

Name	Type	Required
`embed`	Boolean	Yes	Displays the Notebook in embedded mode.
`edit`	Boolean	No	Enables data designers to edit the Notebook. (The toolbar option, `t`, must be enabled as well.)
`h`	Boolean	No	Show/hide the environment header.
`t`	Boolean	No	Show/hide the Notebook toolbar.
`l`	Boolean	No	Show/hide the navigation panel to the left.
`r`	Boolean	No	Show/hide the filter panel to the right.

Other Types of Embedding

For related information about embedding other objects, such as Dashboards and Widgets, see: