Table of Contents

Interface ISoc2ReportExporter

Namespace
Excalibur.Compliance
Assembly
Excalibur.Compliance.Abstractions.dll

Exports SOC 2 reports to various formats for external auditors.

public interface ISoc2ReportExporter

Remarks

Reports can be exported to PDF, Excel, CSV, JSON, or XML format. Each format is optimized for different use cases:

  • PDF: Human-readable formatted report for distribution (requires the Excalibur.Compliance.Pdf package)
  • Excel: Tabular data for analysis and manipulation
  • CSV: Raw data for import into other systems
  • JSON: Machine-readable structured data
  • XML: Machine-readable with schema validation support

Methods

ExportAsync(Soc2Report, ExportFormat, Soc2ReportExportOptions?, CancellationToken)

Exports a report to the specified format.

Task<ExportResult> ExportAsync(Soc2Report report, ExportFormat format, Soc2ReportExportOptions? options, CancellationToken cancellationToken)

Parameters

report Soc2Report

The report to export.

format ExportFormat

The target export format.

options Soc2ReportExportOptions

Optional export options.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ExportResult>

The exported report data.

ExportWithEvidenceAsync(Soc2Report, IReadOnlyList<AuditEvidence>, EvidencePackageOptions?, CancellationToken)

Exports a report with evidence package for auditors.

Task<ExportResult> ExportWithEvidenceAsync(Soc2Report report, IReadOnlyList<AuditEvidence> evidence, EvidencePackageOptions? options, CancellationToken cancellationToken)

Parameters

report Soc2Report

The report to export.

evidence IReadOnlyList<AuditEvidence>

Evidence collection to include.

options EvidencePackageOptions

Optional export options.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ExportResult>

A zip archive containing the report and evidence.

Remarks

Creates a comprehensive audit package containing:

  • The report in PDF and JSON formats
  • All evidence items organized by category/criterion
  • A manifest file describing the package contents
  • Checksums for integrity verification

GetSupportedFormats()

Gets the supported export formats.

IReadOnlyList<ExportFormat> GetSupportedFormats()

Returns

IReadOnlyList<ExportFormat>

List of supported export formats.

ValidateForExport(Soc2Report, ExportFormat)

Validates that a report can be exported to the specified format.

ExportValidationResult ValidateForExport(Soc2Report report, ExportFormat format)

Parameters

report Soc2Report

The report to validate.

format ExportFormat

The target format.

Returns

ExportValidationResult

Validation result with any issues found.