Search results

Data Source view

This section explains how to integrate the Bold BI data source into the sample application by embedding the item listing and designing modules.



NOTE: Node.js versions 14.16 to 18.18 are supported.

How to run the sample

  • Please retrieve the sample of the Iframe DataSource embedding Javascript from GitHub.

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

    Embed Settings

  • To download the embedConfig.json file, please click on the following link. Additionally, you can refer to the image below for visual guidance.

    Embed Settings Download EmbedConfig Properties

  • Please copy the downloaded embedConfig.json file and paste it into the designated location within the application. Make sure that you have placed it in the application as shown in the following image.

    EmbedConfig image

    ServerUrl Datasource Server BI URL (ex: http://localhost:5000/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, For the datasource, DashboardId is not needed
    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 Datasource List
    ExpirationTime Token expiration time. (In the EmbedConfig.json file, the default token expiration time is 10000 seconds).
  • Open the terminal in Visual Studio Code and run this command to install the http-server package. This package enables the sample to run a local HTTP server.

       npm install -g http-server
  • To initiate the HTTP server on a specific port (for example, http-server -p 8000), run this command.

       http-server -p <port number>

    NOTE: Please replace <port number> with the desired port number.

  • Once the server is running, open your web browser and go to the DatasourceListing.html file (for example, http://localhost:8000/DatasourceListing.html).


How the Sample works

  • Using the built-in browser object XMLHttpRequest retrieve data from the embedConfig.json file within the DatasourceListing.html. If the embedConfig.json file is not found, the showError() function will throw an error.


  • The getToken() function generates an authorization token by utilizing the user’s email and embedded secret key from the apiRequest object. he resulting token is then stored in the accessToken variable.


  • The showDatasourceListing() function sends a GET request to the dashboardServerApiUrl/v2.0/items?ItemType=4 endpoint, including the accessToken as the authorization header. The accessToken is obtained from the getToken() function. The received data is then stored in the datasource variable.


  • If the datasource variable is not empty, a div element is created for each item in the datasource and added to the panel element. This action will result in the datasource list becoming visible.

    Creating a new Data Source

    • When the create button is clicked on the data source page, the openDesignerForCreate() function is activated. This function sets up the environment for creating a data source by removing existing content. Subsequently, it generates an embedded view using an <iframe>element, which directs to the data source designer page.



    Editing an existing Data Source

    • The openDesignerForEdit() method is called when we click on any data source in the data source listing contain-er. It retrieves the ID and name of the clicked item from its properties and utilizes them to open the data source designer page for editing within the “datasource” element.