Handleiding - Extensie maken op MIM-toolbox

Software/Standaard Versie
MIM-standaard 1.1.1
MIM-toolbox 1.1.1
Enterprise Architect (EA) 15.2

Inhoud

  1. Beschrijving
  2. Importeer de MIM-toolbox in de EA-omgeving
  3. Maak de package-structuur aan voor de extensie
  4. Modelleer de toolbox-extensie
  5. Modelleer het toolbox-menu
  6. Modelleer het diagram
  7. Genereer MDG Technology
  8. Werken met de toolbox

Beschrijving

Deze handleiding beschrijft hoe je in Enterprise Architect een extensie maakt op de MIM-toolbox. Dit is van toepassing als er extra metamodelconstructies nodig zijn voor het maken van een informatiemodel. Meer informatie en spelregels hiervoor vind je in de MIM-standaard. Een extensie op de MIM-toolbox is ook bedoeld voor het maken van aanvullende constructies die alleen spelen op het niveau van implementatie, of op het niveau van afgeleide technsiche modellen ten behoeve van specifieke interfaces.

Met een extensie breidt je MIM-toolbox uit. Dit is handig wanneer je extra informatie aan modelonderdelen (bijv. objecttypen) wilt toevoegen. Bijvoorbeeld voor: - het uitbreiden van de set met metagegevens voor modelonderdelen van een specifiek sector-/domeinmodel (extra tagged values); - het uitbreiden van de set met metagegevens voor specifieke toepassingen van het model, zoals bijvoorbeeld in Imvertor of voor een UML-JSON-encodings; - het het toevoegen van extra stereotypen.

Deze handleiding neemt het maken van een DiSGeo-extensie op MIM als voorbeeld. Voor het informatiemodel DiSGeo zijn voor de MIM-stereotypen «Objecttype» en «Attribuutsoort» meta-informatie nodig in de vorm van extra tagged values. Voor Objecttype gaat dat om het toevoegen van Actualiteit en Inwinning verplicht. Voor Attribuutsoort zijn dat: Inwinningsregels en Positionele juistheid.

Voorbereiding

Zorg dat je de volgende twee zaken bij de hand hebt: 1. Enterprise Architect: Het is handig om de volgende venster te openen - Browser - Toolbox - Properties - Features 1. De MIM-toolbox waarop je een extensie wilt bouwen, in de vorm van een MDG Technology (.xml). Hier vind je de meest actuele versie van de toolbox

Stap 1: Importeer de MIM-toolbox in de EA-omgeving

  • Open de project browser.
  • Klik op de tab Resources.
  • Klik op de map MDG Technologies.
  • Klik met de rechtermuisknop op Model Technologies en selecteer Import Technology.
  • Open de MDG Technology (dit bestand heeft een .xml-extensie) van de MIM-toolbox.
  • Klik Openen.
  • Selecteer daar linksonderin het diagloogvenster Import To Model en klik vervolgens op OK.

Indien je geen foutmelding krijgt, heb je de MIM-toolbox succesvol geïmporteerd.

Stap 2: Maak de package-structuur aan voor de extensie

  • Klik in de project browser linksbovenin op de map met het gele sterretje, of druk Ctrl+Shift+M.
  • Hierdoor open de Model Wizard.
  • Selecteer het tabblad Model Patterns.
  • Klik daaronder op Model Technologies Perspective.
  • Ga naar Management en selecter vervolgens: MDG Technology Builder.
  • In het venster verschijnen nu verschillende Model Patterns. Dit zijn templates voor het maken van modellen.
  • Kies nu onder MDG Technology Builder voor Basic Template en klik linksonderin op Create Pattern(s).
  • Geef in het dialoogvenster dat nu verschijnt de naam van de extensie op die je gaat maken (bijvoorbeeld 'DISGEO') en klik op OK.

In de project browser zie dat er nu een nieuwe package DiSGeo is toegevoegd. Dat package bevat een - diagram; - een «profile»; - een «diagram profile»; - en een «toolbox profile».

Je hebt nu succesvol de package structuur aangemaakt.

Stap 3: Modelleer de toolbox-extensie

  • Vouw het package «profile»DISGEO uit
  • Dubbelklik op het diagram
  • Hierdoor opent het diagram en verschijnt de bijbehorende toolbox: UML::Profile
  • Ga in het toolboxmenu naar Metaclass en sleep dit element in het diagram.
  • Er verschijnt nu een venster Extend Metaclass.
  • Klik in de linkerkolom op Stereotypes. Hierdoor verschijnen aan de rechterkant alle stereotypen die MIM kent.

Let op: deze zijn alleen beschikbaarbaar nadat je de MIM-toolbox hebt geïmporteerd (zie: stap: 1).

  • Zoek in de lijst aan de rechterkant «Objecttype» en «Attribuutsoort» op, selecteer deze en klik op OK.
  • Deze worden nu toegevoegd aan het diagram.
  • Zoek nu in het toolboxmenu Add Stereotype op (onder Profile Helpers) en sleep dit element op het diagram.
  • Er verschijnt nu een venster Add Stereotype.
  • We gaan nu een stereotype maken dat dient als extensie op het MIM-stereotype «Attribuutsoort».
  • Geef een naam op voor het stereotype. In het geval van dit voorbeeld is gekozen voor Attribuutsoort, maar dit kan elke andere willekeurige naam zijn.
  • Klik vervogens op de button Add Metaclass.
  • Hier geef je de UML-metaklasse uit EA op waarop je extensie plaatsvindt. Als je niet weet van welke UML-metaklasse je stereotype wordt afgeleid, zoek dit dan op in het MIM-profiel.

Info: In hoofdstuk 3 van de MIM-standaard staat beschreven van welke UML-metaklasse elk MIM-stereotype is afgeleid. Omdat je een extensie maakt op MIM, is de nieuwe extensie automatisch óók een extensie op een UML-type. Desondanks moet je dit in Enterprise Architect expliciet benoemen.

  • Laat de overige instellingen staan en klik op Volgende.
  • In dit venster, Define Tagged Values, kun je de extra metadata-elementen opvoeren.
  • Klik met de rechtermuisknop in de kolom Property
  • Kies uit het menu Add Tagged Value.
  • Voer een naam op voor de tagged value. In het geval van dit voorbeeld Actualiteit.
  • In de linkerkolom kun je nog een standaardwaarde opvoeren, maar dat is niet verplicht.
  • In dit voorbeeld blijft dit veld leeg.
  • Herhaal deze stap voor alle tagged values die je aan dit element wilt toevoegen.
  • Als je klaar bent, kun je bovenstaande stappen herhalen voor «Objecttype».
  • Klik daarna op Voltooien

Je ziet nu het nieuwe stereotype met de tagged values. Daarnaast heeft het nu een relatie met de UML-metaklasse «Attribute». Als laatste onderdeel van deze stap moet nu de relatie gelegd worden tussen het nieuwe stereotype en het MIM-stereotype. Dit gaat als volgt:

  • Klik nu op het element Attribuutsoort.
  • Er verschijnen nu rechts van het element een aantal iconen.
  • Klik op de witte pijl (QuickLinker) met de muisknop ingedrukt en sleep dit naar het bijbehorende MIM-type (het bovenste icoon)
  • Kies uit het menu dat nu verschijnt voor Generalization.
  • Je extensie-type heeft nu een relatie met MIM::Attribuutsoort én UML::Attribute.
  • Herhaal deze stappen voor «Objecttype».

Als laatste stap is het handig om het kleurenschema van het modelelement gelijk te maken aan dat van MIM. Dat gaat als volgt:

  • Klik met de rechtermuisknop op het nieuwe element Objecttype.
  • Navigeer naar Appearance en klik op Default Appearance.
  • Nu opent een venster met dezelfde naam.
  • Klik op Background Color.
  • Klik op More Colors.
  • Selecteer het tabblad Custom.
  • En vul vervolgens onderstaande waarden in:
   Hue:   128
   Sat:   245
   Lum:   230
   Red:   206
   Green: 253
   Blue:  254
  • Klik op OK.
  • Zet Border Color en Font Color op zwart.
  • Klik op OK.
  • Herhaal deze stap voor de andere modelelementen, in dit geval Attribuutsoort.

Je hebt nu succesvol het profiel van je extensie aangemaakt.

Stap 4: Modelleer het toolbox-menu

In deze stap maak je de menupagina van de toolbox. Hiermee bepaal je hoe en welke stereotypes zichtbaar zijn in het menu. Het doel van de DiSGeo-extensie is om bestaande MIM-stereotypen uitbreiden met extra tagged values. Daarvoor introduceerden we in EA onder de moterkap weliswaar twee nieuwe stereotypen («Objectype» en «Attribuutsoort»), maar die willen we niet expliciet terugzien in de toolbox. In de toolbox willen we «Objecttype» en «Attribuutsoort» aanbieden.

  • Open het lege diagram uit het package «toolbox profile»DISGEO.
  • Sleep uit de toolbox die bij dit diagram hoort de Profile Helper Add Toolbox Page op het diagram.
  • Het venster Add Toolbox Page opent nu.
  • Vul de naam in van de toolboxpagina die je wilt maken. In dit geval maken we een kopie van de MIM-toolbox, dus noemen we deze (eerste) pagina: MIM: Objecten en attributen.
  • Klik vervolgens op de Add-button en selecteer de optie Add Stereotype.
  • Het venster Select A Profile Element opent nu.
  • Navigeer naar het package «profile»DISGEO en selecter «stereotype»Objecttype en klik op OK.
  • In de eerste rij van de tabel in het venster Add Toolbox Page, is nu dit stereotype toegevoegd.
  • Voor de leesbaarheid is het fijn om het type een alias mee te geven (anders heet het toolbox-item DISGEO::Objectype(UML::Class). Vanwege het eerder genoemde uitgangspunt, krijgt dit stereotype het alias 'Objecttype'.
  • Voeg nu op dezelfde manier 'Attribuutsoort' toe en klik nog niet op OK!.
  • Je hebt nu de twee nieuwe stereotypes toegevoeg aan de toolboxpagina:
+ DISGEO::Objecttype(UML::Class)
+ DISGEO::Attribuutsoort(UML::Attribute)

In de MIM-toolbox heeft deze pagina nog drie andere stereotypes. Deze kun je uit het package MIM-UML halen. Deze beschrijving gaat ervan uit dat je hierover beschikt.

  • Klik nogmaals op de Add-button en navigeer nu naar het package «MIM-UMLprofile» en voeg de volgende elementen toe:
DISGEO::Objecttype(UML::Class)
DISGEO::Attribuutsoort(UML::Attribute)
+ MIM::Gegevensgroep(UML::Attribute)
+ MIM::Gegevensgroeptype(UML::Class)
+ MIM_Keuzeattribuut::Keuze(UML::Attribute)
  • Geef ze de bijbehorende aliassen uit het MIM-profiel
  • Klik nu op OK.
  • Voeg de toolboxpage toe voor MIM-Relaties, MIM-Datatypen, MIM-Waardelijsten en MIM-Packages.
  • Herhaal hiervoor de voorgaande stappen.

Je hebt nu met succes het toolboxmenu gemaakt. Het is in alle gevallen mogelijk om de namen van de stereotypen met de hand op te voeren. De schrijfwijze luistert heel nauw, dus heeft het de voorkeur gebruik te maken van Add Stereotype.

Stap 5: Modelleer het diagram

  • Open het lege diagram uit het package «Diagram Profile»DISGEO.
  • Sleept uit de toolbox die bij dit diagram hoort de Profile Helper Add Diagram Extention op het diagram.
  • Het venster Add Diagram Extention opent nu.
  • Geef een naam op voor het diagram en kies bij Extention Type voor Class.
  • Geef bij Description eventueel een beschrijving op voor de toepassing van dit diagram. Het is handig om hier te vermelden dat je dit diagram nodig hebt om voor de MIM-toolbox inclusief extensie!
  • Vouw onder Properties de lijst met General uit.
  • Kies bij Toolbox Profile uit de lijst met namen, de naam van het profiel, in dit geval: DISGEO en klik op OK.
  • Klik nu op het modelelement «metaclass» Diagram Logical en voeg bij Features een nieuw attribuut toe met de naam: toolboxPage. Vul bij Initial Value de het volgende in:

MIM: Objecten en attributen=1;MIM: Relaties=1;MIM: Datatypen=1;MIM: Waardelijsten=1;MIM: Packages=1;UML: Connectors=0;

  • Dit geeft aan welke onderdelen van de het toolbox menu uit- (waarde: 1) of ingevouwen (waarde: 0) zijn.

Je hebt nu succesvol een Diagram Profile aangemaakt.

Stap 6: Genereer MDG Technology

Je hebt nu succesvol de volgende drie profielen gemaakt: - «profile»DISGEO - «diagram profile»DISGEO - «toolbox profile»DISGEO

In de volgende stap lees je hoe je de profielen publiceert Volg deze link voor een beschrijving.

Nadat je elk profiel gepubliceert hebt, 'bundel' je ze in een MDG Technology. Hoe je dat doet, lees je hier

Stap 7: Werken met de toolbox

Bekijk de meest actuele handleiding voor het gebruik van toolboxen in EA.