Versions Compared

Key

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

...

After extraction of the installer .zip archive the directory structure includeswill include:

  • agent_install.xml (installer response file)
  • install_agent.txt (installation notes)
  • js7_agent_windows.<release>.jar (installer library for a given release)
  • license.txt, license.html (copy of JS7 JobScheduler Commercial License Agreement)
  • setup.cmd (installer script)

Installer Response File

  • The Agent installation makes use uses the agent_install.xml response file that file, which 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 agent_install.xml file from a previous installation is:
      • C:\Program Files\sos-berlin.com\js7\agent
  • The agent_install.xml file is explained with the code listing below. The comments included are intended to be self-explanatory.
    Download: agent_install.xml

    Code Block
    languagexml
    titleConfiguration of the agent_install.xml file
    linenumberstrue
    collapsetrue
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <!-- 
    XML installer response file for JS7 Agent setup
    
    The JS7 Agent 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="licenseOption" .../>
    
    If you run the installer and do not specify a commercial license key
    then at the same time you accept the terms of the
    license 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="licenses">
            <userInput>
            
                <!-- Select the license model (GPL or Commercial) -->
                <entry key="licenseOption" value="GPL"/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.HTMLLicencePanel id="gpl_license"/>
        <com.izforge.izpack.panels.HTMLLicencePanel id="commercial_license"/>
        <com.izforge.izpack.panels.TargetPanel id="target">
            
            <!-- SELECT THE INSTALLATION PATH
                 The path must be absolute!
                 The default path is C:\Program Files\sos-berlin.com\js7\agent -->
            <installpath>C:\Program Files\sos-berlin.com\js7\agent</installpath>
            
        </com.izforge.izpack.panels.TargetPanel>
        <com.izforge.izpack.panels.UserInputPanel id="network">
    		<userInput>
    						
    			<!-- HTTP port of the JS7 Agent -->
    			<entry key="agentPort" value="4445"/>
    			<!-- Optionally specify an IP address or hostname that is used to indicate which network 
    				 interface the JS7 Agent should listen to when using HTTP. If empty 
                     then the Agent listens to any available network interfaces. -->
                <entry key="agentHost" value=""/>
                <!-- Choose 'yes' or 'no' whether the JS7 Agent should be started after installation -->
                <entry key="launchAgent" value="yes"/>
                <!-- The JS7 Agent will be installed as a Windows Service. You can set the 
                     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.UserPathPanel id="userpath">
            
            <!-- SELECT THE DIRECTORY FOR CONFIGURATION FILES AND LOG FILES
                 This directory has to be unique for each JS7 Agent instance.
                 The path must be absolute!
                 The default path is C:\ProgramData\sos-berlin.com\js7\agent_%agentPort%
                 where %agentPort% is the value from above entry 'agentPort' -->
            <UserPathPanelElement>C:\ProgramData\sos-berlin.com\js7\agent_4445</UserPathPanelElement>
            
        </com.izforge.izpack.panels.UserPathPanel>
        <com.izforge.izpack.panels.UserInputPanel id="environment">
            <userInput>
    
                <!-- Directory where the JS7 Agent's log files are stored
                     (default: '[above configuration path]\logs'). -->
                <entry key="logPath" value=""/>
                <!-- Directory where the JS7 Agent's PID file is stored 
                     (default: above log path). -->
                <entry key="pidFilePath" value=""/>
                <!-- Working directory for jobs started by the JS7 Agent
                     e.g. %USERPROFILE% (default: [installation path]) -->
                <entry key="workPath" value=""/>
                <!-- The JS7 Agent 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: -Xms100m). -->
                <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>

...

After installation the resulting directory structure is will be similar to what is explained with that described in the Installation from .tar.gz/.zip Archive chapter above.

...

The installer creates a log file in the directory that is pointed to by the environment variable specified in the JS7_AGENT_LOGS environment variable or in the logs sub-directory of the Agent configuration directory.

...

The update procedure makes use of the same installer response file as explained described for a fresh installation.

Steps to run the installer are the same as explained described for a fresh installation.

...

  • To rollback the installation of a JS7 Agent instance, remove the newly created installation directory and configuration directory directories of the JS7 Agent.
  • Restore the directories from a previous backup, e.g. by extracting the respective .tar.gz/.zip backup archives to the installation and configuration directories.

...