1. Introduktion

1.1. Formål

Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af DDS registry, kan sættes op, samt hvordan koden bygges, deployes og testes.

I afsnit 3 beskrives de softwaremæssige krav der er til miljøet samt hvordan kode bygges.

I afsnit 4 beskrives deployment-miljøet.

Kodestrukturen, kodemæssige afhængigheder til tredjeparts moduler og de forskellige servicemodulers ansvar og design beskrives i afsnit 6.

Testdesign findes i afsnit 7.

1.2. Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for DDS projektet.

Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet: Dokumentdelingsservice (DDS).

1.3. Læsevejledning

Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven, WildFly applikationsserver og MySQL.

Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for komponenten.

1.4. Dokumenthistorik

Version

Dato

Ansvarlig

Beskrivelse

1.0

29.06.2012

Systematic

Initiel udgave

1.1

21.08.2012

Systematic

Ændring i afsnit 3.2, 3.3, 4.2 og 7.2 grundet opdateret bygge- og testprocedure.

1.1a

19.04.2012

Systematic

Mindre ændringer grundet både registrering og opslag via NSP (Release kandidat)

1.2

19.06.2013

Systematic

Kvalitetssikret

1.3

23.05.2014

Systematic

Rettelser som konsekvens af opsplitning af tidl. NPI-mavenprojekt i selvstændige komponenter.

1.4

28.11.2014

Systematic

Referencer til Nationalt Patientindeks (NPI) fjernet

1.5

14.01.2015

Systematic

Nye kommandoer til maven og ændring af npi og npiservices til dds

1.6

30.03.2015

Systematic

Opdatering af afhængigheder i 6.1

Tilføjet afsnit 3.3.

Beskrivelse af afhængigheden til eksterne database scripts og datasources

1.7

02.02.2016

Systematic

Kodereferencer er opdaterede pga. navneskifte fra NPI til DDS

Opgradering til WildFly

Forbedret codecoverage beskrivelse

1.8

25.11.2016

Systematic

BRS stub nu påkrævet (3.3)

Cobertura modul nævn i 6.1

Performancetest fjernet da disse er beskrevet i separat dokument

1.9

16.12.2016

Systematic

Opdateret afhængigheder i afsnit 3.3

Fjernet beskrivelse af code-coverage for unittest i afsnit 7.3.

1.10

13.06.2018

Systematic

Migreret til NSPOP SVN

1.1114.11.2018KvalitetsITDokumentation lagt ind i Confluence
1.1223.07.2020KvalitetsITOpdateret byggevejledning.

1.5. Definitioner og referencer

Definition

Beskrivelse

NSI

National Sundheds-IT

NSP

Den nationale service platform (inden for sundheds-IT)

SHAK

Sygehusafdelingsklassifikation

SOR

Sundhedsvæsenets organisationsregister

STS

Security Token Service

BRS

Behandlingsrelationsservicen

NXRG

Det nationale XDS Registry på NSP

Alias

Beskrivelse

Oversigt

Dokumentdelingsservice (DDS)

DGWS

Den Gode WebService 1.0.1

Design

DDS Registry System Arkitektur

Installationsvejledning

Installationsvejledning DDS Registry

Min-log

Design og Arkitektur Min-log Service (SSE/11734/SDD/0002)

SAM

Design og Arkitektur Samtykke Service (SSE/11734/SDD/0003)

SAM-guide

Guide til udviklere Samtykke Service (SSE/11734/PHB/0007)

Minlog-guide

Guide til udviklere Min Log Service (SSE/11734/PHB/0004)

2. Introduktion til DDS Registry

Realisering af DDS registry består af en Java-baseret webservice.

Webservicen tillader

  • anvendersystemer at lave forespørgsler til dokumentdelingsservice og få metadata om patientinformationer, der er gemt deri, retur

Servicen filtrerer returnerede metadata baseret på borgerens samtykker, validerer brugerens rettigheder, kalder behandlingsrelationsservicen og gemmer eventuelle relevante oplysninger i borgerens Min-log.

For en dybere introduktion til servicen og baggrunden bag, se DDS Registry System Arkitektur.

3. Opsætning af udviklingsmiljø

det følgende antages at koden er hentet ned fra softwarebørsen el.lign.

3.1. Krav til software

Krav til applikationsserveren, operativsystemet og databasen er de samme som til produktionsmiljøet. De specifikke krav kan ses i [Installationsvejledning] afsnit 2.

Derudover er der en række krav til de anvendte udviklingsværktøjer:

Krav til Maven

Maven 3.0.3 eller højere anvendes.

Krav til Docker

Docker 18.x eller højere anvendes.

3.2. Bygge komponenten

Udfør følgende kommando for at bygge komponenten:

mvn clean install

Det tager lidt tid, da der skal genereres kode ud fra et større antal wsdl-filer.

3.3. Integrationstest

For at køre integrationstesten gøres følgende:

Byg DDS, som beskrevet ovenfor

Udfør følgende kommandoer:

cd compose/development
docker-compose up --build

Vent på at setuppet kommer op.

cd integrationstest

mvn verify -Plocal,integration-tests

Det er muligt at ramme andre miljøer end det lokale ved at udskifte local med test1 eller test2.


  • No labels