Utvikle datamodell for Altinn 2 i Altinn Studio

Hva må gjøres for å utvikle datamodell til Altinn 2?

På denne siden:

Endre eksisterende datamodell

Eksisterende datamodell (XSD) kan lastes opp i verktøyet og redigeres. Alle XSD attributter vil følge med fra den opprinnelige XSD’en, selv om disse ikke kan redigeres i verktøyet.

Dersom det kun er behov for små endringer på datamodellen, og det kun er behov for endringer ifm Altinn 2, anbefales det allikevel at man gjør disse endringene manuelt direkte på XSD’en. Dette kan gjøres med forskjellige verktøy, noen eksempler følger:

• XML Spy
• Visual Studio Code med f.eks. XML extension

Opprette ny datamodell for Altinn 2

Det er mulig å lage en ny datamodell fra bunnen av til Altinn 2 i Altinn Studio Datamodellering. Dette gjøres ved å velge Lag ny i verktøyet. Det blir da opprettet en mal for modellen med et enkelt felt. Pass på å legge til følgende på rot i {model}.schema.json-filen for modellen, da dette må til for at TUL skal kjenne igjen modellen som en SERES-modell.

"@xsdRootElement": "melding",

For mer informasjon om utvikling av modell fra bunn av i ASD, se denne guiden.

dataFormatId og dataFormatVersion

Disse verdiene vil tas med fra den opprinnelige datamodellen dersom man laster den opp i Altinn Studio Datamodellering. De kan derimot ikke redigeres i ASD. Ved behov for å redigere disse for eksisterende modeller, gjøres dette manuelt direkte i <model>.schema.json-filen som genereres når XSD lastes opp. Dette er for å sikre at disse verdiene følger med også om man gjør endringer på modellen i ASD ved senere tidspunkt.

Ved behov for å opprette nye datamodeller (som ikke baserer seg på en eksisterende modell med disse verdiene satt) for Altinn 2 må disse verdiene settes manuelt.

• dataFormatId kan være en string med maks 30 karakterer. Konvensjonen på SERES XSD’er har vært et tall med 4 siffer, men dette feltet kan også inneholde andre tegn.
• dataFormatVersion må være et heltall for å fungere med Altinn 2. Om man oppretter en ny datamodell anbefaler vi å f.eks. begynne på 1, og øke ved behov.

XSD attributter

Altinn Studio Datamodellering støtter i utgangspunktet ikke redigering av XSD attributter. Ved opplasting av eksisterende XSD vil alle eksisterende XSD-attributter beholdes og skrives tilbake når ny XSD genereres etter endringer.

Redigere XSD attributter

Disse kan redigeres manuelt i <model>.schema.json-filen som genereres når man lager en ny modell eller laster opp XSD i verktøyet. De kan finnes på det feltet de hører til, under @xsdAttribute-tagen.

Legge til nye XSD attributter

Dette gjøres også manuelt i <model>.schema.json-filen som genereres når man lager en ny modell eller laster opp XSD i verktøyet. Finn frem til den noden som skal ha en XSD attributt, og legg til under properties på noden:

...
"properties": {
    "myAttribute": {
        "@xsdType": "string",
        "@xsdAttribute": true,
        "type": "string",
        "const": "<bytt ut med ønsket verdi>"
    }
}

XSD anyAttribute

Dette kan settes/redigeres manuelt i <model>.schema.json-filen som genereres når man lager en ny modell eller laster opp XSD i verktøyet. Finn frem til noden der anyAttribute skal settes, og legg til følgende på noden:

"@xsdAnyAttribute": {
    "Namespace": "##any",
    "ProcessContent": "None"
},

Attributter på xsd:schema-noden

Dette kan settes/redigeres manuelt i <model>.schema.json-filen som genereres når man lager en ny modell eller laster opp XSD i verktøyet. Det er ikke nødvendig å legge dette til manuelt om man har lastet opp en XSD i verktøyet, kun om man starter med tom modell i verktøyet. Disse settes på roten av <model>.schema.json-filen, ved å legge til:

"@xsdSchemaAttributes": {
    "AttributeFormDefault": "Unqualified",
    "ElementFormDefault": "Qualified",
    "BlockDefault": "None",
    "FinalDefault": "None"
},

XSD Namespaces

Namespaces på xsd:schema-noden

Dette kan settes/redigeres manuelt i <model>.schema.json-filen som genereres når man lager en ny modell eller laster opp XSD i verktøyet. Det er ikke nødvendig å legge dette til manuelt om man har lastet opp en XSD i verktøyet, kun om man starter med tom modell i verktøyet (med mindre man ønsker å redigere/tilføye noe). Disse settes på roten av <model>.schema.json-filen, ved å legge til node med de navnerommene man ønsker å inkludere. F.eks.:

"@xsdNamespaces": {
    "xsi": "http://www.w3.org/2001/XMLSchema-instance",
    "seres": "http://seres.no/xsd/forvaltningsdata",
    "xsd": "http://www.w3.org/2001/XMLSchema"
},