JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 41

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version Current

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

  • 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, download the software and run the installer that will guide you.
  • In this article you find the details about available installer options, updates and rollback for interested parties.
  • The Controller can be installed by use of the graphical installer, for headless installation see JS7 - Controller - Headless Installation on Linux /and Windows.

Prerequisites

  • A Java Runtime Environment 1.8 or newer is required. For details see Which Java versions is JobScheduler available for?
  • It is necessary that a time service is operated on the server which hosts the Controller. This is to synchronize the system clock's time.
  • Technically the Controller can be operated in any Unix environment. HoweverNote, however, that the JS7 - Platforms include article describes support for Controller operation with Linuxin more detail.

Download

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

Installation Video

This video explains how to install the JS7 Controller:

Widget Connector
urlhttps://www.youtube.com/watch?v=yRQXLLchLaY

Installing the JS7 Controller

...

  • The installer can be run in graphical mode or in headless mode, see JS7 - Controller - Headless Installation on Linux /and Windows.

  • 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 Controller -id=<controller-id>"
    • an executable file .\service\js7_controller_<controller-id>.exe that is started by the Windows Service.

...

  • Run the installer for the JS7 Controller using the following script:

    Code Block
    languagebash
    titleWindows command to run the graphical installer
    > C:\Temp\controller.<release>\setup.cmd
  • The installer asks for administrative privileges.  
  • Select the language to be used for the setup: English, Japanese and German are available.

...

License Agreement

  • The License Agreement corresponding to the license option selected has to be accepted before installation can occur.

...

  • In the next window the Controller ID, which is a unique identifier for a Controller, is specified. You can use identifiers such as "controller-test", "controller-production" etc. Character case is significant, the characters a-z, A-Z, 0-9, underscore and hyphen are allowed. Spaces are not allowed in a Controller ID.
  • If you intend to operate a Controller cluster with two Controller instances for the active and standby cluster members, then specify the same identifier during installation of each Controller instance as otherwise the instances will not be considered members of the same cluster. This identifier cannot be modified after installation, changes to the Controller ID require reinstallation of the Controller.
    • A checkbox allows the initial role of the current Controller instance to be specified - i.e. whether it starts with an active or a standby role. Do not select this checkbox if you are operating a standalone Controller instance.
    • Note that operation of a Controller cluster requires a license certificate to have been specified in the License Agreement step described above. See also JS7 - LicensingLicense.
  • Add the HTTP port that is to be used by the JS7 Controller. Make sure that the HTTP port is available and is not otherwise used. If you run other applications that use this port then choose a different port.
  • If you specify a Windows Service account then make sure that this account has "Log on as service permissions". Consider that credentials that you enter to this window are stored in clear text with the installer response file. It is considered more secure not to add credentials with this step, but to add credentials directly after installation using the Windows Service panel.

...

  • The resulting directory structure after installation includes (only files and folders immediately relevant):
    • C:\Program Files\sos-berlin.com\js7\controller (installation directory)
      • .js7controllerinstallinformation (binary installer information)
      • .version (release informationvar (symbolic link to configuration directory)
      • controller_install.xml (installer response file used for from previous installation)
      • 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)
      • sbom.json (JS7 - Software Bill of Materials)
      • ThirdParty.txt (list of 3rd party components and licenses included with the used by JS7 Controller) .version (release
      • informationvar (junction to data directory)
      • bin
        • anonymize-logs.cmd (used to anonymize log files, see JS7 - Log Anonymization)
        • controller.cmd (Start Script)controller.cmd|shThe Start Script for Windows/Unix platforms
        • controller_instance.cmd|sh-exampleexample (Sample Instance Start Script to set individual environment variables. Drop the -example extension to activate this file.)
        • controller_watchdog.cmd|sh
          • Restarts the Controller for Windows/Unix platforms.
          cmd (restarts the Controller if not operated as a Windows Service, called by Start Script)
      • lib (directory for Java libraries)lib (directory
        • for Java libraries)
      • service (directory for operation as a Windows Service)
        • install_controller_windows_service.cmdcmd (used by installer)
        • js7_controller_<controller-id>.exe
        • js7_controller_<controller-id>w.exe
        • LICENSE.txttxt (copy of Apache License, Version 2.0)
        • NOTICE.txttxt (Apache Commons Daemon license notice)
        • RELEASE-NOTES.txttxt (Apache Commons Daemon release notes)
        • uninstall_controller_windows_service.cmdcmd (used by uninstaller)
        • amd64
        • manager
        • x86
      • Uninstaller (Uninstaller directory for Windows only, the empty directory remains in place after uninstall)
        • install.log (lists installed files)
        • js7.ico (uninstaller icon)
        • shortcut.vbs (creates shortcuts for the Windows start menu)
        • uninstall.cmd (used by uninstaller)
        • uninstall_prepare.cmdcmd (used by uninstaller)
        • uninstaller.jarjar (used by uninstaller)
    • C:\ProgramData\sos-berlin.com\js7\controller (configuration directory)var (data directory)
      • controller_home (symbolic link junction to installation directory)
      • config (directory for configuration files)
      • logs (directory for log files)
      • state (directory for journal files)
      • work (directory for work files)

Rollback

To perform a rollback on Windows systems follow the below steps:

...

  • The default location of the logs directory for the Controller is:
    • C:\ProgramData\sos-berlin.com\js7\controller/<controller-id> on 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 .

Automated Startup and Shutdown

For Unix systems startup and shutdown configurations apply that are executed by the root account e.g. from /etc/init.d scripts and by use of systemd.

For Windows systems operation of the Controller by a Windows Service is recommended as these such services can be configured to start/stop automatically on server startup and shutdown.

  • Consider assigning to assign a service account to the JS7 Controller service with the Windows Service Panel.
  • Consider allowing to allow the JS7 Controller service to be automatically started on server startup.

...

Info

Further References