1. Introduktion

1.1. Formål

Vejledning til installation og konfiguration af Aftaleoversigt XDS-adaptere.
Afsnit 2 indeholder servicekrav til det omliggende miljø, herunder krav til operativsystem og standardapplikationer, som f.eks. applikationsservere, Java og/eller Net versioner mm., angivet på version og service pack-niveau.
Afsnit 3 beskriver hvorledes services deployeres, herunder om der er krav om evt. genstart af server eller andre applikationer. Ved opgradering af komponenten beskrives desuden tilstanden, systemet skal være i for at opgraderingen kan finde sted, f.eks. om applikationsserver og/eller databaseserver skal være stoppet.

1.2. Læsevejledning

Læseren forventes at have kendskab til National Sundheds-IT’s platform NSP, samt generelt kendskab til WildFly applikation server og Ubuntu Linux operativ system.
Dokumentet beskriver ikke forhold der berører konfiguration på DoDi, NSP eller centrale ’NSP-lignende miljøer’ eller etablering og konfiguration af distribution af data fra DoDi til øvrige platforme.
Dokumentet er etableret på baggrund af testinstallation på NIAB (NSP in a box) testserver version 2.35.
Hvor der i teksten er angivet <packing> refereres til topniveaufolderen for release-pakken med kildekode. Folderens navngivning afhænger af versionen på releaset.

1.3. Dokumenthistorik

Dette dokument er oprettet med udgangspunkt i dokumentet INS0010 Installationsvejledning Aftaleoversigt XDS-adaptere.docx.

1.4. Definitioner og referencer

2. Krav til miljø

I XDS-adapterne for Aftaleoversigt indgår komponenterne Aftaleoversigt XDS Registry Adapter og Aftaleoversigt XDS Repository Adapter.

2.1. Krav til applikationsservere

Komponenterne er udviklet og testet under WildFly-8.2.0.Final på udviklingsplatformen og mod WildFly 8.2 på NIAB (version 2.35).

Komponenternes konfiguration er tilpasset deployering på WildFly 8.2 applikationsservere.

Applikationsserveren kræver Java 8.

2.2. Krav til operativsystem

Der stilles ingen krav til operativsystemet, ud over krav om, at Java er understøttet på operativsystemet.

Ubuntu Linux bruges som operativsystem på NSP’en, men udviklingen af komponenten er foretaget på Windows 7/8, og disse platforme kan ligeledes afvikle komponenterne.

2.3. Krav til adgang til andre services

Aftaleoversigt XDS Repository Adapter kalder en snitflade til et backend-system, der skal levere indhold til aftaledokumenter.

Denne snitflade er Cap Gemini Sogetis appointment-RESTful snitflade til Bookplan beskrevet i [Aftale RESTful snitflade].

Forbindelsen mellem Aftaleoversigt XDS Repository Adapter og Bookplan RESTful-snitfladen skal være passende beskyttet, hvilket tillige gælder forbindelsen mellem Dokumentdelingsservicen og Aftaleoversigt XDS Repository Adapter.

2.4. Krav til database

Komponenten er testet mod MySQL Version 5.5.60 i Docker.

2.5. Krav til datahåndtering

Både Aftaleoversigt XDS Registry Adapter og Aftaleoversigt XDS Repository Adapter behanlder og opbevarer personhenførbare informationer.

For Aftaleoversigt XDS Registry Adapters vedkommende sker dette ved behandling af personhenførbare informationer hentet fra Bookplan RESTful-snitfladen.

Både Aftaleoversigt XDS Registry og Repository Adapters gemmer CDA dokumenter indeholdende personhenførbar information i et midlertidigt datalager og sender informationer fra dette tilbage til kalderen.

2.6. Krav til hardware

Aftaleoversigt XDS Repository Adapter’s ressourceforbrug vil afhænge af flere parametre:

• Størrelsen af de aftale-informationer, der hentes fra Bookplan RESTful-snitfladen

• Antallet af dokumenter der hentes samtidig

3. Deployment på Wildfly 8.2

Dette afsnit beskriver deploymentprocessen på WildFly 8.2.

Byg og deployering af Aftaleoversigt XDS-adaptere er forberedt, så flere instanser kan fungere på samme Wildfly applikationsserver på samme tid. Derved kan opsættes Aftaleoversigt XDS-adaptere til forskellige regioner eller forskellige instanser inden for samme region. Hver instans bygges og deployeres ved brug af en profil, som beskrevet herunder.

I nuværende kode-base er følgende profiler forberedt:

NB! Deployeringsstien er relativ til <Wildfly>/modules/nsi.

3.1. Deployment af komponenter

OBS! Inden opstart af WildFly skal det sikres at properties og modul filer til servicen ligger i de applikationsspecifikke modul foldere på WildFly. Se afsnit 3.2.

Folderen <installationspakke> forudsættes genereret og indeholdte filer potentielt tilpasset som beskrevet i afsnit Konfiguration af komponenterne.

<packing>/xdswrappers/documentmetadataprovider-war/target/ao-documentmetadataprovider-<profil-navn>.war
<packing>/xdswrappers/documentprovider-war/target/ao-documentprovider-<profil-navn>.war

Servicekomponenter der skal deployes til WildFly, skal kopieres til mappen ”deployments”. Hvis WildFly kører normalt starter den selv komponenten op. Er dette ikke tilfældet skal WildFly genstartes – se afsnit 3.3.

3.2. Oprettelse af databasen

Aftaleoversigtens XDS Registry og XDS Repository har brug for en MySql database til persistering og hentning af dokumenter.

Der skal opsættes en MySQL database med en tilhørende bruger. Navnet på databasen kan f.eks. reflektere profilen f.eks. aoxdscache-rm henholdsvist aoxdscache-rn. De forskellige installationer kan også anvende samme db instans, da der udover selve dokumentet persisteres repository id og homecommunityid.

Når databasen er oprettet skal følgende scripts køres mod MySQL (i den nævnte rækkefølge):

<packing>/xdswrappers/provider-cache/etc/sql/01_aoxdscache_create_tables.sql

3.3. Konfiguration af datasource

Både Aftaleoverisgt XDS Registry og Repository anvender en MySQl som database for de dokumenter, der hentes fra det bagvedliggende bookplan system.

Begge moduler slår datasources op via JNDI. Datasourcen kan konfigureres i Wildfly ved at deploye filen i

/pack/wildfly8/standalone/deployments/aoxdscache-ds.xml

Et eksempel kan findes i:

<packing>/xdswrappers/provider-cache/etc/example/aoxdscache-ds.xml

3.4. Konfiguration af komponenterne

Al konfiguration, undtagen udpegning af log4j-konfigurationsfilen (se afsnit 3.2.2.4 og 3.2.3.5), foregår ved redigering af de relevante properties filer under WildFly modules. Ved konfigurationsændringer bør servicen/WildFly genstartes.

Indholdet af de enkelte konfigurationsfiler, er beskrevet og forklaret i [Driftsvejledning].

Filer beskrevet i det følgende kan tilpasses.

3.4.1. Deployment af modul

WildFly moduler for Aftaleoversigt XDS adapterne sættes op ved at kopiere filerne:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>/module.xml → /pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/
<packing>/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>/module.xml → /pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/

3.4.2. Konfiguration af Aftaleoversigt XDS Registry Adapter

3.4.2.1. AODocumentProvider.properties

Konfigurerer opsætningen af bookplan RESTful klienten for Aftaleoversigt XDS Repository Adapter.

En skabelon for denne fil findes i:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>/AODocumentProvider.properties

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/

Yderligere information kan findes i driftsvejledningen.

3.4.2.2. cda_document_template.xml

Skabelon til brug under transformering af Bookplan aftaler til CDA dokumenter.

En skabelon for denne fil findes i:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>/<version-kode>/cda_document_template.xml

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/

3.4.2.3. aometadataconfiguration.xml

Konfigurerer opsætning af dokument-metadata anvendt af Aftaleoversigt XDS Registry Adapter.

En skabelon for denne fil findes i:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>/<version-kode>/aometadataconfiguration.xml

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/

Yderligere information kan findes i driftsvejledningen.

3.4.2.4. aofilterconfiguration.xml

Konfigurerer opsætning af, hvordan Aftaleoversigt XDS Registry Adapter skal reagere på søge-parametre givet ved dokumentmetadata-forespørgsler.

En skabelon for denne fil findes i:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>/<version-kode>/aofilterconfiguration.xml

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/

Yderligere information kan findes i driftsvejledningen.

3.4.2.5. log4j-ao-documentmetadataprovider-ws.xml

Konfigurerer logopsætningen for Aftaleoversigt XDS Registry Adapter.

En skabelon for log4j konfiguration findes i:

<packing>/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>/log4j-ao-documentmetadataprovider-ws.xml

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/

I det følgende vises hvordan Standalone.xml opdateres med logging profile konfigurationen specifikt til Aftaleoversigt XDS Registry Adapter, men opsætningen er også mulig igennem WildFly Administration Console.

Konfigurationen er udelukkende til stede for at Aftaleoversigt XDS Registry Adapters egen log4j logning virker, men er ikke sat op til at blive brugt som ses ved konfigurationen af level til OFF.

<logging-profile name="ao-metadataprovider-<profil-navn>-logging-profile">
	<size-rotating-file-handler name="PerformanceFile" autoflush="true">
		<level name="OFF"/>	
	</size-rotating-file-handler>
	<logger category="performancelogger" use-parent-handlers="false">
		<level name="OFF"/>
		<handlers>
			<handler name="PerformanceFile"/>
		</handlers>
	</logger>
</logging-profile>

3.4.2.6. Udpegning af log4j-konfigurationsfilen

Filen beskrevet i afsnit 3.2.2.3 udpeges som konfigurationsfil for log4j i filen:

documentsharing.log4j.properties

under roden i war-filen ao-documentmetadataprovider-<profil-navn>.war, der er placeret som beskrevet i afsnit 3.1. Bemærk, at denne fil (om nødvendigt) skal tilpasses direkte i war-filen og ikke findes under Aftaleoversigt XDS Registry Adapter’s modul på WildFly.

3.4.2.7. Konfiguration af NSP SLA log

NSP-util anvendes som en del af servicen og skal konfigureres. Eksempel på konfiguration-fil findes i:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>
   log4j-nspslalog-ao-documentmetadataprovider-ws.properties
   nspslalog-ao-documentmetadataprovider.properties 

Filerne redigeres inden de placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/

Yderligere information kan findes i driftsvejledningen.

3.4.3. Konfiguration af Aftaleoversigt XDS Repository Adapter

3.4.3.1. aoproviderconfiguration.xml

Konfigurerer metadata opsætning af Aftaleoversigt XDS Repository Adapter.

En skabelon for denne fil findes i:

<packing>/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>/aoproviderconfiguration.xml

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/

Yderligere information kan findes i driftsvejledningen.

3.4.3.2. log4j-ao-documentprovider-ws.xml

Konfigurerer logopsætningen for Aftaleoversigt XDS Repository Adapter.

En skabelon for log4j konfiguration findes i:

<packing>/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>/log4j-ao-documentprovider-ws.xml

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/

I følgende vises hvordan Standalone.xml opdateres med logging profile konfigurationen specifikt til Aftaleoversigt XDS Repository Adapter, men opsætningen er også mulig igennem WildFly Administration Console. Konfigurationen er udelukkende til stede for at Aftaleoversigt XDS Repository Adapters egen log4j logning virker, men er ikke sat op til at blive brugt som ses ved konfigurationen af level til OFF.

<logging-profile name="ao-provider-<profil-navn>-logging-profile">
	<size-rotating-file-handler name="PerformanceFile" autoflush="true">
		<level name="OFF"/>	
	</size-rotating-file-handler>
	<logger category="performancelogger" use-parent-handlers="false">
		<level name="OFF"/>
		<handlers>
			<handler name="PerformanceFile"/>
		</handlers>
	</logger>
</logging-profile>

3.4.3.3. Udpegning af log-4j-konfigurationsfilen

Filen beskrevet i afsnit 3.2.3.3 udpeges som konfigurationsfil for log4j i filen:

documentsharing.log4j.properties

under roden i war-filen ao-documentprovider-<profil-navn>.war, der er placeret som beskrevet i afsnit 3.1. Bemærk, at denne fil (om nødvendigt) skal tilpasses direkte i war-filen og ikke findes under Aftaleoversigt XDS Repository Adapter’s modul på WildFly.

3.4.3.4. Konfiguration af NSP SLA-log

NSP-util anvendes som en del af servicen og skal konfigureres. Eksempel på konfiguration-fil findes i:

<packing>/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>
   log4j-nspslalog-ao-documentprovider-ws.properties
   nspslalog-ao-documentprovider.properties

Filerne redigeres inden de placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/

Yderligere information kan findes i driftsvejledningen.

3.5. Start/genstart af service

Komponenterne kan genstartes ved ”touch” af de respektive war-filer på WildFly. Alternativt skal WildFly genstartes ved at køre kommandoen:

/etc/init.d/wildfly8 restart

3.6. Logfiler

Aftaleoversigt XDS Adapter-komponenterne kan logge kald til følgende logs: En NSP-SLA-log, en applikationslog og eventuelt en performancelog.

I default opsætningen logges udelukkende fejl til applikationsloggen.

Det er muligt at konfigurere placeringen af filerne, samt hvilket niveau de logger på, ved at redigere i filerne beskrevet i afsnit 3.2.2.3, 3.2.2.4, 3.2.3.3 og 3.2.3.5.

Alle logs er beskrevet i driftsvejledningen.

3.7. Opgradering af komponenter

Når der kommer opgraderinger til en komponent, vil der medfølge en release-note, der beskriver hvad opgraderingen består af, samt hvilke handlinger der er nødvendige for at opgradere den deployerede komponent.

4. Afinstallation af servicen

Fjern service-komponenter under WildFly’ deployments/ folder:

ao-documentmetadataprovider<profil-navn>.war
ao-documentprovider<profil-navn>.war

Fjern properties filer under Aftaleoversigt XDS Adaptere modul-foldere:

/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/

Fjern eventuelt logfiler – se afsnit 3.4.