JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 8

changes.mady.by.user Aditi Dubey

Saved on

compared with

New Version 9

changes.mady.by.user Andreas Püschel

Saved on

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.

Anchor
database_jobs
database_jobs
Use with JITL Database Jobs

JITL Database Jobs can access a Credential Store in the following ways:

...

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_key_filenoLocation 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

Anchor
mail_jobs
mail_jobs
Use with JITL Mail Jobs

Use with Arguments

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

...

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_key_file noLocation 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

...

Anchor
ssh_jobs
ssh_jobs
Use with JITL SSH Jobs

...

Use with Arguments

References to a Credential Store can be directly specified from arguments. This applies to the following JITL SSH 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, for example:

Name

Purpose

Example

user

This argument specifies the user account to be used when connecting to the SSH server.

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

password

This argument specifies the user account's password for authentication by the SSH server and has to be specified if the password authentication method is specified with the auth_method argument. 
Alternatively, this argument is used to specify the passphrase for a private key if the publickey authentication method is used with the auth_method argument.

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

auth_file

This argument specifies the path and name of a private key file used for authentication with an SSH server. This argument has to be specified if the publickey authentication method is specified with the auth_method argument. 
If the private key file is secured with a passphrase then the passphrase has to be specified with the password argument.

cs://jobs/ssh/ssh.sos-berlin.com@attachment?file=./config/jobs.kdbx

proxy_userThe value of this argument specifies the user account for authentication with the proxy server that is used to connect to the SSH server.cs://jobs/ssh/ssh-proxy.sos-berlin.com@user?file=./config/jobs.kdbx
proxy_passwordThis argument specifies the password for the proxy server user account if a proxy is used to connect to the SSH server.cs://jobs/ssh/ssh-proxy.sos-berlin.com@password?file=./config/jobs.kdbx

Explanation:

  • The jobs/mail/ssh.sos-berlin.com xvalue 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, for example:

Name

Example

user

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

password

cs://jobs/ssh/ssh.sos-berlin.com@password

auth_file

cs://jobs/ssh/ssh.sos-berlin.com@attachment
credential_store_file./config/jobs.kdbx
credential_store_key_file ./config/jobs.key
credential_store_passwordsecret
credential_store_entry_path/jobs/ssh

...