Importing the Code

Pre-requisites

Before you import the code make sure you've set up your Eclipse environment as explained in Setting up the Eclipse Environment.


Importing the code from the Git repository

The Archi code is stored in a Git repository at GitHub. You need to import a copy of the code into your Eclipse workspace. The code consists of a number of plug-ins or "projects".

The (read-only) URI for the Archi Git repository is:

https://github.com/archimatetool/archi.git


Importing the code with the inbuilt EGit in Eclipse

  1. From within Eclipse choose "File -> Import..."

  2. In the wizard select "Git -> Projects from Git". Click "Next"

    Import 1

  3. Select "Clone URI" and then click "Next"

    Import 2

  4. Add the details for the repository's URI (see above) and then click "Next"

    Import 3

  5. Ensure that the "master" branch is selected (you can ignore any other branches if you like) and then click "Next"

    Import 4

  6. Choose a directory where you wish to store your local copy of the code and then click "Next"

    Import 5

  7. The code will be cloned and downloaded from the repository.

    This may take some time. When this is done, choose "Import existing projects" and then click "Next."

    Import 6

  8. Import all of the projects and then click "Finish"

    Import 7

  9. Your workspace should now contain all the projects (note - the actual projects may differ to those shown in this screenshot depending on how recent the code is):

    Workspace


You're not done yet! You'll see that the various projects have red crosses on them. We need to fix that in the next stage.

Next Steps

Now you are ready to move onto the next stage, Running and Debugging Archi.


Getting the code manually as an archive

Alternatively, you could get a snapshot of any committed version of Archi from the list of releases at the GitHub repository, select the required release, and then click on the "zip" or "tar.gz" link to download and un-archive it.

The plug-ins or "projects" are:

  • com.archimatetool.canvas - Canvas Modelling Toolkit
  • com.archimatetool.csv - CSV import/export
  • com.archimatetool.editor - The main Archi Editor
  • com.archimatetool.editor.browser - Browser plugin (not currently used)
  • com.archimatetool.editor.fullscreen.macos - Full-screen support for Mac OS X Lion
  • com.archimatetool.editor.launch.win32 - Launcher for Windows
  • com.archimatetool.export.svg - SVG Image export
  • com.archimatetool.help - Help, documentation and Hints
  • com.archimatetool.importexportexample - Plug-in example of import/export
  • com.archimatetool.jasperreports - Jasper Reports
  • com.archimatetool.jdom - JDOM XML Utils
  • com.archimatetool.model - EMF Ecore model
  • com.archimatetool.reports - Export HTML reports
  • com.archimatetool.templates - Support for model templates
  • com.archimatetool.widgets - GUI Widgets
  • com.archimatetool.zest - Zest Toolkit for the Visualiser
  • tests - Folder for JUnit tests projects
  • tools - Folder for tools projects

Once these projects are unarchived in your file system then you need to import these into Eclipse. We suggest that you work in Eclipse with the "Java Perspective" so that the "Package "Explorer" View is on the left.


Importing the projects into Eclipse

  1. Choose "File->Import..." from the main menu in Eclipse

  2. Select "General" and "Existing Projects into Workspace"

  3. Select the root folder containing the Archi Projects that you got from the Git repository

  4. Select all the Projects as listed above

  5. Click "Finish"


You should now see all of the Projects in the Project Explorer View.

Next Steps

Now you are ready to move onto the next stage, Running and Debugging Archi.