Dette dokument har til formål at gøre det muligt for andre end den oprindelige leverandør at overtage videreudvikling af Det Fælles Stamkort 1.5 (FSK).
Dokumentationen er rettet mod udviklere og IT-arkitekter, som ikke på forhånd har kendskab til komponenten, og som ikke har adgang til komponentens oprindelige udviklere.
Det forudsættes at læseren har læst dokumentet Design og Arkitektur (FSK).
Version | Dato | Ændring | Ansvarlig |
|---|---|---|---|
2.0.0 | 2018-08-27 | Initialt dokument | Trifork |
| 2.0.9 | 2019-25-09 | Ajourført | Trifork |
FSK 1.5-servicens formål er at agere som en on-demand datakode for Dokumentdelingsservicen (DDS). Såfremt en sundhedsprofessionel henter en borgers stamkort gennem Dokumentdelingsservicen, vil FSK 1.5 servicen blive kaldt af DDS, og returnere et XML dokument, som er sammenstillet af data fra følgende registre:
For ODR, LTR og BTR gælder, at der kun returneres information om, hvorvidt der findes data i de pågældende registre eller ej. Såfremt data ønskes hentet fra disse registre skal der foretages til kald direkte til den pågælende register-service. Se Guide til anvendere (FSK) for beskrivelse af format for dokumentet, der returneres af FSK 1.5
Servicen er designet med henblik på udstilling via den nationale serviceplatform (NSP).
Kodebasen består af én WAR-fil / komponent fsk-service.war.
Servicen benytter i udviklingssammenhæng Flyway, hvilket gør at databasen i udviklingsmiljøet automatisk opdateres til gældende version.
WSDL'er og XSD'er for SCES, ODR, LTR, BTR og SKR ligger i modulet fsk-schemas. Dette modul genererer JAXB-klasser som defineret i modulets pom.xml. De genererede klasser anvendes af tilsvarende Client-moduler SCESClient, OrganDonorClient, LivingWillClient, TreatmentWillClient og PersonalDataCardRegisterClient, som alle findes her: fsk-service/src/main/java/dk/stamkort/integrations.
Efter deployment af fsk-service.war til en lokal Wildfly installation i udviklingsmiljøet er det muligt at kalde on-demand webservicen. Dette kan eksempelvis gøres ved at afvikle metoden callOnDemandService i klassen OnDemandServiceITCase inde i IntelliJ, og forinden specificere FSK_TEST_PORT til 8080 i den tilhørende IntelliJ runtime-konfiguration.
Som udgangspunkt er det dog ikke er muligt at få et succesfuldt svar tilbage, med mindre alle underliggende services kan kaldes med succes. Dvs. der skal anvendes et cpr-nummer, der findes i SCES, og både LTR-BTR, ODR og SKR skal være deployet korrekt til Wildfly, med tilhørende DGWS/IDWS proxies. Alternativt kan integration til de enkelte services disables i FSK-servicens application.properties, som det f.eks. er gjort i fsk-test modulet.
For at afvikle unit-tests skal en MariaDB-database være tilgængelig. Dette opnår man lettest ved at køre MariaDB i en Docker-container. Følgende kommando køres fra projektroden:
docker-compose -f compose/development/docker-compose.yml up --build
Bemærk: Det kan tage op mod et minut før containeren er klar. De nødvendige databaser bliver oprettet automatisk. Bemærk at projektet skal bygges før ovenstående kommando fungerer, dette gøres med følgende kommando, ligeledes fra projektroden:
mvn clean install -DskipTests=true
I application.properties-filen i projektet er datasources som default sat til at anvende root-user med tomt password. Database-strukturen bliver automatisk oprettet vha. Flyway SQL-scripter, når unit-testene afvikles.
Datasourcen i testafviklingen auto-konfigureres vha. Spring Boot som anvender database-credentials fra ltr-btr-service/src/test/resources/application.properties.
Projektet skal være fuldt bygget for at lokale dependencies er på plads, og dernæst kan unit tests afvikles med følgende Maven kommando:
mvn clean test
Der genereres desuden en testrapport.
Der er behov for adgange til følgende systemer:
Al kode findes i NSP SVN.
Efter at projektet er checket ud vil man typisk gøre følgende:
Opsætte udviklingsmiljø (her antages IntelliJ)
Bygge war-filen med Maven og køre tests
Følgende software er nødvendigt for at bygge projektet
En Subversion-klient
Java 8
Maven
MariaDB
Gennemfør følgende steps for at bygge WAR filer:
Start MariaDB ved at køre følgende kommando: docker-compose -f compose/development/docker-compose.yml up fskdb
For at bygge projektet, foretage unittests samt at bygge war-filer foretages kommandoen: mvn clean install
Når man udvikler kan det være praktisk at deploye applikationen lokalt. Dette kan gøres vha. Docker Compose-filen under compose/development/docker-compose.yml.
docker-compose up -d --build