Brukerveiledning¶
Arkade 5¶
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¶
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 opppgitt (se innstillinger). Arkade avsluttes ved å lukke hovedvinduet. Ved avslutning igangsettes sletting av midlertidige filer.
Innlastingsvinduet¶
Innlasting¶
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, arkivuttrekk.xml eller NOARKIH.xml). Klikk på knappen «Velg SIP/AIP-fil» dersom uttrekket er en AIP- eller SIP-struktur pakket som en tar-fil.
- Oppgi arkivtype for det valgte uttrekket. Arkade 5 støtter typene «Fagsystem», «Noark 3» og «Noark 5».
- Klikk på knappen «Last inn uttrekk». Det valgte uttrekket vil lastes inn og åpnes i testvinduet.
Testvinduet¶
Ø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*
*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¶
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¶
Etter fullført testing vil en rapport i HTML-format bli generert. Klikk på knappen «Vis rapport» for å åpne den i en nettleser (den vil tilpasse seg gjeldende skjermflate). Ved opprettelse av arkivpakke inkluderes alltid testrapporten. Dersom den (i tillegg) skal tas vare på et annet sted, lagres den ved hjelp av nettleseren. Med rapporten åpen kan dette, i de fleste nettlesere, gjøres ved å taste Ctrl+s.
Arkivpakkegenerering¶
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¶
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¶
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 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» velges vil Arkade lage en csv-fil med forespurt informasjon og lagre denne på følgende lokasjon i tar-filen: {uuid}\administrative_metadata
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 Arkadepakke-{uuid}. Når alt er ferdig generert, vises denne katalogen på den valgte plasseringen.
TIPS: Så lenge arkivpakkevinduet ikke forlates, kan metadata endres og «Opprett pakke» klikkes på nytt. Velges samme pakkeplassering, overskrives foregående pakke og {uuid}.xml med oppdaterte metadata. Sørg bare for at filene som skal overskrives ikke er opptatt, f.eks. ved at de er åpnet i andre programmer.
NB! Knappen «Ny kjøring» avslutter gjeldene arkivbehandling.
Innstillinger¶
Prosesseringsområde¶
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.
Arkade 5 CLI¶
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¶
Arkade CLI kjøres med skriptet arkade.sh som medfølger installasjonspakken.
For å kjøre skriptet slik som vist i eksemplene (./arkade.sh), naviger til installasjonskatalogen:
cd Arkade5CLI-<versjon>
(Ved å tilgjengeliggjøre skriptet i PATH kan det kjøres med arkade fra hvor som helst i filsystemet)
Kommandoer¶
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.sh help
Parametre¶
Bruk --help, etter en kommando for å vise eksempler på bruksmåte og en oversikt over dens parametre:
./arkade.sh generate --help
Alle parametre foruten --help og --version kan oppgis i kortform og må etterfølges av aktuell verdi f.eks. --type Noark5 eller -t Noark5
Parametrenes rekkefølge er likegyldig.
NB! Alle kataloger som oppgis som må eksistere på forhånd.
Prosesseringsområde (CLI)¶
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 parameteret --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¶
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¶
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, arkivuttrekk.xml eller NOARKIH.xml) eller til tar-filen.
Under vises et eksempel på hvordan kommandoen process brukes. Det leses inn et arkivuttrekk fra katalogen ~/N5-arkivuttrekk/. Arkivuttrekkets type er oppgitt til noark5. Metadata for uttrekket leses fra filen ~/metadata.json. Katalog for plassering av prosesseringsområdet er satt til ~/tmp/ og katalog for resulterende data er satt til ~/output/.
./arkade.sh process -a ~/N5-arkivuttrekk/ -t noark5 -m ~/metadata.json -p ~/tmp/ -o ~/output/
Obligatoriske parametre ved arkivprosessering:
--archive--type--metadata-file--processing-area--output-directory
--information-package-type/-i - Standardverdi ’SIP’. Kan overstyres til ’AIP’.--noark5-test-list/-n - Oppgi sti til en fil som inneholder en liste med tester skal kjøres.--document-file-format-check/-f - Arkade utfører formatsjekk av dokumentfiler og lagrer resultatet i en csv-fil i tar-pakken.test - Testing av arkivuttrekk¶
Test om arkivuttrekk er i henhold til en spesifisert standard. Påkrevde parametre er --archive, --type, --processing-area og --output-directory. Dersom det kun skal kjøres et utvalg av tester må en tekstfil som inneholder en liste over disse oppgis med parameteret --noark5-test-list. Arkade CLI kan lage en fil med et eksempel på en liste over tester.
./arkade.sh test -a ~/N5-arkivuttrekk/ -t noark5 -p ~/tmp/ -o ~/output/ -l ~/n5-testlist.txt
pack - Pakking av arkivuttrekk¶
Lag en arkivpakke. På krevde parametre er --archive, --type, --metadata-file --processing-area og --output-directory. Standard pakketype er SIP, dette kan endres ved å oppgi ’AIP’ til parameteret --information-package-type. Det kan også utføres en formatsjekk av filene ved å oppgi parameteret --document-file-format-check.
./arkade.sh pack -a ~/N5-arkivuttrekk/ -t noark5 -m ~/tmp/metadata.json -p ~/tmp/ -o ~/output/ -f
generate - Lag en eksempelfil¶
Kommandoen under lager både en metadata-fil og en testliste-fil i katalogen som er gitt til parameteret --output-directory. Filene lagres med standardnavn arkade-ip-metadata.json og noark5-testlist.txt.
./arkade.sh generate -o ~/output/ -m -n
--metadata-example/-m eller --noark5-test-list/-n--output-directoryResulterende data¶
process og pack kommandoene produserer en arkivpakke som en tar-fil, med tilhørende {uuid}.xml på METS-format, samlet i en katalog. Ved siden av katalogen plasseres en testrapport på HTML-format.
For hver prosessering genereres en unik UUID som bl.a. brukes i fil- og katalognavn for resultatene.