Configuration

GrydReports configuration is split into:

• GrydReportsOptions (main module behavior)
• GrydFiles:Profiles:gryd.report (where generated files are stored — see File Storage)
• ReportDeliveryOptions (delivery defaults)
• ReportScheduleOptions (recurring scheduling guardrails)

Recommended Setup (Facade)

Use the facade for the standard stack (Application + Infrastructure + API):

builder.Services.AddGrydReports(
    builder.Configuration,
    db => db.UseNpgsql(builder.Configuration.GetConnectionString("GrydReports"))
);

This automatically binds GrydReportsOptions from GrydReports section in appsettings.json.

Advanced Setup (Fine-Grained)

Use Infrastructure registration directly when you need explicit option callbacks:

builder.Services.AddGrydReportsApplication();
builder.Services.AddGrydReportsInfrastructure(
    configureOptions: options =>
    {
        options.RetentionDays = 90;
        options.EnableAutoCleanup = true;

        options.MaxSyncGenerationSize = 50 * 1024 * 1024; // 50 MB
        options.SyncGenerationTimeout = TimeSpan.FromMinutes(2);
        options.ForceAsyncAboveBytes = 10 * 1024 * 1024; // 10 MB

        options.AutoRegisterTemplates = true;
        options.TemplateAssemblies.Add(typeof(Program).Assembly);

        options.Caching.Enabled = true;
        options.Caching.DefaultExpiration = TimeSpan.FromHours(1);
        options.Caching.TemplateExpirations["daily-sales"] = TimeSpan.FromMinutes(30);

        options.DigitalSignature = new DigitalSignatureOptions
        {
            Enabled = true,
            CertificatePath = "/certs/report-signing.pfx",
            CertificatePassword = "secure-password",
            Reason = "Official Document",
            Location = "Sao Paulo, BR"
        };
    },
    configureDbContext: db =>
        db.UseNpgsql(builder.Configuration.GetConnectionString("GrydReports"))
);
builder.Services.AddGrydReportsApi();

appsettings.json

GrydReports section is bound to GrydReportsOptions. ConnectionStrings:Jobs is only needed when you enable recurring scheduling with GrydJobs.

{
  "ConnectionStrings": {
    "GrydReports": "Host=localhost;Database=gryd_reports;Username=postgres;Password=postgres",
    "Jobs": "Host=localhost;Port=5432;Database=gryd_jobs;Username=postgres;Password=postgres"
  },
  "GrydReports": {
    "RetentionDays": 90,
    "EnableAutoCleanup": true,
    "MaxSyncGenerationSize": 52428800,
    "SyncGenerationTimeout": "00:02:00",
    "ForceAsyncAboveBytes": 10485760,
    "AutoRegisterTemplates": true,
    "Caching": {
      "Enabled": false,
      "DefaultExpiration": "01:00:00",
      "TemplateExpirations": {
        "daily-sales": "00:30:00"
      }
    },
    "DigitalSignature": {
      "Enabled": false,
      "CertificatePath": "",
      "CertificatePassword": "",
      "Reason": "Official Document",
      "Location": ""
    }
  },
  "GrydFiles": {
    "Profiles": {
      "gryd.report": {
        "MaxSizeBytes": 52428800,
        "AllowedContentTypes": [
          "application/pdf",
          "text/csv",
          "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
        ],
        "ScanRequired": false,
        "DefaultRetentionMode": "UntilReleased"
      }
    }
  }
}

File Storage (GrydFiles)

Generated reports are stored in GrydFiles, the platform's file module, in process. There is no report-specific storage configuration: the bucket is the one GrydStorage configures, and the rules come from the gryd.report profile. The host registers the file module; GrydReports refuses to start when the gryd.report profile is not declared.

builder.Services.AddGrydObjectStorage(builder.Configuration);
builder.Services.AddGrydFiles(builder.Configuration);
builder.Services.AddGrydFilesClamAv(builder.Configuration);
builder.Services.AddGrydReports(builder.Configuration, db => db.UseNpgsql(connectionString));

gryd.report setting	Meaning for reports
AllowedContentTypes	Must include the type of every format you render: application/pdf, text/csv, the XLSX type. A report of a format the profile does not accept fails to store
MaxSizeBytes	The largest report that can be stored
ScanRequired: false	The antivirus is waived — the file never left this process. The server still computes the SHA-256 and checks the content against the type, and the waiver is written to the audit trail at start-up
DefaultRetentionMode: UntilReleased	The file lives while its execution holds it. Deleting the execution releases it, and GrydFiles purges it after GrydFiles:PurgeGracePeriodDays
DownloadUrlTtlMinutes	How long a download URL from GET /reports/{id}/download stays valid (default 5)

Each stored report is referenced by its execution with owner scope gryd.report-execution and owner key equal to the execution id. See the GrydFiles pages on retention and purge and download.

Delivery Configuration

Configure default delivery constraints and message templates:

builder.Services.ConfigureGrydReportsDelivery(opts =>
{
    opts.DefaultSenderEmail = "reports@company.com";
    opts.DefaultSenderName = "Report System";
    opts.DefaultEmailSubject = "Report: {ReportName} - {Date}";
    opts.DefaultEmailBody = "Please find the attached report.";
    opts.MaxRecipients = 50;
    opts.WebhookTimeout = TimeSpan.FromSeconds(30);
    opts.RetryCount = 3;
});

Scheduling Configuration (Optional)

Recurring scheduling is optional and only applies when:

• GrydReports.Scheduling.GrydJobs package is installed
• builder.Services.AddGrydReportsScheduling() is registered

builder.Services.ConfigureGrydReportsScheduling(opts =>
{
    // 0 = unlimited schedules per tenant
    opts.MaxSchedulesPerTenant = 0;

    opts.MaxConsecutiveFailures = 3;
    opts.MinimumInterval = TimeSpan.FromHours(1);
    opts.NotifyOnAutoPause = true;
});

Per-Template Permissions

Configure RBAC per template through GrydReportsOptions:

builder.Services.Configure<GrydReportsOptions>(opts =>
{
    opts.Permissions["financial-report"] = new ReportPermissions
    {
        Generate = ["admin", "finance-manager"],
        View = ["admin", "finance-manager", "finance-analyst"],
        Download = ["admin", "finance-manager"],
        Schedule = ["admin"]
    };

    opts.Permissions["inventory-report"] = new ReportPermissions
    {
        Generate = ["admin", "warehouse-manager"],
        View = ["admin", "warehouse-manager", "warehouse-staff"],
        Download = ["admin", "warehouse-manager"],
        Schedule = ["admin", "warehouse-manager"]
    };
});

Global Reports

Mark templates that do not require tenant scope filtering:

builder.Services.Configure<GrydReportsOptions>(opts =>
{
    opts.GlobalReports.Add(typeof(SystemHealthTemplate));
    opts.GlobalReports.Add(typeof(PlatformUsageTemplate));
});

Health Checks

Register module health checks:

builder.Services.AddGrydReportsHealthChecks(builder.Configuration);

This registers:

• grydreports-database: PostgreSQL connectivity
• grydreports-self: module self-check

Map endpoint:

app.MapHealthChecks("/health", new HealthCheckOptions
{
    Predicate = check => check.Tags.Contains("grydreports")
});

Option Reference

GrydReportsOptions

Option	Type	Default	Description
ConnectionString	string?	null	Report metadata connection string
RetentionDays	int	90	Days to keep generated reports
EnableAutoCleanup	bool	true	Enables automatic retention cleanup
MaxSyncGenerationSize	long	50 MB	Max file size for sync generation
SyncGenerationTimeout	TimeSpan	2 min	Timeout for sync generation
ForceAsyncAboveBytes	long?	null	Forces async generation above threshold
AutoRegisterTemplates	bool	true	Auto-discovers report templates
Caching.Enabled	bool	false	Enables output caching
Caching.DefaultExpiration	TimeSpan	1 hour	Default cache TTL
DigitalSignature.Enabled	bool	false	Enables PDF digital signing

ReportDeliveryOptions

Option	Type	Default	Description
DefaultSenderEmail	string?	null	Default sender email
DefaultSenderName	string?	null	Default sender display name
DefaultEmailSubject	string	Report: {ReportName} - {Date}	Subject template
DefaultEmailBody	string	Please find the attached report.	Body template
MaxRecipients	int	50	Max email recipients
WebhookTimeout	TimeSpan	30s	Webhook timeout
RetryCount	int	3	Delivery retry attempts

ReportScheduleOptions (optional scheduling)

Option	Type	Default	Description
MaxSchedulesPerTenant	int	0	Max active schedules per tenant (0 = unlimited)
MaxConsecutiveFailures	int	3	Auto-pause threshold
MinimumInterval	TimeSpan	1 hour	Minimum allowed schedule interval
NotifyOnAutoPause	bool	true	Notify when schedule auto-pauses