Bold BI Dashboards embedding in Django using Embedded SDK

A GitHub link has been provided to get the sample application, which demonstrates the rendering of the dashboard available on your Bold BI server. This is followed by steps to create a new embedding application in Django on your own.

NOTE: The best way to get started would be to read the Getting Started section of the documentation. The Getting Started guide provides you with enough information that you need to know before working on the sample.

Prerequisites

• Python installer
• Visual Studio Code
• Python extension in VS code

How to run the sample

1. Please get the Django sample from the attached file.

2. Please ensure that you have enabled embed authentication on the embed settings page. If it is not currently enabled, please refer to the following image or detailed instructions to enable it.

3. To download the embedConfig.json file, please follow this link for reference. Furthermore, you can refer to the accompanying image for visual guidance.

   

4. Please copy the downloaded embedConfig.json file and paste it into the designated location within the application. Make sure to place it in the application as shown in the following image.

   

   ServerUrl	Dashboard Server BI URL (ex: http://localhost:5000/bi, http://demo.boldbi.com/bi)
   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 it is cloud analytics server, use `BoldBI.Environment.Cloud`; if it is your own server, use `BoldBI.Environment.Enterprise`).
   DashboardId	Item id of the dashboard to be embedded in your application.
   EmbedSecret	Get your EmbedSecret key from the Embed tab by enabling the Enable embed authentication in the Administration page
   UserEmail	UserEmail of the Admin in your Bold BI, which would be used to get the dashboards list.
   ExpirationTime	Token expiration time. (In the EmbedConfig.json file, the default token expiration time is 10000 seconds).

5. Open the folder in terminal in Visual Studio Code and execute the command python manage.py runserver to run the application.

How this sample works

1. The renderDashboard method will be invoked from the fetchEmbedAndLoad() function based on the configured embedConfig values in the index.html file.

2. Before rendering, call the tokenGeneration Url, which redirects to the TokenGeneration action in the views.py. This action generates the access token using the provided embedDetails.
   

3. Once the token is generated, it will be returned to the index.html file and the dashboard will start to render it.