Page History
...
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-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.2 | 2018-08-31 | Ny release | Trifork |
| 1.0.3 | 2018-09-11 | Ændret databasedriver til MySQL | Trifork |
| 1.0.11 | 2019-08-19 | Opdateret default value for property "minlog.read-activity-text". Tilføjet SQL-script. | Trifork |
| 1.0.13 | 2019-25-09 | Ajourført | Trifork |
| 1.0.16 | 2020-05-25 | Opdateret properties til slettejob | KIT |
| 1.0.17 | 2021-12-07 | Opdateret ifm inaktive cpr numre afvises | KvalitetsIT |
| 1.0.18 | 2022-10-24 | SDS-5679: validering af alder | KvalitetsIT |
| 1.0.19 | 2023-09-26 | SDS-6386: ODR - oprydningsjob genbesøg | KvalitetsIT |
Byggevejledning
For at bygge projektet og dets deployables (war-filer) uden at køre unit-tests og integrationstests, anvendes følgende Maven kommando:
...
- 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.
...
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)
...
for servicen ses i tabellen herunder.
Komponentspecifikke-properties
| Property | Beskrivelse | Default |
|---|---|---|
| datasource.odr.jndi-name | Angiver navnet på en JNDI datasource til Organdonorregister-databasen | java:jboss/datasources/ODR-DS |
| datasource.stamdata.jndi-name | Angiver navnet på den JNDI datasource der giver adgang til en (replikeret) stamdata-database | java:jboss/datasources/STM-DS |
| dcc.endpoint | Angiver 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-text | Angiver den tekst der registreres i MinLog, når der bliver læst Organdonorregistering-data for et CPR-nummer | L\u00e6sning af Organdonorregistrering |
minlog.create-activity-text | Angiver den tekst der registreres i MinLog, når der bliver oprettet Organdonorregistering-data for et CPR-nummer | Oprettelse af Organdonorregistrering |
minlog.delete-activity-text | Angiver den tekst der registreres i MinLog, når der bliver slettet Organdonorregistering-data for et CPR-nummer | Sletning af Organdonorregistrering |
minlog.update-activity-text | Angiver den tekst der registreres i MinLog, når der bliver opdateret Organdonorregistering-data for et CPR-nummer | Opdatering af Organdonorregistrering |
| schemavalidation.validate-requests | Angiver om requests skal schema-valideres (true/false) | true |
| schemavalidation.validate-responses | Angiver om responses skal schema-valideres (true/false) | true |
| schemavalidation.fail-on-response-error | Angiver om en kald skal returnere fejl, hvis response ikke er schema-valid (true/false) | true |
| jobs.delete.cpr-max-results | Slettejob: Angiver maksimum antal rækker med opdateringer i cpr-registry der skal læses ad gangen | 25 |
| jobs.delete.cpr-max-loops | Slettejob: Angiver maksimum antal batches der skal behandles pr. jobeksekvering | 2 |
| cprexists.validationlevel | Valideringsniveau for CPR validering Eksempel: WARNING, REJECT, OFF | |
| cprexists.url | URL for CPR exist service Eksempel: http://test1-cnsp.ekstern-test.nspop.dk:8080/stamdata-cprexists | null |
| cprexists.maxTotalConnections | Konfiguration af client pool til kald af CPRExists service | 200 |
| cprexists.defaultMaxConnectionsPerRoute | Konfiguration af client pool til kald af CPRExists service | 20 |
| cprexists.inactive.status | Konfiguration af inaktive status, liste adskilt af komma | 30,50,60 |
| cprexists.minage | Aldersgrænse for oprettelse af organdonation | 15 |
| whitelisted.level3.cvrs | Komma separeret liste af cvr numre, der må kalde servicen med niveau 3 id kort | |
| allowed.idws.audience | Det tilladte audience på indkommende idws requests | |
| nas.app.name | Applikationsnavn til sla-logning ved NAS-kald | organdonorregister |
| nas.app.shortname | Kort applikationsnavn til sla-logning ved NAS-kald. | odr |
| nas.fail.theshold | Grænse for hvor mange gange NAS-kald må fejle i træk, før NAS opfattes som usund. | 1 |
| nas.connect.timeout.millis | Grænse for hvor lang tid det må tage at oprette forbindelse til NAS (i ms.). | 10000 |
| nas.read.timeout.millis | Grænse for hvor lang tid det må tage at modtage svar fra NAS (i ms.). | 10000 |
| nas.max.total.connections | Maksimalt antal samtidige NAS-forbindelser. | 200 |
| nas.default.max.connections.per.route | Maksimalt antal NAS-forbindelser per rute. | 20 |
| nas.service.url | NAS Endpoint | http://test1.ekstern-test.nspop.dk:8080/nas2/notificationbroker/service |
| nas.topic | NAS topic | http://sundhedsdatastyrelsen.dk/OrganDonation/2022/05/05:OrganDonationUpdated |
| nas.idcard.subject.id.type | Subjecttype for IDKort til NAS-kald. | medcom:cvrnumber |
| nas.idcard.subject.id | SubjectId for IDKort til NAS-kald. | 46837428 |
| nas.idcard.subject.name | Subjectname for IDKort til NAS-kald. | Funktionssignatur til testmiljø (funktionscertifikat) |
| nas.idcard.level | Sikkerhedsniveau for IDKort til NAS-kald. | 3 |
| nas.idcard.system.name | Systemnavn i IDKort til NAS-kald. | itsystem |
| nas.sts.endpoint | Endpointet, hvor Minspærring skal trække sit SOSI IDkort på baggrund af sts.keystore | http://test2.ekstern-test.nspop.dk:8080/sts/services/NewSecurityTokenService |
| nas.sts.test.mode | Boolsk værdi, der angiver om der anvendes test- eller produktions SOSIFederation | true |
| nas.sts.keystore | sti til keystore, der indeholder certifikat til at trække Idkort til NAS-kald. | Statens_Serum_Institut_FOCES.jks |
| nas.sts.keystore.password | Password til sts.keystore | n/a |
| jobs.delete.max.time | Angiver den maksimale udførelsestid for baggrundsjobbet. Angives som Duration i ISO-8601 formattet. Default værdien er på 20 sekunder. | PT20S |
minlogclient.properties
ODR anvender MinLogProvider til at registrere logninger i MinLog2, og i den forbindelse skal Kafka properties for Min Log 2 konfigureres.
| Property | Beskrivelse |
|---|---|
| kafka.producer.bootstrap.servers | Kafka endpoint, som anvendes i forbindelse med kald til MinLog2 |
| kafka.producer.client.id | Navnet som ODR vil fremgå med i listen af Producers på et Kafka Cluster. |
| kafka.producer.key.serializer | Serializer key for Kafka producer |
| kafka.producer.key.value.serializer | Serializer value for Kafka producer |
| kafka.topic | Kafka topic som anvendes i forbindelse med kald til MinLog2 |
...
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 migreringskomponent
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)
...
'et
...
.
...
...
migration.personFileName
...
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
...
Filnavn når deployet | Beskrivelse | Kilde | |||
|---|---|---|---|---|---|
odr-service-wildfly.war | ODR servicen | odr-service-wildfly-<version>.war | |||
odr- | migrationoperations.war | ODR | migeringsværktøj. Deployes kun når migrering skal foretages.baggrundsjob | odr- | migration-<version>operations.war |
Se driftsvejledningen for yderligere information.
...