Versions Compared

Key

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

...

...

  • file - required 
    • the path to the Credential Store file. This file can be located anywhere in the file system.
    • A relative path can be used that is calculated from the Agent's working directory:
      • By default this is the Agent's configuration directory, for example
        • /home/sos/js7/agent/var_<http-port> for Unix
        • C:\ProgramData\sos-berlin.com\js7\agent for Windows
      • Example
        • a relative path ./config/secret.kdbx maps to C:\ProgramData\sos-berlin.com\js7\agent\config\secret.kdbx
  • password - optional 

    • the password for access to the Credential Store 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: the path and name of the Credential Store file using the extension .key, for example, by default ./config/jobs.key is assumed if the Credential Store file ./config/jobs.kdbx is specified.

...

The short syntax can be used if the Hibernate configuration file includes explicit references to the credential storeCredential Store:

Code Block
languagexml
titleExtract from Hibernate configuration file with credential store references using the short syntax
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<hibernate-configuration>
    <session-factory>
        ...
        <property name="hibernate.connection.username">cs://@user</property> 
        <property name="hibernate.connection.password">cs://@password</property> 
        <property name="hibernate.connection.url">cs://@url</property>
         ...
        <property name="hibernate.sos.credential_store_file">./config/secret.kdbx</property>
        <property name="hibernate.sos.credential_store_key_file">./config/secret.key</property>
        <property name="hibernate.sos.credential_store_password">secret</property>
        <property name="hibernate.sos.credential_store_entry_path">/secret/database/reporting</property>
        ...
    </session-factory>
</hibernate-configuration

...

  • <property name="hibernate.sos.credential_store_file"> => path to the Credential Store database file
  • <property name="hibernate.sos.credential_store_key_file"> => path of to the key file for the Credential Store
  • <property name="hibernate.sos.credential_store_password"> => password of the Credential Store database file
  • <property name="hibernate.sos.credential_store_entry_path"> => folder hierarchy and entry name in the Credentials Store database file

Example for Hibernate Configuration File

...

Name

Required

Purpose

Example

db_url

yes

JDBC connection string

cs://jobs/oracle/minos.sos@url

db_user

yes

User name for database access

cs://jobs/oracle/minos.sos@user

db_password

yes

Password for database access

cs://jobs/oracle/minos.sos@password
credential_store_fileyesLocation of the Credential Store database file (*.kdbx)./config/jobs.kdbx
credential_store_keynoLocation of the Credential Store key file (*.key)./config/jobs.key
credential_store_passwordnoPassword of the Credential Storesecret
credential_store_entry_pathno

Folder hierarchy and entry name in the Credential Store 

/jobs/oracle

Use with JITL Notification Jobs

Use with Arguments

References to a Credential Store can be directly specified from arguments. This applies to the following JITL Notification Jobs:

References to a Credential Store

References to a credential store can be directly specified from arguments.

Full Syntax

The full syntax is used when the complete URI is specified with an argument: 

Name

Purpose

Example

mail.smtp.host

SMTP hostname or IP address

cs://jobs/mail/mail.sos-berlin.com@url?file=./config/jobs.kdbx

mail.smtp.user

User account for SMTP authentication

cs://jobs/mail/mail.sos-berlin.com@user?file=./config/jobs.kdbx

mail.smtp.password

Password for SMTP authentication

cs://jobs/mail/mail.sos-berlin.com@password?file=./config/jobs.kdbx

Explanation:

  • The jobs/mail/mail.sos-berlin.com value is an example for a path to an entry in the KeePass database that holds the credentials.
  • The ./config/jobs.kdbx value is an example for a relative path to the KeePass database that holds the Credential Store.

Short Syntax

The short syntax can be used if arguments are specified with references to the Credential Store location:

Name

Required

Purpose

Example

mail.smtp.host

yes

SMTP hostname or IP address

cs://jobs/mail/mail.sos-berlin.com@url

mail.smtp.user

yes

User account for SMTP authentication

cs://jobs/mail/mail.sos-berlin.com@user

mail.smtp.password

yes

Password for SMTP authentication

cs://jobs/mail/mail.sos-berlin.com@password
credential_store_fileyesLocation of the Credential Store database file (*.kdbx)./config/jobs.kdbx
credential_store_keynoLocation of the Credential Store key file (*.key)./config/jobs.key
credential_store_passwordnoPassword of the Credential Storesecret
credential_store_entry_pathno

Folder hierarchy and entry name in the Credential Store 

/jobs/mail

Use with JITL SAP Jobs

Status
colourYellow
titleTODO


Use with JITL SSH Jobs

Status
colourYellow
titleTODO

...