Eclipse Quickstart Guide

Download and minimal setup

  1. Download a ready-to-use Eclipse installation from http://merkur24.inf.uni-konstanz.de/knime/eclipse/
  2. Unpack to the location of your choice
  3. Start Eclipse
  4. Open Window Preferences Team SVN and just open the dialog page - this makes sure that the password prompt opens in the next step
    • if you see a huge error message, ignore and select "SVNKit (Pure Java)..." in the dialog (ask Thorsten for details).
  5. Open File Open Component Query and enter http://www.knime.org/KNIME.cquery
    • Specify org.knime.config as component name and optionally a version
    • Click Resolve to wizard (you need to enter your SVN credentials)
    • Hit Next, then hit Finish
  6. If you get error messages in the console about Resource '.buckminster/tp' is not local restart Eclipse once with -refresh as command line argument
  7. Open Window ⇒ Preferences ⇒ Plug-in Development ⇒ Target Platform
    • Edit... the "Buckminster Default TP"
    • Add... a new Software Site in the Locations tab
    • Enter https://jenkins.knime.org/download/trunk/ as URL for the software site (change "trunk" to "branches/v_x_y" if you want to work on a branch instead of the trunk) and select the feature you want to work with. Select at least "KNIME Core".
    • Make sure the checkbox for Include required software at the bottom in selected. Optionally include the sources if you want to browse them.
    • Finish
    • You can Update any software site in order to get the latest version from the nightly builds.
  8. Open another CQUERY using the link from above
    • Enter the plug-in or feature as component name you want to develop on
    • Click Resolve to wizard (you need to enter your SVN credentials)
    • Hit Next, then hit Finish
    • This will materialize all plug-ins (and features) into your workspace. You can (but do not need to) delete almost all of them afterwards if they are already part of the target platform (such as org.knime.workbench.*). This speeds workspace building.
  9. Eclipse will complain about missing Baselines when the new workspace is compiled
    • Either get the current baseline (from https://jenkins.knime.org/jobs/org.knime.update.org-trunk/workspace/, take the Baseline_Desktop_*.zip), extract it somewhere and go to Window ⇒ Preferences ⇒ Plug-in Development ⇒ API Baselines and add the directory as Baseline (name doesn't matter), or
    • Go to Window ⇒ Preferences ⇒ Plug-in Development ⇒ API Baselines and change "Missing API baseline" from Error to Warning
  10. When creating the run configuration make sure you select "Run a product" in the Main tab and select org.knime.product.KNIME_PRODUCT. In the Plug-ins tab change "Launch with" to "plug-ins select below". You may still select all plug-ins (for convenience) but make sure that for org.eclipse.swt.ws.os.arch only the one with version number >= 3.102 is selected!

Additional features

Additional feature can be fetched using a component query (File ⇒ Open Component Query) or by modifying the target platform (Window ⇒ Preferences ⇒ Plug-in Development ⇒ Target Platform).

Common components:

  • com.knime.update.server for the server space
  • com.knime.update.teamspace for the team space, and
  • org.knime.update.labs gets the labs plugins,
  • org.knime.update.org gets the entire current code package that's released,
  • The UnitTests for KNIME Desktop can be retrieved using
    • org.knime.base.testing and
    • org.knime.core.testing

Note that e.g. students don't have access to the commercial extensions such as the server connector. They must to add it via the target platform.

  • Other interesting component queries
    • com.ggasoftware.indigo.knime.feature for the Indigo nodes
    • org.knime.knip.feature for the Image Processing nodes
    • org.knime.features.network for the network nodes
    • org.knime.features.network.exp for the experimental network nodes
    • org.knime.features.ext.textprocessing for the textmining nodes
    • org.knime.features.ext.lucene for the indexing and searching nodes
  • If you want to checkout from a branch and not the trunk select the second page of the Component Query and:
    • (make sure to have org.knime.binary.jre checked out from trunk if you are using a custom branch)
    • select the top entry in the left list (the selection "pattern")
    • then click Selection Criteria and enter the branch name in Branch/Tag path (without branches or tags, e.g. simply v_2_5_Desktop)

Starting KNIME

  • Create a new launch configuration for an Eclipse Application
  • Select to run the product (not application!) org.knime.product.KNIME_PRODUCT
  • Adjust the JVM settings to something like
  -Xms40m -Xmx2048m -XX:MaxPermSize=192m -ea  -Dosgi.classloader.lock=classname  -XX:+UnlockDiagnosticVMOptions  -XX:+UnsyncloadClass   -Dknime.enable.fastload=true
LinkedInTwitterShare