Retain failed transfers for 12 weeks / 84 days (#1025)

Retain failed transfers for 12 weeks / 84 days as per spec
NHSDigital · Dec 6, 2024 · 06d0ad4 · 06d0ad4
1 parent 0ac0be2
commit 06d0ad4
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+* When a transfer fails, the transfer should remain available in the db for at least 12 weeks (84 days), as per spec.
 * When mapping a `DocumentReference` which contains a `NOPAT` `meta.security` or `NOPAT` `securityLabel` tag the resultant XML for that resource
   will contain a `NOPAT` `confidentialityCode` element.
 * When mapping `AllergyIntolerances` which contain a `NOPAT` `meta.security` tag the resultant XML for that resource

diff --git a/OPERATING.md b/OPERATING.md
@@ -40,7 +40,7 @@ The adaptor requires a Mongodb-compatible database to manage its internal state.
 | GP2GP_MONGO_PASSWORD            |                           | Mongo database password. Leave undefined if GP2GP_MONGO_URI is used.                                                                                           |
 | GP2GP_MONGO_OPTIONS             |                           | Mongodb URL encoded parameters for the connection string without a leading "?". Leave undefined if GP2GP_MONGO_URI is used.                                    |
 | GP2GP_MONGO_AUTO_INDEX_CREATION | true                      | (Optional) Should auto index for Mongo database be created.                                                                                                    |
-| GP2GP_MONGO_TTL                 | P7D                       | (Optional) Time-to-live value for inbound and outbound state collection documents as an [ISO 8601 Duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). |
+| GP2GP_MONGO_TTL                 | P84D                      | (Optional) Time-to-live value for inbound and outbound state collection documents as an [ISO 8601 Duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). |
 | GP2GP_COSMOS_DB_ENABLED         | false                     | (Optional) If true the adaptor will enable features and workarounds to support Azure Cosmos DB.                                                                |
 
 **Trust Store Configuration Options**
@@ -266,7 +266,7 @@ The adaptor's database records:
 * metadata about the transfer process
 
 The supplier MUST configure the `GP2GP_MONGO_TTL` variable to remove the database records
-after a reasonable time period.
+after a reasonable time period. The specs say 12 weeks (84 days), so this is our suggestion.
 
 The adaptor's queued messages contain:
 * the patient's NHS number

diff --git a/service/src/intTest/resources/application.yml b/service/src/intTest/resources/application.yml
@@ -43,7 +43,7 @@ gp2gp:
     password: ${GP2GP_MONGO_PASSWORD:}
     options: ${GP2GP_MONGO_OPTIONS:}
     autoIndexCreation: ${GP2GP_MONGO_AUTO_INDEX_CREATION:true}
-    ttl: ${GP2GP_MONGO_TTL:P7D}
+    ttl: ${GP2GP_MONGO_TTL:P84D}
     cosmosDbEnabled: ${GP2GP_COSMOS_DB_ENABLED:false}
   gpc:
     url: ${GP2GP_GPC_GET_URL:http://localhost:8090/@ODS_CODE@/STU3/1/gpconnect}

diff --git a/service/src/main/resources/application.yml b/service/src/main/resources/application.yml
@@ -39,7 +39,7 @@ gp2gp:
     password: ${GP2GP_MONGO_PASSWORD:}
     options: ${GP2GP_MONGO_OPTIONS:}
     autoIndexCreation: ${GP2GP_MONGO_AUTO_INDEX_CREATION:true}
-    ttl: ${GP2GP_MONGO_TTL:P7D}
+    ttl: ${GP2GP_MONGO_TTL:P84D}
     cosmosDbEnabled: ${GP2GP_COSMOS_DB_ENABLED:false}
   gpc:
     url: ${GP2GP_GPC_GET_URL:http://localhost:8090/@ODS_CODE@/STU3/1/gpconnect}