Servoy Developer 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:
...
Warning | ||
---|---|---|
| ||
These instructions are for trunk and any future branches, but are not relevant for the Servoy 5.2 branch. For instructions how to setup for Servoy 5.2 development, see Setting Up (Servoy 5.2 branch only) |
Stoc |
---|
...
...
...
...
...
...
...
...
...
...
...
...
...
The easiest setup will be when both Servoy Developer and Eclipse operate either under 32 or 64 bit.
Servoy Developer: When installing Servoy Developer, the installer will automatically detect if it's being operated under a 32 or 64 bit Java Virtual Machine and will install a 32 or 64 bit version of Servoy accordingly. By making a certain JVM the default JVM before launching the cross platform Servoy installer or launching the cross platform Servoy installer using a specific JVM, one can control if the installer will install a 32 or 64 bit version of Servoy.
Eclipse: When downloading Eclipse distributions, there are specific downloads available for 32 or 64 bit systems. Note that for Windows, only limited Eclipse distributions offer a download for 64 bit Windows.
When mixing 32 and 64 bit, more configuration is required. This will be discussed under Configuration > Setup the Target Platform.
...
An installation of Servoy Developer is required in order to be able to launch Servoy Developer from source code, because the source depends on the directory structure that is present in a Servoy Developer installation.
The installer for Servoy Developer can be downloaded after login in at http://www.servoy.com/download. Running Running the installer will install Servoy Developer. For a more indepth description of installing Servoy Developer, see Installing Servoy DeveloperAfter installation, start Servoy Developer and install the SQL Explorer plugin and close Servoy developer again. See SQL Explorer integration for more information Download & Install Servoy Developer.
...
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 (PDE) installed is required.
The Eclipse.org download page (http://www.eclipse.org/downloads/) lists a wide range of prepackaged Eclipse distributions. See [http://www.eclipse.org/downloads/packages/compare-packages|http://www.eclipse.org/downloads/packages/compare-packages] for for the overview of what each Eclipse distribution contains.
One of the offered distributions that includes PDE is the Eclipse Classic distribution. Although the plugin development tools can be installed in any Eclipse environment, the easiest is to download the 'Eclipse Classic' distribution and install it.
NOTE: if you want to run the Servoy mobile client, then you also need to install the Google plugin for Eclipse from https://developers.google.com/eclipse/docs/download
Start the downloaded and installed Eclipse installation and choose or create a workspace in which the development on the open source projects of Servoy will take place.
After startup, 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 Developer 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:source:
Install the "egit" eclipse plugin
Open the
...
Checkout the Servoy projects:
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:
...
To check if Eclipse/Servoy Developer runs on a 32 or 64 bit JVM follow the following steps:
...
GIT Perspective: Window > Open Perspective > Other >
...
If the SVN Repository Exploring perspective is not available, most likely there is no SVN Team Provider installed. For more information on installing an SVN Team Provider see SVN Team Provider
...
GIT
Use the GIT Repositories view to clone the open source Servoy projects (latest 7xx branch) from the repositories at https://github.com/Servoy/
Info |
---|
Make sure to enable the checkbox "check out projects when clone is complete" in the GIT clone wizard |
Download Servoy Server libraries
In order to also be able to start debug clients from Servoy Developer launched from the source code, it is required to use the correct version of several libraries of the Servoy Application Server. The latest version of these libraries can be downloaded from the Servoy build server, located at http://build.servoy.com:8080/latest. Download all the libraries from the subdirectory for a specific branch or for trunk who's name postfix matched the value of the releaseNumber variable in the ClientVersion class of the checked-out source code and place them in the 'libs_extra' directory of the 'eclipse_target' project
Download Servoy Server plugin for running mobile
Please download the latest version of the mobile and mobileservice plugins; these can also be downloaded from the Servoy build server, located at http://build.servoy.com:8080/latest. Download the plugins from the subdirectory for trunk (currently) who's name postfix matches the value of the releaseNumber variable in the ClientVersion class. Copy these over to the the {servoyInstall}/application_server/plugins
directory without the postfix (overwrite existing mobile and mobileservice plugins if needed).
Setup the Target Platform:
...
...
...
...
Creating a Launch Configuration: Last step in the setup of the environment is the creation of a Launch Configuration. The checked out open source Servoy projects already contain a pre-configured Launch Configuration:
Note | ||
---|---|---|
| ||
When starting Servoy Developer from source code, it is most likely that a notification is shown indicating that the Servoy Application Server version should be upgraded. This message can be canceled and ignored. |
When starting a debug session, Servoy Developer will launch with settings of the Launch Configuration. By default , the workspace for example the workspace that is opened is set to '/workspace', relative to the Servoy Developer installation.
To edit the launch settings, open Run > Debug Configurations > Eclipse Application > Servoy Launch and edit the settings.
Ready: After completing the steps described above, the Eclipse installation is setup correctly to launch Servoy Developer in a debug session:
*Adding other features to the target: *If additional features are required in the Servoy Developer that is launched from source code, for example an SVN Team Provider plugin, an easy way to achieve this is by adding the feature(s) to the target Definition.
{servoyInstall}/developer
is the directory to point to.{myEclipseWorkspace}/servoy_mobile/war