Skip to content

Commit 801e11f

Browse files
committed
#663 - Standardized API endpoint to serve configuration for the frontend
- move static variables for the settings controller from app.guiinfo to passthrough - add variable description to README.md
1 parent 2a93187 commit 801e11f

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,17 @@ To configure the location of the external service, use the following parameters.
153153
| ELASTIC_SEARCH_HOST | Host and port of the elastic search endpoint | `192.168.1.1:9200` | `localhost:9200` |
154154
| ELASTIC_SEARCH_FILTER | Which parameters can be used to filter results | `foo,bar,baz` | `context,terminology,kds_module` |
155155

156+
### Passthrough Variables
157+
158+
There are a few variables that are not used in the backend itself, but are forwarded to the frontend if requested.
159+
160+
161+
| EnvVar | Description | Example | Default |
162+
|-----------------------------|------------------------------------------------------------------|-------------------|-----------------------------------------------------------------------------------------------------------------|
163+
| PT_CCDL_VERSION | The used version of the Clinical Cohort Definition Language | `` | `unknown` |
164+
| PT_PORTAL_LINK | URL to the portal page | `https://foo.bar` | `https://antrag.forschen-fuer-gesundheit.de` |
165+
| PT_DSE_PATIENT_PROFILE_URL | URL of the patient profile used in data selection and extraction | `foo,bar,baz` | `https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/PatientPseudonymisiert` |
166+
156167
## Support for self-signed certificates
157168

158169
The dataportal backend supports the use of self-signed certificates from your own CAs.

src/main/java/de/numcodex/feasibility_gui_backend/settings/SettingsController.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public class SettingsController {
2424
private static final String KEY_REST_API_PATH = "uiBackendApiUrl";
2525

2626

27-
@Value("${app.guiInfo.dsePatientProfileUrl}")
27+
@Value("${passthrough.dsePatientProfileUrl}")
2828
private String dseUrl;
2929

3030
@Value("${app.privacy.threshold.sites}")
@@ -39,10 +39,10 @@ public class SettingsController {
3939
@Value("${app.privacy.quota.read.resultSummary.pollingInterval}")
4040
private String pollingTime = "PT20S";
4141

42-
@Value("${app.guiInfo.portalLink}")
42+
@Value("${passthrough.portalLink}")
4343
private String portalLink;
4444

45-
@Value("${app.guiInfo.ccdlVersion}")
45+
@Value("${passthrough.ccdlVersion}")
4646
private String ccdlVersion = "version";
4747

4848

src/main/resources/application.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,6 @@ app:
7373
queryResultExpiry: ${QUERYRESULT_EXPIRY:PT1M}
7474
maxSavedQueriesPerUser: ${MAX_SAVED_QUERIES_PER_USER:10}
7575
purgeExpiredQueries: ${PURGE_EXPIRED_QUERIES:0 0 * * * *}
76-
guiInfo:
77-
ccdlVersion: ${CCDL_VERSION:unknown}
78-
portalLink: ${PORTAL_LINK:https://antrag.forschen-fuer-gesundheit.de}
79-
dsePatientProfileUrl: ${DSE_PATIENT_PROFILE_URL:https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/PatientPseudonymisiert}
8076
export:
8177
csv:
8278
delimiter: ${EXPORT_CSV_DELIMITER:;}
@@ -153,7 +149,10 @@ app:
153149
pollingInterval: ${PRIVACY_QUOTA_READ_DETAILED_OBFUSCATED_POLLINGINTERVAL:PT10S}
154150
amount: ${PRIVACY_QUOTA_READ_DETAILED_OBFUSCATED_AMOUNT:3}
155151
interval: ${PRIVACY_QUOTA_READ_DETAILED_OBFUSCATED_INTERVAL:PT2H}
156-
152+
passthrough:
153+
ccdlVersion: ${PT_CCDL_VERSION:unknown}
154+
portalLink: ${PT_PORTAL_LINK:https://antrag.forschen-fuer-gesundheit.de}
155+
dsePatientProfileUrl: ${PT_DSE_PATIENT_PROFILE_URL:https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/PatientPseudonymisiert}
157156
logging:
158157
level:
159158
org.hibernate: ${LOG_LEVEL_SQL:warn}

0 commit comments

Comments
 (0)