Keys¶

The key value store of Consul administrates environment variables for the DPF server configuration.

The keys are commonly set during the installation or configuration of the DPF system.

Hint - usage in Working Units

Use the environment variables in the working unit scripts in order to avoid absolute paths.

-> WL sagt: im Consul ist nur die Umgebung definiert, Was wie wo in der main.customer.xml -> Aber: Wie ist das mit dem Job Cleaner? Da sind Dinge hier wie da definiert, was gilt wann?

Units¶

Values with time specifications are specified in the following time units:

seconds (s, sec)
minutes (m, min)
hours (h, hr)
days (d)
weeks (w, wk)
months
years (y, yr)

Example - with time units

<time_interval>=2h30m
<time_interval>=4m2s

CONSUL_TOKEN¶

CONSUL_TOKEN specifies the ACL token with which the Output Engine services authenticate themselves to Consul.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/CONSUL_TOKEN

Available values: String

Default: INSECURE_ACL_MASTER_TOKEN

Literature - configure Consul ACL

Refer to Configure ACL for on-premise Windows or Configure ACL for on-premise Linux.

CONSUL_URL¶

CONSUL_URL specifies the URL of the Consul server to which the Output Engine services log on.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/CONSUL_URL

Available values: String

<consul_url>

Default: https://localhost:8500

DPF_JOBCLEANER_INTERVAL¶

DPF_JOBCLEANER_INTERVAL specifies ???

The key is available for ???

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/???/tag/any/DPF_JOBCLEANER_INTERVAL

Available values: String

<time_interval_and_unit>

Default: 5m

DPFBIN¶

DPFBIN specifies the directory containing the binaries of the DPF system.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/DPFBIN

Available values: String

<directory>

Default: server\dpf\bin_<PLS_OSFULLNAME>

Literature

DPFDATA¶

DPFDATA specifies the directory containing the DPF data and the job directories.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/DPFDATA

Available values: String

<directory>

Default: data\dpf

Example

env:
    service:
        any:
            tag:
                any:
                    DPFDATA: C:\SEAL\applications\data\dpf

Do not change

The value is set during the installation process. It may not be changed afterwards.

DPFROOT¶

DPFROOT specifies the installation directory of the DPF system.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/DPFROOT

Available values: String

<directory>

Default: ??? Todo

Example

env:
    service:
        any:
            tag:
                any:
                    DPFROOT: C:\SEAL\applications\

Do not change

The value is set during the installation process. It may not be changed afterwards.

DPFSRV¶

DPFSRV specifies the directory of the server components of the DPF system.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/DPFSRV

Available values: String

<directory>

Default: server\dpf

??? Todo: Ich habe Fragen ... mit set DPFSRV bekomme ich untenstehende Ausgabe, aka 2 Werte?!

Example

env:
    service:
        any:
            tag:
                any:
                    DPFSRV: C:\SEAL\applications\server\dpf
                    DPFSRVCUSTOMER: C:\SEAL\customer\

Do not change

The value is set during the installation process. It may not be changed afterwards.

LOG_LEVEL¶

LOG_LEVEL specifies the log level for the correspondent service. Messages that correspond to this log level or a higher one are written to the log file.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/LOG_LEVEL for all services
dc/home/env/service/<service>/tag/any/LOG_LEVEL for the specific <service> service

Available values: String

debug

Debug messages and higher are written to the log file of the service.
info

Information messages and higher are written to the log file of the service.
warn

Warning messages and higher are written to the log file of the service.
error

Error messages and higher are written to the log file of the service.
fatal

Serious error messages are written to the log file of the service.

Default: info

Example

env:
    service:
        any:
            tag:
                any:
                    LOG_LEVEL: warn
    ...

The setting above includes log levels warn, error and fatal.

Hint - job logs

To specify the log level for jobs, refer to LogLevel.

Hint - microservice environment

When the LOG_LEVEL for dpf-process-manager service is set to info, the first line of job.log states if the new microservice environment was used for the job.

MONGO_CONNECT_RETRIES¶

MONGO_CONNECT_RETRIES specifies the number of attempts of a service to connect to the database.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/MONGO_CONNECT_RETRIES

Available values: Integer

<number_retries>

Default: 10

MONGO_DPF_URL¶

MONGO_JOBS_URL specifies the URL of the database where the DPF jobs are storaged.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/MONGO_DPF_URL

Available values: String

mongodb://<server>:<port>/dpf for a single MongoDB server
mongodb://<server1>,<server2,<server3>/dpf?replicaSet=<replica_set> for MongoDB in the cluster mode

Default: mongodb://localhost:27017/dpf

MONGO_LOCKS_AGE¶

MONGO_LOCKS_AGE specifies the time interval after which a lock is regarded as outdated and deleted from the database. A quarter of MONGO_LOCKS_AGE is used as lock-update interval by all services. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/dpf-process-manager/tag/any/MONGO_LOCKS_AGE

Available values: String

<time_interval_and_unit>

Default: 1m

MONGO_LOCKS_INTERVAL¶

MONGO_LOCKS_INTERVAL specifies the time interval after which the ages of the locks are checked. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-dpf-process-manager service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/dpf-process-manager/tag/any/MONGO_LOCKS_INTERVAL

Available values: String

<time_interval_and_unit>

Default: 5s

PERLLIB¶

PERLLIB specifies the directory of the Perl library.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/PERLLIB

Available values: String

<directory>

Default: ??? Todo

Example

env:
    service:
        any:
            tag:
                any:
                    LOG_LEVEL: debug
                    PERLBIN_PATH: C:\SEAL\applications\tools\perl\bin_winnt5\bin
                    PERLLIB: C:\SEAL\applications\tools;C:\SEAL\applications\tools\sealcc\lib;C:\SEAL\applications\server\sapserv\startstop
                    PLSROOT: C:\SEAL\applications
            ...

PLS_LANG¶

PLS_LANG specifies the language in which the messages are output.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/PLS_LANG

Available Values: String

DE

Messages are output in German.
EN

Messages are output in English.

Default: EN

Example

env:
    service:
        any:
            tag:
                any:
                    PLS_LANG: EN
            ...

PLS_OSFULLNAME¶

PLS_OSFULLNAME specifies the name of the operating system used for accessing the platform-specific files.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/PLS_OSFULLNAME

Available values: String

winnt5

Windows Server operating system
??? Todo: andere mögliche Werte?
<operating system>

Default: none

Example

env:
    service:
        any:
            tag:
                any:
                    PLS_OSFULLNAME: winnt5

Do not change

The value is set during the installation process. It may not be changed afterwards.

PLSROOT¶

PLSROOT specifies ??? Todo

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/PLSROOT

Available values: String

<directory>

Default: ??? Todo

Example

env:
    service:
        any:
            tag:
                any:
                    LOG_LEVEL: debug
                    PERLBIN_PATH: C:\SEAL\applications\tools\perl\bin_winnt5\bin
                    PERLLIB: C:\SEAL\applications\tools;C:\SEAL\applications\tools\sealcc\lib;C:\SEAL\applications\server\sapserv\startstop
                    PLSROOT: C:\SEAL\applications
            ...

PLSDATA¶

PLSDATA specifies the directory of the data area.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/PLSDATA

Available values: String

<directory>

Default: data

Example

env:
    service:
        any:
            tag:
                any:
                    PLSDATA: C:\SEAL\applications\data
            ...

Do not change

The value is set during the installation process. It may not be changed afterwards.

PLSTBIN¶

PLSTBIN specifies the directory containing the binaries of the tools.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/PLSTBIN

Available values: String

<directory>

Default: tools\bin_<PLS_OSFULLNAME>

Literature

SEAL_CUSTOMDIR¶

SEAL_CUSTOMDIR specifies the directory containing the customer specific files for the products from SEAL Systems.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/any/tag/any/SEAL_CUSTOMDIR

Available values: String

<directory>

Default: ??? Todo

Example

env:
    service:
        any:
            tag:
                any:
                    SEAL_CUSTOMDIR: C:\SEAL\customer

Do not change

The value is set during the installation process. It may not be changed afterwards.

SERVICE_URL¶

SERVICE_URL specifies how a service can be accessed.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/<service>/tag/any/SERVICE_URL

Available values: String

<service_url>

Default: The server name is determined when a service is started and the default port is used. The correspondent assignment is described in Used Ports.

WUWAIT_INTERVAL¶

WUWAIT_INTERVAL specifies ???

The key is available for ???

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

dc/home/env/service/???/tag/any/WUWAIT

Available values: String

<time_interval_and_unit>

Default: 1m