Product Knowledge Base

Space shortcuts

Page tree

Scope

  • This documentation explains how to download and compile the sources for the JobScheduler Engine and all its components. 
    In case that you wanted to build exclusively YADE, see How to build YADE from the sources.
  • The sources have to be downloaded from the Git repositories. JobScheduler is available from https://github.com/sos-berlin
  • Additional tools will be referenced in this documentation if required to compile the sources.

Prerequisites

As mentioned above, additional tools have to be downloaded and configured following the below order:

Git

  • You can find the Git download and documentation here.
  • SOS uses Git 1.8.4. You can download the latest release from here.

Java

  • To compile individual JobScheduler releases, different Java versions are required:
    • SOS uses the 1.7.0.76 build of the Java JDK to build JobScheduler releases before 1.9.0.
    • SOS uses the 1.8.0.31 build of the Java JDK to build JobScheduler release 1.9.0 and above.
  • To compile for different target platforms (64-bit or 32-bit systems), the corresponding JDK versions are required:
    • To build the engine for a 64-bit system, the corresponding 64-bit version of JDK has to be used for compiling. Analogously for 32-bit compilation. 
    • The JDK version in use will define the correct C++ compiler properties. For example, if you are using a 64-bit JDK, even using Visual Studio Express (32-bit), a 64-bit JobScheduler version would be compiled.
  • To compile the scheduler-engine for the correct target platform:
    • check if the system variable %JAVA_HOME% is set to the installation path of you JDK installation.
    • check if %JAVA_HOME%\bin is in your %PATH% global variable.

Maven

  • You can find the Maven documentation here.
  • SOS uses Maven 3.2.1. You can download the latest Release from here.
  • Maven's \bin folder has to be added to the global variable PATH in order to take effect.
  • No further configuration is required for Maven in order to compile. If further configuration is wanted, for example to receive certain 3rd Party libraries from an official Maven2 repository, e.g. http://repo1.maven.org/maven2, then you have to configure the settings.xml file.

Strawberry Perl

  • Find the download here.
  • Perl 5.10 or above (SOS uses Perl 5.18)
  • Strawberry Perls' \bin folder has to be added to the global variable PATH in order to take effect.
  • Consider the comprehensive guide for Strawberry Perl in http://wiht.link/perl-resources

Cygwin

  • Find the download here. 
  • Cygwins' \bin folder has to be added to the global variable PATH" in order to take effect.
  • No further configuration is required for Cygwin. As well as for the JDK, to build the engine for a 64-bit system, the corresponding 64-bit version of Cygwin has to be used. Analogously for 32-bit compilation.

 

C++ Compiler

  • Set up a development environment for Windows. 
  • For instance Visual Studio, which brings a C++ compiler. Find the download here.
  • SOS uses Visual Studio Express 2010 for Windows platforms.

Download from the Source Repositories

Prepare a folder in your file system where you can clone the repositories to.

Repository for the JobScheduler Engine Documentation

Execute the following command in your Git Shell:

git clone git@github.com:sos-berlin/scheduler-engine-doc.git

to download the project "scheduler-engine-doc" into the folder or use a tool like, e.g. GitExtensions.

Repository for the JobScheduler Engine

Execute the following command in your Git Shell:

git clone git@github.com:sos-berlin/scheduler-engine.git

to download the project "scheduler-engine".

Repositories for the JobScheduler Components (JID, JOE, JITL, YADE)

Execute the following command in your Git Shell:

git clone --recursive git@github.com:sos-berlin/all.git

to download the aggregator project "all" and its submodules.

Hint

After you download the project "all" and all its submodules, the submodules are in a state called "detached Head", which means that references to the submodules point to a commit, which is not the latest in the current branch. To make sure to point to the latest commit of the current branch execute the following commands in your Git Shell:

git checkout origin/master
git submodule foreach "git checkout origin/master"

in which master is the name of the local branch and origin/master is the name of the remote branch with the latest development version of the components. Other available branches are e.g. release/1.9, release/1.8, release/1.7.

Downloading a released version

To be able to build an already released version, like the maintainance release 1.9.2, you have to check out the tag like that:

git checkout v1.9.2
git submodule foreach "git checkout v1.9.2"

 

Building the Projects

Preparation

Before you can start to build the projects you have to make sure that some required libraries are available for the build, which are not available from official public Maven repositories.

You can download the jar files and have to publish them to your local Maven repository in order to make these libraries available for the build.

The libraries to download are:

To publish these libraries to your local Maven repository ( %USERPROFILE%\.m2\ or $HOME/.m2/) use the goal install-file from the maven-install-plugin.

Command for ojdbc6:

mvn org.apache.maven.plugins:maven-install-plugin:2.3.1:install-file -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.1.0.7.0-Production -Dpackaging=jar -Dfile=<path-to-the-downloaded-library>/ojdbc6.jar -DlocalRepositoryPath=<path-to-your-local-maven-repository>

Command for webdavclient4j-core:

mvn org.apache.maven.plugins:maven-install-plugin:2.3.1:install-file -DgroupId=webdavclient4j -DartifactId=webdavclient4j-core -Dversion=0.92 -Dpackaging=jar -Dfile=<path-to-the-downloaded-library>/webdavclient4j-core-0.92.jar -DlocalRepositoryPath=<path-to-your-local-maven-repository>

Command for hostware:

mvn org.apache.maven.plugins:maven-install-plugin:2.3.1:install-file -DgroupId=sos -DartifactId=hostware -Dversion=1.0.0 -Dpackaging=jar -Dfile=<path-to-the-downloaded-library>/hostware-1.0.0.jar -DlocalRepositoryPath=<path-to-your-local-maven-repository>

The values for groupId, artifactId and version parameters in the above examples are those that are already defined in the build configuration. When publishing the libraries with these values, the libraries will be found in your local Maven repository and can be used without modifying the configuration.

Build order

Since the projects depend on each other, you have to make sure that the projects are built in the proper order:

  1. scheduler-engine-doc
  2. scheduler-engine
  3. all

Compile the JobScheduler Engine Documentation

Switch to the folder you have downloaded the scheduler-engine-doc project into, which might look like <PATH_TO_MY_GIT_REPOS>\scheduler-engine-doc.

Type mvn clean install on the command line for building the project including all internal tests - these are tests developed by SOS that check the functionalities of the compiled sources. To compile without the tests, compile it the following way: mvn clean install -DskipTests.

Environment Variable WINDOWS_NET_SDK_HOME

Before you start the compilation of the JobScheduler Engine, check if the environment variable WINDOWS_NET_SDK_HOME is set in your environment. In case it is not, set it with the value:

WINDOWS_NET_SDK_HOME = "%windir%\Microsoft.NET\Framework\<corresponding_version_folder>"

From .NET Framework version 4 on, the corresponding folder has the value v4.0.30319.

Decide the platform to build for

For the two compilations below it is required to indicate a profile to build the sources for the desired platform:

  • For x64 versions, add the following profile to the Maven commands below: mvn clean install -Pwindows-x64
  • For x86 versions, add the following profile to the Maven commands below: mvn clean install -Pwindows-x86

Compile the JobScheduler Engine

Switch to the folder you have downloaded the scheduler-engine project to, which might look like <PATH_TO_MY_GIT_REPOS>\scheduler-engine.

Type mvn clean install (and the profile) on the command line for building the project including all internal tests - these are tests developed by SOS that check the functionalities of the compiled sources. To compile without the tests, compile it the following way: mvn clean install -DskipTests.

Compile all JobScheduler Components (JID, JOE, JITL, YADE)

Switch to the folder you downloaded the all project to, which might look like <PATH_TO_MY_GIT_REPOS>\all\ or /home/MY_ACCOUNT/MY_GIT_REPOS/all/. 

Type mvn clean install (and the profile) on the command line for building the project including all internal tests - these are tests developed by SOS that check the functionalities of the compiled sources. To compile without the tests, compile it the following way: mvn clean install -DskipTests.


Compile YADE

In case you just wanted to compile YADE but not JobScheduler, then switch to the folder that you downloaded the all/jade project to, which might look like <PATH_TO_MY_GIT_REPOS>\all\jade

Type mvn clean install on the command line for building the project including all internal tests - these are tests developed by SOS that check the functionalities of the compiled sources. To compile without the tests, compile it the following way: mvn clean install -DskipTests.

You have to compile all three projects at least once before you can compile YADE on its own. This is required for the YADE build to be able to resolve its dependencies from your local maven repository.

Generated libraries location

After the build has completed you find all created .jar files in

  1. the target folder under each project and subproject.
  2. the local ./m2 repository in your home folder: %USERPROFILE%\.m2\repository\com\sos-berlin

At this point you already have all the library files to update an exisiting JobScheduler installation in your system.

You can find the specific libraries for the different platform in the target folder of the engine-setup:

  1. Windows-x64 in .\scheduler-engine\engine-setup\target\setup\scheduler.windows-x64\bin
      • jobscheduler-engine.dll
      • scheduler.exe
  2. Windows-x86 in .\scheduler-engine\engine-setup\target\setup\scheduler.windows-x86\bin
      • spidermonkey.dll
      • scheduler.exe

Support 

Commercial License

If you purchased a Commercial License with the Service Request Support Option, then the build process will be supported by our Support Team should you face problems. The applicable service level is the same as for severity level "minor", see Product Maintenance.

Open Source License

If you use the Open Source License then the build process will be supported by using our Community Resources. A forum for build issues is available at SourceForge, see https://sourceforge.net/p/jobscheduler/discussion/bp/

Note: no service levels are guaranteed including response times and resolution times.

Troubleshooting

Error: "cannot run program bash"

This error occurs when building on a Windows system where Cygwin is not available. The error log states "cannot run program bash" which is a Linux shell command and has to be executed by Cygwin when running on a Windows system. Please see cygwin explanations for resolving this problem.

Error: "MSB4019: Das importierte Projekt "C:\Program Files\MSBuild\Microsoft.Cpp\v4.0\V120\Microsoft.Cpp.Default.props" was not found"

This error occurs when a Java JDK 32-bit is installed on a 64-bit system, or when the global variable "JAVA_HOME" is either not set or not properly set. Please see Java explanations for resolving this problem.