Introduction

The JITL CheckHistoryJob template can be used to check past executions of workflows and jobs.

...

Anchor
authentication authentication

Authentication

api-server {
# API Server URL
url = "https://joc-2-0-secondary:4443"

# Use of Credential Store
cs-file=${js7.config-directory}"/private/secret.kdbx"
cs-key=${js7.config-directory}"/private/secret.key"
cs-password="secret"
account="/myAccounts/joc@username"
password="/myAccounts/joc@password"

...

The CheckHistoryJob template authenticates with the JS7 - REST Web Service API by use of user account/password and/or by use of a certificate, for details see JS7 - Authentication.

To this purpose the job template makes use of the Agents ./config/private/private.conf file to find a number of configuration items that allow authentication:

js7 {
    auth { ... }
    configuration { ... }
    job { ... }
    web { ... }

	api-server {
    	# API Server URL
	    url = "https://joc-2-0-primary:4443"

    	# Option 1: use of a Credential Store
	    cs-file=${js7.config-directory}"/private/secret.kdbx"
	    cs-key=${js7.config-directory}"/private/secret.key"
    	cs-password="secret"

	    # Option 1: use of references to credentials 
    	account="/myAccounts/joc@username"
	    password="/myAccounts/joc@password"


    	# Option 2: Use of account and password
	    account="root"
    	password="root"
	}
}

Explanation:

• The api-server configuration section specifies authentication details for the CheckHistoryJob and can occur in any position directly within the js7 configuration block.
• Configuration items available from this configuration section are explained with the following chapters.

Certificate Based Authentication

For JS7 - Certificate based Authentication configured with the ./config/private/private.conf file

• the url configuration item is required that specifies the URL of the JS7 REST Web Service API. Typically this corresponds to the JOC Cockpit URL.
  • Users can set up a number of JOC Cockpit instances that are clustered for automated fail-over.
  • Users can set up a load balancer that routes requests to a number of available JOC Cockpit instances.
  • For use with the CheckHistoryJob template both active and standby JOC Cockpit instances can be used.
• the Client Authentication Certificate has to be available from the keystore file indicated with the js7.web.https.keystore or js7.web.https.client_keystore settings.

User Account / Password Authentication

For user account/password authentication configured with the ./config/private/private.conf file

• the url configuration item is required as explained above.
• the user account and password can be specified from the following options:
  • Option 1: Use of a JS7 - Credential Store
    • with the following settings:
      • cs-file: Specifies the path to a KeePass database file.
      • cs-key: Specifies the path to a KeePass key file.
      • cs-password: Specifies the password for the KeePass database file.
      • account: Specifies the path to the entry in the KeePass database that holds the account name.
      • password: Specifies the path to the entry in the KeePass database that holds the password.
    • that suggest to preferably use a KeePass key file (cs-key) to protect the KeePass database. Basically it is pointless to protect a Credential Store by use of a password  (cs-password) that is similarly visible as putting the key under the mat. Use of a key file allows to apply OS ownership and file permissions to protect to the key file from 3rd parties.
  • Option 2: Use of user account and password
    • with the following settings:
      • account: Specifies the account name.
      • password: Specifies the plain text password.
    • that include both settings to be visible from the configuration file.

Job Dependencies

The CheckHistoryJob template can be used to implement job dependencies 

...