Introduction

  • Initial Operation is performed after installation of the JS7 Agent, Controller and the JOC Cockpit.
  • Operation of a JOC Cockpit Cluster requires a commercial license, see JS7 - License for details.
  • Tasks include to apply the license key and licensed binary code.

Prerequisites

Initial Operation requires that a JS7 Agent, Controller and the JOC Cockpit have been successfully installed and are up and running.

JOC Cockpit Cluster Checks

Check Security Level

Any JOC Cockpit cluster members have to use the same Security Level (low, medium, high), see JS7 - Security Architecture, section Secure Configuration.

The JOC Cockpit has to be reinstalled to apply changes to the Security Level.

Check Database Connection

Any JOC Cockpit cluster members have to use the same database connection.

To apply changes, modify the Hibernate hibernate.cfg.xml configuration file:

  • Unix
    • Default Location: /var/sos-berlin.com/js7/joc/resources/joc
    • A different location for the configuration directory can be specified during installation.
  • Windows
    • Default Location: C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>\config
      • where <controller-id> is the unique identifier for the Controller that is specified during installation.
    • A different location for the configuration directory can be specified during installation.
  • Hibernate configuration examples can be found in the JS7 - Database article.

Check Instance Settings

A title and ordering can be specified for each instance when installing the JOC Cockpit, which will then be shown in the JS7 - Dashboard:

  • Use a different title for each JOC Cockpit instance to better distinguish instances in the JS7 - Dashboard view.
  • Use an ordering of your choice that determines the sequence in which JOC Cockpit instances are displayed in the Dashboard view.

Both settings are made in the joc.properties file, as shown in the following example:

Title and Ordering from joc.properties
################################################################################
### If JOC Cockpit is used in a cluster then specify a title to identify which node
### is currently used. Further specify the ordering (Primary <= 0, Standby > 0) for
### display of JOC Cockpit instances with the Dashboard view.

title                        = PRIMARY JOC COCKPIT
ordering                     = 0

The joc.properties file can be found in the following location:

  • Unix
    • Default Location: /var/sos-berlin.com/js7/joc/resources/joc
    • A different location for the configuration directory can be specified during installation.
  • Windows
    • Default Location: C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>\config\license
      • where <controller-id> is the unique identifier for the Controller specified during installation.
    • A different location for the configuration directory can be specified during installation.

Adding License Key and Licensed Binary Code

Customers possessing a commercial license will receive a license key from SOS and can download the binary code that allows clustering of JS7 products - see the JS7 - Download article.

A short description of the procedure required to add the license key is provided below - for a detailed description, see the JS7 - How to apply a JS7 License Key article.

Handling for Installation on premises

The following chapters can be skipped if a license key and licensed binary code have been added during installation of JOC Cockpit. The instructions provided here apply when a license key and licensed binary code are to be added or replaced for an existing installation without updating JOC Cockpit from the installer.

Adding a License Key

  • The license key can be added during installation of each JOC Cockpit instance.
  • The license key can be added later on by saving the license certificate file in the following location:
    • Unix: JOC Cockpit Configuration Directory license sub-folder
      • Default: Location /var/sos-berlin.com/js7/joc/resources/joc/license
      • A different location for the configuration directory can be specified during installation.
    • Windows: JOC Cockpit Configuration Directory license sub-folder
      • Default Location: C:\ProgramData\sos-berlin.com\js7\joc\resources\joc\license
      • A different location for the configuration directory can be specified during installation.

Adding Licensed Binary Code

  • Binary code for clustering is available from the js7-license.jar file which is available from the JS7 - Download page.
  • By downloading the binary code for clustering users consent with the license terms for a commercial license of JS7.
  • The js7-license.jar file has to be saved in the following location:
    • Unix: JOC Cockpit Configuration Directory lib/ext/joc sub-folder
      • Default Location/var/sos-berlin.com/js7/joc/jetty_base/lib/ext/joc
      • A different location for the configuration directory can be specified during installation.
    • Windows: JOC Cockpit Configuration Directory lib\ext\joc sub-folder
      • Default Location: C:\ProgramData\sos-berlin.com\js7\joc\jetty_base\lib\ext\joc
      • A different location for the configuration directory can be specified during installation.

Handling for Container Installation

Basically the same locations for license key and licensed binary code apply as explained for Unix operating systems in previous sections of this article.

Note that the container's file system cannot be accessed before the container is running, which makes it impossible to add or replace licensed binary code before the JOC Cockpit has been started.

Adding a License Key

  • The license key can be added by saving the license certificate file in the following location:

Adding Licensed Binary Code

  • Binary code for clustering is available from the js7-license.jar file, which is available from the JS7 - Download page.
  • By downloading the binary code for clustering users consent with the license terms for a commercial license of JS7.
  • The js7-license.jar file has to be saved in the following location:
    • /var/sos-berlin.com/js7/joc/jetty_base/resources/joc/lib
    • The /var/sos-berlin.com/js7/joc/jetty_base/resources/joc directory is typically mounted to a config volume when running the container: for details see the JS7 - JOC Cockpit Installation for Containers article. The lib sub-directory should be created if it does not already exist before saving the js7-license.jar file.

On start-up the JOC Cockpit checks the above directory for existence of the js7-license.jar file. If the file is found then:

  • the file will be copied to ./jetty_base/lib/ext/joc 
  • any existing version of the file in this directory will be overwritten.

Initial Operation

Login to JOC Cockpit User Interface

  • In your browser navigate to the JOC Cockpit URL and enter the User Account and Password. Typically the URL includes the hostname and port that JOC Cockpit has been installed with:

    • For example, http://myhost:4446. Check that the JOC Cockpit port can be accessed. Note that this might include adding firewall rules to allow access to this port from the computer that you are operating the browser on.

    • After initial installation of the JOC Cockpit the default User Account root and Password root will be available if no changes have been made to the default configuration. Accounts can later on be managed with JS7 - Identity Services.

  • Note that the root user is assigned the all role in the default configuration that includes all available permissions.
    See the JS7 - Authentication and JS7 - Authorization articles for information about the configuration of authentication methods.

  • Note that the JOC Cockpit web service might take a minute to start and to display the login window.

Command Line Operation

  • Command line operations include starting and stopping the JOC Cockpit service:
    • from the command line,
    • from a Unix systemd service file,
    • from a Windows Service.
  • For details see the JS7 - JOC Cockpit - Command Line Operation article.

Log files

  • JOC Cockpit makes use of a number of log files.
  • For log file locations, log rotation and log levels see the JS7 - Logging article.

Further References