ScreamCode.Reporting.Core 1.1.7

ScreamCode.Reporting

Build faster. Report smarter.

A modular .NET 8 reporting engine with an embedded Blazor admin portal. Add powerful reporting capabilities to any ASP.NET Core application in minutes.

🚀 Quick Start

dotnet add package ScreamCode.Reporting.Core
dotnet add package ScreamCode.Reporting.Admin
dotnet add package ScreamCode.Reporting.Pdf
dotnet add package ScreamCode.Reporting.Excel

Program.cs

builder.Services
    .AddScreamReporting(builder.Configuration)
    .AddPdf()
    .AddExcel()
    .AddBuilder()
    .AddTemplates()
    .AddAdmin()
    .AddDataProvider<YourReportDataProvider>();

var app = builder.Build();

await app.Services.InitializeScreamReportingAsync();
await app.Services.EnsureAdminDatabaseAsync();

app.UseStaticFiles();
app.UseAntiforgery();
app.MapBlazorHub();

var adminPath = builder.Configuration["ScreamReporting:AdminPath"] ?? "reportadmin";
app.MapFallbackToPage($"/{adminPath}/{{**path}}", "/_Host");
app.MapFallbackToPage($"/{adminPath}", "/_Host");

app.Run();

appsettings.json

{
  "ScreamReporting": {
    "LicenseKey": "",
    "ApplicationName": "YourApp",
    "AdminPath": "reportadmin",
    "AdminAuth": {
      "Enabled": true,
      "Username": "admin",
      "Password": "your-password",
      "SessionTimeoutMinutes": 60
    },
    "Pdf": {
      "DefaultOrientation": "Portrait",
      "TimeoutMs": 30000
    }
  }
}

Implement IReportDataProvider

public class OrdersDataProvider : IReportDataProvider
{
    public string EntityName => "orders";
    public string DisplayName => "Orders";

    public IReadOnlyList<ReportColumnDefinition> AvailableColumns =>
    [
        new() { Name = "Id", DisplayName = "Order ID", Type = "string" },
        new() { Name = "CustomerName", DisplayName = "Customer", Type = "string" },
        new() { Name = "Total", DisplayName = "Total", Type = "decimal" },
        new() { Name = "CreatedAt", DisplayName = "Date", Type = "datetime" }
    ];

    public IReadOnlyList<ReportFilterDefinition> AvailableFilters =>
    [
        new() { Name = "CreatedAt", DisplayName = "Date", Type = "daterange" }
    ];

    public async Task<ReportTable> GetDataAsync(ReportBuilderRequest request, CancellationToken ct = default)
    {
        // Return your data here
    }

    public async Task<int> GetCountAsync(ReportBuilderRequest request, CancellationToken ct = default)
    {
        // Return count here
    }
}

✨ Features

30-day Professional trial included. No credit card required.

🔐 Authentication

Built-in auth (recommended for quick setup)

"AdminAuth": {
  "Enabled": true,
  "Username": "admin",
  "Password": "your-secure-password"
}

External auth (use your own ASP.NET Identity, JWT, etc.)

app.MapFallbackToPage("/reportadmin/{**path}", "/_Host")
   .RequireAuthorization("AdminRole");

"AdminAuth": {
  "Enabled": false,
  "ExternalAuthConfigured": true
}

📦 Packages

🖥️ Chromium Setup (for PDF generation)

Run once after deployment:

.\ScreamCode-Install.ps1

Or manually:

.\playwright.ps1 install chromium

🌍 Localization

Built-in: English and Bosnian. Add any language by placing a JSON file in Localization/Languages/:

publish/
└── Localization/
    └── Languages/
        ├── en.json
        ├── bs.json
        └── de.json  ← add your language

📄 License

MIT — free to use, modify and distribute.

🔗 Links

• 🌐 Website: screamcode.com
• 📖 Docs: screamcode.com/docs/reporting
• 💰 Pricing: screamcode.com/pricing
• 📧 Support: support@screamcode.com