...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
################################################################################ ### Path to log4j configuration file. Path can be absolute or relative ### to this file. log4j.configuration = log4j.properties ################################################################################ ### Path to hibernate configuration file of JOC's reporting database. ### Path can be absolute or relative to this file. hibernate_configuration_file = reporting.hibernate.cfg.xml ################################################################################ ### Path to hibernate configuration file of a JobScheduler database. ### Path can be absolute or relative to this file. ### The key must have the format 'hibernate_configuration_file_<jobschedulerId>' ### for a specific JobScheduler (cluster) ### or 'hibernate_configuration_scheduler_default_file' ### for all JobSchedulers which don't have a specific setting. hibernate_configuration_scheduler_default_file = jobscheduler.hibernate.cfg.xml ################################################################################ ### The time (in milliseconds) to establish the connection with the ### remote host. Default = 2 jobscheduler_connection_timeout = 2 ################################################################################ ### The time (in milliseconds) waiting for data after the connection ### was established; maximum time of inactivity between two data packets. ### Default = 25 jobscheduler_socket_timeout = 25 ################################################################################ ### Should hostname verification be carried out for https certificate. ### Default false https_with_hostname_verification = false ################################################################################ ### Location of the Javaconfiguration trustorefile which contains the certificates of each ### JobScheduler Master for HTTPS connections. with e.g. url mapping, etc. ### Path can be absolute or relative ### to this file. #truststore# configuration_pathfile = joc../../etc/joc.jksconfiguration.properties ################################################################################ ### RequestsLocation, totype alland webpassword servicesof whichthe modifyJava JobSchedulertruststore objectswhich suchcontains asthe ### "start order", "stop job" certificates of eachJobScheduler Master for HTTPS connections. Path can be ### absolute or relative to this file. # truststore_path = ../../etc/joc.jks # truststore_type = PKCS12 # truststore_password = ################################################################################ ### Requests to all web services which modify JobScheduler objects such as ### "start order", "stop job" etc. can contain a comment to describe the reason. ### This flag controls if the comment is required or not. Default false force_comments_for_audit_log = false ################################################################################ ### Pre-defined comments used for example inSettings for a custom logo file on the 'reasons' describing actions inlogin page ### theThe audit log. comments = System maintenance; \ Repeat execution; \ Business requirement; \ Restart failed execution; \ Re-instantiate stopped object; \ Temporary stop; \ Change of JobScheduler object; \ Rerun with parameter changes; \ Change of external dependency; \ Application deployment and upgradelogo file has to be located in ./jetty_base/webapps/root/ext/images ### Possible units for width are according to ### https://www.w3schools.com/cssref/css_units.asp (default px) ### Possible values for the position are "top" or "bottom" (default=bottom). custom_logo_name = custom_logo_height = custom_logo_position = ################################################################################ ### A default profile should be available that includes any profile settings ### that are applied by default to new users. default_profile_account = root ################################################################################ ### Pre-defined comments used for example in the 'reasons' describing actions in ### the audit log. comments = System maintenance; \ Repeat execution; \ Business requirement; \ Restart failed execution; \ Re-instantiate stopped object; \ Temporary stop; \ Change of JobScheduler object; \ Rerun with parameter changes; \ Change of external dependency; \ Application deployment and upgrade |
Explanations
https_with_hostname_verificationThis setting should be considered carefully. Effectively it forces the hostname in an HTTPS connection to a JobScheduler Master to be verified from the host's certificate. This guarantees that the certificate has been created for the respective host (FQDN).
- With this setting being assigned the value
falseno host name verification takes place and the HTTPS connection is vulnerable to man-in-the-middle attacks.
configuration_fileThis file is used for configuration details that are independent from the JOC Cockpit installation, see chapter The
joc.configuration.propertiesFile.
truststore_path, truststore_type, truststore_passwordA trust store is used if an HTTPS connection between clients, e.g. user browsers, and JOC Cockpit is used. For details see the JOC Cockpit - HTTPS Authentication article.
force_comments_for_audit_logComments can be added whenever an operation is performed that modifies a JobScheduler object, e.g. if a job or job chain is started.
- Basically a user can choose in his profile to add comments which pops up a dialog box to select or enter a comment. If this profile setting is not active then a number of operations, such as starting a job, are performed immediately without additional dialog.
- With the
force_comments_for_audit_logsetting in place all users are forced to add a comment when modifying a JobScheduler object - independent of their profile settings.
custom_logo_name, custom_logo_height, custom_logo_positionThe custom logo is displayed on the login page.
Jira server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JOC-473
default_profile_account- The user profile of the account specified for this setting provides the default values for the profiles of new users.
- An account is specified exactly as the user would type for login. If LDAP Configuration is in place then the domain account is specified, optionally including the domain, e.g.
domain\accountoraccount@domainor by use of thesamAccountNameor the respective LDAP attribute configured by the JOC Cockpit administrator. Jira server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JOC-477
comments- Add/modify/replace items to the list of comments in any language.
- Each comment ends with a semicolon. If comments are to follow then the line for the current comment ends with a backslash.
The joc.configuration.properties File
This file is used for configuration details that are independent from a JOC Cockpit installation.
This file is not changed during an update of the JOC Cockpit.
The default location of this file after installation is the resources/joc folder.
Detailed descriptions of each parameter are included in the file and are intended to be self-explanatory.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
################################################################################
### In almost all cases a JobScheduler Master has a URL in the form
### http(s)://[jobSchedulerHost]:[jobSchedulerHTTP(S)Port].
### JOC Cockpit web services know this URL because the JobScheduler Master stores
### this information to the Reporting Database.
### If the JobScheduler Master is running in a docker container or behind a reverse
### proxy then the URL can be different and the JobScheduler Master cannot know by
### which URL it is accessible.
### Here you can set a url mapping in the form
###
### jobscheduler_url_myJobSchedulerHost_myJobschedulerHTTPPort = url
###
### all entries have a prefix "jobscheduler_url_"
### Please note that the key has to be in lowercase and contains always the
### HTTP port even if the URL uses the HTTPS protocol
# jobscheduler_url_localhost_40444 = http://docker_url |
Explanations
jobscheduler_url_<host>_<port>- This setting is used if a JobScheduler Master is operated, e.g. in a Docker environment, without DNS support and requires URL mapping.
- On startup of JobScheduler Master it will propagate its hostname and port to the Reporting Database.
- If this hostname is not publicly known in the network, e.g has not been added to the DNS, then JOC Cockpit cannot address the JobScheduler Master.
- This setting allows to map the URL reported by the Master to the Reporting Database to a URL that is accessible by JOC Cockpit, e.g. a URL that includes an IP address.
Database Configuration Files
...