Service Keys¶
The key value store of Consul administrates the PLOSSYS 5 server configuration.
You can change the key via the Consul Web interface (see Consul) or via PLOSSYS CLI (see Administrate the System Configuration).
Units¶
Size¶
Values with size specifications are specified in the following size units:
-
bytes(B) -
kilobytes(KB) -
megabytes(MB) -
gigabytes(GB)
Example - with size units
10 Megabytes: 10MB
Time¶
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
2 hours and 30 minutes: 2h30m
4 minutes and 2 seconds: 4m2s
ALLOWED_OIDC_CLIENTS¶
ALLOWED_OIDC_CLIENTS specifies the mapping of permissions to roles specified in the OIDC identity provider. For some examples, refer to Configure the PLOSSYS 5 Server.
The key is available for the seal-rest service.
In Consul, the key is specified here:
dc/home/env/service/rest/tag/any/ALLOWED_OIDC_CLIENTS
Available values: JSON string format
Default: none
AUTH_CLIENT_ID¶
AUTH_CLIENT_ID specifies the client name configured in the OIDC identity provider for retrieving the access token.
The key is available for the following services:
-
seal-plossysadmin -
seal-plossyscli
In Consul, the key is specified here:
dc/home/env/service/<service_name>/tag/any/AUTH_CLIENT_ID
Available values: String
<client_id>
Default:
-
seal-plossyscliservice:seal-plossyscli -
seal-plossysadminservice:seal-plossysadmin
AUTH_CLIENT_SECRET¶
AUTH_CLIENT_SECRET specifies the client secret for retrieving the OIDC identity provider's access token.
The key is available for the following services:
-
seal-plossysadmin -
seal-plossyscli
In Consul, the key is specified here:
dc/home/env/service/<service_name>/tag/any/AUTH_CLIENT_SECRET
Available values: String
<client_secret>
Default: not revealed
AUTH_CLOCK_TOLERANCE¶
AUTH_CLOCK_TOLERANCE specifies the number of seconds allowed as time difference between the OIDC identity provider and the client.
The key is available for the seal-plossysadmin service.
In Consul, the key is specified here:
dc/home/env/service/plossysadmin/tag/any/AUTH_CLOCK_TOLERANCE
Available values: String
<number_seconds>
Default: 5
AUTH_DEFAULT_SESSION_DURATION¶
AUTH_DEFAULT_SESSION_DURATION specifies the duration of the default session in seconds if the OIDC identity provider does not expose the refresh_expires_in parameter in the token.
The key is available for the seal-plossysadmin service.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/AUTH_DEFAULT_SESSION_DURATION
Avaialble values: String
<number_sessions>
Default: 180
AUTH_ISSUER_URL¶
AUTH_ISSUER_URL specifies the OIDC issuer URL. This URL is configured in Keycloak for example. For more information about Keycloak used with SEAL Systems products, refer to the SEAL Interfaces for OIDC documentation.
The key is available for all services.
Caution - ID_PROVIDER_NAME
AUTH_ISSUER_URL has to be set to the same value as ID_PROVIDER_NAME.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/AUTH_ISSUER_URL
Available values: String
<oidc_issuer_url>
Default: https://localhost:32769/auth/realms/SEAL
AUTH_REDIRECT_PROTOCOL¶
AUTH_REDIRECT_PROTOCOL specifies the transfer protocol.
The key is available for the seal-plossysadmin service.
In Consul, the key is specified here:
dc/home/env/service/plossysadmin/tag/any/AUTH_REDIRECT_PROTOCOL
Available values: String
-
http -
https
Default: The protocol of the user interface server is used.
AUTH_REFRESH_TOLERANCE¶
AUTH_REFRESH_TOLERANCE specifies the number of seconds after which a token will be refreshed when it is about to expire.
The key is available for the seal-plossysadmin service.
In Consul, the key is specified here:
dc/home/env/service/plossysadmin/tag/any/AUTH_REFRESH_TOLERANCE
Available values: String
<number_seconds>
Default: 5
AUTH_TYPE¶
AUTH_TYPE specifies the mode of the client authentication.
The key is available for the following services:
-
seal-ipp-checkin -
seal-job-notifier -
seal-rest
In Consul, the key is specified here:
dc/home/env/service/<service_name>/tag/any/AUTH_TYPE
Available values: String
-
basicThe service accepts any authentication. This is implemented by the
Basic Authauthentication. -
oidcIn the request the service expects a JSON Web token (JWT) which is received from an authentication via OpenID server connect.
-
oidc basic(Only available theseal-restservice.)Use
oidcandbasicconcurrently.
Default: oidc
Hint - in practice
In practice, only oidc is relevant due to PLOSSYS Administrator does only work with oidc and using multiple user authentication does not make sense.
CONFIG¶
CONFIG specifies the customized content of the CONFIG configuration file required by the SAPGOF converter.
The key is available for the SAPGOF converter.
In Consul, the key is specified here:
dc/home/plossys/sapgof/CONFIG
Available values: String
<content_config_file>
Default: none (The settings in C:\Program Files\SEAL Systems\seal-sapgof\lib\config\CONFIG are used.)
CONFIG_DIR¶
CONFIG_DIR specifies the name of the directory which contains the configuration of the services unless the configuration is read from Consul.
The key is available for the following services:
-
seal-pdfstamp -
seal-sapgof
In Consul, the key is specified here:
dc/home/env/<service>/any/tag/any/CONFIG_DIR
Available values: String
<config_dir>
Default: none (The settings are read from Consul.)
CONSUL_DOMAIN¶
CONSUL_DOMAIN specifies the domain with which the PLOSSYS 5 services log on.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/CONSUL_DOMAIN
Available values: String
<domain_name>
Default: consul
CONSUL_TOKEN¶
CONSUL_TOKEN specifies the ACL token with which the PLOSSYS 5 services authenticate themselves to Consul.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/CONSUL_TOKEN
Available values: String
<token>
Default: INSECURE_ACL_MASTER_TOKEN
CONSUL_URL¶
CONSUL_URL specifies the URL of the Consul server to which the PLOSSYS 5 services log on.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/CONSUL_URL
Available values: String
<consul_url>
Default: https://localhost:8500
ELASTICSEARCH_INDEX_LOG¶
ELASTICSEARCH_INDEX_LOG specifies the index with which the log messages are stored in Elasticsearch.
The key is available for the seal-rest service.
In Consul, the key is specified here:
dc/home/env/service/rest/tag/any/ELASTICSEARCH_INDEX_LOG
Available values: String
<index_name>
Default: seal-plossys-5-log
ELASTICSEARCH_INDEX_STATISTICS¶
ELASTICSEARCH_INDEX_STATISTICS specifies the index with which the statistics messages are stored in Elasticsearch.
The key is available for the seal-rest service.
In Consul, the key is specified here:
dc/home/env/service/rest/tag/any/ELASTICSEARCH_INDEX_STATISTICS
Available values: String
<index_name>
Default: seal-plossys-5-statistics
ELASTICSEARCH_REST_URL¶
ELASTICSEARCH_REST_URL specifies the URL of the Elasticsearch server.
The key is available for the seal-rest service.
In Consul, the key is specified here:
dc/home/env/service/rest/tag/any/ELASTICSEARCH_REST_URL
Available values: String
<elasticsearch_url>
Default: http://localhost:9200
GRIBS74_PDF_DB¶
GRIBS74_PDF_DB contains the customized content of the GRIBS74_PDF_DB configuration file required by the SAPGOF converter.
The key is available for the SAPGOF converter.
In Consul, the key is specified here:
dc/home/plossys/sapgof/GRIBS74_PDF_DB
Available values: String
<content_gribs74_pdf_db_file>
Default: none (The settings in C:\Program Files\SEAL Systems\seal-sapgof\lib\config\GRIBS74_PDF_DB are used.)
HOUSEKEEPER_INTERVAL¶
HOUSEKEEPER_INTERVAL specifies the time interval after which the service is restarted.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/HOUSEKEEPER_INTERVAL
Available values: String
<time_interval>
Default: 1h
HTPASSWD¶
HTPASSWD specifies the valid users when basic authentication is used. The value has to accord to the format of the Apache htpasswd file. If HTPASSWD is set, HTPASSWD_FILE will be ignored.
The key is available for the seal-rest service.
In Consul, the key is specified here:
dc/home/env/service/rest/tag/any/HTPASSWD
Available values: String
<htpasswd_content>
Default: none
HTPASSWD_FILE¶
HTPASSWD_FILE specifies the location of the password file which contains the valid users when basic authentication is used. The content of this file has to accord to the format of the Apache htpasswd file.
The key is available for the following services:
-
seal-housekeeper -
seal-ipp-checkin -
seal-rest
In Consul, the key is specified here:
dc/home/env/service/<service_name>/tag/any/HTPASSWD_FILE
Available values: String
<htpasswd_path>
Default: none
ID_PROVIDER_NAME¶
ID_PROVIDER_NAME specifies the name of the OIDC identity provider.
The key is available for all services.
Caution - AUTH_ISSUER_URL
ID_PROVIDER_NAME has to be set to the same value as AUTH_ISSUER_URL.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/ID_PROVIDER_NAME
The key is mandatory.
Available values: String
<id_provider_name>(For example, with Keycloak, it is a complete URL:https://<hostname>:32769/auth/realms/SEAL)
Default: none
JOB_LIFETIME_CANCELED¶
JOB_LIFETIME_CANCELED specifies the time interval after which a job with the Canceled status is deleted from the database.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/JOB_LIFETIME_CANCELED
Available values: String
-
<time_interval> -
-1The time interval will never be reached and so the jobs never will be deleted.
Default: 24h
JOB_LIFETIME_ERROR¶
JOB_LIFETIME_ERROR specifies the time interval after which a job with the Error status is deleted from the database.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/JOB_LIFETIME_ERROR
Available values: String
-
<time_interval> -
-1The time interval will never be reached and so the jobs never will be deleted.
Default: 3d
JOB_LIFETIME_PAUSED¶
JOB_LIFETIME_PAUSED specifies the time interval after which a job with the Paused status is deleted from the database.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/JOB_LIFETIME_PAUSED
Available values: String
-
<time_interval> -
-1The time interval will never be reached and so the jobs never will be deleted.
Default: 3d
JOB_LIFETIME_PROCESSED¶
JOB_LIFETIME_PROCESSED specifies the time interval after which an order with the Processed status is deleted from the database.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/JOB_LIFETIME_PROCESSED
Available values: String
-
<time_interval> -
-1The time interval will never be reached and so the jobs never will be deleted.
Default: 24h
JOB_LIFETIME_PROCESSING¶
JOB_LIFETIME_PROCESSING specifies the time interval after which an order with the Processing status is deleted from the database.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/JOB_LIFETIME_PROCESSING
Available values: String
-
<time_interval> -
-1The time interval will never be reached and so the jobs never will be deleted.
Default: -1
JOB_LIFETIME_WAITING¶
JOB_LIFETIME_WAITING specifies the time interval after which a job waiting in a non-pickup queue is deleted from the database.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/JOB_LIFETIME_WAITING
Available values: String
-
<time_interval> -
-1The time interval will never be reached and so the jobs never will be deleted.
Default: -1
JOB_LIFETIME_WAITING_PICKUP¶
JOB_LIFETIME_WAITING_PICKUP specifies the time interval after which a job waiting in a pickup queue is deleted from the database.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/JOB_LIFETIME_WAITING_PICKUP
Available values: String
-
<time_interval> -
-1The time interval will never be reached and so the jobs never will be deleted.
Default: 3d
JOB_MAX_POSTPONED_COUNT¶
JOB_MAX_POSTPONED_COUNT specifies how often a job will be postponed by the seal-dispatcher service in case the next service is not available for example. After exceeding the specified maximum of postponements, the job will be considered erroneous.
The key is available for the seal-dispatcher service.
In Consul, the key is specified here:
dc/home/env/service/dispatcher/tag/any/JOB_MAX_POSTPONED_COUNT
Available values: Integer
-
<number_max_count>The maximum of postponements.
Default: 10
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:
-
dc/home/env/service/any/tag/any/LOG_LEVELfor all services -
dc/home/env/service/<service>/tag/any/LOG_LEVELfor the specific<service>service
Available values: String
-
debugDebug messages are written to the log file of the service.
-
infoInformation messages are written to the log file of the service.
-
warnWarning messages are written to the log file of the service.
-
errorError messages are written to the log file of the service.
-
fatalSerious error messages are written to the log file of the service.
Default: info
Example - log level error
Messages of the log levels error and fatal are written to the log file.
Example - log level info
Messages of the log levels info, warn, error and fatal are written to the log file.
LOUNGE_TTL¶
LOUNGE_TTL specifies the time interval between two transmission attempts in case of error.
The key is available for the seal-dispatcher service.
In Consul, the key is specified here:
dc/home/env/service/dispatcher/tag/any/LOUNGE_TTL
Available values: String
<time_interval>
Default: 1m
LPR_ENCODING¶
LPR_ENCODING specifies the encoding of the job that is accepted or output via LPR.
The key is available for the following services:
-
seal-checkin -
seal-checkout
In Consul, the key is specified here:
dc/home/env/service/<service_name>/tag/any/LPR_ENCODING
Available values: String
Default: win1252
MAX_INSTANCES¶
MAX_INSTANCES specifies the maximum of parallel conversions.
The key is available for the following services:
-
seal-ghost -
seal-sapgof
In Consul, the key is specified here:
dc/home/env/service/<service_name>/tag/any/MAX_INSTANCES
Available values: Integer
<number_instances>
Default: Number of the available CPU cores in the system
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:
dc/home/env/service/any/tag/any/MONGO_CONNECT_RETRIES
Available values: Integer
<number_retries>
Default: 10
MONGO_EVENTS_COLLECTION_SIZE¶
MONGO_EVENTS_COLLECTION_SIZE specifies the size ot the capped collection used to store events in the database.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/MONGO_EVENTS_COLLECTION_SIZE
Available values: String
<collection_size>
Default: 1MB
MONGO_EVENTS_URL¶
MONGO_EVENTS_URL specifies the URL of the database where internal system notifications are stored.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/MONGO_EVENTS_URL
Available values: String
<mongo_events_url>
Default: mongodb://localhost/spooler-events
MONGO_JOBS_URL¶
MONGO_JOBS_URL specifies the URL of the database where the graphic data is stored.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/MONGO_JOBS_URL
Available values: String
<mongo_jobs_url>
Default: mongodb://localhost/spooler-jobs
MONGO_PRINTERS_URL¶
MONGO_PRINTERS_URL specifies the URL of the database where the printer configuration is stored.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/MONGO_PRINTERS_URL
Available values: String
<mongo_printers_url>
Default: mongodb://localhost/spooler-printers
NODE_TLS_REJECT_UNAUTHORIZED¶
NODE_TLS_REJECT_UNAUTHORIZED specifies if self-signed certificates are allowed.
The key is available for the seal-plossysadmin service.
In Consul, the key is specified here:
dc/home/env/service/plossysadmin/tag/any/NODE_TLS_REJECT_UNAUTHORIZED
Available values: Integer
-
0Self-signed certificates are allowed.
-
1Self-signed certificates are not allowed.
Default: 1
Caution - security gap
Setting NODE_TLS_REJECT_UNAUTHORIZED to 0 in a productive system is a serious security gap! Only use it for test purposes!
PACER_INTERVAL¶
PACER_INTERVAL specifies the time interval after which the database is searched again for jobs that have not yet been processed.
The key is available for the seal-dispatcher service.
In Consul, the key is specified here:
dc/home/env/service/dispatcher/tag/any/PACER_INTERVAL
Available values: String
<time_interval>
Default: 5m
PRINT_ERROR_SHEET¶
PRINT_ERROR_SHEET specifies if an error sheet is output in case of error.
The key is available for the seal-dispatcher service.
In Consul, the key is specified here:
dc/home/env/service/dispatcher/tag/any/PRINT_ERROR_SHEET
Available values: Boolean
-
YAn error sheet is output in case of error.
-
NNo error sheet is output in case of error.
Default: N
Hint - default behavior has been changed
Up to version 5.0.5, an error sheet was output in case of error. As of version 5.1.0, the error sheet is not output by default but can be activated by setting PRINT_ERROR_SHEET to Y.
REST_BASE_URL¶
REST_BASE_URL specifies the address of the PLOSSYS REST API.
The key is available for the seal-plossysadmin service.
In Consul, the key is specified here:
dc/home/env/service/plossysadmin/tag/any/REST_BASE_URL
Available values: String
<rest_url>
Default: https://localhost:8080
REST_VERSION¶
REST_VERSION specifies the version of the URL suffix of the PLOSSYS REST API.
The key is available for the seal-plossysadmin service.
In Consul, the key is specified here:
dc/home/env/service/plossysadmin/tag/any/REST_VERSION
Available values: String
<version>
Default: v3
SAP_JOBNOTIFY_TIMEOUT¶
SAP_JOBNOTIFY_TIMEOUT specifies the timeout for sending job notifications to SAP.
The key is available for the seal-job-notifier service.
In Consul, the key is specified here:
dc/home/env/service/job-notifier/tag/any/SAP_JOBNOTIFY_TIMEOUT
Available values: String
<time_interval>
Default: 60s
SAP_JOBNOTIFY_WAITTIME¶
SAP_JOBNOTIFY_WAITTIME specifies the time after which the final status notification is replied to SAP.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/SAP_JOBNOTIFY_WAITTIME
Available values: String
<time_interval>
Default: 15m
SAPNWRFCINI_PATH¶
SAPNWRFCINI_PATH specifies the directory where the SAP configuration file sapnwrfc.ini is stored. The key has to be set if notifications are to be returned to the requesting SAP Systems.
The key is available for the seal-job-notifier service.
In Consul, the key is specified here:
dc/home/env/service/job-notifier/tag/any/SAPNWRFCINI_PATH
Available values: String
<path>
Default:
-
Windows:
C:/ProgramData/SEAL Systems/PLOSSYS/config -
Linux:
/opt/seal/etc
SERVICE_DISCOVERY¶
SERVICE_DISCOVERY specifies if PLOSSYS 5 is running in a cloud environment or on premise. In the cloud environment, the configuration can not be read from Consul but from files.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/SERVICE_DISCOVERY
Available values: String
-
cloudPLOSSYS 5 is running in a cloud environment.
-
consulPLOSSYS 5 is running on premise.
Default: consul
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:
dc/home/env/service/<service>/tag/any/SERVICE_URLfor the specific<service>service
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.
SWEEP_AGE¶
SWEEP_AGE specifies the time interval after which an incomplete job is regarded as incorrect and deleted from the database.
The key is available for the seal-housekeeper service.
In Consul, the key is specified here:
dc/home/env/service/housekeeper/tag/any/SWEEP_AGE
Available values: String
<time_interval>
Default: 10m
SYSTEMS¶
SYSTEMS specifies the list of SAP systems whose output jobs are to be stamped. The value is a multiline text containing one system name in each line.
The key is available for the seal-ipp-checkin service.
In Consul, the key is specified here:
dc/home/plossys/sapgof/stamp/SYSTEMS
Available values: Multiline string
-
<system1> |<system2> |...<systemn>
Default: none
TEMPLATE¶
TEMPLATE specifies the stamp layout for the SAP output jobs.
The key is available for the seal-pdfstamp service.
In Consul, the key is specified here:
dc/home/plossys/sapgof/stamp/TEMPLATE
Available values: String
<template_file>
Default: The default layout of PDF Stamp is used. For more information about PDF Stamp, refer to the PDF Stamp documentation.
TEXT¶
TEMPLATE specifies the stamp text for the SAP output jobs. In the text, variables can be specified.
The key is available for the seal-pdfstamp service.
In Consul, the key is specified here:
dc/home/plossys/sapgof/stamp/TEXT
Available values: String
<stamp_text>
Default: The default stamp text of PDF Stamp is used. For more information about PDF Stamp, refer to the PDF Stamp documentation.
TIMEOUT¶
TIMEOUT specifies the time interval after which a conversion is aborted if it has not generated any new data.
The key is available for the following services:
-
seal-pdf2ps -
seal-pdfstamp -
seal-sapgof
In Consul, the key is specified here:
dc/home/env/service/<service_name>/tag/any/TIMEOUT
Available values: String
<time_interval>
Default: 2m
TLS_DIR¶
TLS_DIR specifies the directory containing the certificate files necessary for the secure transfer between the clients and servers and within PLOSSYS 5.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/TLS_DIR
Available values: String
<dir_name>
The directory contains the following files:
-
key.pemFile with the private key
-
cert.pemFile with the certificate
-
ca.pemFile with the CA certificate
Default: none
Hint - certificate files contained in delivery
The self-signed certificates contained in delivery are hard-coded. The tls directories contained in delivery only contain examples which certificate files are required and how they look like.
TLS_PADIR¶
TLS_PADIR specifies the directory containing the certificate files necessary for secure transfer with PLOSSYS Administrator.
The key is available for the seal-plossysadmin service.
In Consul, the key is specified here:
dc/home/env/service/plossysadmin/tag/any/TLS_PADIR
Available values: String
<dir_name>
The directory contains the following files:
-
key.pemFile with the private key
-
cert.pemFile with the certificate
-
ca.pem(optional)File with the CA certificate
Default: none
Hint - certificate files contained in delivery
The self-signed certificates contained in delivery are hard-coded. The tls directories contained in delivery only contain examples which certificate files are required and how they look like.
TLS_UNPROTECTED¶
TLS_UNPROTECTED specifies the encryption between the PLOSSYS 5 services.
The key is available for all services.
In Consul, the key is specified here:
dc/home/env/service/any/tag/any/TLS_UNPROTECTED
Available values: String
-
noneAll connections are encrypted via HTTPS.
-
loopbackThe local connections are not encrypted. The connections between different servers are encrypted via HTTPS.
Default: loopback