Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootAO XDS Adaptere - Leverancebeskrivelse
includeroottrue


Table of Contents

Introduktion

Formål

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

...

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

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.

Dokumenthistorik

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

Definitioner og referencer

Definition

Beskrivelse

DDSDokumentdelingsservice
NSINational Sundheds-IT
NSPDen nationale service platform (inden for sundheds-IT)

STS

Security Token Service

XDS

Cross-Enterprise Document Sharing

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.

...

  • Service-check

  • Type: Webservice

  • Filnavn: service-check.war

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

Daglig drift

Dette afsnit beskriver den daglige drift af systemet.

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.

...

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

Relaterede services

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

...

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

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.

...

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

VersionKode
Version 1.1v11
Version 2.0v20


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

Konfiguration af Aftaleoversigt XDS Registry Adapter

Konfiguration af bookplan kalder

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

...

PropertyBeskrivelse

ao.appointmentservice.request.timeout.seconds

Antal sekunder for hvor lang tid et request mod Bookplan servicen maximalt må tage før forsøget meldes som mislykket.

ao.appointmentservice.request.username

Brugernavnet der anvendes ved kald til Bookplan

ao.appointmentservice.request.password

Kodeordet der anvendes ved kald til Bookplan

ao.appointmentservice.connection.poolsize

Maksimalt antal samtidige kald mod Bookplan servicen.

ao.appointmentservice.endpoint

Url’en til Bookplan servicen

ao.document.assigning.authority.name

Navnet på oprindelssted for Bookplan data.

ao.document.root.id

OID for oprindelssted af Bookplan data

Konfiguration af CDA Skabelon

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

...

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

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:

...

Code Block
<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>

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.

...

Code Block
<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>

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:

...

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

Konfiguration af log4j

Log4j konfiguration findes i følgende fil:

...

Se yderligere opsætning i installationsvejledningen.

Udpegning af SLA-log konfiguration

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

...

Per default udpeges konfigurationsfilen beskrevet i næste afsnit.

Konfiguration af SLA-log

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

...

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

Konfiguration af Aftaleoversigt XDS Repository Adapter

Konfiguration af dokumentprovider

XDS Repository Adapter konfigureres i følgende fil:

...

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

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:

...

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

Konfiguration af log4j

Log4j konfiguration findes i følgende fil:

...

Se yderligere opsætning i installationsvejledningen.

Udpegning af SLA-log konfiguration

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

...

Per default udpeges konfigurationsfilen beskrevet i næste afsnit.

Konfiguration af SLA-log

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

...

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

HTTP Statuscheck på komponenter i Aftaleoversigt XDS-adaptere

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

...

Følgende underafsnit beskriver den nødvendige konfiguration.

ServiceCheck.properties

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

...

Code Block
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

JMX-Console sikkerhedsopsætning

WildFly

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

...

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

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:

...

Code Block
<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>

Test af service-check konfiguration

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

...

  • 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

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.

Test af versionsnummer

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

...

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

Overvågning

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

Placering af HTML overvågningsside

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

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.

Overvågningstype

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

...

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.

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.

...


Kaldte serviceLogPoint
ao-documentmetadataprovider-<profil-navn>DocumentRegistry_RegistryStoredQuery
ao-documentprovider-<profil-navn>

DocumentRepository_RetrieveDocumentSet

For udgående kald logges ved følgende logpunkter:

Kaldte serviceLogPointTargetSOAPOperation

ao-documentprovider-<profil-navn>

DocumentRepository_RetrieveDocumentSet.AppointmentInvoker.invokeAppointment

search/appointments

Performance logs forekommer kun ved aktivering af performanceloggeren i komponenternes log4j konfiguration.

Logningsstrategi og fortolkning af logmeddelelser

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

...

Log patternFejlbeskrivelse og forklaringer
Returnere tomt svar, da søgning ikke indbefattede APPROVED status.Anvenderen har søgt på specifikke stati (og ikke APPROVED som en del af disse)
Query is invalid due to the following: <grund>Anvenderens søgeparametre ligger udenfor det, der er konfigureret for Aftaleoversigten. Grunden hertil er inkluderet.



Standard fejlsøgning

Fejlsøgning kan ske ved at undersøge de logfiler, der er beskrevet i forudgående afsnit.

Krav til backup

Det anbefales, at aktuelle konfigurationsfiler til Aftaleoversigt XDS-adaptere holdes under versionskontrol og back-up.

Det er ikke nødvendigt at tage backup af databasen, da data heri ikke skal gemmes ("requestscope")

...