Introduction

• First of all, you don't need to read this article in all its parts. For most situations it is sufficient to check the prerequisites, to download the software and to run the installer that will guide you.

Installing the JS7 Agent

Prerequisites

• Java Runtime Environment 1.8 or newer is required.
• For details see Which Java versions is JobScheduler available for?

...

Download

• Choose the Agent archive for Windows systems and the graphical installer from the JS7 - Download page.
• For Windows systems a .zip archive including the installer is available from js7_agent_windows_installer.<release><release>.zip.

Installation

Extract the downloaded archive to a directory, e.g. C:\Temp.

...

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

...

• The installer can be run in graphical mode or in headless mode, see JS7 - Agent - Use of Unix/Windows Headless Installation.

• The installer asks for elevated administrative privileges, therefore it is not required to change the permissions in the .\service directory and the installer sets read/write permissions for the .\logs directory.
• After the installation you will find
  
  • a Windows Service "SOS JS7 Agent -port=<http-port>"
  • an executable file .\service\js7_agent_<port><http-port>.exe that is started by the Windows Service.

...

• Choose the configuration directory for the Agent to which you want to store the Agent's configuration files, log files and journal files.
  
  

Specific Directories

• If you choose the installation directory to be located in C:\Program Files then it is recommended to choose the log directory outside of the installation path, e.g. C:\ProgramData\sos-berlin.com\js7\agent_<port><http-port>\logs.
• The installer sets read/write permissions for the specified Windows Service account. Typically only the administrator group should have write permissions for C:\Program Files.
  
  
  
  

...

• The resulting directory structure after installation includes (only files and folders immediately relevant):
  • agent 
    • 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 Agent)
    • bin
      • agent.cmd|sh
        • The Start Script for Windows/Unix platforms
      • agent_<http<http-port>port>.cmd
        • For Windows systems the installer creates the Agent Instance Start Script.
      • agent_instance.sh-example
        • The template for the Agent Instance Start Script for Unix systems.
      • agent_watchdog.cmd|sh
        • Restarts the Agent for Windows/Unix platforms
    • lib (directory for Java libraries)
    • service (directory for operation as a Windows Service)
    • var_<http-port> (data directory)
      
      • config (directory for configuration files)
        • agent.conf (general Agent configuration) 
        • private (directory for security related configuration files)
          • private.conf-example  (security related configuration configuration)
            • For setting up HTTPS connections see JS7 - Agent Configuration Items
            • For setting up authentication and digital signature checks
      • logs (directory for log files)
      • tmp (directory for temporary files)
    • yade (directory of the YADE file transfer utility)

...

• js7_agent_windows_installer.<release><release>.zip

Preparation

• Stop any running JS7 Agent instances. Consider that more than one Agent instance can be launched from a single Agent installation.
• Prepare to rollback in case that the update of the JS7 Agent is not successful:
  • Take a backup of the Agent's installation directory and configuration directory, e.g. by creating a .zip archive.
    
    • Installation Directory:
      • The default installation directory for the Agent is C:\Program Files\sos-berlin.com\js7\agent
    • Configuration Directory
      • The default configuration directory for the Agent is C:\ProgramData\sos-berlin.com\js7\<agent_port>agent_<http-port>

Update

The update using the graphical installer can be done by rerunning the installer setup.cmd file from the .zip archive and by providing the same parameters such as installation paths, ports etc.

...

• To perform JS7 Agent instance rollback run the uninstaller.
  • The default location of the uninstall.cmd file is:
    
    • C:\Program Files\sos-berlin.com\js7\agent\Uninstaller
• Restore the folders from the backup by unzipping the .zip archive for the installation directory and configuration directory to the respective locations.
• Re-install the Windows Service from the command line:
  • Switch to the  Agent's .\bin directory from the command line
    • The default location of the .\bin directory is:
      

      • C:\Program Files\sos-berlin.com\js7\agent\bin

  • Run the following command that installs the Agent's Windows Service:

    agent.cmd install-service [--http-port=<number>] [--ip-address=<hostname or ip address>]

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's configuration directory.

• The default path of the logs directory for the Agent is:
  
  • C:\ProgramData\sos-berlin.com\js7\agent_<port> on <http-port> for Windows.
• Installation log files use names according to the pattern Install_V<release>_<date-time>_....log where <release> is the release number and <date-time> refers to the point in time of installation.
• For further information about logging see JS7 - Logging.

...