Anchor

	Installation_Requirements
	Installation_Requirements

Installation Requirements

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

The JOC Cockpit can only be installed alongside a JS7 controllerThe JOC Cockpit needs requires access to the a database to store inventory information, status information and workflow related logs. The database is required for restarting restart capabilities with the JS7 - Cluster Service.
A Java Runtime Environment starting from version 1.8 is required. For details see Which Java versions is JobScheduler available for?

Troubleshooting Information

Service.
A Java Runtime Environment starting from version 1.8 is required. For details see Which Java versions is JobScheduler available for?
If a MySQL DBMS is being used then the MySQL wait_timeout setting that rules the max. the lifetime of idle connections should be checked and if necessary extended.
- The default wait_timeout for MySQL is relatively short and the JOC Cockpit cannot keep the connection busy over longer periods of time without user interaction - for example, overnight.
- See the JOC Cockpit - Troubleshooting - Database Connection to MySQL unavailable after idle timeout article for instructions about how to change the MySQL DBMS wait_timeout setting.
Find more hints on possible installation problems from the JOC Cockpit - Troubleshooting section.

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 validation, we do not recommend configuring management it is not recommended to configure the JOC Cockpit to use HTTPS during the initial installation and configuration procedure. Instead, we recommend that the JOC Cockpit is installed and tested with HTTP and the default Shiro 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:
...
The archives can be used to install the JOC Cockpit either from a dialogue or for headless installation for 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 all the necessary the Installation Requirements as listed in stated with the above section above have been met.
Unpack the JOC Cockpit archive to a suitable directory such as /tmp on Linux systems or C:\temp on Windows.

The installer can be started as a dialog or in batch headless mode. Note that an X-Server is required if the installer is to be run on Linux systems as a dialog. If an X-Server is not installed, then batch headless installation should be used.

...

Administrative Permissions

On Windows systems:
- The setup will ask for Elevated Permissionsasks for elevated permissions.
On Unix 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 Server Servlet Container and JOC Cockpit are to be started automatically started after a reboot of the machine).
- To install the JOC Cockpit without root permissions, the start script should be called with a the -u the argument argument, otherwise the sudo prompt will ask for a password.

Dialog installation

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

...

Step 2 - Licensing Agreement
- The License Agreement shown displayed 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/js7/joc on on Linux systems and
  - C:\Program Files\sos-berlin.com\js7\joc on Windows.
- Users can use the Step 3 installation form shown below to specify their own individual installation path for the JOC Cockpit if required.

Anchor
jetty-base
jetty-base
Step 4 - Jetty Installation & Configuration
- The JOC Cockpit requires a Java-capable web server and comes with a Jetty serverships with the Jetty Servlet Container. Step 4 allows system administrators to specify whether this web server the Servlet Container is to be installed and if so, to specify its configuration - , i.e. the port(s) it usesports to be used, installation path, memory pool, etc.
- The Install JOC ... including the Jetty checkbox specifies whether the Jetty web server should be installed.
- Default Paths
- While the Jetty web server delivered Servlet Container provided with the JOC Cockpit is installed in the joc_installation_directory, which that was configured in the previous step - the Jetty configuration files are installed in the jetty_base directory. The Jetty Base input field in the form shown in the screenshot installer form can be used to set the jetty_base directory.
  - The default path to the jetty_base directory on Linux systems leads points to the user's home directory:
    - e.g. /home/sos/sos-berlin.com/js7/joc
  - Log By default log files are saved by default stored in:
    - /var/log/sos-berlin.com//js7/joc on logs on Linux systems.
  - The default path to the jetty_base directory and log files on Windows systems is:
    - C:\ProgramData\sos-berlin.com\js7\joc
- Note that if If the Jetty delivered provided with the JOC Cockpit is not to be installed and either an alternative Jetty installation or another web server Servlet Container is to be used , then relevant configuration files for such a server such as the as shiro.ini and joc.properties files will will still be written to the file system. These files can then be moved by the system administrator to a suitable location for their web server the Servlet Container as required. See the Configuration with Alternative Web Servers section below for more information.
Step 5 - JOC Configuration
- The JS7 JOC Cockpit can be installed in a cluster. So if the JOC Cockpit is installed as a cluster then it is required to provide a title to the JOC. By default the title is joc, this can be modified as per the user.
- The security level for the signing mechanism can has to be added specified at the time of JOC Cockpit installation for a . A security level used is required for the signing of deployment objects such as workflows. See the Secure Configuration Article for more information. The JS7 JOC Cockpit provides three types of signing mechanismssecurity levels:
  - Low: This mechanism is easy to use as it does not require any user interaction for the signing operation to be performed.
  - Medium: This mechanism is similar to the low signing mechanism except for the fact that the private key stored with the current user's profile is used for the signing of configuration objects.
  - High: This mechanism has is the highest security level and this requires any configuration objects to be exported and to be signed individually outside of JOC Cockpit.
Step 6 - Database Management System
- Choose the DBMS to be used by the JOC Cockpit for the database system.
- The database connection settings either can be either species specified directly or can be provided by a hibernate configuration file. If the settings are specified directly then it is required to choose the database system DBMS otherwise the hibernate configuration file path can be specified after checking the option with hibernate configuration file.
- The database system DBMS is specified in the upper selection on this form. It is recommended that the box checkbox in the centre center of the form remains checked so that the script which is executed that creates and fills populates the necessary database tables can be executedrequired database objects.
Step 7 - Database connection Configuration
- Specify the parameters for the connection to the Databasedatabase.
  
  It will probably be obvious from the names given to the parameters in the screenshot above that the values are for a database to be used by
- the JS7 JOC CockpitThe 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 saved in stored to the jetty_base/resources/joc folder. The default name of the database configuration file is:is hibernate.cfg.xml.
  This file can be modified at a later date if required using a on if required. Any text editor can be used. The JS7 JOC Cockpit service will then have has to be restarted before to apply changes made to this the hibernate configuration file are implemented.
- The name and location of the database the hibernate configuration file itself is specified in with the joc.properties file , which that can also be found in the jetty_base/resources/joc folder.

Step 8 - Specify the JDBC Driver for the Database Connection

Specify if a JDBC driver Driver provided with the installation installer should be used for the Database Connection or whether an external driver is requiredJDBC Driver should be used.
The information shown in this form depends on the DBMS previously selected:
- The jTDS JDBC® the driver delivered with the JOC Cockpit is only shown as an option when Sybase^® or Microsoft SQL Server^® DBMSs have been specified.
- If you have specified a MySql^® DBMS then you will get a checkbox for specifying whether you want to use the MariaDB^® JDBC^® driver provided with the JobScheduler.
- If you do not check the jTDS JDBC^® or the MariaDB JDBC drivers then you must enter your own JDBC^® driver Driver in the form shown below.

Configuring the JDBC Driver

-

URL for Oracle^® RAC databases

The JDBC driver 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 -
Processing
Performing the Installation
- This step shows the progress of displays a progress bar for the first part of the installation procedure.
- Changes to the installation configuration can no longer be made once this step has started.
  Instead, configuration files such as those in the folder can be modified manually and then can be manually modified. To apply changes the JOC Cockpit should be restarted.
Step 12 - External Processes
- This step shows displays the progress of the second part of the installation procedure.
- The information shown in displayed with this step will be is written to the installation log file , which that can be found in the jetty_base/logs folder.
Step 13 - Completion
- The last step of the installation shows a displays summary of information about 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 will be provided.
Operation
- Go to the Initial Operation section of this article for information about opening the JOC Cockpit Interface.

...

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_licence"/>
    <com.izforge.izpack.panels.TargetPanel id="target">
        
        <!-- SELECT THE INSTALLATION PATH
             It must be absolute! 
             For example:
             /opt/sos-berlin.com/js7/joc on Linux
             C:\Program Files\sos-berlin.com\js7\joc on Windows -->
        <installpath>[:choose absolute installation path of JOC:]</installpath>
        
    </com.izforge.izpack.panels.TargetPanel>
    <com.izforge.izpack.panels.UserInputPanel id="jetty">
        <userInput>
            
            <!-- JOC requires a servlet container such as Jetty. 
                 If a servlet container 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 with Jetty. -->
            <entry key="withJettyInstall" value="yes"/>
            <entry key="jettyPort" value="4446"/>
            <!-- Specify the name of the Windows service or Linux Daemon (default: joc).
                 Only necessary for multiple instances of JOC on one server. It must be 
                 unique per server. This entry is deactivated by a comment because it
                 MUST NOT BE CHANGED DURING OVER-INSTALLATION! -->
            <!--
            <entry key="jettyServiceName" value="joc"/>
            -->
            <!-- Only necessary for Windows -->
            <entry key="jettyStopPort" value="40446"/>
            <!-- Only necessary for Unix (root permissions required) -->
            <entry key="withJocInstallAsDaemon" value="yes"/>
            <!-- To enter a JOC User (default=current User). 
                 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 Linux
                 C:\ProgramData\sos-berlin.com\js7\joc on Windows -->
            <entry key="jettyBaseDir" value=""/>
            <!-- Choose (yes or no) wether the JOC's Jetty should be (re)started at the end of the 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 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 is a standby node in a cluster -->
            <entry key="isStandby" value="no"/>
            
            <!-- Security Level for the signing mechanism: possibly values are 'LOW', 'MEDIUM' and 'HIGH'
                 HIGH:
                    public PGP keys are stored for verification only
                    all signing will be done externally outside of JOC Cockpit
                 MEDIUM:
                    a private PGP key will be stored for signing
                    signing will be done automatically with the provided key
                 LOW:
                    no keys will be stored
                    signing will be done internally with default keys -->
            <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 following entries such as
                 databaseHost, databasePort, ... or by a hibernate configuration file 
                 Posible values are 'withoutHibernateFile' (default) and 'withHibernateFile'. -->
            <entry key="databaseConfigurationMethod" value="withoutHibernateFile"/>
                 
            <!-- Choose the database management system. 
                 Supported values are 'h2' for H2 (for evaluation only), 'mysql' for MySQL,
                 'oracle' for Oracle, 'mssql' for MS SQL Server, 'pgsql' for PostgreSQL.
                 Only if databaseConfigurationMethod=withoutHibernateFile -->
            <entry key="databaseDbms" value="mysql"/>
            
            <!-- Path to a hibernate configuration file if databaseConfigurationMethod=withHibernateFile -->
            <entry key="hibernateConfFile" value=""/>
            
            <!-- You can choose between 'on' or 'off' to create the database tables.
                 If you have modified the initial data of an already existing installation, 
                 then the modifications will be undone. Data added remains unchanged. 
                 This entry should be only 'off', when you sure, that all tables are already created. -->
            <entry key="databaseCreateTables" value="on"/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="dbconnection">
        <userInput>
            <!-- Database Configuration if databaseConfigurationMethod=withoutHibernateFile -->
                 
            <!-- Enter the name 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, MS SQL Server 1433, postgreSQL 5432. -->
            <entry key="databasePort" value=""/>
            
            <!-- Enter the schema -->
            <entry key="databaseSchema" value=""/>
            
            <!-- Enter the user name 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 -->
            
            <!-- You can specify an external JDBC connector then set internalConnector = no
                 For license reasons MySQL abd MS SQL Server JDBC drivers are not provided. 
                 Alternatively you can use the mariadb JDBC Driver for MySQL which is provided. 
                 For MS SQL Server you have to specify an external JDBC connector. 
                 An Oracle ojdbc8 JDBC driver is also provided. -->
                 
            <!-- You can choose between 'yes' or 'no' for using the internal JDBC connector
                 or not -->
            <entry key="internalConnector" value="yes"/>
                 
            <!-- Select the path to JDBC Driver -->
            <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>

Batch Headless installation is started by opening a terminal or command window in the folder containing the setup.* file and by typing:

Code Block
language text
title Starting batch headless installation of the JOC Cockpit on Linux systems with root permissions
/tmp/joc.[release]> ./setup.sh joc_install.xml
Code Block
language text
title Starting batch headless installation of the JOC Cockpit on Linux systems without root permissions
/tmp/joc.[release]> ./setup.sh -u joc_install.xml
Code Block
language text
title Starting batch headless installation of the 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 functioning web server working Servlet Container - either the Jetty provided with the JOC Cockpit or another 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.
Note that on some systems the web service may take a minute to start and to display the login form shown as explained below.

Operation from the Command Line

...

On Linux systems

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

...

In the folder:
- C:\Program Files\sos-berlin.com\joc\service
Enter:
- start_jetty_windows_service.cmd stop|start

...

Anchor
resources
resources
Further Resources

...

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version 9

Key

Installation Requirements

Troubleshooting Information

Operating Systems

HTTPS Authentication

Download

Installation Procedure

Preparation

Administrative Permissions

Dialog installation

Step 2 - Licensing Agreement

Step 3 - Target Path for

Installation

Anchor
jetty-base
jetty-base
Step 4 - Jetty Installation & Configuration

Default Paths

Step 5 - JOC Configuration

Step 6 - Database Management System

Step 7 - Database connection Configuration

Step 8 - Specify the JDBC Driver for the Database Connection

Configuring the JDBC Driver

URL for Oracle^® RAC databases

Step 9 -

Performing the Installation

Step 12 - External Processes

Step 13 - Completion

Operation

Initial Operation with the JOC Cockpit Login Form

Operation from the Command Line

On Linux systems

Anchor
resources
resources
Further Resources

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 8

New Version 9

Key

Installation Requirements

Troubleshooting Information

Operating Systems

HTTPS Authentication

Download

The following archive files are available for download:...The archives can be used to install the JOC Cockpit either from a dialogue or for headless installation for 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

Administrative Permissions

Dialog installation

Step 2 - Licensing Agreement

Step 3 - Target Path for

Installation

Anchorjetty-basejetty-baseStep 4 - Jetty Installation & Configuration

Default Paths

Step 5 - JOC Configuration

Step 6 - Database Management System

Step 7 - Database connection Configuration

Step 8 - Specify the JDBC Driver for the Database Connection

Configuring the JDBC Driver

URL for Oracle® RAC databases

Step 9 -

Performing the Installation

Step 12 - External Processes

Step 13 - Completion

Operation

Initial Operation with the JOC Cockpit Login Form

Operation from the Command Line

On Linux systems

AnchorresourcesresourcesFurther Resources

Anchor
jetty-base
jetty-base
Step 4 - Jetty Installation & Configuration

URL for Oracle^® RAC databases

Anchor
resources
resources
Further Resources