JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 41

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 42

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

  • Extract the downloaded archive to a directory.
  • After extraction the resulting directory structure includes (only files and folders immediately relevant):
    • controller
      • license.gpl (copy of  GPLv3 (General Public License) )
      • license.html, license.txt (copy of JS7 JobScheduler Commercial License Agreement)
      • ThirdParty.txt (list of 3rd party components and licenses included with the JS7 Controller)
      • bin
        • controller.cmd|sh
          • The Start Script for Windows/Unix platforms
        • controller_watchdog.cmd|sh
          • Restarts the Controller for Windows/Unix platforms
        • environment_variables.cmd|sh
          • Environment Startup Script for the JS7 Controller
      • lib (directory for Java libraries)
      • service (directory for operation as a Windows Service)
        • amd64
        • manager
        • x86
        • install_controller_windows_service.cmd
        • LICENSE.txt (copy of Apache License, Version 2.0)
        • NOTICE.txt
        • RELEASE-NOTES.txt
        • uninstall_controller_windows_service.cmd
        • amd64
        • manager
        • x86
      • user_bin
        • environment_variables.cmd|sh-example 
          • Sample configuration file to set individual environment variables. Drop the -example extension to activate this file.
      • var (configuration directory)
        • config (directory for configuration files)
          • controller.conf (general Controller configuration)
          • lib (optional directory for JDBC Drivers and licensed binary code)
          • license (optional directory for license certificate files)
          • private (directory for security related configuration files)
            • private.conf-example (security related configuration)
        • logs (directory for log files)
        • state (directory for journal files)
    • On Windows Systems:
      • You have to modify the directory permissions for the above .\logs and .\service directories if you extract the Controller to e.g. C:\Program Files.
        • This step is not required if you extract the Controller e.g. to C:\ProgamData.

        • Start a command prompt with elevated administrative rights and execute e.g.

          Code Block
          languagebash
          titleAllow full acces for "Users" on .\service and .\logs directories
          cd "path\to\installation-directory"
icacls "service" /L /grant *S-1-5-32-545:(OI)(CI)F
icacls "logs" /L /grant *S-1-5-32-545:(OI)(CI)F 

...

  • The Controller installation makes use the controller_install.xml response file that includes parameters such as the installation path, ports, etc.
    • For a fresh installation the installer response file is included with the downloaded archive.
    • The default location of the controller_install.xml file from a previous installation is:
      • C:\Program Files\sos-berlin.com\js7\controller\<controller-id>
    • The <controller-id> is a unique identifier for a Controller that you specify from the installer response file:
      • You are free to choose an identifier, e.g. controller-test, controller-prod if you intend to run a separate Controller for each environment. Upper case and lower case characters are considered, the characters a-z, A-Z, 0-9, underscore and hyphen are allowed. Spaces are not allowed in a Controller ID.
      • If you intend to operate a Controller cluster then both Controller instances have to use the same Controller ID.
  • Customers with a commercial license should choose the respective license option and specify the location of the license key with the installer response file.

  • The controller_install.xml file is explained with the code listing below. The comments included are intended to be self-explanatory.
    Download: controller_install.xml

    Code Block
    languagexml
    titleConfiguration of the controller_install.xml file
    linenumberstrue
    collapsetrue
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- 
XML installer response file for JS7 Controller setup

The JS7 Controller is available with a dual license model:
- GNU GPL v3.0 License, see https://www.gnu.org/licenses/gpl-3.0.en.html
- JS7 Commercial License, see license.txt

The setup asks you for the desired license model,
see below <entry key="licenseOptions" .../>

If you run the installer and do not specify a commercial license key
then at the same time you accept the terms of the
licence agreement under the GNU GPL v3.0 License.
-->
<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="licenseOption" value="GPL"/>
            
            <!-- If you select GPL as a license model than the 'licenseFile' must be empty.
                 Otherwise please enter the path to the license file if available.
                 It is also possible to add the license file later on. -->
            <entry key="licenseFile" 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
             The installer expands this path with the JS7 Controller ID as a sub-directory.
             The path must be absolute!
             The default path is C:\Program Files\sos-berlin.com\js7\controller -->
        <installpath>C:\Program Files\sos-berlin.com\js7\controller</installpath>
        
    </com.izforge.izpack.panels.TargetPanel>
    <com.izforge.izpack.panels.UserPathPanel id="userpath">
        
        <!-- SELECT THE DIRECTORY FOR CONFIGURATION FILES AND LOG FILES
             The installer expands this path with the JS7 Controller ID as a sub-directory.
             The path must be absolute!
             The default path is C:\ProgramData\sos-berlin.com\js7\controller -->
        <UserPathPanelElement>C:\ProgramData\sos-berlin.com\js7\controller</UserPathPanelElement>
        
    </com.izforge.izpack.panels.UserPathPanel>
    <com.izforge.izpack.panels.UserInputPanel id="network">
        <userInput>
        
            <!-- ID of the JS7 Controller -->
            <entry key="controllerId" value="controller"/>
            
            <!-- Choose 'yes' if the JS7 Controller instance is a standby Controller instance in a cluster -->
            <entry key="isStandby" value="no"/>
            
            <!-- Choose 'yes' or 'no' whether the JS7 Controller should be started after installation -->
            <entry key="launchController" value="yes"/>
            
            <!-- HTTP port of the JS7 Controller -->
            <entry key="controllerPort" value="4444"/>
            
            <!-- Optionally specify an IP address or hostname that is used to indicate which network 
                 interface the JS7 Controller should listen to when using HTTP. If empty then 
                 the Controller listens to any available network interfaces. -->
            <entry key="controllerHost" value=""/>
            
            <!-- The JS7 Controller will be installed as a Windows Service. You can set the Windows Service
                 account otherwise the local system account will be used. The account has to be
                 specified according to the pattern 'Domain\User'. -->
            <entry key="serviceAccount" value=""/>
            <entry key="servicePassword" value=""/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="environment">
        <userInput>

            <!-- Directory where the JS7 Controller's log files are stored 
                 (default: '[above configuration path]\logs'). -->
            <entry key="logPath" value=""/>
            
            <!-- Directory where the JS7 Controller's PID file is stored 
                 (default: above log path). -->
            <entry key="pidFilePath" value=""/>
            
            <!-- Working directory for the JS7 Controller
                 e.g. %USERPROFILE% (default: [installation path]) -->
            <entry key="workPath" value=""/>
            
            <!-- The JS7 Controller requires a Java JRE minimum version '1.8'. You can choose 
                 a different Java environment than the Java used during installation. -->
            <entry key="javaHome" value=""/>
            
            <!-- Optionally specify Java options (default: -Xmx500m). -->
            <entry key="javaOptions" 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>

...