Indhold

Komponenter

Dette dokument dækker FGVHR-servicen. Der udstilles et enkelt komponent af typen SOAP Webservice og en af typen REST-service.

• Type: SOAP Webservice

• Filnavn: fgvhr.war

• Url: <serverurl>/fgvhr

• Status-url: <serverurl>/fgvhr/status

• DKS-config: <serverurl>/fgvhr/20230601/dksconfig
  
  
• Type: Webservlet
• Filnavn: fgvhr-operations.war
• Url: <serverurl>/fgvhr-operations

• Status-url: <serverurl>/fgvhr-operations/status

• Version-url: <serverurl>/fgvhr-operations/version

Konfiguration

Servicekonfiguration

Grundlæggende konfiguration foregår ved redigering i filen fgvhr.properties. Den skal placeres i WildFly modul:

/pack/wildfly8/modules/dk/nsp/fgvhr/main/

Moduldefinitionen findes i kildekoden under:

/fgvhr-war/etc/modules/dk/nsp/fgvhr/configuration/main/module.xml

I fgvhr.properties kan følgende properties defineres:

minlogclient.properties

FGVHR anvender MinLogProvider til at registrere logninger i MinLog, og i den forbindelse skal Kafka properties for MinLog konfigureres. 

log4j konfiguration

Log4j konfiguration for begge services findes i samme wildfly modul som servicekonfigurationen

Se yderligere opsætning i installationsvejledningen.

Overvågning

Der udstilles statussider, som kan tilgås fra adresserne i afsnittet Komponenter

Fortolkning af statussider

Statussiderne returnerer enten:

• HTTP 200, hvis servicen i øjeblikket kører fint.
• HTTP 503, hvis der er opstået en fejl der kræver indgriben.

Audit-logning

Hvert servicekald medfører en ny indgang i auditloggen, som kan være udfyldt med følgende komponenter, afhængig af konteksten:

{
    "time": "2023-09-07T07:32:59.492Z",
    "category": "dk.sds.nsp.audit.log.fgvhr",
    "audit": {
        "timestamp": "2023-09-07T09:32:59.429+02:00",
        "components": [
            {
                "component": "FGVHR",
                "contexts": [
                    {
                        "context": "getConsent",
                        "information": [
                            {
                                "key": "patient-id",
                                "type": "RPI",
                                "value": "0108501234"
                            },
                            {
                                "key": "patient-id-source",
                                "type": "RPI",
                                "value": "CPR"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "access": {
        "code": 200,
        "duration": 17,
        "httpHeaders": {
            "Content-Type": "text/xml;charset=UTF-8",
            "SOAPAction": "GetConsent"
        },
        "httpHost": "localhost",
        "idCardAttributes": {
            "X509Subject": "CN=NSP Test Service Consumer,SERIALNUMBER=UI:DK-O:G:8d3fa047-c77e-47e4-bdd2-e91488610ce6,O=Sundhedsdatastyrelsen,2.5.4.97=NTRDK-33257872,C=DK",
            "dk:gov:saml:attribute:AssuranceLevel": "3",
            "dk:gov:saml:attribute:CprNumberIdentifier": "0511804817",
            "dk:gov:saml:attribute:SpecVer": "DK-SAML-2.0"
        },
        "method": "POST",
        "path": "/fgvhr/20230601/service",
        "query": "",
        "port": 8080,
        "protocol": "http",
        "reqSize": 12257,
        "resSize": 642,
        "soapHeaders": {
            "Audience": "https://fsk",
            "Issuer": "TEST1-NSP-STS",
            "NameID": "dk:gov:saml:attribute:CprNumberIdentifier:0511804817",
            "w3Action": "GetConsent",
            "w3MessageID": "a0952bbd-40c2-46e4-835f-614843f48dbd"
        },
        "threadId": "default task-1",
        "time": "2023-09-07T09:32:59.429+02:00",
        "stats": {
            "handlerDuration": 44,
            "RequestContentDuration": 0,
            "ResponseContentDuration": 0,
            "SecurityProtocolRequestDuration": 8,
            "SecurityProtocolResponseDuration": 34,
            "bufferAllocated": false,
            "usedBuffers": 2,
            "activeBuffersInPool": 2,
            "idleBuffersInPool": 0
        }
    }
}

Baggrundsjobs

NAS adviseringsjob

Baggrundsjobbet har til formål at sende alle ikke-afsendte NAS-adviseringer, der er oprettet på baggrund af ændring i borgeres fravalg. Adviseringer lagres i tabellen "unsent_notifications".

Baggrundsjobbet startes med et HTTP GET kald til

<serverurl>/fgvhr-operations/nas-notification-job

Jobbet konfigureres med parametrene beskrevet i afsnittet "Servicekonfiguration".

Jobbets seneste status kan aflæses på komponentens statusside. Detaljer om de enkelte kørsler (antal rækker behandlet mm.) skrives direkte til komponentens log-fil. 

Slettejob

Detaljer omkring de forskellige trin slettejobbet har, kan findes i FGVHR Design og arkitektur dokumentet.

Servicens slettejob bliver afviklet vha. en udstillet RestController, som kaldes vha. simpelt HTTP GET kald til:

<serverurl>/fgvhr-operations/cleanup-fgvhr/start

Driften vedligeholder en cron, som kalder slettejobbets url i et fast mønster vha. curl.

Slettejobbet status kan ses, vha. HTTP GET kald til:

<serverurl>/fgvhr-operations/cleanup-fgvhr/status

Endpointet kan svare følgende

• • Httpkode 200 og Database: OK 
  • Httpkode 500 og Database: Unavailable

Slettejobbets alarmer kan ses, vha. HTTP GET kald til:

<serverurl>/fgvhr-operations/cleanup-fgvhr/alarm

Er servicens sund returneres httpkode 200 ellers 500 og en eller flere alarm linier:

• • Person Information servicen har fejlet flere gange end tilladt i en given periode.
  • Baggrundsjobbet  FGVHR Cleanup fejlede sidst det blev kørt. Problemet var:  <reason>.
  • Der er ingen forbindelse til databasen med JNDI navnet <name of jndi>

Man kan ændre styring af slettejobbet ved at ændre følgende parametre:

• deletion.desired.execution.duration=PT20S
  Det er en max grænse for hvor lang tid jobbet må køre pr. gang. 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.
• deletion.fgvhr.batchsize=1000
  Det er en max grænse for, hvor mange cpr numre, der håndteres af gangen. Blandt andet i forbindelse med kald til PersonInformation deceased og den videre sletning af fgvhr.
• deletion.save.deceased=12M
  Angiver hvor lang tid en person skal være død for at vedkommenens fravalg bliver slettet
• deletion.save.deceased.digital.post=0D
  Angiver hvor lang tid en person skal være død for at vedkommenens digital post bliver slettet. Typisk skal det slettes med det samme.
• deletion.patient.id.source.cpr=urn:oid:1.2.208.176.1.2
  Anvendes til at finde de records ud, som skal kontrolleres vha. PatientInformationService om personerne er afdøde. Der skal kun undersøges af de records, som er cpr numre.

Digital post afsendelse

Detaljer omkring de forskellige trin baggrundsjobbet har, kan findes i FGVHR Design og arkitektur dokumentet.

Servicens slettejob bliver afviklet vha. en udstillet RestController, som kaldes vha. simpelt HTTP GET kald til:

<serverurl>/fgvhr-operations/fgvhr-send-digitalpost/start

Driften vedligeholder en cron, som kalder jobbets url i et fast mønster vha. curl.

Ved aktivering er en del af handlingen at kalde over til digital post komponent.

Denne komponent anvender brevskabeloner, som skal være synkroniseret mellem de 2 komponenter. 

Ved kald til den Digitale Post Komponent, er der adgangskontrol. Det sker via 2-vejs TLS samt en IP-whitelisting, som skal ske afkoblet i NSP miljøerne via netværksinfrastrukturen.

Returnerer kaldet til Digital Post Komponent en fejl opdateres letter tabellen i databasen i dens error_counter og last_error. Returnerer kaldet til Digital Post Komponent fejl, kan detaljer omkring disse ses som error log i applikationsloggen.. Returnerer kaldet til Digital Post Komponent warnings, kan disse ses som warning log i applikationsloggen.

Jobbets status kan ses, vha. HTTP GET kald til:

<serverurl>/fgvhr-operations/fgvhr-send-digitalpost/status

Endpointet kan svare følgende

• • Httpkode 200 og Database: OK 
  • Httpkode 500 og Database: Unavailable

Jobbets alarmer kan ses, vha. HTTP GET kald til:

<serverurl>/fgvhr-operations/fgvhr-send-digitalpost/alarm

Er servicens sund returneres httpkode 200 ellers 500 og en eller flere alarm linier:

• • Person Information servicen har fejlet flere gange end tilladt i en given periode.
  • Baggrundsjobbet FGVHR Digital Post forsendelse fejlede sidst det blev kørt. Problemet var <reason>
  • Der er ingen forbindelse til databasen med JNDI navnet <name of jndi>
  • Database tabellen letter har flere records med error_counter højere end tilladt. Det nuværende antal er <count>.
  • Database tabellen letter har breve som er usendte i en længere periode en tilladt. Perioden er: <period>. Det nuværende antal er: <count>
  • Følgende fejl er forekommet for letter <uuid>: <error>
  • Følgende fejl er forekommet for letter <uuid> og <count> andre: <error>*

*) hvis flere uuid'er skrives alle uuid'er til applikationsloggen.

Man kan ændre styring af jobbet ved at ændre følgende parametre:

• digitalpost.fgvhr.schedule.error.period=2D
  Hvis der ved afsendelse af et letter opstår en fejl, rescheduleres letter med denne periode. Eksemplet viser 2 dage
• digitalpost.fgvhr.send.limit=100
  Det antal af letters, som hentes ud af databasen ad gangen. Eksemplet henter 100.
• digitalpost.fgvhr.send.desired.execution.duration=PT20S
  Det er en max grænse for hvor lang tid jobbet må køre pr. gang. 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.
• digitalpost.fgvhr.error.tolerance=0
  Angiver hvor mange letters der må ligge i databasen med fejl, før det meldes som en alarm. Eksemplet viser, at er der bare een letter med fejl, skal der rejses en alarm
  
• digitalpost.fgvhr.unsent.error.period=1D
  Angiver hvor gamle (målt på sendAt) letters må være i databasen, før det meldes som en alarm. Eksemplet viser, at et letter må ligge een dag
  
• deletion.desired.execution.duration=PT20S
  Det er en max grænse for hvor lang tid jobbet må køre pr. gang. 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.
• deletion.fgvhr.batchsize=1000
  Det er en max grænse for, hvor mange cpr numre, der håndteres af gangen. Blandt andet i forbindelse med kald til PersonInformation deceased og den videre sletning af fgvhr.
• deletion.save.deceased=12M
  Angiver hvor lang tid en person skal være død for at vedkommenens fravalg bliver slettet
• deletion.patient.id.source.cpr=urn:oid:1.2.208.176.1.2
  Anvendes til at finde de records ud, som skal kontrolleres vha. PatientInformationService om personerne er afdøde. Der skal kun undersøges af de records, som er cpr numre.