Vejledning i skabelse og test af metadata

Transkript

1 Side 1 af 5 Tilbage til statslige vejledninger Tilbage til vejledninger for kommunale myndigheder Vejledning i skabelse og test af metadata Indhold på denne side: 1. Om metadata 1.1 Opmærkning 2. Skabelse af metadata 2.1 Automatisk generering 2.2 Manuel indtastning i teksteditor 2.3 Metadatagenerering vha. wordmakroer 2.4 Indtastning i XML standardværktøj 3. Test af metadata 3.1 Simpel test 3.2 Udvidet test 3.3 Anvisning på simpel test 3.4 Anvisning på udvidet test 1. Om metadata Metadata betyder data om data. Statens Arkivers metadatamodel er en systemuafhængig beskrivelsesstandard, der bruges til elektronisk dokumentation af arkiveringsversionens tabeller og deres relationer. Metadata gør det muligt for Statens Arkiver at genskabe det elektroniske arkiv. Metadata skal skrives efter bestemte regler og med en bestemt notation (tegnsystem). Den notation man skal anvende er beskrevet og struktureret bekendtgørelsens bilag 3 (Bekendtgørelse nr. 432 af 11. marts 2004 om arkiveringsversioner af bevaringsværdige data fra elektroniske arkivsystemer) ved hjælp af metasproget EBNF (Extended Backus- Naur Form). 1.1 OPMÆRKNING Eksempel på opmærkning for en tabel: <tabel> <titel>sag</titel> <posttype>fast</posttype> <feltdef> <titel>sagsid</titel> <datatype>num</datatype> <bredde>8</bredde> <feltinfo>primærnøgle, ikke betydningsbærende</feltinfo> <feltfunk>sagsidentifikation</feltfunk> </feltdef> <tabelinfo>tabel over sagsbehandlere</tabelinfo>

2 Side 2 af 5 </tabel> 2. Skabelse af metadata Der findes i princippet 4 måder at skabe metadata: Automatisk generering Manuel indtastning i teksteditor Generering af metadataskabeloner vha. wordmakroer Indtastning i XML standardværktøj eller vha. skabeloner 2.1 AUTOMATISK GENERERING Automatisk generering af metadata sker typisk via udtræk af databasen eller via informationer som systemets programmør har lagt ind i programmet. Hvis test af metadata op mod Statens Arkivers XML Schema ikke er indbygget i systemet, bør denne test foretages via XML standardværktøj (se afsnittet "Test af metadata"). 2.2 MANUEL INDTASTNING I TEKSTEDITOR Manuel indtastning via Notepad eller lign. teksteditor kan umiddelbart forekomme besværligt, men der er mange som foretrækker dette frem for mere automatiserede metoder, hvor man "mister fornemmelsen" for det man sidder og laver. 2.3 GENERERING AF METADATA SKABELONER VHA. WORDMAKROER En simpel skabelon (f.eks. i form af en Word Makro) kan lette arbejdet, specielt hvis der er tale om et stort antal tabeller, som skal beskrives. Et Worddokument med de relevante makroer kan downloades fra Statens Arkiver hjemmeside XMLMacro.dot Nedenstående metadataskabelon er genereret vha. de nævnte makroer: <?xml version="1.0" encoding="iso "?> <arkiveringsversion xmlns="sa_metadata" xmlns:xsi=" xsi:schemalocation="sa_metadata sa_md_11.xsd" sa_version="1.1" > <tabel> <posttype></posttype> <feltdef> <datatype></datatype> <bredde></bredde> <feltinfo></feltinfo> </feltdef> <pn></pn> <fn>

3 Side 3 af 5 <fremmedtabel> </fremmedtabel> <kardinalitet></kardinalitet> <kardinalitet></kardinalitet> </fn> <tabelinfo></tabelinfo> </tabel> <saq> <saqinfo> </saqinfo> <saqdata> </saqdata> </saq> </arkiveringsversion> Man kan komme langt med "klippe klistre metoden", men det er vigtigt at man efterfølgende tester metadata vha. et XML Schema (se afsnittet "Test af metadata"). 2.4 INDTASTNING I XML STANDARDVÆRKTØJ Indtastning i XMLstandardværktøj, svarer på mange måder til manuel indtastning i en teksteditor, men XML værktøjet vil typisk give en hjælpende hånd ved at komme med forslag til næste opmærkning eller hele strukturer. Microsoft XMLNotepad (simpel editor) og XMLSpy (avanceret editor) er eksempler på værktøjer som kan anvendes til at skabe metadata. XMLSpy har den fordel at det er muligt at teste om syntaksen overholdes samtidigt med at metadata skabes. Der findes endnu ikke så mange XML standardværktøjer på markedet som understøtter XML Schemaer, men der vil utvivlsomt dukke flere op fremover. 3. Test af metadata Når metadata er skabt, skal det efterfølgende testes. Dette kan gøres manuelt ved linie for linie at gennemse metadata, eller mere eller mindre automatiseret vha. XML værktøjer og XML Schema. 3.1 SIMPEL TEST Man kan foretage en simpel test af metadata i XML, hvor der udelukkende testes om beskrivelsen af metadata i XML er korrekt ("wellformed") - fx at startopmærkning svarer til slutopmærkning. Noget forenklet kan man sige, at man tester om formen er korrekt, men ikke indholdet. 3.2 UDVIDET TEST

4 Side 4 af 5 Man kan også foretage en mere udvidet test af metadata i XML, hvor der også testes om metadata overholder en række regler for struktur og indhold - fx at indholdet af et element (felt) kun må være bogstaverne fra a-z. Disse regler er skrevet i et XML Schema. Man kalder det, at metadata i XML er gyldigt ("valid") i forhold til et givent XML Schema. Noget forenklet kan man sige, at man tester både om formen er korrekt, og om indholdet overholder reglerne. 3.3 ANVISNING PÅ SIMPEL TEST En simpel test kan foretages fx med Microsoft Internet Explorer 6.0: Åben Metadata i Explorer 6.0. Hvis Slutopmærkning er forskellig fra Startopmærkning vil der fremkomme et skærmbillede som fortæller hvad som er forkert og på hvilken linie fejlen skal findes. I nedenstående eksempel er opmærkningen <titel>kod00123</tittel> stavet forkert. Eftersom Slutopmærkning og Startopmærkning er forskellige fremkommer følgende fejlmeddelelse: XML-siden kan ikke vises XML kan ikke vises ved hjælp typografi-arket XSL. Ret fejlen, og klik derefter på knappen opdater, eller prøv igen senere. Slutkoden "tittel" svarer ikke til startkoden "titel". der opstod en fejl under behandling af ressourcen file://h:/metadata.xml. Linie 5, position 21 <titel>kod00123</tittel> ANVISNING PÅ UDVIDET TEST En udvidet test kan foretages med værktøjer som understøtter test af metadata ved hjælp af XML Schemaer. Hent Statens Arkiver XML-Schema. Bemærk at schemaet ikke sikrer: at overensstemmelse mellem relationer er overholdt. at overholdelse af schemaet bl.a. af ovennævnte grund ikke vil være ensbetydende med, at Statens Arkiver kan godkende at metadata overholder kravene. Af værktøjer som understøtter test af metadata vha. XML Schemaer bør nævnes XMLSpy version 4.4 (eller nyere version) som kan downloades fra i form af en 30 dages fuldt funktionsdygtig "Trial Version". For værktøjer af denne type gælder, at som oftest kan test af struktur og indhold foregå med et enkelt tastetryk eller museklik, og XML værktøjet forsøger at komme med fornuftige forslag til hvor evt. fejl befinder sig.

5 Side 5 af 5 Se også andre værktøjer på bl.a. og Her kan man eksempelvis finde henvisninger til MSXML 4.0 (MS XML Core Services), som understøtter test af metadata vha. XML Schemaer MSXML 4.0 For at kunne installere MSXML kræves MS Windows Installer 2.0 og som minimum MS Windows 98. Det anbefales endvidere at anvende Microsoft Internet Explorer 6.0 frem for udgave 5.5. I den medfølgende hjælpefil til ovenstående SDK er der angivet eksempler på, hvorledes man i forskellige programmeringssprog kan validere XML dokumenter mod et XML Schema. Bl.a. er der eksempler i JavaScript så man udelukkende ved hjælp af XML dokument, XML Schema, JavaScript fil og MSXML 4.0 og MS Internet Explorer kan teste XML-dokumentet, og få at vide, hvor der evt. er fejl. Note: SDK står for Software Development Kit Statens Arkiver