Search results

Bold BI Dashboards embedding in Angular with ASP.NET Core using Embedded SDK

We have created the Angular and ASP.NET Core application for achieving this embedding. Here, the Angular app acts as a client and the Core app acts as a server. Using this environment, we could be able to list the dashboards and render them on it.

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 Angular App with ASP.NET Core Application from here.

  2. Here, the Angular application act as a client, and the ASP.NET Core application act as a server since we need to set the following properties in the app.component.ts file as follows. Embed Properties in App Component

    apiHost ASP.NET Core application would be run on http://localhost:61377/, which needs to be set as `apiHost`
    environment Your Bold BI application environment. (If Cloud, you should use `cloud`, if Enterprise, you should use `enterprise`)
    rootUrl 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.
    authorizationUrl Url of the GetDetails action in ValuesController of the ASP.NET Core application
    getDashboardsUrl Url of the GetDashboards action in ValuesController of the ASP.NET Core application
  1. In EmbedProperties.cs of the ASP.NET Core application, you need to set the RootUrl, SiteIdentifier, UserEmail, UserPassword, and EmbedSecret properties.
    Embed Properties

    RootUrl Dashboard Server BI URL (ex: http://localhost:5000/bi, http://dashboard.syncfusion.com/bi)
    SiteIdentifier For Bold BI Enterprise edition, it should be like `site/site1`. For Bold BI Cloud, it should be empty string.
    UserEmail UserEmail of the Admin in your Bold BI, which would be used to get the dashboards list
    UserPassword Password of the Admin in Bold BI, which would be used to get the dashboards list
    EmbedSecret You could get your EmbedSecret key from Embed tab by enabling `Enable embed authentication` in Administration page as shown below
  1. You can get your Embed Secret key from the administrator setting section. Please refer to this link for more details.

  2. Then, run your ASP.NET Core application as well as the Angular App.

How this sample works

  1. Based on the properties set on the app.component.ts file, we would call the GetDashboards() method from the ngOnInit() in the dashboard-listing.component.ts.
    Get Dashboards

  2. Above the GetDashboards() method would call the GetDashboards action in HomeController of the ASP.NET Core Application. Then, it would generate a user token and get the dashboard list.
    Get Dashboards Controller

  3. In the dashboard-listing.component.html file, we have designed a page for listing the dashboards on the left side and rendering the dashboard. The retrieved dashboard list has been sent to the dashboardsList property.
    Dashboard Listing

  4. By default, we have rendered the first dashboard from the list using the renderDashboard() method in the dashboards-listing.component.ts file. This render method implemented with the Bold BI SDK component code.
    Dashboard Rendering

  5. Before rendering, we are calling the authorizationUrl, which redirects to GetDetails action in the HomeController, which generates the EmbedSignature using the embed secret provided in the EmbedProperties.cs of ASP.NET Core application.
    Get Embed Details

  6. These details will be sent to the Bold BI server, and get validated there. Once details are validated, the dashboard starts to render.