Fiks Arkiv er en modernisering av GI Arkiv 1.1 og det nye grensesnittet som anbefales brukt når kommunen skal sette opp kommunikasjonen mellom et fagsystem og en arkivløsning.
Se filen meldingstyper.json for hvilke meldingstyper som er i denne protokollen og hvordan de henger sammen. Man kan også se på den genererte UML-modellen som viser hvordan meldingstypene henger sammen.
Hver meldingstype som har en payload har et tilhørende xsd-skjema med samme navn.
Under mappen kodelister ligger eksempler på kodelister i json-format samt diagram som gir oversikt over innhold.
Skjemaene er i xsd-format og ligger under Schema/V1.
Det er et skjema for hver meldingstype som har en payload og som har samme navn som meldingstype, samt delte skjema med fellest datatyper.
KS leverer også bibliotek for Java og .NET som inneholder skjemaene, meldingstyper.json filen, hjelpeklasser og genererte modeller fra skjema.
Maven Central: https://central.sonatype.com/artifact/no.ks.fiks/fiks-arkiv
Nuget.org: https://www.nuget.org/packages/KS.Fiks.Arkiv.Models.V1
For mer utfyllende dokumentasjon om protokollen kan man lese mer i wiki for Fiks Arkiv
For informasjon om Fiks plattformen og Fiks Arkiv i den sammenheng kan man lese mer på ks.no og på developers.fiks.ks.no
I mappen Dokumentasjon i dette repoet finner man dokumentasjon og diagrammer for denne versjonen av protokollen. Diagrammene er stort sett utarbeidet vha PlantUML. Kildekoden i PlantUML for diagrammene ligger da der også hvis man ønsker å bruke de som utgangspunkt i videre arbeid eller ønsker å forbedre de.
Vi bruker PlantUML for å tegne diagrammer som så blir eksportert til png og svg filer. For eksempel bruker vi PlantUML til å generere oversikten over sammenhengen mellom meldingstyper ut i fra meldingstyper.json filen.
Vi genererer også PlantUML kode fra xsd filene for å vise datamodellen vha PHP biblioteket xsdata
For å generere nye modeller i prosjektet kan man kjøre generate-uml.sh scriptet.