Project

General

Profile

AF3 Developer Installation with Oomph

FAQ

  • Question: Oomph installer cannot find update sites? (Problem occurred on Windows)
    Answer: Deactivate proxy servers.
  • Question: Launching AF3 causes SIGSEGV on Linux and kills Java VM within "libgdk-x11-2.0.so". What now?
    Answer: In your launch configuration, on the 'Environment' tab, add a new variable called 'SWT_GTK3' and set its value to '0'. JVM is linked against GTK2, therefore we need to tell the launcher not to use GTK3 with this setting.
  • Question: Rating files and git interaction seems very slow.
    Answer: Please ensure you completed step 1 of the installation instructions. If the environment variable HOME does not point to a local directory, heavy network traffic occurs that causes these performance issues.

Java Compiler Version 11

The AF3 source must be compiled using a Java compiler version 11. We recommend OpenJDK since we use it for building internally.

Notes
  • OpenJDK can be obtained from AdoptOpenJDK, a buildfarm sponsored by companies depending on Java.
  • Alternatively, you can also perform manual installation from the OpenJDK site.
  • You can use a 32 or 64-bit version of Java/Eclipse, but pay attention that running Eclipse in 32-bit mode requires a 32-bit Java and 64-bit Eclipse requires 64-bit Java.

Installation Procedure

  • Windows-only: Please ensure that the HOME variable is set (Keys: Windows + Pause -> Adjust settings -> Advanced -> Environment variables) or run this script to set the mentioned variable to the user's directory. It is read by the git implementation of eclipse. NOTE: If your user folder points to a network share, you will experience severe performance impacts, so choose a local folder instead!
  • Download the Eclipse Installer
  • Start the Eclipse installer and switch to Advanced Mode (upper-right symbol)
  • On the Product page select:
    • Eclipse Modeling Tools
    • Product Version: 2018-12
    • Java 1.8+ VM: <Select your JDK 11 Installation or leave the default>
    • Bundle Pool: <Select a location for the bundle pool or leave the default>
    • Select the Next button to go to the Project page
  • On the Project page:
    • Note: If you have a stale <user> entry from a previous installation, check mark it and remove it using the Red X icon right of the filter text field
    • Hit the Green Plus icon right of the filter text field
    • Select Eclipse Projects from the Catalog drop-down box
    • Save this setup file to your disk (right-click and select "Save Link As..."): af3.setup
    • Hit Browse File System... and locate the file You just saved
    • Select OK
    • There is now a new folder / category entry called <User> and the AutoFOCUS 3 (Developer) project below it
    • Check-mark the project and click Next
  • Depending on the state of your installer, you may need to install the unzip feature for the installer.
    The installer is relaunched afterwards and you have to reselect the AutoFOCUS 3 (Developer) project.
  • On the Product Variable page:
    • Check "Show all variables" at the bottom of this dialog page to see all options
    • Important: Ensure that the "Target Platform" is set to 2018-12
    • Customize the installation locations or accept the default (sub-folder to your user home)
    • Important for contributors: Enter your personal REST API key from the redmine page (this website):
      • Login to the current web page (top right), or register if you have not done so yet.
      • Open the My Account page (top right) in a new tab or browser window.
      • Click "Show" below the "API access key" header in the rightmost pane of the page.
      • Copy the key to the corresponding key field in the oomph installer (initialized with all 0s)
      • Keep "My Account" page open since you will need the key in a later setup step again.
  • Select Next
  • You see a list of tasks that will be executed. Just hit Finish.
  • You will be asked to confirm licenses.
  • Wait until the projects are fully built and the IDE has updated the package explorer icons (you should see gray, red, yellow or green code rating bullets in the top-left corner of each project icon).
  • NOTE: If there are build errors after the compilation, clean (ONLY) the plugin "org.fortiss.tooling.kernel" such that the pseudo-errors dissappear.
  • Next, one typically switches to the Java perspective by typing "Java" into the Quick Access" box in the top-right corner and clicking on the "Perspective" item in the list (Not the View!).

Note that You can clean your installation by deleting the installation root folder.
However, you might want to keep the bundle pool.

Starting AF3

Go to "Run > Run" or "Run > Debug" to start af3. You will be prompted to select a launch configuration. Select the one which matches your operating system and click ok.

Optional: Install external tools

  1. OCRA
    • Download OCRA (https://es-static.fbk.eu/tools/ocra/) and unzip it to a destination of your choice.
    • Add the path of your ocra executable to your PATH environment variable.
      • Mac & Linux: "sudo ln -s /<your path of executable>/ /usr/local/bin/ocra"
      • Windows: Press "Windows + Pause", "Change Settings", "Advanced", "Envrionment variables", and add to the PATH variable "C:\...<ocra DIR>\bin\win64" or "C:\...<ocra DIR>\bin\win32" for 32-bit installations.