Home
For oppdatert dokumentasjon om Fiks-Arkiv og implementasjonsdetaljer for protokollen anbefaler vi å se på sidene for Fiks-Arkiv protokollen og Fiks-Protokoll på ks-no.github.no her: https://developers.fiks.ks.no/tjenester/fiksprotokoll/arkiv/
Der finner man f.eks. lenker til Github prosjekter som hører sammen med protokollen.
Datamodellen følger Noark 5. Noark 5 er dokumentert her: Noark 5-standarden
Mappe er det overordnede objektet for å samle saker i. Det er mulig å ha mapper i mapper.
Saksmappe er en spesialisering av mappe og er den som brukes i saksarkiver. Ved blanding av mapper og saksmapper må saksmappe være nederste nivå. Oftest vil det kun være saksmappe.
Registrering er det overordnede objektet for å samle et sett med dokumenter som hører sammen, eller for å angi en hendelse.
Journalpost er en spesialisering av registrering og brukes for hendelser som skal inn i journalen, en oversikt over all korrespondanse til og fra organisasjonen, samt interne notater og rapporter. Oftest vil det kun være journalposter registrert i saksmapper.
Dokumentbeskrivelse inneholder info om hoveddokument og vedlegg knyttet til registreringen/journalposten.
Dokumentobjekt inneholder info om "filer". En dokumentbeskrivelse kan ha mange dokumentobjekt: Utkast arkivert og versjonert, formatvarianter som formater for tekstbehandling og visning, sladdet versjon m.m.
Noarks datamodell er hierarkisk med fire nivåer over mappe. Disse inngår dels som referanser fra mappe/saksmappe i GeoIntegrasjon:
Arkiv er øverste nivå og samler alt som en organisasjon arkiverer.
Arkivdel er en del av arkivet som er ordnet på samme måte (f.eks. etter gårds- og bruksnummer, eller etter en arkivkode). Det kan også lages arkivdeler for en tidsperiode. Det er vanlig at det emne-/funksjonsordnede arkivet har ny arkivdel for hver kommunestyreperiode i kommunene eller hvert 5. år for andre. Arkivdel er referert fra (saks-)mappen for å angi hvilken arkivdel denne ligger i.
Klassifikasjonssystem angir hvordan sakene i en arkivdel er ordnet, f.eks. om det er et objektarkiv/seriearkiv med gårds- og bruksnummer, lønnsnummer, klientnummer e.a., eller om det er et emnearkiv/funksjonsordnet arkiv etter en fast arkivnøkkel.
Klasse er selve arkivkoden som i et eiendomsarkiv normalt er gårdsnummer/bruksnummer, evt. kommunenummer-gårdsnummer/bruksnummer. I et emne-/funksjonsordnet arkiv kan det være en kode som A40, 001 eller 2.5.13. En saksmappe vil normalt ha en primær klasse som inngår i hierarkiet, men kan også ha sekundære klasser. I GeoIntegrasjon brukes objektet klasse knyttet til (saks-)mappe som inneholder informasjon om både klassifikasjonssystemet og klassen. Mappen kan ha flere klasser. Den første er da den primære og er den som styrer ordningen inn i arkivdelen, men de øvrige er tilleggsinformasjon.
Fiks-Arkiv baserer seg på asynkron meldingsutveksling via Fiks-Protokoll plattformen. Dette vil si at avsender ikke kan forvente at det vil utføres en handling på bakgrunn av sendt melding med det samme, men at handlingen vil skje en gang i fremtiden.
Asynkron meldingsutveksling medfører at avsender må håndtere at sendte meldinger ikke nødvendigvis blir utført med en gang, men at man får svar på meldingen på et senere tidspunkt. Det vil være 4 mulige utfall av en melding:
- Svar som bekrefter at handlingen meldingen skulle utføre var vellykket
- Svar som inneholder en feilmelding
- Meldingens levetid utløper (TTL). Avsender må avgjøre om dette håndteres med re-sending eller på annen måte
- Du får svar som sier at meldingen er mottatt, men mangler bekreftelse på at handlingen ble utført. Gitt at mottaker har bekreftet å mottatt meldingen er ansvaret for handling nå overført til mottaker.
Fiks-Arkiv vil ha meldinger både for arkivering og spørring mot arkivet. For avsendersystem som ikke har behov for å sende all informasjon en komplett arkivmelding inneholder vil det utvikles forenklede klienter som fyller ut nødvendige felter for å skape en gyldig arkivmelding.
Fiks-Protokoll (Fiks-IO) er en kanal for sikker maskin-til-maskin integrasjon. Denne kanalen kan benyttes for å bygge prosesser på tvers av systemer og organisasjoner, for eksempel når et fagsystem skal arkivere et dokument i et arkivsystem eller spørre om informasjon som er lagret i et annet system. Dokumentasjon for hvordan du kommer i gang med Fiks Protokoll finnes her.
Arkivmeldingene som sendes er standardisert for å kunne sendes mellom Fiks-Arkiv og eFormidling uten at det er nødvendig å mappe mellom forskjellige formater underveis. Dette gjør at en statlig virksomhet kan sende en arkivmelding via sitt integrasjonspunkt til en kommunal varsomhets GeoIntegrasjon2.0 mottak via FIKS IO som vist i modellen under
GI Arkiv bruker en meldingstjeneste som Fiks IO til å sende meldinger aynkront mellom to systemer.
Siden hver bruker av Fiks IO kopler opp til Fiks IO som står sentralt, vil det kun være nødvendig med åpning mot Fiks IO for alle som bruker GI Arkiv.
Hvert system må autentisere seg for å få tilgang til en konto i Fiks IO. Hver konto kan velge hvilken andre kontoer den vil motta meldinger fra. Autentisering foregår med maskinporten og Fiks autentisering. se https://ks-no.github.io for mer detaljer.
Fiks Arkiv vil ha asynkrone meldinger, detter betyr at meldingene kan komme fram en tilfeldig tid i framtida. En bør sette fornuftige Time to live verdier på meldinger. Hvis en søker etter data vil kanskje 10-30s være en fornuftig timeout, mens arkviering av f.eks en journalpost kan ta 3 dager. Hvis en setter Time to live høgt kan systemer gå ned og komme opp igjen før den utfører oppgaven. Fiks IO garanterer heller ikke at meldingen kommer fram eller at de kommer fram i den rekkefølgen de ble sendt, så klienten må da ha en egen sjekk på om det er komt svar og eventuelt prøve på nytt hvis det er fornuftig.
Protokollen Fiks Arkiv har et gitt antall meldingstyper som støttes.
Les mer om meldingstypene her.
Alle meldinger som har en xml-payload som er standardisert innenfor protokollen har et tilhørende skjema med eventuelle fellesskjema som inneholder felles datatyper.
Skjema som tilhører en meldingstype sin payload har tilsvarende navn som meldingstypen.
F.eks. har meldingstypen no.ks.fiks.arkiv.v1.arkivering.arkivmelding.opprett et tilhørende skjema med navn no.ks.fiks.arkiv.v1.arkivering.arkivmelding.opprett.xsd som inkluderer skjemaet metadatakatalog.xsd med felles datatyper.
Oversikt over skjema og hvilke felles skjema som er inkludert hvor:
Protokollen er versjonert, hvis du lurer på hvilken protokollversjon mottaker støtter kan en sjekke dette i FiksIO konto katalogen.
Link til Gjennomgang av ulike brukstilfeller. - Mal For brukstilfelle - Arne.Brukstilfeller
Meldingsprotokollen- med meldinger og klient bibliotek - Tor kjetil
Implementasjon av grensesnittet – bruk av klient bibliotek - Tor kjetil
Validator - godkjente system