NOARK 5 tjenestegrensesnitt

Innhold1Orientering og introduksjon51.1Historikk og status51.2Noark51.3Noark tjenestegrensesnitt51.4Prosjekt for Noark 5 tjenestegrensesnitt51.5Prosjektets hovedml51.6Prosjektets organisering61.7Endringslogg72Normative referanser83Konformitet94Teknologi94.1Autentisering95Definisjoner106Konsepter og prinsipper116.1Utforming av tjenester116.1.1REST tjenestene116.1.1.1Oppkobling og ressurslenker116.1.1.2Finne objekter (Read)136.1.1.3Opprette objekter (Create)166.1.1.4Preutfylling av objekt186.1.1.5Oppdatere objekter (Update)196.1.1.6Oppdatere referanser mellom objekter206.1.1.7Slette objekter (Delete)226.1.1.8Overfringsformat256.1.1.9Hente og overfre filer256.2Validering av data286.3Identifikatorer286.4Utvidelsesmuligheter287Tjenester og informasjonsmodell297.1Om UML og notasjon som er benyttet297.2Noark5v4327.2.1Arkivstruktur377.2.1.1Arkiv557.2.1.2Arkivdel637.2.1.3Arkivenhet757.2.1.4Arkivskaper807.2.1.5Basisregistrering827.2.1.6Dokumentbeskrivelse897.2.1.7Dokumentobjekt997.2.1.8ElektroniskSignatur1077.2.1.9Gradering1097.2.1.10Hendelseslogg1117.2.1.11Kassasjon1127.2.1.12Klasse1157.2.1.13Klassifikasjonssystem1217.2.1.14Konvertering1257.2.1.15Kryssreferanse1297.2.1.16Mappe1317.2.1.17Merknad1417.2.1.18Registrering1457.2.1.19Skjerming1497.2.1.20Sletting1527.2.1.21UtfrtKassasjon1547.2.1.22NasjonaleIdentifikatorer1577.2.2Kodelister1657.2.2.1Arkivdelstatus1667.2.2.2Arkivstatus1677.2.2.3Avskrivningsmte1677.2.2.4Dokumentmedium1687.2.2.5Dokumentstatus1697.2.2.6Dokumenttype1697.2.2.7ElektroniskSignaturSikkerhetsniv1707.2.2.8ElektroniskSignaturVerifisert1717.2.2.9FlytStatus1727.2.2.10Format1727.2.2.11Graderingskode1747.2.2.12Hendelsetype1757.2.2.13Journalposttype1757.2.2.14Journalstatus1767.2.2.15Kassasjonsvedtak1777.2.2.16Klassifikasjonstype1787.2.2.17Korrespondanseparttype1797.2.2.18Land1797.2.2.19Mappetype1807.2.2.20Merknadstype1807.2.2.21MtedeltakerFunksjon1817.2.2.22Mteregistreringsstatus1827.2.2.23Mteregistreringstype1837.2.2.24Mtesakstype1847.2.2.25Postnummer1857.2.2.26Presedensstatus1857.2.2.27SakspartRolle1867.2.2.28Saksstatus1867.2.2.29SkjermingDokument1877.2.2.30SkjermingMetadata1887.2.2.31Slettingstype1897.2.2.32SystemID1907.2.2.33Tilgangskategori1917.2.2.34Tilgangsrestriksjon1927.2.2.35TilknyttetRegistreringSom1937.2.2.36Variantformat1937.2.3Sakarkiv1957.2.3.1Avskrivning2037.2.3.2Dokumentflyt2077.2.3.3EnkelAdresse2117.2.3.4Journalpost2127.2.3.5Kontaktinformasjon2237.2.3.6Korrespondansepart2237.2.3.7KorrespondansepartEnhet2277.2.3.8KorrespondansepartIntern2287.2.3.9KorrespondansepartPerson2297.2.3.10Presedens2307.2.3.11Saksmappe2387.2.3.12Sakspart2467.2.3.13SakspartEnhet2497.2.3.14SakspartPerson2507.2.4Admin2527.2.4.1AdministrativEnhet2537.2.4.2Bruker2597.2.4.3Tilgang2637.2.5LoggingOgSporing2647.2.5.1Endringslogg2658Vedlegg 1 Konformitetskrav2679Vedlegg 2 Objektkatalog26810Vedlegg 3 Ressurser til REST API269

Orientering og introduksjonHistorikk og statusNoark

Noark Norsk arkivstandard ble utarbeidet som kravspesifikasjon for elektroniske journalsystemer i statsforvaltningen, og etablerte seg raskt som en de facto standard, forvaltet av Riksarkivet. Kommunal sektor utarbeidet en tilsvarende kravspesifikasjon Koark. Spesifikasjonene i Koark ble innlemmet i Noark-4, og da arkivforskriften trdte i kraft ble det obligatorisk for offentlig forvaltning benytte et Noark-basert system for elektronisk journalfring.

Gjeldende standard Noark 5 kan benyttes for all elektronisk arkivdanning ogs fagsystemer med saksbehandling.

Noark tjenestegrensesnitt

Teknisk grensesnitt mot kjernen er en del av standarden. Noark-4 Web Services ble utarbeidet i 2006 etter initiativ fra KS, og som et resultat av behov hos kommunene. Formlet var standardisere og forenkle kommunikasjonen mellom de ulike systemene i forvaltningen.

Statens Kartverk og KS gjennomfrte i GeoIntegrasjonsprosjektet en revisjon av Noark-4 Web Services. Tjenestene i Noark-4 Web services er avgrenset ut fra behovene fagsystemene har for arkivere og gjenfinne data.

I nvrende form, og sett i lys av avgrensningene, mangler Noark tjenestegrensesnittet funksjonalitet. Et utvidet standardisert grensesnitt vil legge til rette for gode, sammenhengende tjenester p tvers av virksomhetsgrensene i offentlig sektor. De ulike leverandrene behver ikke utvide tjenestene, eller benytte egne grensesnitt.

Prosjekt for Noark 5 tjenestegrensesnitt

Prosjekt for Noark 5 tjenestegrensesnitt ble satt i gang av Riksarkivet og KS hsten 2013, og gjennomfrt i regi av KS KommIT. Blant initiativtakere til prosjektet var ogs K10 det kommunale it-samarbeidet for landets 10 strste kommuner.

Mlsettingen for prosjektet har vrt, sammen med arkivleverandrene, utvide det standardiserte grensesnittet mot Noark 5 kjerne. Grensesnittet skal vre tjenestebasert og bygge p erfaringene fra Noark -4 med tilhrende web services, GeoIntegrasjonsprosjektet og arkivleverandrenes utvidelser.

Prosjektgruppen ble etablert i november 2013. Prosjektets arbeidsgruppe ble satt ned i januar 2014 og arbeidet med versjon 0.9 av tjenestegrensesnittet er avsluttet i oktober 2014.

Prosjektets hovedml

Mandatet for prosjektet var- etablere en plattformuavhengig informasjonsmodell i UML for arkivstrukturen i Noark 5- definere CRUD tjenester (Create, Read, Update, Delete) for objektene i informasjonsmodellen

Ml og begrunnelse for prosjektet var videre

sammen med arkivleverandrindustrien utvikle og levere et tjenestegrensesnitt for Noark 5 som implementeres som et krav i Noark-standarden, forvaltes av Riksarkivet og benyttes av faglsninger uavhengig av leverandr. Prosjektet skal ogs levere et forslag til opplegg for test og godkjenning. Prosjektet skal videre bidra til skape en arena der leverandrindustrien og bestillerne kan mtes og diskutere behov og utfordringer.

Et standardisert Noark 5 tjenestegrensesnitt skal bidra til gode, sammenhengende digitale tjenester p tvers av virksomhetsgrensene i offentlig sektor, sttte opp under offentlige virksomheters nske om leverandruavhengighet, samt fremme digitalisering og gi bedre tjenester.

Prosjektets organisering

Prosjekteiere:Riksarkivet, KS, KMD og Kartverket

Styringsgruppe:SAMDOK sin strategigruppe Arkiv i e-forvaltning

Prosjektgruppen har besttt av:

Hans Fredrik Berg (Riksarkivet), Rune Sandland (KommIT), Michael Pande Rolfsen (KommIT), Anne Mette Drum (KS), Line Richardsen (KS), Tor Kjetil Nilsen (KommIT/Arkitektum as), Per Arne Aass (Fredrikstad kommune), Atle Lvstakken (Bergen Kommune). Prosjektleder Inger Berit Eidsten (KommIT/EKOR AS).

Arbeidsgruppen har besttt av:

Fra prosjektgruppenHans Fredrik Berg (Riksarkivet), Tor Kjetil Nilsen (KommIT), Rune Sandland (KommIT) Inger Berit Eidsten (KommIT).

Fra leverandreneACOS - Trygve Hland, Ciber - Antony Lrdahl / Kjetil Sahlberg, Evry - Ragnar Sturtzel, Gecko - Haakon Johannessen / Steinar Herland, Documaster - Christian Lundvang / Dimitar Ouzounov, Norconsult - Tor Olav Alms, Oppad - Thor Arne Johnsen, Software Innovation - Bjrn Tore Eriksen, Visma - Harry Myrene

Trondheim kommune: Jean-Philippe Caquet

Endringslogg

Versjon

Dato

Utfrt av

Endring

0.9

26.08.2014

Tor Kjetil Nilsen

Frste versjon

0.9.1

09.10.2014

Inger Berit Eidsten

Lagt inn kapittel om Orientering og introduksjon

0.9.2

10.10.2014

Tor Kjetil Nilsen

Flyttet kapittel om avgrensninger og utvidelser til Vedlegg 5 Endringslogg fra NOARK 5 v3.1

0.9.3

30.10.2014

Tor Kjetil Nilsen

Oppdatert fra UML modell og eksempler

0.9.4

06.11.2014

Tor Kjetil Nilsen

Oppdatert bilde for oppdatering av mappe, fjernet kommentarer

0.9.5

06.05.2015

Tor Kjetil Nilsen

Overskriftsnummerering, fjernet SOAP webservice, gtt tilbake p relasjon til sakspart og korrespondansepart

0.9.6

08.07.2015

Tor Kjetil Nilsen

Oppdatert etter konklusjoner p intern hring

0.9.7

14.01.2016

Tor Kjetil Nilsen

Oppdatert etter konklusjoner p hringskommentarer

0.9.8

03.05.2016

Tor Kjetil Nilsen

Oppdatert etter konklusjoner p hringskommentarer

0.9.8.1

31.05.2016

Tor Kjetil Nilsen

Oppdatert med flere filtereksempler, kapittel for

filopplasting og feilrettinger

1.0 beta

01.07.2016

Tor Kjetil Nilsen

Oppdatert etter avklaringsmter overlevering fra SAMDOK til Arkivverket

Normative referanser

For den fulle forstelse av denne standarden br en ha god kjennskap til referansene under.

Norsk Arkivstandard(NOARK) 5 versjon 3.1 https://arkivverket.no/arkivverket/Offentleg-forvalting/Noark/Noark-5/Standarden

Unified Modeling Language(UML) versjon 2 - er en industristandard for datarelatert modellering, forvaltet av et internasjonalt konsortium Object Management Group(OMG) - http://www.omg.org/spec/UML/

Webtjenester med REST/HATEOAS - https://tools.ietf.org/html/draft-kelly-json-hal-07

Konformitet

Bakgrunnen for konformitetsnivene er behovet for kunne gruppere krav i NOARK standarden med aktuell modularitet i system som skal anskaffes. Det vil ogs gjre det enklere for leverandrer f godkjenning for sine implementasjoner.

Anskaffelser av arkivkjerner kan tilpasses aktuelle konformitetsniv.

Anskaffelser av fagsystem br opplyse om hvilket niv som tilbys av arkivkjerne, og fagsystem som integrerer seg med arkivkjerne br opplyse om hvilke niv de krever for kunne operere p aktuell kjerne.

De grunnleggende krav er lagt i basiskrav og arkivstruktur og m stttes av alle kjerner. Utvidelser skjer med egne moduler som er