diff --git a/projects/effective-proposal-framework-and-delius/README.md b/projects/effective-proposal-framework-and-delius/README.md index b94b28d4c3..2761baca87 100644 --- a/projects/effective-proposal-framework-and-delius/README.md +++ b/projects/effective-proposal-framework-and-delius/README.md @@ -1,3 +1,13 @@ -# effective-proposal-framework-and-delius +# Effective Proposal Framework and Delius A probation integration service to share data between Ctrl-O's 'Effective Proposal Framework' system and the Delius probation case management system. + +## Context Map + +![Context Map](./tech-docs/source/img/epf-and-delius-context-map.svg) + +## Interfaces + +### HMPPS External API + +The HMPPS External API provides the gateway, access control and client relationship management for this API. diff --git a/projects/effective-proposal-framework-and-delius/tech-docs/diag/epf-and-delius-context-map.d2 b/projects/effective-proposal-framework-and-delius/tech-docs/diag/epf-and-delius-context-map.d2 new file mode 100644 index 0000000000..e69dcf5afd --- /dev/null +++ b/projects/effective-proposal-framework-and-delius/tech-docs/diag/epf-and-delius-context-map.d2 @@ -0,0 +1,42 @@ + +style { + fill: "#ffffff" +} + +context-epf: Effective Proposals Framework Context { + + entities: Entities { + grid-columns: 3 + person-on-probation: Person on Probation + sentence: Sentence + provider: Responsible Provider + } + + interface: EPF { + type: Customer + } +} + +context-delius: Delius Context { + link: https://github.com/ministryofjustice/delius + style.stroke-width: 8 + + entities: Entities { + grid-columns: 3 + event: Event + disposal: Disposal + responsible-officer: Responsible Officer + person-on-probation: Person on Probation + probation-area: Probation Area + } + interface: Effective Proposal Framework and Delius { + link: https://github.com/ministryofjustice/hmpps-probation-integration-services/tree/main/projects/effective-proposal-framework-and-delius + type: Supplier + } +} + +context-delius.interface--context-epf.interface: Upstream\n\n\nDownstream + +*.style.border-radius: 10 +*.*.style.border-radius: 10 +*.*.style.stroke-width: 2 diff --git a/projects/effective-proposal-framework-and-delius/tech-docs/source/img/epf-and-delius-context-map.svg b/projects/effective-proposal-framework-and-delius/tech-docs/source/img/epf-and-delius-context-map.svg new file mode 100644 index 0000000000..e9e6ab7fe5 --- /dev/null +++ b/projects/effective-proposal-framework-and-delius/tech-docs/source/img/epf-and-delius-context-map.svg @@ -0,0 +1,152 @@ +Effective Proposals Framework ContextDelius ContextEntitiesEPFEntitiesEffective Proposal Framework and DeliusPerson on ProbationSentenceResponsible ProviderCustomerEventDisposalResponsible OfficerPerson on ProbationProbation AreaSupplierUpstream Downstream + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +