1. Introduktion

1.1. Formål

Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af komponenterne fra Aftaleoversigt XDS-adaptere.

Driftsvejledningen indeholder information om komponenterne med hensyn til eksterne afhængigheder, standard placering af logfiler og konfigurationsfiler, og evt. krav til genstart af applikationer hvis komponenten ikke er responsiv.

I afsnit 2 er beskrevet hvilke komponenter, der indgår i Aftaleoversigt XDS-adaptere og deres forventede placering med hensyn til platform.

Afsnit 4 beskriver aktuelle konfigurationsparametre for komponenterne i Aftaleoversigt XDS-adaptere, samt eksempler på konfigurationsparameter-filer.

I afsnit 5 beskrives hvorledes Aftaleoversigt XDS-adapter-komponenterne overvåges.

Beskrivelse af standard fejlsøgning og vejledning for start/stop af komponenterne er beskrevet i afsnit 6.

Specielle krav til backup er beskrevet i afsnit 7, ligesom procedure ved reetablering af komponenterne ud fra backup beskrives.

1.2. Læsevejledning

Læseren forventes at have kendskab til National Sundheds-IT’s platform NSP, samt generelt kendskab til WildFly applikationsserver samt Ubuntu Linux operativ system.

1.3. Dokumenthistorik

Dette dokument er oprettet med udgangspunkt i dokumentet OHB0016 Driftsvejledning Aftaleoversigt XDS-adaptere.docx

1.4. Definitioner og referencer

2. Komponenter

Flere konfigurationer af Aftaleoversigt XDS-adaptere kan være deployeret på samme Wildfly applikationsserver. Se beskrivelse af profiler og profil-navne i indledningen af afsnit 4.

Aftaleoversigt XDS-adaptere er implementeret gennem følgende komponenter:

• Aftaleoversigt XDS Registry Adapter

• Type: Webservice

• Filnavn: ao-documentmetadataprovider-<profil-navn>.war

• Url: <serverurl>/ao-documentmetadataprovider-<profil-navn>

• Statusurl: <serverurl>/service-check/service?servicename=ao-documentmetadataprovider-<profil-navn>

• Aftaleoversigt XDS Repository Adapter

• Type: Webservice

• Filnavn: ao-documentprovider-<profil-navn>.war

• Url: <serverurl>/ao-documentprovider-<profil-navn>

• Statusurl: <serverurl>/service-check/service?servicename=ao-documentprovider-<profil-navn>

Brug af service-check forudsætter følgende komponent på NSP:

• Service-check

• Type: Webservice

• Filnavn: service-check.war

• Url: <serverurl>/service-check/service

3. Daglig drift

Dette afsnit beskriver den daglige drift af systemet.

3.1. Database

Aftaleoversigt XDS Registry og Repository anvender en database til persistering og afhentning af bookplan dokumenter. Denne database er at betragte som en "sessioncache". De persisterede data kan derfor til enhver tid slettes. Det er derfor ikke nødvendigt at tage backup af databasen.

Da databasen over tid vil vokse, giver det mening at rydde op i denne (f.eks i natligt/ugenligt job).

Oprydningsproceduren er udstillet på en servlet for Aftaleoversigt XDS Repository med adressen: <serverurl>/ao-documentprovider-<profil-navn>/clearDbCache?age=300

age er alder (i timer) der angiver, hvor gamle dokumenter skal være, før de slettes. Defaultværdien for age er 24 (dvs. et døgn).

Der kan sættes et eksternt job op (f.eks. cron job, der kalder dette endpoint).

3.2. Relaterede services

Aftaleoversigt XDS Registry Adapter afhænger af den eksterne service:

• Bookplans RESTful aftalesnitflade

Ved fejl i denne vil Aftaleoversigt XDS Registry Adapter returnere svar til anvendere, hvoraf det fremgår, at der er fejl.

4. Konfiguration

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.

Hver profil er blevet udviddet, så de indeholder 2 version af f.eks. cda_document_template.xml. Hver profil kan dog ikke afvikle begge version i samme Wildfly. Så indtil den eksisterende version udgår, så skal der være en wildfly pr. version, spm indeholder instanser svarende til profiler.

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

Versionerne har kun imdflydelse på, hvor eksempel filer skal hentes fra. De skal stadig deployes til hver Wildfly, som angivet ovenover.

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

4.1. Konfiguration af Aftaleoversigt XDS Registry Adapter

4.1.1. Konfiguration af bookplan kalder

Opsætningen for kalderen af bookplan servicen konfigueres i AODocumentProvider.properties.

Denne indlæses fra WildFly modulet:

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

Et eksempel på sådan konfiguration er:

ao.appointmentservice.request.timeout.seconds=120
ao.appointmentservice.request.username=username
ao.appointmentservice.request.password=password
ao.appointmentservice.connection.poolsize=10
ao.appointmentservice.endpoint=http://localhost:9090/appointmentsstub/search/appointments/V1
ao.document.assigning.authority.name=Region Nordjylland Aftaleoversigt
ao.document.root.id=1.2.208.176.99.179.99.98.1.1

Properties beskrives ifølge tabel.

4.1.2. Konfiguration af CDA Skabelon

Aftaleoversigt XDS Registry bruger en CDA skabelon til at transformere Bookplan svaret til en række af CDA dokumenter.

Der er i skabelonen indsat placeholdere for genererede værdier. Disse starter og slutter med tegnet ’¤’, som f.eks. ”¤AUTHOR_ADDRESS_STREET¤”. Placeholdere må ikke ændres.

Skabelonen indlæses fra:

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

4.1.3. Konfiguration af dokument-metadata

Dokument-metadata anvendt af Aftaleoversigt XDS Registry Adapter, når der laves opslag på en patient, er defineret i følgende fil:

• aometadataconfiguration.xml

Denne indlæses fra WildFly modulet:

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

Et eksempel på indhold i aometadataconfiguration.xml:

<metadata>
	<classCode class="codedValue">
 		<code>001</code>
 		<codeSystem>2.16.840.1.113883.3.4208.100.9</codeSystem>
 		<description>Klinisk rapport</description>
 	</classCode>
 	<confidentialityCode class="codedValue">
 		<code>N</code>
 		<codeSystem>2.16.840.1.113883.5.25</codeSystem>
 		<description>Normal</description>
 	</confidentialityCode>
 	<formatCode class="codedValue">
 		<code>urn:ad:dk:medcom:appointmentsummary:full</code>
 		<codeSystem>2.16.840.1.113883.3.4208.100.10</codeSystem>
 		<description>DK Appointment Summary Document schema</description>
 	</formatCode>
 	<languageCode>da-DK</languageCode>
 	<mimeType>text/xml</mimeType>
 	<practiceSettingCode class="codedValue">
 		<code>Unknown</code>
 		<codeSystem>2.16.840.1.113883.11.10612</codeSystem>
 		<description>Unknown</description>
 	</practiceSettingCode>
 	<typeCode class="codedValue">
 		<code>39289-4</code>
 		<codeSystem>2.16.840.1.113883.6.1</codeSystem>
 		<description>Dato og tidspunkt for møde mellem patient og sundhedsperson</description>
 	</typeCode>
 	<homeCommunityId>1.2.208.176.99.179.99.98</homeCommunityId>
 	<repositoryUniqueId>1.2.208.176.99.179.99.98.1</repositoryUniqueId>
 	<uniqueIdRoot>1.2.208.176.99.179.99.98.1.1</uniqueIdRoot>
 	<healthcareFacilityTypeCode class="codedValue">
 		<code>22232009</code>
 		<codeSystem>1.2.208.176.1.1.2</codeSystem>
 		<description>hospital</description>
 	</healthcareFacilityTypeCode>
 	<authorInstitution class="dk.nsi.documentsharing.core.metadata.model.OrganisationImpl">
 		<name>Region Nordjylland</name>
 		<id class="valueWithAssigningAuthority">
 			<value>6071000016008</value>
 			<assigningAuthority>1.2.208.176.1.1</assigningAuthority>
 		</id>
 		<address class="dk.nsi.documentsharing.core.metadata.model.AddressImpl">
 			<street>Niels Bohrs Vej 20</street>
 			<postalCode>9220</postalCode>
 			<city>Aalborg Øst</city>
 		</address>
 		<telecom class="dk.nsi.documentsharing.core.metadata.model.TelecomImpl">
 			<telecom>97 64 80 00</telecom>
 		</telecom>
 	</authorInstitution>
</metadata>

4.1.4. Konfiguration af filter på dokument-metadata-forespørgsel

Ved opslag på en patient kan der anføres en række søge-parametre. Aftaleoversigt XDS Registry Adapter har logik, der er afhængig af konkrete søge-parametre og konfigureret filter (beskrevet her), fastlægger om den bagvedliggende bookplan service skal kaldes.

Filteret konfigureres i følgende fil:

• aofilterconfiguration.xml

Denne indlæses fra WildFly modulet:

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

I konfiguration specificeres 0, 1 eller flere kode-sæt i hhv. classCodes, typeCodes, eventCodes, confidentialityCodes og formatCodes.

<filter>
 	<classCodes>
 	</classCodes>
 	<typeCodes>
 	</typeCodes>
 	<eventCodes>
 	</eventCodes>
 	<confidentialityCodes>
 	</confidentialityCodes>
 	<formatCodes>
 	</formatCodes>
</filter>

Hver kode-sæt, består af:

<codedValue>
 	<code>kode-værdi</code>
 	<codeSystem>kode-system</codeSystem>
 	<description>menneskelæselig beskrivelse af kodeværdi</description>
</codedValue>

Filterets classCodes, typeCodes, eventCodes, confidentialityCodes og formatCodes modsvarer lignende navne i søge-parametre, der kan være anført ved kald af Aftaleoversigt XDS Registry Adapter opslag. Er et kodesæt anført i søge-parametre for fx eventCodes, da bevirker filteret et tomt svar, når:

1. Filterets eventCodes ikke er tomt, og

2. Ingen af evt. flere eventCodes fra søge-parametre findes i filterets eventCodes-liste

Tilsvarende logik er gældende de øvrige koder i filteret.

Følgende er et eksempel på konfiguration af filteret:

<filter>
 	<classCodes/>
 	<typeCodes>
 		<codedValue>
 			<code>39289-4</code>
 			<codeSystem>2.16.840.1.113883.6.1</codeSystem>
 			<description>Dato og tidspunkt for møde mellem patient og sundhedsperson</description>
 		</codedValue>
 	</typeCodes>
 	<eventCodes/>
 	<confidentialityCodes>
 		<codedValue>
 			<code>N</code>
 			<codeSystem>2.16.840.1.113883.5.25</codeSystem>
 			<description>Normal</description>
 		</codedValue>
 	</confidentialityCodes>
</filter>

4.1.5. Udpegning af log4j-konfiguration

Følgende fil, der findes under roden i war-filen ao-documentmetadataprovider-<profil-navn>.war, udpeger den fil, der anvendes til konfiguration af log4j:

• documentsharing.log4j.properties

Bemærk, at denne fil (om nødvendigt) skal tilpasses direkte i war-filen og ikke findes i WildFly modulet.

4.1.6. Konfiguration af log4j

Log4j konfiguration findes i følgende fil:

• log4j-ao-documentmetadataprovider-ws.xml

Denne indlæses fra WildFly modulet:

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

I konfigurationen er det muligt at aktivere performanceloggeren, der udvalgte steder i adapteren, vil skrive tidsvarighed af kald igennem systemet. Performanceloggeren aktiveres ved at ændre level værdien fra ”OFF” til ”DEBUG”. Eftersom konfigurationen kun indlæses ved opstart af servicen, er det nødvendigt at genstarte servicen efter endt redigering af log4j-ao-documentmetadataprovider-ws.xml filen.

Eksempel på konfiguration af performanceloggeren, hvor level værdien er sat til ”OFF”:

<logger name="performancelogger" additivity="false">
 	<level value="OFF" />
 	<appender-ref ref="PerformanceFile" />
</logger>

Som standard skriver performanceloggeren til ao-documentmetadataprovider-ws-performance.log i WildFly’ log-folder.

Se yderligere opsætning i installationsvejledningen.

4.1.7. Udpegning af SLA-log konfiguration

Følgende fil udpeger hvilken fil, der indeholder konfigurationen af SLA-logning:

• nspslalog-ao-documentmetadataprovider.properties

Denne indlæses fra WildFly modulet:

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

Per default udpeges konfigurationsfilen beskrevet i næste afsnit.

4.1.8. Konfiguration af SLA-log

Per default indlæses konfigurationen af Aftaleoversigt XDS Registry Adapters SLA-logning fra følgende fil:

• log4j-nspslalog-ao-documentmetadataprovider.properties

Denne indlæses fra WildFly modulet:

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

4.2. Konfiguration af Aftaleoversigt XDS Repository Adapter

4.2.1. Konfiguration af dokumentprovider

XDS Repository Adapter konfigureres i følgende fil:

• aoproviderconfiguration.xmll

Denne indlæses fra WildFly modulet:

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

Et eksempel på indhold i aoproviderconfiguration.xml:

<ProviderConfiguration>
     <homeCommunityId>1.2.3.7.8</homeCommunityId>
     <repositoryUniqueId>1.2.3.4.77.88</repositoryUniqueId>
</ProviderConfiguration>

4.2.2. Udpegning af log4j-konfigurationsfil

Følgende fil, der findes under roden i war-filen ao-documentprovider-<profil-navn>.war, udpeger den fil, der anvendes til konfiguration af log4j:

• documentsharing.log4j.properties

Bemærk, at denne fil (om nødvendigt) skal tilpasses direkte i war-filen og ikke findes i WildFly modulet.

4.2.3. Konfiguration af log4j

Log4j konfiguration findes i følgende fil:

• log4j-ao-documentprovider-ws.xml

Denne indlæses fra WildFly modulet:

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

I konfigurationen er det muligt at aktivere performanceloggeren, der udvalgte steder i adapteren, vil skrive tidsvarighed af kald igennem systemet. Performanceloggeren aktiveres ved at ændre level værdien fra ”OFF” til ”DEBUG”. Eftersom konfigurationen kun indlæses ved opstart af servicen, er det nødvendigt at genstarte servicen efter endt redigering af log4j-ao-documentprovider-ws.xml filen.

Eksempel på konfiguration af performanceloggeren, hvor level værdien er sat til ”OFF”:

<logger name="performancelogger" additivity="false">
	<level value="OFF" />
	<appender-ref ref="PerformanceFile" />
</logger>

Som standard skriver performanceloggeren til ao-<profil-navn>-documentprovider-ws-performance.log i WildFly’ log-folder.

Se yderligere opsætning i installationsvejledningen.

4.2.4. Udpegning af SLA-log konfiguration

Følgende fil udpeger hvilken fil, der indeholder konfigurationen af SLA-logning:

• nspslalog-ao-documentprovider.properties

Denne indlæses fra WildFly modulet:

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

Per default udpeges konfigurationsfilen beskrevet i næste afsnit.

4.2.5. Konfiguration af SLA-log

Per default indlæses konfigurationen af Aftaleoversigt XDS Repository Adapters SLA-logning fra følgende fil:

• log4j-nspslalog-ao-documentprovider.properties

Denne indlæses fra WildFly modulet:

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

4.3. HTTP Statuscheck på komponenter i Aftaleoversigt XDS-adaptere

Det er muligt at lave servicetjek på Aftaleoversigtsadaptere ved brug af den generelle service servicecheck.

For at understøtte servicetjek kræves konfiguration af servicecheck servicen, der er både generel og specifikt for aftaleoversigtsadaptere.

Følgende underafsnit beskriver den nødvendige konfiguration.

4.3.1. ServiceCheck.properties

Grundlæggende konfiguration af service-check sker ved tilretning af properties i ServiceCheck.properties filen.

Eksempel på ServiceCheck.properties

jmx.url=service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector
jmx.username=nisse
jmx.password=ngyffe
service.config.path=service-check.xml
log4j.path=servicecheck.log4j.properties

Konfiguration af log4j sker ved tilretning af properties i filen servicecheck.log4j.properties:

log4j.logger.service-check=INFO,sclog
log4j.appender.sclog=org.apache.log4j.RollingFileAppender
log4j.appender.sclog.File=${jboss.server.log.dir}/service-check.log
log4j.appender.sclog.layout=org.apache.log4j.PatternLayout
log4j.appender.sclog.layout.ConversionPattern=%d [%t] %-5p %c - %m%n

4.3.2. JMX-Console sikkerhedsopsætning

4.3.2.1. WildFly

Følgende script afvikles for at tilføje en ny JMX bruger på wildfly:

wildfly\bin\add-user.sh

Under opsætning af brugeren vælges typen ’Management User’ og muligheden for kommunikation på tværs af applikationsservere kræves ikke rettigheder til.

Når brugeren er oprettet med navn og kodeord ændres ServicesCheck.properties, så properties stemmer overens med det indtastede i add-user.sh scriptet.

Se afsnit 4.3.1 for et eksempel på konfiguration af jmx.username og jmx.password.

4.3.3. service-check.xml

Konfiguration af de enkelte checks for en service foretages ved tilretning af settings i service-check.xml filen. Nedenfor ses eksempel på konfiguration af Aftaleoversigt XDS Adapteres service check, der omfatter:

• Check i WildFly at servicen er registreret og aktiv

<service name="ao-documentmetadataprovider-<profil-navn>">
    <assertions resultCode="200">
        <mBeanCheck>         
			<ObjectName>jboss.as:deployment=ao-documentmetadataprovider-<profil-navn>.war,subsystem=undertow,servlet=MetadataProviderWS</ObjectName>
        </mBeanCheck>
    </assertions>
    <assertions resultCode="404">
        <mBeanCheck> 	         
			<ObjectName>jboss.as:deployment=ao-documentmetadataprovider-<profil-navn>.war,subsystem=undertow,servlet=MetadataProviderWS</ObjectName>
            <isRegistered>false</isRegistered>
        </mBeanCheck>
    </assertions>
</service>

<service name="ao-documentprovider-<profil-navn>">
    <assertions resultCode="200">
        <mBeanCheck> 	          
			<ObjectName>jboss.as:deployment=ao-documentprovider-<profil-navn>.war,subsystem=undertow,servlet=DocumentProviderWS</ObjectName>
        </mBeanCheck>
    </assertions>
    <assertions resultCode="404">
        <mBeanCheck> 	         
			<ObjectName>jboss.as:deployment=ao-documentprovider-<profil-navn>.war,subsystem=undertow,servlet=DocumentProviderWS</ObjectName>
            <isRegistered>false</isRegistered>
        </mBeanCheck>
    </assertions>
</service>

4.3.4. Test af service-check konfiguration

Efter konfiguration og deploy af ServiceCheck servicen, kan Aftaleoversigt XDS Adaptere servicecheck testes med følgende kommandoer:

curl –i localhost:9090/service-check/service?servicename=ao-documentmetadataprovider-<profil-navn>
curl –i localhost:9090/service-check/service?servicename=ao-documentprovider-<profil-navn>

Servicen returnerer følgende http koder:

• 200 ved normal situation.

• 404 hvis servicen ikke er deployed

• 405 ved fejlkonfiguration af url til check af service-check funktionen (for at lette fejlsøgning)

• 500 ved anden intern fejl ved forespørgsel i WildFly på den overvågede service

4.4. HTTP Versionsnummer-information på Aftaleoversigt XDS-adaptere

Der kan hentes versionsnummer fra kørende Aftaleoversigt XDS adaptere som givet i nedenstående tabel.

Versionsnummeret hentes fra Mavens pom.properties indlejret i jar-filen for fællesartefaktet ao-provider-common.

4.4.1. Test af versionsnummer

Efter konfiguration og deploy af Aftaleoversigt XDS-adaptere kan versionsnummeret for fx Aftaleoversigt XDS Registry Adapter hentes med:

curl localhost:9090/ao-documentmetadataprovider-<profil-navn>/version

hvilket giver output i stil med:

Version: 1.0.0

Tilsvarende hentes versionsnummeret for Aftaleoversigt XDS Repository Adapter blot ved at anvende det andet endpoint i tabellen.

5. Overvågning

Aftaleoversigt XDS-adaptere overvåges af service-check overvågningsside, hvis url kan aflæses i afsnit 2.

5.1. Placering af HTML overvågningsside

Under listen af komponenter først i dette dokument, er der henvisninger til overvågningssiderne.

5.2. Fortolkning af HTML overvågningsside

Alle overvågningssider returnerer enten status 200, hvis de i øjeblikket kører fint, status 404, hvis service ikke er deployed og status 500, hvis der er opstået en fejl, og komponenten derfor ikke virker korrekt.

5.3. Overvågningstype

Simpel WEB side der anvender JMX til at indhente oplysninger om Web services deployed på serveren. Som udgangspunkt overvåges følgende:

• Verificer service er registreret og aktiveret i WildFly

Det muligt at udvide overvågning med yderligere checks ved at tilføje nye objekter i service-check.xml, se eksempler i afsnit 4.3.2.

5.4. Logfiler og fortolkning af disse

Alle logfiler er at finde i log/ under WildFly. Herunder findes en liste over alle logfiler med en beskrivelse af hvilke komponenter der skriver til dem.

For alle webservices er der en tilhørende SLA-log, der sørger for at logge udvalgte elementer fra requests til webservicen.

For Aftaleoversigt XDS-adaptere logges indgående kald, samt udgående kald til Svareksponeringsservicen.
For indgående kald logges ved følgende logpunkter:

5.4.1. Logningsstrategi og fortolkning af logmeddelelser

Logning foretages udfra følgende principper i forhold til loglevels og brug af stacktraces:

• ERROR log-level: Foretages med stacktrace for exceptions, hvor driften skal tage action. Eksempler på fejlsituationer gennemgåes  nedenfor.
• WARN log-level: Foretages ved uheldig situation, fx timeout på Bookplan service. Er vilkårene for en exception kendte og kontrollerede (svarende til en specifikt anvendt checked exception), da logges uden stacktrace. I øvrige tilfælde logges med stacktrace. I begge tilfælde logges fejlbeskrivelse, service-url samt in-bound (og out-bound) message id.
• INFO log-level (uden stacktrace): Anvendes, når fejlen skyldes anvender, fx manglende whitelistning eller ugyldigt/udløbet idkort/certifikat.
• DEBUG log-level (med/uden stacktrace): Kan anvendes, da DEBUG-level kan slås til også i drift om nødvendigt.

Nedenfor gennemgås, hvilke fejlscenarier, der kan opstå i Aftaleoversigten. Tabellerne indeholder logpattern dvs. hvilken tekst driften kan forvente at finde i applikationsloggen. Tilhørende er en fejlbeskrivelse og mulige løsninger beskrevet.

I det følgende gennemgåes de typiske fejlscenarier med ERROR:

I det følgende gennemgåes de typiske fejlscenarier med WARN:

I det følgende gennemgåes de typiske fejlscenarier med INFO. Da disse skyldes anvender kan det i supportsituationer være en hjælp til fejlfinding: