Arkade5 Documentation

Transkript

1 Arkade5 Documentation Release Arkitektum AS December 22, 2016

2

3 Innhold 1 Start her! Introduksjon og nedlasting Innhold Installasjonsveiledning Systemkrav for å kjøre Arkade Avinstallere tidligere versjoner av verktøyet Installer ny versjon av Arkade Kjør programmet Avinstallasjon av programmet (Windows 10) Brukerveiledning Oppstartskjerm Test kjøring Rapport Fil informasjon Systemdokumentasjon Arkivverket.Arkade Arkivverket.Arkade.UI Versjonshistorikk Versjon Versjon i

4 ii

5 Innhold: Innhold 1

6 2 Innhold

7 KAPITTEL 1 Start her! 1.1 Introduksjon og nedlasting Arkade 5 utvikles av Arkitektum for Arkivverket. Verktøyet benyttes til å teste arkivuttrekk både før og etter leveranse til Arkivverket. Programvaren skal ferdigstilles 1. mars Disse sidene vil fungere som dokumentasjonssider og for nedlasting av programmet. Den nyeste versjonen av programmet ligger her arkade msi ( ) 1.2 Innhold Installasjonsveiledning: Dette dokumentet beskriver hvordan verktøyet skal installeres. Brukerveiledning: Brukerveiledningen beskriver hvordan Arkade 5 brukes. Systemdokumentasjon: Her finner du utviklerinformasjon på engelsk. Versjonshistorikk: Denne siden har informasjon forandringer og oppdateringer som er gjort fra versjon til versjon. (Release notes.) 3

8 4 Kapittel 1. Start her!

9 KAPITTEL 2 Installasjonsveiledning 2.1 Systemkrav for å kjøre Arkade 5.NET Framework må være installert for å kunne kjøre Arkade 5. Dette kan lastes ned og installeres her. 2.2 Avinstallere tidligere versjoner av verktøyet Versjon og tidligere versjoner må avinstalleres før Arkade kan oppgraderes. Følg vanlige avinstallasjonsrutiner og ta vekk alle tidligere versjoner av Arkade på PCen. Test versjon 0.4.x er satt opp til å automatisk håndtere gamle installasjoner av Arkade. 2.3 Installer ny versjon av Arkade Last ned den siste versjonen av Arkade 5 fra denne siden. Deretter startes installasjonen verd å klikke eller åpne den nedlastede.msi filen Merk: Windows Smart Screen advarsel Den følgende advarselen vil vises om Windows (Win10) maskinen har Windows Smart Screen satt på. 5

10 Klikk på Mer info Klikk Kjør likevel Følg installasjonsveiviseren og aksepter all de foreslåtte installasjonsvalg. 6 Kapittel 2. Installasjonsveiledning

11 2.4 Kjør programmet Start -> Alle apper Finn Arkade 5 i app listen Klikk på Arkade 5 for å kjøre programmet 2.4. Kjør programmet 7

12 2.5 Avinstallasjon av programmet (Windows 10) Klikk Start -> Instillinger -> System -> Apper og funksjoner Velg Sorter etter installasjonsdato Velg Arkade i listen over installerte programmer Klikk Avinstaller Klikk Avinstaller igjen i nytt vindu Klikk Ja på Brukerkontokontroll advarselen fra Windows 8 Kapittel 2. Installasjonsveiledning

13 KAPITTEL 3 Brukerveiledning Oppdatert Skjermen nedenfor vises ved oppstart av Arkade 5. Versjonen støtter innlesing av arkivdata av format Norak3, Noark4, Noark5 og fagsystem. Verktøyet kjører testere på arkivdataene. 3.1 Oppstartskjerm Arkivet kan enten velges som en.tar fil eller rot mappen i en filstruktur (samme nivå som ADDML.XML filen). Valgene gjøres med henholdsvis Velg tar-fil eller Velg katalog knappen. Videre må det velges hva slags type arkiv det er ved å velge radio knappen for Norak3, Noark4, Noark5 eller Fagsystem. Når disse to valgene er gjort, kan Start testing knappen trykkes for å kjøre testene. 9

14 3.2 Test kjøring Vinduet for test kjøringen viser litt foskjellige data etter som om det er et Noark5 uttrekk eller et utrekk basert på en ADDML fil. Begge versjoner viser: Filsti (stien som ble valgt ved start av kjøringen) UUID for utrekk Løpened informasjon om test kjøringen Det vises også meldinger om innlesing, rapportgenerering og fullført testing i den nedre delen av vinduet. Test kjøring vindu for Norak3, Noark4 og Fagsystemer. 10 Kapittel 3. Brukerveiledning

15 Test kjøring vindu for Norak Rapport En HTML rapport vil automatisk genereres ved fullført testing. Rapporten vil vises i en nettleser ved å klikke på knappen Vis rapport. Et eksempel er vist nedenfor Rapport 11

16 3.4 Fil informasjon Ved innlesing av et arkiv, vil programmet opprette en arbeidsmappe for uttrekket. Disse blir lagt i bruker filsystemet til brukeren som er innlogget på Windows PCen. Filstien for arbeidsmappene er C:\Users\{bruker}\Arkade. 12 Kapittel 3. Brukerveiledning

17 Programlogger finnes i.logs mapppen i dette området og selve arbeidskopien finnes i.work mappen Fil informasjon 13

18 14 Kapittel 3. Brukerveiledning

19 KAPITTEL 4 Systemdokumentasjon List of supported ADDML processes Analyse_CountRecords Analyse_CountChars Analyse_FindExtremeRecords Analyse_CountRecordDefinitionOccurences Analyse_AllFrequenceList Analyse_CrossTable Analyse_CountNULL Analyse_FindExtremeValues Analyse_FindMinMaxValue Analyse_FrequenceList Control_AllFixedLength Control_NumberOfRecords Control_FixedLength Control_NotUsedRecordDef Control_Key Control_ForeignKey Control_MinLength Control_MaxLength Control_DataFormat Control_NotNull Control_Uniqueness Control_Codes Control_Birthno Control_Organisationno Control_Accountno 15

20 Control_Date_Value Control_Boolean_Value List of implemeted Noark5 Tests Antall arkiver i arkivstrukturen Antall arkivdeler i arkivstrukturen Arkiveldene status i arkivstrukturen Antall klassifikasjonssystemer i arkivstrukturen Antall klasser i arkivsstrukturen Antall mapper i arkivstrukturen Kontroller at refererte dokumenter eksisterer i uttrekket Checksum validations Schema Validation of XML 4.1 Arkivverket.Arkade This is the core library with functions for reading and testing archive extractions, generating reports and creating SIP/AIP-packages. List of packages: Core - Common classes ExternalModels - Classes generated from xml schemas Identify - Identification classes for reading and identifying an archive extraction Tests - Contains all test classes for testing archive extractions Util - General utilities 4.2 Arkivverket.Arkade.UI This project provides the graphical user interface of the Arkade 5 software. It is based on WPF, Windows Presentation Foundation. Together with WPF, the application uses the Prism library for creating a loosly coupled, maintainable and testable XAML application. Autofac is used as a dependency framework. Bootstrapping of the applications happens in Bootstrapper.cs. It is based on the bootstrapper provided by Prism and it loads the Autofac-module provided by the Arkade core library. The design and layout is based on Google s Material Design. This has been implemented with the help of the [MaterialDesignThemes-library]( Note that the user interface is only inspired by the material design, not neccessary strictly following it in every situation. 16 Kapittel 4. Systemdokumentasjon

21 KAPITTEL 5 Versjonshistorikk 5.1 Versjon Dato: Dette er den andre versjonen av verktøyet som slippes for testing. Denne versjonen støtter følgende arkivtyper: Noark5 Noark4 Noark3 Fagsystem Arkivinnlesing kan gjøres fra mappestruktur og fra.tar-fil. Programmet kjører 2 forskjellige løp for arkivtrekk som er definert av en ADDML fil i flatfil struktur og Noark5 uttrekk. Noark4 utrekk blir også kjørt under ADDML løpet ved at NOARKIH.xml filen blir transformert til en ADDML gjennom en XSLT. Implementerte Noark5 tester: 1. Antall arkiver i arkivstrukturen 2. Antall arkivdeler i arkivstrukturen 3. Arkiveldene status i arkivstrukturen 4. Antall klassifikasjonssystemer i arkivstrukturen 5. Antall klasser i arkivsstrukturen 6. Antall mapper i arkivstrukturen 7. Kontroller at refererte dokumenter eksisterer i uttrekket 8. Valider sjekksummer 9. Valider xml i henhold til skjema Implementerte ADDML prosesser (Noark3, Noark4, og fagsystem): 1. Analyse_CountRecords 2. Analyse_CountChars 3. Analyse_FindExtremeRecords 17

22 4. Analyse_CountRecordDefinitionOccurences 5. Analyse_AllFrequenceList 6. Analyse_CrossTable 7. Analyse_CountNULL 8. Analyse_FindExtremeValues 9. Analyse_FindMinMaxValue 10. Analyse_FrequenceList 11. Control_AllFixedLength 12. Control_NumberOfRecords 13. Control_FixedLength 14. Control_NotUsedRecordDef 15. Control_Key 16. Control_ForeignKey 17. Control_MinLength 18. Control_MaxLength 19. Control_DataFormat 20. Control_NotNull 21. Control_Uniqueness 22. Control_Codes 23. Control_Birthno 24. Control_Organisationno 25. Control_Accountno 26. Control_Date_Value 27. Control_Boolean_Value Notater: Testrapporten og testloggen viser maks 100 like avvik. Dette er gjort for å redusere faren for minneproblemer ved uttrekk med store antall like avvik. Grensesnittet er oppdatert fra den tidligere versjonen. Arbeidsmappe ligger nå under c:/brukere/{innloggetbruker}/arkade ADDML.xml eller arkivstruktur.xsd fil må ligge på rotnivå i mappestruktur eller tar fil. ADDML.xml fil må definere hvilke prosesser som skal kjøres og hvordan de forholder seg til fil, post eller felt. Ikke alle tester kjøres på alle felt. 5.2 Versjon Dato: Kapittel 5. Versjonshistorikk

23 Dette er første versjonen som slippes til testing. I denne versjonen har vi fokusert på infrastruktur og legge grunnlaget for det videre arbeidet med utvikling av verktøyet. Det er implementert 7 testpunkter for NOARK 5 arkivuttrekk. Brukergrensesnittet er ikke er ferdig utviklet, men danner et utgangspunkt for sluttproduktet. Verktøyet produsere ikke noen annen output enn xml-loggen på nåværende tidspunkt. Denne legges i arbeidskatalogen under c:temp sammen med arkivvutrekket som er testet. Krav som kan testes: K1.2 - Verktøyet er modulbasert - slik at det senere vil være enkelt å koble på funksjoner eller tjenester, tilpasse nye protokoller for kommunikasjon, og dessuten senere kunne skille ut en klient- og en tjenerdel K1.5 - Brukergrensesnitt er malbasert, med tanke på fremtidige nye språkversjoner K1.6 - Verktøyet lar seg enkelt installere på en Windows maskin (Windows 7, 8 og 10) K2.7 - Verktøyet kan pakke ut en TAR fil K2.8 - Verktøyet kan evaluere sjekksummer for tilhørende dokumenter i et uttrekk henhold til definerte algoritmer (SHA eller MD5 basert) K2.9 - Verktøyet kan lese inn en ADDML definisjon K Verktøyet viser til enhver tid hva det gjør, og fremdrift for de forskjellige prosesser K3.2 - Verktøyet tester sjekksummer for alle filer i uttrekket. Det gis feilmelding og programmet avsluttes dersom disse ikke stemmer. K3.7 - Verktøyet kan teste Noark-5 ved hjelp av ADDML definisjonen, med tillegg av krav definert i Vedlegg 5. Se liste over testpunkter som er implementert nedenfor. K5.2 - Alle automatiske operasjoner logges - med tidsstempel K5.3 - Syntaks for loggen er strengt definert - og dokumentert på engelsk - som et XML format i form av en XSD fil K5.4 - Det genereres en detaljert logg i henhold til XSD definisjonen over. Det tekstlige innholdet skal være engelskeller norskspråklig Testpunkter som er implementert for Noark 5 1. Antall arkiver i arkivstrukturen 2. Antall arkivdeler i arkivstrukturen 3. Arkiveldene status i arkivstrukturen 4. Antall klassifikasjonssystemer i arkivstrukturen 5. Antall klasser i arkivsstrukturen 6. Antall klasser uten underklasser eller mapper i det primære klassifikasjonssystemet i arkivstrukturen 7. Antall mapper i arkivstrukturen 5.2. Versjon