Brukerveiledning\uf0c1
Arkade 5\uf0c1
Skrivebordsapplikasjon for Windows
Arkade 5 brukes ved å lese inn et arkivuttrekk, utføre testing av uttrekket og/eller opprette en arkivpakke av uttrekket. Ved testing genereres det en utfyllende testrapport. Arkade 5 muliggjør også opprettelse/endring av metadata for arkivuttrekk.
Oppstart/avslutning\uf0c1
Ved oppstart av Arkade åpnes innlastingsvinduet. Dersom et tilgjengelig område for midlertidige filer ikke allerede er definert, vil Arkade først be om at dette blir oppgitt (se «Prosesseringsområde»). Arkade avsluttes ved å lukke hovedvinduet. Ved avslutning igangsettes sletting av midlertidige filer.
Innlastingsvinduet\uf0c1
Innlasting\uf0c1
Velg og last inn arkivuttrekket som skal behandles:
- Klikk på knappen «Velg katalog» dersom uttrekket er en ordinær fil-/mappestruktur. I tilfelle velges katalogen som inneholder arkivbeskrivelse-filen (addml.xml eller arkivuttrekk.xml). Klikk på knappen «Velg fil» dersom uttrekket er en .siard-fil eller en AIP/SIP-struktur pakket som en tar-fil.
- Dersom Arkade ikke automatisk har klart å detektere arkivtypen, oppgi arkivtype for det valgte uttrekket. Arkade 5 støtter typene «Fagsystem», «Noark 3», «Noark 5» og «Siard».
- Klikk på knappen «Last inn uttrekk». Det valgte uttrekket vil lastes inn og åpnes i testvinduet.
Testvinduet\uf0c1
Øverst i testvinduet vises:
- Full filsti for det valgte uttrekket
- En unik identifikator (UUID), generert for den gjeldende behandlingen av det valgte uttrekket
- Valgt arkivtype
- Hvilken fil som under testing prosesseres i øyeblikket
- Løpende informasjon om testkjøring*
- Informasjon om testframdrift i prosent (N5/N3/Fagsystem) eller som statusmeldinger (Siard)
*For uttrekk av typen Noark 5 vises antall prosesserte XML-elementer. For uttrekk basert på en ADDML-fil vises antall prosesserte filer og antall prosesserte poster.
Testkjøring\uf0c1
Klikk på knappen «Start testing» for å starte testkjøring på det valgte uttrekket. Testkjøringen vil vare fra noen minutter til mange timer, avhengig av uttrekkets størrelse.
Under testkjøring vil det, i den nedre delen av vinduet, vises meldinger om innlesing, ev. strukturelle feil/mangler ved uttrekket, rapportgenerering og fullført testing.
Testrapport\uf0c1
Etter fullført testing vil det genereres en rapport i formatene HTML, PDF/A-1b, XML og JSON. Klikk på knappen «Vis rapport» for å åpne HTML-versjonen i en nettleser eller eksportere en katalog med rapporten i alle formater.
(!) Ved opprettelse av arkivpakke inkluderes alltid testrapporten i alle formater.
Arkivpakkegenerering\uf0c1
Klikk på knappen «Opprett pakke» for å lage en arkivpakke (AIP/SIP) av uttrekket. Dette åpner arkivpakkevinduet der valg for pakken kan gjøres før den opprettes.
Det er mulig å opprette en arkivpakke uten først å utføre testing av det aktuelle arkivuttrekket. En slik pakke vil ikke inneholde noen testrapport.
Nytt uttrekk / ny kjøring\uf0c1
Ved klikk på knappen «Ny kjøring» avsluttes pågående arkivbehandling og Arkade returnerer til innlastingsvinduet. Dersom det inneværende arkivuttrekket endres, f.eks. som følge av feil/mangler vist i testrapporten, må uttrekket lastes inn på nytt (og ev. tester kjøres på nytt) før knappen «Opprett pakke» oppretter en pakke som inneholder endringene (og knappen «Vis rapport» åpner en gyldig testrapport). Uttrekket lastes inn på nytt ved å klikke «Ny kjøring» (eller ved å starte Arkade på nytt).
NB! Skal det opprettes en arkivpakke som inkluderer resultatene fra inneværende testkjøring, må dette gjøres før «Ny kjøring» klikkes (eller Arkade avsluttes).
Arkivpakkevinduet\uf0c1
Før arkivpakke opprettes registreres aktuelle metadata. For å skape en gyldig arkivpakke må påkrevde felter (merket *) utfylles. Dersom det aktuelle arkivuttrekket i utgangspunktet var en arkivpakke (AIP/SIP) med allerede definerte metadata, vil Arkade forsøke å lese disse inn og forhåndsutfylle feltene i arkivpakkevinduet. Ved å klikke knappen «Hent eksterne metadata» kan det velges en fil med forhåndsdefinerte metadata, enten en METS-fil (f.eks. {uuid}.xml, info.xml eller dias-mets.xml fra tidligere produsert pakke) eller metadata på JSON-format - f.eks. generert med malfil-generator (GUI) eller med Arkade CLI - for automatisk utfylling av feltene. Når pakken opprettes skrives den utfylte informasjonen til filen dias-mets.xml som legges ved i arkivpakken. Metadataene skrives også til filen {uuid}.xml som legges utenfor, på samme nivå som, arkivpakken.
I nedre del av vinduet velges ønsket pakketype, SIP eller AIP.
Dersom «Inkluder formatinformasjon for dokumentfiler», eller «Inkluder formatinformasjon for LOBer» for Siard-uttrekk, velges vil Arkade lage en csv-fil med forespurt informasjon og lagre denne på følgende lokasjon i tar-filen: {uuid}\administrative_metadata. (Pakkeuavhengig formatanalyse av innholdet i en hvilken som helst katalog er tilgjengelig fra «verktøy»-menyvalget: 
).
Når ønskede metadata er oppgitt, klikkes knappen «Opprett pakke». Dette åpner et dialogvindu for valg av pakkens plassering. Ved valgt plassering opprettes arkivpakken.
Arkivpakken vil opprettes som en tar-fil og filnavnet vil være UUID-en som er generert for den gjeldende arkivbehandlingen: {uuid}.tar. Pakken og tilhørende {uuid}.xml-fil plasseres i en katalog Arkaderesultater-{uuid}. Når alt er ferdig generert, vises denne katalogen på den valgte plasseringen.
NB! Knappen «Ny kjøring» avslutter gjeldene arkivbehandling.
Tip
- Pakke re-generering
Så lenge arkivpakkevinduet ikke forlates, kan metadata endres og «Opprett pakke» klikkes på nytt. Velges samme pakkeplassering, overskrives foregående pakke og
{uuid}.xmlmed oppdaterte metadata. Sørg bare for at filene som skal overskrives ikke er opptatt, f.eks. ved at de er åpnet i andre programmer.——————————–
- ESSArch-tilpasninger
Følgende operasjoner kan forenkle innlastning av arkivpakke i ESSArch:
- Navn om pakkeinformasjonsfilen fra
{uuid}.xmltilinfo.xml(eller annet fast navn iht. ESSArchs konfigurasjon) - Fjern linjene i pakkeinformasjonsfilen som beskriver filen dias-mets.xml (se bildet)
- Plasser pakkeinformasjonsfilen og pakkefilen i en egen katalog
- Navn om pakkeinformasjonsfilen fra
Knappemeny\uf0c1
Øverst til høyre i Arkades hovedvindu finnes det til enhver tid følgende knapper:
Verktøy - Ulike tilleggsverktøy (se «Verktøy»)
Hjemmeside - Åpner Arkades nettsted i standard nettleser
Innstillinger - Innstillinger for språk og midlertidige filer m.m. (se «Innstillinger»)
Om Arkade - Viser versjons- og lisensinformasjon for Arkade 5 og tilknyttet programvare
Verktøy \uf0c1
Åpner et vindu med tilleggsverktøy for Arkade:
PRONOM filformat-analyse\uf0c1
Analyse av filformater iht. PRONOM for filer i en valgt katalog og dens underkataloger (rekursivt). Hver fil sin PRONOM-id kontrolleres mot hvilke filformater Riksarkivarens forskrift definerer som gyldige arkivformater. Gyldigheten spesifiseres under feltet med header-navn RAF-yyMMdd, der yyMMdd viser til endringsdatoen til versjonen av forskriften valideringen baserer seg på. Dersom filens gyldighet er spesifiert med Gyldig*, indikerer asteriksen (*) at filformatet er godkjent under visse forutsetninger, gitt av Riksarkivarens forskrift. Arkade har ikke tilgang til de spesifikke forutsetningene, disse må derfor undersøkes nærmere manuelt.
Validering av arkivformat\uf0c1
Validering av om en valgt fil eller katalog har det valgte formatet blant følgende:
- PDF/A
- Validering av valgt PDF-fil, eller av PDF-filene i en valgt katalog. Validatoren kontrollerer om filene er PDF/A av en variant godkjent av Arkivverket (PDF/A-1A, -1B, -2A, -2B eller -2U).
- DIAS
- Validering av en valgt SIP eller AIP som tar-fil eller katalog. Validatoren kontrollerer om informasjonspakken har en fil- og katalogstruktur som er iht. spesifikasjonen for DIAS. (Filinnhold blir ikke kontrollert.) Enkelte spesielle avvik fra standarden blir akseptert av Arkivverket. Det framgår av valideringsresultatet om pakkens struktur er gyldig (uten mangler), ugyldig (mangelfull) eller akseptabel (har aksepterte mangler).
Generering av mal-fil for metadata\uf0c1
Generering av en json-fil med riktig METS-struktur, utfylt med eksempeldata. Etter å ha erstattet eksempeldata med reelle data, kan filen importeres for utfylling av metadata i Arkivpakkevinduet.
Innstillinger \uf0c1
Prosesseringsområde\uf0c1
Under kjøring benytter Arkade et filområde til plassering av midlertidige filer fra arkivprosessering, system- og feillogger samt andre systemfiler. Plassering for prosesseringsområdet velges av bruker som en katalog i filsystemet og må være definert før arkiv kan behandles. Plasseringen som velges må være egnet med tanke på størrelse, tilgjengelighet og personvern. Størrelsen må være minst den av alle uttrekk som skal behandles under samme kjøring i tillegg til plass for systemfiler. Ved avslutning av Arkade igangsettes sletting av midlertidige filer og gamle loggfiler. Plasseringen av prosesseringsområdet kan når som helst endres fra innstillingsvinduet. Ved endring av plassering, igangsettes sletting av opprinnelig prosesseringsområde. Ny plassering vil tas i bruk neste gang Arkade startes.
Språk\uf0c1
Det er mulig å velge språk for både brukergrensesnitt og filer som blir produsert av Arkade. Det kan være nyttig å skille mellom disse for eksempel for en engelskspråklig bruker som skal levere rapporter på norsk. En oversikt over støttede språk finnes i systemdokumentasjonen
Mørk modus\uf0c1
Brukes for å aktivere eller deaktivere mørk modus for Arkade.
Arkade 5 CLI\uf0c1
Kommandolinjegrensesnitt for Linux, macOS og Windows
Arkade 5 CLI tester og/eller lager en arkivpakke av et arkivuttrekk. Hva slags type oppgave som skal utføres styres ved hjelp av en kommando. Plasseringer for arkivutrekket som skal behandles, metadata, ferdig arkivpakke og testrapport samt midlertidige filer og systemlogger, kan alle oppgis som parametre, avhengig av hvilken kommando som skal kjøres.
Se installasjonsveiledning for Arkade 5 CLI
Kjøring\uf0c1
Dersom instruksjonene i installasjonsveiledningen for ditt operativsystem følges (Linux/Mac, Windows) vil Arkade 5 CLI være kjørbart med arkade <kommando> [parametere] fra hvor som helst i filsystemet.
(Dersom man ikke følger stegene som beskriver hvordan Arkade 5 CLI tilgjengeliggjøres fra hvor som helst i filsystemet må man i Linux/Mac kjøre arkade med ./arkade.sh.)
Videre eksempler er gitt med utgangspunkt i at ovennevnte veiledning er fulgt.
Kommandoer\uf0c1
Arkade CLI krever fra og med versjon 2.0 at det oppgis en kommando for å spesifisere hvilken oppgave som skal utføres.
For en oversikt over tilgjengelige kommandoer og de tilhørende parametrene, bruk help:
arkade help
Parametre\uf0c1
Bruk --help, etter en kommando for å vise eksempler på bruksmåte og en oversikt over dens parametre:
arkade generate --help
Alle parametre foruten --help og --version kan oppgis i kortform og må, hvis ikke annet er oppgitt, etterfølges av aktuell verdi f.eks. --type Noark5 eller -t Noark5
Parametrenes rekkefølge er likegyldig.
Arkivtype (--type/-t)\uf0c1
Dersom arkivuttrekket som oppgis til --archive/-a er gyldig i henhold til en av standardene Arkade støtter, kan Arkade automatisk detektere arkivtypen. Automatisk deteksjon av arkivtypen til et pakket arkiv (.tar-fil) forutsetter at infofilen er lokalisert ved siden av arkivfilen.
Språk (--language/-l)\uf0c1
Arkade CLI støtter fra og med versjon 2.3.0 valg av språk for utdata fra applikasjonen. Se systemdokumentasjon for hvilke språk Arkade støtter.
Prosesseringsområde (CLI)\uf0c1
Under kjøring benytter Arkade et filområde til plassering av midlertidige filer fra arkivprosessering, system- og feillogger samt andre systemfiler. Plassering for prosesseringsområdet velges av bruker som en katalog i filsystemet og må oppgis med parameteren --processing-area eller -p. Plasseringen som velges må være egnet med tanke på størrelse, lese-/skrivehastighet og personvern. Størrelsen må være minst den av uttrekket som skal behandles, i tillegg til noen MB for systemfiler. Etter en arkivprosessering vil Arkade igangsette sletting av midlertidige filer og gamle loggfiler. Av tekniske hensyn fjernes ikke automatisk mindre enn 1 uke gamle loggfiler. Vær oppmerksom på at loggfiler kan inneholde personopplysninger. Det anbefales å bruke den samme plasseringen for prosesseringsområdet for hver kjøring. Slik kan Arkade automatisk fjerne loggfiler som er mer enn 1 uke gamle. Sørg ellers for manuelt å fjerne loggfilene.
Eksempel på bruk\uf0c1
Plasseringer og navn på kataloger for inn- og utdata er valgfrie. I eksemplene som følger brukes katalogene tmp/ og output/ i hjemmekatalogen ~/. Opprett de samme katalogene dersom du vil bruke eksempelkommandoene i denne veiledningen slik som de står.
mkdir ~/tmp
mkdir ~/output
process - Prosessering av arkivuttrekk\uf0c1
Arkivuttrekket som skal prosesseres kan foreligge som en ordinær mappestruktur eller en AIP/SIP-struktur pakket som en tar-fil. Parameterverdien for --archive/-a settes til hhv. katalogen som inneholder arkivbeskrivelse-filen (addml.xml eller arkivuttrekk.xml) eller til tar-filen.
Under vises et eksempel på hvordan kommandoen process brukes. Det leses inn et arkivuttrekk fra katalogen ~/N5-arkivuttrekk/. Ved å ikke oppgi -t i dette eksempelet, er arkivuttrekkets type overlatt til Arkade å detektere. Metadata for uttrekket leses fra filen ~/output/arkade-ip-metadata.json. Katalog for plassering av prosesseringsområdet er satt til ~/tmp/ og katalog for resulterende data er satt til ~/output/.
arkade process -a ~/N5-arkivuttrekk/ -m ~/output/arkade-ip-metadata.json -p ~/tmp/ -o ~/output/
--archive --metadata-file --processing-area --output-directory-a -m -p -o--information-package-type/-i - Standardverdi ’SIP’. Kan overstyres til ’AIP’.--noark5-test-selection/-s - Oppgi sti til en fil som inneholder et utvalg av tester som skal kjøres.--result-display-limit/-r - Definerer maksimalt antall resultater som vises per testpunkt i .html- og .pdf-testrapporter. Standardverdi er 100.--document-file-format-check/-f - Arkade utfører formatanalyse av dokumentfiler og lagrer resultatet i en csv-fil i tar-pakken.test - Testing av arkivuttrekk\uf0c1
Test om et arkivuttrekk er i henhold til standard. Eksempel på bruk:
arkade test -a ~/N5-arkivuttrekk/ -p ~/tmp/ -o ~/output/ -s ~/output/n5-testlist.txt
--archive --processing-area --output-directory-a -p -o--result-display-limit/-r - Definerer maksimalt antall resultater som vises per testpunkt i .html- og .pdf-testrapporter. Standardverdi er 100.--noark5-test-selection/-s - Oppgi sti til en fil som inneholder et utvalg av tester som skal kjøres. Arkade CLI kan lage en fil med et eksempel på en liste over tester.pack - Pakking av arkivuttrekk\uf0c1
Lag en arkivpakke.
arkade pack -a ~/N5-arkivuttrekk/ -m ~/output/arkade-ip-metadata.json -p ~/tmp/ -o ~/output/ -f
--archive --metadata-file --processing-area --output-directory-a -m -p -o--information-package-type/-i - Standardverdi ’SIP’. Kan overstyres til ’AIP’.--document-file-format-check/-f - Arkade utfører formatanalyse av dokumentfiler og lagrer resultatet i en csv-fil i tar-pakken.generate - Lag en eksempelfil\uf0c1
Kommandoen under lager både en metadatafil og en testutvalgfil i katalogen som er gitt til parameteren --output-directory/-o. Filene lagres med standardnavn avhengig av hvilket språk som er valgt. I eksempelet er det valgt norsk bokmål, standardnavn blir derfor arkade-ip-metadata.json og noark5-testutvalg.txt.
arkade generate -o ~/output/ -m -s -l nb
Dersom man ønsker å overstyre standardnavnet til metadata- eller testutvalgfilen kan man henholdsvis bruke --metadata-example-filename/-M eller --noark5-test-selection-filename/-S.
arkade generate -o ~/output/ -m -s -l nb -M minMetsfilForNoark5Uttrekk.json -S kunN5_3.txt
--metadata-example/-m eller --noark5-test-selection/-s (minst én av parametrene må oppgis)--output-directory/-o--metadata-example-filename/-M - Oppgi valgfritt navn på metadatafil.--noark5-test-selection-filename/-S - Oppgi valgfritt navn på testutvalgfil.analyse - Utfør analyse\uf0c1
Kommandoen under ufører PRONOM filformatanalyse på alt innhold i katalogen som er gitt til parameteren --format-analysis/-f. Resultatet av analysen lagres i katalogen som oppgis til --output-directory/-o. Standardnavnet på resultatfilen fra formatanalysen kan om ønskelig overstyres med parameteren --format-analysis-filename/-F.
arkade analyse -f ~/directory -o ~/output/ -F myResultFileName
--format-analysis/-f--output-directory/-o--output-filename/-O (stor O) - UTGÅR - bruk heller -F--format-analysis-filename/-F - Oppgi valgfritt navn på resultatfil for formatanalysen.validate - Utfør validering\uf0c1
Kommandoen validerer en katalog eller en fil oppgitt med parameteren --item/-i mot et gyldig arkivformat oppgitt med parameteren --format/-f. Resultatet vises på skjermen.
- Støttede formater
- PDF/A
- DIAS
Validering av en enkelt fil mot PDF/A-formatet:
arkade validate -i ~/N5-arkivuttrekk/dokumenter/detteErKanskjeEnPdfa.pdf -f PDF/A
Validering av alle filer i en katalog og dens underkataloger mot PDF/A-formatet:
arkade validate -i ~/N5-arkivuttrekk/dokumenter/ -f PDF/A -o ~/output/
Validering av en .tar mot DIAS-formatet:
arkade validate -i ~/output/arkade-resultater_{uuid}/{uuid}.tar -f DIAS
Validering av en katalog mot DIAS-formatet:
arkade validate -i ~/N5-arkivuttrekk/ -f DIAS
--item/-i - Oppgi stien til filen som skal valideres.--format/-f - Oppgi arkivformatet som filen skal valideres mot.--output-directory/-o - NB! Kun påkrevd dersom -i er en katalog og -f er PDF/A.Resulterende data\uf0c1
process og pack kommandoene produserer en arkivpakke som en tar-fil, med tilhørende {uuid}.xml på METS-format, samlet i en katalog. process produserer i tillegg testrapport på HTML, PDF/A-1b, XML og JSON-format; rapporten plasseres i en egen katalog ved siden av pakken. Dersom man kjører test lagres rapportene i en katalog på oppgitt lokasjon.
For hver prosessering genereres en unik UUID som bl.a. brukes i fil- og katalognavn for resultatene.