Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootLaboratoriesvarservice (SXA) - Leverancebeskrivelse
includeroottrue


Anchor
_Toc40578283
_Toc40578283
Anchor
_GoBack
_GoBack
Anchor
_Toc292960798
_Toc292960798
Anchor
_Toc327798371
_Toc327798371
Anchor
_Toc277248668
_Toc277248668
Anchor
_Toc44403513
_Toc44403513
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

Anchor
_Toc327955587
_Toc327955587
Anchor
_Toc462259824
_Toc462259824
Introduktion

Anchor
_Toc316542421
_Toc316542421
Anchor
_Ref317083052
_Ref317083052
Anchor
_Toc327955588
_Toc327955588
Anchor
_Toc462259825
_Toc462259825
Formål

Anchor
_Toc318379509
_Toc318379509
Anchor
_Toc325523296
_Toc325523296
Anchor
_Toc317839916
_Toc317839916
Anchor
_Toc44403516
_Toc44403516
Anchor
_Toc239132517
_Toc239132517
Anchor
_Toc243720169
_Toc243720169
Anchor
_Toc316542422
_Toc316542422
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.

Anchor
_Toc327955590
_Toc327955590
Anchor
_Toc462259826
_Toc462259826
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.

Anchor
_Toc317831244
_Toc317831244
Anchor
_Toc317839917
_Toc317839917
Anchor
_Toc327955591
_Toc327955591
Anchor
_Toc462259827
_Toc462259827
Dokumenthistorik

Version

Dato

Ansvarlig

Beskrivelse

0.9

18.8.2016

Systematic

Første udgave

1.0

21.9.2016

Systematic

Klargjort til release

Anchor
_Toc327955592
_Toc327955592

Anchor
_Toc462259828
_Toc462259828
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

Anchor
driftsvejledning
driftsvejledning
Driftsvejledning

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

Anchor
_Toc318271581
_Toc318271581
Anchor
_Ref326672747
_Ref326672747
Anchor
_Toc327955593
_Toc327955593
Anchor
_Toc462259829
_Toc462259829
Krav til miljø

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

Anchor
_Toc318271582
_Toc318271582
Anchor
_Toc327955594
_Toc327955594
Anchor
_Toc462259830
_Toc462259830
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.

Anchor
_Toc318271583
_Toc318271583
Anchor
_Toc327955595
_Toc327955595
Anchor
_Toc462259831
_Toc462259831
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.

Anchor
_Toc327955597
_Toc327955597
Anchor
_Toc318271585
_Toc318271585
Anchor
_Toc462259832
_Toc462259832
Krav til adgang til andre services

Der skal være adgang til Svareksponeringsservicen hos Laboratoriedatabanken

Anchor
_Toc327955598
_Toc327955598
Anchor
_Toc462259833
_Toc462259833
Krav til datahåndtering

Anchor
_Toc327955599
_Toc327955599
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.

Anchor
_Toc462259834
_Toc462259834
Krav til hardware

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

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


Anchor
_Toc318271592
_Toc318271592
Anchor
_Ref326673205
_Ref326673205
Anchor
_Ref327263957
_Ref327263957
Anchor
_Toc327955604
_Toc327955604
Anchor
_Toc462259835
_Toc462259835
Deployment på WildFly 8.2

Dette afsnit beskriver deploymentprocessen på WildFly 8.2.

Anchor
_Toc318271594
_Toc318271594
Anchor
_Toc327955606
_Toc327955606
Anchor
_Ref404866726
_Ref404866726
Anchor
_Toc462259836
_Toc462259836
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.

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

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


Yderligere information er at finde i driftsvejledningen.

Anchor
_Toc318271596
_Toc318271596
Anchor
_Ref326072243
_Ref326072243
Anchor
_Ref327263945
_Ref327263945
Anchor
_Toc327955607
_Toc327955607
Anchor
_Ref404865649
_Ref404865649
Anchor
_Toc462259837
_Toc462259837
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.


Anchor
_Toc435691889
_Toc435691889
Anchor
_Toc435693170
_Toc435693170
Anchor
_Toc462259838
_Toc462259838
Deployment af Modul

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

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


Anchor
_Ref326822174
_Ref326822174
Anchor
_Toc327955609
_Toc327955609
Anchor
_Toc462259839
_Toc462259839
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:

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


Filen redigeres inden den placeres på WildFly i:

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

Code Block
<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/sxafilterconfiguration.xml


Filen redigeres inden den placeres på WildFly i:

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


Yderligere information kan findes i driftsvejledningen.

Anchor
_Ref404866587
_Ref404866587
sxapracticesettingcodes.xml

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

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


Filen placeres på WildFly i:

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


Yderligere information kan findes i driftsvejledningen.

Anchor
_Ref462259730
_Ref462259730
log4j-sxa-documentmetadataprovider-ws.xml

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

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


Filen redigeres inden den placeres på WildFly i:

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


Den tilhørende fil:

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


kopieres ligeledes til:

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

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


Anchor
_Ref404867071
_Ref404867071
Anchor
_Toc326736431
_Toc326736431
Anchor
_Toc327092937
_Toc327092937
Anchor
_Toc327955611
_Toc327955611
Anchor
_Toc318271597
_Toc318271597
Udpegning af log4j-konfigurationsfilen

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

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

Anchor
_Ref462259750
_Ref462259750
Konfiguration af NSP SLA log

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

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

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


Yderligere information kan findes i driftsvejledningen.

Anchor
_Toc462259840
_Toc462259840
Konfiguration af Svareksponeringsservice XDS Repository Adapter

SXADocumentProvider.properties

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

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


Filen redigeres inden den placeres på WildFly i:

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

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


Filen redigeres inden den placeres på WildFly i:

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


Yderligere information kan findes i driftsvejledningen.

Anchor
_Ref404866884
_Ref404866884
sxapracticesettingcodes.xml

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

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


Filen placeres på WildFly i:

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


Yderligere information kan findes i driftsvejledningen.

Anchor
_Ref462259773
_Ref462259773
log4j-sxa-documentprovider-ws.xml

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

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


Filen redigeres inden den placeres på WildFly i:

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


Den tilhørende fil:

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


kopieres ligeledes til:

Code Block
/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).

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


Anchor
_Ref404867078
_Ref404867078
Udpegning af log4j-konfigurationsfilen

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

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

Anchor
_Ref462259783
_Ref462259783
Konfiguration af NSP SLA log

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

Code Block
<packing>/xdswrappers/documentprovider-war/src/test/resources/
log4j-nspslalog-sxa-documentprovider.properties
nspslalog-sxa-documentprovider.properties


Filerne redigeres inden de placeres på WildFly i:

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


Yderligere information kan findes i driftsvejledningen.

Anchor
_Toc318271598
_Toc318271598
Anchor
_Ref326657454
_Ref326657454
Anchor
_Toc327955613
_Toc327955613
Anchor
_Toc462259841
_Toc462259841
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:

Code Block
/etc/init.d/wildfly8 restart


Anchor
_Toc318271599
_Toc318271599
Anchor
_Ref326672401
_Ref326672401
Anchor
_Toc327955614
_Toc327955614
Anchor
_Toc462259842
_Toc462259842
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\].


Anchor
_Toc318271595
_Toc318271595
Anchor
_Toc327955615
_Toc327955615
Anchor
_Toc462259843
_Toc462259843
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.

Anchor
_Toc327955616
_Toc327955616
Anchor
_Toc462259844
_Toc462259844
Af-installation af servicen

Fjern service-komponenter under WildFly' deployments/ folder:

Code Block
sxa-documentmetadataprovider.war
sxa-documentprovider.war 


Fjern properties filer under Svareksponeringsservice XDS Adaptere modul-foldere:

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