...

• Download the Agent archive for the target system from the JS7 - Download page.
  
  • For Unix systems:
    • A .tar.gz archive is available that is extracted to create the Agent's directory structure (see below).
      
      • js7_agent_unix.<release><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><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><release>.zip

Installation from .tar.gz/.zip Archive

...

• Extract the downloaded archive file to a directory.
• After extraction the resulting directory structure 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_instance.sh-example
        • The template for the Agent Instance Start Script
      • 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 (configuration directory)
      
      • config (directory for configuration files)
        • agent.conf (general Agent configuration) 
        • private (directory for security related configuration files)
          • private.conf-example  (security related 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 for the YADE file transfer utility)
  • 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
        language bash title Allow 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 has to use its individual ./var_<http<http-port of the instance>instance> data directory, e.g. ./var_4445, ./var_4447 etc.

...

• 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 .tar.gz/.zip archive.
    • Installation Directory:
      • The default installation directory for the Agent is

        • /opt/sos-berlin.com/js7/agent for Unix systems,

        • C:\Program Files\sos-berlin.com\js7\agent for Windows systems.
    • Configuration Directory
      • The default configuration directory for the Agent is
        • /home/<user-account>/sos-berlin.com/js7/agent_<http<http-port> port> for Unix systems,
        • C:\ProgramData\sos-berlin.com\js7\agent_<http<http-port> port> for Windows systems.

Running the Update

...

• When extracting files to the same location then existing files with the same name will be overwritten. Files added by the user remain in place.
  • This is particularly true for the Agent Start Script ./bin/agent.sh|cmd that should not be modified by users. Instead, apply changes to a new Agent Instance Start Script file  ./bin/agent_<http<http-port>port>.sh|cmd. This script is used to configure a number of environment variables and to finally execute the Agent Start Script.
• The .tar.gz/.zip archive includes Java libraries in the ./lib directory that ship with unique file names per Agent release.
  • Therefore, before extracting files, rename or remove an existing ./lib directory in order to store libraries from the current Agent release only to this directory.

...

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

...

• The default location of the logs directory is:
  
  • C:\ProgramData\sos-berlin.com\js7\agent_<http<http-port>port>
• Installation log files are named 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.

Update

Preparation

• Stop the JS7 Agent instanceany 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_<http<http-port>port>

Running the Update

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

...

• To perform the rollback of a JS7 Agent installation run the uninstaller from the command line.
  • The default location of the uninstall.cmd file is:
    
    • C:\Program Files\sos-berlin.com\js7\agent\Uninstaller
• Restore from a previous backup, e.g. by extracting the .tar.gz/.zip archive to the installation directory and configuration directory.
• Re-install the Windows Service from the command line:
  • Switch to the .\bin directory of the Agent installation.
    • The default location of the .\bin directory is:
      

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

  • Run the Agent Instance Start Script installs the Agent's Windows Service:

    agent_<http-port>.cmd install-service [--http-port=<number>]

Automated Start-up and Shutdown

...