Generator (NY)

Generator er en testklient for NVDB API Skriv. Dette er en webapplikasjon som eksponeres av NVDB API Skriv sammen med øvrige REST-endepunkter. I applikasjonen kan man sende inn forhåndsdefinerte test case, observere arbeidsflyten under behandling og til slutt inspisere behandlingsresultatet.

Formålet med Generator er å visualisere arbeidsflyten for endringssett, illustrere oppbygging av endringssettformatet for ulike oppgaver og vise hvordan ulike valideringsfeil meldes i behandlingsresultatet.

Generator er tilgjengelig på følgende URLer:

Miljø	Formål	URL
UTV	Utvikling	https://nvdbapiskriv-kontrollpanel.utv.atlas.vegvesen.no/generator
STM	Systemtesting	https://nvdbapiskriv-kontrollpanel-stm.utv.atlas.vegvesen.no/generator
ATM	Akseptansetesting	https://nvdbapiskriv-kontrollpanel.test.atlas.vegvesen.no/generator
PROD	Produksjonsdrift	https://nvdbapiskriv-kontrollpanel.atlas.vegvesen.no/generator

Endringssettgeneratoren brukes til å opprette og sende endringssett til NVDB API Skriv. Generatoren er tilgjengelig på /generator for innloggede brukere som har tilgang til generatoren.

Generatoren har tre faner:

• JSON Editor – skriv eller lim inn et komplett endringssett i JSON-format. I editoren ligger det også noen eksempel på endringssett.
• Endringssett Bygger (Alpha) – bygg opp et endringssett trinnvis gjennom å velge operasjoner for vegobjekter, samt å legge til egenskaper, stedfesting og assosiasjoner for objektene.
• Veiledning – forklaring av endringssett, operasjoner, egenskaper, stedfesting og assosiasjoner.

Valgt fane lagres i URL-en som parameteren tab=editor brukes når ingen fane er angitt.

JSON Editor

Velg eksempel og rediger JSON

Ved oppstart lastes et standardeksempel. Fra nedtrekkslisten Velg eksempel kan man velge andre forhåndsdefinerte eksempler. JSON-innholdet kan deretter redigeres direkte i tekstfeltet.

Følgende funksjoner er tilgjengelige:

• Tøm – fjerner innholdet i tekstfeltet.
• Formater – formaterer JSON-innholdet med riktig innrykk.
• Kopier – kopierer innholdet til utklippstavlen.
• Last ned – laster ned innholdet som endringssett.json.
• Last opp – brukeren kan laste opp en lokal .json-fil.

JSON-en valideres mens den redigeres. Ved ugyldig JSON vises det en feilmelding under tekstfeltet, og Send JSON er deaktivert. Det samme gjelder når tekstfeltet er tomt eller en innsending pågår.

Kjøring

Velg DryRun (kjør uten lagring) dersom endringssettet skal valideres og behandles uten at data lagres i NVDB. La avkrysningsboksen være avslått når endringssettet skal behandles med vanlig lagring.

Klikk Send JSON for å sende inn endringssettet. Generatoren bruker den ordinære innsendingen mot NVDB API Skriv og viser status for de ulike trinnene i behandlingen. Ved vellykket innsending vises endringssett-ID. Ved feil vises en statusmelding med informasjon om hva som feilet.

Endringssett Bygger (Alpha)

Byggeren oppretter JSON automatisk fra feltene i skjemaet. Nederst på siden vises en JSON-forhåndsvisning bestående av feltene som er lagt til i skjemaet.

Basisinformasjon

Under Basisinformasjon kan følgende felt angis:

• Datakatalogversjon – versjonen av datakatalogen som skal brukes. Standardverdien er 2.41.
• Ansvarlig – brukernavn til ansvarlig.
• Ekstern referanse – valgfri referanse, for eksempel en prosjektidentifikator.
• Kontekst – valgfri kontekstinformasjon.

Operasjoner

Velg én eller flere operasjonstyper under Operasjoner. En operasjon kan fjernes igjen ved å klikke på samme knappen som ble brukt til å legge til operasjonene eller ved å bruke "fjern"-knappen. Hver operasjon vises som et utfellbart panel og viser antall vegobjekter som er lagt til.

Generatoren støtter disse operasjonene:

• Registrer – etablerer nye vegobjekter. Nye objekter får tempId og får NVDB-ID og versjon ved behandling.
• Oppdater – oppretter en ny versjon av et eksisterende vegobjekt.
• Delvis oppdater – oppdaterer bare deler av et eksisterende vegobjekt.
• Korriger – retter feil i en eksisterende vegobjektversjon.
• Delvis korriger – korrigerer bare deler av et eksisterende vegobjekt.
• Lukk – setter sluttdato på et eksisterende vegobjekt.
• Gjenopprett – fjerner sluttdato på et vegobjekt som er lukket.
• Fjern – fjerner et vegobjekt eller en versjon av et vegobjekt.

Klikk Legg til vegobjekt inne i en operasjon for å legge til et objekt. Hvert objekt kan fjernes separat.

Vegobjekt

Et vegobjekt redigeres i faner som tilpasses operasjonen:

• Basisinformasjon – vegobjekttype, NVDB ID/temp ID, versjon og operasjonsspesifikke felter.
• Egenskaper – egenskaper hentes fra datakatalogen for valgt vegobjekttype.
• Stedfesting – oppretting, oppdatering eller fjerning av punkt- eller linjestedsfesting.
• Assosiasjoner – legge til assosiasjoner til andre vegobjekter.

Fanene Egenskaper, Stedfesting og Assosiasjoner vises for operasjoner som kan endre innholdet i vegobjektet. De vises ikke for Fjern, Lukk eller Gjenopprett.

For eksisterende vegobjekter angis NVDB ID og versjon. Ved registrering angis en midlertidig ID (tempId).

• Felter som lukkedato og kaskadevalg vises når operasjonen krever dem.
• Ved korrigering må det angis tidspunkt for når vegobjektversjonen opprinnelig innlest fra NVDB API Les. Denne oppgis på NVDB-tid.

Egenskaper og assosiasjoner hentes dynamisk fra datakatalogen etter at vegobjekttype er valgt. Stedfesting kan angis som punkt eller linje og kan inneholde flere linjer.

Forhåndsvisning og innsending

JSON-forhåndsvisningen oppdateres når skjemaet endres. Velg DryRun (kjør uten lagring) for behandling uten lagring i NVDB, eller la valget være avslått for ordinær behandling.

Klikk Send endringssett for å sende JSON-en til NVDB API Skriv. Knappen er deaktivert når endringssettet ikke inneholder vegobjekter eller mens innsending pågår. Statusmeldinger og endringssett-ID vises under knappen.

Veiledning og begrensninger

Fanen Veiledning beskriver formatet for endringssett, obligatoriske og valgfrie felter, støttede datatyper, stedfesting og assosiasjoner. Veiledningen omtaler også geometri-formatet, men geometri er ikke implementert som redigeringsfelt i den visuelle endringssettbyggeren.