Registry excerpt generation subsystem

🌐 This document is available in both English and Ukrainian. Use the language toggle in the top right corner to switch between versions.

1. General description

This subsystem is designed to generate excerpts from registry data from business processes based on configured templates and to store them for long-term retention.

2. Subsystem functions

  • Generation of excerpts from registry data based on configured templates.

  • Excerpt generation status verification

  • Retrieval of a user-generated excerpt from the file repository

  • Signing of generated excerpts

3. Technical design of the subsystem

The diagram below depicts the components that comprise the Registry excerpts generation subsystem and their interactions with other subsystems within the framework of functional scenarios.

excerpt overview

4. Subsystem components

Component name In the registry Origin Repository Purpose

Excerpts management service

excerpt-service-api-deployment

origin

github:/epam/edp-ddm-excerpt-service-api

Provides a REST API for creating excerpt requests, obtaining request statuses, and downloading excerpts

PDF excerpts generation service

excerpt-worker-deployment

origin

github:/epam/edp-ddm-excerpt-worker

Generates excerpts in .pdf format

CSV excerpts generation service

excerpt-worker-csv-deployment

origin

github:/epam/edp-ddm-excerpt-worker-csv

Generates excerpts in .csv format

DOCX excerpts generation service

excerpt-worker-docx-deployment

origin

github:/epam/edp-ddm-excerpt-worker-docx

Generates excerpts in .docx format

Historical excerpts generation utility

history-excerptor-job

origin

github:/epam/edp-ddm-history-excerptor

github:/epam/edp-ddm-history-excerptor-chart

Generates historical excerpts

Excerpts operational database

operational:excerpt

origin

github:/epam/edp-ddm-registry-postgres/tree/main/platform-db/changesets/excerpt

Stores the state of excerpts generation requests

Excerpts operational file repository

ceph:file-excerpt-bucket

origin

-

Stores generated and signed excerpts

Signed excerpts operational file repository

ceph:excerpt-signature-bucket [deprecated]

origin

-

Stores signed excerpts from the registry

Excerpt template operational file repository

ceph:excerpt-templates

origin

-

Stores excerpt templates

6. Subsystem quality attributes

6.1. Observability

The Registry excerpts generation subsystem supports logging and collects performance metrics for further analysis through web interfaces of relevant Platform subsystems.

For more details on subsystem designs, refer to the respective sections:

6.2. Auditability

The Registry excerpts generation subsystem records significant technical and business events related to the operation of the system by end-users using the audit event logging.