Scope

• The libsosperlscript.so library is included with the JobScheduler setup and acts as an interface to a local Perl installation should Perl API Jobs be used.

  • This library is used exclusively for job scripts of type <script language="perlscript">, i.e. for jobs that make use of the JobScheduler API. 
  • This library is not required for Perl scripts that can be executed from the command line independently of a JobScheduler instance.
  • The library in the JobScheduler setup only works if you use the JobScheduler API without additional Perl modules. See also

    Jira
    server SOS JIRA serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1576

Prerequisites

Git

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

Anchor
java java

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.

Perl (for Linux platforms)

JDK

• The path to your Java JDK is required for the compilation

• SOS uses the path /usr/java/jdk1.8.0_31

Perl

• Version: Perl 5.10 or abovePerl 5.10 or above (SOS uses Perl 5.18).
• You can find the downloads here.
• No further configuration is required for Perl. 

Strawberry Perl (for Windows platforms)

• 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.

Anchor
cpp-compiler cpp-compiler

C++ Compiler

• Set up a development environment for Linux and Windows.
• For Windows it is recomended to use Visual Studio, which brings a C++ compiler. Find the download here.
For Linux you need the following packagesUnix. The following packages are required:
• gcc - GNU Compiler, starting with version 4.1.3
• zlib-devel
• binutils (version corresponding to gcc)
• SOS uses Visual Studio Express 2010 for Windows platforms gcc 4.4.6

Download from the

Repositories

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

Repository for the JobScheduler Engine

Execute the following command in your Git your Git Shell:

Code Block
language bash
git clone git@githubhttps://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 (for Windows).

Repository for

Compile the

Library

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 ShellOnce the folder scheduler-engine is created (from cloning the repositories), change the working directory to scheduler-engine/engine-kernelcpp and create a folder LINKS:

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

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

engine/engine-kernelcpp
mkdir LINKS

Switch to the folder LINKS and create a symbolic link to your Perl installation as follows:

cd 

LINKS
ln -

s 

git checkout --branch v1.9.2
git submodule foreach "git checkout --branch 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:

• • ojdbc6
  • webdavclient4j-core
  • hostware (or use the version from an existing JobScheduler (x86) installation)

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 C:\MY_GIT_REPOS\scheduler-engine-doc\ or /home/MY_ACCOUNT/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. If these tests are not relevant for you, compile it the following way: mvn clean install -DskipTests.

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:

• Windows
  • For x64 versions, add the following profile to the Maven commands below: -Pwindows-x64
  • For x86 versions, add the following profile to the Maven commands below: -Pwindows-x86
• Unix
  • For x64 versions, add the following profile to the Maven commands below: -Plinux-x64
  • For x86 versions, add the following profile to the Maven commands below: -Plinux-x86
    

Compile the JobScheduler Engine

Switch to the folder you have downloaded the scheduler-engine project to, which might look like C:\MY_GIT_REPOS\scheduler-engine\ or /home/MY_ACCOUNT/MY_GIT_REPOS/scheduler-engine/. 

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. If these tests are not relevant for you, 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 C:\MY_GIT_REPOS\all\ or /home/MY_ACCOUNT/MY_GIT_REPOS/all/. 

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. If these tests are not relevant for you, compile it the following way: mvn clean install -DskipTests.

/usr/lib64/perl5/5.10.0/x86_64-linux-thread-multi perl

In order to compile the last step is to call the makefile make-libsosperlscript:

JAVA_HOME=<path_to_java_jdk> make/make-libsosperlscript

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 or $HOME/.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
   1. • spidermonkey.dll
      • scheduler.exe
3. Linux-x64 in 
   1. ./scheduler-engine/engine-setup/target/setup/scheduler.linux-x64/bin
      • scheduler
      • setuid
   2. ./scheduler-engine/engine-setup/target/setup/scheduler.linux-x64/lib
   • • libjobscheduler-engine.so
4. Linux-x86 in 
   1. ./scheduler-engine/engine-setup/target/setup/scheduler.linux-x86/bin
      • javavscript
      • scheduler
      • setuid
   2. ./scheduler-engine/engine-setup/target/setup/scheduler.linux-x86/lib
   • • libjobscheduler-engine.so
     • libspidermonkey.so

Support 

Commercial License

If you purchased a Commercial License with the Service Request Support Option, then the build process will be supported assisted by our Support Team should you face any 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/Buiild Process Forum

Troubleshooting

Error: "

z_com.h:10:17: error: jni.h: No such file or directory"

Error: "make: *** No rule to make target '.../LINKS/perl/CORE/EXTERN.h', needed by `perl.o'.  Stop."

Installation

Error: "File zlib-xxx was not found"

• Copy the libsosperlscript.so into the ./lib directory of the JobScheduler installation.

• Create a symlink in the ./lib directory which points to the libperl.so of the Perl installation

  Code Block
  ln -s /usr/lib64/perl5/<Perl version>/x86_64-linux-thread-multi/CORE/libperl.so libperl.so

  See also How to program the JobScheduler API in Perl

• Set the PERL5LIB environment variable if you get the following error in the Perl API job

  Code Block
  COM-80020009 DISP_E_EXCEPTION [begin] [] [PERL-2 [[perl_parse() Can't locate strict.pm in @INC (you may need to install the strict module)

  The article How to program the JobScheduler API in Perl describes how to set the PERL5LIB environment variable. A JobScheduler restart is required.

• Please delete the files
  
  • ./lib/libstdc++.so.6.0.8
  • ./lib/libstdc++.so.6
  • ./lib/libgcc_s.so.1
  • ./lib/libgcc_s.so

  in the JobScheduler installation if you get the following error in the Perl API job

  Code Block
  dlopen("libsosperlscript.so"): /opt/sos-berlin.com/jobscheduler/jobscheduler.1.10_4110/lib/libstdc++.so.6: version `GLIBCXX_3.4.11' not found

  A JobScheduler restart is required.
  See also

  Jira
  server SOS JIRA serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-980