Handleiding koppeling architectuurtools

Sinds release 5.0 van de Softwarecatalogus wordt een koppeling met architectuurtools ondersteund. Zie de releasebrief 5.0. Hieronder beschrijven we de basishandelingen om een applicatielandschap en koppelingen van een gemeente of samenwerking uit de Softwarecatalogus te exporteren naar architectuurtools.

AMEFF

De Softwarecatalogus exporteert een model vanuit de Softwarecatalogus in AMEFF-formaat.
Zie http://gemmaonline.nl/index.php/ArchiMate_Model_Exchange_File_Format voor meer informatie over deze standaard.

Leveranciers

Leveranciers van architectuurtools die deze standaard (gaan) ondersteunen zijn:
ArchiXL, Bizzdesign, Mavim, Sparx, Dragon1 en Value Blue. Heeft u een tool van één van deze leveranciers in huis, neem dan met hen contact op voor verdere ondersteuning. Zij zijn op de hoogte van deze exportmogelijkheid en gaan met pilot-gemeenten deze mogelijkheid verder in de praktijk beproeven. Wij zullen deze praktijkervaringen regelmatig publiceren op de nieuwspagina van de Softwarecatalogus.

Tool Archi

Het open-sourcetool Archi ondersteunt de AMEFF-standaard ook. VNG Realisatie kan de ondersteuning van Archi tot op zekere hoogte verzorgen. We hebben nu deze eerste (beperkte) handleiding gemaakt om te kunnen starten als beginnend gebruiker. We kunnen geen uitgebreidere handleidingen, instructies, helpdesk en dergelijke over de werking van Archi zelf bieden. We gaan wel met pilot-gemeenten die dit tool gebruiken ervaring opdoen en zullen op basis daarvan onze ondersteuning voor Archi verder bepalen. Als u voor het eerst gebruik van Archi gaat maken kunt u dit tool gratis downloaden vanaf https://www.archimatetool.com.

De export uit de Softwarecatalogus

Ingelogd als gemeente of samenwerking, vind je op het tabblad Pakketten (en ook op het tabblad Koppelingen) de exportmogelijkheid in de listbox naast de Exporteerknop. Pakketten én koppelingen worden in 1 model geëxporteerd. Kik op de pijl van de listbox en kies “Beta-versie AMEFF-export”.

Er verschijnt een “wacht”-venster met de melding dat de export soms langer dan een minuut kan duren. Inmiddels hebben we gemiddelde download-tijden rond 30 seconden gerealiseerd.  Het opslaan van het gedownloade AMEFF-xml is browser-afhankelijk, maar komt normaal gesproken terecht in de map “downloads”. Vanuit daaruit kan het geïmporteerd worden in het architectuurtool. Voor de verdere werking in de tools van bovengenoemde leveranciers moet dus naar behoefte verder contact met die leveranciers gezocht worden. Hierna volgt de beschrijving van de import in Archi.

Import in Archi

Kies in het File menu: Import en dan Model From Open Exchange File…

Dubbelklik in de downloadmap op het exportbestand. Dit bestand heeft als naam:
<datum download>GEMMA_Softwarecatalogus_<Gemeente- of Samenwerkingsnaam>_ameff_model

Het model wordt dan geladen en kan daarna bekeken worden met o.a. de Visualiser.

Model

Bij een standaard-indeling zoals het Archi-scherm meestal opent, is het model zichtbaar. Met diverse navigatie-instellingen kan de scherm-indeling echter aangepast worden. In het Menu “Window” kan met de keuze “Models” het model altijd weer getoond worden. Als je door navigatie het Model niet meer ziet, moet je andere schermdelen even met de knopjes Minimize, Restore of Maximize verplaatsen.

GEMMA views

In het venster 'Models' staat onderin de submap Views. In deze map vind je alle GEMMA views en de GEMMA views met daarop geplot de pakketten van de gemeente zoals geregistreerd in de Softwarecatalogus. De views met de gemeentelijke pakketten zijn te herkennen aan de naam met daarachter tussen haakjes de (gemeentenaam).

Kijk bijvoorbeeld naar de views:

  • RD02 Bedrijfsfuncties ruimtelijk domein met referentiecomponenten > GEMMA referentiearchitectuurview
  • Bedrijfsfuncties ruimtelijk domein Turfbrug (test VNG Realisatie) > dezelfde GEMMA view met de ruimtelijk domein pakketten van de gemeente

Je kunt in Archi een GEMMA view kopiëren en deze gebruiken als basis voor een eigen view

Visualiser

Door op een applicatienaam in het Models venster te klikken, zie je in de Visualiser alle koppelingen tussen die applicatie met andere applicaties, en met landelijke voorzieningen. De Visualiser is in het menu Window te openen als die nog niet geopend is. Door binnen de Visualiser op andere applicaties te klikken, krijg je successievelijk de koppelingen van die geselecteerde applicatie te zien. Door op een referentiecomponent te klikken krijg je o.a. de relaties met standaarden te zien. Ook op een standaard kan dan weer geklikt worden om de relaties tussen die standaard en andere referentiecomponenten te zien.

Met de Lay-out button kun je een nieuw plaatje genereren dat het scherm optimaal vult.

Tekenen met de informatie uit de Softwarecatalogus

In het Models venster staan de overige submappen, o.a.:

Je kunt vanuit het Models venster elementen op een view slepen.

  • Maak een nieuwe view (klik rechts op de map Views en kies voor New > Archimateview

  • Sleep je één element in de view dan plaatst Archi dat element op de view. Als er op deze view elementen voorkomen waar het element een relatie mee heeft dan worden deze ook getekend.

    • kies bijvoorbeeld uit de map Application een pakket of een pakketversie
  • Sleep je meerdere elementen in een view, dan worden alle elementen én hun relaties getekend.
    • kies uit de map Application meerdere pakketten en pakketversies. Deze worden dan getekend met de relatie 'heeft versie' tussen pakket en pakketversie

In het onderstaande filmpje kun je de hierboven beschreven stappen bekijken.

Het is ook mogelijk om Archi met de informatie uit het model een view te laten genereren

  • Selecteer in het modelvenster één of meer elementen en klik rechts, kies 'Generate view for'.
  • Archi tekent alle elementen en hun relaties in een nieuwe view
    • Als een element veel relaties heeft, levert dit nogal een vol plaatje op.
    • Het maken van een overzichtlijke view wordt een stuk makkelijker door te beginnen met het verwijderen van overbodige elementen uit de view.

Tekenen van een view met koppelingen

De koppelingen uit de Softwarecatalogus zijn ook beschikbaar in het model. Een koppeling is gemodelleerd als een Archimate flow relatie tussen twee pakketten of tussen een pakket en een buitengemeentelijke voorziening.

Maak een view van de koppelingen:

  • Maak eerst een nieuwe Archimateview te maken (met de rechtermuisknop op "Views")
  • Filter met de zoekfunctie (het vergrootglas) met de zoekterm "tern".
    • In de map relaties zie je alle koppelingen uit de Softwarecatalogus omdat die de naam 'intern' of 'extern' hebben gekregen.
    • En je ziet ook alle elementen met "tern" in de naam.
  • Sleep een aantal koppelingen in de view
    • Selecteer een subset van koppelingen (niet te veel, dan verlies je het overzicht).
    • Sleep deze in de view
  • Vervolgens is aan het jou om de pakketten zo te verschuiven dat er een goed overzicht ontstaat van de koppelingen en pakketten
    • Je kun een koppeling ook beperkt opmaken door deze te selecteren en het middelste punt te verslepen

Onderstaande filmpje toont de bovenstaande stappen

    Als je een view wilt maken van alle koppelingen die die relevant zijn voor een bepaald onderwerp, bijvoorbeeld de Omgevingswet, doe dit dan in kleine plukjes. Sleep telkens 5 koppelingen in de view en maak deze eerste weer overzichtelijk.

    Teken de koppeling mét de intermediair zoals geregistreerd in de Softwarecatalogus

    Met de onderstaande stappen teken je een koppeling én de intermediair waarmee de koppeling geïmplementeerd is.

    • Sleep een koppeling die geïmplementeerd is met een intermediair in de view.
      • In de Softwarecatalogus is van de koppeling de intermediair bij de optionele technische informatie ingevuld
      • Archi tekent twee pakketten en de koppeling
    • Opzoeken van de intermediair in het model
      • Selecteer de koppeling en kijk in het tabblad properties
      • Kopieer van de properties de naam van de intermediair
      • Zoek in het model op naam van de intermediair
    • Sleep de intermediair in de view
      • Archi tekent de intermediair met de relatie 'heeft intermediair' naar de koppeling

    Het onderstaande filmpje laat de zojuist beschreven stappen zien.

    Afsluiten Archi

    Bij het afsluiten van Archi kan (via het File-menu) het model lokaal gesaved worden als Archimate-model. Dan kan het de volgende keer ook weer direct gebruikt worden. Vergeet je dat, dan moet het opnieuw geïmporteerd worden.

    Mutaties vanuit de Softwarecatalogus verwerken in een eerder in Archi opgeslagen model

    Er is een "merge"-functie voor AMEFF-exports beschikbaar op https://test.wikixl.nl/ameff-merge/AMEFFMergeForm.html. Dit biedt de mogelijkheid om 2 architectuurmodellen (weer)  samen te voegen tot 1 model. Dit is van toepassing als je bijvoorbeeld in een initieel model vanuit de Softwarecatalogus eigen toevoegingen van andere architectuurelementen en/of views maakt; bijvoorbeeld Producten/Diensten, Zaaktypen, Registraties, Afdelingen, Processen, Ketenpartners, ICT-infrastructuur enz. zodat je een eigen "Enterprise Architectuur" ("Lokaal model") krijgt. Als je dan later vanuit een nieuwe export van de Softwarecatalogus ("Domein-model"), mutaties van het applicatie- en koppelingenlandschap wil verwerken naar je "Lokaal model" wil je natuurlijk je eigen toevoegingen in het "Lokaal model" behouden. De merge-functie houdt daar rekening mee. Je dient dan van beide modellen wel eerst weer een AMEFF-export te maken, en die samenvoegen tot een nieuwe versie van het "Lokaal model". Alleen verwijderingen in de Softwarecatalogus (het "Domein-model") leiden niet tot verwijderingen in het "Lokaal model". Dat komt omdat de merge-functie vooralsnog alleen werkt vanuit de mutaties van het "Domeinmodel" en identifiers daarin vergelijkt met het "Lokaal Model". Het is dus nu (nog) geen zgn "two-way-merge", dus verwijderingen van elementen en views in de "bron" (Softwarecatalogus en GEMMA) moeten handmatig in het Lokaal Model verwijderd worden.

    Advies is om toegevoegde elementen en views een “prefix” in de naam te geven zodat deze eenvoudig gezocht kunnen worden.

    Bij een wijziging van de GEMMA-architectuur, of van de applicaties of koppelingen in de Softwarecatalogus, of wijzigingen in beide:

    • wordt een nieuwe AMEFF-export uit de Softwarecatalogus gemaakt (is inclusief GEMMA) en geïmporteerd in Archi;
    • worden deze nieuwe (als bron) en de vorige Archimate-file (als doel) vanuit Archi als AMEFF-bestanden geëxporteerd en “gemerged” met https://test.wikixl.nl/ameff-merge/AMEFFMergeForm.html

    Daarbij gelden de volgende regels:

    Niet-bestaande onderdelen in het doel worden vanuit de bron toegevoegd. Ook de modelnaam wordt aangepast, deze wordt aangevuld met datum tijd en als een AMEFF-download aangeboden.

    Uitgangspunten:

    • Bronbestand is leidend: dit is de nieuwe export uit de Softwarecatalogus;
    • Alle in het doelbestand (het laatst actuele Archi-model) aanwezige GEMMA-elementen met dezelfde sleutels (Referentiecomponenten, Bedrijfsprocessen etc.) worden overschreven;
    • Alle GEMMA-relaties worden overschreven;
    • Alle GEMMA-views worden overschreven;
    • Let op dat nieuwe GEMMA-views in het doelbestand ook nieuwe ID's (in de Object ID-eigenschap) hebben en geen kopieën zijn van andere views. Als ID's hetzelfde zijn worden de views of andere elementen overschreven door onderdelen uit het bronbestand.
    • Om dezelfde reden moeten relaties tussen originele GEMMA- of Softwarecatalogus-elementen en de toegevoegde elementen niet in bestaande views getekend worden, of als attribuut (“property”) aan een element toegevoegd worden: die views en properties worden overschreven bij een update! Maak dus nieuwe elementen en nieuwe views voor de specifieke Enterprise Architectuur-elementen.
    • Verwijderingen in GEMMA of Softwarecatalogus moet handmatig in het Archi-model verwijderd worden.

    NB: de merge-functie is nog TEST maar de ervaringen zijn tot nu toe dat het goed werkt.