Embedding Dashboards

Embedding Dashboards#

Squirro dashboards can be embedded into other web applications or even desktop software. The basis for this is iFrame technology.

How to Embed Using iFrames#

image1

To embed a dashboard into a third-party application, select the dashboard within the user interface. On the right-hand side, open the menu and select Embed iFrame or Share. The only difference between the two commands is that Embed iFrame generates the full HTML code for an iFrame, while Share simply returns a URL to use.

That URL can be used for embedding, or it can simply be shared in chat apps, email, etc.

If you select the Automatically login into this account checkbox, a token is generated and appended to the dashboard URL. With this token, anybody can access the dashboard impersonating the current user in read-only mode.

Parameters#

The URL generated by the user interface always embeds the dashboard in its saved state. This means that any dashboard query and time limits configured in the dashboard are applied. These can be overwritten with URL parameters.

For example, the user interface may have returned the following URL:

https://squirro.example.com/app/dashboard/OuKRZuhmTXCA0mAfwSVm2g/hMcTiqacTIa0mXYvVh5N9Q

To extend this URL and pass in a custom query, use the query parameter as follows:

https://squirro.example.com/app/dashboard/OuKRZuhmTXCA0mAfwSVm2g/hMcTiqacTIa0mXYvVh5N9Q?query=test

Further parameters are added, separated by an ampersand. An example with a query and a token:

https://squirro.example.com/app/dashboard/OuKRZuhmTXCA0mAfwSVm2g/hMcTiqacTIa0mXYvVh5N9Q?query=test&token=abc

Parameter Reference#

All URL parameters are processed by the dashboard state system, which converts them into interactive selection chips that appear in the search interface. These selections can be removed or modified by users through the UI.

Reference: For detailed information about how URL parameters are converted to dashboard selections, see the Dashboard Editor page (Dashboard URL API Reference section).

Parameter

Documentation

token

Token for authentication. The token generated with that checkbox only grants the privileges needed to visit dashboards.

query

Items visualized in the dashboard are limited to the ones returned by this query. For query syntax details, see the Query Syntax page.

relative_start

Only return items that were created after this date and time. Uses the relative date and time format. Relative time is a number followed by a unit, for example 1w for 1 week (ago).\

Valid units are:

Unit

Description

y

Years

M

Months

w

Weeks

d

Days

h

Hours

m

Minutes

s

Seconds

created_after

Only return items that were created after this date and time. Uses the standard date and time format.

relative_end

Only return items that were created after this date and time. Uses the relative date and time format (see the relative_start parameter for more details).

created_before

Only return items that were created before this date and time. Uses the standard date and time format.

query_params

Query parameters injected into all API requests from the dashboard as template_params. This is a JSON-encoded dictionary of key/value pairs that can be used for query transformation in the Jinja template.

chatter_token

A Salesforce.com access token. If the Share on Chatter feature is turned on and this option is set, the Share on Chatter option is displayed in the horizontal result list.

chatter_url

A Salesforce.com instance URL used for the share on Chatter function.

Sandboxing#

If the iframe is used with the sandbox attribute, modal dialogs and JavaScript are blocked. Learn more

Set the sandbox attribute to allow-scripts allow-modals to avoid this.

Chat Widget Considerations#

When a dashboard containing the Chat widget is embedded in an external website, some agent types require access to Squirro-internal endpoints that are not available in that context. Requests to those endpoints will fail, and users may see error messages in the embedded widget.

To avoid this, turn off the following agents before embedding a dashboard with the Chat widget:

  • Collection agent

    Collection agents query the Collections endpoint to scope the conversation to a specific document collection. That endpoint is not accessible from external websites, which causes errors in the embedded widget.

  • Favorite Filter agent

    Favorite Filter agents query the Favorite Filters widget endpoint to narrow the conversation to a saved search. That endpoint is not accessible from external websites, which causes errors in the embedded widget.

Troubleshooting#

Automatic Logout#

When embedding a dashboard integration with a token (automatic login) the user may be automatically logged out from the system when they access Squirro standalone the next time. This is because the read-only token only grants access to the dashboard, but not to the standalone application.

To prevent this from happening, you can point a second domain name to the Squirro application and use that domain for integrations. That approach avoids clashes between the embedded iFrames and the standalone application usage.

Contents