Introduktion
Formål
Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af komponenten.
Driftsvejledningen indeholder information om DDS Registry og Repository 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 (Komponenter) er beskrevet hvilke komponenter, der indgår i DDS Registry og Repository og deres forventede placering med hensyn til platform.
Afsnit 4 (Konfiguration) beskriver aktuelle konfigurationsparametre for DDS Registry henholdsvis Repository, samt eksempler på konfigurationsparameter-filer.
Afsnit 5.1, 5.2 og 5.3 (Overvågning) beskriver hvorledes DDS Registry og Repository komponenterne overvåges.
I afsnit 5.4 er DDS Registry og Repository-relaterede logfiler beskrevet, så disse evt. kan overvåges, og tillige danne baggrund for fejlsøgning.
Beskrivelse af standard fejlsøgning og start/stop vejledning for komponenterne er beskrevet i afsnit 6 (Standard fejlsøgning).
Specielle krav til backup er beskrevet i afsnit 7 (Krav til backup m.m.), ligesom procedure ved reetablering af komponenten 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, MySQL, samt Ubuntu Linux operativ system.
Dokumenthistorik
Dokumentet er oprettet med udgangspunkt i 2 separate Driftsvejledninger for registry henholdsvis repository. Den videre redigeringshistorik efter dette tidspunkt fremgår af confluence "Page History".
Definitioner og referencer
Definition | Beskrivelse |
---|---|
DCC | Dekoblingskomponenten på NSP |
DDS | Dokumentdelingsservice |
DKS | DCC Konfigurations Service |
ITI | IT Infrastructure, fra Integrating the Healthcare Enterprise (IHE). |
NSI | National Sundheds-IT |
NSP | Den nationale service platform (inden for sundheds-IT) |
SHAK | Sygehusafdelingsklassifikation |
SOR | Sundhedsvæsenets organisationsregister |
STS | Security Token Service |
AP | Almen praksis |
Alias | Beskrivelse |
---|---|
DKS-beskrivelse | https://www.nspop.dk/display/web/DKS+--+DCC+Konfiguration+Service, hentet 02.09.2016. |
Komponenter
Dette dokument dækker følgende dokument delings komponenten (DDS) på NSP. Den består af 2 logiske komponenter:
- DDS Registry
- Type: Webservice
- Filnavn: ddsregistry.war
- Servicecheckurl: <serverurl>/ddsregistry/servicecheck
- Statusurl: <serverurl>/ddsregistry/status
- Versionurl: <serverurl>/ddsregistry/version
- Endpoint for RegistryStoredQuery:
- Url: <serverurl>/ddsregistry
- DKS-konfiguration: <serverurl>/ddsregistry/dccconfig/dks
DDS Repository
Type: Webservice
Filnavn: ddsrepository.war
Url: <serverurl>/ddsrepository
Servicecheckurl: <serverurl>/ddsrepository/servicecheck
Statusurl: <serverurl>/ddsrepository/status
Versionurl: <serverurl>/ddsrepository/version
DKS-konfiguration: <serverurl>/ddsrepository/dccconfig/dks
DDS komponenterne anvender desuden ConsentVerification-servicen, MinLog Registration-servicen, Behandlingsrelationsservicen samt STS’en.
DDS registry anvender også HealthShare Document Registry servicen. Mens DDS repository gør brug af nul, et eller flere XDS repositories.
Daglig drift
Dette afsnit beskriver den daglige drift af systemet.
Relaterede services
DDS Registry og Repository afhænger af tilstedeværelsen af en række andre services, og ved fejl i disse vil DDS fejle tilsvarende. Disse services er:
- STS
- Samtykkeverifikationsservice
- DDS registry også:
- Nationale registry NXRG samt andre bagvedliggende registry services (som konfigureret i databasen)
Desuden er DDS Registry og Repository afhængig af følgende services, hvor fejl ikke bevirker fejl af DDS:
- Behandlingsrelationsservice
- MinLogRegistration-service
Consent override log
DDS Registry og Registry logger brug af værdispring til consent override loggen (ddsregistry-consentoverride.log). Denne skal kunne indsamles og der skal foretages opfølgning på indholdet af dette. Den skal derfor være tilgængelig for indsamling, og må ikke fjernes andet end i denne forbindelse.
DDS registrys Adgang via Trust Konfigurationsfiler
Enabling
Tjek for adgang via Trust for ikke-autoriserede sundhedspersoner bliver aktiveret, hvis property trusted.roles.filename er angivet i DDSRegistry.properties.
Hvis man ønsker at aktivere eller de-aktivere tjekket, så kræver det ændring af DDSRegistry.properties og genstart af Wildfly.
Format
For Trust konfigurationsfilerne gælder følgende:
- Alle linier der starter med # betragtes som en kommentar.
- Blanke linier er tilladte.
- Alle andre linier bliver behandlet.
- Ved fejl skrives en fejlbesked til loggen - den fejlramte linie ignoreres og indlæsningen fortsætter.
- Parserne er case-sensitive.
Liste af roller i Trust (trusted.roles)
Filen der indeholder listen af roller, som en ikke autoriseret sundhedsperson kan få adgang til DDS med, er angivet ved property trusted.roles.filename.
Trust rollen er angive som følgende:
ROLLETEKST¤ROLLEID¤POSITIVLISTE AF DOKUMENTTYPER[,]
Tegnet ¤ bruges til at opdele linier i 3 dele:
- ROLLETEKST - en kort beskrivelse af den rolle linien omhandler.
- ROLLEID - en unik nøgle der angiver rollen. Nøglen har følgende format fra SOSI id kortet
- urn:dk:healthcare:national-federation-role:code:<kode>:value:<værdi>
- POSITIVLISTE AF DOKUMENTTYPER - liste af dokumenttyper, som rollen giver adgang til adskilt med komma.
Eksempel på indhold i fil med Trust roller:
|
Genindlæsning
Hvis der er ændringer til konfigurationsfilerne for adgang via Trust, så skal WildFly genstartes før ændringerne er aktive.
Konfiguration
Komponenterne afvikles i et docker-compose setup, som ligger under https://svn.nspop.dk/svn/components/dds/trunk/compose.
En række af DDS registry og DDS repositorys properties har samme navne og anvendelse. Derfor beskrives disse sammen nedenfor. Efterfølgende beskrives de properties, som adskiller sig for de 2 komponenter.
DDS Registry og Repository
Servicekonfiguration
Grundlæggende konfiguration foregår ved redigering i filerne
- For DDS registry: DDSRegistry.properties. Filen er placeret i compose/configuration/ddsregistry, og er volume-mappet.
- For DDS repository: DDSRepository.properties. Filen er placeret i compose/configuration/ddsrepository, og er volume-mappet.
I filerne skal følgende properties være definerede. Bemærk kolonnerne "Reg" og "Rep" der angiver med 'x' om propertien kan anvendes for registry henholdsvis repository properties filen.
Bemærk at overstregede properties ikke længere indlæses af DDS Registry, men er hardcodet som følge af ændring i DGWS håndtering. Værdierne skal stadig være tilgængelige i properties filen.
Registry og Repository properties
Property | Reg | Rep | Beskrivelse |
---|---|---|---|
idcard.version | x | x | Servicen afviser kald, hvor ID-kort i Security-header ikke har versionsnummer opgivet som værdien af denne property. Angives til 1.0.1. |
sts.test.mode | x | x | Angiver med værdien true at servicen benytter test-STS. Værdien skal være ’false’ i drift, hvorved den rigtige SOSI-STS anvendes. |
log.config.file | x | x | Angiver placering af log4j properties. |
client.consentverification.properties | x | x | Angiver placering af properties til kald af Samtykkeverifikationsservicen. |
client.minlogregistration.properties | x | x | Angiver placering af properties til kald af MinLog Registreringsservicen. |
client.treatment.relation.properties | x | x | Angiver placering af properties til kald af behandlingsrelationsservicen. |
treatment.relation.service.invoke | x | x | Angiver med værdien true, at behandlingsrelationsservicen skal kaldes. Værdien false bevirker, at behandlingsrelationsservicen ikke kaldes. |
servicestatuscheck.consentverification.failurethreshold | x | x | Antal kald til samtykkeverifikationsservicen der må fejle før der meldes 500 på statussnitfladen. |
servicestatuscheck.treatmentrelation.failurethreshold | x | x | Antal kald til BRS der må fejle før der meldes 500 på statussnitfladen. |
servicestatuscheck.minlog.failurethreshold | x | x | Antal kald til MinLog der må fejle før der meldes 500 på statussnitfladen. |
servicestatuscheck.database.failurethreshold | x | x | Antal kald til lokal database der må fejle før der meldes 500 på statussnitfladen. |
servicestatuscheck.unlockdelay | x | x | Antal sekunder fra statussnitfladen melder 500 til at antal fejl kald nulstilles. |
sts.keystore | x | x | Keystore, der indeholder DDS Registrys/Repository funktionscertifikat |
sts.keystore.password | x | x | Password til sts.keystore |
sts.endpoint | x | x | Endpointet, hvor DDS Registry/Repository skal trække sit SOSI IDkort på baggrund af sts.keystore |
idcard.subject.id.type | x | x | Subjecttype for IDKortet |
idcard.subject.id | x | x | Subjectid for IDKortet |
idcard.subject.name | x | x | Subjectnavn for IDKortet |
idcard.level | x | x | Sikkerhedsniveau for IDkortet |
idcard.system.name | x | x | Systemnavn i IDkortet |
whitelisted.level3.cvrs | x | x | Liste (kommasepareret) af whitelistede CVR numre og certifikater som DDS'en tillader kald med niveau 3 Idkort fra (se afsnit nedenfor vedr. whitelisting for detaljer vedr. format) |
dds.citizen.powerofattorney.privileges | x | x | Det fuldmagtsprivilegie, der tillader at en borger tilgår en anden borgers data via DDS |
client.documentregistry.properties | x | Angiver placering af properties til kald af det nationale registry (NXRG) samt andre bagvedliggende registry services. | |
registry.invoker.use.fastinfoset | x | Angiver med værdien true, at servicen skal tilbyde anvendelse af Fast Infoset ved kommunikation med XDS Registries. Ved værdien false foregår kommunikationen med vanlig XML. | |
minlog.query.default | x | x | Teksten der sendes til MinLog registreringsservicen, når en sundhedsperson laver opslag/dataudtræk. |
minlog.query.consentoverride | x | x | Teksten der sendes til MinLog registreringsservicen, når en sundhedsperson laver opslag/dataudtræk med tilsidesættelse af samtykketjek (værdispring). |
minlog.query.childcustodyholder | x | x | Teksten der sendes til MinLog registreringsservicen, når en borger laver opslag/dataudtræk på vegne af en anden borger, hvor vedkommende er forældremyndighedsindehaver. |
minlog.query.proxyholder | x | x | Teksten der sendes til MinLog registreringsservicen, når en borger laver opslag/dataudtræk på vegne af en anden borger, hvor vedkommende er fuldmagtshaver. |
minlog.query.guardian | x | x | Teksten der sendes til MinLog registreringsservicen, når en borger laver opslag/dataudtræk på vegne af en anden borger, hvor vedkommende er værge. |
ap.assigning.authorities.filename | x | Angiver fil med liste af AP, der indgår i komplekseforløb pilotprojektet. | |
ap.patient.consent.filename | x | Angiver fil med liste af patienter, der har givet samtykke til AP. | |
validation.response.ydernummer | x | Valideringsniveau for ydernummer-validering. Eksempel: WARNING, OFF. Default: WARNING | |
oid.assignment.ydernummer | x | OID for ydernummer. Default: 1.2.208.176.1.4 | |
client.documentrepository.properties | x | Angiver placering af properties til kald af dokumentkilder, hvor snitfladen til indhentning af dokument benytter Den Gode Webservice. | |
repository.retrieve.documents.processing.timeout | x | Antal millisekunder, der afventes svar fra kaldt XDS Repository med henblik på at samle svar fra eventuelt flere kaldte XDS Repositories til videre processering. Dette er ikke en timeout på kaldet til XDS Repository, der i stedet er konfigureret i documentsource-tabellen i databasen jf. afsnit 4.1.5. | |
retrieved.documents.processing.timeout | x | Antal millisekunder, der afventes færdiggørelse af efterprocessering af svar med henblik på at samle efterprocesserede svar i det samlede svar. Dette er ikke en timeout, der bevirker udelukkelse af svar. | |
dds.minlog.on.idcard.level3.enabled | x | Angiver, om DDS skal minlogge, når der kaldes med SOSI Idkort niveau 3 |
I den/de properties-filer, der udpeges af de forskellige ”client.*.properties” properties skal flg. properties defineres:
Property | Reg | Rep | Beskrivelse |
---|---|---|---|
verification.wsdl.location | x | x | Angiver service endpoint for Samtykkeverifikationsservicen |
registration.log.organisation_name | x | x | Angiver standard organisationsnavnet, der bliver sendt til MinLog Registreringsservicen. |
treatment.relation.wsdl.location | x | x | Angiver service endpoint for behandlingsrelationsservicen |
treatment.relation.service.timeout | x | x | Timeout givet i millisekunder anvendt ved kald til behandlingsrelationsservicen |
verification.invoker.timeout | x | x | Timeout givet i millisekunder anvendt ved kald til samtykke verifikationsservicen. |
minlog.producer.bootstrap.servers | x | x | Kafka bootstrap servers der anvendes til MinLog registrering. |
minlog.producer.client.id | x | x | Kafka klient id anvendt til MinLog registrering. |
minlog.producer.key.serializer | x | x | Kafka key serializer. Skal være "org.apache.kafka.common.serialization.StringSerializer" |
minlog.producer.value.serializer | x | x | Kafka value serializer. Skal være "org.apache.kafka.common.serialization.StringSerializer" |
minlog.topic | x | x | Kafka topic til MinLog registrering. |
dds.minlog.on.idcard.level3.enabled | x | Angiver, om DDS skal minlogge, når der kaldes med SOSI Idkort niveau 3 Skal sættes: true, false | |
personinformation.maxTotalConnections | x | x | Konfiguration af client pool til kald af CPRExists service |
personinformation.defaultMaxConnectionsPerRoute | x | x | Konfiguration af client pool til kald af CPRExists service |
personinformation.url | x | x | Peger på endpointet for PersonInformationServicen. |
Udover ovenstående skal følgende angives i den properties fil, der er udpeget i propertien ”client.treatment.relation.properties”. Disse forholder sig til værdier i SOAP requesten til behandlingsrelationsservicen og de følgende beskrivelser refererer til elementer i denne.
Property | Reg | Rep | Beskrivelse |
---|---|---|---|
treatment.relation.serviceprovider.vendor | x | x | Indsættes som ’ServiceProvider/Vendor’ i behandlingsrelationsservicens treatmentRelationRequestBody |
treatment.relation.serviceprovider.version | x | x | Indsættes som ’ServiceProvider/Version’ i behandlingsrelationsservicens treatmentRelationRequestBody |
treatment.relation.lookup.timeinterval.start.offset | x | x | Angiver antallet af dage fra DDS-kaldtidspunktet, der skal indsættes som tidsstemplet ’RelationLookupTimeInterval/start’ i behandlingsrelationsservicens treatmentRelationRequestBody. Negativt fortegn angiver antal dage før DDS-kaldtidspunktet. |
treatment.relation.lookup.timeinterval.end.offset | x | x | Angiver antallet af dage fra DDS-kaldtidspunktet, der skal indsættes som tidsstemplet ’RelationLookupTimeInterval/end’ i behandlingsrelationsservicens treatmentRelationRequestBody. Negativt fortegn angiver antal dage før DDS-kaldtidspunktet. |
treatment.relation.timelimit.offset | x | x | Angiver antallet af dage fra DDS-kaldtidspunktet, der skal indsættes som tidsstemplet ’TimeLimit’ i behandlingsrelationsservicens treatmentRelationRequestBody. |
treatment.relation.queryable.cvr | x | x | Indsættes som ’QueryableCvr’ i behandlingsrelationsservicens treatmentRelationRequestBody |
treatment.relation.external.reference.id | x | x | Indsættes som ’ExternalReferenceId’ i behandlingsrelationsservicens treatmentRelationRequestBody |
treatment.relation.acceptable.relations.hospital | x | x | Kommasepareret liste af kategorier, der indsættes som ’AcceptableRelations/Relation’ i behandlingsrelationsservicens treatmentRelationRequestBody, når sundhedspersonens organisation er opført som hospital (ved SHAK-kode). |
treatment.relation.followup.relations.hospital | x | x | Kommasepareret liste af kategorier, der indsættes som ’FollowupRelations/Relation’ i behandlingsrelationsservicens treatmentRelationRequestBody, når sundhedspersonens organisation er opført som hospital (ved SHAK-kode). |
treatment.relation.acceptable.relations.doctor | x | x | Kommasepareret liste af kategorier, der indsættes som ’AcceptableRelations/Relation’ i behandlingsrelationsservicens treatmentRelationRequestBody, når sundhedspersonens organisation er opført som yder (ved ydernummer). |
treatment.relation.followup.relations.doctor | x | x | Kommasepareret liste af kategorier, der indsættes som ’FollowupRelations/Relation’ i behandlingsrelationsservicens treatmentRelationRequestBody, når sundhedspersonens organisation er opført som yder (ved ydernummer). |
treatment.relation.acceptable.relations.organization | x | x | Kommasepareret liste af kategorier, der indsættes som ’AcceptableRelations/Relation’ i behandlingsrelationsservicens treatmentRelationRequestBody, når sundhedspersonens organisation er opført som SOR (ved SOR-kode). |
treatment.relation.followup.relations.organization | x | x | Kommasepareret liste af kategorier, der indsættes som ’FollowupRelations/Relation’ i behandlingsrelationsservicens treatmentRelationRequestBody, når sundhedspersonens organisation er opført som SOR (ved SOR-kode). |
Registry properties
I metadata er identifikation af sundhedsorganisationer givet ved et id og anførelse af hvilken assigning authority, der har udstedt det id. I DDSRegistry.properties skal der ved properties givet i Tabel 1 være anført, hvilke object identifiers (OID), der anvendes for assigning authority for sundhedsorganisationers id.
Property | Beskrivelse |
---|---|
consent.check.sor.assigning.authorities.oid | |
consent.check.shak.assigning.authorities.oid | |
consent.check.ynumber.assigning.authorities.oid | |
registering.allowed.sor.assigning.authorities.oid | |
registering.allowed.shak.assigning.authorities.oid | |
registering.allowed.ynumber.assigning.authorities.oid |
Tabel 1 OID for assigning authorities for sundhedsorganisationer
OID-værdier for assigning authorities givet i mønsteret properties consent.check.* (fx consent.check.sor.assigning.authorities.oid) er de, der anvendes ved samtykkekontrol ved opslag på eksisterende metadata. Disse lister af OID-værdier vil vokse over tid og afspejle også evt. historiske assigning authorities.
OID-værdier for assigning authorities givet i mønsteret properties registering.allowed.* (fx registering.allowed.sor.assigning.authorities.oid) er de, der tillades ved dokumentkilders registrering af dokumentmetadata. Disse lister af OID-værdier bør kun afspejle de assigning authorities, der er i anvendelse på registreringstidspunktet.
Eksempel på ”DDSRegistry.properties” fil (bemærk at alle ”client.*.properties” udpeger filen selv, og at klient properties derfor er defineret i samme fil):
|
Eksempel på ”DDSRepository.properties” fil (bemærk at alle ”client.*.properties” udpeger filen selv, og at klient properties derfor er defineret i samme fil):
|
Konfiguration af indeks for DDS registry
ReposiDe dokumentindeks, hvortil DDSRegistry videresender opslag og registrering af dokumenter, er konfigureret i tabellen documentregistry i databasen documentsources.
Kolonne | Type | Beskrivelse |
---|---|---|
documentregistryid | int | unikt id for rækken |
documentregistryserviceurl | streng | Adressen for indeksets webservice-endpoint givet som URI. |
documentregistryfriendlyname | streng | Et relativt brugervenligt navn for indekset, der indgår i fejlbeskeden, når indekset ikke svarer rettidigt eller ikke kan tilgås. |
documentregistryservicenamespace | streng | Namespace anvendt af indeksets webservice-endpoint. Standard-værdien er urn:ihe:iti:xds-b:2007. |
documentregistrylocal | boolsk værdi | Hvorvidt indekset er lokalt eller ej. Dokumentdelingsservicen skal have præcis et lokalt indeks, der benyttes ved registrering af dokumenter. Værdien 1 anfører lokalt indeks, 0 ellers. |
documentregistrytimeoutvalue | int | Timeout givet i millisekunder anvendt ved Dokumentdelingsservicens opslag mod indekset, dvs. timeout for kald af indeksets webservice. |
documentregistryactive | boolsk værdi | Hvorvidt indekset anvendes eller ej. Værdien 1 anfører, at indekset anvendes, 0 ellers. |
documentregistryservicename | streng | Navnet på service-gruppen for indeksets webservice. Standard-værdien er DocumentRegistry_Service. |
documentregistryfailurethreshold | int | Grænseværdi for hvor mange kald til indekset der må fejle før monitoreringssnitfladen melder fejl. |
documentregistrysoapversion | streng | Hvorvidt der skal anvendes headere af type HSUID, DGWS (Security og Medcom) og Medcom fra DGWS. |
documentregistryititransaction | streng | Beskrivelse af hvilken ITI transaction, der kan anvendes på dokumentindekset. Understøtter en dokumentindeks flere ITI transactions skal der laves en indgang per ITI transaction. Se Tabel 4 for lovlige værdier, hvoraf der skal anføres en enkelt. |
Tabel 2 Tabellen documentregistry i documentsources-databasen
Værdi | Benytter HSUID udgående | Benytter DGWS udgående | Note |
---|---|---|---|
1.2 | ✓ | ÷ | |
1.2_NO_HSUID | ÷ | ÷ | |
1.2_DGWS | ✓ | ✓ | |
1.2_DGWS_NO_HSUID | ÷ | ✓ | |
1.2_MEDCOM_NO_HSUID | ÷ | (✓) Kun Medcom-header | |
1.2_NO_ADDR | ✓ | ÷ | Kalder uden addressing headers. |
Tabel 3 Værdier for documentregistrysoapversion, der anfører hvilke headere, der anvendes ved udgående kald fra DDS Registry mod XDS-komponenter.
Værdi | Beskrivelse |
---|---|
ITI-18 | Benyttes til opslag på metadata via Registry Stored Query ITI-18 transaktionen. |
Tabel 4 Værdier for documentregistryititransaction, der anfører hvilken ITI transaction, den givne indgang kan anvendes med.
Følgende er et eksempel på konfigurering af et lokalt, aktivt indeks:
Kolonne | Værdi |
---|---|
documentregistryid | 1 |
documentregistryserviceurl | http://sv-proj-093:57774/csp/public/hsbus/HS.IHE.XDSb.Registry.Services.cls |
documentregistryfriendlyname | DDS |
documentregistryservicenamespace | urn:ihe:iti:xds-b:2007 |
documentregistrylocal | 1 (true) |
documentregistrytimeoutvalue | 300000 |
documentregistryactive | 1 (true) |
documentregistryservicename | DocumentRegistry_Service |
documentregistryfailurethreshold | 5 |
documentregistrysoapversion | 1.2_MEDCOM_NO_HSUID |
documentregistryititransaction | ITI-18 |
Tabel 5 Eksempel på konfiguration af indeks
For at tilføje et indeks til konfigurationen, udføres et SQL-statement i stil med:
|
log4j konfiguration
Log4j konfiguration findes i (hvis ovenstående format anvendes):
- For DDS registry: compose/configuration/ddsregistry/ddsregistry.log4j.properties filen.
- For DDS repository: compose/configuration/ddsrepository/ddsrepository.log4j.properties filen
Se yderligere opsætning i installationsvejledningen.
SLA-log konfiguration
SLA-logning på DDS Registry og Repository udføres vha SLALoggingInterceptor. Konfiguration af SLA-log findes i filen:
- For DDS registry: compose/configuration/ddsregistry/nspslalog-ddsregistry.properties.
- For DDS repository: compose/configuration/ddsrepository/nspslalog-ddsrepository.properties.
Whitelist konfiguration
Der foretages whitelisting på to niveauer. Først er der den whitelisting, der skal til for at anvende DDS Registry og Repository. Derudover findes en whitelisting, der afgør, hvorvidt en anvender må kalde DDS med et niveua 3 Idkort. De to whitelisting-mekanismer beskrives i det følgende.
Whitelisting til anvendelse af DDS Registry og Repository
For at tilføje et CVR-nummer til white-list databasen, bruges følgende SQL insert:
For DDS registry:
|
For DDS repository:
|
Da DDS Registry og Repository sender Id-kortet videre til samtykkeservice, behandlingsrelationsservice og minlog-registrationservice skal whitelisten også opdateres med følgende værdier:
|
Whitelisting til kald med niveau 3 Idkort
Alle anvendere skal whitelistes som beskrevet ovenfor for at anvende DDS Registry og Repository. Derudover findes en ekstra whitelisting mekanisme, som gør det muligt for visse anvendere at kalde DDS Registry og Repository med et niveau 3 Idkort. Dette kræver en særlig whitelisting og kan sættes op ved at tilføje oplysninger om anvenderen i konfigurationsparameteren 'whitelisted.level3.cvrs'. På trods af navnet kan whitelisting til niveau 3 sættes op på to niveauer: CVR nummer eller et specifikt certifikat.
Værdien er en kommasepereret liste som vist i følgende eksempel:
Opsætning af niveau 3 whitelisting
|
Eksemplet viser de tre formater, der kan anvendes:
- Værdi uden type: I eksempelt ovenfor fortolkes værdien '31908574' som et CVR nummer. Dette sikrer bagudkompatibilietet med tidligere opsætninger
- Værdier med typen CVR: I eksemplet ovenfor fortolkes 'CVR:46837428' som et CVR nummer med værdien 46837428
- Værdier med typen CERT: I eksemplet ovenfor fortolkes 'CERT:CVR:33257872-FID:28250866' som whitelisting af certificatet med Subject Serial Number CVR:33257872-FID:28250866.
I forhold til anvenderne, så tjekkes det, om der er en whitelisting af anvenderens CVR nummer og hvis dette ikke er tilfældet, så tjekkes, om det specifikke certifikat, der anvendes er whitelistet. Alle andre forsøg på adgang med niveau 3 Idkort afvises.
DKS konfiguration
Indholdet, der returneres ved kald af DCC Konfiguration Service-snitfladen (DKS), indlæses fra filen:
- Fra DDS registry: /pack/wildfly8/modules/nsi/ddsregistry/config/main/dksConfiguration.xml
- Fra DDS repository: /pack/wildfly8/modules/nsi/ddsrepository/config/main/dksConfiguration.xml
Filerne skal overholde DKS XML-skemaet og beskriver de webservice-operationer DDS Registry udstiller jf. [DKS-beskrivelse].
Test af DKS
Efter konfiguration og deployering af DDS Registry og Repository servicene, kan DKS-snitfladerne testes med:
|
Succesfuldt svar giver indholdet svarende til filerne nævnt ovenfor.
Header konfiguration
Det er muligt at konfigurere registry og repository til at lede efter HTTP- og SOAP-headere, og videresende dem til bagvedliggende registries.
Videresendelse styres af databasetabellerne
- For DDS registry: documentsources.documentregistry_forwarded_header
- For DDS repository: documentsources.documentsource_forwarded_header
Indholdet af tabel documentsources.documentregistry_forwarded_header er som følger:
Feltnavn | Indhold |
---|---|
headername | Navn på header, der ledes efter. Hvis headertype er 'HTTP', ledes i HTTP-headers i requestet. Hvis headertype er 'SOAP', ledes i headere i SOAP-envelopen i requestet. |
headertype | Typen af header der ledes efter. Kan være 'HTTP' eller 'SOAP', skrevet med store bogstaver. |
documentregistryid | Id på documentregistry, som header ønskes videresendt til. Der er opsat en foreign key-constraint, der sikrer at der refereres til et registry i documentregistry-tabellen. |
Indholdet af tabel documentsources.documentsource_forwarded_header er som følger:
Feltnavn | Indhold |
---|---|
headername | Navn på header, der ledes efter. Hvis headertype er 'HTTP', ledes i HTTP-headers i requestet. Hvis headertype er 'SOAP', ledes i headere i SOAP-envelopen i requestet. |
headertype | Typen af header der ledes efter. Kan være 'HTTP' eller 'SOAP', skrevet med store bogstaver. |
oid | oid på repository, som header ønskes videresendt til. Der er opsat en foreign key-constraint, der sikrer at der refereres til et registry i documentsource-tabellen. |
DocumentSources konfiguration for DDS repository
For at tilføje et kildesystem til documentsource databasen, bruges følgende SQL insert:
|
oid: OID værdien som for den pågældende XDS dokument kilde, som kan være at typen ’repository_unique_id’ eller ’home_community_id’
type: Angiver hvilken typen af OID der er angivet, og den skal have én af følgende værdier: [‘repository_unique_id’|’home_community_id’]
service_endpoint: Angiver URL til XDS dokument kilde
soap_version: Angiver XDS dokument kildens SOAP version og den skal have én af følgende værdier:
Værdi | Benytter HSUID udgående | Benytter DGWS udgående |
1.1 | + | ÷ |
1.2 | + | ÷ |
1.1_NO_HSUID | ÷ | ÷ |
1.2_NO_HSUID | ÷ | ÷ |
1.2_DGWS | + | + |
1.2_DGWS_NO_HSUID | ÷ | + |
1.2_DGWS_NO_ADDR | + | + |
1.2_MEDCOM_NO_HSUID | ÷ | (+) Kun Medcom-header |
Værdien 1.2_DGWS_NO_ADDR benyttes, når WS-Addressing ikke ønskes anvendt.
timeout: Angiver hvor lang tid DDS forsøger at hente dokumenter fra eksterne kilder inden forsøget opgives. Tiden angives i millisekunder.
failurethreshold: Angiver grænseværdi for hvor mange kald mod repositoriet der må fejle før monitoreringssnitfladen melder fejl. Angives som heltal.
Kombinationen oid og unique_id_type skal være unik.
Monitorering
Til statuscheck af DDS Registry og Repository findes til hver en servicecheck servlet der kalder servicens afhængigheder, samt en statuscheck servlet der monitorerer de kald der foretages fra DDS Registry og Repository. Alle servlets udstiller http-snitflader som melder 500 ved fejl.
Test af versionsnummer
Efter konfiguration og deploy af DDS Registry og Repository kan versionsnummeret hentes med følgende kommandoer:
|
hvilket hver giver output i stil med:
|
I eksemplet kørte servicen på en lokal maskine konfigureret til port 9090.
Specielt vedrørende testConnection på JBoss
På grund af en kendt fejl i JBoss 6, logges en række exceptions i server loggen, hvis følgende filer ikke findes (de må gerne være tomme):
|
Konfiguration af databasemonitorering
Databasemonitoreringen laver en simpel query mod databasen. Denne query er justbar og kan ændres i servicenes property filer.
DDSRegistry.properties:
|
DDSRepository.properties:
|
Test af monitorering af afhængigheder
Til Monitorering af afhængigheder til egen propertyfil, trådmanager, document registry (for DDS registry) og egen database findes en servlet i DDS Registry og Repository. Bemærk at denne snitflade laver kald til databasen og healthshare registry.Efter konfiguration og deploy af komponenterne kan det testes med:
|
Servicen returnerer følgende http koder:
- Der returneres http kode 200 ved normal situation.
- http fejlkode 404 returneres hvis servicen ikke er deployeret
- Hvis en eller flere af afhængighederne mangler eller ved intern fejl i WildFly returneres kode 500. Fejlbeskeden vil kunne ses i ddsregistry-servicecheck.log eller ddsrepository-servicecheck.log. Såfremt der ikke er nogen fejlbeskeder i loggen bør property-filen undersøges som det første, da det er herigennem logindstillingerne bestemmes.
Test af monitorering af status
Til Monitorering af forbindelser til BRS, MinLog, SamtykkeVerifikationsservice, PersonInformation, registries (DDS registry), repositories (DDS Repository) og egen database findes en servlet i DDS Registry og Repository. Disse services opsamler data på hvor mange kald til de forskellige andre services der er fejlet, og melder fejl hvis det overstiger de threshold-værdier der er defineret i property-filen.
Efter konfiguration og deploy af komponenterne, kan den testes med:
|
Servicen returnerer følgende http koder:
- Der returneres http kode 200 ved normal situation.
- http fejlkode 404 returneres hvis servicen ikke er deployeret
- Hvis en eller flere af interne afhængighederne har fejlet nok gange til at nå deres grænseværdi returneres kode 203.
- Hvis en eller flere af ekserne afhængighederne (minlog osv) har fejlet nok gange til at nå deres grænseværdi returneres kode 500.
- Bemærk at
- DDS Registry anvender ”documentregistryfriendlyname” kombineret med ”documentregistryititransaction” (se afsnit 4.1.1.1) til identifikation af de forskellige indekser.
DDS Repository anvender ”service_endpoint” til identifikation af de forskellige repositories.
Fejlbeskeder vil kunne ses i ddsregistry-status.log henholdsvis ddsrepository-status.log
Opsamlingen af kald til en service der fejler nulstilles automatisk efter et antal sekunder. Dette styrres med en properti, servicestatuscheck.unlockdelay.
Nulstilling af opsamling af kald
Opsamlingen af kald der benyttes til monitoring af status kan nustilles. Servicen resetstatuscounters nulstiller alle de opsamlede data omkring fejlkald der har været siden sidste nulstilling.
Der skrives i statusloggen når denne service har været brugt.
Nulstil status for DDS Registry:
|
Nulstil status for DDS Repository:
|
Servicen returnerer følgende http koder:
- Der returneres http kode 200 ved normal situation.
Overvågning
DDS Registry og Repository overvåges hver af en servicespecifik servicechecksnitflade, samt en statussnitflade. Disse to snitfladers url’er 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 servicen ikke er deployeret, 203 mange fejl fra intern dds kald (DDS registry) og status 500, hvis der er opstået en fejl, og komponenten derfor ikke virker korrekt.
Overvågningstype
Simpel webside deployeret på serveren. Som udgangspunkt overvåges følgende:
- Tilstedeværelse og indhold af propertyfil
- Forbindelse til datasources via JNDI opslag
- Forbindelse til document registry for DDS registry
- Konfiguration af trådmanager
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. Hvorvidt der anvendes disse default-logfilnavne eller skrives til andre, er afhængig af servicens konfiguration af log4j.
DDS Registry:
Logfilnavn | Komponenter der skriver til logfilen | Beskrivelse |
---|---|---|
ddsregistry.log | DDS Registry | Generel applikationslog |
dds-audit.log | DDS Registry | Auditlog for indkommende kald af servicens operationer |
nsputil-sla-ddsregistry.log | DDS Registry | SLA-log |
ddsregistry-consentoverride.log | DDS Registry | Log over anvendelse af værdispring ved kald af servicens operationer |
ddsregistry-servicecheck.log | DDS Registry | Logfil for aktivt servicecheck |
ddsregistry-status.log | DDS Registry | Logfil for passivt opsamlet status på webservice- og database-kald. |
ddsregistry-xdserror.log | DDS Registry | Logfil for XDS-fejl indlejret i svar samt fejl ved kald af eksterne XDS-komponenter. |
DDS Repository:
Logfilnavn | Komponenter der skriver til logfilen | Beskrivelse |
ddsrepository.log | DDS Repository | Generel applikationslog |
dds-audit.log | DDS Repository | Auditlog for indkommende kald af servicens operationer |
nsputil-sla-ddsrepository.log | DDS Repository | SLA-log |
ddsrepository-consentoverride.log | DDS Repository | Log over anvendelse af værdispring ved kald af servicens operationer |
ddsrepository-servicecheck.log | DDS Repository | Logfil for aktivt servicecheck |
ddsrepository-status.log | DDS Repository | Logfil for passivt opsamlet status på webservice- og database-kald. |
ddsrepository-xdserror.log | DDS Repository | Logfil for XDS-fejl indlejret i svar samt fejl ved kald af eksterne XDS-komponenter. |
SLA log
For alle webservices er der en tilhørende SLA-log, der sørger for at logge udvalgte elementer fra requests til webservicen. For DDS Registry og Repository logges alle kald til DDSRegistryWS henholdsvis DDSRepositoryWS, hvor loggen vil indeholde information om kald til webservicens forskellige serviceoperationer og behandlingstid for kaldet inklusiv kald til kontrolservices.
SLA-logpunkter for indkommende kald til DDS Registry:
- DocumentRegistry_RegistryStoredQuery
SLA-logpunkter for udgående kald fra DDS Registry:
Kaldte service | LogPoint | TargetSOAPOperation |
---|---|---|
Behandlings-relations-service | DocumentRegistry_RegistryStoredQuery.TreatmentRelation | |
MinLog | DocumentRegistry_RegistryStoredQuery.Minlog.LogDataAdd | LogDataAdd |
Samtykke | DocumentRegistry_RegistryStoredQuery.ConsentForUserCheck | urn:dk:nsi:consentservices:verification:service:1#ConsentForUserCheck |
Samtykke | DocumentRegistry_RegistryStoredQuery.ConsentForDataCheck | urn:dk:nsi:consentservices:verification:service:1#ConsentForDataCheck |
XDS Registry | DocumentRegistry_RegistryStoredQuery | urn:ihe:iti:2007:RegistryStoredQuery |
For SLA-logning af udgående kald til XDS Registry:
- logges i feltet GenericCallParms desuden det konfigurerede navn for XDS Registry under parameternavnet registryFriendlyName.
- logges fejlet kald, på trods af succesfuldt kald, når en eller flere af følgende XDS-fejl/advarsler er indlejret i XDS-fejlstrukturen i svaret:
- XDSMissingHomeCommunityId
- XDSRegistryBusy
- XDSRegistryError, medmindre der er tale om advarsel om tilbageholdte oplysninger grundet samtykker
- XDSRegistryOutOfResources
- XDSUnavailableCommunity
- XDSUnknownCommunity
SLA-logpunkter for indkommende kald til DDS Repository:
DocumentRepository_RetrieveDocumentSet
SLA-logpunkter for udgående kald fra DDS Repository:
Kaldte service | LogPoint | TargetSOAPOperation |
Behandlings-relations-service | DocumentRepository_RetrieveDocumentSet.TreatmentRelation | |
MinLog | DocumentRepository_RetrieveDocumentSet.Minlog.LogDataAdd | LogDataAdd |
Samtykke | DocumentRepository_RetrieveDocumentSet.ConsentForUserCheck | urn:dk:nsi:consentservices:verification:service:1#ConsentForUserCheck |
Samtykke | DocumentRepository_RetrieveDocumentSet.ConsentForDataCheck | urn:dk:nsi:consentservices:verification:service:1#ConsentForDataCheck |
XDS Repository | DocumentRepository_RetrieveDocumentSet | urn:ihe:iti:2007:RetrieveDocumentSet |
For SLA-logning af udgående kald til XDS Repository:
logges i feltet GenericCallParms desuden det kaldte XDS Repository’s repositoryUniqueId under parameternavnet repositoryUniqueId.
logges fejlet kald, på trods af succesfuldt kald, når en eller flere af følgende XDS-fejl/advarsler er indlejret i XDS-fejlstrukturen i svaret:
XDSMissingHomeCommunityId
XDSRepositoryBusy
XDSRepositoryError, medmindre der er tale om advarsel om tilbageholdte oplysninger grundet samtykker
XDSRepositoryOutOfResources
XDSUnavailableCommunity
XDSUnknownCommunity
XDSUnknownRepositoryId
Audit log
Auditlogning foretages med det officielle NSP Audit Log modul.
De forskellige ITI-håndtag logges på følgende måde.
DDS Registry
ITI-18 søgninger logger patient-id, bruger-id, på-vegne-af-id og for hver DocumentEntry (DE) i returneret svar (der kan være frafiltreret metadata pga. samtykker): DE.uniqueId, DE.repositoryUniqueId, DE.homeCommunityId, DE.typeCode. Se eksempel nedenfor:
|
DDS Repository
De forskellige ITI-43 operationer logger patient-id, bruger-id, på-vegne-af-id og for hvert dokument i returneret svar (der kan være frafiltreret dokument(er) pga. samtykker, der kan være forespurgt dokumenter, der ikke er tilgængelige): requestens uniqueId, repositoryUniqueId, homeCommunityId.
Eksempel:
|
Standard fejlsøgning
- Ved problemer med indlæsning af servicens konfigurationsfiler (DDSRegistry.properties og DDSRepository.properties) bør man verificere at filen er volume-mappet korrekt. Vær opmærksom på at filen ikke læses hvis den ikke er til stede ved opstart af WildFly serveren.
- Ved manglende logning hvor der forventes fejlbeskeder bør konfigurationsfilen (DDSRegistry.properties og DDSRepository.properties) checkes, da logindstillingerne sættes herigennem.
- En service eller et job kan stoppes og startes gennem docker.
Krav til backup m.m.
Det anbefales at aktuelle konfigurationsfiler til DDS Registry og Repository er under versionskontrol og back up.