How to configure WebAPI Data Processing Extension for Report Viewer

To configure the WebAPI Data Processing Extension for the Bold Reports® Report Viewer, install the BoldReports.Data.WebData NuGet package and register it with ReportConfig.DefaultSettings at application startup. The following steps register and load WebAPI data extensions in a Web Report Viewer application.

How do I install the WebAPI data source extension NuGet package?

To register and load WebAPI data sources in the Bold Reports® Report Viewer, install the BoldReports.Data.WebData package in your application.

Right-click the project or solution in the Solution Explorer tab, and choose Manage NuGet Packages. Alternatively, select the Tools > NuGet Package Manager > Manage NuGet Packages for Solution menu command.

Search for BoldReports.Data.WebData NuGet package, and install it in your application.

Built in WebAPI

How do I register the WebAPI data source extension at application startup?

To register the WebAPI data source extension for the Bold Reports® Report Viewer, add BoldReports.Data.WebData to ReportConfig.DefaultSettings at application startup, as described for each platform in the following sections.

ASP.NET

To register the extension in the ASP.NET Web application, follow these steps.

  1. Open the code-behind file Global.asax.cs and add the following using statement.

        using BoldReports.Web;

  2. Then register the assembly name BoldReports.Data.WebData in Application_Start using ReportConfig.DefaultSettings as follows to use the WebAPI data extension.

        protected void Application_Start(object sender, EventArgs e)
    {
        System.Web.Http.GlobalConfiguration.Configuration.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{action}/{id}",
        defaults: new { id = RouteParameter.Optional });

        AppDomain.CurrentDomain.SetData("SQLServerCompactEditionUnderWebHosting", true);

        //Use the below code to register extensions assembly into report designer
        ReportConfig.DefaultSettings = new ReportSettings().RegisterExtensions(new List<string> { "BoldReports.Data.WebData" });
    }

ASP.NET Core

To register the extension in the ASP.NET Core application, follow these steps.

  1. Open the file Startup.cs and add the following using statement.

        using BoldReports.Web;

  2. Register the package name BoldReports.Data.WebData in Startup using ReportConfig.DefaultSettings, as follows, to use the WebAPI data extension.

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory loggerFactory)
    {
        loggerFactory.AddConsole(Configuration.GetSection("Logging"));
        loggerFactory.AddDebug();

        AppDomain.CurrentDomain.SetData("SQLServerCompactEditionUnderWebHosting", true);

        //Use the below code to register extensions assembly into report designer
        ReportConfig.DefaultSettings = new ReportSettings().RegisterExtensions(new List<string> { "BoldReports.Data.WebData" });
    }

To register multiple data extensions in the application, provide the assembly names as a list of strings.

See also