Archi en plug-ins installeren: verschil tussen versies

 
(7 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 4: Regel 4:
 
|GEMMAOnlinebeheerder=Beheerder Architectuurtools
 
|GEMMAOnlinebeheerder=Beheerder Architectuurtools
 
}}
 
}}
[[Werken met VNGR architectuurmodellen|Overzichtpagina werken met VNGR architectuurmodellen]]
+
[[Category:ArchiMate modelleren]]
 
+
Download [https://www.archimatetool.com/download/ Archi]. Voor Windows kun je kiezen voor de installeerbare versie of voor de portable versie
Download Archi van https://www.archimatetool.com/download/. Voor Windows kun je kiezen voor de installeerbare versie of voor de portable versie
 
  
 
* als je meerdere versies naast elkaar wilt gebruiken, dan moet één van de versies portable zijn.  
 
* als je meerdere versies naast elkaar wilt gebruiken, dan moet één van de versies portable zijn.  
Regel 23: Regel 22:
  
 
* Download de '''coArchi''' – Model Collaboration for Archi plug-in om samen te kunnen werken aan een architectuurmodel in een git-repository
 
* Download de '''coArchi''' – Model Collaboration for Archi plug-in om samen te kunnen werken aan een architectuurmodel in een git-repository
 +
* Ga naar [https://github.com/archimatetool/archi-modelrepository-plugin/wiki/Setup-and-Configuration Setup and Configuration]
  
De scripting plug-ins is alleen beschikbaar voor donateurs van Archi. Voor VNGR architecten wordt de plug-in beschikbaar gesteld in de Teams folder [https://teams.microsoft.com/_#/files/Tooling?threadId=19%3A3dbb7c5deaba43fa9bd2fb1912844b66%40thread.skype&ctx=channel&context=Archi%252FArchi%2520(actuele%2520versie) Archi (actuele versie)]
+
Zie voor de jArchi scripting plug-in de pagina [[Archi scripting]]
 
 
* '''jArchi''' – Scripting for Archi
 
** extra features beschikbaar in open source scripts
 
** enkele specifieke scripts voor het beheer van het GEMMA architectuurmodel
 
  
 
== Configureren Archi ==
 
== Configureren Archi ==
Regel 34: Regel 30:
 
Voer onderstaande configuratie uit om goed te kunnen werken met de GEMMA architectuurmodellen
 
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 [https://teams.microsoft.com/_#/files/Tooling?threadId=19%3A3dbb7c5deaba43fa9bd2fb1912844b66%40thread.skype&ctx=channel&context=Archi%252FArchi%2520(actuele%2520versie) Archi (actuele versie)]
+
* voor standaard GEMMA kleuren en figuren importeer het voorkeurschema [https://github.com/VNG-Realisatie/GEMMA-ArchiMate-repository/blob/master/GEMMA_color.prefs GEMMA_color.prefs] uit de GEMMA repository 
 
** Edit > Preferences > Colors and fonts
 
** Edit > Preferences > Colors and fonts
 
*** import schema GEMMA_color.prefs
 
*** import schema GEMMA_color.prefs
Regel 42: Regel 38:
 
** Automatic Relation Management
 
** Automatic Relation Management
 
*** Edit > Preferences > Connection > ARM
 
*** Edit > Preferences > Connection > ARM
*** In GEMMA gebruiken we geen composition relations => verwijder de vink 'creating new relations' bij de composition relation.
 
 
** Uitlijning op grid
 
** Uitlijning op grid
 
*** Zorg ervoor dat de grid-size en de grootte voor nieuwe figuren veelvouden van elkaar zijn. Voor de GEMMA worden de onderstaande grid-size en figure size gebruikt:
 
*** Zorg ervoor dat de grid-size en de grootte voor nieuwe figuren veelvouden van elkaar zijn. Voor de GEMMA worden de onderstaande grid-size en figure size gebruikt:
Regel 50: Regel 45:
 
*** Wijzig de default size for new ArchiMate figures van 120 bij 55 naar 130 bij 60;  
 
*** Wijzig de default size for new ArchiMate figures van 120 bij 55 naar 130 bij 60;  
 
** Regeltje meer ruimte
 
** Regeltje meer ruimte
*** Edit > Preferences > General
+
*** Edit > Preferences > Appearance
 
*** De status bar toont welk object geselecteerd is. De titelbalk van het properties window toont deze informatie ook.
 
*** 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
 
*** 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 ==
 
== Configureren coArchi en Git ==
Regel 63: Regel 57:
 
=== Welke git-provider gebruik je? ===
 
=== 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.  
+
'''Let op''': de ArchiMate-repositories zijn verhuisd van GitLab naar GitHub.
 +
 
 +
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
 
* 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
+
* De VNG ArchiMate repositories vind je bij [https://github.com/ GitHub] onder de [https://github.com/VNG-Realisatie VNG-Realisatie] organisatie
* Als je een model met gemeenten wilt delen, gebruik dan ook GitLab.  
+
* De GEMMA ArchiMate-repositories zijn publiek, dus voor iedereen toegankelijk
 +
* Heb je toegang nodig tot een andere repository, maak dan een een account bij GitHub en vraag om toegang
 +
* Als je een model met gemeenten wilt delen, gebruik dan ook GitHub.  
  
=== Hoe inloggen met Archi ? ===
+
=== Inloggen bij GitHub 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.  
+
Hier worden de verschillende opties beschreven hoe je met Archi kunt inloggen bij GitHub. Als je met de browser naar GitHub 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.
 
Hieronder de opties en enkele afwegingen om daaruit te kiezen.
Regel 80: Regel 78:
 
* Inloggen met een token voor API-clients (en Archi is een API-client)
 
* Inloggen met een token voor API-clients (en Archi is een API-client)
 
** eenvoudig op te zetten
 
** eenvoudig op te zetten
** met een token krijgt Archi (een API-client) toegang tot GitLab onder jouw account
+
** met een token krijgt Archi (een API-client) toegang tot GitHub onder jouw account
*** Zie [https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html personal access tokens] voor hoe je een token maakt
+
*** Zie [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens  Managing your personal access tokens] voor hoe je een token maakt
 
*** Gebruik vervolgens het token als wachtwoord in Archi
 
*** Gebruik vervolgens het token als wachtwoord in Archi
 
* Authenticeren met een SSH-key
 
* Authenticeren met een SSH-key
Regel 88: Regel 86:
 
** én meteen ook voor een andere git-client
 
** én meteen ook voor een andere git-client
  
==== Hoe maak een een SSH-key aan (optioneel) ====
+
==== Hoe maak je een een SSH-key aan (optioneel) ====
  
Voor het aanmaken en installeren van een SSH-key, zie [https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html Create and add your SSH public key]
+
Voor het aanmaken en installeren van een SSH-key, zie [https://docs.github.com/en/authentication/connecting-to-github-with-ssh Connecting to GitHub with SSH]
  
 
Tips voor het het werken met SSH-key:
 
Tips voor het het werken met SSH-key:
  
<ul>
+
* gebruik de defaults
<li><p>gebruik de defaults</p></li>
+
* gebruik één key en wees hier zuinig op
<li><p>gebruik één key en wees hier zuinig op. </p></li>
+
* Als je geen vertrouwen hebt dat je private key veilig is op de plek waar je deze bewaart, beveilig deze dan met een passphrase
<li><p>plaats deze key op je laptop op de default locatie met de default naam =&gt; voor Windows is dit </p>
+
 
<pre class="">c:\User\&lt;username&gt;\.ssh\id_rsa</pre></li>
+
<b>Instructies voor Windows</b>
<li><p>Als je geen vertrouwen hebt dat je private key veilig is op de plek waar je deze bewaart, beveilig deze dan met een passphrase</p></li></ul>
+
* plaats deze key op je laptop op de default locatie met de default naam =&gt; voor Windows is dit <pre class="">c:\User\&lt;username&gt;\.ssh\id_rsa</pre>
  
 
<b>Instructies voor macOS</b>
 
<b>Instructies voor macOS</b>
<ul>
+
* Open een Terminal scherm
<li><p>Open een Terminal scherm</p></li>
+
* Maak een SSH-keypair aan: <pre class="">ssh-keygen -m PEM -t rsa -C "email@example.com"</pre>
<li><p>Maak een SSH-keypair aan:</p>
+
* Accepteer de voorgestelde bestandsnaam
<pre class="">ssh-keygen -m PEM -t rsa -C "email@example.com"</pre></li>
+
* Geef indien gewenst een wachtwoord op
<li><p>Accepteer de voorgestelde bestandsnaam</p></li>
+
* Kopieer de private key naar het klembord <pre class="">pbcopy < ~/.ssh/id_rsa.pub</pre>
<li><p>Geef indien gewenst een wachtwoord op</p></li>
+
* Log in op de Git omgeving en vul de inhoud van het klembord in bij de SSH sleutels
<li><p>Kopieer de private key naar het klembord</p>
 
<pre class="">pbcopy < ~/.ssh/id_rsa.pub</pre></li>
 
<li><p>Log in op de Git omgeving en vul de inhoud van het klembord in bij de SSH sleutels</p></li>
 
 
 
zie ook [https://docs.gitlab.com/ee/ssh/README.html#generating-a-new-ssh-key-pair GitLab and SSH keys]</ul>
 
  
 
=== Invullen login gegevens in Archi ===
 
=== 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)
+
Om te kunnen samenwerken aan architectuurmodellen, waaronder het GEMMA architectuurmodel in een repository op GitHub
  
 
* Edit &gt; Preferences &gt; Collaboration
 
* Edit &gt; Preferences &gt; Collaboration
Regel 125: Regel 118:
 
*** je kunt inloggen met username en password
 
*** je kunt inloggen met username en password
 
*** of met de API-key
 
*** 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 [https://www.archimatetool.com/plugins/#jArchi jArchi – Scripting for Archi] voor verdere informatie
 
 
 
 
Configuratie voor scripting
 
 
* Edit &gt; Preferences &gt; 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
 

Huidige versie van 28 jul 2023 om 02:01


Download Archi. Voor Windows kun je kiezen voor de installeerbare versie of voor de portable versie

  • als je meerdere versies naast elkaar wilt gebruiken, 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[bewerken]

Voor het installeren van de plug-ins, volg de installatie instructies van de Archi website. Ga vervolgens 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
  • Ga naar Setup and Configuration

Zie voor de jArchi scripting plug-in de pagina Archi scripting

Configureren Archi[bewerken]

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 GEMMA repository
    • 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
    • Uitlijning op grid
      • Zorg ervoor dat de grid-size en de grootte voor nieuwe figuren veelvouden van elkaar zijn. Voor de GEMMA worden de onderstaande grid-size en figure size gebruikt:
      • Edit > Preferences > Diagram
      • Wijzig de default grid-size van 12 naar 10;
      • Edit > Preferences > General tab Appearance
      • Wijzig de default size for new ArchiMate figures van 120 bij 55 naar 130 bij 60;
    • Regeltje meer ruimte
      • Edit > Preferences > Appearance
      • 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

Configureren coArchi en Git[bewerken]

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?[bewerken]

Let op: de ArchiMate-repositories zijn verhuisd van GitLab naar GitHub.

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 ArchiMate repositories vind je bij GitHub onder de VNG-Realisatie organisatie
  • De GEMMA ArchiMate-repositories zijn publiek, dus voor iedereen toegankelijk
  • Heb je toegang nodig tot een andere repository, maak dan een een account bij GitHub en vraag om toegang
  • Als je een model met gemeenten wilt delen, gebruik dan ook GitHub.

Inloggen bij GitHub met Archi[bewerken]

Hier worden de verschillende opties beschreven hoe je met Archi kunt inloggen bij GitHub. Als je met de browser naar GitHub 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 GitHub 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 je een een SSH-key aan (optioneel)[bewerken]

Voor het aanmaken en installeren van een SSH-key, zie Connecting to GitHub with SSH

Tips voor het het werken met SSH-key:

  • gebruik de defaults
  • gebruik één key en wees hier zuinig op
  • 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 Windows

  • plaats deze key op je laptop op de default locatie met de default naam => voor Windows is dit
    c:\User\<username>\.ssh\id_rsa

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

Invullen login gegevens in Archi[bewerken]

Om te kunnen samenwerken aan architectuurmodellen, waaronder het GEMMA architectuurmodel in een repository op GitHub

  • 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
Deze pagina is het laatst bewerkt op 28 jul 2023 om 02:01.