Table of Contents
Anchor
Installation_Requirements	Installation_Requirements

Introduction

The JOC Cockpit can be installed on Linux and Windows systems without the use of a graphical installer by running the JOC Cockpit installer in headless mode. See the JS7 - JOC Cockpit - Installation Using the Graphical Installer for Linux and Windows article for instructions on the use of a graphical installer.

Prerequisites

The following requirements have to be met before the JOC Cockpit can be installed and operated:

JOC Cockpit requires access to a database to store inventory information, status information and workflow related logs. The database is required for restart capabilities with the JS7 - Cluster Service.
A Java Runtime Environment starting from version 1.8 is required. For details see A Java Runtime Environment in version 1.8 or newer is required. Starting from Release 2.5.0 the minimum Java version is Java 11. For details see the Which Java versions is JobScheduler available for?

Operating Systems

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

HTTPS Authentication

The JOC Cockpit can be operated with HTTPS. However, due to complexities with certificate management it is not recommended to configure the JOC Cockpit to use HTTPS during initial installation. Instead, we recommend that the JOC Cockpit is installed and tested with HTTP and the default authentication mechanism. HTTPS connections and optionally LDAP authentication can be added in a second step. See the JOC Cockpit - Authentication and Authorization and JOC Cockpit - HTTPS Authentication articles for more information.

Download

The following archive files are available for download:

js7_joc_linux.[release].tar.gz
js7_joc_windows.[release].zip

where release is the release number.

The archives can be used to install the JOC Cockpit either from a dialogue or for headless installation with both 32 bit and 64 bit systems.

The archives can be downloaded from:

the JS7 - Download page
the JobScheduler SourceForge page

Installation Procedure

Preparation

Ensure that the Installation Requirements as stated with the above section have been met.
Unpack the JOC Cockpit archive to a suitable directory such as /tmp on Linux systems or C:\temp on Windows.

...

Administrative Permissions

On Windows systems:
- The setup asks for elevated permissions.
On Linux systems:
- Root permissions are required when the JOC Cockpit is to be installed together with Jetty if the Jetty server is to run as a demon, i.e. the Jetty Servlet Container and JOC Cockpit are to be started automatically after reboot of the machine.
- To install JOC Cockpit without root permissions, the start script should be called with the -u argument, otherwise the sudo prompt will ask for a password.

Dialog installation

Dialog installation is started by running the setup.sh or setup.cmd files from the unpacked download archive.

Language Selection

...

Step 2 - Licensing Agreement

...

Step 3 - Target Path for Installation

...

The default installation paths for the JOC Cockpit are:

/opt/sos-berlin.com/js7/joc on Linux systems and
C:\Program Files\sos-berlin.com\js7\joc on Windows.

...

e.g. /home/sos/sos-berlin.com/js7/joc

...

/var/log/sos-berlin.com/js7/logs on Linux systems.

...

Step 5 - JOC Configuration

...

Step 6 - Database Management System

...

Choose the DBMS to be used by the JOC Cockpit for the database.

...

Step 7 - Database connection Configuration

...

The database connection settings from the above screenshot should be evident.

...

The database configuration for the JOC Cockpit is written to an XML file during installation and stored to the jetty_base/resources/joc folder. The default name of the database configuration file is hibernate.cfg.xml.

This file can be modified later on if required. Any text editor can be used. The JOC Cockpit service has to be restarted to apply changes to the hibernate configuration file.

...

Step 8 - Specify the JDBC Driver for the Database Connection

article.
It is necessary that a time service is operated on the server that hosts JOC Cockpit in order to synchronize the system clock's time.
Technically the JOC Cockpit can be operated in any Unix environment. However, support for operation of the JOC Cockpit is limited to Linux systems as described in the JS7 - Platforms article.
The JOC Cockpit requires access to a database to store inventory and status information, as well as workflow related logs - see the JS7 - Database article.
- A schema has to be created in the database prior to installation.
- A user account has to be created that is granted full privileges for the schema.
- If you intend to use different accounts and privilege sets for setup and for operation of the JOC Cockpit then consider switching Hibernate configuration files after setup (see below) to use an account with limited privileges to select, insert, update, delete and execute permissions for schema objects.
Installation of the JOC Cockpit requires administrative privileges in the following situations:
- for Unix systems
  - the JOC Cockpit installer cannot be executed from the root account but can be executed from a user account that makes use of sudo to acquire privileges:
    - to make the root account owner of the installation directory, for example, in /opt
    - to make the user account owner of the configuration directory, for example, in /var
  - administrative privileges are not required for installation with a user account that owns the installation and configuration directories.
- for Windows systems
  - the setup requires administrative privileges.

Download

Download the JOC Cockpit installer archive for your target environment from the JS7 - Download page.
- For Unix systems:
  - A .tar.gz archive including the installer is available which can be used to run the installer.
    - js7_joc_linux.<release>.tar.gz
- For Windows systems:
  - A .zip archive including the installer is available which can be used to run the installer.
    - js7_joc_windows.<release>.zip
The .tar.gz/.zip archives can be used to install JOC Cockpit with the graphical installer or to carry out headless installation.

Installation Video

This video explains the installation.

Widget Connector

url	https://www.youtube.com/watch?v=Q6Ib9YRAGxg&ab_channel=JobScheduler

Installation in Headless Mode

Installation

The installer is available for Windows and Unix systems.

To run the installer in graphical mode see JS7 - JOC Cockpit - Installation Using the Graphical Installer for Linux and Windows.
Installation in headless mode is described below.

Installer Archive

Extract the JOC Cockpit archive to a suitable directory such as /home/<user-account> on Unix systems or C:\user\<user-account> on Windows systems.

The extracted installer directory layout looks like this:

db (not required for installation: directory for DBMS SQL scripts that can be used in case that database objects should be created before installation, see the JS7 - Database article)
- mssql.sql
- mysql.sql
- oracle.sql
- pgsql.sql
hibernate-examples (directory for DBMS Hibernate connection sample files, see the JS7 - Database article)
- hibernate-integrated-security-mssql.cfg.xml
- hibernate-maria-mysql.cfg.xml
- hibernate-oracle12c.cfg.xml
- hibernate-postgres.cfg.xml
install-joc.txt (installation notes)
joc.<release>.jar (installer library for a given release)
joc_install.xml (installer response file)
license.gpl (copy of GPLv3 (General Public License) )
license.html, license.txt (copy of JS7 JobScheduler Commercial License Agreement)
setup.sh, setup.cmd (installer script for Unix, Windows)

Database Connection

The database connection has to be ready prior to installation:

Create a schema and user account in your preferred database. For supported DBMS versions see the JS7 - Database article.
Specify connection information for the JOC Cockpit setup:
- you can specify general connection information during the installation procedure or
- you can prepare a Hibernate configuration file to store connection information.
  - Pick up one of the Hibernate example files listed above which matches your DBMS and copy the file to the installer directory, e.g. with the name hibernate.cfg.xml.
  - Apply your changes to the Hibernate file as explained in the JS7 - Database article.

Installer Response File

The JOC Cockpit makes use of the joc_install.xml file which includes installer options such as the installation directory, ports etc.
Customers with a commercial license should choose the relevant license option and specify the location of the license key file with the installer response file.

The joc_install.xml file is explained with the code listing below. The comments included are intended to be self-explanatory.
Download: joc_install.xml

Code Block

language	xml
title	Configuration of the joc_install.xml file
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- 
XML configuration file for JOC Cockpit setup

The JS7 JOC Cockpit is available with a dual license model:
- GNU GPL v3.0 License, see https://www.gnu.org/licenses/gpl-3.0.en.html
- JS7 Commercial License, see license.txt

The setup asks you for the desired license model,
see below <entry key="licenseOption" .../>

If you run the installer and do not specify a commercial license key
then at the same time you accept the terms of the
license agreement under the GNU GPL v3.0 License.
-->
<AutomatedInstallation langpack="eng">
    <com.izforge.izpack.panels.UserInputPanel id="home">
        <userInput/>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="licenses">
        <userInput>
        
            <!-- Select the license model (GPL or Commercial) -->
            <entry key="licenseOption" value="GPL"/>
            
            <!-- If you select GPL as license model than the 'licenseFile' must be empty.
                 Otherwise please enter the path to the license file if available.
                 It is also possible to add the license file later. -->
            <entry key="licenseFile" value=""/>
            
        </userInput>

...

Configuring the JDBC Driver URL for Oracle^® RAC databases

The JDBC Driver URL for Oracle^® RAC databases should be entered in the Host field of the database connection form. For example:

Code Block

jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(LOAD_BALANCE=OFF)(FAILOVER=ON) 
(ADDRESS=(PROTOCOL=TCP)(HOST=tst-db1.myco.com)(PORT=1604)) 
(ADDRESS=(PROTOCOL=TCP)(HOST=tst-db2.myco.com)(PORT=1604))) 
(CONNECT_DATA=(SERVICE_NAME=mydb1.myco.com)(SERVER=DEDICATED)))

In addition, the Schema and Port fields should be left empty.

Step 9 - Performing the Installation

...

This step displays a progress bar for the first part of the installation procedure.

...

Step 12 - External Processes

...

Step 13 - Completion

...

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

...

Operation

Go to the Initial Operation section of this article for information about opening the JOC Cockpit Interface.

Batch installation

Configuration

The joc_install.xml file has to be configured with parameters such as the installation path, database connections, etc. before installation can start.

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

Code Block

language	xml
title	Configuration of the joc_install.xml file
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- 
XML configuration file for JOC

If you call the installer with this XML file then 
you accept at the same time the terms of the 
licence agreement under GNU GPL 2.0 License 
(see http://www.gnu.org/licenses/gpl-2.0.html)
-->
<AutomatedInstallation langpack="eng">
    <com.izforge.izpack.panels.UserInputPanel id="home">
        <userInput/>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.HTMLLicencePanel id="gpl_licencelicense"/>
    <com.izforge.izpack.panels.HTMLLicencePanel id="commercial_license"/>
    <com.izforge.izpack.panels.TargetPanel id="target">
        
        <!-- SELECT THE INSTALLATION PATH
             The Itpath must be absolute! 
             For example:
             /opt/sos-berlin.com/js7/joc on LinuxUnix
             C:\Program Files\sos-berlin.com\js7\joc on Windows -->
        <installpath>[:choose absolute installation path of JOC Cockpit:]</installpath>
        
    </com.izforge.izpack.panels.TargetPanel>
    <com.izforge.izpack.panels.UserInputPanel id="jetty">
        <userInput>
            
            <!-- JOC Cockpit requires a servlet container such as Jetty. 
                 If a servlet container is already installed then you can use it. 
                 Otherwise a Jetty will be installed in addition if withJettyInstall=yes.
                 You need root permissions to install JOC Cockpit with Jetty. -->
            <entry key="withJettyInstall" value="yes"/>
            <entry key="jettyPort" value="4446"/>
            <!-- Specify the name of the Windows serviceService or LinuxUnix Daemon (default: joc).
                 OnlyRequired necessaryonly for multiple instances of JOC Cockpit on the onesame server. 
  It must be 
            The name has to be unique per server. This entry is deactivated by a comment because it
                 MUST NOT BE CHANGEDMODIFIED DURING OVERRE-INSTALLATION! -->
            <!--
            <entry key="jettyServiceName" value="joc"/>
            -->
            <!-- Only necessaryRequired for Windows only -->
            <entry key="jettyStopPort" value="40446"/>
            <!-- Only necessaryAvailable for Unix only (root permissions required) -->
            <entry key="withJocInstallAsDaemon" value="yes"/>
            <!-- To enter a Enter a user account for running JOC UserCockpit (default=current Useruser). 
                 For Unix only (root permissions required)!!! -->
            <entry key="runningUser" value=""/>
            <!-- Path to Jetty base directory 
                 For example:
                 /home/[user]/sos-berlin.com/js7/joc on LinuxUnix
                 C:\ProgramData\sos-berlin.com\js7\joc on Windows -->
            <entry key="jettyBaseDir" value=""/>
            <!-- Choose ('yes' or 'no)' wetherwhether the JOC Cockpit's Jetty should be (re)started at the end of thestarted after installation -->
            <entry key="launchJetty" value="yes"/>
            
            <!-- Java options for Jetty. -->
            <!-- Initial memory pool (-Xms) in MB -->
            <entry key="jettyOptionXms" value="128"/>
            <!-- Maximum memory pool (-Xmx) in MB -->
            <entry key="jettyOptionXmx" value="512"/>
            <!-- Thread stack size (-Xss) in KB -->
            <entry key="jettyOptionXss" value="4000"/>
            <!-- Further Java options -->
            <entry key="jettyOptions" value=""/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="joc">
        <userInput>
            
            <!-- JOC Cockpit can be installed in a cluster. Please type a unique title to identify the cluster node, 
                 e.g. 'Primary' or 'Secondary' (default = hostname). Max. length is 30 characters. -->
            <entry key="jocTitle" value=""/>
            
            <!-- Choose 'yes' if JOC Cockpit is operated as a standby nodeinstance in a cluster -->
            <entry key="isStandby" value="no"/>
            
            <!-- Security Level for the deployment signing mechanism: possiblypossible values are 'LOW', 'MEDIUM' and 'HIGH':
                 HIGH:
                    publicRSA/ECDSA PGPcertificates keys are stored for verification onlyper user,
                    all signing willis be doneperformed externally outside of JOC Cockpit.
                 MEDIUM:
                    aRSA/ECDSA private PGPkeys keyand willcertificates beare stored for signing per user,
                    signing willis beperformed done automatically with the user's providedprivate key.
                 LOW:
                    a single RSA/ECDSA private key and certificate are stored with the root account,
 no keys will be stored
               signing is performed automatically with signingthe willroot beaccount's doneprivate internallykey withfor defaultall keysusers. -->
            <entry key="securityLevel" value="LOW"/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="database">
        <userInput>
            <!-- Reporting Database Configuration -->
            
            <!-- Database connection settings can be specified with followingsubsequent entries such as
                 databaseHost, databasePort, ... or by a hibernate configuration file  a Hibernate configuration file.
                 or you choose the embedded H2 database (for evaluation only) without further configuration.
                 PosiblePossible values are 'withoutHibernateFile' (default), 'withHibernateFile' and 'withHibernateFileh2'. -->
            <entry key="databaseConfigurationMethod" value="withoutHibernateFile"/>
                 
            <!-- Choose the database management system. 
                 Supported values are 'h2'mysql' for MySQL, 'oracle' for H2 (for evaluation only), 'mysql' for MySQL, Oracle, 
                 'mssql' for Microsoft SQL Server, 'pgsql' for PostgreSQL.
                 Used only if databaseConfigurationMethod=withoutHibernateFile -->
            <entry key="databaseDbms" value="mysql"/>
   'oracle' for Oracle, 'mssql' for MS SQL Server, 'pgsql' for
 PostgreSQL.
           <!-- Path to a Hibernate configuration Onlyfile if databaseConfigurationMethod=withoutHibernateFilewithHibernateFile -->
            <entry key="databaseDbmshibernateConfFile" value="mysql"/>
            
            <!-- Path to a hibernate configuration file if databaseConfigurationMethod=withHibernateFile -->
 You can choose between 'byInstaller', 'byJoc' or 'off' to create the database objects.
                 Data of an <entry key="hibernateConfFile" value=""/>
   already existing installation remain unchanged. 
         
        This entry should  <!-- You can choose between 'on' or 'off' to create the database tablesbe 'off' only when you are certain that all objects have already been created.
                 If you have modified the initial data of an already existing installation, 'byJoc' creates or updates database object the next time JOC Cockpit is started. 'byInstaller' is recommended.
                 If databaseConfigurationMethod=h2 then the modificationsobjects will be created undone.when DataJOC addedCockpit remainsstarts unchanged.and 
                 Thisthis entryvalue shouldwill be only 'off', when you sure, that all tables are already created. ignored -->
            <entry key="databaseCreateTables" value="onbyInstaller"/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="dbconnection">
        <userInput>
            <!-- Database Configurationconfiguration if databaseConfigurationMethod=withoutHibernateFile -->
                 
            <!-- Enter the namehostname or ip address of the database host .
                 This entry can also be used to configure the URL(s) for Oracle RAC databases.
                 For example:
                 <entry key="databaseHost" value="(DESCRIPTION=(ADDRESS_LIST=(LOAD_BALANCE=OFF)(FAILOVER=ON)
                    (ADDRESS=(PROTOCOL=TCP)(HOST=tst-db1.myco.com)(PORT=1604))
                    (ADDRESS=(PROTOCOL=TCP)(HOST=tst-db2.myco.com)(PORT=1604)))
                    (CONNECT_DATA=(SERVICE_NAME=mydb1.myco.com)(SERVER=DEDICATED)))"/>
                 The "databaseSchema" and "databasePort" entries should then be left empty. -->
            <entry key="databaseHost" value=""/>
            
            <!-- Enter the port number for the database instance. Default ports are for H2 1521, MySQL 3306, 
                 Oracle 1521, MSMicrosoft SQL Server 1433, postgreSQLPostgreSQL 5432. -->
            <entry key="databasePort" value=""/>
            
            <!-- Enter the database schema -->
            <entry key="databaseSchema" value=""/>
            
            <!-- Enter the user nameaccount for database access -->
            <entry key="databaseUser" value=""/>
            
            <!-- Enter the password for database access -->
            <entry key="databasePassword" value=""/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="jdbc">
        <userInput>
            <!-- Database Configuration configuration if databaseConfigurationMethod != h2 -->
            
            <!-- You can specify an external JDBC Driver, in connectorthis thencase set internalConnector = no
                 For license reasons MySQL abdand MSMicrosoft SQL Server JDBC drivers are not providedincluded. 
                 Alternatively you can use the mariadbMariaDB JDBC Driver for MySQL whichthat is providedincluded. 
                 For MSMicrosoft SQL Server you have to specify an external JDBC connectorDriver. 
                 An Oracle ojdbc8 JDBC driver is also providedincluded. -->
                 
            <!-- You can choose between 'yes' or 'no' for using the internal JDBC connector
                 or not Driver -->
            <entry key="internalConnector" value="yes"/>
                 
            <!-- Select the path to the JDBC Driver file (*.jar) -->
            <entry key="connector" 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>

Running the Installer

Headless installation is started performed by opening a terminal or command console window in and navigating to the folder containing the setup.sh or setup.* file and by typingcmd file.

Performing headless installation of JOC Cockpit on Unix systems without root permissions:

Code Block

language	text
title	Starting headless installation of the JOC Cockpit on Linux Unix systems with without root permissions

/tmp/joc.[release]> # login as the user account (not as root)
./setup.sh joc_install.xml -u joc_install.xml

All files in the installation and configuration directories will be owned by the user account

Performing headless installation of JOC Cockpit on Unix systems from a user account that can acquire root permissions:

Starting headless installation of the

Code Block

language	text
title	Starting headless installation of the JOC Cockpit on Linux Unix systems without with root permissions

/tmp/joc.[release]> # login as the user account (not as root)
./setup.sh -u joc_install.xml

Code Block

language

text

title

The installer will use sudo to acquire root permissions. Execution of the above command by the root account is denied.
Files in the installation directory will be owned by the root account, files in the data directory will be owned by the user account as described below.

Performing headless installation of JOC Cockpit on Windows systems
```
C:\temp\joc.[release]> setup.cmd joc_install.xml
```

...

Initial Operation with the JOC Cockpit Login Form

Note that a working Servlet Container - either the Jetty provided with the JOC Cockpit or some other product - is required before the JOC Cockpit installation can be operated.

...

Call the JOC Cockpit login form in a web browser and enter the User Name 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 changes have not been made to the shiro.ini configuration file. Note that in the default configuration the root user is assigned all role, which has all permissions available.

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

requires administrative privileges:

Code Block

language	text
title	Starting headless installation of the JOC Cockpit on Windows systems

@rem login with an account that can acquire elevated privileges for administrative tasks
setup.cmd joc_install.xml

Note: Do not omit specifying the joc_install.xml response file as a command line argument when executing setup.sh or setup.cmd. If the response file is not specified, the graphical installer will be invoked as described in the JS7 Installation: How to install the JS7 JOC Cockpit on premises using the Graphical Installer article.

Directory Layout

By default the installation is added:

for Unix to the:

...

Operation from the Command Line

The default configuration for the Jetty server means that it automatically started with the operating system. However, it can also be stopped and started from the command line.

On Linux systems

In the folder:
- installation directory:
- /opt/sos-berlin.com/js7/joc
- data directory: /jetty/bin
Enter:
- ./jetty.sh stop|start

On Windows systems

- var/sos-berlin.com/js7/joc
for Windows to the:In the folder:
- installation directory:
- C:\Program Files\sos-berlin.com\js7\joc\service
Enter:
- start_jetty_windows_service.cmd stop|start

Updating

Empty the Browser Cache after updating the JOC Cockpit

You should use Ctrl & F5 as well as empty the browser cache before starting the JOC Cockpit after an update.

Installation Log Files

The JOC Cockpit configuration and installation log information are written to a new log file each time an installation or update is carried out. These log files can be found in the logs folder in the jetty_base directory.

Installation log files are named according to the pattern Install_V[release]_[date&time]_....log where release is the version release number and date and time refer to the installation.

Deinstallation

The JOC Cockpit can be uninstalled using the uninstall.cmd and uninstall.sh scripts saved in the folders:

on Linux systems:
- /opt/sos-berlin.com/js7/joc/Uninstaller
on Windows systems:
- C:\Program Files\sos-berlin.com\js7\joc\Uninstaller

Windows systems

...

- data directory: ProgramData\sos-berlin.com\js7\joc

The following listing shows the directory layout after installation of the JOC Cockpit:

/opt (Unix installation directory), Program Files (Windows installation directory)
- sos-berlin.com
  - js7
    - joc (installation directory)
      - .jocinstallinformation (installation response file, remains in place after uninstall)
      - jetty_base (symbolic link to data directory)
      - 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 (plain text format of license terms for the commercial JS7 - License)
      - sbom.json (JS7 - Software Bill of Materials)
      - ThirdParty.txt (lists the the 3rd party components and licenses used by JS7)
      - db (directory for DBMS *.sql scripts to populate the database)
        h2
        mssql
        mysql
        oracle
        pgsql
      - install (directory with Jetty installer scripts)
        install_jetty_base.sh|.cmd (used by installer)
        install_jetty_service.sh (used by installer for Unix)
        joc_install_tables.sh,|.cmd (creates or updates database objects, used for JS7 - Rescue in case of lost access to JOC Cockpit)
        joc_manage_identity_service.sh|.cmd (see JS7 - Shiro Identity Service Migration)
        uninstall_jetty_service.sh (used by installer for Unix)
        update_jetty_base.sh|.cmd (used by installer)
      - jetty (directory for Jetty binary files and scripts)
        bin
        anonymize-logs.sh|.cmd (used to anonymize log files, see JS7 - Log Anonymization)
        jetty.sh (start script for JOC Cockpit Unix daemon)
        joc.service (sample file for use with JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems)
      - lib (directory for user specific configurations)
        log4j2.xml (used for based console logging to stdout, see JS7 - Logging)
        patches (used for JS7 - Patches for JOC Cockpit, the directory is cleaned up when running the installer)
        user_lib (used for individual .jar files such as JDBC Drivers, see JS7 - Database)
      - service (directory for operation as a Windows Service)
        install_jetty_windows_service.cmd (used by installer)
        js7_joc.exe, js7_jocw.exe (used for start-up and configuration of the service, see JS7 - How To - Apply Java Options)
        set_java_home_for_jetty_windows_service.cmd (see JS7 - JOC Cockpit Windows Service does not start)
        start_jetty_windows_service.cmd (used by installer)
        uninstall_jetty_windows_service.cmd (used by installer)
      - Uninstaller (Uninstaller directory, the empty directory remains in place after uninstall)
        joc_install.xml (installer response file, remains in place after uninstall)
        uninstaller.jar (binary file of the uninstaller)
        uninstall.sh|cmd (script to invoke uninstaller)
/var (Unix data directory), ProgramData (Windows data directory)
- sos-berlin.com
  - js7
    - joc
      - jetty_base (configuration directory)
        joc_home (symbolic link to installation directory)
        start.ini (Jetty servlet container configuration file, remains in place after uninstall. This file is migrated to the start.d folder starting from Release 2.5.0)
        archive (directory for JOC Cockpit versions before applying patches, remains in place after uninstall)
        lib (directory for Java libraries, remains in place after uninstall)
        logs (directory for log files files, remains in place after uninstall)
        resources (directory for configuration files, remains in place after uninstall)
        joc (directory for configuration files, remains in place after uninstall)
        hibernate.cfg.xml (Hibernate configuration file for database access, remains in place after uninstall if modified)
        joc.properties (JOC Cockpit configuration file, remains in place after uninstall)
        log4j2.xml (log configuration file, remains in place after uninstall if modified, see JS7 - Logging)
        shiro.ini.active (Shiro configuration file if the JS7 - Shiro Identity Service is used. This file reports the currently active configuration, remains in place after uninstall)
        shiro.ini-example (Shiro example configuration file if the JS7 - Shiro Identity Service is used)
        lib (optional directory for JDBC Drivers and licensed binary code)
        license (optional directory for license certificate files, remains in place after uninstall)
        xsd (directory for XSD schema files, remains in place after uninstall)
        start.d (starting from Releases 2.5 (in progress) that introduces Jetty 11 this directory holds *.ini files for settings previously available with start.ini)
        temp (directory for temporary files, remains in place after uninstall)
        webapps (directory for JOC Cockpit installation)
        joc (directory for JOC Cockpit GUI files and patches)
        WEB-INF
        classes (directory for resource files and JS7 - Patches for JOC Cockpit)
        lib (Java binary files)
        root
/home/<user-account> (Unix home directory)
- .jocrc (user profile script applied on start-up of JOC Cockpit)

Directory Layout if the Jetty Servlet Container is not Installed

If the Jetty servlet container included with JOC Cockpit is not installed and if no previous configuration files are found in the Program Files\sos-berlin.com\js7\joc directory then by default files will only be added to the

If the checkbox is not selected, configuration files will be left in both the JOC Cockpit installation folder and the Jetty web server installation folder (if installed with the JOC Cockpit).

On Linux systems

Make a Backup!

The uninstall script on Linux systems will not open a dialog box. Instead, an uninstall script will start the Uninstaller and remove both the program and configuration files and folders.

These files contain the configuration information from the last JOC Cockpit and Jetty web server installations.

Files that are not removed during a normal uninstall (i.e. when the checkbox is not ticked) are noted in the File Structure section of this article below.

...

The JOC Cockpit installation procedure contains the option of installing and using the Jetty Web Server that is included in the JOC Cockpit installation archive. This option was configured in Step 4 of the installation procedure described above. An alternative web server that is capable of handling Java web applications, such as Tomcat or another web server, can also be used.

If the Jetty provided with the JOC Cockpit is not to be installed, the installation program will look and see if a jetty_base shortcut from a previous installation is to be found in the jetty_home 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 the joc_home directory.
System administrators can then move the configuration files to the appropriate application directory as required.

See also links in the References section below.

Location of the `resources/joc` folder with a fresh installation

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

on Linux systems:
- /opt/sos-berlin.com/js7/joc/resources/joc
on Windows systems:
- C:\Program Files\sos-berlin.com\js7\joc\resources\joc

Location of the `resources/joc` folder after an installation on top of a JOC Cockpit installation with Jetty

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 the folder will not be moved from its location. This means that the "new" resources the folder will be found after the new installation as follows (if the original installation was carried out in the default directory):

on Linux systems:
- /opt/sos-berlin.com/js7/joc/resources/joc
on Windows systems:
- C:\Program Files\sos-berlin.com\js7\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 the 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 one 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.

File Structure

The following listings should make clear the changes that occur in the JOC Cockpit file structure during installation and de-installation.

Windows Systems

Default File Structure if Jetty is Installed

If the Jetty web server provided with the JOC Cockpit is installed then files will be added by default in the ProgramData\sos-berlin.com\joc and Program Files\sos-berlin.com\js7\joc directories.

...

If configuration files are found in Program Files\sos-berlin.com

js7
- joc
  - jetty_base
    - archive (directory with files, remains after uninstall)
    - lib (directory with files, remains after uninstall)
    - logs (directory with files, remains after uninstall)
    - patches (directory with files, remains after uninstall)
    - resources (remains after uninstall and (empty) after full uninstall)
      - joc (directory with files, remains after uninstall)
        license (directory with files, remains after uninstall)
        xsd (directory with files, remains after uninstall)
        hibernate.cfg.xml (remains after uninstall if modified)
        joc.properties (remains after uninstall)
        log4j2.xml (remains after uninstall if modified)
        shiro.ini.active (remains after uninstall)
        shiro.ini-example (only added if shiro.ini file is found)
  - temp (directory with files, remains after uninstall)
  - webapps
  - start.ini (file, remains after uninstall)

\js7\joc directory then files will be added to the ProgramData\sos-berlin.com\js7joc and Program Files\sos-berlin.com\js7\joc directories as explained above.

Update and Upgrade

Detailed instructions for updating and upgrading can be found in the JS7 - Update and Patch Management article.

Preparation

Stop the JS7 JOC Cockpit instance.

Running the Update

The update of the JS7 JOC Cockpit is performed from a similar download archive to that used for a fresh installation.
Use the joc_install.xml file created during the installation. The default location of the joc_install.xml file from a previous installation is:
- C:\Program Files\sos-berlin.com\js7\joc\ for Windows and
- /opt/sos-berlin.com/js7/joc for Unix systems.
Perform the same steps to run the installer as explained above.
- The update will replace existing files and will update database objects as required.
- The update will not remove configuration files or settings in such files.

Installation Log Files

The JOC Cockpit configuration and installation log information is written to a new log file each time an installation or update is carried out. These log files can be found in the logs sub-directory of the jetty_base directory.

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 the JS7 - Logging article.

Deinstallation

The JOC Cockpit can be uninstalled using the uninstall.sh and uninstall.cmd scripts available from the following locations:

For Unix systems:
- /opt/sos-berlin.com/js7/joc/Uninstaller
For Windows systems:
- C:\

Program Files
- sos-berlin.com
  - js7
    - joc
      - install (directory with files)
        install_jetty_base.cmd
        update_jetty_base.cmd
      - jetty (directory with files)
      - jetty_base (symlink)
      - service
      - Uninstaller (directory, the empty remains after uninstall and full uninstall)
        uninstall.cmd
        uninstaller.jar
      - .jocinstallinformation (file, remains after uninstall)
      - joc_install.xml (file, remains after uninstall)

Default File Structure if Jetty is not Installed

If the Jetty web server provided with the JOC Cockpit is not installed and no previous configuration files are found in the Program Files\sos-berlin.com\joc the directory then files will be added by default only in the Program Files\sos-berlin.com\joc directories.

...

- Program Files\sos-berlin.com\

...

- js7\joc\Uninstaller

Unix Systems

The uninstall script on Unix systems runs in headless mode. The uninstall script will start the Uninstaller and will remove the installation directory, data directory and sub-folders.

Windows Systems

Starting the uninstaller will display the following window:

Image Added

Selecting 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 checkbox is not selected, configuration files will be left in both the JOC Cockpit installation folder and the Jetty servlet container installation folder (if installed with the JOC Cockpit).

Automated Start-up and Shutdown

For Unix systems a start-up and shutdown configuration can be used that is executed by systemd running with the root account.

For details see the JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems article.

For Windows systems operation of the JOC Cockpit by a Windows Service is recommended as such services can be configured to start/stop automatically on server start-up and shutdown.

Consider assigning a service account to the JOC Cockpit service with the Windows Service Panel.
Consider allowing the JOC Cockpit service to be automatically started on server start-up.

Initial Operation

Having completed the installation or update of the JS7 JOC Cockpit you can start the JOC Cockpit either manually or from its Unix daemon/Windows Service, see the JS7 - JOC Cockpit Command Line Operation article.

Should users face problems starting the JOC Cockpit then please refer to the JS7 - Troubleshooting - JOC Cockpit section.

A number of JOC Cockpit instances can be operated as a passive cluster with the first JOC Cockpit instance started acting as the primary cluster member and any additional JOC Cockpit instances acting as standby cluster members. The role of the primary cluster member is decided by the order by which JOC Cockpit instances are started.

Info

Note that operating a JOC Cockpit cluster for high availability requires a commercial license, see JS7 - License.
The installation of JOC Cockpit Cluster instances follows the standard operating procedures explained above. There is no difference in installation for the roles of primary cluster member and standby cluster members.
Note the following information about initial cluster operation:
- JS7 - Initial Operation for JOC Cockpit Cluster

Further References

Program Files
sos-berlin.com
js7
joc
install
install_jetty_base.cmd
shortcut.vbs
_{joc_install_tables.cmd}
update_jetty_base.cmd
logs
Install_ ... .log (files will remain after uninstall)
resources
joc
hibernate.cfg.xml (remains after uninstall if modified)
joc.properties (remains after uninstall)
joc.properties-example (only added if joc.properties file is found at installation start)
log4j2.xml (remains after uninstall if modified)
shiro.ini (remains after uninstall)
shiro.ini-example (only added if shiro.ini file is found at installation start)
service
amd64 (directory)
manager (directory)
x86 (directory)
install_jetty_windows_service.cmd
LICENSE.txt
NOTICE.txt
RELEASE-NOTES.txt
set_java_home_for_jetty_windows_service.cmd
start_jetty_windows_service.cmd
uninstall_jetty_windows_service.cmd
Uninstaller (the empty directory remains after uninstall)
js7.ico
uninstall.cmd
uninstaller.jar
webapps
joc.war
.jocinstallinformation (file, remains after uninstall)
joc_install.xml (file, remains after uninstall)

Clustering and Redundancy

With each instance running on its own server, multiple instances of the JOC Cockpit can either be installed as an active cluster or redundantly. In both cases, installation of the JOC Cockpit instances follows the standard procedure described above. The configuration of the JOC Cockpit instances then follows the instructions provided in the Authentication and Authorization - Configuration article.

The JOC Cockpit - Clustering article provides more general information about installing and configuring multiple instances of the JOC Cockpit.

JOC Cockpit Configuration

The JOC Cockpit includes certain configuration items which can be used to configure JOC Cockpit. Details about how to configure JOC Cockpit the article JS7 - JOC Cockpit Configuration Items can be followed.

...

Installation with Other Application Servers:

Tips from a user on Installation with Tomcat

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 2

New Version Current

Key

Introduction

Prerequisites

Operating Systems

HTTPS Authentication

Download

Installation Procedure

Preparation

Administrative Permissions

Dialog installation

Language Selection

Step 2 - Licensing Agreement

Step 3 - Target Path for Installation

Step 5 - JOC Configuration

Step 6 - Database Management System

Step 7 - Database connection Configuration

Step 8 - Specify the JDBC Driver for the Database Connection

Download

Installation Video

Installation in Headless Mode

Installation

Installer Archive

Database Connection

Installer Response File

Configuring the JDBC Driver URL for Oracle® RAC databases

Step 9 - Performing the Installation

Step 12 - External Processes

Step 13 - Completion

Operation

Batch installation

Configuration

Running the Installer

Initial Operation with the JOC Cockpit Login Form

Directory Layout

Operation from the Command Line

On Linux systems

On Windows systems

Updating

Empty the Browser Cache after updating the JOC Cockpit

Installation Log Files

Deinstallation

Windows systems

On Linux systems

Location of the resources/joc folder with a fresh installation

Location of the resources/joc folder after an installation on top of a JOC Cockpit installation with Jetty

File Structure

Windows Systems

Default File Structure if Jetty is Installed

Update and Upgrade

Preparation

Running the Update

Installation Log Files

Deinstallation

Default File Structure if Jetty is not Installed

Unix Systems

Windows Systems

Automated Start-up and Shutdown

Initial Operation

Further References

Clustering and Redundancy

JOC Cockpit Configuration

Installation with Other Application Servers:

Configuring the JDBC Driver URL for Oracle^® RAC databases

Location of the `resources/joc` folder with a fresh installation

Location of the `resources/joc` folder after an installation on top of a JOC Cockpit installation with Jetty