Secure Embed Parameters

Customize Bold BI dashboards and widgets in iFrame embeds using optional URL parameters. Configure parameters via the Bold BI UI in the “Get Embed Code” dialog or manually append them as query strings. Some parameters require manual addition. Refer to the parameter tables for names, descriptions, types, and applicability.

Parameters Configurable in Bold BI UI

These parameters can be set directly in the Bold BI UI using the “Get Embed Code” dialog box.

Parameters Requiring Manual Addition to iFrame URL

These parameters must be manually added to the iFrame URL as they are not configurable through the Bold BI UI.

URL Creation

Follow these steps to manually create a secure embed URL with a signature for advanced use cases.

Step 1: Create the Embed URL

The embed URL follows this format:

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

• Base URL: The URL for the dashboard, widget, or data source, hosted on your server (e.g., http://localhost:51777).

• Embed Parameters (Mandatory):

• Embed Signature: A hashed value generated using the HMACSHA256 algorithm with the embed parameters and your embed secret key. Refer to the Bold BI site administration settings for the key.

Step 2: Generate the Embed Signature

To add or modify parameters not available in the Bold BI UI, generate a new embed signature using this C# code (or equivalent):

var embedParameters = "embed_nonce=55a1c8f4-5015-487d-8463-d3ebeae655fd&embed_user_email=admin@domain.com";
var embedSecretKey = "7tFaq2zidmxJN8Pid6IUAiGFqAUwMfK";

public string GetSignatureUrl(string embedParameters, string embedSecretKey)
{
    var encoding = new System.Text.UTF8Encoding();
    var keyBytes = encoding.GetBytes(embedSecretKey);
    var messageBytes = encoding.GetBytes(embedParameters);
    using (var hmacsha = new HMACSHA256(keyBytes))
    {
        var embedSignature = hmacsha.ComputeHash(messageBytes);
        return Convert.ToBase64String(embedSignature);
        // Example output: VYrDMVX4h85PrRBKX9mystRHYkU8z+HVC9bkVMc2qGY=
    }
}

Step 3: Combine and Embed

Combine the base URL, embed parameters, and signature. Example for a dashboard:

<iframe src="http://localhost:51777/bi/site/site1/dashboards/8428c9d9-85db-418c-b877-ea4495dcddd7/Predictive%20Analytics/Personal%20Expense%20Analysis?embed_nonce=3e253410-1a82-4fb3-a337-122a8007dafc&embed_user_email=admin@domain.com&embed_signature=VYrDMVX4h85PrRBKX9mystRHYkU8z+HVC9bkVMc2qGY=" width="100%" height="100%"></iframe>

Example: Generating URL with embed_datasource_filter for Row-Level Security

To implement row-level security, append the embed_datasource_filter parameter to filter data by user-specific criteria.

Steps to Generate the URL:

1. Start with the Base URL: Use the dashboard URL.
2. Add Mandatory Parameters: Include embed_nonce and embed_user_email.
3. Add embed_datasource_filter: Append the filter, e.g., &embed_datasource_filter=&&Region=North&Department=Sales.
4. Generate Embed Signature: Generate a new signature for the parameters (including embed_datasource_filter) using the embed secret key, as described in the Embed Using Embed Secret Token documentation.
5. Combine and Embed: Combine the base URL, parameters, and signature, then embed in an iFrame:

<iframe src="http://localhost:51777/bi/en-us/site/site1/dashboards/8428c9d9-85db-418c-b877-ea4495dcddd7/Predictive%20Analytics/Sales%20Dashboard?embed_nonce=3e253410-1a82-4fb3-a337-122a8007dafc&embed_user_email=admin@domain.com&embed_datasource_filter=&&Region=North&Department=Sales&embed_signature=VYrDMVX4h85PrRBKX9mystRHYkU8z+HVC9bkVMc2qGY=" width="100%" height="100%"></iframe>

For more details, refer to the Apply Row-Level Filters via URL documentation.

Notes

• Signature Regeneration: The copied URL includes a signature valid only for parameters configured in the Bold BI UI. Adding or removing parameters after copying invalidates the signature, breaking the URL.
• Dependencies: Parameters like enable_ai_summary, hide_aidata_usage, and customize_ai_name require enable_ai_assistant=true. embed_expirationtime requires embed_timestamp. Refer to the Configure AI documentation.
• Localization: Parameters hide_language_dropdown and language_code require prior configuration in Bold BI. See the Localization documentation.
• Custom Theme: The embed_theme parameter requires uploading custom theme files to the Bold BI server. See the Custom Theme documentation.
• Legacy Support: Parameters like views, export, dashboard_comments, and widget_comments replace older names (e.g., embed_dashboard_views), supported until Bold BI v11.3.