Search results

Bold BI Dashboards embedding in Windows Forms using Embedded SDK

We have created a Windows Forms application for achieving this embedding. Here, we could set the server and dashboard details as the embed details then the dashboard would be rendered after passing the authorization.

NOTE: The best way to get started would be reading the Getting Started section of the documentation to start using first. The Getting Started guide gives you enough information that you need to know before working on the sample.

How to run the sample

  1. Please download the Windows Forms sample from here.

  2. You need to set your embed property details in EmbedProperties.cs.
    Embed Properties

    RootUrl Dashboard Server BI URL (ex: http://localhost:5000/bi/site/site1, http://demo.boldbi.com/bi/site/site1)
    SiteIdentifier For Bold BI Enterprise edition, it should be like `site/site1`. For Bold BI Cloud, it should be empty string.
    Environment Your Bold BI application environment. (If Cloud, you should use `Cloud`, if Enterprise, you should use `OnPremise`)
    DashboardId Set the item id of the dashboard to embed from BI server.
    UserEmail UserEmail of the Admin in your Bold BI, which would be used to authorize the server.
    EmbedSecret You could get your EmbedSecret key from Embed tab by enabling `Enable embed authentication` in Administration page as mentioned in next step
  1. You could get the item id of the dashboard from the BI server. Please refer to this link and the following screenshot.
    Get Dashboard Id

  2. You can get your Embed Secret key from the administrator setting section. Please refer to this link for more details.

  3. Then, run your Windows Forms sample.

How this sample works

  1. Based on the dashboardId provided in the embed properties, we would authorize the server URL by calling the GetEmbedDetails function. Learn more about authorize server here Get Embed Details

  2. In the above authorization, we have generated the SignatureUrl with the provided EmbedSecret key and validate the embed details in Bold BI. Once details are validated, the dashboard starts to render.

  3. In the EmbedProperties.cs, you can change the dashboard Id of the respective dashboard as you wish to embed. Set Dashboard Id