Versions Compared

Old Version 20

changes.mady.by.user Thomas Stougaard Lange

Saved on

compared with

New Version Current

changes.mady.by.user Thomas Kilden Nielsen

Saved on

Key

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

...

Dette dokument beskriver installation og konfiguration af Organdonorregister-servicen (ODR) samt tilhørende migreringsværktøj. Konfiguration af tilhørende DGWS/IDWS Proxy er også beskrevet.

Organdonorregister-servicen består af 2 komponenter følgende komponent (war-arkiverarkiv), der skal konfigureres og deployes på en applikationsserver:

  • odr-service-wildfly: Organdonorregister-servicen. War-arkiv. Servlet-baseret webservice pakket specifikt til Wildfly.

  • odr-migration: Komponent til migrering af data. Anvendes kun ved initial migrering af data fra den gamle løsning. War-arkiv. Servlet-baseret webservice pakket specifikt til Wildfly.

Projektet bygges med Maven og kræver Java 8 samt en MariaDB-installation for at kunne afvikle unit-tests.Udover normalt tilgængelige Maven dependencies, afhænger projektet også af interne artefakter. Hvis disse artefakter ikke er udgivet (released) i den påkrævede version i NSP's Nexus repository, skal man selv udtjekke og bygge dem fra NSP's Subversion i den pågældende version. Artefakternes forskellige versioner vil være tilgængelige under et Subversion-tag. Disse artefakter er:

  • cpr-subscriber (Maven identifier: dk.sds:cprsubscriber)

For at bygge disse interne artefakter, henvises der til artefakternes dokumentation.

Info

Alle filer der refereres til ligger sammen med projektets kildekode i NSP's Subversion. Referencer til stier er relative med udgangspunkt i projektets rodmappe.

...

Version

Dato

Ændring

Ansvarlig

1.0.1

2018-08-20

Initialt dokument

Trifork

1.0.22018-08-31Ny releaseTrifork
1.0.32018-09-11Ændret databasedriver til MySQLTrifork
1.0.112019-08-19Opdateret default value for property "minlog.read-activity-text". Tilføjet SQL-script.Trifork
1.0.132019-25-09AjourførtTrifork
1.0.162020-05-25Opdateret properties til slettejobKIT
1.0.172021-12-07Opdateret ifm inaktive cpr numre afvisesKvalitetsIT
1.0.182022-10-24SDS-5679: validering af alderKvalitetsIT
1.0.192023-09-26SDS-6386: ODR - oprydningsjob genbesøgKvalitetsIT

Byggevejledning

For at bygge projektet og dets deployables (war-filer) uden at køre unit-tests og integrationstests, anvendes følgende Maven kommando:

...

  • odr/V1__create_OrganDonorRegistration.sql
  • odr/V2__create_Properties.sql
  • odr/V3__add_PersonIdentifier_index.sql
  • odr/V4__create_Notification_tables.sql

(Replikeret) Stamdata-database

  • stm/R__create_v2_Person_Simplified_view.sql

 

Info

Scriptet R__create_v2_Person_Simplified_view.sql opretter et view, som afhænger af eksistensen af tabellen v2_Person. Dette er tabellen, der indeholder CPR-ændringer, og den skal man selv stå for at levere. Under afvikling af unit-tests bliver en testudgave af denne tabel automatisk oprettet vha. et SQL-script i compose/database/db/test.

...

Komponenten deployes vha. NSP's platform Docker image og konfigurationsfiler mountes i containeren som angivet i projektets Compose-filer.

odr-service-wildfly og odr-migration konfigureres ved hjælp hver deres Wildfly-modul, der indholder  indholder de nødvendige konfigurationsfiler til valg af datasources, brugerdefinerede parametre, logning, mm.  WildflyWildfly-modulet er integreret i komponentens Docker image.

...

Herunder beskrives properties i odr-service-wildfly komponentens konfigurationsfiler.

application.properties

...

Properties er her opdelt i to tabeller. Den første tabel indeholder anvendte Spring Boot-properties. Den anden tabel indeholder properties, der er specifikt defineret til brug i servicen. Begge typer af properties er defineret i samme konfigurationsfil.

Spring Boot-properties

...

JTA transaktioner. Det er påkrævet at denne er false, således at Spring Boot i stedet anvender dens egen håndtering af transaktioner. (true/false)

...

og operations.properties

Properties for servicen ses i tabellen herunder. Det er angivet hvilken property fil de er relevante for. Operations filen anvendes af komponentens baggrundsjobs.

PropertyFil

Komponentspecifikke-properties

Property
BeskrivelseDefault
datasource.odr.jndi-nameapplicationAngiver navnet på en JNDI datasource til Organdonorregister-databasenjava:jboss/datasources/ODR-DS
datasource.stamdata.jndi-nameapplicationAngiver navnet på den JNDI datasource der giver adgang til en (replikeret) stamdata-databasejava:jboss/datasources/STM-DS
dcc.endpointapplicationAngiver det endpoint, som DCC'en skal kalde. Dette kommer til at fremgå af den XML, der returneres i /dksconfig. Bør ændres før produktion.http://test1.fsk.netic.dk:8080/odr/odr
minlog.read-activity-textapplicationAngiver den tekst der registreres i MinLog, når der bliver læst Organdonorregistering-data for et CPR-nummerL\u00e6sning af Organdonorregistrering
schemavalidation

minlog.

validate-requestsAngiver om requests skal schema-valideres (true/false)trueschemavalidation.validate-responses

Angiver om responses skal schema-valideres (true/false)

trueschemavalidation.fail-on-response-error

Angiver om en kald skal returnere fejl, hvis response ikke er schema-valid (true/false)

create-activity-text

applicationAngiver den tekst der registreres i MinLog, når der bliver oprettet Organdonorregistering-data for et CPR-nummerOprettelse af Organdonorregistrering

minlog.delete-activity-text

applicationAngiver den tekst der registreres i MinLog, når der bliver slettet Organdonorregistering-data for et CPR-nummerSletning af Organdonorregistrering

minlog.update-activity-text

applicationAngiver den tekst der registreres i MinLog, når der bliver opdateret Organdonorregistering-data for et CPR-nummerOpdatering af Organdonorregistrering
true
jobs.delete.cpr-max-resultsapplicationSlettejob: Angiver maksimum antal rækker med opdateringer i cpr-registry der skal læses ad gangen25
jobs.delete.cpr-max-loopsapplicationSlettejob: Angiver maksimum antal batches der skal behandles pr. jobeksekvering2
cprexists.validationlevel

application

Valideringsniveau for CPR validering

Eksempel: WARNING, REJECT, OFF


cprexists.url

application

URL for CPR exist service

Eksempel: http://test1-cnsp.ekstern-test.nspop.dk:8080/stamdata-cprexists

null
cprexists.maxTotalConnections

application

Konfiguration af client pool til kald af CPRExists service

200
cprexists.defaultMaxConnectionsPerRoute

application

Konfiguration af client pool til kald af CPRExists service

20
cprexists.inactive.statusapplicationKonfiguration af inaktive status, liste adskilt af komma30,50,60
cprexists.minageapplicationAldersgrænse for oprettelse af organdonation15
whitelisted.level3.cvrsapplicationKomma separeret liste af cvr numre, der må kalde servicen med niveau 3 id kort
allowed.idws.audienceapplicationDet tilladte audience på indkommende idws requests

https://fsk

nas.app.nameapplicationApplikationsnavn til sla-logning ved NAS-kaldorgandonorregister
nas.app.shortnameapplicationKort applikationsnavn til sla-logning ved NAS-kald.odr
nas.connect.timeout.millisapplicationGrænse for hvor lang tid det må tage at oprette forbindelse til NAS (i ms.).20000
nas.max.total.connectionsapplicationMaksimalt antal samtidige NAS-forbindelser.200
nas.default.max.connections.per.routeapplicationMaksimalt antal NAS-forbindelser per rute.20
nas.service.urlapplicationNAS Endpointhttp://test1.ekstern-test.nspop.dk:8080/nas2/notificationbroker/service
nas.topicapplicationNAS topichttp://sundhedsdatastyrelsen.dk/OrganDonation/2022/05/05:OrganDonationUpdated
sts.idcard.subject.id.type

application

operations

Subjecttype for IDKort til ekstern komponent kald.medcom:cvrnumber
sts.idcard.subject.id

application

operations

SubjectId for IDKort til ekstern komponent kald.46837428
sts.idcard.subject.name

application

operations

Subjectname for IDKort til ekstern komponent kald.Funktionssignatur til testmiljø (funktionscertifikat)
sts.idcard.level

application

operations

Sikkerhedsniveau for IDKort til ekstern komponent kald.3
sts.idcard.system.name

application

operations

Systemnavn i IDKort til ekstern komponent kald.itsystem
sts.endpoint

application

operations

Endpointet, hvor komponenten trækker sit SOSI IDkort på baggrund af sts.keystorehttp://test2.ekstern-test.nspop.dk:8080/sts/services/NewSecurityTokenService
sts.test.mode

application

operations

Boolsk værdi, der angiver om der anvendes test- eller produktions SOSIFederationtrue
sts.keystore

application

operations

sti til keystore, der indeholder certifikat til at trække Idkort til kald af eksterne komponenter.Statens_Serum_Institut_FOCES.jks
sts.keystore.password

application

operations

Password til sts.keystoren/a
jobs.delete.max.timeapplicationAngiver den maksimale udførelsestid for baggrundsjobbet. Angives som Duration i ISO-8601 formattet. Default værdien er på 20 sekunder.PT20S
personinformation.*operationsDisse er beskrevet i driftsvejledningen
deletion.*operationsDisse er beskrevet i driftsvejledningen
digitalpost.*
Disse er beskrevet i driftsvejledningen





minlogclient.properties

ODR anvender MinLogProvider til at registrere logninger i MinLog2, og i den forbindelse skal Kafka properties for Min Log 2 konfigureres. 

PropertyBeskrivelse
kafka.producer.bootstrap.serversKafka endpoint, som anvendes i forbindelse med kald til MinLog2
kafka.producer.client.idNavnet som ODR vil fremgå med i listen af Producers på et Kafka Cluster.
kafka.producer.key.serializerSerializer key for Kafka producer
kafka.producer.key.value.serializerSerializer value for Kafka producer
kafka.topic

Kafka topic som anvendes i forbindelse med kald til MinLog2

...

nsp-role-mapping.properties

ODR anvender denne property fil til at mappe hvilken rolle (role), der kommer ned i minlog registreringen.

Property filen vedligeholdes her: https://git.nspop.dk/projects/TOOL/repos/nsp-role-mapping/browse/nsp-role-mapping.properties


PropertyBeskrivelse
citizen.user

Bestemmer hvilken rolle står beskrevet i minlog ved kald til ODR for borger

Eksempel på værdi: borger

healthcareprofessional.unknown.user

Bestemmer hvilken rolle står beskrevet i minlog ved kald til ODR for sundhedfarlig, hvor der ikke kunne bestemmes en rolle.

Eksempel på værdi: unverified role

<Uddannelseskoder>

Der angives en række uddannelseskoder med kode=læsbar tekst

Eksempler er:

C511=Ambulancebehandler
9495=Bandagist
B511=Behandlerfarmaceut
5159=Bioanalytiker
5153=Ergoterapeut

Når der logges til minlog, og rollen er en uddannelseskode, laves der mapning mellem kode og læsbar tekst. Findes koden ikke som mapning anvendes den oprindelige kode.

<Nationale Roller (NSP)>

Der angives en række nationale roller med rolle=læsbar tekst

Eksempler er:

urn:dk:healthcare:national-federation-role:code:41001:value:SundAssistR1=Sundhedsstamkort-Læser
urn:dk:healthcare:national-federation-role:code:41002:value:SundAssistR2=Sundhedsdata-Læser
urn:dk:healthcare:national-federation-role:code:41003:value:PlejeAssR3=Plejehjemsassistent
urn:dk:healthcare:national-federation-role:code:41004:value:AudiologiMedarbR4=Audiologi-Medarbejder

Når der logges til minlog, og rollen er en national rolle, laves der mapning mellem rolle og læsbar tekst. Findes rollen ikke som mapning anvendes den oprindelige rolle.

log4j.xml

Konfigurerer logning for servicen.

Der benyttes en rolling file appender, hvor størrelsen af log filerne og antallet af gemte log filer konfigureres med de to environment variable: LOG_MAX_FILE_SIZE og LOG_MAX_BACKUP_INDEX.

Standardværdierne angiver nogle brugbare niveauer for anvendelse i produktion. Se Driftsvejledningen for uddybet beskrivelse af logning.

Se den officielle Log4j 2 dokumentation for alternativ konfiguration.

...

Der henvises til accesshandlerens dokumentation for yderligere detaljer om konfiguration af security-api'et.

Konfiguration af

...

application.properties

Spring Boot-properties

...

JTA transaktioner. Det er påkrævet at denne er false, således at Spring Boot i stedet anvender dens egen håndtering af transaktioner. (true/false)

...

datasources

...

...

PersonData.csv

...

migration.organDonorFileName

...

OrganDonorData.csv

log4j2.xml

Konfigurerer logning for migreringskomponenten.

Standardværdierne angiver nogle brugbare niveauer for anvendelse til migrering i produktion. Se migeringsvejledningen for uddybet beskrivelse af logning.

Se den officielle Log4j 2 dokumentation for alternativ konfiguration.

Konfiguration af datasources

odr-service-wildfly komponenten kræver adgang til 2 JNDI datasources. Disse skal opsættes i Wildfly og refereres til i servicens application.properties.

...

migration migeringsværktøj. Deployes kun når migrering skal foretages.migration-<version>

Filnavn når deployet

Beskrivelse

Kilde

odr-service-wildfly.war

ODR servicen

odr-service-wildfly-<version>.war

odr-

operations.war

ODR

baggrundsjob

odr-

operations.war

Se driftsvejledningen for yderligere information.

...