5.1 XML syntax en structuur

Begrijpt de syntax en structuur van XML-documenten.

Het probleem: hoe wissel je gegevens uit?

Stel je voor: twee gemeentelijke systemen moeten gegevens over een inwoner uitwisselen. Het ene systeem (A) slaat gegevens op in een database, het andere (B) in een heel ander formaat. Hoe zorg je ervoor dat beide systemen elkaars gegevens begrijpen?

Je zou de gegevens in platte tekst kunnen sturen, bijvoorbeeld:

Jan de Vries, Kerkstraat 12, 3511AB, Utrecht

Maar dit levert direct problemen op:

• Wat als iemand twee achternamen heeft? Waar begint het adres dan?
• Hoe weet het ontvangende systeem welk veld wat is?
• Wat als er een komma in een adres staat?

In het verleden werd dit probleem vaak opgelost door specifiek voor deze situatie software te schrijven. Als systeem A vervolgens dezelfde gegevens ook moest uitwisselen met nog een ander systeem (C) werd weer nieuwe code geschreven. Je kunt je voorstellen dat er na verloop van tijd een kluwen van verbindingen was gelegd om gegevens uit te wisselen.

In de praktijk wordt dit vaak het “spaghetti-probleem” genoemd: wanneer N systemen met M andere systemen gegevens moeten uitwisselen, zijn er tot N×M koppelvlakken nodig — elk met een eigen formaat. Dit leidt tot onbeheersbare “copy-paste”-integraties. De oplossing: één gemeenschappelijke taal voor gegevensuitwisseling.

Er is dus een manier nodig om gegevens gestructureerd vast te leggen, zodat computers, maar ook mensen, ondubbelzinnig kunnen begrijpen wat elk gegeven betekent.

Markup: tekst met betekenis

De oplossing heet markup (letterlijk: “opmaak” of “annotatie”). Je plaatst labels (ook wel “tags” genoemd) om stukjes tekst heen, zodat duidelijk is wat elk stukje betekent.

Een tag herken je aan de punthaken < en >. Tags komen in paren: een begintag en een eindtag (begint met </).

<voornaam>Jan</voornaam>

• <voornaam> — de begintag
• Jan — de inhoud (het feitelijke gegeven)
• </voornaam> — de eindtag

Het geheel noemen we een element.

Wat is XML precies?

XML staat voor eXtensible Markup Language – een uitbreidbare opmaaktaal:

XML is dus een set afspraken over hoe je gegevens in tekstformaat vastlegt, zodat:

1. Een mens kan lezen en begrijpen wat er staat
2. Een computer de gegevens automatisch kan verwerken
3. Verschillende systemen de gegevens kunnen uitwisselen

XML is een universeel geaccepteerde standaard voor informatie-uitwisseling (referentie: W3C XML-specificatie).

Belangrijk: XML is geen programmeertaal en geen systeem. XML is puur een formaat — een manier om gegevens op te schrijven. Je hebt altijd software (een applicatie, een koppelvlak) nodig die XML leest of schrijft.

De oorsprong van XML

XML is niet uit het niets ontstaan, maar is de jongste telg in een familie van markup-talen:

GML (1969) ──→ SGML (1978) ──→ HTML (1992) ──→ WWW
                            └──→ XML  (1997) ──→ Gegevensuitwisseling

HTML en XML zijn dus beide afstammelingen van SGML, maar met een heel ander doel: HTML beschrijft hoe informatie er uitziet, XML beschrijft wat informatie betekent. XHTML is dan weer de HTML vorm die voldoet aan de XML syntax.

De XML-declaratie

Elk XML-document begint (optioneel, maar sterk aanbevolen) met een XML-declaratie:

<?xml version="1.0" encoding="UTF-8"?>

De declaratie staat altijd op de allereerste regel en vóór het root-element. Dat is het enige element in een XML-bestand dat alle andere elementen (kind-elementen) bevat.

Elementen: de bouwstenen van XML

Elementen met tekst als inhoud — de eenvoudigste vorm:

<voornaam>Jan</voornaam>
<huisnummer>12</huisnummer>
<geboortedatum>1985-03-15</geboortedatum>

Voor XML is alles tekst. Het getal 12 en de datum 1985-03-15 zijn gewoon tekenreeksen. Pas met XSD (zie 5.3) kun je afdwingen dat een waarde een getal of datum moet zijn.

Regels voor elementen

• Elementen hebben altijd, met uitzondering van lege elementen (waarover zo meer), een begin- en een eindtag;
• Elementnamen beginnen met een letter, underscore (_) of een dubbele punt (:) en worden gevolgd door naam karakters;
• naam karakters bestaan uit letters, underscores, dubbele punten, cijfers, hyphens (-) of een punt (.). In de praktijk wordt de dubbele punt echter niet gebruikt uitgezonderd als scheidingsteken tussen namespace-prefix (waarover meer in het volgende onderdeel) en elementnamen;
• Letters zijn niet gelimiteerd tot ASCII. De verschillende nationaliteiten mogen dus hun eigen karakters gebruiken in elementnamen;
• Elementennamen mogen niet starten met ‘XML’, ‘xml’ of een variatie daarop.

Let op! XML is case sensitive, de elementen ‘Artikel’ en ‘ARTIKEL’ zijn dus niet dezelfde elementen.

Elementen met kind-elementen — nesting:

<adres>
  <straat>Kerkstraat</straat>
  <huisnummer>12</huisnummer>
  <postcode>3511AB</postcode>
  <woonplaats>Utrecht</woonplaats>
</adres>

De elementen <straat>, <huisnummer> etc. zijn kind-elementen (child elements) van <adres>. Het element <adres> is het ouder-element (parent element). Zo ontstaat een boomstructuur.

Lege elementen — een element zonder inhoud:

<overlijdensdatum></overlijdensdatum>
<!-- of verkort: -->
<overlijdensdatum/>

Root-element — elk XML-document heeft precies één buitenste element dat alle andere elementen omvat:

<inwoner>
  <voornaam>Jan</voornaam>
  <achternaam>de Vries</achternaam>
  <adres>
    <straat>Kerkstraat</straat>
    <huisnummer>12</huisnummer>
    <postcode>3511AB</postcode>
    <woonplaats>Utrecht</woonplaats>
  </adres>
</inwoner>

Attributen: extra informatie bij een element

Een attribuut staat in de begintag en heeft de vorm naam="waarde":

<inwoner burgerservicenummer="123456789">
  <voornaam>Jan</voornaam>
  <achternaam>de Vries</achternaam>
</inwoner>

Regels voor attributen:

• De waarde staat altijd tussen aanhalingstekens (enkele of dubbele);
• Een element mag meerdere attributen hebben, gescheiden door spaties;
• Elk attribuut mag maar één keer voorkomen op hetzelfde element;
• Attributen hebben geen vaste volgorde.

Wanneer een attribuut, wanneer een kind-element?

Let op: Of een gegeven als een element of juist als een attribuut moet worden gedefinieerd is sterk afhankelijk van het informatiedomein. In een domein dat gaat over temperaturen wordt de waarde ‘Celsius’ waarschijnlijk in een element opgeslagen, in een domein dat gaat over het weer is het waarschijnlijk een attribuut.

Let op: In StUF-berichten worden attributen veelvuldig gebruikt, onder meer voor het aangeven van het mutatiesoort en de aanduiding van sleutelwaarden.

Als de regels uit de voorgaande paragraaf (‘Elementen: de bouwstenen van XML’) en deze paragraaf correct worden toegepast ontstaat er een welgevormd (well-formed) XML-bestand (ook vaak een XML-instantie genoemd). In een van de volgende onderdelen zullen we zien dat een XML-bestand daarnaast ook nog valide kan zijn.

Voorbeeld uit de praktijk: een CV in XML

Dit voorbeeld laat zien hoe een eenvoudig document in XML wordt vastgelegd:

<?xml version="1.0" encoding="UTF-8"?>
<CV salarisnummer="12345" auteur="J. de Vries" documentdatum="2022-07-15">
  <persoonlijke_gegevens>
    <naam>Jan de Vries</naam>
    <adres>
      <straat>Kerkstraat</straat>
      <huisnummer>12</huisnummer>
      <postcode>3511AB</postcode>
      <woonplaats>Utrecht</woonplaats>
    </adres>
  </persoonlijke_gegevens>
</CV>

Herken je de onderdelen?

1. XML-declaratie — <?xml version="1.0" encoding="UTF-8"?>
2. Elementen — <CV>, <persoonlijke_gegevens>, <naam>, <adres>, etc. — elk met begin- en eindtag
3. Attributen — salarisnummer, auteur, documentdatum — metagegevens over het CV zelf

Voorbeeld uit de praktijk: een weerrapport in XML

<?xml version="1.0" encoding="UTF-8"?>
<Weerrapport datum="2023-03-11">
  <Station naam="Ameland">
    <Weersgegevens weertype="zwaar-bewolkt">
      <Temperatuur eenheid="Celsius">18,1</Temperatuur>
      <Wind richting="Z.O.">
        <Snelheid eenheid="m/sec">4</Snelheid>
      </Wind>
      <Zicht eenheid="m">900</Zicht>
      <Druk eenheid="hPa">1167</Druk>
    </Weersgegevens>
  </Station>
</Weerrapport>

Merk op hoe de attributen hier meerdere rollen vervullen:

• Identificatie: naam="Ameland" vertelt welk station het betreft
• Classificatie: weertype="zwaar-bewolkt" geeft het type weer aan
• Eenheden: eenheid="Celsius", eenheid="m/sec" — metagegevens over hoe de waarde gelezen moet worden

Oefening 5.1.1

Download en installeer eerst ‘Altova XMLSpy 2024 Enterprise XML Editor - Release 2’. Gebruik de ‘free, fully- functional, 30-day trial’ of vraag de beheerder van de KCA specifieke software (Robert Melskens) om de Licentie gegevens.

Naar de oefening.

Oefening 5.1.2

Naar de oefening.

Vergelijking met HTML

Waarom XML?

XML is de universeel geaccepteerde standaard voor informatie-uitwisseling. De belangrijkste redenen:

1. Leesbaar voor mens én machine — gewone tekst, overal te openen;
2. Platform-, leverancier- en taalonafhankelijk — werkt met Java, C#, Python, en elk besturingssysteem;
3. Zelfbeschrijvend — tagnamen vertellen wat de inhoud is;
4. Uitbreidbaar — nieuwe elementen toevoegen zonder bestaande structuren te breken;
5. Valideerbaar — met schema’s (XSD) formeel controleerbaar;
6. Niet meer weg te denken — het zit inmiddels in vrijwel elke softwarelaag (configuratie, berichten, documenten).

De XML-familie: terminologie

XML staat niet op zichzelf, maar maakt deel uit van een familie van technologieën:

XML-tools

Om met XML te werken gebruik je doorgaans drie soorten tools:

In de gemeente komt je XML tegen in koppelvlakbeschrijvingen (StUF/WSDL), in configuratiebestanden, en in berichtuitwisseling tussen systemen.