Embedding overview

Embedding refers to either including Birst content in external applications or including content from external applications in Birst Dashboards.

Embedding External Web Pages

Dashboards can display content from other websites within dashlets. You specify the URL of the website and optionally use dashboard filters as URL query parameters. Use the Insert Web Page feature and pass parameters if you are embedding external content within Dashboards that does not require the use of JavaScript callback event handling, such as embedding a video. See Embedding external web pages.

Using Embedded APIs and JavaScipt

The best way to embed Javascript code, such as D3 or Google charts, is to enter your JavaScript code directly inside Dashboards using the Add HTML Editor feature. A benefit of using the Add HTML Editor feature is that you can invoke JavaScript callbacks to dynamically control bi-directional filtering or drill-to-dashboard based on an one-click event of the embedded external visual. See HTML and JavaScript in dashboards.

Embedding Birst Content in External Applications

Birst provides a general mechanism for embedding reports and dashboards within web applications, such as for an OEM embedded analytics scenario.

Note: Embedded Visualizer reports (via iframe using JavaScript) respond to external filters applied from the parent content web page and adjust to any re-sizing efforts made by the parent content container.

Embedding in an External Web Application

You can embed reports and dashboards in other web applications using a single sign-on (SSO) mechanism. This allows your own authentication mechanism to authenticate the user within your application, after which your application requests an authentication token for the user to access embedded Birst reports and dashboards, for example, in an HTML Iframe.

Embedding in Cloud Applications

There are specific methods for embedding within the Salesforce cloud applications. It is possible to embed multiple Visualizer reports and Dashboards (from the same space) onto an external web page.