ADDML ved avlevering

ADDML (Archival Data Description Markup Language) er Nasjonalarkivets egenutviklede standard for teknisk beskrivelse av datasett. Standarden brukes for å beskrive poststrukturerte datafiler (tabelluttrekk) på teknisk detaljnivå. Standarden er i de senere år utvidet med muligheter for kontekstuell beskrivelse, men er fortsatt primært beregnet på teknisk beskrivelse.

Systemdokumentasjon

Tidligere var ADDML obligatorisk ved avlevering av arkivuttrekk og datasett. Men standarden er i dag frivillig å ta i bruk. Formålet kan også ivaretas ved å supplere arkivuttrekk med systemdokumentasjon.

• Systemdokumentasjon Se veileder om systemdokumentasjon.

Kontekst og innholdsbeskrivelse

En ADDML-fil skal inneholde både kontekst- og innholdsbeskrivelse. Filen skal også inneholde informasjon om hvor data finnes og hvordan dataene leses, forstås og etterprøves. Hvis det er gjort tilpasninger innen tegnsett eller kompliserte felter i løpet av uttrekksprosessen, vil ADDML-en være den maskinlesbare dokumentasjonen.

Les mer om ADDML-standarden

Referanseinformasjon om aktører og system

ADDML-filen skal inneholde referanseinformasjon om aktører og system som var med på å skape informasjonen i uttrekket.

• Aktører
  • Rolle – Arkivskaper, Produsent [av uttrekket], Arkiveier
  • Type – Individ, Organisasjon, System
  • Kontaktperson
• System
  • Systemtype – Noark 3-5 [implementert], Fagsystem eller annet fra listen lenger oppe.
  • Navn – Daglig-navn på løsning hos arkivskaper
  • Versjon – Versjonsnummer for systemet

Informasjon knyttet spesifikt til uttrekket

ADDML-filen skal også inneholde informasjon knyttet spesifikt til uttrekket, som utvalgskriterier rundt start- og sluttdato for arkivskapning og typen uttrekk som blir overført.

• Arkivperiode
  • Start- og sluttdato
  • Periodeskille
• Arkivuttrekk
  • Dato for uttrekk
  • Type uttrekk, trenger ikke være samme som system-typen

Etter man har tatt et uttrekk fra fagsystemet:

1. Liste opp filene med «registerdata», med filnavn, sjekksum og antall poster per fil.
2. Så Videre lager man definisjoner for alle nivåer; fil, post og felt. For felter som bruker kodet verdi, skal også kode med forklaring beskrives.
3. Legg til nøkler per post-definisjon, både identifiserende / unik nøkkel og kobling til andre post-definisjoner / fremmednøkkel.
4. Deretter knytter man fil, post og felt til en konkret måte for lesing av data, for eksempel tegnsettet i filen, post- og felt-skiller og om et felt inneholder en dato-verdi eller fødselsnummer.
5. Til slutt legges det til prosesser, som etterprøver den øvrige dokumentasjonen i filen med hva som faktisk finnes i uttrekket; kontroller sjekksum, datatype, antall poster, osv.

Noark 5

For Noark 5 finnes kun referanse-informasjon og registerdata i ADDML, fordi beskrivelser, lese-informasjon og prosesser allerede er beskrevet andre steder, blant annet i standarden. Så ADDML-filen vil inneholde statistiske data om antallet poster, sjekksum og relasjon mellom filene (hvilke XML-filer som valideres med hvilke XSD-er). Hvis det er tatt i bruk andre elementer enn de som finnes beskrevet i standarden, skal disse beskrives med et eget XML-skjema.

Lage ADDML-beskrivelser

ADDML-beskrivelsen kan lages enten i en tekst- eller XML-editor. En XML-editor med auto-complete kan generere en ADDML-fil med minimal kunnskap om standarden, samtidig som man får  fylt ut det meste av informasjon på en strukturert måte.