Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

Where [release] is the JobScheduler version number.

Unpack the archive in into 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 you will require an X-Server. Use Batch Installation if an X-Server is not available.

To start the installer enter the following in a terminal window:

Code Block
languagetext
titleExample: Start Installer on Unix®
/tmp/jobscheduler.[release]> ./setup.sh

...


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

...

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 the two installation directories that are required. The binaries and libraries are stored under the first pathdirectory.The configuration and log files are stored under the second path.

For the rest of this installation guide the first installation directory will be referred to as $SCHEDULER_HOME and the second as $SCHEDULER_DATA.

...

The JOC Cockpit interface has to be installed separately to the JobScheduler. After both have been installed the JobScheduler can be accessed after the setup by entering the following URL in a web browser (Firefox , Microsoft Microsoft Edge® & Internet Explorer®, Chrome® are supported): 

...

Installation Paths

The setup requires the paths to two pathsdirectories. A sub-directory named with the JobScheduler ID will then be added to both these pathsdirectories later in the installation procedure. The JobScheduler ID will be entered later on.

...

The binaries and libraries are stored in this first pathdirectory, which will be referred to as $SCHEDULER_HOME in the rest of this installation guide. The default values for paths to this path directory are:

...

The configuration and log files are stored in this second pathdirectory, which will be referred to as $SCHEDULER_DATA in the rest of this installation guide. The default values for paths to this path directory are:

Anchor
setup-packages
setup-packages

...

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

...

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

...

  • The JobScheduler ID

    • The JobScheduler ID is entered in the JobScheduler ID input box. Omit Avoid special characters such as  / \ : ; * ? ! $ % & " < > ( ) | ^
    • The ID is used on Microsoft Windows as the name of the JobScheduler service after setup. The service name has will have the syntax sos_scheduler_[scheduler_id].
    • The JobScheduler ID must be unique over all installed JobSchedulers. (Unless you are building a cluster, in which case all JobScheduler Masters have the same ID. See JobScheduler Master Installation - 10 - Cluster Installation for more information.)
    • In addition, the JobScheduler ID is used as a subdirectory name in the both the $SCHEDULER_HOME and $SCHEDULER_DATA installation paths.
    • The JobScheduler ID is written to the $SCHEDULER_HOME/bin/jobscheduler_environment_variables.(cmd|sh) file and can be changed manually later on.
  • The JobScheduler Host and Ports

    • The JobScheduler Host is used for TCP and HTTP/HTTPS communication to send operating information for JOC and 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 for HTTP and HTTPS communication by the JobScheduler Web Services. 
      • This port must be unique for each JobScheduler Master being operated either standalone or as a cluster member. 

    • The Host and Port entries are written to the $SCHEDULER_DATA/config/scheduler.xml file and can be changed manually later on.
  • The Allowed Host 

    • This field is required as a security feature of the JobScheduler, whereby communication can be restricted to particular computers. This feature is explained in more detail in the JobScheduler allowed_host documentation.
    • The Allowed Host entry is also written to the $SCHEDULER_DATA/config/scheduler.xml file and can be changed manually later on.

...

The SMTP Server is specified here in this form, along the mail sender, recipient and CC und and BCC recipients if required. Multiple addresses are possible and should be separated by commas.

...

 Mail Notification & Event Handling

Specify This form is used to specify the conditions under which the JobScheduler should automatically forward job log files by e-mail. 

...

The lower part of this form is only shown when the Housekeeping Package was selected in the Setup Packages form and is used to specify whether the JobScheduler is to be configured as an event handler. Relevant objects will be created in $SCHEDULER_DATA /config/live/sos/events folder. This is explained in more detail in the Events documentation.

Note that the JobScheduler can alternatively be integrated with a system monitor that can be used to send notifications - see the Monitoring article for more information.

Anchor
database-forms
database-forms

...

...

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

The JobScheduler Database Connection

The database access parameters for the JobScheduler database are specified in the upper part of the this form. These are  The database connection configuration is saved in the three locations: 

  • $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.ini file, which can also be changed manually later on.

The DBMS driver to be used is specified in the middle part of the form:

  • The jTDS JDBC® driver delivered with the JobScheduler is only shown for as an option when Sybase® and or Microsoft SQL Server® DBMSs have been specified.
  • If you selected MySql® have specified a MySql® DBMS then you will get a checkbox for alternatively specifying whether you want to use of the MariaDB® JDBC® driver provided with the JobScheduler
  • If you do not check the jTDS JDBC® or the MariaDB JDBC driver drivers then you must enter your own JDBC® driver in a later the form shown below

The database connection 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 offered for:

  • ... IBM® DB2. 
  • ... MySql® when Use the MariaDB® JDBC® driver for MySql® databases was not checked. 
  • ... Microsoft® SQL Server or Sybase when Use the jTDS JDBC® JDBC® driver for Sybase and Microsoft® Microsoft® SQL Server databases was not checked.

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. See the  partt  part of this installation guide for information about the database driver required by the JobScheduler Master. The drivers for Oracle® Database and PostgreSQL are included in the setup. However, the relevant IBM® IBM® DB2, MySql®, Sybase and Microsoft® SQL Server JDBC® JDBC® driver must be manually specified here. Note that for Microsoft® Microsoft® SQL Server and Sybase databases the jTDS JDBC® JDBC® driver and for MySql® the MariaDB® JDBC® 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 was activated. For IBM®

Note that 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.

...

Reporting information can be stored in the same database and DBMS as used by the JobScheduler Master, which was configured in the steps described above, or in a separate one. This is specified separate database, possibly using another DBMS.

Unchecking the JobScheduler and Reporting Databases are the same box in the form shown below . The check list for specifying a DBMS shown in the form and the subsequent configuration forms will only be shown if the JobScheduler and Reporting Databases are the same box is uncheckedwill allow the fields for configuring a separate reporting database to be shown

If a separate reporting database is to be used then a second form for the Reporting database will be shown in which the database connection for the Reporting Database will be specified. The configuration information entered in this step is identical to that already specified for the JobScheduler Database Connection and need not be repeated here. (See above.)