Validering av XML, Svensk geoprocess Guide för validering av XML, Svensk Geoprocess

Transkript

1 Validering av XML, Svensk geoprocess Guide för validering av XML, Svensk Geoprocess

2 Validering av XML, Svensk geoprocess Bakgrund Ett behov finns av att kunna kontrollera och validera XML-filer som skapas enligt de regler (scheman) som finns för teman inom Svensk geoprocess. Stödet kan exempelvis användas vid utveckling eller kontroll av leverans.. Som stöd för denna kontroll och validering av XML vid datautbyte enligt Svensk geoprocess har denna beskrivning tagits fram. Dokumentet är bara ett se som ett stöd. Du kan läsa mer om XML här: Denna information riktar sig primärt till kommuner, systemleverantörer och andra intressenter, till personer med viss erfarenhet av XML-kod. Validera XML Validering av XML kan ske i två steg. Det första steget är att kontrollera att XML är välformad. Vilket betyder att den XML man skapar eller får levererad följer de regler som finns för XML. Dessa är regler som är definierade för själva formatet. Mer om detta kan du läsa här: Det andra steget är att validera XML mot ett eventuellt schema. Ett schema används för att tydliggöra en definition av en XML-struktur. Till exempel vilka namn element i XML får ha, i vilken ordning element får vara osv. Inom Svensk geoprocess har varje respektive geodatatema ett eller flera egna scheman som regelverk för hur XML-filer skall se ut. Dessa scheman är framtagna utifrån de modeller (UML) som tagits fram för respektive tema, om dessa kan du läsa mer om här: För att validera XML, enligt båda stegen ovan, finns det olika typer av stöd att ta till handa. Alla mer renodlade utvecklingsprogramvaror har ett stöd för validering av XML, t.ex. XMLSpy, oxygen, Eclipse osv. Det finns också enklare programvaror som Notepad ++, XML Copy Editor. Gemensamt för dessa är att man måste ha dessa installerade på sin dator. För extern kontroll finns det webbsidor som erbjuder möjlighet att kontrollera sin XML-kod. Många sidor kan dock bara utföra det första steget av XML-validering, att kontrollera om XML är välformad. För att kontrollera mot ett schema finns dock färre alternativ. 1

3 Validera XML med Notepad ++ Följ denna länk: Text editorn Notepad ++ bygger på öppen källkod och är förenklat en förädling av Notepad som finns med i Windows-paketet. Det är en gratis mjukvara och som nu finns tillgänglig via Github. Notepad++ har en mängd funktioner för att underlätta att exempelvis. skriva kod i en mängd olika program- och märkspråk, bland annat XML, och dessa har stöd för att validera XML gentemot scheman. Svensk geoprocess rekommenderar att använda Notepad++ då det är gratis och utför validering korrekt. Steg 1, Ladda hem Notepad++ och installera Följ länken ovan, och navigera in på hemsidans nedladdningsarea, Download. Välj sedan vilken version du vill ha (x86 eller x64), om du är osäker fungerar det alltid att ta 32-bit X86. Tryck på länken Notepad++ Installer 32-bit x86. När nedladdning är klar, starta den installerare du laddat hem och följ instruktioner (välj Svenska som språk). Om du inte får installera programvaror själv på din dator, kontakta IT-administratör och be om att få detta program installerat. Steg 2, starta Notepad++, installera tillägg Nu har du Notepad++ på din dator. För att kunna utföra mer avancerade rutiner på XML så krävs ett tillägg ilket vi nedan beskriver. Starta Notepad++ I menyn, gå till Tillägg och välj Plugin manager -> Show plugin manager 2

4 Figur 1 Lägg till tillägg I rutan som kommer upp ska du i fliken Available söka efter XML Tools. Bocka för den lilla check-rutan och lite längre ner i samma fönster trycker du på Install. När det är klart ska du se ett nytt val under Tillägg som heter XML Tools, likt bilden ovan. Steg 3, öppna och validera XML Nu ska du öppna den XML-fil som du vill validera. Figur 2 Öppna XML-fil i Notepad++ När XML-filen öppnats är det dags att validera den. Om all text är grå kan du i Notepad++ ställa in vilket språk filen har, görs i menyn välj Språk och längst ner XML. Element ska ha blå text i defaultläge. Detta ordnas automatiskt om XML har en header längst upp som är rätt. I menyn, välj Tillägg och XML-tools -> Validate now 3

5 Figur 3 Validera XML via XML Tools Nu får du svar: a. Om din XML saknar länk till schema kommer denna information upp; Kontakta då leverantören av XML och påpeka att länken måste läggas till. Du kan själv lägga till den men den ska alltid finnas med i leveranser. Figur 4 Länk till XML-schema saknas b. Om din XML är rätt kommer följande information upp: 4

6 Figur 5 Din XML är korrekt c. Om din XML har fel kommer följande information upp: För frågor och stöd kring användning av Notepad++ för att validera XML kontakta supporten på: svenskgeoprocess@lm.se 5