JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 10

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 11

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

  • Download the Agent archive for the target system from the JS7 - Download page.
    • For Unix systems:
      • A tarball .tar.gz archive is available that is extracted to create the Agent's directory structure (see below).
        • js7_agent_unix.<release>.tar.gz
    • For Windows systems:
      • A .zip archive is available that is extracted to create the Agent's directory structure (see below).
        • js7_agent_windows.<release>.zip
      • A .zip archive including the installer is available that is used to run the installer in headless mode.
        • js7_agent_windows_installer.<release>.zip

Installation from

...

.tar.gz/.zip Archive

Installation

  • Extract the downloaded archive file to a directory.
  • The After extraction the resulting directory structure includes (only files and folders immediately relevant):
    • agent agent 
      • bin
        • agent.cmd|sh
          • The Start Script for Windows/Unix platforms
        • agent_watchdog.cmd|sh
          • Restarts the Agent for Windows/Unix platforms
        • agent_instance.sh-example
          • The template for the Agent Instance Start Script
      • lib
        • The directory for Java libraries
      • service
        • For operation as a Windows Service
      • var
      • yade
        • For use of the YADE file transfer utility
      • service
        • For operation as a Windows Service
      • license.gpl (copy of  GPLv3 (General Public License) )
      • license.html, license.txt (copy of JS7 JobScheduler Commercial License)
      • ThirdParty.txt (list of 3rd party components and licenses included with Agent)
    • On Windows Systems:
      • You have to
      On Windows Systems:
      • You have to modify the directory permissions for the above .\logs and .\service directories if you extracted the Agent to e.g. C:\Program Files.
        • This step is not required if you extract the Agent 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 
    • If multiple run-time instances of an Agent starting from the same Agent installation are used then every instance must have its own ./var_<port of the instance> data directory, e.g. ./var_4445, ./var_4447 etc.

...

Installation

Installer Response File

  • After extraction of the .zip archive that includes the installer the directory structure includes:The Agent installation makes use the 
      • agent_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 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

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

    Installer Response File

    • The Agent installation makes use the agent_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
      Code BlocklanguagexmltitleConfiguration
      • 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

      xml file
      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"/>
      linenumberstrue
      collapsetrue
      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- 
XML configuration 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 licence.txt

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

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

    ...

    • Running the installer of the JS7 Agent on Windows systems

      Code Block
      languagetext
      titleRunning the installer of JS7 Agent on Windows systems
      C:\temp\agent.[release]> setup.cmd agent_install.xml

    Directory Structure

    After installation the resulting directory structure is the same as explained with the above chapter Installation from .tar.gz/.zip Archive.

    Installation Log

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

    ...

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

    Rollback

    Rollback from

    ...

    .tar.gz/.zip Archive Installation

    • To rollback the installation of a JS7 Agent instance remove the newly created installation directory and configuration directory 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 directory and configuration directory.

    ...