Setting up the Eclipse Environment - archimatetool/archi GitHub Wiki

Eclipse Environment

Archi is built upon the Eclipse Rich Client Platform (RCP) and is also developed using the Eclipse Integrated Development Environment (IDE). This section deals with setting up the Eclipse IDE ready for development.

Eclipse requires a Java JDK

Eclipse runs on top of Java so you need to ensure that you have installed a Java Development Kit (JDK). Some Eclipse distributions contain a bundled JDK so you don't need to do this.

Archi itself is targeted toward JDK 17.

Download Eclipse

Download the Eclipse IDE from Eclipse Downloads. Ensure that you download a package that is correct for your OS and includes the Git client and support for Eclipse plug-in and RCP (Rich Client Platform) development.

The variety of Eclipse packages available can be confusing. You need a package that supports both Java and RCP (Rich Client Platform) development. If you're not sure, choose the Eclipse for RCP and RAP Developers package.

[!TIP] I find that the Eclipse packages linked above are not really suited to my needs. I download the basic Eclipse SDK and manually add the Git and EMF SDK plug-ins as described below.

Setting up Eclipse

  • Extract the Eclipse IDE files somewhere on your development machine. This will create an "eclipse" folder (Or an "Eclipse" app on Mac)
  • Launch Eclipse from the "eclipse" executable file, or "Eclipse" app on Mac
  • You will be asked to select a "Workspace". If you're not sure, select the default and check "Use this as the default and do not ask again"
  • Dismiss the Welcome Screen
  • Set up Eclipse just how you would like to work with it.

[!IMPORTANT] Ensure that you set Eclipse to use the JDK installed on your system, otherwise you won't be able to debug Java code. Set this up in Preferences, Java, Installed JREs and add the JDK.

Note - Archi is targeted for JDK 17.

Adding additional plug-ins (manual setup)

You might want to set up your Eclipse installation with more Eclipse plug-ins. Some Eclipse packages don't include Git or EMF SDK integration. If this is the case you can add more plug-ins to your Eclipse IDE.

You can add these plug-ins from within Eclipse itself:

  1. Choose Help-->Install New Software... to invoke the wizard
  2. In the "Work with" combo box select 2024-12 - https://download.eclipse.org/releases/2024-12 (this date might be different)
  3. Wait for the dialog list to populate (You will see a "Pending..." message. Sometimes this can take a long time...) 2019-09
  4. From the list under "Collaboration" select "Git integration for Eclipse"
  5. From the list under "Modeling" select "EMF - Eclipse Modeling Framework SDK"
  6. Click "Next" and Accept all terms to Finish the wizard.
  7. The plug-ins should then be installed and you will need to restart Eclipse

Next steps

Now you are ready to move onto the next stage, Importing the Code.