Versions Compared

Key

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

...

  • Run the installer for JS7 Controller parametrized with the controller_install.xml the file that is included with the extracted archive.

  • This parameter file is preconfigured, i.e. you can run it without any changes.

    Code Block
    languagebash
    titleWindows command to open the installer GUI
    > cd C:\Temp\controller.x.x.x
    > setup.cmd controller_install.xml
  • If you run the installer without modifications in controller_install.xml then
    • the installation path is C:\Program Files\sos-berlin.com\js7\controller
    • the http port is 4444
    • the log folder is C:\ProgramData\sos-berlin.com\js7\controller
  • If you want to modify the default options then edit the controller_install.xml file before you start the installer.

    • The default controller_install.xml the file is shown in the code listing below. The extensive comments are intended to be self-explanatory. 


      Code Block
      languagexml
      titleContent of controller_install.xml
      linenumberstrue
      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
      <!-- 
      XML configuration file for JS7 Controller setup
      
      The JS7 Controller is available with a dual licensing model.
      - GNU GPL 2.0 License (see http://www.gnu.org/licenses/gpl-2.0.html)
      - JS7 Commercial License (see licence.txt)
      
      The setup asks you for the desired license model 
      (see <entry key="licenceOptions" .../> below).
      
      If you call the setup with this XML file then you accept 
      at the same time the terms of the chosen license agreement. 
      -->
      <AutomatedInstallation langpack="eng">
          <com.izforge.izpack.panels.UserInputPanel id="home">
              <userInput/>
          </com.izforge.izpack.panels.UserInputPanel>
          <!--com.izforge.izpack.panels.UserInputPanel id="licences">
              <userInput-->
              
                  <!-- Select the license model (GPL or Commercial) -->
                  <!--entry key="licenceOptions" value="GPL"/-->
                  
                  <!-- If you selected GPL as license model than the licence must be empty.
                       Otherwise please enter a license key if available.
                       It is also possible to modify the license key later. -->
                  <!--entry key="licence" value=""/>
                  
              </userInput>
          </com.izforge.izpack.panels.UserInputPanel-->
          <com.izforge.izpack.panels.HTMLLicencePanel id="gpl_licence"/>
          <com.izforge.izpack.panels.HTMLLicencePanel id="commercial_licence"/>
          <com.izforge.izpack.panels.TargetPanel id="target">
              
              <!-- SELECT THE INSTALLATION PATH
                   The installation expands this path with the JS7 ID as subdirectory.
                   It must be absolute!
                   For example C:\Program Files\sos-berlin.com\js7\controller -->
              <installpath>C:\Program Files\sos-berlin.com\js7\controller</installpath>
              
          </com.izforge.izpack.panels.TargetPanel>
          <com.izforge.izpack.panels.UserPathPanel id="userpath">
              
              <!-- SELECT THE DIRECTORY FOR CONFIGURATION AND LOG FILES
                   The installation expands this path with the JS7 ID as subdirectory.
                   The path must be absolute!
                   Default path is C:\ProgramData\sos-berlin.com\js7\controller -->
              <UserPathPanelElement>C:\ProgramData\sos-berlin.com\js7\controller</UserPathPanelElement>
              
          </com.izforge.izpack.panels.UserPathPanel>
          <com.izforge.izpack.panels.UserInputPanel id="network">
              <userInput>
              
                  <!-- ID of the JS7 Controller -->
                  <entry key="controllerId" value="controller"/>
                  
                  <!-- Choose yes if the JS7 Controller is a Standby-Controller in a cluster -->
                  <entry key="isStandby" value="no"/>
                  
                  <!-- Choose (yes or no) wether the JS7 Controller should be started at the end of the installation -->
                  <entry key="launchController" value="yes"/>
                  
                  <!-- HTTP port of the JS7 Controller -->
                  <entry key="controllerPort" value="4444"/>
                  
                  <!-- Set optionally an ip address or hostname. It could be used for indicating which network 
                       interfaces the JS7 Controller should listen to when using HTTP. If it is empty then 
                       it listens to all available network interfaces. -->
                  <entry key="controllerHost" value=""/>
                  
                  <!-- The JS7 Controller will be installed as Windows service. You can set the service
                       account otherwise the local system account will be used. The account has to be the form 
                       'Domain\User'. -->
                  <entry key="serviceAccount" value=""/>
                  <entry key="servicePassword" value=""/>
                  
              </userInput>
          </com.izforge.izpack.panels.UserInputPanel>
          <com.izforge.izpack.panels.UserInputPanel id="environment">
              <userInput>
      
                  <!-- Directory where the JS7 Controller's log files are stored (default: 
                       '[above user path]\logs'). -->
                  <entry key="logPath" value=""/>
                  
                  <!-- Directory where the JS7 Controller's pid file is stored (default: 
                       above log path). -->
                  <entry key="pidFilePath" value=""/>
                  
                  <!-- Working directory for all jobs which started by the JS7 Controller
                       e.g. %USERPROFILE% (default: [installation path]) -->
                  <entry key="workPath" value=""/>
                  
                  <!-- The JS7 Controller requires a Java JRE at least version '1.8'. You can choose 
                       a different Java environment than the Java which is used during this installation. -->
                  <entry key="javaHome" value=""/>
                  
                  <!-- Set optionally Java options (default: -Xmx500m). -->
                  <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>
      

Debugging

  • The Controller log level can be increased using the Controller's Apache ProcRun Demon Service Manager demon/service.
  • On Windows systems, this is installed in the Controller service Folder and will have a name such as js7_controller_<Controller ID>w.exe  where Controller ID is the unique ID for the Controller 
  • Start the ProcRun Manager, select the Logging tab in the Manager interface and set the level to Debug
  • The location of the log files has already been described above. 
  • Do not forget to set the debug level back to Info once finished.