Versions Compared

Key

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

...

  • 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) used for the Open Source JS7 - License)
      • license.html (HTML format of license terms for the commercial JS7 - License)
      • license.txt (plain text format of license terms for the commercial JS7 - License)
      • ThirdParty.txt (list of 3rd party components and licenses used by JS7)
      • bin
        • anonymize-logs.sh|.cmd (used to anonymize log files, see JS7 - Log Anonymization)
        • agent.sh|.cmd (Start Script for Unix/Windows platforms)
        • agent.service-example (sample file for use with JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems)
        • agent_credential_value.sh|.cmd (Script for access to a Credential Store on Unix/Windows platforms)
        • agent_instance.sh-example (template for the Agent Instance Start Script)
        • agent_watchdog.sh|.cmd (restarts the Agent for Unix/Windows platforms if not operated as a Daemon/Service, called by Start Script)
      • lib (directory for Java libraries)
        • log4j2.xml (used for based console logging to stdout, see JS7 - Logging)
        • patches (used for JS7 - Patches for Agent, the directory is cleaned up when running the installer)
        • user_lib (used for individual .jar files such as JDBC Drivers, see JS7 - Database)
        • (additional directories for Java libraries)
      • service (directory for operation as a Windows Service)
        • install_agent_windows_service.cmd (used by installer)
        • LICENSE.txt (copy of Apache License, Version 2.0)
        • NOTICE.txt (Apache Commons Daemon license notice)
        • RELEASE-NOTES.txt (Apache Commons Daemon release notes)
        • uninstall_agent_windows_service.cmd (used by uninstaller)
        • amd64
        • manager
        • x86
      • var (data directory, to be copied to var_<http_port> directory based on the HTTP port used by the Agent)
      • yade (directory for the YADE file transfer utility)
    • On Windows Systems:
      • You have to modify the directory permissions for the above-mentioned .\logs and .\service directories if you extracted the Agent to, for example, C:\Program Files.
        • This step is not required if you extract the Agent to, for example, C:\ProgamData.
        • Start a command prompt with elevated administrative rights and execute, for example:

          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 more than one run-time instance of an Agent starting from the same Agent installation is used then every instance has to use its individual ./var_<http-port of the instance> data directory, e.g. ./var_4445, ./var_4447 etc. as each Agent instance has to use an individual port when operated on the same server.
      • This allows to operate each Agent instance with a different run-time account executing jobs within the context of this account.
      • Alternatively users can switch the run-time account on a per job basis, see JS7 - Running Jobs as a different User.
    • To start the Agent you can use the commands explained in the JS7 - Agent - Command Line Operation article or your can automate startup from the instructions provided by the "Automated Startup the Automated Start-up and Shutdown" section below.

Update and Upgrade

...

  • To perform a 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 and configuration directories.
  • 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

Anchor
automated_startup_shutdown
automated_startup_shutdown
Automated Start-up and Shutdown

Start-up and shutdown configurations apply for Unix systems. These are executed by the root account e.g. from /etc/init.d scripts and use systemd.

...