2 - Batch Installation

Note that when the JobScheduler installation is started with a parameterized XML file, no dialog forms will appear.
The file scheduler_install.xml included in the extracted directory ./jobscheduler.[release] can be used for this purpose. You can start the setup as follows AFTER you have edited this file with the installation paths, host, port, database connection, etc..

Example: Start installer on Unix® with parameter file

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

Example: Start installer on Microsoft® Windows® with parameter file

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

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®, the root privileges are not required. If you want to install the JobScheduler without root privileges, then call:

Example: Start installer on Unix® without root privileges

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

This scheduler_install.xml mirrors all the values which can specified during a setup dialog. Please read the Installation Using the Setup Program in the previous chapter to get information about all the setup settings.

2.1 Licenses

The JobScheduler is available with a dual licensing model. The GNU GPL 2.0 license is available for Microsoft® Windows® and Linux®, otherwise the commercial license is required. In the following part of the scheduler_install.xml file you can choose the license model and enter the license key if necessary.

Example: License in scheduler_install.xml

<com.izforge.izpack.panels.UserInputPanel id="licences">

     <userInput>
     	<!-- Select the license model (GPL or Commercial) -->
             <entry key="licenceOptions" value="GPL"/>
 
     	<!-- If you selected GPL as license model than the licence must be empty. 
		     Otherwise please enter a license key if available. 
		     It is also possible to modify the license key later. -->
          <entry key="licence" value=""/>
 
     </userInput>

</com.izforge.izpack.panels.UserInputPanel>

Please read the Licenses section in the previous chapter for more information.

2.2 Installation Paths

You have to edit the following parts of the scheduler_install.xml file instead using the form in the dialog setup.

Example: $SCHEDULER_HOME in scheduler_install.xml

<com.izforge.izpack.panels.TargetPanel id="target">
 
     <!-- SELECT THE INSTALLATION PATH FOR THE BINARIES AND LIBRARIES 
          The installation expands this path with the JobScheduler ID as subdirectory. 
          The path must be absolute! 
          Default paths are: 
               /opt/sos-berlin.com/jobscheduler for Unix® 
               C:\Program Files\sos-berlin.com\jobscheduler for Microsoft® Windows® -->
     <installpath>[:choose absolute installation path of the JobScheduler:]</installpath>
 
</com.izforge.izpack.panels.TargetPanel>

Example: $SCHEDULER_DATA in scheduler_install.xml

<com.izforge.izpack.panels.UserPathPanel id="userpath">
 
     <!-- SELECT THE DATA PATH FOR CONFIGURATION AND LOG FILES The installation expands this path with the JobScheduler ID as subdirectory. 
          The path must be absolute! 
          Default paths are: 
               /home/[user]/sos-berlin.com/jobscheduler for Unix® 
               C:\ProgramData\sos-berlin.com\jobscheduler for newer Microsoft® Windows® C:\Documents and Settings\All Users\Application Data\sos-berlin.com\jobscheduler for older Microsoft® Windows® -->
     <UserPathPanelElement>[:choose absolute data path of the JobScheduler configuration and log files:]< /UserPathPanelElement>
 
</com.izforge.izpack.panels.UserPathPanel>

Please read the sectionthe Installation Paths section in the previous chapter for more information.

2.3 Setup Packages

You have to edit the following part of the scheduler_install.xml file instead using the form in the dialog setup.

Example: Packages in scheduler_install.xml

<com.izforge.izpack.panels.PacksPanel id="package">
 
          <!-- SELECT THE PACKS WHICH YOU WANT INSTALL -->
 
          <!-- Package: JobScheduler 
               JobScheduler Basic Installation 
               THIS PACK IS REQUIRED. IT MUST BE TRUE -->
          <pack index="0" name="Job Scheduler" selected="true"/>
 
          <!-- Package: Database Support Job history and log files can be stored in a database. 
               Database support is available for MySql®, PostgreSQL, Oracle® Database, Microsoft® SQL Server, IBM® DB2. 
               THIS PACK IS REQUIRED. IT MUST BE TRUE -->
          <pack index="2" name="Database Support" selected="true"/>
 
          <!-- Package: Housekeeping Jobs 
               Housekeeping Jobs are automatically launched by the JobScheduler, 
               e.g. to send buffered logs by mail, to remove temporary files or to restart the JobScheduler. -->
          <pack index="5" name="Housekeeping Jobs" selected="true"/>
 
</com.izforge.izpack.panels.PacksPanel>

Please read the section Setup Packages (page 11) in the above chapter for more information.

2.4 JobScheduler's Host, Port, ID

You have to edit the following part of the scheduler_install.xml file instead using the form in the dialog setup.

Example: Host, Port, ID in scheduler_install.xml

<com.izforge.izpack.panels.UserInputPanel id="network"> 
     <userInput> 
          <!-- Network Configuration -->
 
          <!-- Enter the name or ip address of the host on which the JobScheduler is operated --> 
          <entry key="schedulerHost" value=""/> 

          <!-- Enter the port for TCP communication --> 
          <entry key="schedulerPort" value="4444"/> 
          <!-- Enter the port for Jetty HTTP --> 
          <entry key="jettyHTTPPort" value="44440"/> 
          <!-- Enter the port for Jetty HTTPS --> 
          <entry key="jettyHTTPSPort" value="8443"/> 
          <!-- To enter a JobScheduler ID is required. The IDs of multiple instances of the JobScheduler must be unique per server. 
               The JobScheduler ID expands the above installation paths as subdirectory. 
               Please omit special characters like: / \ : ; * ? ! $ % & " < > ( ) | ^ --> 
          <entry key="schedulerId" value="scheduler"/> 
          <!-- It is recommended to enable TCP access for the host where the JobScheduler will install, 
               optionally enter additional host names or ip addresses. 
               To enable all hosts in your network to access the JobScheduler enter '0.0.0.0'. --> 
          <entry key="schedulerAllowedHost" value="localhost"/> 
          <!-- Choose (yes or no) whether the JobScheduler should be started at the end of the installation --> 
          <entry key="launchScheduler" value="yes"/> 
     </userInput> 
 
</com.izforge.izpack.panels.UserInputPanel>

Please read the section The Basic JobScheduler Forms (page 13) in the above chapter for more information.

2.5 Cluster

In the following part of the scheduler_install.xml file you can choose whether the JobScheduler runs standalone or in a cluster (see also Installation of a Cluster (page 41)).

Example: Cluster in scheduler_install.xml

<com.izforge.izpack.panels.UserInputPanel id="cluster"> 
 
     <userInput> 
 
          <!-- Cluster Configuration --> 
          <!-- The JobScheduler can be installed independent of other possibly JobSchedulers, 
               as a primary JobScheduler in a backup system or as a backup JobScheduler. 
               Use '' for a standalone, '-exclusive' for a primary or '-exclusive -backup' for a backup JobScheduler. 
               A database is required for a backup system. 
               All JobSchedulers in a backup system must have the same JobScheduler ID and the same database. 
               Further you can set '-distributed-orders' for a load balancing cluster. 
               For more information see: 
                    http://www.sos-berlin.com/doc/de/scheduler.doc/backupscheduler.xml 
                    http://www.sosberlin.com/doc/de/scheduler.doc/distributed_orders.xml --> 
          <entry key="clusterOptions" value=""/> 
 
          </userInput> 
 
</com.izforge.izpack.panels.UserInputPanel>

If the value of the clusterOptions entry element ...

... is empty then the JobScheduler runs standalone.
... is equal to -exclusive then the JobScheduler is the primary in a Backup Cluster.
... is equal to -exclusive -backup then the JobScheduler is the secondary in a Backup Cluster.
... is equal to -distributed-orders then the JobScheduler is a member of a Load Balancing Cluster.

Further information about Backup Cluster can be found here, about Load Balancing look here.

2.6 Mail Settings

You have to edit the following parts of the scheduler_install.xml file instead using the forms in the dialog setup.

Example: Mail Configuration in scheduler_install.xml

<com.izforge.izpack.panels.UserInputPanel id="smtp"> 
 
     <userInput> 
 
          <!-- Mail Recipients Configuration / SMTP Authentication --> 
 
          <!-- Enter the ip address or host name and port (default: 25) of your SMTP server --> 
          <entry key="mailServer" value=""/> 
          <entry key="mailPort" value="25"/> 
 
          <!-- Configure the SMTP authentication if necessary. --> 
          <entry key="smtpAccount" value=""/> 
          <entry key="smtpPass" value=""/> 
 
          <!-- Enter the addresses of recipients to which mails with log files are automatically forwarded. 
               Separate multiple recipients by commas --> 
          <!-- Account from which mails are sent --> 
          <entry key="mailFrom" value=""/> 
 
          <!-- Recipients of mails --> 
          <entry key="mailTo" value=""/> 
 
          <!-- Recipients of carbon copies: --> 
          <entry key="mailCc" value=""/> 
 
          <!-- Recipients of blind carbon copies --> 
          <entry key="mailBcc" value=""/> 
 
     </userInput> 
 
</com.izforge.izpack.panels.UserInputPanel>

Example: Mail Configuration der scheduler_install.xml

<com.izforge.izpack.panels.UserInputPanel id="email"> 
 
     <userInput> 
 
          <!-- Mail Configuration / Event Handler --> 
          <!-- Choose in which cases mails with log files are automatically forwarded. --> 
          <entry key="mailOnError" value="yes"/> 
          <entry key="mailOnWarning" value="yes"/> 
          <entry key="mailOnSuccess" value="no"/> 
 
          <!-- The Housekeeping package is required for configure JobScheduler as event handler 
               Choose this option if you intend to use JobScheduler Events and 
                - this JobScheduler instance is the only instance which processes Events
                - this JobScheduler instance is a supervisor for other JobSchedulers which submit Events --> 
          <entry key="jobEvents" value="off"/> 
 
     </userInput> 
 
</com.izforge.izpack.panels.UserInputPanel>

Please read the section The Basic JobScheduler Forms (page 13) in the above chapter for more information.

2.7 The Database Support Package Settings

You have to edit the following parts of the scheduler_install.xml file instead using the forms in the dialog setup.

Example: Database Support in scheduler_install.xml

<com.izforge.izpack.panels.UserInputPanel id="database"> 
 
     <userInput> 
 
          <!-- Database Configuration These entries are only necessary if the package 'Database Support' is chosen.--> 
          <!-- Choose the database management system. 
               Supported values are: 
                - 'mysql' for MySql®, 
                - 'Oracle® Database' for Oracle® Database, 
                - 'mssql' for Microsoft® SQL Server, 
                - 'pgsql' for PostgreSQL, 
                - 'db2' for IBM® DB2 and 
                - 'sybase' for Sybase. --> 
          <entry key="databaseDbms" value="mysql"/> 
 
          <!-- You can choose between 'on' or 'off' to create the database tables. 
               If you have modified the initial data of an already existing installation, then the modifications will be undone. 
               Data added remains unchanged. 
               This entry should be only 'off', when you are sure that all tables have been created. --> 
          <entry key="databaseCreate" value="on"/> 
 
     </userInput> 
 
</com.izforge.izpack.panels.UserInputPanel>

Example: License in scheduler_install.xml

<com.izforge.izpack.panels.UserInputPanel id="dbconnection"> 
 
     <userInput> 
 
          <!-- Database Configuration 
               These entries are only necessary if the package 'Database Support' is chosen. --> 
 
          <!-- Enter the name or ip address of the database host --> 
          <entry key="databaseHost" value=""/> 
 
          <!-- Enter the port number for the database instance. 
               Default ports are for MySql® 3306, Oracle® Database 1521, Microsoft® SQL Server 1433, postgreSQL 5432, IBM® DB2 50000, Sybase 5000. --> 
          <entry key="databasePort" value=""/> 
 
          <!-- Enter the schema --> 
          <entry key="databaseSchema" value=""/> 
 
          <!-- Enter the user name for database access --> 
          <entry key="databaseUser" value=""/> 
 
          <!-- Enter the password for database access --> 
          <entry key="databasePassword" value=""/> 
 
          <!-- You must provide the MySql®, Microsoft® SQL Server or Sybase JDBC® Driver respectively if you selected corresponding DBMS type. 
               For license reasons MySql®, Sybase and Microsoft® SQL Server JDBC® Drivers are not provided. 
               Alternatively you can use:
                - the MariaDB® JDBC® Driver for MySql® and 
                - the jTDS JDBC® Driver for Microsoft® SQL Server and Sybase which is provided.--> 
          <!-- You can choose between 'yes' or 'no' for using the jTDS JDBC® Driver 
               This entry has only an effect for Microsoft® SQL Server or Sybase --> 
          <entry key="connectorJTDS" value="yes"/> 
 
          <!-- You can choose between 'yes' or 'no' for using the MariaDB® JDBC® Driver 
               This entry has only an effect for MySql® --> 
          <entry key="connectorMaria" value="yes"/> 
 
     </userInput> 
 
</com.izforge.izpack.panels.UserInputPanel>

Example: License in scheduler_install.xml

<com.izforge.izpack.panels.UserInputPanel id="jdbc"> 
 
     <userInput> 
 
          <!-- Configuration for JDBC® Driver 
               This entry is only necessary if the package 'Database Support' is chosen and 
               you selected a DBMS type like MySql®, Microsoft® SQL Server or Sybase in the previous <userInput> element. --> 
 
          <!-- You must provide the MySql®, Microsoft® SQL Server or Sybase JDBC® Driver respectively if you selected corresponding DBMS type. 
               For license reasons MySql® and Microsoft® SQL Server JDBC® Drivers are not provided. 
               Specify the JDBC® Driver source (e.g. mysql-connector-java-*.jar for MySql®, sqljdbc.jar for Microsoft® SQL Server, jconn3.jar for Sybase). 
               Alternatively you can use:
                - the MariaDB® JDBC® Driver for MySql® and 
                - the jTDS JDBC® Driver for Microsoft® SQL Server and Sybase which is provided. --> 
          <!-- Select the path to JDBC® Driver --> 
          <entry key="connector" value=""/> 
 
     </userInput> 
 
</com.izforge.izpack.panels.UserInputPanel>

Please read the section The Database Support Package Forms (page 16) in the above chapter for more information.

Space shortcuts

Page tree

2.1 Licenses

2.2 Installation Paths

2.3 Setup Packages

2.4 JobScheduler's Host, Port, ID

2.5 Cluster

2.6 Mail Settings

2.7 The Database Support Package Settings