Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 'File Locations' section updated

...

  • The JOC Cockpit can only be used to operate JobScheduler Masters in versions 1.11 and newer. These JobSchedulers have to use a separate schema, user and database to any other JobSchedulers that use the same DBMS because of changes made to the database tables for version 1.11.
  • The JOC Cockpit can only be installed alongside a JobScheduler Master version 1.11 and newer.
    In high availability environments the JOC Cockpit can be used with a remote DBMS,
    Status
    title< CONFIRM DBMS can be on different computer
  • An Oracle Java 8 JRE has to be installed if not already installed for the JobScheduler. Note that Oracle Java 9 has not yet (December 2016) been tested with the JOC Cockpit.
    The JAVA_HOME variable should be set to point to the JRE.
    Status
    title< CONFIRM DBMS can be on different computer
  • A web server such as Jetty or Tomcat, which is capable of handling Java web applications is required. This can be the Jetty provided with the JOC Cockpit installation.
    Status
    title< DOES jetty InSTANCE HAVE TO INSTALLED ON SAME COMPUTER?

...

The JOC Cockpit is available for Linux and Windows operating systems in and the same archive can be used for installation on 64-bit and on 32-bit systems. See the Which platforms is JobScheduler available for and what platform support is provided? article for more information.

Status
titleAP@AP: IS ARTICLE CORRECT TARGET?

...

  • joc_linux.[release].tar.gz Statustitle< Definition to be added
  • joc_windows.[release].zip

where release is the release number.

These archives can be used to install the JOC Cockpit either as a dialog or as a batch process and for both 32 and 64-bit systems.

...

  • Code Block
    languagetext
    titleStarting batch installation of the JOC Cockpit installer on Linux systems
    /tmp/jobscheduler.[release]> ./setup.sh
  • Code Block
    languagetext
    titleStarting batch installation of the JOC Cockpit installer on Windows systems
    C:\temp\jobscheduler.[release]> setup.cmd

The installation dialog is shown described in the following sections.

...

Installation Dialog

  • Language Selection

    • Select the language to be used for the setup: English and German are available.


  • Step 1 - Welcome Screen



  • Step 2 - Licensing Agreement

    • The License Agreement shown in Step 2 of the installation has to be accepted before installation can take place.



  • Step 3 - Target Path for the Installation

    • The path to the installation directory for the JOC Cockpit program files - referred to later in this page as the joc_installation_directory - is set in this step.
    • The default installation paths for the JOC Cockpit are:

      • /opt/sos-berlin.com/joc on Linux systems and

        Status
        title< To Verify

      • C:\Program Files\sos-berlin.com\joc on Windows.
    • Users can use the Step 3 installation form shown below to specify their own installation path for the JOC Cockpit if required. 



  • Step 4 - User Data / Install Jetty

    • The JOC Cockpit requires a Java-capable web server and comes with a Jetty server. Step 4 allows system administrators specify whether this web server is to be installed and if yesso, to specify its configuration - i.e. the port(s) it uses - and installation path.
    • The Install JOC ... inclusive Jetty checkbox specifies whether the Jetty web server should be installed.
    • While the Jetty web server delivered with the JOC Cockpit is installed in the joc_installation_directory - the Jetty configuration files are installed alongside the JOC Cockpit log and configuration files in the jetty_base directory. The Jetty Base field in the form shown below can be used to set the jetty_base directory.
      The default paths to the jetty_base directory are:
      • /home/[user]/sos-berlin.com/joc on Linux systems and

        Status
        title< To Verify

      • C:\ProgramData\sos-berlin.com\joc on Windows.
    • Note that if If the Jetty delivered with the JOC Cockpit is not to be installed and either an alternative Jetty installation or another web server is to be used, then relevant configuration files required for such a server such as the shiro.ini and joc.properties files will still be written to the file system. These files can then be moved by the system administrator to the suitable location for their web server as required. See the Configuration with Alternative Web Servers section below for more information.

  • Step 5 - Choose the DBMS

    • The type of DBMS used by the JobSchedulers operated by the JOC Cockpit is specified in this step.

      • The DBMS type can be found in the database configuration for job history section of the $JOBSCHEDULER_DATA/factory.ini file of one of the JobSchedulers to be operated from the JOC Cockpit, where $JOBSCHEDULER_DATA is defined in the JobScheduler - Installation Guide (Section 1.2).
    • The database configuration for the JOC Cockpit is written to an XML file during installation and saved in the jetty_base/resources/joc folder.
      The default name of the database configuration file is:
      • hibernate.cfg.xml
    • The name and location of the database configuration file is specified in the joc.properties file, which can also be found in the jetty_base/resources/joc folder.
      The default name and location of the database configuration file are:
      • resources/joc/hibernate.cfg.xml
      Image Removed


    • Image Added

  • Step 6 Step 6 - Configure the Database Connection

    • The access parameters for the DBMS used by the JobSchedulers operated by the JOC Cockpit are specified in this step.

      • The DBMS access parameters used can be found in the database configuration for job history section of the $JOBSCHEDULER_DATA\factory.ini file of one of the JobSchedulers, where $JOBSCHEDULER_DATA is defined in the JobScheduler - Installation Guide (Section 1.2).


  • Step 7 - No longer required

  • Step 8 - Installation

    • Progress of the first part of the installation procedure is shown in this step.



  • Step 9 - Processing

    • This step shows the progress of the second part of the installation procedure.


  • Step 10 - Completion

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

    • Note that if a problem occurs during installation a warning message will be shown here and a link to the installation log file provided at this step if a problem occurs during installation.

  • Initial Testing with the JOC Cockpit Login Form

    Note that a  working web server - either the Jetty provided with the JOC Cockpit or another - is required before the JOC Cockpit installation can be tested.
    To test the JOC Cockpit:
    • Call the JOC Cockpit login form in a web browser and enter the username and password.

      After a first installation of the JOC Cockpit the default User Name and Password of root:root and Shiro Authentication will be active, if no changes have been made to the shiro.ini configuration file.

      See the Authentication and Authorization Configuration article for information about the configuration of other user profiles and authentication methods.

    • Note that on some systems the web service may take a minute to start and display the login form shown below.

...

The JOC Cockpit can be uninstalled using the uninstall.cmd script saved in the folder (on Windows systems):

  • on Linux systems:
    • ...   /opt/sos-berlin.com/joc/Uninstaller  < PATH TO BE COMPLETEDverified
  • on Windows systems:
    • C:\Program Files\sos-berlin.com\joc\Uninstaller

...

Ticking the "Force the deletion of C:\Program Files\ ...." checkbox will cause the uninstall script to remove boththe program and the configuration files and folders.

...

If the Jetty provided with the JOC Cockpit is not to be installed, the installation program will look and see if configuration files jetty_base shortcut from a previous installation are is to be found in a subdirectory of the jetty_basehome directory. Particularly relevant for system administrators would be the shiro.ini file (containing authentication and authorization information) and the joc.properties file (containing database configuration information).

  • If configuration files are found then these will not be overwritten or removed.
  • Default configuration files will be written to the file system in in the joc_home directory.
  • System administrators can then move the shiro.ini file and other resources the configuration files to the appropriate application directory as required.

...

With a fresh installation, the installer will not find any existing Jetty and will save the resources directory by default as follows:

  • on Linux systems:
    • /homeopt/[user]/sos-berlin.com/joc/resources/joc   < PATH TO BE CONFIRMED
  • on Windows systems:
    • C:\Program Files\sos-berlin.com\joc\resources\joc

...

If the JOC Cockpit is being installed without the included Jetty but on top of an installation that has included the JOC Cockpit Jetty then the resources\joc folder will not be moved from its location. This means that the "new" resources folder will be found after the new installation as follows (if the original installation was carried out in the default directory):

  • on Linux systems:
    • /home/[user]opt/sos-berlin.com/joc/resources/joc   < PATH TO BE CONFIRMED
  • on Windows systems:
    • C:\ProgramDataProgram Files\sos-berlin.com\joc\resources\joc

In this situation the shiro.ini and joc.properties file from the earlier installation will not be overwritten.

The "old" hibernate.cfg.xml database configuration file will be read during the installation and the settings suggested as default values. The file itself will be deleted and a new onw saved in the joc_home directory.

An update of the JOC Cockpit will neither overwrite the new or old configuration files. However new versions of the joc.properties and shiro.ini files named joc.properties-example and shiro.ini-example will be written to the resources\joc folder, alongside the originals.

...