Indhold
1 Introduktion
1.1 Formål
1.2 Læsevejledning
1.3 Dokumenthistorik
1.4 Definitioner og referencer
2 Krav til miljø
2.1 Krav til applikationsservere
2.2 Krav til operativsystem
2.3 Krav til adgang til andre services
2.4 Krav til datahåndtering
2.5 Krav til hardware
3 Deployment på WildFly 8.2
3.1 Deployment af komponenter
3.2 Konfiguration af komponenterne
3.2.1 Deployment af Modul
3.2.2 Konfiguration af Svareksponeringsservice XDS Registry Adapter
3.2.3 Konfiguration af Svareksponeringsservice XDS Repository Adapter
3.3 Start/genstart af service
3.4 Logfiler
3.5 Opgradering af komponenter
4 Af-installation af servicen

Introduktion

Formål

Vejledning til installation og konfiguration af Svareksponeringsservice 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.

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.

Dokumenthistorik

Version

Dato

Ansvarlig

Beskrivelse

0.9

18.8.2016

Systematic

Første udgave

1.0

21.9.2016

Systematic

Klargjort til release

Definitioner og referencer

Definition

Beskrivelse

DDS

Dokumentdelingsservice

NSI

National Sundheds-IT

NSP

Den nationale service platform (inden for sundheds-IT)

DODI

NSI platform til data opsamling og distribution

XDS

Cross-Enterprise Document Sharing

Alias

Beskrivelse

Driftsvejledning

Driftsvejledning Svareksponeringsservice XDS-adapter, (SSE/11734/OHB/0017)

Krav til miljø

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

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.

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.

Krav til adgang til andre services

Der skal være adgang til Svareksponeringsservicen hos Laboratoriedatabanken

Krav til datahåndtering

SXA XDS Repository Adapter foretager udtræk af dokumenter fra anden service. SXA XDS Repository Adapter gemmer ikke disse dokumenter, men behandler dem og sender indhold videre til kalderen.

Krav til hardware

Svareksponeringsservice XDS Repository Adapter's ressourceforbrug vil afhænge af flere parametre:

  • Størrelsen af de dokumenter der hentes.
  • Antallet af dokumenter der hentes samtidig


Deployment på WildFly 8.2

Dette afsnit beskriver deploymentprocessen på WildFly 8.2.

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 tilgængelig og indeholdte filer potentielt tilpasset som beskrevet i afsnit 3.2.

<packing>/xdswrappers/documentmetadataprovider-war/target/sxa-documentmetadataprovider.war
<packing>/xdswrappers/documentprovider-war/target/sxa-documentprovider.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.
Optionelt kan der opsættes en stub service, som returnerer dokumenter ligesom laboratoriedatabanken. I dette tilfælde skal en ekstra servicekomponent deployeres til Wildfly.

<packing>/labreportservicestub/labreportservicestub/target/labreportservicestub.war


Yderligere information er at finde i driftsvejledningen.

Konfiguration af komponenterne

Al konfiguration, undtagen udpegning af log4j-konfigurationsfilen (se afsnit 3.2.2.5 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.


Deployment af Modul

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

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/module.xml
->
/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentmetadataprovider/config/main
----------------------------------------------------------------------------
<packing>/xdswrappers/documentprovider-war/src/test/resources/module.xml
->
/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentprovider/config/main


Konfiguration af Svareksponeringsservice XDS Registry Adapter

sxametadataconfiguration.xml

Konfigurerer opsætning af dokument-metadata anvendt af Svareksponeringsservice XDS Registry Adapter.
En skabelon for denne fil findes i:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/sxametadataconfiguration.xml


Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentmetadataprovider/config/main


Yderligere information kan findes i driftsvejledningen.

sxafilterconfiguration.xml

Konfigurerer opsætning af, hvordan Svareksponeringsservice 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/sxafilterconfiguration.xml


Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentmetadataprovider/config/main


Yderligere information kan findes i driftsvejledningen.

sxapracticesettingcodes.xml

Filen konfigurerer mapningen mellem søgeparametre for dokumentdeling og specialer fra Svareksponeringsservicen. En færdig skabelon findes i:

<packing>/xdswrappers/provider-common/src/test/resources/sxapracticesettingcodes.xml


Filen placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentmetadataprovider/config/main


Yderligere information kan findes i driftsvejledningen.

log4j-sxa-documentmetadataprovider-ws.xml

Konfigurerer logopsætningen for Svareksponeringsservice XDS Registry Adapter.
En skabelon for log4j konfiguration findes i:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/log4j-sxa-documentmetadataprovider-ws.xml


Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentmetadataprovider/config/main 


Den tilhørende fil:

<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/log4j.dtd


kopieres ligeledes til:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentmetadataprovider/config/main 


I det følgende vises hvordan standalone.xml opdateres med logging profile konfigurationen specifikt til Svareksponeringsservice XDS Registry Adapter, men opsætningen er også mulig igennem WildFly Administration Console. Konfigurationen er udelukkende til stede for at Svareksponeringsservice XDS Registry Adapters egen log4j logning virker, men er ikke sat op til at blive brugt, hvilket fremgår af at konfigurationen af level er sat til OFF.

<logging-profile name="sxa-metadataprovider-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>


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 sxa-documentmetadataprovider.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 Svareksponeringsservice XDS Registry Adapter's modul på WildFly.

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/
log4j-nspslalog-sxa-documentmetadataprovider-ws.properties
nspslalog-sxa-documentmetadataprovider.properties


Filerne redigeres inden de placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentmetadataprovider/config/main


Yderligere information kan findes i driftsvejledningen.

Konfiguration af Svareksponeringsservice XDS Repository Adapter

SXADocumentProvider.properties

Filen konfigurerer parametre anvendt ved kald af Svareksponeringsservicen. En skabelon findes i:

<packing>/xdswrappers/documentprovider-war/src/test/resources/SXADocumentProvider.properties


Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentprovider/config/main


Yderligere information kan findes i driftsvejledningen.

sxaproviderconfiguration.xml

Konfigurerer metadata opsætning af Svareksponeringsservice XDS Repository Adapter.
En skabelon for denne fil findes i:

<packing>/xdswrappers/documentprovider-war/src/test/resources/sxaproviderconfiguration.xml


Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentprovider/config/main


Yderligere information kan findes i driftsvejledningen.

sxapracticesettingcodes.xml

Filen konfigurerer mapningen mellem søgeparametre for dokumentdeling og specialer fra Svareksponeringsservicen. En færdig skabelon findes i:

<packing>/xdswrappers/provider-common/src/test/resources/sxapracticesettingcodes.xml


Filen placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentprovider/config/main


Yderligere information kan findes i driftsvejledningen.

log4j-sxa-documentprovider-ws.xml

Konfigurerer logopsætningen for Svareksponeringsservice XDS Repository Adapter.
En skabelon for log4j konfiguration findes i:

<packing>/xdswrappers/documentprovider-war/src/test/resources/log4j-sxa-documentprovider-ws.xml


Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentprovider/config/main 


Den tilhørende fil:

<packing>/xdswrappers/documentprovider-war/src/test/resources/log4j.dtd


kopieres ligeledes til:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentprovider/config/main 


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

<logging-profile name="sxa-provider-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>


Udpegning af log4j-konfigurationsfilen

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

documentsharing.log4j.properties


under roden i war-filen sxa-documentprovider.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 Svareksponeringsservice XDS Repository Adapter's modul på WildFly.

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/
log4j-nspslalog-sxa-documentprovider.properties
nspslalog-sxa-documentprovider.properties


Filerne redigeres inden de placeres på WildFly i:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentprovider/config/main


Yderligere information kan findes i driftsvejledningen.

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


Logfiler

Svareksponeringsservice 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.4, 3.2.2.6, 3.2.3.4 og 3.2.3.6.
Alle logs er beskrevet i \[Driftsvejledning\].


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.

Af-installation af servicen

Fjern service-komponenter under WildFly' deployments/ folder:

sxa-documentmetadataprovider.war
sxa-documentprovider.war 


Fjern properties filer under Svareksponeringsservice XDS Adaptere modul-foldere:

/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentmetadataprovider/config/main
/pack/wildfly8/modules/nsi/ddsprojects/sxa/documentprovider/config/main


Fjern eventuelt logfiler – se afsnit 3.4.

  • No labels