Skip to content

Documentation update about the default config params #1465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinWheelerMT merged 1 commit into from
May 7, 2026
Merged

Documentation update about the default config params #1465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions OPERATING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Variables without a default value and not marked optional, *MUST* be defined for
| GP2GP_ROOT_LOGGING_LEVEL | WARN | The logging level applied to the entire application (including third-party dependencies). |
| GP2GP_LOGGING_LEVEL | INFO | The logging level applied to GP2GP adaptor components. |
| GP2GP_LOGGING_FORMAT | (*) | Defines how to format log events on stdout |
| GP2GP_REDACTIONS_ENABLED | false | Defines if RCMR_IN030000UK07 HL7 XML is produced when `NOPAT` `meta.security` fields are provided within the structured bundle |
| GP2GP_REDACTIONS_ENABLED | true | Defines if RCMR_IN030000UK07 HL7 XML is produced when `NOPAT` `meta.security` fields are provided within the structured bundle |

Logging levels are one of: DEBUG, INFO, WARN, ERROR

Expand Down Expand Up @@ -46,6 +46,7 @@ MongoDB provides [a table of compatible versions of their product against the Ja
| GP2GP_MONGO_AUTO_INDEX_CREATION | true | (Optional) Should auto index for Mongo database be created. |
| 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. |
| GP2GP_DOCUMENTDB_ENABLED | false | (Optional) If true the adaptor will enable features and workarounds to support AWS DocumentDB. |

**Trust Store Configuration Options**

Expand Down Expand Up @@ -98,7 +99,12 @@ The adaptor fetches patient records and documents with the GP Connect Consumer A
|--------------------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| GP2GP_GPC_GET_URL | http://localhost:8090/@ODS_CODE@/STU3/1/gpconnect | (*) The base URL of the GP Connect Consumer Adaptor. @ODS_CODE@ is a placeholder replaced in runtime with the actual ODS code of the losing practice. |
| GP2GP_GPC_STRUCTURED_FHIR_BASE | /fhir | The path segment for Get Access Structured FHIR server |
| GP2GP_GPC_MAX_REQUEST_SIZE | 150000000 (150 MB) | Buffer size when downloading data from GPC |
| GP2GP_GPC_OVERRIDE_NHS_NUMBER | | (Optional) Overrides the NHS number used for GP Connect requests. Intended for testing only. |
| GP2GP_GPC_MAX_REQUEST_SIZE | 150000000 (150 MB) | Buffer size when downloading data from GPC |
| GP2GP_REQUESTING_PRACTITIONER_SDS_USER_ID | UNK | SDS user ID used for the requesting practitioner details when constructing GP Connect requests. |
| GP2GP_REQUESTING_PRACTITIONER_SDS_ROLE_PROFILE_ID | UNK | SDS role profile ID used for the requesting practitioner details when constructing GP Connect requests. |
| GP2GP_REQUESTING_PRACTITIONER_FAMILY_NAME | ADAPTOR | Family name used for the requesting practitioner details when constructing GP Connect requests. |
| GP2GP_REQUESTING_PRACTITIONER_GIVEN_NAME | GP2GP | Given name used for the requesting practitioner details when constructing GP Connect requests. |

(*) `GP2GP_GPC_GET_URL` could be set to the base URL of a GP Connect Producer for limited testing purposes

Expand All @@ -109,7 +115,7 @@ The GP2GP uses the [MHS Adaptor](https://github.com/nhsconnect/integration-adapt
| Environment Variable | Default | Description |
|----------------------------------------------|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| GP2GP_MHS_OUTBOUND_URL | http://localhost:8081/mock-mhs-endpoint | URL to the MHS adaptor's outbound endpoint |
| GP2GP_MHS_INBOUND_QUEUE | inbound | Name of the queue for MHS inbound |
| GP2GP_MHS_INBOUND_QUEUE | gp2gpInboundQueue | Name of the queue for MHS inbound |
| GP2GP_MHS_INBOUND_QUEUE_CONSUMER_CONCURRENCY | 1 | Defines the number of concurrent mhs inbound queue consumers in a single application. https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/jms/annotation/JmsListener.html#concurrency-- |


Expand All @@ -118,6 +124,7 @@ The GP2GP uses the [MHS Adaptor](https://github.com/nhsconnect/integration-adapt
| Environment Variable | Default | Description |
|----------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| GP2GP_LARGE_ATTACHMENT_THRESHOLD | 4500000 | Value in bytes. Defines the max size of a single attachment sent to MHS. If a document is larger than this value, it's content will be split and sent in chunks. |
| GP2GP_LARGE_EHR_EXTRACT_THRESHOLD | 4500000 | Value in bytes. Defines the max size of an EhrExtract before it is split into fragments for outbound messaging. |

### MHS Adaptor and GP Connect Consumer Adaptor Client Options
Options for configuring the web client making requests to the MHS Adaptor and the GP Connect Consumer Adaptor.
Expand Down Expand Up @@ -149,6 +156,12 @@ Timeout is measured as total time for the HTTP request and response to complete.
| GP2GP_MHS_CLIENT_MIN_BACKOFF_SECONDS | 5 | Min backoff time (seconds) |
| GP2GP_MHS_CLIENT_TIMEOUT_SECONDS | 120 | Request timeout (seconds) |

### Timeout Scheduler Configuration Options

| Environment Variable | Default | Description |
|----------------------|-----------------|-----------------------------------------------------------------------------|
| TIMEOUT_CRON_TIME | 0 0 */12 * * * | Cron expression controlling how often timed-out transfers are reconciled. |

## Adaptor Process

TODO: Sequence diagram "user journey" of Spine messages, tasks, and GPCC requests
Expand Down
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,27 @@ GP2GP 2.2b producer, or those wishing to decommission their existing producer, m

1. [Guidance for setting up the GP2GP adaptors in INT](https://github.com/NHSDigital/nia-patient-switching-standard-adaptor/blob/main/getting-started-instructions.md)
1. [Guidance for operating the adaptor as a New Market Entrant](OPERATING.md)
1. [Configuration and environment defaults](#configuration-and-environment-defaults)
1. [Guidance on integrating with the adaptor's APIs](#adaptor-api)
1. [Documentation on how this adaptor maps GP Connect concepts to GP2GP concepts](https://github.com/NHSDigital/patient-switching-adaptors-mapping-documentation)

## Configuration and environment defaults

Runtime defaults are defined in `service/src/main/resources/application.yml`.
Operational guidance and full environment variable tables are documented in `OPERATING.md` under the **Configuration** section.

To avoid documentation drift, use `OPERATING.md` as the primary operator reference and `application.yml` as the runtime source of truth.

### Key defaults

- `GP2GP_REDACTIONS_ENABLED=true`
- `GP2GP_MHS_INBOUND_QUEUE=gp2gpInboundQueue`
- `GP2GP_LARGE_ATTACHMENT_THRESHOLD=4500000`
- `GP2GP_LARGE_EHR_EXTRACT_THRESHOLD=4500000`
- `GP2GP_GPC_CLIENT_TIMEOUT_SECONDS=1200`
- `GP2GP_MHS_CLIENT_TIMEOUT_SECONDS=120`
- `TIMEOUT_CRON_TIME=0 0 */12 * * *`

## Adaptor API

An API is provided to query the status of GP2GP transfers that have been processed, and initiate a resend of an
Expand Down
3 changes: 1 addition & 2 deletions docker/vars.local.e2e.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,9 @@ export GP2GP_MHS_CLIENT_MAX_BACKOFF_ATTEMPTS=0
export GPC_CONSUMER_SERVER_PORT="8090"
export GPC_CONSUMER_SDS_URL="http://wiremock:8080/spine-directory/"
export GPC_CONSUMER_SDS_APIKEY="anykey"
export GPC_CONSUMER_LOGGING_LEVEL="DEBUG"
export GPC_SUPPLIER_ODS_CODE="XYZ222"

export GP2GP_LOGGING_LEVEL="DEBUG"
export GPC_CONSUMER_LOGGING_LEVEL="DEBUG"

export MHS_MOCK_REQUEST_JOURNAL_ENABLED="true"
export MHS_MOCK_REQUEST_JOURNAL_ENABLED="true"
1 change: 0 additions & 1 deletion docker/vars.local.tests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ export GP2GP_LARGE_EHR_EXTRACT_THRESHOLD="4500000"
export GPC_CONSUMER_SERVER_PORT="8090"
export GPC_CONSUMER_SDS_URL="http://wiremock:8080/spine-directory/"
export GPC_CONSUMER_SDS_APIKEY="anykey"
export GPC_CONSUMER_LOGGING_LEVEL="DEBUG"

export GP2GP_LOGGING_LEVEL=DEBUG
export GPC_CONSUMER_LOGGING_LEVEL=DEBUG
1 change: 0 additions & 1 deletion docker/vars.public.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ export GP2GP_GPC_GET_URL="http://gpcc:8090/@ODS_CODE@/STU3/1/gpconnect"

export GPC_CONSUMER_SERVER_PORT="8090"
export GPC_CONSUMER_SDS_APIKEY="anykey"
export GPC_CONSUMER_LOGGING_LEVEL="DEBUG"

export GP2GP_LOGGING_LEVEL=DEBUG
export GPC_CONSUMER_LOGGING_LEVEL=DEBUG
Loading