WordGro

Modelgebaseerde systems engineering (MBSE) is een methodologie die wordt ingezet om complexe systemen te beschrijven met daarbij domeinmodellen in plaats van document-gebaseerde als het primaire middel voor informatie-uitwisseling. Deze aanpak creëert een hogere productiviteit door het minimaliseren van onnodige handmatige transacties van de informatie. De centrale digitaal modellen zijn voor iedereen toegankelijk en ze maken het mogelijk om informatie makkelijk terug te vinden en bij te houden.

Toch zijn mensen vaak gehecht aan de documentatie op papier en is het beoordelen van modellen vaak lastiger dan documenten. Daarnaast stellen ze vaak ook eisen aan de vorm waarin de ontwerpen moeten worden opgeleverd. Dit sluit meestal niet aan op de MBSE tooling die door de engineers worden gebruikt. Hierdoor ontstaat er alsnog veel handmatig werk of er wordt een script ontwikkeld die dit geautomatiseerd doet, maar hierdoor gaat uiteindelijk in beide gevallen de tracering van de informatie verloren.

Hoe draagt MBSE bij aan een hogere productiviteit en het aantoonbaar voldoen aan de eisen?
Het gebruik van modellen maakt het sowieso makkelijker om informatie terug te vinden en bij te werken. Soltegro gebruikt voornamelijk “Enterprise-Architect (EA)” daarvoor, een ontwerptool dat veel wordt toegepast om MBSE toe te kunnen passen. Om modellen om te zetten naar de gewenste documenten hebben wij een EA-plugin ontwikkeld; WordGro.

De set van documenten is dus een vorm (en eigenlijk een moment opname) om de systeembeschrijvingen op te leveren, zodat deze beoordeeld kunnen worden. De modellen bevatten de actuele informatie en kunnen op elk moment worden omgezet naar documenten. Er is bewust gekozen om een plugin te ontwikkeling voor EA ipv gebruik te maken van de “scripting” mogelijkheid die EA biedt. De kwaliteit van de scripts is lastig te controleren, daarnaast is de onderhoudbaarheid en uitwisseling tussen projecten moeilijker en beperkt het de mogelijkheid om frameworks te gebruiken.

Het basisprincipe van de WordGro plugin is dat het gebruik maakt van de EA-database structuur om verschillende document templates te creëren. Deze templates bepalen dus welke modelelementen/informatie op welke plek in het document moeten komen. De templates kunnen vervolgens weer worden gebuikt om de specifieke documenten per subsysteem te definiëren.

De WordGro plugin biedt tevens de mogelijkheid om informatie te importeren en om te zetten naar model elementen, die vervolgens kunnen worden gebruikt bij de documentgeneratie. Denk hierbij aan eisen, beslissingen, objecten, functies, etc. Importeren van informatie kan vanuit Word/ Excel of via Webservers (via SOAP/REST). De laatste optie maakt het mogelijk om geautomatiseerd informatie uit te wisselen met externe systemen als Relatics en Sharepoint.

Voordat de documenten worden gegenereerd bestaat de mogelijkheid om een aantal validatiescripts uit te voeren. Die controleren of het ontwerp syntactisch correct is en alle benodigde informatie aanwezig is. Tijdens het genereren is het mogelijk om Word-macro’s uit te voeren om bijvoorbeeld een eisen-index tabel te genereren of layout consistentie te realiseren. Het is mogelijk om Jenkins te configureren zodat de plugin-taken niet op een lokale machine hoeven te worden uitgevoerd. Deze Jenkins buildserver kan geconfigureerd worden om elke nacht een “build” te draaien van alle documenten, zodat de actuele status op elk moment kan worden opgeleverd of snel te constateren er ergens een fout is gemaakt bij het opstellen systeembeschrijving.

Hogere productiviteit
WordGro is een oplossing die leidt tot een hogere productiviteit. Het voorkomt onnodig veel handwerk wanneer MBSE  toegepast wordt bij uitvoeren van een project, maar er uiteindelijk documenten intern of extern opgeleverd moeten worden.

De plugin bevat onderstaande functionaliteit:

  • Template editor
  • Validatie script (controle script tbv MBSE-ontwerp voordat documenten worden gegenereerd)
  • Model taak runner om geautomatiseerde taken op het model uitvoeren (bijvoorbeeld imports of validaties)
  • XML (en JSON) template editor
  • Tools voor het uitlijnen van diagrammen
  • Documenten lijst opstellen
  • Importeren van eisen/functies/systemen/ontwerpbeslissingen en meer vanuit XML/Excel/CSV/Relatics
  • Ophogen van document(en) versies
  • Genereren van UPP diagrammen o.b.v. RWS Excelsheets
  • Draaien van macro’s op Word documenten
  • Genereren van PDF
  • Automatisch EA thema wisselen bij generatie
  • Tracering naar model elementen opnemen in Word document.
  • Invoegen van afbeeldingen, Word-documenten, Excel-sheets als tabellen vanaf disk/fileserver of SharePoint
  • Opsplitsen van grote afbeeldingen over meerdere pagina’s
  • Toevoegen/wijzigen van document eigenschappen
  • Wisselen tussen pagina afmetingen van A1 tot A5 zowel liggend als staand
  • Invoegen van inhoudsopgave, figuur-lijst, tabel-lijst.

Voordelen WordGro:

  • Gebruik van templates voor documenten
  • Invoegen van Word documenten tijdens generatie
  • Generatie niet alleen lokaal op laptop, maar ook op build-server
  • Laptop is altijd vrij om verder te gaan met ontwerp
  • Iedere nacht een complete set documenten
  • Terugkijken van vorige versies van documenten
  • Sneller ontdekken van fouten in model
  • Automatiseren van taken op het model
  • Waarborging van kwaliteit