Release notes ODS 2.0

Gewijzigd op Di, 12 Mei om 1:02 PM

Nieuw Entity Data Model (EDM) in ODS 2.0

In ODS 2.0 is een nieuw Entity Data Model (EDM) geïntroduceerd. Dit model bepaalt hoe data en metadata in de ODS zijn gestructureerd en via OData beschikbaar worden gesteld. Het nieuwe EDM is ontworpen om eenvoudiger, consistenter en beter bruikbaar te zijn voor tools zoals Power BI en andere OData-clients.

Waarom een nieuw EDM?

In eerdere versies van de ODS was het EDM historisch gegroeid. Daardoor ontstonden complexe en soms onlogische relaties tussen entiteiten, bijvoorbeeld diepe “nesting” in URL’s en metadata die niet altijd overeenkwam met de daadwerkelijke werking van de API. Dit leidde tot:

  • Onnodig complexe OData-URL’s
  • Metadata die niet goed aansluit op de feitelijke data
  • Beperkingen en problemen bij het gebruik van OData-tools zoals Power BI
  • Extra maatwerk in de ODS om dit toch werkend te houden

Het nieuwe EDM in ODS 2.0 lost deze knelpunten structureel op.

Wat is er veranderd?

Met het nieuwe EDM is gekozen voor een duidelijkere scheiding tussen data en metadata, geïnspireerd op moderne OData-implementaties (zoals die van het CBS), maar aangepast aan de manier waarop Swing en de ODS 2.0 worden gebruikt.

De belangrijkste wijzigingen:

  • Eenduidige structuur
    Entiteiten zoals indicatoren, dimensies, geografische niveaus en perioden hebben nu een heldere, logische plaats in het model.
  • Maximaal één niveau van nesting
    OData-endpoints zijn eenvoudiger opgebouwd. Hierdoor zijn URL’s beter leesbaar en makkelijker te gebruiken in analysetools.
  • Consistente metadata
    De metadata die de ODS aanbiedt, sluit nu beter aan op de daadwerkelijke data en endpoints. Dit voorkomt verwarring bij automatische tooling.
  • Data en metadata samen beschikbaar
    Bij het ophalen van data worden de relevante metadata-entiteiten expliciet meegenomen, zodat gebruikers beter kunnen begrijpen wat de data betekent en hoe deze is opgebouwd.
  • Verbeterde ondersteuning voor Power BI en andere OData-clients
    Door de vereenvoudigde structuur en consistente metadata werkt het modelleren en filteren van data in Power BI prettiger en voorspelbaarder.

Wat betekent dit voor jou als gebruiker?

Voor gebruikers van de ODS betekent dit concreet:

  • Je kunt data eenvoudiger ophalen, met minder complexe URL-structuren
  • OData-tools herkennen de structuur en relaties beter
  • Metadata (zoals dimensies, perioden en geo-indelingen) is duidelijker en betrouwbaarder
  • Minder verrassingen of uitzonderingen bij het koppelen van dashboards en rapportages

De functionaliteit blijft gericht op het ophalen en analyseren van ODS-data, maar de technische onderlaag is toekomstbestendiger en gebruiksvriendelijker geworden.

Metadatavelden aangepast

ODS 2.0 bevat een groot aantal expliciete veldnaam‑, datatype‑ en semantische wijzigingen in de indicator‑metadata (o.a. Variables → Indicators, Unary → Single, string‑waarden → echte datatypes). Bestaande koppelingen die expliciet uitgaan van oude veldnamen of waarden moeten mogelijk worden aangepast. De twee belangrijkste voorbeelden van dit soort aanpassingen zijn de velden ‘Unit’ en ‘Source’. Deze geven in de ODS 2.0 de namen van respectievelijk de eenheid en de bron van een indicator weer, en niet meer de eenheid- en broncode. Een volledige lijst van alle aangepaste velden wordt momenteel nog aangemaakt en zal als bijlage van dit document beschikbaar komen.

ODS 2.0 voldoet aan DCAT-AP-NL 3.0

Het uitgangspunt bij het opzetten van de ODS 2.0 is dat het voldoet aan de eisen van de DCAT-AP-NL 3.0. Zie https://docs.geostandaarden.nl/dcat/dcat-ap-nl30/ voor de volledige documentatie hiervan. De benodigde informatie om te voldoen aan de DCAT-AP-NL 3.0 is te vinden in een settings file, die per Swing-versie ingesteld wordt.

Swagger‑UI toegevoegd aan ODS 2.0

Met ODS 2.0 is een Swagger‑UI beschikbaar gesteld. Deze interactieve documentatie geeft gebruikers direct inzicht in de beschikbare OData‑endpoints van de ODS en de bijbehorende structuur.

De Swagger‑UI is te benaderen via:
https://demo.swingsoftware.eu/ods/swagger/index.html

Wat is de toegevoegde waarde?

De Swagger‑UI maakt het eenvoudiger om:

  • Een overzicht te krijgen van alle beschikbare endpoints binnen ODS 2.0
  • Te zien welke data en metadata via welke endpoints beschikbaar zijn
  • De opbouw van requests en responses beter te begrijpen
  • De ODS te verkennen zonder eerst diep in externe documentatie te hoeven duiken

Dit is vooral handig voor gebruikers die de ODS koppelen aan analysetools (zoals Power BI), eigen applicaties bouwen of de API technisch willen verkennen.

Wat betekent dit voor gebruikers?

Er is nu één centrale plek waar je:

  • De structuur van de ODS 2.0 API kunt bekijken
  • Snel kunt controleren welke endpoints beschikbaar zijn
  • Minder afhankelijk bent van losse documentatie of voorbeelden

De Swagger‑UI is daarmee een stap richting betere toegankelijkheid, transparantie en gebruiksgemak van de ODS 2.0.

Invisible data niet oproepbaar

Wanneer indicatoren in Swing Studio gemarkeerd zijn als ‘Invisible’, dan zijn deze indicatoren niet meer oproepbaar via de ODS 2.0.

Waardes onder de drempelwaarde

Vanaf nu krijgen waardes die onder een door de beheerder ingestelde drempelwaarde vallen, een eigen notatie. Voorheen was er bij een data-oproep met de ODS geen enkel onderscheid tussen een ontbrekende waarde en een waarde onder de drempelwaarde. In de ODS 2.0 is daar onderscheid in aangebracht.

Data standaard geaggregeerd

Vanaf nu wordt de data via de ODS 2.0 op alle gebiedsniveaus beschikbaar gesteld waarop de data in de Swing Viewer beschikbaar is. Voorheen was dat instelbaar door de beheerder.

Gebruik ODS 2.0 inzichtelijk in Matomo

Binnen de web analytics omgeving van Matomo wordt het gebruik van de ODS 2.0 door eindgebruikers bijgehouden. De eerste en laatste vier karakters van de Web API-key worden aan Matomo doorgegeven. Zo heb je als Swing beheerder inzicht in het gebruik van de ODS 2.0 en is de belasting van de server per gebruiker na te gaan.