Gebruikershandleiding
In dit document een handleiding hoe de toolkit onder normale omstandigheden gebruikt kan worden om: - de nieuw aangeleverde delen van de NT te valideren, - op te nemen in de taxonomieviewer, - en een wijzigingsoverzicht te draaien op basis van voorgaande versie(s).
De screenshots zijn gemaakt begin januari 2023, omdat de toolkit nog in ontwikkeling is kunnen afbeeldingen afwijken van het hier getoonde
Admin
Het onderhoudsdeel van de toolkit is afgeschermd met een login en is bereikbaar via de url: admin login
Na te zijn ingelogd kom je in het hoofd-onderhoudsscherm. Daarin zijn vier tabbladen, taxonomie toolkit, versies vergelijken, parse from url en taxonomy package de laatste drie zijn handig als je buiten de 'Happy Flow' wilt werken.
Happy flow (NT17)
Nu volgt de beschrijving van 'normaal' gebruik van de toolkit, het geregeld valideren van nieuw aangeleverde delen van de taxonomie, het vullen van Nessie en wijzigingen rapporteren. Na het inloggen opent de admin met "Taxonomy toolkit" als actieve tab, en is "Upload zipfile" in het midden de actieve tab.
1. SBR
Eind januari ontvangen we een eerste zipbestand van de taxonomiebouwer, het SBR gedeelte. We controleren het zipbestand of daar de directorie www.nltaxonomie.nl in voorkomt. Als dat niet het geval is zal de taxonomie als zipbestand in het geopende bestand te zien zijn (een zipfile in een zipfile). Uitpakken en het tweede zipbestand aan dezelfde controle onderwerpen. Als het juiste zipbestand is geselecteerd kan die worden geüploadet door het zipbestand in het vakje upload zipfile te slepen, of door op het plusje te klikken en het bestand via de verkenner te selecteren.
Zodra het bestand op de server staat verandert het scherm en tonen we onder het uploadvak de inhoud van het zipbestand. De rode knop unpack and add to local store zorgt er voor dat het zipbestand daadwerkelijk wordt uitgepakt en wordt toegevoegd aan de eerder geuploadete bestanden.
Dit deel van de NT kent geen entrypoint. De definities worden later door andere delen van de NT gebruikt. Dit doen we voor de alfa, beta en definitieve versie als ze worden aangeleverd.
2. KVK
Dan ontvangen we de alfa release voor de KVK. Ook hier vinden we het zipbestand met de taxonomie er in en slepen het naar de server. Het lezen en uitpakken zal nu iets meer tijd kosten. Scroll nog even door het lijstje om er zeker van te zijn dat er een www.nltaxonomie.nl directory aanwezig is bij de bestanden en klik op Unpack and add to local store. (Ook dit zal enige tijd in beslag nemen).
beeld na het uitpakken van de KVK 17 alfa.
Wanneer het zipbestand is uitgepakt wordt er gesprongen naar het files-tabblad. Je zal zien dat het veld NT Version boven het files tabblad is ingevuld met NT17, en daar achter 'alfa' is aangevinkt. Deze informatie wordt uit het zipbestand gehaald (directorystructuur en naamgeving). Alle gevonden entrypoints zijn geselecteerd en in het rechterscherm verschijnt de configuratie zoals die naar de server gestuurd zou worden.
De toolkit kan de volgende taken uitvoeren:
- parsen, het lezen van de XML bestanden en converteren tot een python-object.
- valideren, controleer of de ingelezen bestanden voldoen aan de architectuurregels die gelden voor de NT. De uitkomst wordt weggeschreven in een rapport.
- Opslaan in DB, de database is de bron voor de taxonomieviewer en wordt gebruikt bij het maken van mutatierapporten.
- Vergelijken met oudere versies, schrijf een mutatierapport ten opzichte van de voorgaande definitieve versie van de NT en alle eventueel tussenliggende alfa en beta versies.
Tijdens de Happy Flow selecteer je alles. En vul bij de run ID het domein KVK in. Dit gebruiken we later bij het maken van een versierapport voor de verschillende domeinen.
Je kan je e-mailadres invullen, dan stuurt de server zodra die klaar is een e-mail met een samenvatting van wat er is gedaan op de server. De kans dat deze email in de spmafolder verdwijnt is, gezien de inhoud van de email, 99,9%. De eerste keer zal je de mail dus uit die folder moeten vissen en de afzender toevoegen aan vertrouwde afzenders. (kc-xbrl.tooling@cooljapan.nl)
Je klikt op de rode knop Parse, valideer, opslaan en vergelijk en haalt je favoriete warme drank uit de automaat. Het configuratiescherm aan de rechterkant is op serverlogs gesprongen en de mededeling XBRL Toolkit started
staat op het scherm. Hier verschijnen zo af en toe mededelingen uit de parser of puntjes achter elkaar uit de database opslag. Na het laatste entrypoint wordt pas gestart met het vergelijken van de versies. Deze vergelijking geeft geen output en duurt van enige minuten tot uren. In het geval van de KVK zal er na enkele uren onderaan 'all done' verschijnen en is de batchverwerking klaar. Als er een geldig e-mailadres is opgegeven dan ontvang je ook een klaarmelding in de e-mail.
3. Belastingdienst
Vanaf hier is het een herhaling van zetten. Je uploadt het zipbestand met taxonomieën, je unpacked and add to local store, je kiest parse, valideer, opslaan en vergelijk. Je vult nu BD in bij RunID en je laat de toolkit zijn werk weer doen.
4. En verder (BZK, OCW, meer BD)
Vervolgens komen er om de zoveel tijd delen van de NT als zipbestand bij Logius binnen. Je herhaalt voor al die bestanden het riedeltje, uploaden, uitpakken, en verwerken.
Versies vergelijken
Het tweede tabblad geeft de mogelijkheid om de verschillen tussen de NT versies te bestuderen. Tijdens de Happy Flow worden deze vanzelf weggeschreven. Hier heb je de mogelijkheid om het vergelijken van versies zelf op te starten en een vergelijk tussen 'willekeurige' versies mogelijk te maken. De linkerkant van het scherm laat zien voor welke vergelijkingen er al rapporten zijn geschreven.
Het hoofdniveau is tevens het rapport voor de hele NT. Dus in het rijtje "New in NT17 since NT16" op de naam klikken zal de vergelijking voor de hele NT in een nieuw scherm openen. Je kan de lijst uitbreiden door naast de naam of op het driehoekje te klikken. Je krijgt dan een overzicht van de deelvergelijkingen die er zijn gemaakt. Hierin is voor elk vergelijkbaar entrypoint een rapport opgenomen en voor elk "leveringsdomein". De laatste kunnen worden gebruikt ter verificatie van de door de leverancier geleverde wijzigingsspecificatie. De uitkomst van onze vergelijking is indicatief, want gebaseerd op de toolkit interpretatie van de NT.
Zelf opstarten.
Je kan handmatig een vergelijking opstarten tussen alle in de database beschikbare NT versies. Deze functionaliteit zal je in de praktijk niet vaak nodig hebben, het toolkitscherm handelt dat in de happy flow voor je af. De uitkomsten van deze rapporten zijn sterk afhankelijk van de inlees-discipline. Alleen als de zipbestanden op volgorde, voorzien van een RunID worden ingelezen is de uitkomst betrouwbaar.
Parse from URL
Soms vind je op internet een XBRL Taxonomie en ben je nieuwsgierig. Met de optie Parse from URL is het op dit moment mogelijk om een URL van een entrypoint op te geven en door de toolkit te laten parsen (en valideren).
Taxonomy package
Taxonomy packages zijn, in theorie, de bom! Alle bestanden in een zipbestand, met de mogelijkheid om extra (meta) informatie aan bestanden te hangen en iets meer context.
In praktijk valt dit een beetje tegen, bouwers vergeten bestanden op te nemen of leveren geen mappings aan om externe bestanden te kunnen vinden. Daarom bieden we nu aleen 'test' faciliteiten aan voor taxonomy-packages. Je kan ze uploaden en ze laten parsen en valideren. Gezien het slagingspercentage is opslaan in de db, en dus zichtbaar in Nessie een brug te ver.