Dette dokument dækker følgende komponenter på NSP:
NSP XDS Registry
Type: Webservice
Filnavn: nxrg.war
Url: <serverurl>/nxrg
Servicecheckurl: <serverurl>/nxrg/status
Versionurl: <serverurl>/nxrg/health returnerer en json struktur med denne
Migreringskomponenten, der migrerer opentext data til SQL scripts til indlæsning i nxrg databasen.
Grundlæggende konfiguration foregår ved redigering i filen nxrg.properties, der placeres i følgende WildFly modul:
/pack/wildfly/modules/sds/nxrg/configuration/main/
Moduldefinitionen er at finde i sourcekoden til nxrg under:
/compose/configuration/module.xml
I filen skal følgende properties være definerede:
Property | Beskrivelse |
---|---|
datasource.jndi.name | JNDI navnet på den datasource der giver adgang til NXRG databasen. |
liquibase.changelog.file | Angiver den changelog fil som liquibase skal anvende. Property er ikke krævet. Hvis der skal afvikles integrationstest mod det miljø der installeres skal denne sættes til liquibase-changelog-test.xml. Denne kan også sættes via en environmentvariabel i formen liquibase_changelog_file. |
nxrg.allowed.mimetype | Tilladt MimeType på DocumentEntries i requests til ITI-42, ITI-57 og ITI-61. |
iti18.request.validation.enabled | Angiver om der skal foretages openehealth-validering af requestet. Default: true. |
iti18.response.validation.enabled | Angiver om der skal foretages openehealth-validering af responset. Default: true. |
iti42.request.validation.enabled | Angiver om der skal foretages openehealth-validering af requestet. Default: true. |
iti42.response.validation.enabled | Angiver om der skal foretages openehealth-validering af responset. Default: true. |
iti57.request.validation.enabled | Angiver om der skal foretages openehealth-validering af requestet. Default: true. |
iti57.response.validation.enabled | Angiver om der skal foretages openehealth-validering af responset. Default: true. |
iti61.request.validation.enabled | Angiver om der skal foretages openehealth-validering af requestet. Default: true. |
iti61.response.validation.enabled | Angiver om der skal foretages openehealth-validering af responset. Default: true. |
Log4j konfiguration findes i samme wildfly modul som servicekonfigurationen
Se yderligere opsætning i installationsvejledningen.
NXRG udstiller en overvågningsside, som findes i listen af komponenter i afsnit 2.
NXRG-overvågningssiden returnerer enten:
Det overvåges om der kan opnås forbindelse til databasen.
TODO
TODO
NXRG laver forretningslogninger ved hvert kald af de udbudte ITI-services. I det følgende gennemgåes formaterne for hver service.
Alle forretningslogninger ender i en dedikeret logfil nxrg-itiusage.log.
Loglinjen er formatteret som json og alle logninger har følgende indgange:
timestamp: Tidsstempel for loghændelsen
threadId: Trådens navn (hvor iti-servicen blev udført)
category: Hvilken ITI service beskriver linjen?
status: Returstatusværdi for den pågældende service rapporteres i status, mens eventuelle fejl angives i en liste errors.
priority: Loglinjens prioritet (er INFO for forretningslogninger)
Succesfuldt kald til service iti-42 giver anledning til en logningslinje på følgende format:
{ "timestamp":"25 Jun 2021 11:58:15,468", "threadId":"default task-1", "priority":"INFO", "category":"ITI-42", "status":{ "errors":null, "status":"OK" }, "submissionSet":{ "uniqueId":"5321688553302212937.6611016525576425327.1624615095422" }, "documentEntries":[ { "entryUUid":"urn:uuid:608ce70e-db4b-4ced-98d6-58cdbba16a14", "replacesEntryUuid":null } ] } |
Iti-42 logninger har følgende egenskaber:
submissionSet: Identifikation (uniqueId) af det submissionset, der indeholder informationen i iti-42 kaldet.
documentEntries: En liste af entryUUid'er, der oprettes. Hvis en documentEntry i kaldet giver anledning til replace på en anden documentEntry, så angives dette uuid i egenskaben replacesEntryUuid.
Succesfuldt kald til service iti-18 giver anledning til en logningslinje på følgende format:
{ "timestamp":"25 Jun 2021 12:50:40,929", "threadId":"default task-1", "priority":"INFO", "category":"ITI-18", "status":{ "errors":null, "status":"OK" }, "queryType":"urn:uuid:14d4debf-8f97-4251-9a74-a90016b0af0d", "returnType":"LeafClass", "numberOfResults":5 } |
Iti-18 logninger har følgende egenskaber:
queryType: Identifikation typen af query.
returnType: Definerer, hvilken type af objekter, der returneres fra servicen
numberOfResults: Antallet af documententries i svaret
Succesfuldt kald til service iti-57 giver anledning til en logningslinje på følgende format:
{ "timestamp":"11 Aug 2021 13:41:07,202", "threadId":"default task-1", "priority":"INFO", "category":"ITI-57", "status":{ "status":"OK", "errors":null }, "updateOperationName":"UpdateDocumentEntryAvailabilityStatus", "updatedObjectUuid":"urn:uuid:7a2bf9c1-3603-46fe-9b22-4d25e4c01192" } |
Iti-57 logninger har følgende egenskaber:
updateOperationName: Typen af opdatering
updatedObjectUuid: UUID der er opdateret.
Migreringstoolet læser opentext data fra en Mariadb og producerer opdateringsscripts til indlæsning i NXRG databasen.
Migreringstoolet leveres som et Docker image og containeren kan startes som følger
docker run --env migrationpath=/migrationoutput/ --volume /mymachine/output/run1:/migrationoutput registry.nspop.dk/components/nxrg-migration:snapshot |
Migreringstoolet output'er SQL scripts. Outputsti til scripts kan sættes med en env variabel som vist ovenfor og volume mount til hostmaskinen som vist ovenfor.
Andre env, der kan sættes:
ENV | Beskrivelse | Eksempel |
---|---|---|
opentext_data_url | URL til databasen med opentext data | jdbc:mysql://localhost:3307/opentext |
opentext_data_user | Bruger til opentext databasen | opentext |
opentext_data_pass | Password for bruger | opentext |
migrationfilesize | Antal inserts statements per migreringsfil | 100000 |
Som beskrevet i NXRG - Design- og arkitekturbeskrivelse kan der efter en migrering foretages hhv
Disse to processer er implementeret som en del af NXRG og kan afvikles med følgende kommando
docker run --env filepath=/migrationvalidation/ --volume /mymachine/migrationvalidation/run1:/migrationvalidation registry.nspop.dk/components/nxrg-migration-verification:snapshot validation docker run --env filepath=/migrationverification/ --volume /mymachine/migrationverification/run1:/migrationverification registry.nspop.dk/components/nxrg-migration-verification:snapshot verification |
validation: Migreringsverifikationtoolet output'er lister med CPR numre
verification: Migreringsverifikationtoolet indlæser liste med CPR numre til anvendelse i kald, og output'er request og response kald indhold. Det forventer at finde en fil ved navn cpr.txt i det angivne bibliotek på samme format som cprDocumententries.txt eller cprTop100.txt (output af validation)
Sti'er til dette kan sættes med en env variabel som vist ovenfor og volume mount til hostmaskinen som vist ovenfor
Env, der kan sættes i forbindelse med validering:
ENV | Beskrivelse | Eksempel |
---|---|---|
nxrg_data_url | URL til databasen med NXRG data | jdbc:mysql://localhost:3307/nxrg |
nxrg_data_user | Bruger til NXRG databasen | nxrg |
nxrg_data_pass | Password for bruger | nxrg |
Env, der kan sættes i forbindelse med verifikation:
ENV | Beskrivelse | Eksempel |
---|---|---|
nxrg_iti18_url | url til NXRG iti-18 snitflade | https://nxrg.nspnxrg.medcom.dk/nxrg/iti18 |
opentext_iti18_url | url til OpenText iti-18 snitflade | https://test1-cnsp.ekstern-test.nspop.dk:8443/registry/services/xds-iti18 |
Cleanup job sletter DocumentEntries og tilhørende objekter fra NXRG databasen som er ældre end en specificeret dato.
Cleanup jobbet har følgende properties der kan sættes:
Property | Beskrivelse | Default hvis ikke sat |
---|---|---|
delete.after.days | Hvor gamle dokumenter i Registry skal være, før de slettes | 2 år |
delete.type.code | Type Code på de dokumenter der slettes (Her er aftale = "39289-4") | 39289-4 |
delete.output.dir | Directory hvor output filer placeret | /cleanup-output |
Servicen udstiller to HTTP endpoints:
som kan interageres med eks. med curl
curl http://localhost:8060/nxrg/cleanup/status |
Cleanup job logger på standardout vha. log4j. Jobbet vil ved kørsel udskrive følgende INFO statements ud:
Konfigurationsparametre:
Søgning:
Sletning
Efter kørsel af jobbet vil der blive placeret filer i det konfigurerede output bibliotek svarende til dokumenter der skal slettes i XDS repository. Der genereres een fil pr Repository der skal slettes dokumenter i.
Navngivningen på filen/filerne vil være:
Hvor "ddMMyyyyHHmm" svarer til det tidspunkt, hvor jobbet blev startet, og repositoryId er OID på det repository der skal slettes dokumenter i.