...

• 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 (copy of JS7 JobScheduler Commercial License Agreementplain text format of license terms for the commercial JS7 - License)
    • ThirdParty.txt (list of 3rd party components and licenses included with the used by JS7 Agent)
    • bin
      • agentanonymize-logs.cmd|sh
        • The Start Script for Windows/Unix platforms
      • agent_credential_value.cmd|sh
        • The script for access to a credential store on Windows/Unix platforms
      • agent_instance.sh-example
        • The template for the Agent Instance Start Script
      • 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 / 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)agent_watchdog.cmd|shRestarts the Agent for Windows/Unix platforms
    • lib (directory for Java libraries)
      • service (directory for operation as a Windows Service)
      • • 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 Agentvar (configuration directory)
        
        • config (directory for configuration files)
          • agent.conf (general Agent configuration, see JS7 - Agent Configuration Items) 
          • private (directory for security related configuration files)
            • private.conf-example  (security related configuration, see JS7 - Agent Configuration Items)
              
              • For setting up HTTPS connections see up JS7 - Agent Configuration ItemsHTTPS Connections
              • For setting up authentication and digital signature checks
            • trusted-pgp-keys (empty directory, can be used to add individual PGP public keys for signing, see JS7 - Secure Deployment)
            • trusted-x509-keys (directory to hold X.509 certificates for signing, see JS7 - Secure Deployment)
              • sos.intermediate-ca.pem (default certificate of SOS to allow deployment with JOC Cockpit)
        • logs (directory for log files)
        • state (directory for journal files, will be created on startup of the Agent)
        • work (directory for work files)
      • 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
          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 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.
    • 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 and Shutdown" section below.

  ...

  • The Agent installation uses the agent_install.xml response file, which 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

    Code Block
    language xml title Configuration of the agent_install.xml file linenumbers true collapse true
    <?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"/> <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

  • Running Run the installer for the JS7 Agent on Windows systems with the following command:

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

  ...

  • 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

  Automated

  ...

  Start-up and Shutdown

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

  • Note the use of the JS7_AGENT_USER environment variable from the ./bin/agent_<http-port>.sh instance start script  Instance Start Script to run an Agent that is started by root for a different user account.
  • A sample service file for use with systemd can be found at ./bin/agent.service-example.
  • For details see JS7 - systemd Service Files for automated Startup / Shutdown with Unix Systems

  Operation of the Agent by a Windows Service is recommended for Windows systems as such services can be configured to start/stop automatically on server startup start-up and shutdown.

  • Consider assigning a service account to the JS7 Agent service with the Windows Service Panel.
  • Consider allowing the JS7 Agent service to be automatically started on server startupstart-up.

  Initial Operation

  Having completed the installation or update of a JS7 Agent you can start the Agent either manually or from its Unix daemon/Windows Service, see JS7 - Agent Command Line Operation.

  ...