JS Viewer ASP.NET Core Middleware

In This Topic

ASP.NET Core middleware is software to handle HTTP requests and responses. Each middleware component serves a specific purpose, one authenticates a user, and the other handles static files like Javascript or CSS files. These middleware components together set up a request processing pipeline.

The default code developed by the ASP.NET Core Web App template sets up the request processing pipeline for the application using a set of middlewares - UseDeveloperExceptionPage() and UseStaticFiles() of the IApplicationBuilder interface. The middlewares are executed in the order in which they are added to the pipeline.

To provide access to a report output from the browser, you need to configure ActiveReports JSViewer in ASP.NET Core middleware. It is done by adding the UseReporting() middleware, which configures middleware for ActiveReports API and handlers.

Create an ASP.NET Core Project
Open Microsoft Visual Studio 2022 and select Create a new project.
Select ASP.NET Core Web Application and click Next.
Type a name for your project and click Next.
Fill-in the additional info like Target Framework as .NET 6.0.
Uncheck the 'Configure for HTTPS' checkbox instruction and click Create.

Configure ActiveReports in ASP.NET Core Middleware
Right-click the project in the Solution Explorer and select Manage Nuget Packages.

Add the following package to the project.

GrapeCity.ActiveReports.Aspnetcore.Viewer

In the License Acceptance dialog that appears, click I Accept.
Add a new folder called 'Reports' in application's root and place the report you want to display in the viewer, in this folder.
Make sure to set the Build Action property of the report to 'Embedded Resource'.
Open 'Startup.cs' file and add the following 'using' statement at the top.
```
using GrapeCity.ActiveReports.Aspnetcore.Viewer;
```

Modify the content for the Program.cs file as follows to enable the application to use ActiveReports:

Program.cs	Copy Code
using GrapeCity.ActiveReports.Aspnetcore.Viewer; var builder = WebApplication.CreateBuilder(args); // Add services to the container. builder.Services.AddRazorPages(); ; var app = builder.Build(); // Configure the HTTP request pipeline. if (!app.Environment.IsDevelopment()) { app.UseExceptionHandler("/Error"); // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts. app.UseHsts(); } app.UseHttpsRedirection(); app.UseStaticFiles(); // Configure middleware for ActiveReports API and handlers. app.UseReporting(settings => { settings.UseEmbeddedTemplates("JsViewer_Core.Reports", System.Reflection.Assembly.GetEntryAssembly()); settings.UseCompression = true; }); app.UseRouting(); app.UseAuthorization(); app.MapRazorPages(); app.Run();

Program.cs

Copy Code

using GrapeCity.ActiveReports.Aspnetcore.Viewer;

var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddRazorPages();
;
var app = builder.Build();
// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();

// Configure middleware for ActiveReports API and handlers.
app.UseReporting(settings =>
{
    settings.UseEmbeddedTemplates("JsViewer_Core.Reports", System.Reflection.Assembly.GetEntryAssembly());
    settings.UseCompression = true;
});

app.UseRouting();
app.UseAuthorization();
app.MapRazorPages();
app.Run();

Make sure that the correct namespace is provided in the first argument of UseEmbeddedTemplates for the report.

Note: Instead of ‘UseEmbeddedTemplates', you can use either 'UseFileStore' or 'UseCustomStore’ method calls.

'UseEmbeddedTemplates' stores reports as resources in dlls.
'UseFileStore' stores reports in the file system.
'UseCustomStore’ allows you to store reports in any user-defined location, like a custom database or any other type of location.

Product Support Forum | Print this page