Embed Dashboards using SSO in Bold BI

Bold BI supports embedding the dashboards to other web applications using Single Sign-On authentication.

Steps to embed dashboards

Below are the steps to embed dashboards into other web applications.

NOTE: A similar procedure should be followed to render the multi-tab dashboard in view mode.

Get embed secret code

1. Go to the settings page and click Embed. Enable the Enable embed authentication under that page.

   

2. Click Generate Secret button.

   

3. On clicking it, the secret code will be generated. Save the secret key safely, as it will not be able to retrieve or restore this generated secret.

   

4. Once the secret code is generated, it can be regenerated by clicking the Regenerate Secret button.

   

Warning : Resetting this code will break the previously working embedded dashboards.

Creating the embed URL for view mode

The embed URL should be in the following format.

{dashboard URL}/{embed parameters}&embed_signature={signature}

Please find the details of the parameter in the URL as follows.

Parameters to generate the signature in the embed URL

The below values are necessary to form the signature

Generating the signature for the embed URL

The embed parameter should be formed as in the below format.

To obtain the signature for the embed URL, pass the query parameters as an argument to the below GetSignatureUrl method. It will return the hashed signature, which you must append to the existing query parameters with the query parameter name as ‘embed_signature’.

        
        public string GetSignatureUrl(string queryString)
        {
            // Get the embedSecret key from Bold BI.
            var embedSecret = "8apLLNabQisvriG2W1nOI7XWkl2CsYY";
            var encoding = new System.Text.UTF8Encoding();
            var keyBytes = encoding.GetBytes(embedSecret);
            var messageBytes = encoding.GetBytes(queryString);
            using (var hmacsha1 = new HMACSHA256(keyBytes))
            {
                var hashMessage = hmacsha1.ComputeHash(messageBytes);
                return Convert.ToBase64String(hashMessage);
            }
        }

We have provided the code snippet to generate the signature in C#. You can write the equivalent code in your platform language.

Available parameter

How to pass the dashboard parameter and URL parameter filters in embed URL

In embed URL, you can pass both types of filters(Dashboard Parameter/URL Filter Parameter) values at the same time.

Pass your filters to the embed_datasource_filter URL parameter in the embed URL as follows.

• In the embed URL, the dashboard parameter filter must be started with a double ampersand &&. For more details, Refer to this link.

• In the embed URL, the URL filter parameter must be started with a single ampersand &. For more details, refer to this link .

Creating the embed URL to create dashboard

The embed URL should be in the following format.

{create dashboard URL}/{embed parameters}&embed_signature={signature}

Please find the details of the parameter in the URL as follows.

Creating the embed URL for edit dashboard

The embed URL should be in the following format.

{dashboard edit URL}/{embed parameters}&embed_signature={signature}

Please find the details of the parameter in the URL as follows.

Parameters to generate the signature in the embed URL

The following values are necessary to form the signature.

Sample to embed dashboard using SSO authentication

You can download the sample here.