Het geautomatiseerd documenteren van een workspace

Het is mijn overtuiging, dat FME een geavanceerde tool is om datastromen te managen en manipuleren, om aan het einde van het proces de gevraagde informatie te krijgen. Vanwege de onuitputtelijke hoeveelheid mogelijkheden van FME is het echter niet altijd even duidelijk op welke wijze deze informatie uiteindelijk tot stand komt. Vanuit dat oogpunt is het natuurlijk logisch om hier meer orde en overzicht te creëren.

Helaas is het beschrijven van wat er in een workspace allemaal gebeurt niet makkelijk en het vergt dan ook flink wat tijd om de transformers en het configureerbare gedrag dat zij vertonen verklarend te documenteren. Een extra uitdaging wordt het dan ook, als er een wijziging in dat complexe proces moet worden doorgevoerd dat ertoe kan leiden dat de documentatie ook gewijzigd dient te worden en de reeds gerealiseerde documentatie worden herzien. Zeer herkenbaar is het effect van de vraag van een Opdrachtgever, waar de documentatie bij de workspaces is? Meestal is dit het moment dat daarover weer opnieuw moet worden nagedacht en dan blijkt het wel heel vaak voor te komen dat het heel lastig is precies de gedachtegang terug te halen die tot de specifieke keuzes die gemaakt zijn hebben geleid, wat juist de informatie is die je graag wilt vastleggen. Het zegt bijna nooit iets over het hoe maar voornamelijk over het waarom.

Mijn uitgangspunt is dan ook, om de documentatie een onderdeel te laten uitmaken van de workspace en transformers, net zoals dat ook gebeurt bij andere programmeertalen. Daarom gebruiken wij bookmarks, bookmarkdescriptions en annotations met verklarende tekst. Door inzet van deze mogelijkheden kunnen wij onze argumenten omtrent bepaalde keuzes vastleggen en op deze wijze is altijd reproduceerbaar waarom wij welke keuzes hebben gemaakt. Door slim om te gaan met nummering in bookmarks en gebruik te maken van geneste bookmarks met subnummering kan er inzicht gegeven worden in de route die de data door de workspace volgt. In combinatie met een goed ingevulde properties box hebben wij daarmee alle input die nodig is, om een begeleidend beschrijvend document te genereren over de workspace.

Er is namelijk output te genereren over de workspace met gebruik van de FMW reader, welke de tekst, nummering en properties uit de bookmarks en workspace haalt. De informatie die wordt gegenereerd in een outputbestand kan dan tevens worden voorzien van de volgorde die is aangebracht in de bookmarks. Op deze wijze genereren wij automatisch documentatie behorend bij workspace, welke wij bijvoorbeeld kunnen opslaan en kunnen delen op een wiki pagina. De documentatie is hiermee beschikbaar voor bijvoorbeeld collega’s en de systeembeheerder. Omdat de documentatie bij elke wijziging in de workspace automatisch kan worden bijgewerkt, is de documentatie altijd actueel en dus van goede kwaliteit. De documentatie is op basis van geautomatiseerd documenteren goed gestructureerd en daarmee ook makkelijk te raadplegen en te interpreteren. Het documentatiesysteem is makkelijk te hergebruiken, makkelijk te onderhouden en goed uitwisselbaar met andere FME-gebruikers.

Deze primitieve workspace laat een klein beetje zien wat de mogelijkheden zijn. Het resultaat staat hieronder:

1. De reader leest alle bookmarks van de geselecteerde workspace
2. Hier worden de volgnummertjes en tekst uit de bookmarks gehaald
3. Sorteer de bookmarks in een lijst op basis van het volgnummer
4. Voeg alle teksten uit de lijst met bookmarks samen in 1 attribuut
5. Schrijf de tekst naar een bestand