Skip to content

Commit 6aee7ca

Browse files
samgibsonmojryankearsley-moj
authored andcommitted
Include API and Visualiser clarification in README architecture section
1 parent 292cb0b commit 6aee7ca

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@ HMPPS Creating Future Opportunities (CFO) - Data Management System (DMS). It is
1313
## Architecture
1414
CFO DMS is built as a microservices architecture using .NET Aspire for orchestration. Data flows through the following pipeline:
1515

16-
**File Ingestion → Parsing → Staging → Import → Running Picture → Matching → Clustering**
16+
**File Ingestion → Parsing/Cleaning → Staging → Import → Running Picture → Matching → Clustering**
1717

1818
1. **FileSync** monitors MinIO/S3/FileSystem storage and syncs incoming files
19-
2. **Parsers** (Offloc, Delius) transform raw PNOMIS and NDelius files into structured records in staging databases
19+
2. **Parsers/Cleaners** (Offloc, Delius) transform raw PNOMIS and NDelius files into structured records in staging databases
2020
3. **Import** validates and migrates data from staging to running picture databases
2121
4. **Matching Engine** identifies and links related offender records across systems
22-
5. **Cluster database** maintains grouped offender data for downstream consumers (e.g., CATS)
22+
5. **Cluster database** maintains grouped offender data
23+
6. **API** exposes the processed data via REST endpoints for downstream consumers (e.g., CATS)
24+
7. **Visualiser** provides a web UI for exploring and visualising relationships between offender data
2325

2426
Supporting services include **DbInteractions** (complex database operations), **Blocking** (matching rules), **Cleanup** (data maintenance), and **Logging**. Services communicate asynchronously via RabbitMQ message queues.
2527

0 commit comments

Comments
 (0)