Dette dokument beskriver installation og konfiguration af Det Fælles Stamkort-servicen (FSK) samt den tilhørende konfiguration af dokumentdelingsservicen (DDS).
FSK-servicen består af én komponent (war-arkiv), der skal konfigureres og deployes på en applikationsserver:
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:
For at bygge disse interne artefakter, henvises der til artefakternes dokumentation.
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 |
|---|---|---|---|
2.0.0 | 2018-08-16 | Initialt dokument | Trifork |
| 2.0.8 | 2019-08-16 | Opdateret properties med konfiguration af Spring Boot Actuator. Opdateret default value for property "minLog.readActivity.text". | Trifork |
| 2.0.9 | 2019-25-09 | Ajourført | Trifork |
| 2.0.11 | 2019-12-16 | Ajourført | Trifork |
| 2.0.12 | 2021-05-25 | Tilføjet author properties | KvalitetsIT |
| 2.0.13 | 2021-08-20 | Fjernet reference til SyncJob og tabel Properties | KvalitetsIT |
For at bygge projektet og dets deployables (war-filer) uden at køre unit-tests og integrationstests, anvendes følgende Maven kommando:
mvn clean install -DskipTests
Projektets deployables ender i target-mappen under de respektive moduler.
Unit-testene i projektet kan afvikles med følgende Maven-kommando:
mvn clean test
Alternativt kan også samtidigt bygge projektet ved at anvende Maven-kommandoen:
mvn clean install
Komponenten er tilpasset at kunne indgå i det aktuelt gældende CI-miljø på NSP. Det tager aktuelt udgangspunkt i version 1 af NSP's platform Docker image.
I miljøer med flere app-servere er det vigtigt at servicens interne job ikke kører i flere inkarnationer, da der så kan opstå "race conditions". Derfor bør det sikres at synkroniseringsjobbet kun kaldes fra een server.
Servicen er testet mod MariaDB version 10.1, som bliver brugt på NSP platformen.
Bemærk, ved unittest anvendes en in-memory H2 database, som automatisk startes op, når unittests køres.
Der stilles ikke nogle særlige minimumskrav til hardware, men man skal forvente at bruge high-end hardware (både cpu, ram, netkort og diske) for at kunne opfylde de gældende svartidskrav på NSP.
Herunder beskrives servicens tilgang til database samt oprettelse af tabeller og views.
Servicen kræver en enkelt database til dens egen data.
Servicen konfigureres med en datasource, som tilgår databaserne vha. separat specificerede brugere.
Databasebrugeren, der tilgår servicens egen database, skal være tildelt følgende rettigheder:
Datamodellen styres vha. inkrementelle SQL-scripts, der kan findes under compose/database/db/migration/fsk og indeholder scripts til at køre på servicens database.
Scripterne er udformet til at blive kørt med databasemigreringsværktøjet Flyway, og afvikles automatisk under Maven-byg. |
I produktion anvendes scripterne manuelt og skal køres på databasen i inkrementel rækkefølge baseret på versionsnummeret i filnavnet (først V1__(...).sql, dernæst V2__(...).sql, osv.). Hvert script må aldrig køres mere end én gang; der gælder dog en undtagelse for ikke-versionerede scripter, hvis filnavne begynder med R, som står for Repeatable. Disse Repeatable scripter skal køres hver gang deres indhold (checksum) er blevet ændret, men de må først køres efter alle versionerede scripter er blevet kørt.
Ved initial installation af servicen vil det således være følgende scripter, der skal køres i den nedenstående rækkefølge:
Scripterne R__create_v2_Person_Simplified_view.sql og R__create_Yderregister_v3_Simplified_view.sql opretter views, som afhænger af eksistensen af tabellerne v2_Person og Yderregister_v3. Disse tabeller 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.
fsk-service konfigureres ved hjælp af et Wildfly-modul, der indholder de nødvendige konfigurationsfiler til valg af datasources, brugerdefinerede parametre, logning, mm. Wildfly-modulet er integreret i komponentens Docker image.
Alle konfigurerbare properties bør gennemgås inden idriftsættelse, men standardværdierne er tiltænkt anvendelse i produktion medmindre andet er angivet. |
Herunder beskrives properties i fsk komponentens konfigurationsfiler.
Følgende tabel indeholder properties, der er specifikt defineret til brug i servicen. Komponentspecifikke-properties
| Property | Beskrivelse | Forslået værdi | Default |
|---|---|---|---|
| health.certificate-expires-warning | Angiver antal dage, inden anvendte certifikater udløber, hvorfra komponentens statusside vil begynde at vise en advarsel. | 30 | |
| author.institution.root | Angiver author institution root id ved oprettelse af stamkort i fsk. | 1.2.208.176.1.1 | 1.2.208.176.1.1 |
| author.institution.extension | Angiver author institution extension ved oprettelse af stamkort i fsk. | 1126211000016009 | 1126211000016009 |
| author.institution.assigningAuthorityName | Angiver author institution autorityname ved oprettelse af stamkort i fsk. | SOR | SOR |
| author.institution.name | Angiver navn på author institution ved oprettelse af stamkort i fsk. | Fælles Stamkort udstedelse | Fælles Stamkort udstedelse |
| datasource-fsk.jndi-name | Angiver navnet på den primære JNDI datasource | java:jboss/datasources/FSK-DS | |
| datasource-stamdata.jndi-name | Angiver navnet på den JNDI datasource der giver adgang til en (replikeret) stamdata-database | java:jboss/datasources/STM-DS | |
| spring.flyway.enabled | Angiver om servicen selv sørger for opgradering af databasen (hvilket kræver at “fsk-service”-brugeren har privilegier til DDL, samt at inkrementelle SQL-scripts er tilgængelige i WAR-filen). Bør være false. | false | |
| sts.endpoint | Adresse på NSP'ens SecurityTokenService. | http://test1.ekstern-test.nspop.dk:8080/sts/services/NewSecurityTokenService | |
| sts.connect.timeout.millis | Connect-timeout mod STS (ms) | ||
| sts.read.timeout.millis | Read-timeout mod STS (ms) | ||
| sts.keystore | Angiver hvilken keystore, ser anvendes til at trække systemidkort (til anvendelse ved DGWS kald til samarbejdende services). | NSP_Service_Consumer_sds.p12 | |
| sts.keystore.password | Password til ovennævnte keystore. | Test1234 | |
| sts.idcard.subject.id | Organisationsid i form af CVR-nummer. | 33257872 | |
| sts.idcard.subject.name | Organisationsnavn. Dette skal være navnet på den organisation, der matcher CVR nummeret angivet i sts.idcard.subject.id | Sundhedsdatastyrelsen | |
| sts.idcard.system.name | Systemnavn til indlejring i systemidkort | FSK | |
| dgwsclient.pool.size | Antal parallelle kald, der kan maksimalt anvendes til kald til de underliggende services SCES, SKR, LTR, BTR og ODR. | 50 | |
| dgwsclient.timeout.millis | Timeout (ms) for tråde, der anvendes til kald til de underliggende services SCES, SKR, LTR, BTR og ODR. Bør være større end de read-timeout-millis, der kan angives for de enkelte services. | 10000 | |
| sces.enable | Enable/disable SCES integration | true | true |
| sces.endpoint | Endpoint til CPR-Enkeltopslag | http://test1.ekstern-test.nspop.dk:8080/stamdata-cpr-ws/service/DetGodeCPROpslag-1.0.4 | |
| sces.connect.timeout.millis | Connect-timeout mod CPR-enkeltopslag (ms) | 2000 | 5000 |
| sces.read.timeout.millis | Read-timeout mod CPR-enkeltopslag (ms) | 7000 | 10000 |
| odr.enable | Enable/disable integration til organdonorregistret | true | true |
| odr.endpoint | Endpoint til organdonorregister | http://localhost:8080/odr/odr | |
| odr.connect.timeout.millis | Connect-timeout mod organdonorregistret (ms) | 2000 | 5000 |
| odr.read.timeout.millis | Read-timeout mod organdonorregistret (ms) | 7000 | 10000 |
| ltr.enable | Enable/disable integration til livstestamenteregistret | true | true |
| ltr.endpoint | Endpoint til livstestamenteregister | http://localhost:8080/ltr-btr/ltr | |
| ltr.connect.timeout.millis | Connect-timeout mod livstestamenteregistret (ms) | 2000 | 5000 |
| ltr.read.timeout.millis | Read-timeout mod livstestamenteregistret (ms) | 7000 | 10000 |
| btr.startdatetime | Tidspunkt for, hvornår FSK servicen begynder at foretage kald til behandlingstestamenteregisterservicen (såfremt integrationen er enabled). Dette angives som et dato/klokkeslæt i lokal tid på format yyyy-MM-dd HH:mm:ss. | 2019-01-01 00:00:00 | 2019-01-01 00:00:00 |
| btr.enable | Enable/disable integration til behandlingstestamenteregistret | true | true |
| btr.endpoint | Endpoint til behandlingstestamenteregister | http://localhost:8080/ltr-btr/btr | |
| btr.connect.timeout.millis | Connect-timeout mod behandlingstestamenteregistret (ms) | 2000 | 5000 |
| btr.read.timeout.millis | Read-timeout mod behandlingstestamenteregister (ms) | 7000 | 10000 |
| skr.enable | Enable/disable integration til stamkortregistret | true | true |
| skr.endpoint | Endpoint til stamkortregister | http://localhost:8080/skr/skr | |
| skr.connect.timeout.millis | Connect-timeout mod stamkortregistret (ms) | 2000 | 5000 |
| skr.read.timeout.millis | Read-timeout mod stamkortregistret (ms) | 7000 | 10000 |
| syes.endpoint | Endpoint til Stamdata Yder EnkeltopslagsService | http://localhost:8080/syes/syes | |
| syes.connect.timeout.millis | Connect-timeout mod Stamdata Yder EnkeltopslagsService (ms) | 2000 | 5000 |
| syes.read.timeout.millis | Read-timeout mod Stamdata Yder EnkeltopslagsService (ms) | 7000 | 10000 |
| call.sces.status.30 | Fejl der returneres når CPR-nummeret har status 30 | Det er ikke muligt at hente stamkortet, da CPR-nummeret er inaktivt | |
| call.sces.status.50 | Fejl der returneres når CPR-nummeret har status 50 | Det er ikke muligt at hente stamkortet, da CPR-nummeret er inaktivt | |
| call.sces.status.60 | Fejl der returneres når CPR-nummeret har status 60 | Det er ikke muligt at hente stamkortet, da CPR-nummeret er inaktivt | |
| call.sces.status.90 | Fejl der returneres når CPR-nummeret har status 90 | Det er ikke muligt at hente stamkortet, da borgeren er afgået ved døden for mere end 1 år siden | |
| deletion.fsk.batchsize | Angiver den maksimale antal cpr numre, som behandles per gang | ||
| desired.execution.duration | Angiver den maksimale udførelsestid for baggrundsjobbet. Angives som Duration i ISO-8601 formattet. | ||
| deletion.save.deceased | Angiver period på, hvor længe en person minimum skal være død for at blive slettet af slettet jobbet. Formatet er D for dage, M for måneder og Y for år. Nogle eksempler: 2Y er 2 år, 12M er 12 måneder og 60D er 60 dage. | ||
| personinformation.url | URL for PersonInformation service Eksempel: http://test1-cnsp.ekstern-test.nspop.dk:8080/stamdata-personinformation | ||
| personinformation.errorcount.duration | Specificering af hvor lang tid tilbage der skal tælles fejl fra PersonInformation servicen (ifm. /health endpointet for slettejobbet). Angives som duration i ISO-8601 formattet. Default værdi er PT10M (10 minutter). | PT10M | |
| personinformation.error.tolerance | Antal fejl der tolereres fra PersonInformation servicen før /health endpointet for slettejobbet angiver servicen som ikke tilgængelig. Default værdi er 0. | 0 | |
| fsk.httpclient.pooling.totalconnections | Konfiguration af client pool til kald af samarbejdende services. Eksempel på værdi: 200 | ||
fsk.httpclient.pooling.maxconnections.pr.route | Konfiguration af client pool til kald af samarbejdende services. Eksempel på værdi: 20 |
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 dokumentation for alternativ konfiguration.
Standardværdierne konfigurerer en Log4j-backend der logger med ISO 8601 timestamps.
Se NSP-util - Designdokument.doc eller den officielle Log4j 1 dokumentation for alternativ konfiguration.
fsk-service komponenten kræver adgang til 2 JNDI datasources. Disse skal opsættes i Wildfly og refereres til i servicens application.properties.
Der følgende beskriver de forskellige deployables som komponenten indeholder.
Filnavn når deployet | Beskrivelse | Kilde |
|---|---|---|
fsk-service.war | FSK servicen | fsk-service-<version>.war |
Se driftsvejledningen for yderligere information.
Når der kommer opgraderinger til en komponent, vil der medfølge release notes, der beskriver opgradering, fallback, osv. for den enkelte komponent.
OBS: Den følgende konfiguration er udfaset, da denne funktionalitet er blevet erstattet af FSK Registry Adapter komponenten. |
Der skal konfigureres 2 ting på DDS:
1. Der skal laves konfiguration, så DDS ved hvilket "home community id" og "repository unique id" der hører til FSK, så DDS ved hvilken URL der skal kaldes når en klient beder om et dokument fra et bestemt repository.
FSK-servicen der skal kaldes fra DDS befinder sig på http://<fsk appserver host>:<port>/fsk/services/fsk (som skal kunne nåes fra DDS).
På alle miljøer skal "home community id" være "1.2.208.176.8.1.12", men "repository unique id" er forskellig afhængig af miljøet. Der skal angives følgende værdier på de forskellige miljøer:
| Miljø | Værdi |
|---|---|
| TEST1 | 1.2.208.176.43210.8.10.12 |
| TEST2 | 1.2.208.176.43210.8.20.12 |
| UDDANNELSE | 1.2.208.176.43210.8.40.12 |
| PRODTEST | 1.2.208.176.43210.8.30.12 |
| PROD | 1.2.208.176.8.1.12 |
2. I DDS registry skal det også konfigureres at FSK har adgang til visse typer opslag. Det drejer sig om typerne ITI-18, ITI-42, ITI-57 og ITI-61.
Se evt. denne sag, hvor konfigurationen blev udført på test1:
https://jira.nspop.dk/browse/FSK-7