Wat de plugin doet

• 

  Bij opslaan werkt hij de werkversie bij

  Elke keer dat je een gekoppeld model in Archi opslaat, stuurt de plugin de wijzigingen naar de werkversie van het project. Op de achtergrond; Archi wacht er niet op.

• 

  Hij maakt geen versies

  De werkversie zien alleen beheerders. Een versie voor je stakeholders leg je vast in Architrium zelf: open het project en kies Vastleggen als versie.

• 

  Hij stuurt alleen wat veranderd is

  De eerste keer gaat het hele model mee, daarna alleen de wijzigingen.

• 

  Hij verliest niets

  Is er geen verbinding, dan probeert de plugin het later vanzelf opnieuw. De tooltip van de knop laat zien of de werkversie is bijgewerkt of achterloopt, en sinds wanneer.

Wat je nodig hebt

• 

  Archi 5

  Getest met Archi 5.10. Te downloaden van archimatetool.com.

• 

  Een account als beheerder

  Een account bij Architrium, als beheerder van een project.

• 

  Het plugin-bestand

  com.architrium.plugin-<versie>.jar. Zolang Architrium nog niet in productie is, is er nog geen openbare download: vraag het bestand aan via info@intimearchitecture.nl.

Installeren

Op elk platform is het hetzelfde: sluit Archi, zet het plugin-bestand in de map dropins van Archi, en start Archi opnieuw. Alleen de plek van die map verschilt. Bestaat de map nog niet, maak hem dan aan. Staat er een oudere versie van de plugin in, haal die dan eerst weg.

Windows

1. Sluit Archi.
2. Open de Verkenner, klik in de adresbalk, typ %APPDATA%\Archi en druk op Enter.
3. Open daar de map dropins, of maak hem aan als hij er niet is.
4. Kopieer het bestand com.architrium.plugin-<versie>.jar naar die map.
5. Start Archi.

De volledige map is C:\Users\<jouw naam>\AppData\Roaming\Archi\dropins.

macOS

1. Sluit Archi.
2. Kies in de Finder Ga → Ga naar map… (Shift + Command + G), typ ~/Library/Application Support/Archi en druk op Enter.
3. Open daar de map dropins, of maak hem aan als hij er niet is.
4. Kopieer het bestand com.architrium.plugin-<versie>.jar naar die map.
5. Start Archi.

Liever in Terminal?

mkdir -p ~/Library/Application\ Support/Archi/dropins
cp ~/Downloads/com.architrium.plugin-*.jar ~/Library/Application\ Support/Archi/dropins/

Linux

1. Sluit Archi.
2. Kopieer het plugin-bestand naar ~/.archi/dropins (zie de opdrachten hieronder).
3. Start Archi.

mkdir -p ~/.archi/dropins
cp ~/Downloads/com.architrium.plugin-*.jar ~/.archi/dropins/

.archi is een verborgen map in je thuismap.

Lukt het niet met de map in je gebruikersprofiel, dan kun je ook een map dropins maken naast de map plugins van de Archi-installatie zelf.

Is het gelukt? Dan staat er in Archi een menu Architrium in de menubalk en het Architrium-logo in de werkbalk.

Instellen

1. Eén keer: waar Architrium staat, en inloggen

1. Kies in Archi Architrium → Voorkeuren… en vul bij API-endpoint in: het API-adres van deze omgeving
2. Kies Architrium → Inloggen…. Je browser opent een pagina van Architrium; log daar zo nodig in en klik op Toestaan.

Je wachtwoord komt niet in Archi: de plugin krijgt een eigen sleutel voor deze computer. Je blijft ingelogd tot je uitlogt (Architrium → Uitloggen); in je account in Architrium zie je op welke computers Archi is ingelogd en trek je de toegang in.

2. Per model: de koppeling met een project

Samen aan een model: kies Architrium → Online project openen… en kies een project uit de lijst, of maak er een aan. De plugin beheert het bestand.

Een eigen bestand:

1. Open het model en kies Architrium → Koppeling van dit model… (of klik op het Architrium-logo in de werkbalk).
2. Vul de Project-id in (die staat bij het token, zie hieronder), en laat Werkversie in Architrium bijwerken bij elke keer opslaan aangevinkt. Ben je ingelogd, dan mag het token leeg blijven.
3. Sla het model op. De koppeling staat in het model zelf en reist met het bestand mee.

Je kunt meerdere modellen open hebben, elk gekoppeld aan een eigen project.

Liever niet inloggen? Dan werkt de plugin met een persoonlijk token per project. Vul bij de voorkeuren ook je gebruikersnaam in. Klik in Architrium bij het project op het sleutel-icoon (Mijn token genereren); het token wordt maar één keer getoond. Vul het in bij de koppeling van het model. Het token blijft alleen op jouw computer, versleuteld, en elke architect maakt zijn eigen.

Bestaat het project al, en heb je het model niet op deze computer? Kies in Archi Architrium → Model ophalen uit Architrium…, kies het project (of vul, als je niet bent ingelogd, de project-id en je token in), en kies waar het .archimate-bestand moet komen. Je krijgt een nieuw, al gekoppeld model met de werkversie. Het model komt terug zoals het vanuit Archi is verstuurd; alleen de afbeeldingen zelf zitten er niet in.

Samen aan één model werken? In een online project komt wat een collega doet vanzelf in je open model. Is het project aangemaakt met Delen bij opslaan, dan wijzig je alleen wat je zelf vergrendeld hebt: klik met de rechtermuisknop op het model, een map, een view of een element en kies Architrium: vergrendelen. Bij Vrij tegelijk bewerken gaat elke wijziging meteen mee, zonder opslaan en zonder vergrendelen. De modelboom en het venster Samenwerking laten zien wie welke view open heeft, wat er vergrendeld is en of de eigenaar nog verbonden is. Zonder verbinding is een online project alleen te bekijken, en een project dat zo is geopend, werk je niet meer bij vanuit een los bestand. Alles hierover staat in de handleiding.

Gebruiken

1. 

   Sla je model op in Archi

   De werkversie in Architrium wordt bijgewerkt.

2. 

   Bekijk de werkversie

   Open het project in Architrium; als beheerder zie je bovenaan in de versiekeuze Werkversie.

3. 

   Leg een versie vast

   Kies Vastleggen als versie zodra je stakeholders het mogen zien. Daarop geven zij feedback.

Feedback terugzien in Archi. Kies Architrium → Feedback tonen. Je ziet de feedback en verbetervoorstellen die open zijn of in behandeling, op het model waar je mee bezig bent, met het element of de view waar ze over gaan; dubbelklik om ernaartoe te gaan. Verversen haalt de lijst opnieuw op; je model wordt daarbij niet bijgewerkt. De status wijzig je in Architrium zelf.

Welk pakket heb je nodig? De werkversie bijwerken vanuit een eigen bestand kan met elk pakket. Feedback tonen kan vanaf Plus. Online project openen…, vergrendelen en het venster Samenwerking horen bij samenwerken in Archi en vragen Pro, van het pakket waaraan het project hangt en van elke architect die meewerkt. Kan iets niet met je pakket, dan zegt de plugin welk pakket nodig is.

Alle opdrachten van het menu Architrium en de rest van Architrium staan in de handleiding.

Wil je de werkversie bijwerken zonder iets te wijzigen, bijvoorbeeld direct na het koppelen? Kies Architrium → Werkversie nu bijwerken; heeft het model nog niet-opgeslagen wijzigingen, sla het dan eerst op. Wil je voor een model tijdelijk niet automatisch bijwerken, haal dan het vinkje weg in het koppelvenster (het Architrium-logo).

What the plugin does

• 

  Saving updates the working version

  Every time you save a linked model in Archi, the plugin sends the changes to the project's working version. In the background; Archi doesn't wait for it.

• 

  It doesn't create versions

  Only administrators can see the working version. You commit a version for your stakeholders in Architrium itself: open the project and choose Commit as version.

• 

  It only sends what changed

  The first time the whole model is sent, after that only the changes.

• 

  It doesn't lose anything

  If there is no connection, the plugin retries later by itself. The button's tooltip shows whether the working version is up to date or behind, and since when.

What you need

• 

  Archi 5

  Tested with Archi 5.10. Download it from archimatetool.com.

• 

  An administrator account

  An Architrium account, as an administrator of a project.

• 

  The plugin file

  com.architrium.plugin-<version>.jar. As long as Architrium is not in production yet, there is no public download yet: request the file at info@intimearchitecture.nl.

Installing

It's the same on every platform: close Archi, put the plugin file in Archi's dropins folder, and start Archi again. Only the location of that folder differs. If the folder doesn't exist yet, create it. If an older version of the plugin is in there, remove it first.

Windows

1. Close Archi.
2. Open File Explorer, click the address bar, type %APPDATA%\Archi and press Enter.
3. Open the dropins folder there, or create it if it isn't there.
4. Copy the file com.architrium.plugin-<version>.jar into that folder.
5. Start Archi.

The full folder is C:\Users\<your name>\AppData\Roaming\Archi\dropins.

macOS

1. Close Archi.
2. In the Finder choose Go → Go to Folder… (Shift + Command + G), type ~/Library/Application Support/Archi and press Enter.
3. Open the dropins folder there, or create it if it isn't there.
4. Copy the file com.architrium.plugin-<version>.jar into that folder.
5. Start Archi.

Prefer Terminal?

mkdir -p ~/Library/Application\ Support/Archi/dropins
cp ~/Downloads/com.architrium.plugin-*.jar ~/Library/Application\ Support/Archi/dropins/

Linux

1. Close Archi.
2. Copy the plugin file to ~/.archi/dropins (see the commands below).
3. Start Archi.

mkdir -p ~/.archi/dropins
cp ~/Downloads/com.architrium.plugin-*.jar ~/.archi/dropins/

.archi is a hidden folder in your home directory.

If the folder in your user profile doesn't work, you can also create a dropins folder next to the plugins folder of the Archi installation itself.

Did it work? Then Archi shows an Architrium menu in the menu bar and the Architrium logo in the toolbar.

Setting up

1. Once: where Architrium is, and logging in

1. In Archi choose Architrium → Voorkeuren… (preferences) and under API-endpoint enter: the API address of this environment
2. Choose Architrium → Inloggen… (log in). Your browser opens an Architrium page; log in there if needed and click Allow.

Your password never reaches Archi: the plugin gets a key of its own for this computer. You stay logged in until you log out (Architrium → Uitloggen); in your Architrium account you can see on which computers Archi is logged in and revoke the access.

2. Per model: the link to a project

Working on a model together: choose Architrium → Online project openen… (open an online project) and pick a project from the list, or create one. The plugin manages the file.

A file of your own:

1. Open the model and choose Architrium → Koppeling van dit model… (or click the Architrium logo in the toolbar).
2. Fill in the Project-id (shown with the token, see below), and leave the option to update the working version on every save ticked. If you are logged in, the token may stay empty.
3. Save the model. The link is stored in the model itself and travels with the file.

You can have several models open, each linked to its own project.

Rather not log in? Then the plugin works with a personal token per project. Also enter your username in the preferences. In Architrium, click the key icon for the project (Generate my token); the token is shown only once. Enter it in the model's link. The token stays on your computer only, encrypted, and every architect creates their own.

Does the project already exist, and is the model not on this computer? In Archi choose Architrium → Model ophalen uit Architrium… (fetch a model from Architrium), pick the project (or, if you are not logged in, fill in the project id and your token), and choose where the .archimate file should go. You get a new, already linked model with the working version. The model comes back as it was sent from Archi; only the images themselves are not included.

Working on one model together? In an online project, what a colleague does arrives in your open model by itself. If the project was created with Share on save, you only change what you have locked yourself: right-click the model, a folder, a view or an element and choose Architrium: vergrendelen (lock). With Edit freely together every change is sent at once, without saving and without locking. The model tree and the Samenwerking window show who has which view open, what is locked and whether the owner is still connected. Without a connection an online project can only be viewed, and a project opened this way can no longer be updated from a separate file. Everything about this is in the manual.

Using it

1. 

   Save your model in Archi

   The working version in Architrium is updated.

2. 

   View the working version

   Open the project in Architrium; as an administrator you'll see Working version at the top of the version list.

3. 

   Commit a version

   Choose Commit as version as soon as your stakeholders may see it. That is what they give feedback on.

Seeing feedback in Archi. Choose Architrium → Feedback tonen (show feedback). You see the feedback and proposals that are open or in progress on the model you're working on, with the element or view they are about; double-click to go there. Verversen (refresh) fetches the list again; your model is not updated by it. You change the status in Architrium itself.

Which plan do you need? Updating the working version from a file of your own works with every plan. Feedback tonen works from Plus. Online project openen…, locking and the Samenwerking window belong to working together in Archi and require Pro, for the plan the project is on and for every architect who takes part. If something isn't possible with your plan, the plugin says which plan is needed.

All commands of the Architrium menu and the rest of Architrium are in the manual.

Want to update the working version without changing anything, for example right after linking? Choose Architrium → Werkversie nu bijwerken (update the working version now; the plugin itself is in Dutch); if the model has unsaved changes, save it first. To stop updating automatically for a model for a while, untick the option in the link dialog (the Architrium logo).