Archi en plug-ins installeren


Overzichtpagina werken met VNGR architectuurmodellen

Installeren Archi

Download Archi van https://www.archimatetool.com/download/. Voor Windows kun je kiezen voor de installeerbare versie of voor de portable versie. Advies is om de nieuwste versie van Archi te gebruiken. De ervaring leert dat de Archi releases zeer stabiel zijn.

Gebruik minimaal Archi versie 4.7. Het GEMMA architectuurmodel en de van de GEMMA afgeleide projectmodellen stellen deze eis vanwege:

  • ondersteuning voor ArchiMate 3.1 (vanaf Archi 4.6)
  • het samenvoegen van projectmodellen en het GEMMA architectuurmodel (interne en geëxporteerde id's gelijk aan elkaar vanaf versie 4.7)


Je kunt meerdere Archi versies naast elkaar installeren. Als je gebruik maakt van Windows, dan moet één van de versies portable zijn.

  • Let op: ook de portable versie gebruikt default je profiel in je home directory
  • Om Archimate 2.1 bestanden te kunnen importeren, moet je een oude Archi versie installeren. Deze is niet meer beschikbaar op Internet. Het installatiebestand is in onze Teams omgeving nog beschikbaar.
    • Installatiebestand staat op Teams in de folder Archi 3.3.2
    • Als je geen toegang hebt tot deze folder, stuur een bericht aan mark.backer@vng.nl


Geen bijzonderheden verder voor het installeren van Archi, volg de instructies van de site

Installeren plugins

Ga naar de Archi plug-in pagina.

  • Download de coArchi – Model Collaboration for Archi plug-in om samen te kunnen werken aan een architectuurmodel in een git-repository

De scripting plug-ins is alleen beschikbaar voor donateurs van Archi. Voor VNGR architecten wordt de plug-in beschikbaar gesteld in de Teams folder Archi (actuele versie)

  • jArchi – Scripting for Archi
    • extra features beschikbaar in open source scripts
    • enkele specifieke scripts voor het beheer van het GEMMA architectuurmodel

Voor het installeren van de plug-ins, volg de installatie instructies van de Archi website

Configureren Archi

Voer onderstaande configuratie uit om goed te kunnen werken met de GEMMA architectuurmodellen

  • voor standaard GEMMA kleuren en figuren importeer het voorkeurschema GEMMA_color.prefs uit de map Archi (actuele versie)
    • Edit > Preferences > Colors and fonts
      • import schema GEMMA_color.prefs
    • Edit > Preferences > Diagram > tab Default figures
      • wijzig de default figures voor Application component, Device, Grouping en Node (kies figure in rechter kolom)
  • Optioneel, enkele persoonlijke handige instellingen voor het modelleren
    • Automatic Relation Management
      • Edit > Preferences > Connection > ARM
      • In GEMMA gebruiken we geen composition relations => verwijder de vink 'creating new relations' bij de composition relation.
    • Uitlijning op grid
      • Edit > Preferences > Diagram
      • Zorg ervoor dat de grid-size en de grootte voor nieuwe figuren veelvouden van elkaar zijn
      • Het default grid is 12 en de default size for new ArchiMate figures is 120 bij 55 (zie tab General en Appearance)
      • Zet de grid-size op 10 en de size for new ArchiMate figures op 130 bij 60;
    • Regeltje meer ruimte
      • Edit > Preferences > General
      • De status bar toont welk object geselecteerd is. De titelbalk van het properties window toont deze informatie ook.
      • Zet show status bar uit voor een extra regel ruimte
  • het configureren van de coArchi en jArchi plugins staat beschreven bij de onderwerpen Versiebeheer en samenwerken en jArchi scripting

Configureren coArchi en Git

Wil je in Archi met verschillende versies van het architectuurmodel werken of je wilt met meerdere mensen aan één model samenwerken, dan heb je de collaboration plugin nodig en een git repository.

Zie coArchi – Model Collaboration for Archi voor documentatie

Welke git-provider gebruik je?

Git is gestandaardiseerd, het maakt eigenlijk niet uit welke provider je kiest. Het git gedeelte is overal hetzelfde. Wel zijn er verschillen tussen bijvoorbeeld github of gitlab in hoe de website werkt en hoe je met mensen naast git kunt communiceren en samenwerken.

  • Kies de provider die je fijn vind werken, je kunt een repository altijd verplaatsen naar een andere provider
  • De VNG Realisatie architectuurrepositories staan bij GitLab, maak dus (ook) een account bij gitlab
  • Als je een model met gemeenten wilt delen, gebruik dan ook GitLab.

Hoe inloggen met Archi ?

Hier worden de verschillende opties beschreven hoe je met Archi kunt inloggen bij GitLab. Als je met de browser naar GitLab gaat, dan log je in met een username password (en voor enkele acties nog een extra passcode). Echter als je met een tool - zoals Archi - met een git repository wilt werken, zijn er meer opties.

Hieronder de opties en enkele afwegingen om daaruit te kiezen.

  • Inloggen met een username password (let op, dit werkt niet als je je account met 2FA authentication hebt beveiligd)
    • niets extra aanmaken en configureren en dus een snelle start
    • vanuit Archi zul je per repository moeten inloggen om toegang te krijgen
  • Inloggen met een token voor API-clients (en Archi is een API-client)
    • eenvoudig op te zetten
    • met een token krijgt Archi (een API-client) toegang tot GitLab onder jouw account
  • Authenticeren met een SSH-key
    • meer werk om op te zetten (key creëren en configureren)
    • met een SSH-key is voor Archi de toegang tot alle repositories in één keer geregeld
    • én meteen ook voor een andere git-client

Hoe maak een een SSH-key aan (optioneel)

Voor het aanmaken en installeren van een SSH-key, zie Create and add your SSH public key

Tips voor het het werken met SSH-key:

  • gebruik de defaults

  • gebruik één key en wees hier zuinig op.

  • plaats deze key op je laptop op de default locatie met de default naam => voor Windows is dit

    c:\User\<username>\.ssh\id_rsa
  • Als je geen vertrouwen hebt dat je private key veilig is op de plek waar je deze bewaart, beveilig deze dan met een passphrase

Instructies voor macOS

  • Open een Terminal scherm

  • Maak een SSH-keypair aan:

    ssh-keygen -m PEM -t rsa -C "email@example.com"
  • Accepteer de voorgestelde bestandsnaam

  • Geef indien gewenst een wachtwoord op

  • Kopieer de private key naar het klembord

    pbcopy < ~/.ssh/id_rsa.pub
  • Log in op de Git omgeving en vul de inhoud van het klembord in bij de SSH sleutels

  • zie ook GitLab and SSH keys

Invullen login gegevens in Archi

Om te kunnen samenwerken aan architectuurmodellen, waaronder het GEMMA architectuurmodel in een repository op GitLab (alleen na installatie van plug-in co-Archi)

  • Edit > Preferences > Collaboration
    • Vul je naam en email in. Onder deze naam laat git zien dat jij een wijziging hebt doorgevoerd
    • Workspace default laten. Dit is de directory waar Archi voor iedere repository een .git directory aanmaakt (voor lokale wijzigingen) en waar een tijdelijk <repository>.archimate bestand wordt bewaard
    • SSH Authentication; invullen als je kiest voor een ssh-key. Als je je key beveiligd met een wachtwoord, deze dan hier opgeven
    • HTTP authentication; default vink laten staan
      • je kunt inloggen met username en password
      • of met de API-key

Configureren jArchi scripting

Met de jArchi-plugin is het mogelijk om met een script een architectuurmodel te lezen en te bewerken. Hiermee kun je je eigen functies aan Archi toevoegen. Zie jArchi – Scripting for Archi voor verdere informatie


Configuratie voor scripting

  • Edit > Preferences > Scripting (zie je geen tab scripting, dan moet je de plug-in jArchi eerst installeren)
    • accepteer de default directory of configureer in Archi je <script directory>
      • advies, kies een directory met backup (bijvoorbeeld een dropbox directory)
    • voorkeur editor, bijvoorbeeld Atom of Visual Studio Code (tip: zet script language op javascript)
    • zet vink bij Javascript ES6 (experimental)
      • Ook Javascript met ES6 syntax wordt zo ondersteund