orchardcore-reports

CrestApps Orchard Core Reports

The Reports module is a reusable reporting framework. It adds one admin Reports area and a small contract any module implements to publish a report. Every report shares the same filter form, the same renderer (metric cards, tables, bars, Chart.js charts) and the same exports (CSV built in, Excel with an add-on). Modules such as Omnichannel, Contact Center, Phone Number Verifications, Orders and Inventory contribute their reports through it.

Designed reports that people build in the browser are the Report Builder feature; see the orchardcore-report-builder skill.

Features

The feature IDs are constants on ReportsConstants (Feature, OpenXmlFeature, SubscriptionsFeature, BuilderFeature).

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

Install the module packages in the web (startup) project. A module that only contributes reports references CrestApps.OrchardCore.Reports.Abstractions.

Layers and namespaces

• CrestApps.OrchardCore.Reports.Abstractions holds the contracts and the document model: IReport, IReportRunner, ReportDescriptor, ReportOptions, ReportContext, ReportRunMode, ReportFilterExtensions, IReportExportFormat, ReportExportFormatDescriptor, ReportsConstants, ReportValue and AddReport / AddReportExportFormat (namespace CrestApps.OrchardCore.Reports); ReportDocument, ReportSection, ReportFilter, ReportDateRange, ReportStyle, ReportFormat and the other models (namespace CrestApps.OrchardCore.Reports.Models); IReportManager and IReportExportManager (namespace CrestApps.OrchardCore.Reports.Services).
• CrestApps.OrchardCore.Reports.Core holds the default ReportManager, ReportExportManager and CsvReportExportFormat.
• CrestApps.OrchardCore.Reports is the Orchard Core module: admin menu, ReportsController, views, and ReportDateRangeFilterDisplayDriver.