Skip to end of metadata
Go to start of metadata

Installing the JS7 Controller

Prerequisites

Preparation

  • Choose the Controller archive for the target system from the JS7 - Download page.
  • For Windows systems a .zip archive including the installer is available.

Installation

  • Extract the downloaded archive js7_controller_windows_installer.<release>.zip to a directory, e.g. C:\Temp.

  • The installer can be run with a GUI or in headless mode, see JS7 - Controller - Use of Linux/Windows Headless Installation.

  • The installer asks for elevated administrator 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 dialog for the JS7 Controller using

    Windows command to run the installer GUI
    > C:\Temp\controller.<release>\setup.cmd
  • The installer asks for elevated administrator permissions.  
  • Select the language to be used for the setup: English and German are available.

    LanguageSelection


  • Click Next on the welcome window.

    Welcome Page

  • The License Agreement displayed with step 2 of the installation has to 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 that is used by the JS7 Controller. Make sure that the HTTP port is available, i.e. is 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 select 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\controller\logs.
  • The installer sets read/write permissions for the specified Windows Service user account. Typically only the administrator group should have write permissions for C:\Program Files.



  • This step displays the progress of the first part of the installation procedure.
  • Changes to the installer options can no longer be applied once this step was started.



  • The Processing panel displays progress of the second part of the installation procedure.



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

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


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

Updating the JS7 Controller

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

  • js7_controller_windows_installer.<release>.zip

Preparation

  • Stop the JS7 Controller instance.
  • Prepare to rollback in case that the update of the JS7 Controller is not successful:
    • Take a backup of the Controller's installation directory and configuration directory, e.g. by creating a .zip archive.
      • Installation Directory
        • The default installation path for the Controller is C:\Program Files\sos-berlin.com\js7\controller\<controller-id>
      • Configuration Directory
        • The default configuration path for the Controller is C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>

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 Controller instance rollback run the uninstaller.
    • The default location of the uninstall.cmd file is:
      • C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\Uninstaller
  • Restore the folders from the backup by unzipping the .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 Controller from the command line.
      • The default location of the .\bin directory is:
        • C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\bin

    • Run the below command that installs the Controller's Windows Service. 

      controller.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_CONTROLLER_LOGS or in the logs sub-directory of the Controller configuration directory.

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

Further References



  • No labels
Write a comment…