Installing the JS7 Agent

Prerequisites

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

Preparation

• Choose the Agent archive for the target system from the JobScheduler Download page.
• For Windows systems a .zip archive is available.

Installation

• Extract the downloaded archive js7_agent_windows_installer.x.x.x.zip to an arbitrary directory, e.g. C:\Temp.

• The installer can run with or without a GUI.

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

• Run the installer dialog for the JS7 Agent using

  Windows command to open the installer GUI

  > C:\Temp\agent.x.x.x\setup.cmd

• The installer asks for elevated administrator permissions.  
• Select the language to be used for the setup: English and German are available.
  
  
  
  
  
• Click Next on the Welcome window of the Installation screen
  
  
• The License Agreement displayed with Step 2 of the installation must be accepted before installation can occur.
  
  
  
  
• The installer opens a GUI to specify the installation path after you accept the terms of the license agreement.
  
  
  
  
• Add the HTTP port which can be used by the JS7 Agent. Make sure that the HTTP port is available, i.e. not otherwise used. If you run other applications that use this port then choose a different port.
• If you specify a service account then make sure that this account has "Log on as service permissions".
  
  
  
  
• If you selected the installation path 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>\logs.
• The installer sets read/write permissions for the specified Windows service user but normally exclusively the administrator group should have write permissions for C:\Program Files.
  
  
  
  
• This step shows the progress of the first part of the installation procedure.
• Changes to the installation configuration can no longer be made once this step has started.
  
  
  
  
• The Perform External Process shows the progress of the second part of the installation procedure.
  
  
  
  

  • The information displayed with this step will be written to the installation log file that can be found in the JS7_AGENT_DATA/logs folder.
    
    

• The last step of the installation displays a summary of the installation (success/error) and paths to relevant information.

  
  
  

  • Note that if a problem occurs during installation a warning message will be displayed and a link to the installation log file will be provided.

Updating the JS7 Agent

An update of the JS7 Agent is performed from the same download archive as used for any fresh installation:

• js7_agent_windows_installer.x.x.x.zip for Windows

Preparation

• Stop the JS7 Agent instance.
• Prepare to rollback in case that the update of the JS7 Agent is not successful:
  • Create a .zip archive for the
    • Installation Directory:
      • The default installation path for the Agent is C:\Program Files\sos-berlin.com\js7\agent on Windows.
    • Configuration Directory
      • The default configuration path for the Agent is C:\ProgramData\sos-berlin.com\js7\<agent_port> on Windows.
• Take a Backup of the above archives created.

Update

The update using the GUI 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.

Rollback

To perform the rollback on Windows follow the below steps:

• 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 on Windows.
• Restore the folders from the backup by unzipping the .tar.gz/.zip archive for the installation directory and configuration directory to the respective location.
• Re-Install the windows service from the command line:
  • Switch to the ./bin directory for the Agent from the command line
    • The default location of the ./bin directory is:
      

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

  • Run the below command. This command 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 subdirectory of the Agent configuration directory.

• The default path of the logs directory for the Agent are:
  
  • C:\ProgramData\sos-berlin.com\js7\agent_<port> on Windows.
• Installation log files are named according to the pattern, Install_V[release]_[date&time]_....log where release is the version release number and date and time refer to the installation.

• For further information about logging refer to the overview of log files with the JS7 - Logging article.

Further References

• JS7 - Agent - Command Line Operation