Altinn Studio Datamodellering

Brukerguide for verktøyet Altinn Studio Datamodellering

On this page:

Altinn Studio Datamodellering er et verktøy for å utvikle datamodeller. Den baserer seg på en datamodell i JSONSchema format, og kan ut fra dette generere XSD- og C#-modell.

Navigere til Altinn Studio Datamodellering

1. Logg inn i Altinn Studio
2. På førstesiden, velg rediger (blått penn-ikon) på enten: a. En app, eller b. Datamodellerings repo for din organisasjon
3. Velg Datamodell fanen i topp-menyen

Når man kommer til den nye siden for datamodellering vises en dialog med informasjon om den nye siden. Om man ikke ønsker å se denne hver gang man går inn på siden kan man velge Ikke vis igjen. Da vil dialogen skjules så lenge man bruker samme PC og nettleser - frem til det ev. kommer endringer vi ønsker å varsle om.

Laste opp / vise datamodell

Datamodellen definerer hvilke data som kan sendes inn via en app, og hvilket format det skal sendes på. Vi støtter pr. nå kun opplasting av XSD datamodell.

1. Klikk på Last opp datamodell - enten fra startsiden om det ikke er noen eksisterende datamodeller, eller fra verktøylinjen øverst i verktøyet og velg XSD-en i filvelgeren
2. Klikk Last opp

Datamodellen blir da lastet opp og prosessert, og alle nødvendige filer generert og lagret i app-repositoryet. Tre-visning av datamodellen kan åpnes for å se en visuell representasjon av datamodellen. Typer som er definert i datamodellen vises i panelet på venstre side.

Velge modell fra nedtrekkslisten

Alle modeller som er lastet opp i verktøyet for en app eller <org>-datamodels repo er tilgjengelig i listen. XSD’er som ligger i repo som ikke har noen tilknyttede modell-filer (JSONSchema) vil også vises i listen, se neste avsnitt for mer info.

Spesielt for datamodellering på organisasjonsnivå

Når man jobber mot et datamodell-repo på organisasjonsnivå (i stedet for direkte mot en app), er det 2 grupper med datamodeller som vises i nedtrekkslisten.

• Den første er JSONSchema - dette er modellene der man har hentet inn/lastet opp XSD i verktøyet og prosessert denne, og fått generert modell-filene.
• Den andre er XSD - dette er de XSD’ene som ligger i <org>-datamodels repo som ikke har blitt hentet inn og prosessert i verktøyet. Når man velger en modell fra XSD-listen, vil denne automatisk lastes inn i verktøyet og JSONSchema modell-fil genereres - denne kan så jobbes videre med i ASD.

Lage ny datamodell

Det er mulig å opprette en ny datamodell fra bunnen av:

1. Klikk på Lag ny datamodell.
2. Skriv inn navnet på datamodellen i feltet.
3. Klikk på Opprett modell.

Datamodellen opprettes med noen eksempel-felter som man kan jobbe videre med eller slette:

• property1 (tekst, påkrevd)
• property2 (tekst, påkrevd)
• property3 (tekst)

For å redigere denne modellen, kan man legge til/redigere felter på rot-nivå via “Legg til” knappen øverst, via kontekst-menyen på nodene, og man kan legge til nye typer via +-tegnet i Typer-panelet på venstre side. For mer info om redigering av modeller, se avsnitt om redigering av modeller.

Redigere datamodell

For å redigere en datamodell må modellen være valgt i nedtrekkslisten. I tillegg må man velge Rediger øverst til høyre i modellverktøyet - da vil et panel for å redigere modellen vises på høyre side av verktøyet. Valget her vil huskes til neste gang man er inne.

Redigere navn på felt

1. Klikk på feltet, og se at navnet på feltet vises i høyre-panelet.
2. Endre navn til ønsket verdi.
3. Navnet oppdateres.

Legge til nytt felt

1. Hold musepekeren over noden du ønsker å legge til et felt på.
2. Klikk på de tre prikkene til høyre for noden.
3. Velg Legg til felt fra menyen.
4. Feltet blir lagt til.
5. Alternativt kan man legge til felt direkte fra høyre-panelet:

• Velg noden du ønsker å legge til felt på ved å klikke på den
• Velg “Felter”-fanen i høyre-panelet
• Legg til felter direkte i denne fanen.

Legge til en ny type

1. Trykk på +-tegnet ved siden av “Typer”-overskriften i panelet på venstre side

Redigere en type

1. Velg ønsket type fra panelet på venstre side ved å klikke på den, en egen tre-visning for typen vises da i midten.
2. Egenskaper for typen kan redigeres i høyre-panelet
3. Ved å trykke på “Legg til” knappen øverst kan man legge til felter på typen
4. Ved å velge felter fra typen kan man redigere egenskaper for disse i høyre-panelet.
5. Man lukker redigeringsmodus for typer ved å trykke på x øverst i modell-panelet, ved siden av Du redigerer nå på <type>.

Slette en type

1. Velg ønsket type fra panelet på venstre side
2. I kontekst-menyen til rot-noden på typen (...), velg “Slett”.
3. Merk at det ikke er mulig å slette typer som er i bruk.

Legge til en referanse til en type

1. Hold musepekeren over noden du ønsker å legge til et felt på.
2. Klikk på de tre prikkene til høyre for noden.
3. Velg Legg til referanse fra menyen.
4. Feltet blir lagt til
5. Velg type i Refererer til feltet i høyre-panelet

Slette et felt

1. Hold musepekeren over noden du ønsker å slette.
2. Klikk på de tre prikkene til høyre for noden.
3. Velg Slett felt fra menyen.
4. Feltet blir slettet.

Redigere egenskaper til et felt

1. Klikk på noden/feltet du ønsker å redigere for å få opp egenskaper i høyre-panelet
2. Rediger egenskapene for noden/feltet som ønsket. Tilgjengelige egenskaper for feltet vil variere basert på base-typen for feltet.

Redigere/legge til XSD-attributter, namespaces, osv, inkl dataFormatId og dataFormatVersion`.

Foreløpig er ikke dette noe som støttes direkte i verktøyet. Det er allikevel mulig å gjøre dette manuelt. Beskrivelser for hvordan dette gjores finnes i lenkene under:

• dataFormatId og dataFormatVersion
• XSD attributter generelt
• XSD namespaces

Generere modellfiler (XSD og C#)

Når modellen er klar, kan man generere modell-filer ved å klikke på Generer modeller-knappen over høyre-panelet. For <org>-datamodels-repo vil det kun genereres XSD, mens for app-repo vil det også genereres C# modell-fil. Husk å trykke på Push til venstre i hovedmenyen til Altinn Studio for å dele dine endringer.

Laste ned XSD

XSD fil kan så lastes ned ved å gå til repoet - klikk på person-ikonet øverst til høyre på siden, og velg “Åpne repository”. Naviger til ønsker fil i mappestrukturen, og klikk på nedlastingsikonet.