PouryaKit.Reporting.Module

The Kit's report Module, a Module shipped as a package. A Host adds it once beside its own Modules. An Actor requests a report job over HTTP, and the Module stores the job in its own schema, generates the file in the background, stores it in the Host's one file storage provider, and serves the job's state and a time-limited download link to its requester. A recurring retention removes expired jobs and their files.

InstallCopy Anchor Link

dotnet add package PouryaKit.Reporting.Module --prerelease

When to use itCopy Anchor Link

• An Actor requests a report that takes a while to build, and downloads it when it is ready.
• You add report kinds to a Host by implementing the two ports.
• You need to know what a stale claim, a late settlement, another Actor or tenant, or the retention does to a job.

It renders with PouryaKit.Reporting and stores through PouryaKit.Storage, so the Host composes one provider, such as PouryaKit.Storage.S3.

Quick startCopy Anchor Link

Add the Module to the Host and implement its two ports, as the Proving Sample does. The Host also registers an IActorPermissions of PouryaKit.Security and one file storage provider, or its build fails:

modules.Add<ReportModule>();
builder.Services.AddSingleton<IReportRequestAuthorizer, SalesReports>();
builder.Services.AddSingleton<IReportLayouts, SalesReports>();

The first port decides who may request a kind, with which parameters:

public Task<bool> MayRequestAsync(
    OperationContext context,
    ReportRequest request,
    CancellationToken cancellationToken
)
{
    return Task.FromResult(
        context.Actor.Kind == ActorKind.Person
            && context.Tenant is not null
            && request.Kind == Kind
            && MonthOf(request) is not null
    );
}

What you getCopy Anchor Link

• A job stored with its requester and tenant.
• Generation by attempts that each claim the job, so a stale claim can be taken over.
• A job served within its tenant to its requester, or an Actor the Host grants the tenant's jobs.
• A retention that removes expired jobs and their files.

Learn moreCopy Anchor Link

• Report Module
• The Host's ports
• A job's life
• Reporting