JobScheduler Master Installation - 1 - Dialog Installation

1.1 Installation Using the Setup Program

The following archive files including installer are available:

• jobscheduler_linux-x64.[release].tar.gz for Linux 64-Bit
• jobscheduler_linux-x86.[release].tar.gz for Linux 32-Bit
• jobscheduler_windows-x64.[release].zip for Microsoft Windows 64-Bit 

• jobscheduler_windows-x86.[release].zip for Microsoft Windows 32-Bit

Unpack the archive in an arbitrary directory and change to the extracted directory ./jobscheduler.[release].

The installer can be started as a dialog or in batch mode (see Batch Installation. If you use the installer as a dialog on Unix then it will require an X-Server. Use Batch Installation if an X-Server is not available.

/tmp/jobscheduler.[release]> ./setup.sh

c\windows\Temp\jobscheduler.[release]>setup.cmd

The setup requires administrator privileges on Microsoft Windows. The setup opens a dialog for this on Microsoft Windows if necessary. On Unix a sudo prompt will be open. Don't log in as root on Unix but use sudo! 

Under Unix, root privileges are not required. If you want to install the JobScheduler without root privileges, then call:

/tmp/jobscheduler.[release]> ./setup.sh -u

The setup dialog starts with the selection of the language to be used in the setup. This is followed by a greeting, acceptance of the license conditions and the specification of two installation directories. The binaries and libraries are stored under the first path.The configuration and log files are stored under the second path.

For the rest of this documentation the first installation directory will be referred to as $SCHEDULER_HOME and the second as $SCHEDULER_DATA. Specification of the installation directories is followed by the Package Selection dialog.

The forms which are subsequently presented for the configuration of the JobScheduler depend on the packages which are selected for installation alongside the JobScheduler. Further details of the JobScheduler configuration are to be found in the Setup Forms section.

After selection of the required packages, the necessary files are copied into the installation directories. After this, the scripts that configure the installation packages are executed. The processing of the installation scripts run during the setup is logged. This log file is to be found in the folder $SCHEDULER_DATA/logs and is named Install_V[release]_[date][time]_[series number].log. 

JobScheduler Operations Center (JOC) can be accessed after the setup by entering the following URL in a web browser (Firefox , Microsoft Internet Explorer^®, Chrome^® are supported): http://localhost:[port] where [port] is the port specified for the JobScheduler instance during setup.

1.2 Licenses

The JobScheduler is available with a dual licensing model. The GNU GPL 2.0 license is available for Microsoft Windows and Linux.

If you choose the commercial license then an input field is shown to enter the license key. The license key will be written in the file $SCHEDULER_DATA/config/sos.ini. If you have problems with the license key you can continue with the installation and edit the $SCHEDULER_DATA/config/sos.ini later.

1.3 Installation Paths

The setup requires two paths. A sub-directory named with the JobScheduler ID will then be added to both these paths. The form for entering the JobScheduler ID will be described later on.

The Installation Path

The binaries and libraries are stored in this first path ($SCHEDULER_HOME).The default is:

•  /opt/sos-berlin.com/jobscheduler for Unix®. If you use the installer without root permissions then you must choose another folder (e.g. /home/[user]/sos-berlin.com/jobscheduler). 
• C:\Program Files\sos-berlin.com\jobscheduler for Microsoft® Windows®

The Configuration and Log File Path
 

The configuration and log files are stored in this second ($SCHEDULER_DATA) path. The default is:

• /home/[user]/sos-berlin.com/jobscheduler for Unix
• C:\ProgramData\sos-berlin.com\jobscheduler for Microsoft Windows Vista/2008/7
• C:\Documents and Settings\All Users\Application Data\sos-berlin.com\jobscheduler for Microsoft Windows XP/2003

1.4 Setup Packages

The following packages may be selected during setup:

• JobScheduler 
  • This is the basic package and must be installed. The package contains JobScheduler Operations Center (JOC) which is an Ajax based interface for monitoring and controlling the JobScheduler objects, such as Jobs, Job Chains and Orders. Further the package contains JobScheduler Object Editor (JOE) to create, edit and maintain the JobScheduler objects and JobScheduler Information Dashboard (JID), which provides an overview of the jobs planned and those that have successfully been completed. 
• Database Support 
  • This package must also be installed. MySql (5.x ++), Oracle Database (8.1.x, 9.2, 10g, 11g), Microsoft SQL Server (2000, 2005, 2012), PostgreSQL (8.x, 9.x), and SybaseASE 15.0. are supported. 
• Housekeeping Jobs 
  • Housekeeping Jobs are automatically carried out by the JobScheduler, for example, re-sending temporarily stored protocol mails after a mail server failure; deleting temporary files or restarting the JobScheduler automatically. In addition, the Housekeeping Jobs package enables the JobScheduler to be configured as an event handler.

Package selection is made using the following dialog form:

1.5 Setup Forms

The number of forms shown during setup depends on the packages which have been chosen for installation.

1.5.1 The Basic JobScheduler Forms

• The JobScheduler ID

  • The JobScheduler ID is entered in the JobScheduler ID input box. Omit special characters like  / \ : ; * ? ! $ % & " < > ( ) | ^
  • The ID is used on Microsoft Windows for the name of the JobScheduler service after setup. The service name has the syntax sos_scheduler_[scheduler_id].
  • The JobScheduler ID must be unique over all installed JobSchedulers (except you want to build a cluster). 
  • Further, the JobScheduler ID expands both installation paths as a sub-directory.

• The JobScheduler Host and Ports

  • The JobScheduler Host is used for TCP and HTTP/HTTPS communication with the JobScheduler e.g. for JOC and for the JobScheduler Web Services.
    • The JobScheduler Port is used for TCP communication with the JobScheduler i.e. for JOC.
    • The JobScheduler HTTP Port is used HTTP and HTTPS communication by the JobScheduler Web Services. 

      • This port must be unique for each JobScheduler Master being operated standalone or as a cluster member. 

      • The See also the How to operate JobScheduler with Jetty article for more details about Jetty. 

• The Allowed Host 

  • This field is required as a security feature of the JobScheduler, whereby communication can be restricted to particular computers. This is explained in more detail in the JobScheduler allowed_host documentation.
  • The Port and the Allowed Host entries are also written to the $SCHEDULER_DATA/config/scheduler.xml file.
• The JobScheduler ID is written to the $SCHEDULER_HOME/bin/jobscheduler_environment_variables.(cmd|sh) file.
• The ports for Jetty / the Web Services is written to the JobScheduler database $SCHEDULER_DATA/config/jetty.xml file. The configuration files can be changed manually later on.

The SMTP Server is specified here along the mail sender, recipient and if required CC und BCC. Multiple addresses are to be separated by commas.

The values entered here configure the $SCHEDULER_DATA/config/factory.ini file, which can also be changed manually later on.

Specify information regarding whether the JobScheduler should automatically forward job log files by e-mail. 

The entries made using this form are saved in the $SCHEDULER_DATA/config/factory.ini file, which can also be changed manually later on.

The lower part is only shown when the housekeeping package was selected. It enables the JobScheduler to be configured as an event handler. Corresponding objects will be created in $SCHEDULER_DATA /config/live/sos/events respectively. This is explained in more detail in the Events documentation.

1.5.2 The Database Support Package Forms

The following forms are only shown when the Database Support package was selected.

The radio buttons in the form shown above determine whether the JobScheduler should be installed "stand-alone" or in a backup system or a load balancing cluster (see also JobScheduler Master Installation - 10 - Installation of a Cluster. Further information about Backup Cluster can be found here, about Load Balancing look here. You can change the cluster option later (see here).

The database system is specified in the upper selection on this form. It is recommended that the box in the center of the form is checked, so that a script which creates and fills the necessary database tables can be executed. Alternatively, the tables can be be changed manually later on (page 28). If you have already installed another JobScheduler with the same database connection then abandon this option.

The database connection information is specified in the input fields. The middle part where you can choose the provided jTDS JDBC® driver is only shown for Sybase and Microsoft® SQL Server. If you selected MySql® then you get a checkbox for alternatively use of the MariaDB® JDBC® driver. If the jTDS JDBC® driver or the MariaDB® JDBC® driver is unchecked then you must enter your own JDBC® driver in a next dialog. This configuration is saved in the $SCHEDULER_DATA/config/factory.ini, $SCHEDULER_DATA/config/hibernate.cfg.xml and $SCHEDULER_DATA/config/sos_settings.ini files. All files can be changed manually if required.

This dialog form is offer for:

• ... IBM® DB2. 
• ... MySql® and you have unchecked the MariaDB® JDBC® driver for MySql® databases. 
• ... Microsoft® SQL Server or Sybase and you have unchecked the jTDS JDBC® driver for Sybase and Microsoft® SQL Server databases.

The script for the creation of the database tables is started by the setup program and requires a JDBC® driver appropriate to the database system being used. The drivers for Oracle® Database and PostgreSQL are included in the setup. However, the relevant IBM® DB2, MySql®, Sybase and Microsoft® SQL Server JDBC® driver must be manually specified here. Note that for Microsoft® SQL Server and Sybase databases the jTDS JDBC® driver and for MySql® the MariaDB® JDBC® driver that is delivered as part of the JobScheduler setup can be used when the appropriate checkbox in the previous form is activated. For IBM® DB2 you have to provide a license file for the driver too. As this driver will also be required by the JobScheduler later on, it is copied by the setup into the $SCHEDULER_HOME /lib/user_lib folder.

1.5.3 The Reporting Database

Reporting information can be stored in the same database as used by the JobScheduler Master or in a a separate one. The check list for for specifying a DBMS for the reporting database will only be shown if the JobScheduler and Reporting Databases are the same box is unchecked. 

If a separate reporting database is to be used a second step for the Reporting database will follow in which the database connection for for this database will be specified. The configuration information entered in this step is identical to that specified for the JobScheduler Database Connection at Step 13.