Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • NSP XDS Registry Felt migrerings service

  • Type: Webservice

  • Filnavn: nxrgfieldmigration.war

  • Url: <serverurl>/nxrgfieldmigration

  • Servicecheckurl: <serverurl>/nxrgfieldmigration/status

  • Versionurl: <serverurl>/nxrgfieldmigration/health

Formålet med servicen er beskrevet i design og arkitektur dokumentets afsnit  felt migrering".

Klargøring før felt migrering

Inden man kan køre en feltmigrering, skal følgende ting være på plads. Disse klargøres i forbindelse med udvikling af komponenten og oprettes på systemet når NXRG installeres/opgraderes.

  • Database script til at indsætte ny række/felt migrering i fieldmigrationstatus. Dette findes som liquidbase script  for NXRG servicen.
  • Database script der tilføjer det søgbare felt til f.eks. documententries eller anden relevant tabel. Det er her NXRG og felt migreringen gemmer den søgbare værdi.
  • En kørende version af NXRG, der sørger for at nye dokumentregistreringer gemmer data i det (nye) søgbare felt (migreringen håndterer kun registreringer eksisterende på det tidspunk ny version af NXRG installeres)

Ovenstående 3 punkter skal være inkluderet i samme NXRG release, og når den er installeret, er migreringen klar til at blive kørt (se afsnit nedenfor)

Konfiguration

Servicekonfiguration

...

I filen skal følgende properties være definerede:

Property

Beskrivelse

Property

Beskrivelse

datasource.jndi.name

JNDI navnet på den datasource der giver adgang til NXRG databasen.

nxrg.data.max.no.of.documentsAngiver, hvor mange dokument registreringer (antal database records) der skal håndteres i een kørsel. Større antal tager længere tid.

...

NXRG felt migrering udstiller en overvågningsside på endpoint <serverurl>/nxrgfieldmigration/status

Fortolkning af HTML overvågningsside

NXRG-overvågningssiden Overvågningssiden returnerer enten:

  • HTTP 200, hvis servicen i øjeblikket kører fint og der er forbindelse til databasen.
  • HTTP 500, hvis der er opstået en fejl der kræver indgriben.

Overvågningstyper

Det overvåges om der kan opnås forbindelse til databasen.

Status

NXRG udstiller to status sider

 Version

Udstilles på endpoint <serverurl>/nxrgfieldmigration/health

Eksempel på status:

Code Block
{
   "version":"1.0.14-SNAPSHOT"
}

Den fortæller, hvilken version af felt migrering servicen, som kører.

Migrerings status

Udstilles på endpoint <serverurl>/nxrgfieldmigration/fieldmigrationstatus

Eksempel på status:

Code Block
[
   {
      "id":1,
      "migrationid":"documententry-repositoryid-add",
      "progressid":121,
      "targetid":121,
      "migrationStartTime":"2022-05-18T12:09:13Z",
      "migrationEndTime":"2022-05-18T12:11:35Z",
      "lastUpdateTime":"2022-05-18T12:11:35.886375Z"
   }
]

Den fortæller, hvor langt en given migrering er:

For hver felt migrering, som findes til NXRG, findes der en sådan record på status siden. Har felt migrering aldrig været kørt vil ovenstående have 0 i progressid samt null i migrationStartTime og migrationEndTime.

Felt

Beskrivelse

id

En intern nøgle

migrationid

Navnet på migrering af feltet. Siger noget om, hvad der migreres

progressid

peger på en dokument registrering (id i documentEntries tabellen). Er 0 sålænge migreringen ikke er startet. Når en migrering er kørt, vil progressid pege på den sidste documentEntries, der er migreret i kørslen. Når migrationid rammer targetid, er der ikke mere at migrere. 

targetidpeger på den sidste dokument registrering (id i documentEntries tabellen), der skal migreres. Når migrationid rammer denne værdi, er der ikke mere at migrere.
migrationStartTimetidspunkt for, hvornår den første kørsel af migreringen er startet. Er værdien null har migrering af feltet aldrig været startet
migrationEndTimetidspunkt for, hvornår migreringen er afsluttet (da progressid ramte targetid)
lastUpdagtedTimetidspunkt for, hvornår data for feltmigreringen senest er opdateret


Kørsel af felt migrering

Se afsnit "klargøring af felt migrering" først. Herefter kontroller at property nxrg.data.max.no.of.documents er sat til ønsket værdi.

For at aktivere en migrering anvendes servicens endpoint: <serverurl>/nxrgfieldmigration/fieldmigrationrun

Nu startes der en migrering for de "migrationid'er" som findes i listen man ser, når man tjekker migerings status (se ovenfor). Er migrationEndTime udfyldt er der ikke noget at migrere. Men ellers køres der migering på det antal registreringer, der er angivet i property nxrg.data.max.no.of.documents.

...