Merge pull request #3803 from aldavidson/add-python-component-to-architecture-adoc

Add python component to architecture adoc

Author: misaka

docs/README.md

@@ -3,7 +3,6 @@
 This directory contains documentation for the Manage vaccinations in schools service.
 
 - [Architecture](architecture.adoc)
-- [Deployment](deployment.adoc)
 - [Offline Support](offline-support.adoc)
 - [Offline CSRF Security](offline-csrf-security.adoc)
 

docs/architecture-future.adoc

@@ -226,10 +226,6 @@ working.
 
 include::offline-support.adoc[leveloffset=+2,lines=24..-1]
 
-== Deployment
-
-include::deployment.adoc[leveloffset=+1,lines=24..-1]
-
 == Components
 
 * Authentication

docs/architecture.adoc

@@ -198,14 +198,11 @@ service using a standard login page, and as is standard with Ruby on Rails apps,
 resources are exposed with REST-like paths using an MVC approach to separate
 concerns on the server.
 
-== Deployment
-
-include::deployment.adoc[leveloffset=+1,lines=24..-1]
-
 == Components
 
 * Authentication
 * Programme management - creation, update, etc
 * Programme operations and vaccination recording
 * Offline support - Browser-based component
 * FHIR server synchronisation
+* Reporting (in development)

docs/diagrams/component-view.puml

@@ -19,6 +19,9 @@ Enterprise_Boundary(nhs, "NHS England Digital") {
       Component(webapp, "Web Application")
       Component(bgjobs, "Background Jobs")
     }
+    Container_Boundary(mavis_reporting_app, "Mavis Reporting UI", Python) {
+      Component(mavis_reporting, "Reporting interface", "Python")
+    }
     ContainerDb(database, "Database", "PostgreSQL")
   }
 
@@ -36,14 +39,15 @@ Rel(webapp, cis, "Gets user info", "OIDC")
 Rel(sais, webapp, "Uses system", "HTML, JS")
 Rel(sais, poc, "Gets vaccination records from")
 Rel(sais, webapp, "Uploads vaccination records", "CSV")
+Rel(sais, mavis_reporting, "Generates reports", "CSV")
 Rel(parents, webapp, "Responds to consent requests", "HTML, JS")
 Rel(webapp, database, "Read and write data", "Postgres, TLS")
+Rel(mavis_reporting, webapp, "Reads data from", "private REST API")
 Rel(webapp, bgjobs, "Queues jobs")
 Rel(bgjobs, database, "Read and write data", "Postgres, TLS")
 Rel(bgjobs, notify, "Send notifications to user", "REST API")
 Rel(notify, parents, "Sends notifications to", "Email, SMS")
 Rel(bgjobs, pds, "Gets NHS numbers from", "FHIR REST API")
-Rel(bgjobs, dps, "Sends vaccination records to", "MESH")
 
 
 SHOW_FLOATING_LEGEND()

docs/diagrams/container-view.puml

@@ -16,6 +16,7 @@ System_Ext(poc, "Point of care systems")
 Enterprise_Boundary(nhs, "NHS England Digital") {
   System_Boundary(manage, "Mavis") {
     Container(mavis, "Server Application", "Ruby on Rails")
+    Container(mavis_reporting, "Reporting interface", "Python")
     ContainerDb(mavis_db, "Database", "PostgreSQL")
   }
 
@@ -33,12 +34,13 @@ Rel(mavis, cis, "Gets user info", "OIDC API")
 Rel(sais, mavis, "Uses system", "HTML, JS")
 Rel(sais, poc, "Gets vaccination records from")
 Rel(sais, mavis, "Uploads vaccination records", "CSV")
+Rel(sais, mavis_reporting, "Generates reports", "CSV")
 Rel(parents, mavis, "Responds to consent requests", "HTML, JS")
 Rel(mavis, notify, "Send notifications to user", "REST API")
 Rel(notify, parents, "Sends notifications to", "Email, SMS")
 Rel(mavis, pds, "Gets NHS numbers from", "FHIR REST API")
-Rel(mavis, dps, "Sends vaccination records to", "MESH")
 Rel(mavis, mavis_db, "Reads from and writes to", "Postgres, TLS")
+Rel(mavis_reporting, mavis, "Reads data from", "private REST API")
 
 SHOW_FLOATING_LEGEND()