Versions Compared

Key

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

...

  • Download: jobscheduler_install.xml

    Code Block
    languagexml
    titleInstaller Response File
    linenumberstrue
    collapsetrue
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <!-- 
    XML configuration file for JobScheduler setup
    
    The JobScheduler is available with a dual licensing model.
    - GNU GPL 2.0 License (see http://www.gnu.org/licenses/gpl-2.0.html)
    - JobScheduler Commercial License (see licence.txt)
    
    The setup asks you for the desired license model 
    (see <entry key="licenceOptions" .../> below).
    
    If you call the setup with this XML file then you accept 
    at the same time the terms of the chosen license agreement. 
    -->
    <AutomatedInstallation langpack="eng">
        <com.izforge.izpack.panels.UserInputPanel id="home">
            <userInput/>
        </com.izforge.izpack.panels.UserInputPanel>
        <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>
        <com.izforge.izpack.panels.HTMLLicencePanel id="gpl_licence"/>
        <com.izforge.izpack.panels.HTMLLicencePanel id="commercial_licence"/>
        <com.izforge.izpack.panels.TargetPanel id="target">
            
            <!-- SELECT THE INSTALLATION PATH FOR THE BINARIES AND LIBRARIES
                 The installation expands this path with the Scheduler 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 Windows -->
            <installpath>/opt/sos-berlin.com/jobscheduler</installpath>
            
        </com.izforge.izpack.panels.TargetPanel>
        <com.izforge.izpack.panels.UserPathPanel id="userpath">
            
            <!-- SELECT THE DATA PATH FOR CONFIGURATION AND LOG FILES
                 The installation expands this path with the Scheduler 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 Windows -->
            <UserPathPanelElement>/var/sos-berlin.com/jobscheduler</UserPathPanelElement>
            
        </com.izforge.izpack.panels.UserPathPanel>
        <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, SQL Server, 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 Job Scheduler, 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>
        <com.izforge.izpack.panels.UserInputPanel id="network">
            <userInput>
                <!-- Network Configuration -->
                
                <!-- Enter the port for TCP communication (e.g. 4444) 
                     No longer required! -->
                <entry key="schedulerPort" value=""/>
                
                <!-- Enter the port for HTTP communication -->
                <entry key="schedulerHTTPPort" value="40444"/>
                
                <!-- 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="testsuite"/>
                
                <!-- Only for Linux (root permissions required) -->
                <entry key="schedulerInstallAsDaemon" value="yes"/>
                	
                <!-- To enter a JobScheduler User (default=current User). 
                     Only for Linux (root permissions required) -->
                <entry key="runningUser" value=""/>
                
                <!-- Specify optional Java options here -->
                <entry key="jsJavaOptions" value=""/>
                
                <!-- 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="0.0.0.0"/>
                
                <!-- Choose (yes or no) wether the JobScheduler should be started at the end of the installation -->
                <entry key="launchScheduler" value="no"/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserInputPanel id="cluster">
            <userInput>
                <!-- Cluster Configuration / Job Streams Plugin -->
                
                <!-- 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.sos-berlin.com/doc/de/scheduler.doc/distributed_orders.xml -->
                <entry key="clusterOptions" value=""/>
                
                <!-- Enable JobStreams plugin.
                     For more information see https://kb.sos-berlin.com/x/uoC2AQ -->
                <entry key="jobStreamsPlugin" value="on"/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <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>
        <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>
        <com.izforge.izpack.panels.UserInputPanel id="database">
            <userInput>
                <!-- JobScheduler Database Configuration -->
                
                <!-- Database connection settings can be specified with following entries such as
                     databaseHost, databasePort, ... or by a hibernate configuration file 
                     Posible values are 'withoutHibernateFile' (default) and 'withHibernateFile'. -->
                <entry key="databaseConfigurationMethod" value="withoutHibernateFile"/>
                     
                <!-- Choose the database management system. Supported values are 'mysql' for MySQL,
                     'oracle' for Oracle, 'mssql' for MS SQL Server, 'pgsql' for PostgreSQL,
                     'db2' for DB2 and 'sybase' for Sybase. 
                     Only if databaseConfigurationMethod=withoutHibernateFile -->
                <entry key="databaseDbms" value="mysql"/>
                
                <!-- Path to a hibernate configuration file if databaseConfigurationMethod=withHibernateFile -->
                <entry key="hibernateConfFile" value=""/>
                
                <!-- 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 sure, that all tables are already created. -->
                <entry key="databaseCreate" value="on"/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserInputPanel id="dbconnection">
            <userInput>
                <!-- JobScheduler Database Configuration if databaseConfigurationMethod=withoutHibernateFile -->
                     
                <!-- Enter the name or ip address of the database host 
                     This entry can also be used to configure the URL(s) for Oracle RAC databases.
                     For example:
                     <entry key="databaseHost" value="(DESCRIPTION=(ADDRESS_LIST=(LOAD_BALANCE=OFF)(FAILOVER=ON)
                        (ADDRESS=(PROTOCOL=TCP)(HOST=tst-db1.myco.com)(PORT=1604))
                        (ADDRESS=(PROTOCOL=TCP)(HOST=tst-db2.myco.com)(PORT=1604)))
                        (CONNECT_DATA=(SERVICE_NAME=mydb1.myco.com)(SERVER=DEDICATED)))"/>
                     The "databaseSchema" and "databasePort" entries should then be left empty. -->
                <entry key="databaseHost" value="mysql-5-7"/>
                
                <!-- Enter the port number for the database instance. Default ports are for MySQL 3306, 
                     Oracle 1521, MS SQL Server 1433, postgreSQL 5432, DB2 50000, Sybase 5000. -->
                <entry key="databasePort" value="3306"/>
                
                <!-- Enter the schema -->
                <entry key="databaseSchema" value="jobscheduler113"/>
                
                <!-- Enter the user name for database access -->
                <entry key="databaseUser" value="jobscheduler"/>
                
                <!-- Enter the password for database access -->
                <entry key="databasePassword" value="jobscheduler"/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserInputPanel id="jdbc">
            <userInput>
                <!-- JobScheduler Database Configuration -->
                     
                <!-- You can specify an external JDBC connector then set internalConnector = no
                     For license reasons MySQL, Sybase, MS SQL Server and Oracle ojdbc7 JDBC 
                     drivers are not provided. 
                     Alternatively you can use the mariadb JDBC Driver for MySQL and 
                     the jTDS JDBC Driver for MS SQL Server and Sybase which is provided. 
                     An Oracle ojdbc6 JDBC driver is also provided.
                     An internal JDBC connector for DB2 is not available -->
                     
                <!-- You can choose between 'yes' or 'no' for using the internal JDBC connector
                     or not -->
                <entry key="internalConnector" value="yes"/>
                
                <!-- Select the path to JDBC Driver -->
                <entry key="connector" value=""/>
                
                <!-- Only for DB2: Select the path to DB2 license file for JDBC Driver -->
                <entry key="connectorLicense" value=""/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserInputPanel id="reportingDatabase">
            <userInput>
                <!-- Reporting Database Configuration 
                     NOT SUPPORTED FOR SYBASE AND DB2 -->
                
                <!-- Set 'yes' if the JobScheduler and the Reporting database are the same.
                     If 'yes' then further Reporting database variables are ignored. -->
                <entry key="sameDbConnection" value="yes"/>
                
                <!-- Database connection settings can be specified with following entries such as
                     databaseHost, databasePort, ... or by a hibernate configuration file 
                     Posible values are 'withoutHibernateFile' (default) and 'withHibernateFile'. -->
                <entry key="reporting.databaseConfigurationMethod" value="withoutHibernateFile"/>            
                     
                <!-- Choose the database management system. Supported values are 'mysql' for MySQL,
                     'oracle' for Oracle, 'mssql' for MS SQL Server, 'pgsql' for PostgreSQL. 
                     only if reporting.databaseConfigurationMethod=withoutHibernateFile-->
                <entry key="reporting.databaseDbms" value="mysql"/>
                
                <!-- Path to a hibernate configuration file if reporting.databaseConfigurationMethod=withHibernateFile -->
                <entry key="reporting.hibernateConfFile" value=""/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserInputPanel id="reportingDbconnection">
            <userInput>
                <!-- Reporting Database Configuration if reporting.databaseConfigurationMethod=withoutHibernateFile
                     NOT SUPPORTED FOR SYBASE AND DB2 -->
                     
                <!-- Enter the name or ip address of the database host 
                     This entry can also be used to configure the URL(s) for Oracle RAC databases.
                     For example:
                     <entry key="reporting.databaseHost" value="(DESCRIPTION=(ADDRESS_LIST=(LOAD_BALANCE=OFF)(FAILOVER=ON)
                        (ADDRESS=(PROTOCOL=TCP)(HOST=tst-db1.myco.com)(PORT=1604))
                        (ADDRESS=(PROTOCOL=TCP)(HOST=tst-db2.myco.com)(PORT=1604)))
                        (CONNECT_DATA=(SERVICE_NAME=mydb1.myco.com)(SERVER=DEDICATED)))"/>
                     The "reporting.databaseSchema" and "reporting.databasePort" entries should then be left empty. -->
                <entry key="reporting.databaseHost" value="mysql-5-7"/>
                
                <!-- Enter the port number for the database instance. Default ports are for MySQL 3306, 
                     Oracle 1521, MS SQL Server 1433, postgreSQL 5432. -->
                <entry key="reporting.databasePort" value="3306"/>
                
                <!-- Enter the schema -->
                <entry key="reporting.databaseSchema" value="jobscheduler113"/>
                
                <!-- Enter the user name for database access -->
                <entry key="reporting.databaseUser" value="jobscheduler"/>
                
                <!-- Enter the password for database access -->
                <entry key="reporting.databasePassword" value="jobscheduler"/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserInputPanel id="reportingJdbc">
            <userInput>
                <!-- Reporting Database Configuration 
                     NOT SUPPORTED FOR SYBASE AND DB2 -->
                     
                <!-- You can specify an external JDBC connector then set reporting.internalConnector = no
                     For license reasons MySQL, MS SQL Server and Oracle ojdbc7 JDBC 
                     drivers are not provided. 
                     Alternatively you can use the mariadb JDBC Driver for MySQL and 
                     the jTDS JDBC Driver for MS SQL Server and Sybase which is provided. 
                     An Oracle ojdbc6 JDBC driver is also provided. -->
                     
                <!-- You can choose between 'yes' or 'no' for using the internal JDBC connector
                     or not -->
                <entry key="reporting.internalConnector" value="yes"/>
                     
                <!-- Select the path to JDBC Driver -->
                <entry key="reporting.connector" value=""/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserInputPanel id="end">
            <userInput/>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.InstallPanel id="install"/>
        <com.izforge.izpack.panels.ProcessPanel id="process"/>
        <com.izforge.izpack.panels.FinishPanel id="finish"/>
    </AutomatedInstallation>
  • Explanations
    • The above installer response file works for releases 1.13. Other releases ship with different versions of this file. You should pick-up a template of this file that matches your JobScheduler release by extracting the installer tarball. 
    • Generally all defaults of the response file can be maintained.
      • This includes use of port 40444 for the connection of JOC Cockpit to the Master. At run-time this port can be mapped, see Dockerfile.
    • Line 182-233: The database connection makes use of a hostname "mysql-5-7" that is assumed to be the hostname of a Docker container in the same Docker network running the MySQL database.
      • Modify the database connection settings as required for use with your DBMS and access credentials.

...