Skip to content
EuroDMS Dev Guide

Document Archive

Document Archive

Section titled “Document Archive”

Quellverzeichnis: modules/document-archive/

Revisionssichere Dokumentenablage auf Basis von Mayan EDMS.

Services

Section titled “Services”

Geschäftslogik des Moduls (src/services/):

  • AccessLogService
  • AnonymizationService
  • ArchiveBucketAlreadyExistsError
  • ArchiveBucketNotFoundError
  • ArchiveBucketService
  • DeletionLogService
  • DocumentNotFoundError
  • DocumentService
  • DocumentTerminalError
  • EInvoiceService
  • EmailArchiveNotFoundError
  • EmailArchiveService
  • EmailArchiveTerminalError
  • LegalHoldAlreadyActiveError
  • LegalHoldNotFoundError
  • LegalHoldService
  • OcrService
  • RetentionPolicyNotFoundError
  • RetentionPolicyService
  • RetentionService
  • SearchService
  • TemplateNotFoundError
  • TemplateService
  • VehicleFileService

Repositories

Section titled “Repositories”

Datenzugriffs-Ports (src/repositories/):

  • AccessLogRepository
  • ArchiveBucketRepository
  • DeletionRecordRepository
  • DocumentRepository
  • DocumentTemplateRepository
  • EInvoiceValidationRepository
  • EmailArchiveRepository
  • InMemoryAccessLogRepository
  • InMemoryArchiveBucketRepository
  • InMemoryDeletionRecordRepository
  • InMemoryDocumentRepository
  • InMemoryDocumentTemplateRepository
  • InMemoryEInvoiceValidationRepository
  • InMemoryEmailArchiveRepository
  • InMemoryLegalHoldRepository
  • InMemoryRetentionPolicyRepository
  • LegalHoldRepository
  • RetentionPolicyRepository

Domain Events

Section titled “Domain Events”

Vom Modul emittierte Ereignisse (src/events.ts):

  • DOCUMENT_ARCHIVE_EVENT_TYPES
  • EventHandler
  • documentAnonymized
  • documentArchived
  • documentCreated
  • documentDeleted
  • documentLegalHoldReleased
  • documentLegalHoldSet
  • documentOcrCompleted
  • documentRetentionExpired
  • documentTemplateGenerated
  • eInvoiceValidated
  • eInvoiceValidationFailed
  • emailArchived
  • emailAssigned
  • templateStatusChanged
  • vehicleFileUpdated

API-Endpunkte

Section titled “API-Endpunkte”

HTTP-Endpunkte unter api/routes/document-archive/ — Details in der API-Referenz.

Methode Pfad Datei
GET /v1/archive/buckets archive.ts
POST /v1/archive/buckets archive.ts
GET /v1/archive/buckets/:id archive.ts
DELETE /v1/archive/buckets/:id archive.ts
GET /v1/archive/retention-policies archive.ts
POST /v1/archive/retention-policies archive.ts
GET /v1/archive/retention-policies/:id archive.ts
GET /v1/documents documents.ts
POST /v1/documents documents.ts
GET /v1/documents/:id documents.ts
PATCH /v1/documents/:id documents.ts
DELETE /v1/documents/:id documents.ts
POST /v1/documents/:id/anonymize documents.ts
POST /v1/documents/:id/einvoice-validate templates.ts
POST /v1/documents/:id/legal-hold documents.ts
DELETE /v1/documents/:id/legal-hold documents.ts
POST /v1/documents/:id/ocr documents.ts
GET /v1/documents/:id/ocr-text documents.ts
GET /v1/documents/audit-log documents.ts
GET /v1/documents/deletion-log documents.ts
GET /v1/documents/einvoice-validations templates.ts
GET /v1/documents/retention-report documents.ts
POST /v1/documents/search documents.ts
GET /v1/documents/templates templates.ts
POST /v1/documents/templates templates.ts
GET /v1/documents/templates/:templateId templates.ts
PATCH /v1/documents/templates/:templateId templates.ts
POST /v1/documents/templates/:templateId/generate templates.ts
POST /v1/documents/templates/:templateId/transition templates.ts
GET /v1/emails emails.ts
POST /v1/emails emails.ts
GET /v1/emails/:id emails.ts
PATCH /v1/emails/:id/assign emails.ts
POST /v1/emails/search emails.ts
GET /v1/vehicles/:vin/file vehicle-file.ts
GET /v1/vehicles/:vin/file/export vehicle-file.ts

Public API

Section titled “Public API”

Über den Modul-Index (src/index.ts) exportierte Symbole — die einzige erlaubte Zugriffsart von außen:

  • // Aggregate Roots Document
  • // Aggregate Roots - Email Archive EmailArchive
  • // DTOs - AccessLog CreateAccessLogInput
  • // DTOs - Anonymization AnonymizeDocumentInput
  • // DTOs - ArchiveBucket CreateArchiveBucketInput
  • // DTOs - DeletionRecord ListDeletionRecordsQuery
  • // DTOs - Document ArchiveDocumentInput
  • // DTOs - DocumentTemplate CreateTemplateInput
  • // DTOs - EInvoiceValidation ValidateEInvoiceInput
  • // DTOs - Email Archive ArchiveEmailInput
  • // DTOs - LegalHold SetLegalHoldInput
  • // DTOs - Retention Report RetentionReport
  • // DTOs - RetentionPolicy CreateRetentionPolicyInput
  • // DTOs - VehicleFile VehicleFile
  • // Document documentCreated
  • // Document transitions canTransitionDocument
  • // E-Invoice eInvoiceValidated
  • // Email Archive (M12-H11) emailArchived
  • // Email Assignment Resolver (M12-H11) type EmailAssignmentResolver
  • // Enums DocumentStatus
  • // Enums - Email Archive (M12-H11) EmailFormat
  • // Errors ValidationError
  • // Helper now
  • // Template documentTemplateGenerated
  • // Template transitions canTransitionTemplate
  • // Validations - Common isValidTimestamp
  • // Validations - Email Archive (M12-H11) isValidEmailFormat
  • // Validations - Enums isValidDocumentStatus
  • // Validations - Specific isValidSha256Hash
  • // Value Objects DocumentContent
  • // Value Objects - Email Archive EmailAttachment
  • // Vehicle File vehicleFileUpdated
  • AccessAction
  • AccessEntry
  • AccessLog
  • AccessLogService
  • AnonymizationService
  • AnonymizationStrategy
  • ArchiveBucket
  • ArchiveBucketAlreadyExistsError
  • … und 201 weitere

Zurück zur Modul-Übersicht oder zur Startseite.