Setting up the development environment

Servoy is a plugin for the Eclipse platform, so to develop the Servoy codebase an Eclipse SDK environment with Eclipse Plugin development facilities is required.

In order to get started with development on one of the open source Servoy projects, the following is required:

1. A Servoy Developer installation, with the SQL Explorer plugin installed
2. A separate Eclipse environment with the Eclipse plugin development tools installed 
3. Configuration of the Eclipse installation

Installing Servoy Developer

The installer for Servoy Developer can be downloaded after login in at http://www.servoy.com/download. Running the installer will install Servoy Developer.

For a more indepth description of installing Servoy Developer, see Installing Servoy Developer|...|\

After installation, start Servoy Developer and install the SQL Explorer plugin. See [] for more information.

Installing Eclipse with the Eclipse plugin development tools

The open source Servoy projects are all plugins for the Eclipse environment, so in order to develop on one of the projects a Eclipse version with Eclipse plugin development tools installed is required.

The Eclipse.org download page (http://www.eclipse.org/downloads/) lists a wide range of prepackaged Eclipse distributions, one being the 'Eclipse for RPC/Plug-in Developers'. Although the plugin development tools can be installed in any Eclipse environment, the easiest is to download the 'Eclipse for RPC/Plug-in Developers' distribution and install it.

Configuration

Start the Eclipse installation and choose or create a workspace into which the development on open source projects of Servoy will take place.

The following configuration needs to be done:

Setup a variable: Go to Window > Preferences > Run/Debug > String Substitution and create a new variable named 'servoy_install' with the value of the directory where Servoy is installed.

Create a classpath variable: Go to Window > Preferences > Java > Build Path > Classpath Variables and create a new variable named 'WEBSTART' with the value of of javaws.jar in the Java installation.

Setup a connection to the Servoy SVN:

• Open the SVN Perspective: Window > Open Perspective > Other > SVN Repository Exploring
• Add a new Repository Location: File > New > Repository Location
  • Specify the URL 'https://subversion.servoy.com/product' and click 'Finish'
    
    

Checkout the Servoy projects:

• Expand the tree structure under the newly created Repository Location to the desired version to work on.
• Select all the projects
• Right-click one of the selected projects and select "Check Out" from the context menu
  

Setup the Target Platform: The Target Platform setting provides the Eclipse instance with information on the Servoy Developer installation, namely whether it's installed to run on a 32 or 64 bit Java virtual Machine (JVM). The checked out Servoy projects already contain the target setup files for different platform/JVM combinations:

1. Generic
2. Mac OSX
3. Mac OSX 64 bit
4. Windows 32 bit
5. Windows 64 bit
6. Linux
7. Linux 64 bit

• Switch to the Java Perspective: Window > Open Perspective > Java
• Expand to com.servoy.eclipse.core > target in the Package Explorer
• Open (double-click) the correct .target file:
  • when Eclipse and Servoy Developer both run on either a 32 or 64 bit JVM, open the generic.target file
  • otherwise, open the file that matches the Servoy Developer environment
• Click the 'Set as Target Platform'. This will setup the Target Platform correctly, after which projects will be build and should compile without error.

  To check if Eclipse/Servoy Developer runs on a 32 or 64 bit JVM follow the following steps:

  • Open Eclipse/Servoy Developer
  • Go to Help > About Eclipse/About Servoy Developer > Installation Details > Configuration tab and look for the text '-arch'.
  • If the text is followed by 'x86', Eclipse/Servoy Developer runs on 32 bit. If it is followed by 'x86_64', Eclipse/Servoy Developer runs on 64 bit