Navigatie terug volgende

Voorbeelden van configuratie instellingen op het gedrag van de Model Export Enhancer


Relaties tussen elementen kunnen worden hergebruikt.
Op basis van een patroon koppel je relaties  aan andere elementen.
Het model wordt niet vervuild met informatie die je kunt afleiden.


  • Samenvatting

    Elementen hebben relaties met andere elementen. Wanneer je in een model veel relaties opneemt wordt een model onoverzichtelijk. Veel relaties tussen elementen zijn af te leiden. De generator kan hiervan gebruik maken door het model te verrijken met relaties en dit verrijkte model voor het genereren van documentatie te gebruiken. Deze pagina beschrijft hoe je dat configureert.

Relaties hergebruiken door een kopie te maken

Hiernaast staat een diagram van een eenvoudig model met een 'actor' die met de rol 'persona' verbonden is met een element 'Voorbeeld Activiteit 1' van het type 'activity'.
Het element 'Voorbeeld Activiteit 1' is verbonden met 'Voorbeeld Activiteit 2' door een relatie met de naam 'invokes'. 
Dit model wordt aangemaakt met een standaard moxen bestand en vervolgens verwerkt zonder aanpassingen in de configuratie.


 


Het model aanmaken

Het moxen bestand hiervoor maakt de 'actor' vier elementen van het type 'activity'.
De 'actor' wordt verbonden met het element 'Voorbeeld Activiteit 1' met de naam 'persona'.
De vier elementen van het type 'activity' met een relatie genaamd 'invokes'.

Het moxen bestand staat in: 'text-model\archives\voorbeelden\instructies'.
Opgelet: In het moxen bestand staat het absolute minimum om een model te maken.



De standaard gegenereerde documentatie

De gegenereerde webpage laat de informatie zien over de 'Voorbeeld Persoon' en de de relaties.
Over relaties zelf is geen informatie te zien. Je wilt zien in welke richting de relatie loopt en op basis van die informatie de webpage verrijken.
Omdat vanuit 'Voorbeeld Activiteit 1' een keten van activiteiten start wil je de 'actor' met alle activiteiten als 'persona' verbinden.

Kopie van een relatie maken

De configuratie instelling 'enhance_derivedReference' geeft de mogelijkheid om een an relatie te kopiëren onder bepaalde omstandigheden.
In dit voorbeeld is die omstandigheid: Wanneer een 'activity' een relatie met de naam 'persona' heeft moet de relatie met de naam 'persona' gekopieerd worden naar alle elementen die zijn verbonden met de naam 'invokes'. Dit geldt ook voor elke vervolg activiteit.
Het bestand staat in: '\bat\base\agile\profiles\enhance'. In deze folder staan tal van opties om het gedrag van de generator aan te passen.
Door in het bestand de volgende regel op te nemen, zorg je ervoor dat het begin en het eindpunt van de relatie wordt aangepast.
Op te nemen instelling: 'activity , invokes ; persona'.
Met deze instructie worden voor elementen van het type 'activity' waaraan elementen zijn verbonden met de naam 'invokes' de relatie met naam 'persona'  gekopieerd naar de elementen die verbonden zijn met 'invokes'.


Gevolg voor het verrijkte model

Hiernaast staat een diagram van het verrijkte model waarin de 'actor' verbonden is met alle elementen van het type 'activity'.












De aangepaste gegenereerde documentatie

De gegenereerde webpage laat nu de informatie over zien van  het element 'Voorbeeld Persoon'.
Je ziet dat de informatie is toegevoegd dat de actor een relatie heeft met alle activiteiten.
Je kunt nog niet de activiteiten via een link bereiken. Alleen 'Voorbeeld Activiteit 1' is aanklikbaar, omdat deze is opgenomen in het moxen bestand.


De gegevens in de gegenereerde documentatie

De inhoud van de gegenereerde documentatie is gedefinieerd in een configuratie bestand in de folder '\bat\base\agile\profiles\layout'.
Je kunt per type element een specifieke configuratie opnemen. In dit voorbeeld is het type van de gebruikte element 'actor'. Wanneer in deze folder een bestand aanwezig is met de naam 'topicdescription-actor-template.txt'. Bestaat er geen bestand met deze naam dan wordt het bestand 'topicdescription-template.txt' gebruikt. Dit is het bestand dat in de voorbeeld situatie wordt gebruikt.
Wanneer je een type wilt toepassen die niet in de standaard download zit kun je dit bestand aanpassen of zelf een indeling samenstellen.



Definitie gegevens in gegenereerde documentatie

In het bestand voor de webpage is een secties opgenomen voor de naam van een relatie. In dit voorbeeld is die naam van de relatie 'persona'.
Elke sectie bevat een stukje HTML die in een webpage wordt geplaatst als de relatie bestaat. In dit voorbeeld is dat 'Betrokken bij'Deze sectie moet je toevoegen.

Het effect van de aanpassing 

De gegenereerde webpage laat nu de informatie over zien van  het element 'Voorbeeld Persoon'.
Je ziet dat de informatie is toegevoegd voor de relaties met  'Voorbeeld Persoon'.
Alle activiteiten zijn aanklikbaar. 
In de lijst achter 'Betrokken bij:' zijn niet alle activiteiten opgenomen de activiteiten 'Voorbeeld Activiteit 3' en 'Voorbeeld Activiteit 4' ontbreken omdat deze reeds geselecteerd kunnen worden. Dit is nodig om te voorkomen dat dit soort overzichten erg lang worden. Elementen kunnen immers naar elkaar verwijzen.