Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Hibernate configuration files are the Database configuration files. The database information like database users, passwords, and jdbc URLs etc are specified in the hibernate configuration files. These files configuration files can be used at the time of installation or can be created for the using with of the ManagedDatabaseJobJSAdapterClass job.

The Hibernate configuration files used by the installation are: 

  • The following hibernate configuration files are available with JobScheduler Master and JOC Cockpit:
    • JobScheduler run-time database: hibernate.cfg.xml for JobScheduler and jobscheduler.hibernate.cfg.xml for JOC Cockpit
    • Reporting database: reporting.hibernate.cfg.xml 

  • Database accounts, passwords, and URLs are specified as plain text with the above hibernate configuration files when they are provided at the time of installation using option <entry key="databaseConfigurationMethod" value="withoutHibernateFile"/>. To make the hibernate configuration file to use the database information from the Credential Store it is required to first create the hibernate configuration files and then use the <entry key="databaseConfigurationMethod" value="withHibernateFile"/> at the time of installation and provide the path to the Hibernate configurations file.
  • The Hibernate configuration file also supports the Credential Store. 
    Display feature availability
    StartingFromRelease1.13.3

    Display feature availability
    StartingFromRelease1.12.12

...

Parameter String to retrieve the data from Credential Store

The SOSKeePassDatabase  the class uses a parameter string that holds a URI and a number of query parameters:

...

  • The URI based syntax includes the protocol cs:// 
  • followed by the <entry_path> that specifies the directory structure and entry name in the credentials store file.
  • followed by the @ character
  • followed by the <property_name> that should be retrieved:

    • frequently-used properties include credential store field names such as title, user, password, attachment Custom field names are supported. 

...

  • file - required 
    the path to the credential store database file. This file can be stored anywhere in the file system.

  • password - optional optional 
    the password for the credential store database file. 
    It is recommended not to use this parameter and instead to use a key_file to access the credential store.

  • key_file - optional, default: <credential_store_database_filename_without_extension>.key 

Refer to the Knowledge base Knowledgebase article Using a Credential Store for Jobs#Syntax for a detailed description.

...

The syntax for

...

Hibernate Configuration files

The hibernate configuration file is introduced with different elements (property options) which can be used to retrieve the information from Credential Store.

...

Example of a hibernate file that uses the KeePass database (kdbx) with Password to access database credentials.

...

Downloads

Configuring attached example

  • Unzip the archive to the live folder of JobScheduler installation 
  • Add the database configuration according to your environment in the KDBX database (present in the example folder)  for using the kdbx with the key file which accesses the credential to log in to the database.the KeePass file kdbx-p-f.kdbx.
  • To access the KeePass file use kdbx-p-f.key as a key file.
  • Make the changes for the Database (URL, Username, Password)
  • The file hibernate-cs.syntax.full.cfg.xml includes the elements to access kdbx.
  • The Databasejob includes the command (database query) to be executed
  • Run the order hibernate_order from the JOC Cockpit
  • The output of the command will be displayed

References

  • Links to Change Management System 
    • Jira
      serverSOS JIRA
      columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
      serverId6dc67751-9d67-34cd-985b-194a8cdc9602
      keyJITL-587
    • Jira
      serverSOS JIRA
      columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
      serverId6dc67751-9d67-34cd-985b-194a8cdc9602
      keyJITL-589

...