Clone wiki

org.openmarkov / First_download

WARNING: At this moment the development branch contains an unstable version of OpenMarkov, we are working to provide a stable version as soon as possible.

Downloading OpenMarkov's repositories

At this point, you are supposed to have a working IDE and Git in your computer; if not, go back and install them.

You have to download every repository you want to browse plus these two: org.openmarkov, which is like the front door of OpenMarkov; and org.openmarkov.full, which acts as the corridors to the other Maven repositories.

You can download all repositories with this script.

If you don't want to download all the repositories, simply delete them from the previous script. You have a list and a subproject tree to help you choose.

The script will clone from the development branch. Once over, import your local copy into your IDE. We explain how to do it for Eclipse and IntelliJ.

1a. Importing OpenMarkov into Eclipse

Open Eclipse and import the project (File > Import > Maven > Existing Maven Projects). Then select the /OpenMarkovMainFolder folder and click "Finish". You will see something like this:

Eclipse_window.png

As a final test, right click the OpenMarkov.java file and run it (Run > As Java Application).

1b. Importing OpenMarkov into IntelliJ

Open IntelliJ and select "Import project"¹. If you are already in the project view, you can import it by selecting "File > New > Project from existing sources". Select the folder that contains both git clones (/OpenMarkovMainFolder, in our case)². Choose "Maven" below the "Import project from external model" option.

Now, mark the following options:

  • Check the box "Search for projects recursively" because the repositories are not in the root folder, but in subfolders.
  • [Optional, but strongly recommended] Take into account that by default IntelliJ will save its auxiliary files in the same folder as the real project and you don't want that. To avoid it, check the box "Keep project files in..." and choose an auxiliary folder; for example, /OpenMarkovMainFolder/Idea_files or /OpenMarkovMainFolder/aux_files.
  • Check the box "Import Maven projects automatically" to download all the OpenMarkov subprojects. Click "Next".

Now you should see every repository you downloaded in the next window (here we only downloaded the essential two):

Both_projects.jpg

If that's not the case, check that git has downloaded both repositories and begin this section again.

Click "Next". If IntelliJ asks for an SDK (JDK), set its path as explained below. Alternatively, you can skip this step now and install it later.

And then the last window, name your project before clicking "finish".

Setting the path for the JDK

If IntelliJ is unable to locate your Java Development Kit (JDK, also known as SDK), it will ask you for its location. It will likely be in one of these folders:

  • Windows: Program Files/Java

  • Linux: /usr/lib/jvm/java-1.8.0-openjdk-amd64

Set it with the "+" button.

Setting the location of the repositories

Newest versions of IntelliJ do this automatically, so if you don't get this message skip this section. Older ones might show a message (on the right lower corner) complaining about invalid VCS mapping³. That is because OpenMarkov's code is not in the folder /OpenMarkovMainFolder itself, but in its subfolders.

Expand the message, click "Configure", mark the two OpenMarkov repositories shown, add them with the "+" button, and remove the /OpenMarkovMainFolder folder with the "-" button. The screen will look like this:

Setting the SVC folders.png

Close that window. Press Ctrl+E and choose "Maven Projects" in order to show the Maven hierarchy. You must see something like:

IntelliJ_window.png

As a final test, right click on the OpenMarkov.java file and click "Run".


Adding a new module to OpenMarkov

If the CISIAD added a new module (subproject) to OpenMarkov or you didn't download some of them and you want them now. Here is how to add a new module to a project (OpenMarkov in particular) in Eclipse and IntelliJ. By module, I refer only to CISIAD-approved modules, the ones in the cases stated before: - new OpenMarkov subprojects added by the CISIAD team or - subprojects of OpenMarkov that you didn't download in the first time. These subprojects are already integrated with Maven while a custom/external subproject will need Maven integration and that will not be covered here.

Download with Git

The first step is going to the OpenMarkov working directory and open there a terminal/Git Bash. Then clone the wished repositories using the git command:

git clone -b development http://bitbucket.org/cisiad/org.openmarkov.<modulename>

for every repository you want to add.

IntelliJ IDEA

To add a new module open File -> Project structure and navigate in the lateral menu to Modules. Now look for a + symbol in the top-left corner and click it. Choose "Import module". From here the steps the same as those of the first download. Those are:

1a. [Few modules] For every module: choose the folder that contains the module. Next. Choose "Maven" as external model. Next. Then accept the default options until you click Finish.

1b. [A lot of modules] In this case it is better to choose the folder that contains all subprojects (which is the OpenMarkov working directory). Next. Choose Maven as external model. Next. Now make sure the checkbox Search for projects recursively is checked. Next. And in the final screen, select only the subprojects that you wish to import (navigation through this list is easier using arrows and Spacebar to check/unckeck projects). Click Finish.

The subprojects will be added and automatically ordered in the package tree (you might need to click on them to actually see that).

Eclipse

Eclipse doesn't treat different projects from modules so the importing process is the same as in the first download, which is:

  1. Select File -> Import
  2. Choose Existing Maven Projects
  3. Select as root directory the OpenMarkov working directory
  4. Eclipse will recognize which subprojects are new and check only those, so clicking Finish get the things done.

  1. If it is the first time you open IntelliJ, it will ask you about installing plugins. You don't need to mark anyone as the default configuration is enough to run OpenMarkov.

  2. If Windows blocks you for any reason (for example, because it is unable to access the folder /OpenMarkovMainFolder) run IntelliJ as administrator.

  3. If you closed this message don't worry, it will reappear eventually.

Updated