Overblik
Driftsvejledningen indeholder information der er relevant for driften af Behandlingstestamenteregister-servicen (BTR), herunder oplysninger om standard placering af log- og konfigurationsfiler, eksterne afhængigheder og fejlfinding.
I produktion består Behandlingstestamenteregister-servicen af følgende to komponenter (war-arkiv), der er deployet på en Wildfly applikationsserver:
- ltr-btr-service-wildfly: Denne afhænger af adgang til 2 MariaDB datasources. Desuden afhænger den af at kunne kalde (skrive til) MinLog-servicen.
- ltr-btr-operations: De to baggrundsjobs der hører til Behandlingstestamenteregister-servicen. Denne afhænger også af adgang til 2 MariaDB datasources.
Ændringslog
Version | Dato | Ændring | Ansvarlig |
---|---|---|---|
1.0.1 | 2018-08-17 | Initialt dokument | Trifork |
1.0.2 | 2018-08-31 | Ny release | Trifork |
1.0.3 | 2018-09-06 | Endpoints ændret fra /ltr-btr til /btr | Trifork |
1.0.4 | 2018-11-23 | Tilføjet admin endpoints | Trifork |
1.0.14 | 2019-25-09 | Ajourført | Trifork |
1.1.0 | 2020-03-24 | TreatmentWillV2 med noLifeProlongingIfDying uden angivelse af yderligere accept | KvalitetsIT |
1.1.1 | 2020-03-30 | Afvisning af yderligere accept for uafvendeligt døende på TreatmentWill-snitflade | KvalitetsIT |
1.1.3 | 2020-05-26 | Opdateret slettejob | KvalitetsIT |
1.1.7 | 2021-09-06 | Opdateret ifm. udfasning af dgws/idws-proxy. | KvalitetsIT |
1.1.8 | 2021-10-12 | Opdateret ifm. udfasning af btr-snitflade med accept fra pårørende, værge eller fremtidsfuldmægtig for uafvendeligt døende | KvalitetsIT |
1.1.9 | 2021-10-26 | Opdateret ifm inaktive cpr numre afvises | KvalitetsIT |
1.1.10 | 2022-03-19 | Genintroduceret btr-snitflade | KvalitetsIT |
1.1.11 | 2023-12-13 | SDS-6387: BTR - oprydningsjob genbesøg | KvalitetsIT |
Funktionalitet
Servicen udstiller en række data som beskrevet i anvenderguiden. Komponenten kaldes af anvendere gennem NSP'ens DCC (afkoblingskomponenten), som viderestiller kaldet til servicens webservice-endpoint. Servicen udstiller derudover en række administrative og konfigurationsrelaterede funktionaliter.
Direkte kald på service-komponenten
URL | Funktionalitet |
---|---|
<server>/btr/isAlive | Status-side for servicen. Viser om servicen fungerer korrekt, se afsnittet Overvågning. |
<server>/btr/dksconfig/ltr | Livstestamenteregistret: DCC auto-konfigurations API. Anvendes til konfiguration af NSP'ens DCC. |
<server>/btr/ltr | Livstestamenteregistret: Webservice-endpoint |
<server>/btr/btr | Behandlingstestamenteregistret: Webservice-endpoint |
<server>/btr/ltrAdmin | Livstestamenteregistret: Webservice admin-endpoint (til brug for brugerflade) |
<server>/btr/btrAdmin | Behandlingstestamenteregistret: Webservice admin-endpoint (til brug for brugerflade) |
<server>/btr/dksconfig/btr | Behandlingstestamenteregistret: DCC auto-konfigurations API. Anvendes til konfiguration af NSP'ens DCC. |
<server>/btr/wsdl | HTML-side med links til download af WSDL-filer i hhv. DGWS- og IDWS-udgave. |
<server>/btr/wsdl/ltr/dgws | Livstestamenteregistret: DGWS WSDL |
<server>/btr/wsdl/ltr/idws | Livstestamenteregistret: IDWS WSDL |
<server>/btr/wsdl/btr/dgws | Behandlingstestamenteregistret: DGWS WSDL |
<server>/btr/wsdl/btr/idws | Behandlingstestamenteregistret: IDWS WSDL |
<server>/btr/wsdl/btrV2/dgws | Behandlingstestamenteregistret version 2: DGWS WSDL |
<server>/btr/wsdl/btrV2/idws | Behandlingstestamenteregistret version 2: IDWS WSDL |
<server>/ltr-btr-operations/ltr-slettejob/start | Slettejob for LTR startes ved kald af denne url, og personer, som har været døde i et år eller mere, slettes fra LivingWill tabellen. Returnerer altid http status kode 200. Eventuelle fejl skrives i loggen. |
<server>/ltr-btr-operations/ltr-slettejob/status | Oplysninger om slettejob på den pågældende server. Oplysningerne gemmes i hukommelsen på serveren og forsvinder ved genstart. Der kan returneres følgende fra statussnitfladen: 200: Komponenten fungerer og kan anvendes. Der returneres desuden følgende oplysninger i JSON format:
|
<server>/ltr-btr-operations/btr-slettejob/start | Slettejob for BTR startes ved kald af denne url, og personer, som har været døde i et år eller mere, slettes fra TreatmentWill tabellen. Returnerer altid http status kode 200. Eventuelle fejl skrives i loggen. |
<server>/ltr-btr-operations/btr-slettejob/status | Oplysninger om slettejob på den pågældende server. Oplysningerne gemmes i hukommelsen på serveren og forsvinder ved genstart. Der kan returneres følgende fra statussnitfladen: 200: Komponenten fungerer og kan anvendes. Der returneres desuden følgende oplysninger i JSON format:
|
Daglig drift
Servicen kræver ingen daglig vedligeholdelse udover sædvanlig systemovervågning.
Alt data (inkl. historiske data) for en borger fjernes 1 år efter borgerens død ved hjælp af to slettejobs.
Overvågning
Servicen udstiller en status-side (isAlive). På denne side fremgår servicens version, opstartstidspunkt mm. samt status for slettejob.
Eksempel på et response fra status-siden:
200 OK Title: ltr-btr-service-wildfly Deployed: 2018-08-10T10:55:17.777Z Build-Date: 2018-08-10T10:52:22Z Build-Version: 1.0.1-SNAPSHOT Builder: A robot Display time: 2018-08-10T12:57:43.577Z Delete job: Enabled, Last successful deletion: 1900-01-01T00:00:00Z, Error count: 0
Status for baggrundsjobbet LTR fremgår af denne url:
curl <server>/ltr-btr-operations/ltr-slettejob/status
og for BTR:
curl <server>/ltr-btr-operations/btr-slettejob/status
Eksempel på denne statusside hvor et af jobbene er fejlet (det vil se ud på samme måde for begge jobs):
{"lastException":"An error occurred querying v2_Person_Simplified between 2022-09-26T11:06:47Z and 2022-09-26T11:11:29Z","timeOfLastExecution":"2023-09-26 13:11:29","lastExecutionSucceeded":"false"}
HTTP statuskode
Status-siden returnerer følgende HTTP statuskoder afhængig af servicens status:
- 200: Applikationen kører i øjeblikket fint.
- 500: Der er opstået en fejl, der kræver indgriben.
Fejlfinding
Følgende årsager kan resultere i en statuskode 500:
- Hvis btr eller stm databaserne ikke er tilgængelige. Der overvåges databaseadgang ved et simpelt "SELECT 1" statement. Denne query køres på alle datasources.
- Andre ukendte årsager.
Hvis status-siden giver HTTP 500 bør man checke den servicens log, som burde indeholde en detaljeret fejlmeddelelse med stacktrace.
Logning
Følgende beskrivelse af logning i servicen tager udgangspunkt i standard-opsætningen. Logning konfigureres vha. konfigurationsfilerne beskrevet i installationsvejledningen.
Alle logfiler placeres i standalone/log i Wildfly.
Alle logs benytter en rolling file appender, og indeholder derfor et postfix i filnavnet, der ikke er præsenteret i nedenstående.
Følgende tabel over logfiler beskriver, hvilke komponenter der skriver til dem:
Logfilnavn | Indhold |
---|---|
accesshandler.log | Log for accesshandler-biblioteket. |
access.log | Access-log. |
audit.log | Auditlog. Indeholder logning af, hvem der har kaldt, hvilken SOAP-action der blev kaldt, hvilken person der blev kaldt for, hvordan der blev kaldt (DGWS/IDWS) og hvornår der blev kaldt. |
btr_service.log | Applikationslog for servicen, som indeholder de vigtigste systemhændelser. Root: WARN |
nsp-kafka.log | Log for kafka-produceren, som står for skrivning til MinLog. |
nsputil-sla-btr.log | SLA-log. Indeholder SLA-logninger for alle kald på servicen. Indeholder desuden SLA-logninger for servicens kald til MinLog. |
server.log | Log for Wildfly-serveren. |
Auditlog
Der er i BTR fem kategorier af audit logs; cpr, livstestamente, behandlingstestamente, aktør og cpr validering
Følgende tabeller viser hvilke kategorier der audit logges for hver operation i BTR.
Livstestamenteregistret
Operation | Kontekst | Kategorier |
---|---|---|
UpdateLivingWill | updateLivingWill | livstestamente, aktør, cpr validering |
DeleteLivingWill | deleteLivingWill | cpr, aktør, cpr validering |
GetLivingWill | getLivingWill | livstestamente, aktør, cpr validering |
HasLivingWill | hasLivingWill | cpr, aktør, cpr validering |
Behandlingstestamenteregistret
Operation | Kontekst | Kategorier |
---|---|---|
CreateTreatmentWill | createTreatmentWill | behandlingstestamente, aktør, cpr validering |
UpdateTreatmentWill | updateTreatmentWill | behandlingstestamente, aktør, cpr validering |
DeleteTreatmentWill | deleteTreatmentWill | cpr, aktør, cpr validering |
GetTreatmentWill | getTreatmentWill | behandlingstestamente, aktør, cpr validering |
HasTreatmentWill | hasTreatmentWill | cpr, aktør, cpr validering |
Behandlingstestamenteregistret version 2
Operation | Kontekst | Kategorier |
---|---|---|
CreateTreatmentWill | createTreatmentWill | behandlingstestamente, aktør, cpr validering |
UpdateTreatmentWill | updateTreatmentWill | behandlingstestamente, aktør, cpr validering |
DeleteTreatmentWill | deleteTreatmentWill | cpr, aktør, cpr validering |
GetTreatmentWill | getTreatmentWill | behandlingstestamente, aktør, cpr validering |
HasTreatmentWill | hasTreatmentWill | cpr, aktør, cpr validering |
UpgradeToTreatmentWill | upgradeToTreatmentWill | behandlingstestamente, aktør, cpr validering |
GetTreatmentWillWithOnlyForcedTreatment | getTreatmentWillWithOnlyForcedTreatment | behandlingstestamente, aktør, cpr validering |
Følgende tabeller viser hvad der audit logges for hver af de fem kategorier.
cpr
Komponent | Kontekst | Type | Nøgle | Information |
---|---|---|---|---|
BTR | (afhængig af operation) | Personlig | cpr | CPR på borgeren |
livstestamente
Komponent | Kontekst | Type | Nøgle | Information |
---|---|---|---|---|
BTR | (afhængig af operation) | Ikke Personlig | pid | ID på livstestamente |
BTR | (afhængig af operation) | Personlig | cpr | CPR på borgeren |
BTR | (afhængig af operation) | Følsomme | no-life-prolonging-if-dying | noLifeProlongingIfDying feltet på livstestamente |
BTR | (afhængig af operation) | Følsomme | no-life-prolonging-if-severely-degraded | noLifeProlongingIfSeverelyDegraded feltet på livstestamente |
behandlingstestamente
Komponent | Kontekst | Type | Nøgle | Information |
---|---|---|---|---|
BTR | (afhængig af operation) | Ikke Personlig | pid | ID på behandlingstestamente |
BTR | (afhængig af operation) | Personlig | cpr | CPR på borgeren |
BTR | (afhængig af operation) | Følsomme | no-life-prolonging-if-dying | noLifeProlongingIfDying feltet på behandlingstestamente |
BTR | (afhængig af operation) | Følsomme | no-life-prolonging-if-dying-acceptance-needed | noLifeProlongingIfDying.acceptanceNeeded feltet på behandlingstestamente |
BTR | (afhængig af operation) | Følsomme | no-life-prolonging-if-severely-degraded | noLifeProlongingIfSeverelyDegraded feltet på behandlingstestamente |
BTR | (afhængig af operation) | Følsomme | no-life-prolonging-if-severely-degraded-acceptance-needed | noLifeProlongingIfSeverelyDegraded.acceptanceNeeded feltet på behandlingstestamente |
BTR | (afhængig af operation) | Følsomme | no-life-prolonging-if-severe-pain | noLifeProlongingIfSeverePain feltet på behandlingstestamente |
BTR | (afhængig af operation) | Følsomme | no-life-prolonging-if-severe-pain-acceptance-needed | noLifeProlongingIfSeverePain.acceptanceNeeded feltet på behandlingstestamente |
BTR | (afhængig af operation) | Følsomme | no-forced-treatment-if-incapable | noForcedTreatmentIfIncapable feltet på behandlingstestamente |
BTR | (afhængig af operation) | Følsomme | no-forced-treatment-if-incapable-acceptance-needed | noForcedTreatmentIfIncapable.acceptanceNeeded feltet på behandlingstestamente |
aktør
Komponent | Kontekst | Type | Nøgle | Information |
---|---|---|---|---|
BTR | (afhængig af operation) | Personlig | actor-cpr | CPR på aktør |
BTR | (afhængig af operation) | Personlig | actor-firstname | Fornavn på aktør |
BTR | (afhængig af operation) | Personlig | actor-lastname | Efternavn på aktør |
BTR | (afhængig af operation) | Personlig | actor-usertype | Typen af aktør |
BTR | (afhængig af operation) | Personlig | actor-authorisation-number | Autorisationsnummer på aktør |
BTR | (afhængig af operation) | Personlig | actor-education-code | Uddannelseskode på aktør |
BTR | (afhængig af operation) | Personlig | actor-organisation-id | Organisations ID på aktør |
BTR | (afhængig af operation) | Personlig | actor-organisation-id-source | Typen af organisations ID |
BTR | (afhængig af operation) | Personlig | actor-organisation-name | Organisationsnavn på aktør |
cpr validering
Følgende logges kun hvis validerings mode er sat til WARNING.
Komponent | Kontekst | Type | Nøgle | Information |
---|---|---|---|---|
BTR | validateCpr | Personlig | cpr-does-not-exist | Medsendt CPR nummer (hvis det ikke findes i CPR register) |
BTR | validateCpr | Personlig | cpr-inactive | Medsendt CPR nummer (hvis det er inaktivt) |
Minlog
Der er i BTR fire brugertyper: Borger, sundhedsfaglig, system bruger og admin bruger.
Følgende tabel viser for hvilke operationer og brugertype kombinationer, der logges til minlog (x=der logges).
Livstestamenteregistret
Operation / Brugertype | Borger | Sundhedsfaglig | System bruger | Admin bruger |
---|---|---|---|---|
UpdateLivingWill | x | x | x | |
DeleteLivingWill | x | x | x | |
GetLivingWill | x | x | ||
HasLivingWill |
Behandlingstestamenteregistret
Operation / Brugertype | Borger | Sundhedsfaglig | System bruger | Admin bruger |
---|---|---|---|---|
CreateTreatmentWill | x | x | x | |
UpdateTreatmentWill | x | x | x | |
DeleteTreatmentWill | x | x | x | |
GetTreatmentWill | x | x | ||
HasTreatmentWill |
Slettejob
Servicens slettejob bliver afviklet vha. en udstillet RestController, som kaldes vha. simpelt HTTP GET kald.
Dette gøres for at sikre afviklingen af slettejob i flere-node drift, hvor en loadbalancer sørger for fordeling af kald til bagvedliggende servere.
Driften vedligeholder en cron, som kalder slettejobbets url i et fast mønster vha. curl.
Følgende parameter til styring af slettejobbet kan ændres i application.properties for LTR:
jobs.delete.max.time=PT20S
og BTR:
jobs.delete.max.time=PT20S
Der er en max grænse for hvor lang tid jobbet må køre pr. gang og det kan angives her. Når jobbet har kørt den tid der er angivet, så stopper udførslen. Her efter kan jobbet kaldes igen og den vil fortsætte med processeringen hvor jobbet stoppede sidst.
Parameteren angives som en Duration i ISO-8601 format. Dvs. eksemplet viser 20 sekunder.
Kommando til kald af slettejob for LTR:
curl <server>/ltr-btr-operations/ltr-slettejob/start
og BTR:
curl <server>/ltr-btr-operations/btr-slettejob/start
Slettejobbet skal for LTR aktiveres hver dag, hvert 15. minut mellem 8.05-16.05 - startende kl. 8.05
Slettejobbet skal for BTR aktiveres hver dag, hvert 15. minut mellem 8.10-16.10 - startende kl. 8.10
Med mindre ovenstående parametre ændres, så vil slettejobbet behandle op til 1550 sletninger om dagen. (I gennemsnit er der 150 døde pr. døgn).
Backup
Servicen indeholder ikke nogen backup-mekanismer, og dette skal derfor konfigureres på database-niveau. Der bør foretages backup af data på en forsvarlig måde, i tilfælde af behov for en genetablering af data. Disse data skal opbevares på en forsvarlig måde, jfr. regler om personhenførbare data.