Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP/1.1 200 OK Database : OK 

rapportere om slettejobbets er klar til at modtage kald. Se detaljer i senere afsnit.

HTTP/1.1 500 Internal Server Error Baggrundsjobbet StackedOperationsService fejlede sidst det blev kørt. Problemet var: Data for CPR-nummeret kunne ikke findes, fordi kaldet til PersonInformation-servicen returnerede en uventet statuskode: 409. Person Information servicen har fejlet flere gange end tilladt i en given periode

.

URL

Funktionalitet

<server>/odr/status

Status-side for servicen. Viser om servicen fungerer korrekt, se afsnittet Overvågning.

<server>/odr/alarm

Alarm-side for servicen. Viser om der er valideringsfejl i servicen, se afsnittet Overvågning.

<server>/odr/odr
Webservice-endpoint
<server>/odr/odrAdmin
Webservice admin-endpoint (til brug for brugerflade)
<server>/odr/dksconfig
DCC auto-konfigurations API. Anvendes til konfiguration af NSP'ens DCC.
<server>/odr/wsdl
HTML-side med links til download af WSDL-filer i hhv. DGWS- og IDWS-udgave.
<server>/odr/wsdl/dgws
DGWS WSDL
<server>/odr/wsdl/idws
IDWS WSDL
<server>/odr-operations/odr-slettejob/deceased/start
Baggrundsjob til sletning af døde startes ved kald af denne url. Returnerer altid http status kode 200. Eventuelle fejl skrives i loggen.
<server>/odr-operations/odr-slettejob/emigrated/start
Baggrundsjob til oprydning ift. udrejste startes ved kald af denne url. Hvis person har en aktiv registrering, så tjekkes dem om denne person er udrejst. Hvis dette er tilfældet, så sættes VALIDTO-datoen til afviklingstidspunktet.
Returnerer altid http status kode 200. Eventuelle fejl skrives i loggen.
<server>/odr-operations/odr-slettejob/status

Dette kald verificerer databaseadgang.

Der kan returneres følgende fra statussnitfladen:

200: Der er adgang til databasen og jobbet kan anvendes.
5xx: Komponenten melder at den ikke kan anvendes.

Code Block
languagebash
<server>/odr-operations/odr-slettejob/alarm

Dette kald verificerer services, eksterne kald og databaseadgange.

Denne service indeholder kun data, hvis der er alarmer.

200: Komponenten fungerer og der er ingen alarmer.
5xx: Komponenten melder at den ikke kan anvendes.

Følgende er et ekempel på et svar, hvor personinformationservice ikke er tilgængelig.

rapportere om slettejobbet er i en tilstand, der kræver indgriben fra driften.


<server>/odr-operations/odr-send-digitalpost-notification/start

Baggrundsjob til at sende notifikationer til personer, som skal have en påmindelse om organ donation. Se detaljer i senere afsnit.

<server>/odr-operations/odr-send-digitalpost-notification/status

Dette kald rapportere om notifiationsjobbets er klar til at modtage kald. Se detaljer i senere afsnit.

<server>/odr-operations/odr-send-digitalpost-notification/alarm

Dette kald rapportere om notifikationsjobbet er i en tilstand, der kræver indgriben fra driften

Code Block
languagebash

Daglig drift

Servicen kræver ingen daglig vedligeholdelse udover sædvanlig systemovervågning.

...

Parameteren angives som en Duration i ISO-8601 format. Dvs. eksemplet viser 20 sekunder.

OrganDonorEmigratedCleanup

Baggrundsjobbet kaldes når der skal ryddes op registreringer for person der er udrejste.


Status og alarm endpoints

Kommando til kald af slette job status og alarmKommando til kald af slettejob:

Code Block
languagebash
titleKommando
curl <server>/odr-operations/odr-slettejob/emigrated/start

Følgende parametre til styring af OrganDonorEmigratedCleanup kan ændres i operations.properties for ODR:

...

deletion.desired.execution.duration.emigrated

...

PT20S

...

Den tid vi ønsker at bruge på sletning ved hvert request. Tiden er ikke garanteret, da vi kun tjekker mod den efter hver StackOperation er udført.

Default værdien er 20 sekunder.

...

deletion.batchsize.emigrated

...

1000

...

Max. antal entries (f.eks. CPR) vi behandler pr. batch

...

personinformation.batchsize.emigrated

...

1000

...

Max. antal CPR vi forespørger på i en enkelt request til personinformation

/status
curl <server>/odr-operations/odr-slettejob/alarm


Status kaldet verificerer databaseadgang. Der kan returneres følgende fra statussnitfladen:

200: Der er adgang til databasen og jobbet kan anvendes.

5xx: Komponenten melder at den ikke kan anvendes.

Code Block
languagebash
HTTP/1.1 200 OK
Database : OK 


Alarm kaldet verificerer services, eksterne kald og databaseadgange. Denne service indeholder kun data, hvis der er alarmer.

200: Komponenten fungerer og der er ingen alarmer.

5xx: Komponenten melder at den ikke kan anvendes.


Følgende er et ekempel på et svar, hvor personinformationservice ikke er tilgængelig.

Code Block
languagebash
HTTP/1.1 500 Internal Server Error
Baggrundsjobbet StackedOperationsService fejlede sidst det blev kørt. Problemet var: Data for CPR-nummeret kunne ikke findes, fordi kaldet til PersonInformation-servicen returnerede en uventet statuskode: 409.
Person Information servicen har fejlet flere gange end tilladt i en given periode.


OrganDonorEmigratedCleanup

Baggrundsjobbet kaldes når der skal ryddes op registreringer for person der er udrejste.

Kommando til kald af slettejob

Der er en max grænse for hvor lang tid jobbet må køre pr. gang (deletion.desired.execution.duration.emigrated) 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.

OrganDonorNotification

Baggrundsjobbet kaldes når der skal sendes notificationer til personer omkring påmindelser om organdonation. For nuværende er det notifikationer til personer der snart bliver 18 år.

Kommando til kald af notifikationer:

Code Block
languagebash
titleKommando
curl <server>/odr-operations/odr-send-digitalpost-notificationslettejob/emigrated/start

...


Følgende parametre til styring af OrganDonorNotification af OrganDonorEmigratedCleanup kan ændres i operations.properties for ODR:

NøgleDefault værdiBeskrivelse
digitalpost

deletion.desired.

notification

execution.

odr

digitalpost.notification.odr.send.desired.execution.duration

PT20S

duration.

startdate

Den dato, hvor jobbet skal være aktivt første dag.

Hvis jobbet køres før denne dato, vil der ikke blive sendt nogle notifikationer.

emigrated

PT20S

Den tid vi ønsker at bruge på sletning ved hvert request.

Tiden

 Tiden er ikke garanteret, da vi kun tjekker mod den efter hver StackOperation er udført.

Parameteren angives som en Duration i ISO-8601 format

Default værdien er 20 sekunder.

digitalpost

deletion.

notification.odr.send.limit

batchsize.emigrated

1000

Max. antal entries (

antal notifikationer) vi henter op fra dagens udtrukne personer

digitalpost.notification.odr.legalage.periode.year

P18Y

For udtræk af personer på deres fødselsdato.

Det antal år personen skal være når notifikationen sendes ud

Parameteren angives som en Duration i ISO-8601 format i år

digitalpost.notification.odr.legalage.offset.days

P2D

For udtræk af personer på deres fødselsdato.

En buffer periode i dage, hvornår notifikationen sendes ud før personen har fødselsdag

f.eks. CPR) vi behandler pr. batch

personinformation.batchsize.emigrated

1000

Max. antal CPR vi forespørger på i en enkelt request til personinformation

Der er en max grænse for hvor lang tid jobbet må køre pr. gang (deletion.desired.execution.duration.emigrated) 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

...

.

...

For udtræk af personer på deres fødselsdato.

Den brevskabelon, som anvendes for dem som ikke har taget stilling til organdonation

...

digitalpost.notification.odr.descided

...

For udtræk af personer på deres fødselsdato.

Den brevskabelon, som anvendes for dem som har taget stilling til organdonation

...

digitalpost.notification.odr.alarm.date.period

...

P3D

Status og alarm endpoints

Kommando til kald af notifikationers status og alarm:

...

languagebash
titleKommando

...

Dvs. eksemplet viser 20 sekunder.

Status og alarm endpoints

Se for OrganDonorDeceasedCleanup.

OrganDonorNotification

Baggrundsjobbet kaldes når der skal sendes notificationer til personer omkring påmindelser om organdonation. For nuværende er det notifikationer til personer der snart bliver 18 år.

Kommando til kald af notifikationer:

Code Block
languagebash
titleKommando
curl <server>/odr-operations/odr-send-digitalpost-notification/start


Parametre

Følgende parametre til styring af OrganDonorNotification kan ændres i operations.properties for ODR:

NøgleDefault værdiBeskrivelse

digitalpost.notification.odr.startdate


Den dato, hvor jobbet skal være aktivt første dag.

Hvis jobbet køres før denne dato, vil der ikke blive sendt nogle notifikationer.

digitalpost.notification.odr.send.desired.execution.duration

PT20S

Den tid vi ønsker at bruge på hvert request. Tiden er ikke garanteret, da vi kun tjekker mod den efter hver StackOperation er udført.

Parameteren angives som en Duration i ISO-8601 format

Default værdien er 20 sekunder.

digitalpost.notification.odr.send.limit

1000

Max. antal entries (antal notifikationer) vi henter op fra dagens udtrukne personer

digitalpost.notification.odr.legalage.periode.year

P18Y

For udtræk af personer på deres fødselsdato.

Det antal år personen skal være når notifikationen sendes ud

Parameteren angives som en Duration i ISO-8601 format i år

digitalpost.notification.odr.legalage.offset.days

P2D

For udtræk af personer på deres fødselsdato.

En buffer periode i dage, hvornår notifikationen sendes ud før personen har fødselsdag.

Parameteren angives som en Duration i ISO-8601 format i dage

digitalpost.notification.odr.template.undecided


For udtræk af personer på deres fødselsdato.

Den brevskabelon, som anvendes for dem som ikke har taget stilling til organdonation

digitalpost.notification.odr.descided


For udtræk af personer på deres fødselsdato.

Den brevskabelon, som anvendes for dem som har taget stilling til organdonation

digitalpost.notification.odr.alarm.date.period

P3D

Angiver hvor alarm jobbet skal begynde at rapportere fejl at noget ikke er sendt

Parameteren angives som en Duration i ISO-8601 format i dage

Status og alarm endpoints

Kommando til kald af notifikationers status og alarm:

Code Block
languagebash
titleKommando
curl <server>/odr-operations/odr-send-digitalpost-notification/status
curl <server>/odr-operations/odr-send-digitalpost-notification/alarm


Der er følgende status og alarm check i notifikations jobbet

HealthindicatorUdførsel/resultatStatusIndicator tekstAlarmIndicator tekstKonfiguration (property)

DBHealthIndicator

Udførsel

Kalder databasen med "select 1"

Kalder databasen med "select 1"datasource.odr.jndi-name=java:jboss/datasources/ODR-DS

Status 200

{"Database":"OK"}


Status 500

{"Database":"Unavailable"}

Der er ingen forbindelse til databasen med JNDI navnet <jndi>
StackedOperationsService
(organDonorNotificationService)

Udførsel


Tjekker om den seneste kørsel af jobbet afsluttede med success

Status 200



Status 500


Baggrundsjobbet StackedOperationsService fejlede sidst det blev kørt. Problemet var: <exception>.
NewestNotificationHealthIndicator

Udførsel

Henter den nyeste record fra tabel NotificationDate med status Completed

Tjekker om den seneste Completed record i NotificationDate ligger tidligere end det er tilladt at komme bagud.digitalpost.notification.odr.alarm.date.period=P3D

Status 200

{"Nyeste færdigbehandlede dato":"Ingen"} eller

{"Nyeste færdigbehandlede dato":"<dato>"}



Status 500

na - svarer altid 200

Der er ikke færdigbehandlet en dato den: <dato>. Den er ældre end <dage> dage gammel.
StatusNotificationHealthIndicator

Udførsel

For hver status type hentes antal records fra tabel NotificationPerson

For hver status type (undtagen Completed) hentes antal records fra tabel NotificationPerson. Hvis dette antal  er større end 0 og den seneste Completed record i NotificationDate ligger tidligere end det er tilladt at komme bagud.

digitalpost.notification.odr.alarm.date.period=P3D

Status 200

{"Antal i NotificationPerson med status <status>":"<antal>"}


Status 500

na - svarer altid 200

Der ligger <antal> notifikationer fra den <dato> med status <status>.
ErrorNotificationHealthIndicator

Udførsel


Tjekker om der ligger records i tabel NotificationPerson, som har status Error.

Status 200


 

Status 500


Der ligger totalt <antal> notifikationer med status Error.
PersonInformationHealthIndicator

Udførsel


Tjekker antal fejl inden for en given periode ikke overstiger maks

personinformation.error.tolerance=0

personinformation.errorcount.duration=PT10M

Status 200



Status 500


Person Information servicen har fejlet flere gange end tilladt i en given periode.
DigitalPostHealthIndicator

Udførsel


Tjekker antal fejl inden for en given periode ikke overstiger maks

digitalpost.error.tolerance=0

digitalpost.errorcount.duration=PT10M

Status 200



Status 500


Digital Post Adapter servicen har fejlet flere gange end tilladt i en given periode.


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.