...
- The JOC Cockpit can only be installed alongside a JobScheduler Master version 1.11 and newer.
Display feature availability StartingFromRelease 1.11 - The JOC Cockpit requires access to the DBMS that operates the JobScheduler database.
- The JOC Cockpit requires access to the DBMS that operates the reporting database. The reporting database may be integrated in the JobScheduler database or may be a separate database on a separate DBMS.
- An JVM 1.8 has to be installed.
The JAVA_HOME variable should point to the location of the JDK or JRE.
...
- If a MySQL DBMS is being used by the JobScheduler, then the MySQL
wait_timeout
setting that rules the max. 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 such as - 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.
- The default
- Find more hints on possible installation problems from the JOC Cockpit - Troubleshooting section.
...
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 andC:\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 JettyJetty Installation & Configuration
- The JOC Cockpit requires a Java-capable web server and comes with a Jetty server. Step 4 allows system administrators to specify whether this web server is to be installed and if so, to specify its configuration - i.e. the port(s) it uses - and , installation path, memory pool, etc..
- The Install JOC ... including 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 in the screenshot 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 andC:\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 for such a server such as the
shiro.ini
andjoc.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 -
ChooseSpecify the Reporting DBMS
The Choose the DBMS to be 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)for reporting data.
Step 6 - Configure the Reporting Database Connection
Specify the parameters for the connection to the Reporting Database.
It will be 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 JobScheduler. In this case the Reporting Database Tables will be integrated in the JobScheduler Database. This will be described in the next step.
The database configuration for the JOC Cockpit is written to an XML file during installation and saved in
thethe
folderjetty_base/resources/joc
folder.
The default name of the database configuration file is:reporting.hibernate.cfg.xml
This file can be modified at a later date if required using a text editor. The JOC Cockpit service will then have to be restarted before changes made to this file are implemented.
The name and location of the database configuration file itself is specified in the
joc.properties
file, which can The name and location of the database configuration file is specified in thejoc.properties
file, which can also be found in the thejetty_base/resources/joc
folder folder.
Step
67 -
ConfigureSpecify 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
$SCHEDULER_DATA\factory.ini
file of one of the JobSchedulers, where$SCHEDULER_DATA
is defined in the JobScheduler - Installation Guide (Section 1.2).
Used by the JobScheduler
Specify whether a separate connection it to be specified for the JobScheduler Database
- If the JobScheduler(s) and JOC Cockpit share the same database then clicking Next will cause the Installation to proceed to Step 10. This step starts the installation process itself and changes to the configuration are no longer possible.
- If the JobScheduler(s) and JOC Cockpit use separate databases then the checkbox in the form should be deselected. In this case, clicking Next will cause the Installation to proceed to the specification of the DBMS and the connection parameters for the JobScheduler database, which are described next.
- The DBMS access parameters used can be found in the database configuration for job history section of the
Step 8 - Specify the JobScheduler DBMS
- This form is identical to those already shown for the Reporting Database in Steps 5 above.
- This form is identical to those already shown for the Reporting Database in Steps 5 above.
Step 9 - Configure the JobScheduler Database Connection
Specify the parameters for the connection to the JobScheduler Database.
- 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 DBMS type can be found in the database configuration for job history section of the
- 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:reporting.hibernate.cfg.xml
This file can be modified at a later date if required using a text editor. The JOC Cockpit service will then have to be restarted before changes made to this file are implemented.
The name and location of the database configuration file itself is specified in the
joc.properties
file, which can also be found in thejetty_base/resources/joc
folder.
Step 10 - Processing the Installation
This step shows the progress of 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 thejetty_base/resources/joc
folder can modified manually and then the JOC Cockpit restarted.
Step 11 - External Processes
Step 7 - No longer requiredStep 8 - Installation
Progress of the first part of the installation procedure is shown in this step.
Step 9 - ProcessingThis step shows the progress of the second part of the installation procedure.
The information shown in this step will be written to the installation log file, which can be found in the
jetty_base/logs
folder
Step 12
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 will be provided.
Initial Operation 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 operated..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.
Updating
Empty the Browser Cache after updating the JOC Cockpit
...