Getting Started ‐ Setup - archimatetool/archi-modelrepository-plugin2 GitHub Wiki

Considerations before installing

  • coArchi2 is a complete re-write of coArchi 1 and is a separate plug-in
  • You can install coArchi 1 and coArchi2 together at the same time, but you will see duplicate panels and menus for both versions - the Collaboration Workspace, the Change History panel, and the Branches panel as well as the menu and toolbar items
  • You can either live with the duplication in the UI or you can uninstall coArchi 1 before installing coArchi2
  • Alternatively, you can create a standalone installation of Archi with coArchi2 installed locally
  • coArchi2 requires Archi 5.4 or later

Installation

[!Important] The binary plug-in is not yet widely available. We're doing internal testing first.

  • The plug-in is packaged as a coArchi2_x.x.x.archiplugin file which can be installed through Archi's "Help->Manage Plug-ins..." menu. For more information read this.
  • Alternatively you can create a stand-alone version of Archi with localised plug-ins as follows...

Creating a stand-alone installation of Archi and coArchi2

This is probably the best option for testing coArchi2 beta in isolation.

  1. Download the Windows Portable Zip version of Archi, the Linux version or the Mac version from here
  2. On Windows or Linux unzip the bundle into a separate folder that has write access
  3. On Mac extract the Archi app from the .dmg file to a different location than your working version of Archi for Mac

[!Important] Mac Users: before editing the Archi.ini file you need to run Archi at least once so that the app bundle can be verified. If you don't do this and edit the Archi.ini file and then run Archi an error message will appear advising you to move the Archi app to the trash. Alternatively run the following command from Terminal to clear the quarantine bit - xattr path_to/Archi.app -rc

  1. Locate the Archi.ini file. On Windows and Linux it is in the root folder of the Archi folder. On Mac it is inside the app bundle in the Archi.app/Contents/Eclipse folder. Note - you may have to enable file name extensions to see the full name Archi.ini.
  2. Open the Archi.ini file in a text editor and change the following lines so they have local "workspace", "config" and "dropins" (plug-ins) folder locations:

On Windows and Linux:

-Dosgi.instance.area=workspace
-Dosgi.configuration.area=config
-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=dropins

On Mac:

-Dosgi.instance.area=../workspace
-Dosgi.configuration.area=../config
-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=../dropins
  1. Launch Archi
  2. Install coArchi2 from the "Help->Manage Plug-ins..." menu. For more information read this.
  3. Restart Archi
  4. Now select "Reset Window Layout" from the main "Window" menu so that the coArchi panels are arranged correctly

Note that coArchi2 panels and actions are available from the toolbar and the "Collaboration" main menu.

Setting up Preferences

Before proceeding you should set up the preferences for coArchi2.

See Preferences for more information.