orchardcore-reports

CrestApps OrchardCore Reports

The Reports module provides a shared admin Reports area and contracts for modules that publish reports. Reports use one filter and rendering model for browser output and exports.

Features and packages

• CrestApps.OrchardCore.Reports enables the framework and admin area.
• CrestApps.OrchardCore.Reports.OpenXml adds Excel .xlsx export support.
• The Reports feature depends on CrestApps.OrchardCore.Resources.
• CSV export is provided by the base Reports feature.

Enable the features with a root-wrapped recipe:

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "CrestApps.OrchardCore.Reports",
        "CrestApps.OrchardCore.Reports.OpenXml"
      ]
    }
  ]
}

Enable the OpenXml add-on only when Excel export is required. When several exporters are available, the admin page groups them under one Export dropdown.

Report contracts

Implement IReport for a report definition. Provide a technical Name, a display name, a description, a category, a permission, and a RunAsync implementation that returns a ReportDocument for the supplied ReportContext.

Register reports as scoped services:

using CrestApps.OrchardCore.Reports;
using Microsoft.Extensions.DependencyInjection;
using OrchardCore.Modules;

namespace MyModule;

public sealed class Startup : StartupBase
{
    public override void ConfigureServices(IServiceCollection services)
    {
        services.AddScoped<IReport, SalesReport>();
    }
}

IReport, IReportManager, IReportExportFormat, and IReportExportManager are in CrestApps.OrchardCore.Reports. ReportDocument, ReportSection, ReportContext, ReportFilter, and ReportFormat are in CrestApps.OrchardCore.Reports.Models.

Use ReportSection.ForMetrics, ReportSection.ForTable, ReportSection.ForBars, and ReportSection.ForChart to compose the document. Use ReportFormat for consistent number, duration, and percentage formatting. Charts use ordered labels and one or more numeric datasets in the shared responsive twelve-column layout.