Server Parameters

customizing__sys_cu_error_url

String

URL that is displayed in the Problems in System Customizing message and that contains links to the corresponding documentation page in the PLANTA Online Help

customizing__enable_py_service_functions

{0,1}

• 0: service functions are deactivated

• 1: (default) service functions are activated

ppms_license

String

License of PLANTA project, default is '000'

database__q1codepage

Integer

Code page of the system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))

database__typename

String
{oracle, mssql, postgres}

Type of system database

S 39.1.0

database__type

Integer

Deprecated since S 39.1.0 and will be removed in future releases. Use database_typename instead

Type of system database

Up to S 39.1.0

default_language

String (e.g.: de)

Default language for preloading

default_currency

String

Default currency for preloading (currently not used)

default_country

String

Default country for preloading (currently not used)

preload_languages

String (e.g.: en, fr, ru)

Additional languages for preloading

customizing__dtp_customizing_mode

{0,1}

When enabled, CU metadata will always be up-to-date and no stale values will be used within the session (effectively disables all caching on DTP level). For further information, see here.

intercom__enable_compression

{0,1}

default 1; allows compressed communication with a recent and correctly configured client (see NachrichtenKompression for details)

intercom__compression_level

{0..9}

default 6; defines the compression level with 0:no compression and 9:best compression

customizing__enable_exec_python_script

{0,1}

• default 1; allows the deactivation of the processing of client_exec()/server_exec() API calls

• The HeadlessClient is based on this functionality; in case of deactivation, BatchJobs will no longer work!

scheduler__disable_sched_fixes

String

Using these parameters you can disable the fixes listed below.

customizing__version

earth or venus

Select the customizing version of the PLANTA Python library

maintain__gc_keepalive_threshold_megabytes

512

Threshold value for garbage collection.
If the total memory usage of one session exceeds this value, an attempt to release memory will be undertaken, not only during the waiting period but also while the program is running. The default value is 512. For performant scheduling/replanning in large systems, a value between 1024 and 8192 is recommended.

customizing__debug_python

{0,1}

Enables (1) or disables (0) the remote Python debug interface.

customizing__debug_python_host

String (e.g. localhost)

Hostname or IP address of the debugger client to which the server connects.

customizing__debug_python_port

Integer (e.g. 5678)

Port number used to establish the connection with the Python debugger.

exit_on_exception

{0,1}

If set to 1, the worker process will terminate immediately upon encountering a critical, unhandled exception.

maintain__system__dimension

small, medium, large

The general size of the system. This parameter sets various other parameters (parallel_sessions, hibernate__c3p0__min_size, hibernate__c3p0__timeout, hibernate__c3p0__max_size, hibernate__c3p0__numHelperThreads) to suitable pre-defined values, unless these parameters have themselves been set to a different value.

For parallel_sessions, these are “small” 10, “medium” 25, “large” 75. The default is “medium”.

Internal sessions without a client, such as the persistent scheduler session, are no longer counted against this limit from S 39.2.0.

In S 39.2.7 and S 39.2.8, this parameter does not set the c3p0 values. The import of a customizing deployment aborts there.

Behavior changed from S 39.2.7

maintain__create_core_dumps

{0,1}

Enables (1) or disables (0) the generation of core dumps in case of a crash.

maintain__core_dump_root_path

String

If the application crashes and a core dump is generated, it will be saved here.

From S 39.5.37: If a writeable_path is defined, it will be added to this path.

maintain__core_dump_tool_command

String (path or shell command)

Command used to run a tool that processes or generates the core dump.

maintain__create_heap_dumps

{0,1}

Enables (1) heap dump creation in case of critical memory-related issues.

maintain__attach_jit_debugger

{0,1}

Enables (1) automatic attachment of a just-in-time debugger when an error occurs.

maintain__jit_debugger_command

String (shell command)

Command to start the JIT debugger (e.g., gdb, vsjitdebugger, etc.).

database__max_parameters_in_statement

Integer (e.g. 999)

Maximum number of parameters allowed in a single SQL statement (e.g. for IN clauses).

database__max_split_statements

Integer (e.g. 100)

Maximum number of SQL statements a single query may be split into.

database__query_by_key_cutoff

Integer (e.g. 200)

If the number of keys exceeds this threshold, the query will be split or processed differently.

database__query_min_statements_for_stocking

Integer (e.g. 5)

Optimization will only be applied if at least this many SQL statements are involved.

client_transfer__max_dfs_in_one_message

Integer (e.g. 1000)

Maximum number of data fields (DFs) that can be sent in a single client-server message.

maintain__planta_pwd_hashing

{0,1}

If enabled (1), passwords will be compared using hashes only, increasing security.

database__use_underscore_as_wildcard

Boolean true, false

If true (default), SQL treats an underscore as wildcard.

S 39.0.4 m

S 39.0.3 w

session_shutdown_timeout

Integer (seconds)

Time limit for the controlled shutdown of the worker on the signals SIGTERM and SIGINT, for example with docker stop. Default value “30”. If the proto connection to the manager exists, a clean shutdown message is sent to the manager. If the shutdown is not completed within this time, the worker is terminated forcibly, and this is logged.

S 39.2.0

session_oidc_login_timeout

Integer (seconds)

Time a Web Client session with OIDC login waits for the logged-in user. Default value “1800”. If no user is transmitted within this time or the connection to the Web Client is lost, the worker ends the session.

S 39.2.5

maintain__transform_sql_literals

The internal parsing and replacement of literals can be switched off globally with this parameter

auth__methods

interactive

kerberos

any

• interactive: the usual login message box, secure due to challenge-response authentication.

  • For a backward-compatible behavior, auth__methods is set to interactive by default.

  • As long as this value is set, there will be no changes with regard to previous versions.

• kerberos

• any: is composed of all implemented authentication methods)

• or any combination of the above listed values, separated by blank characters and/or punctuation, so that it results in a conjunction of all mentioned individual or combined methods.

ldap

openidconnect

pki

• ldap, openidconnect, pki: authentication via a preceding software component (requires the use of PLANTA secure)

proxy

osuser

legacy

secure

• proxy: authentication via a preceding software component (requires the use of PLANTA secure)

• osuser: no authentication, not secure

• legacy: is composed of the authentication methods osuser and interactive

• secure: is composed of the authentication methods, enabling a secure login, currently interactive and kerberos

Up to S 39.5.31

config__globals

String (path)

Path to the main global.conf configuration file.

config__server

String (path)

Path to the PLANTA server configuration file (local path under PLANTA server directory).
Should not be changed by the user.

config__hibernate

String (path)

Path to the Hibernate configuration file (local path under PLANTA server directory).
Should not be changed by the user.

config__web

String (path)

Path to the Webservice configuration file (local path under PLANTA server directory).
Should not be changed by the user.

config__kerberos

String (path)

Path to the Kerberos configuration file (local path under PLANTA server directory).
Should not be changed by the user.

config__auth

String (path)

Path to the authentication configuration file (local path under PLANTA server directory).
Should not be changed by the user.

config__secure

String (path)

Path to the Secure configuration file (local path under PLANTA server directory).
Should not be changed by the user.

config__license

String (path)

Path to the license configuration file (local path under PLANTA server directory).
Should not be changed by the user.

config__logback

String (path)

Defines the file to be used as logback configuration. Can, for example, be one of the following files with the config/ prefix (e.g. config/logback.xml):

• logback.xml

• logback_debug.xml

• logback_console_files.xml

• logback_console_files_debug.xml

• logback_only_console.xml

• logback_only_console_debug.xml

  • The only_console files can be used for logging within the container. No log files are written and the SessionType is added to each message.

The config/ prefix is optional from S 39.2.0. A plain file name is searched for automatically in the config/ directory. Existing entries with prefix and absolute paths work unchanged.

logback__level__<logger>

OFF, ERROR, WARN, INFO, DEBUG, TRACE, INHERITED

Sets the log level of a single logger without changing the logback configuration file. The logger name replaces <logger>; for the root logger, it is ROOT. INHERITED removes a level set in the file so that the level is inherited from the parent logger again. The parameter overrides the file and is applied again at every reload.

S 39.2.0

config__scheduler

String (path)

Path to the scheduler configuration file. Should not be changed by user.

gui__host

Host name or IP address, v4 or v6

External host name of the server. The network interface on which the server listens is set via gui__interface.

Behavior changed from S 39.2.0

gui__interface

Host name or IP address, v4 or v6

Network interface on which the server listens for client connections. Previously, this was controlled via gui__host.

S 39.2.0

gui__port

Integer

Port the server is listening on for client connections

maintain__debug

Boolean

Loads a debug version of the python library when set to true - development option

maintain__silent

Boolean

Deactivates/activates some output to standard output and standard error - development option

maintain__performance_counting

Boolean

false by default; true enables performance counting globally

maintain__virtual_threads_enabled

Boolean true, false

Controls whether the helper and session I/O threads of the manager run on Java 21 virtual threads. Default value “true”. With “false”, classic platform threads are used, which matches the behavior up to S 39.1 and also serves as a rollback without a code change. Requires JDK 21 or higher.

S 39.2.0

parallel_sessions

Integer

Number of sessions (connections to the server, or open clients) allowed at the same time before the server rejects new connection attempts. Internal sessions without a client no longer count against this limit from S 39.2.0. When the limit is reached, the server logs the rejection with log message 0100093 (WARN), including scope, configured limit, and current number of sessions. Without a value of its own, the value from maintain__system__dimension applies: “small” 10, “medium” 25, “large” 75. The default is “medium”.

Behavior changed from S 39.2.0

Behavior changed from S 39.2.7

maintain__recompile_pojos_at_startup

Boolean

If set to true, Java classes that are defined by Customizing tables will be recompiled at every Server start (recommended)

maintain__mem_limit__max_size

Integer

Native memory size maximum (in MiB)

maintain__mem_limit__session

Integer

Minimum free size (in MiB) for session start

maintain__mem_limit__calculation

Integer

Minimum free size (in MiB) for calculation of a project

maintain__mem_limit__module

Integer

Minimum free size (in MiB) for loading module data

maintain__mem_limit__alloc

Integer (MiB)

Memory threshold (in MiB) for native memory allocation control.

maintain__mem_limit__recalculation

Integer

Minimum free size (in MiB) for start of recalculation

relational_delete_by_java

Boolean

A different way of handling the deletion of related tables
This is a beta functionality; it is recommended that you leave this at false

maintain__ld_preload_names

String

Internal names for Server
This should NOT be changed by the user

proto__keepalive__millis

Integer (milliseconds)

If no protobuffer-message is received after this interval, the client will be closed (assumed to be stuck)

proto__keepalive__check

Integer

If this number of protobuffer-messages fails to arrive, the client will be closed (protobuffer-error assumed)

writeable_path

String (path)

Directory in which the server writes files

logfile_path

String (path)

Directory in which the server writes log files. If a writeable_path is defined, it will be added in front of the path defined in logfile_path

maintain__ssl__debug

Boolean

If set to true, debug information for SSL is logged. If the server is started with yajsw, the information will be contained in wrapper.log

sessionlink

host name/IP address

Enables the ProtoInterface connection between Worker and Manager.

use_external_autonumber_service

{0,1}

Enables (1) the use of an external auto-numbering service for IDs.

external_autonumber_service

String (URL)

URL to the external auto-numbering service used when enabled.

database__persistent_db_session

{0,1}, {false, true}

If “1” (or “true”), a persistent database session is maintained across client requests. Each session gets its own database connection, which is closed at the end of the session. In this mode, hibernate__c3p0__max_size does not limit the number of connections.

Behavior changed from S 39.2.0

Behavior changed from S 39.2.7

maintain__dont_waste_my_time

{0,1}

Internal flag to skip schema validation checks (use with caution).

maintain__detached_native

{0,1}

If 1, the Manager will not automatically start a Worker on startup.

maintain__skip_event_manager

{0,1}

Internal flag to disable the Event Manager subsystem.

proto__debug

Integer (e.g. 0–5)

Sets the debugging level for ProtoInterface (0 = off, higher = more verbose).

maintain__jython__no_bytecode

{0,1}

If 1, Jython modules will no longer be compiled to bytecode.

maintain__jython__debug

{0,1}

Enables debug output for Jython processing.

enable_unsafe_http_requests

{0,1}

If 1, allows execution of HTTP requests considered unsafe (use with caution).

maintain__python__debug

{0,1}

Enables debug messages for Python execution.

maintain__python__pycache

String (path)

Path to the directory where Python bytecode cache is stored.

webservices__prometheus__enable

Boolean

Activates the Prometheus interface, default value false

webservices__prometheus__connection

String (e.g. 127.0.0.1:9090)

Combined Prometheus connection string in the form of IP:Port.

webservices__prometheus__port

Integer

Port extracted from prometheus__connection. Internal use.

webservices__prometheus__interface

host name/IP address

Host extracted from prometheus__connection. Internal use.

webservices__prometheus__entrypoint

String (e.g. /metrics)

URL path for the Prometheus metrics endpoint.

webservices__monitoring__enable

Boolean

Activates the monitoring interface, default value false

webservices__monitoring__port

Integer

Port number on which the web server listens; required parameter (monitoring is implicitly deactivated if no port is configured)

webservices__monitoring__interface

host name/IP address

Interface to which the web server is bound; localhost by default

webservices__services__enable

Boolean

Enables the legacy web services module

Deprecated

Use webservices__generic_service__enable instead.

webservices__services__port

Integer

Port number used for the legacy web services.

Deprecated

Use webservices__generic_service__port instead.

webservices__services__interface

String (IP or hostname)

Interface binding for legacy services.

Deprecated

Use webservices__generic_service__interface instead.

webservices__services_doc__enable

Boolean

Activates the web services documentation, false by default

webservices__services_doc__port

Integer

Port number on which the web server listens; required parameter (web services documentation is implicitly deactivated if no port is configured)

webservices__services_doc__hostname

String (hostname)

Hostname under which the service documentation will be accessible.

webservices__generic_service__enable

Boolean

Activates the PLANTA link web services, false by default

webservices__generic_service__port

Integer

Port number on which the PLANTA link web service listens; required parameter (web services are implicitly deactivated if no port is configured)

webservices__generic_service__interface

host name/IP address

Interface to which the web server is bound; localhost by default

webservices__grpc__enable

Boolean

Switches on the gRPC server for PLANTA pulse and the agile views of the Web Client. Default value true. In the web.conf configuration file, the key is grpc.

webservices__grpc__port

Integer

Port on which the gRPC server for PLANTA pulse and the agile views of the Web Client listens. Default value 50051. The manager announces the port to the Web Client at login (from S 39.2.3). In the web.conf configuration file, the key is grpc_port.

webservices__grpc__interface

Host name or IP address, v4 or v6

Network interface on which the gRPC server for PLANTA pulse listens. Default value 0.0.0.0, i.e. all interfaces. In the web.conf configuration file, the key is grpc_interface.

S 39.2.0

webservices__grpc__host

host name/IP address

Deprecated

Former name of webservices__grpc__interface, in web.conf grpc_host. The name still works. If it is set, its value is used and a deprecation warning with the new name is written to the log. If both names are set, the new one applies.

The old name will be removed in a future release and should be renamed in deployments.

webservices__ssl_swagger_enable

Boolean

Deprecated

webservices__ssl_generic_enable

Boolean

Enables SSL for PLANTA link web services, false by default

webservices__ssl_services_docs_enable

Boolean

Enables SSL for web services documentation, false by default

webservices__ssl_keystore_password

String

Password for the Java keystore

webservices__ssl_keystore

Path

Path to the Java keystore

webservices__cross_origin_filter_all

Boolean

Cross-site scripting filter which needs to be enabled, true by default

webservices__apikey_auth_filter_swagger

Boolean

Deprecated

webservices__apikey_auth_filter_generic

Boolean

ApiKey authentication for PLANTA link web services, false by default

Needs to be set to false if the Authentication parameter on a specific web interface is to be used instead

webservices__saml_auth_filter_pulse

Boolean

SAML authentication for all web services, true by default

webservices__server_status__enable

Boolean

Enables the Health Endpoint

webservices__server_status__connection

String (e.g. 127.0.0.1:9090)

Configures the connection for the Health Endpoint in the form of IP:Port.

webservices__server_status__port

Integer

Port on which the server status interface is listening.

webservices__server_status__interface

String (IP address or hostname)

Interface to which the server status interface binds.

webservices__server_status__entrypoint

String

Configures the entrypoint for the Health Endpoint

webservices__security_headers__common__std

String (header definition)

Standard security headers to include in all responses.

webservices__security_headers__common__additional

String

Additional custom headers added to all responses (non-SSL).

webservices__security_headers__ssl__std

String

Standard headers for SSL-enabled connections.

webservices__security_headers__ssl__additional

String

Additional SSL-specific headers to include in responses.

scheduler__enabled

{0,1}

Enables or disables the scheduling post processing, which controls the critical path and longest critical path calculation and new Python API functions for cycle check

scheduler__host

localhost

Hostname used by the Java part of the scheduler to establish connections.

scheduler__port

Integer (valid TCP port number)

Port number used by the Java part of the scheduler to establish connections.

scheduler__lcp_float_independent

{0,1}

If enabled, float (slack) is ignored when determining the Longest Critical Path. By default (per CPM definition), float is considered.

scheduler__lcp_determine_all

{0,1}

Determines whether all Longest Critical Paths are calculated or only the single longest one.

scheduler__lp_bucket_enabled

{0,1}

Enables or disables the bucketing method for structured Longest Path calculation.

scheduler__lp_bucket_determine_all

{0,1}

Determines whether the Longest Path is calculated across all projects or only within the selected project.

secure__stream__default_protocol

{planta_plain, planta_ssl}

Connect with or without TLS encryption

secure__stream__defaults_enforced

Boolean true, false

If defaults are not enforced, a client can specify a protocol, host, and port via the route attribute.

secure__ssl__protocol

TLSv1.2

Protocol for PLANTA backend SSL connection.

secure__ssl__keystore__file

config/keystore.jks

Keystore file in jks format. Must contain the client certificates for the servlet. Used for SSL backend connection.

secure__ssl__keystore__password

Password to access keystore

secure__ssl__truststore__file

config/truststore.jks

Truststore file in jks format. Must contain the public keys of the trust chain up to the CA that issued the certificates in keystore.jks

secure__ssl__truststore__password

Password to access truststore

secure__servlet__enforce_request_vector

Boolean true, false

Default settings for the SSL/TLS enabled connector

secure__servlet__transport_scheme

http / https

If set to https, an SSL connection is used.

secure__servlet__entrypoint

String

Makes entrypoint for PLANTA secure configurable.

This setting must match that of the ClientAdapter (secure_server_endpoint parameter).

Default: \PlantaServerAdapter\

secure__servlet__connection

String : Integer

Combines interface and port, separated by a ':', e.g. your_interface:your_port

secure__reverse_proxy__auth

Boolean true, false

To allow login using either LDAP or OIDC, this has to be set to true.

secure__reverse_proxy__user_format

plain

The format of the user header. At the moment the header is transmitted plain.

secure__reverse_proxy__user_header

{X-Authenticated-User / X-Forwarded-User}

X-Authenticated-User is used for LDAP method and X-Forwarded-User is used for OIDC as header attribute for the user name.
If it is left blank, neither LDAP nor OIDC is activated as login method.

secure__reverse_proxy__user_token

X-Forwarded-Access-Token

Is used for OIDC as header attribute for the user token.

This parameter is only required if additional claims are to be read from OIDC.

secure__session__min_wait

Integer

Defines how long a polling request may wait. Longer intervals reduce overhead, shorter intervals reduce the time until connection failure will be noticed.

secure__session__max_wait

Integer

A potential reverse proxy requires a read timeout >= max_wait in order to avoid 504 gateway timeout errors on the client adapter side.

secure__session__default_wait

Integer

secure__session__keepalive

Integer

Should be the same value for both keepalive and the client

secure__session__max_inactivity

Integer

Defines how long a session remains alive in the absence of web requests.

secure__service__ldap_enabled

Boolean true, false

Enables the LDAP service to synchronize users of a directory service

secure__service__ldap_useSSL

Boolean true, false

Enables SSL usage of the LDAP service

secure__service__ldap_ignore_size_limit_exceeded

Boolean true, false

Controls the behavior when the LDAP server size limit is exceeded during a user import. If set to false (default), the import is aborted and an error is logged. If set to true, the subset truncated by the server is imported anyway.

Instead of setting this to true, it is better to increase the size limit on the directory server or narrow the search filter to obtain complete results.

S 39.1.5

secure__service__ldap_resolve_nested_groups

Boolean true, false

Enables server-side resolution of nested groups. Default value false. With false, the behavior remains unchanged. Nested groups can then only be used via the LDAP_MATCHING_RULE_IN_CHAIN rule (1.2.840.113556.1.4.1941).

S 39.1.6

secure__service__ldap_ignore_partial_result

Boolean true, false

Ensures that the user import no longer aborts when Active Directory returns references to additional directory scopes (continuation references). Default value true. With true, continuation references are ignored and the import is carried out completely.

S 39.1.6

config__ldap

Path to the LDAP configuration file

secure__enabled

Boolean true, false

Indicates whether the secure module is enabled, based on license.

secure__stream__allowed_protocols

{planta_plain, planta_ssl} (list)

Allowed stream protocols for secure communication with the backend.

secure__stream__default_host

IP / hostname

Default host for secure backend connection.

From S 39.2.0, the parameter can be set and then overrides the automatic derivation from the worker IP address. This is required for deployments in Kubernetes and similar environments in which automatic host detection does not work reliably.

S 39.2.0 (addition)

secure__stream__default_port

Integer

Default port for secure backend connection.

secure__ssl__enabled

Enables SSL usage for secure backend connection.

secure__servlet__connection__host

Boolean true, false

Host part extracted from servlet__connection. Internal use.

secure__servlet__connection__port

Integer

Port part extracted from servlet__connection. Internal use.

secure__session__min_polling

Integer

Minimum interval between two requests.

secure__session__max_requests

Integer

Maximum number of parallel requests per session.

secure__xml__validate_schema

Boolean true / false

Validates transmitted XML against schema (XSD).

secure__auth_method__ldap

Boolean true / false

Enables LDAP as authentication method.

secure__auth_method__oidc

Boolean true / false

Enables OIDC as authentication method.

secure__auth_method__ldap_useSSL

Boolean true / false

Enables SSL for LDAP authentication method.

secure__service__ldap_convert_endianness

Boolean true / false

Converts UUID object endianness to match LDAP requirements.

S 39.0.0

secure__oidc__clientId

String

The application (client) ID from the OIDC/Azure AD app registration. This unique identifier identifies the PLANTA application at the identity provider. Tokens are only accepted if they were issued for this client ID.

secure__oidc__url_issuer

URL

The complete issuer URL of the OIDC identity provider. This URL is used to validate the JWT tokens and to retrieve the OIDC configuration. For Azure AD, it has the format https://login.microsoftonline.com/{tenant-id}. The URL must start with https and, for Microsoft Entra ID, contain a specific tenant. Cross-tenant endpoints such as “common”, “organizations”, or “consumers” disable the OIDC login.

secure__oidc__user_authent_by_token

Boolean true, false

Enables the authentication method via JWT token

S 39.0.0

secure__oidc__clientSecret

String

The client secret (application secret) from the OIDC/Azure AD app registration. Required for secure communication between the PLANTA server and the identity provider. Important: Store this secret securely (e.g. in Docker secrets or environment variables from encrypted sources).

S 39.1.0

secure__oidc__token_user_attribute

String

Defines the attribute that will be adopted as a user. Possible attributes: name, preferred_username or email

S 39.0.0

secure__oidc__url_jwkset

URL

URL of the JSON Web Key Set (JWKS) of the identity provider. The server uses these keys to verify the signature of the ID token.

secure__oidc__tenantId

String

The Tenant ID

Only S 39.1.0

secure__oidc__jwksEndpoint_suffix

String

Suffix for the jwks endpoint

Only S 39.1.0

secure__oidc__authority_prefix

String

URL prefix

Only S 39.1.0

secure__oidc__idTokenEndpoint_suffix

String

Suffix for the ID token endpoint

Only S 39.1.0

secure__oidc__scope

String

Usage of ID token

Only S 39.1.0

secure__oidc__access_token_scope

String

Usage of access token

Only S 39.1.0

secure__oidc__issuer_prefix_1

String

Issuer prefix

Only S 39.1.0

secure__oidc__issuer_prefix_2

String

Alternative issuer prefix

Only S 39.1.0

secure__oidc__issuer_prefix_3

String

Alternative issuer prefix

Only S 39.1.0

secure__oidc__jwksEndpoint_suffix_alternate

String

Alternative for the JWKS endpoint suffix

Only S 39.1.0

secure__cloudflare__team_domain

String

The complete team domain URL of your Cloudflare Zero Trust organization including protocol

S 39.1.1

secure__cloudflare__audience

String

The Audience Tag (Application Audience) of your Cloudflare Access application. If the parameter is empty, login via Cloudflare Access is disabled.

S 39.1.1

secure__cloudflare__token_user_attribute

String

The JWT token attribute to be used for user identification. Possible attributes: email, sub or user_id

S 39.1.1

ldap__enabled

Boolean true / false

Indicates whether LDAP integration is enabled on the server side. Read-only.

ldap__service__url

ldaps://your.ldap.url:port

URL for DirectoryService, preceded by the protocol and ending with the port

ldap__service__base

ou=user, DC=ldap, DC=url

The base to start in the DirectoryService

ldap__service__userDn

maxservice@yourldap.url

A service user for the DirectoryService to have access to it

ldap__service__password

mysecretpassphrase

The password for the service user

ldap__service__java__naming__ldap__attributes__binary

Map

A list of properties that are passed on to LDAP.

The listed attributes for the java.naming.ldap.attributes.binary key are read as binary values.

If there is more than one attribute, they must be separated by spaces, e.g.:

<map>

<entry key="java.naming.ldap.attributes.binary" value="objectGUID"/>

</map>

In the case of the environment variable, only a String must be assigned, e.g. 'objectGUID'

ldap__attributes__ldapUserFilter

String

A hardcoded filter to narrow down the search area

These are the recommended PLANTA groups to assign users to roles from the DirectoryService. Each of these groups references a role in PLANTA project:

• PLANTAProject_Administrator

• PLANTAProject_Employee

• PLANTAProject_ProjectManager

• PLANTAProject_MultiProjectManager

• PLANTAProject_DepartmentManager

• PLANTAProject_PortfolioManager

• PLANTAProject_PMAdministrator

ldap__attributes__ldapSearchScope

{SUBTREE / OBJECT / ONELEVEL}

The search scope for searches

ldap__attributes__plantaUserData

Map

A list of all LDAP attributes that are written into the DB when a user logs in or by a query_user_data.

They are listed as key - value pairs.

The key that is flagged with login is used to authenticate the user.

The key that is flagged with uuid is converted into a UUID string and serves to log the user in.

The key that is flagged with base64 is converted into a Base64-encoded string.

Since S39.1.0 it is possible to read binary attributes and encode them in Base64.

Up to S39.1.0, only text attributes are allowed, except for the objectGUID which is converted into a UUID string.

For example:

<map>

<entry key="userPrincipalName" value="login"/>

<entry key="mail" value=""/>

<entry key="sAMAccountName" value=""/>

<entry key="sn" value=""/>

<entry key="objectGUID" value="uuid"/>

</map>

In the case of the environment variable an array of strings has to be assigned, e.g. {'userPrincipalName=login','mail=','sAMAccountName=','distinguishedName=','objectGUID=uuid'}

ldap__attributes__ldapPageSize

Integer

Number of entries per page of an LDAP query. During the user import, the results are fetched page by page and merged, so that even large directories are imported without exceeding the server size limit. Default value: 500.

The actual overall size limit (MaxSizeLimit) is bypassed by paging. Since PLANTA fetches page by page and merges the results, the complete directory tree can be imported even if it contains far more than 1000 entries.

S 39.1.5

hibernate__dialect

de.planta.server.hibernate.dialect.Oracle10gDialect
de.planta.server.hibernate.dialect.SQLServerDialect

Configures Oracle or MSSQL SQL dialect

hibernate__connection__driver_class

oracle.jdbc.driver.OracleDriver
com.microsoft.sqlserver.jdbc.SQLServerDriver

Configures the JDBC driver

hibernate__connection__url

URL with SID: jdbc:oracle:thin:@$db.server:$db.oracle.port:$db.name
URL with service names: jdbc:oracle:thin:@//db_hostname:port/service_name

DB connection URL - configured via installer

hibernate__connection__username

USER_123

Username used for connecting to the DB

hibernate__connection__password

gE_he1M

Password used for connecting to the DB

hibernate__default_schema

Applies to Oracle users only. In the context of SQL Server, the term “database schema” has an entirely different meaning.
Required if the Oracle user name deviates from the schema name to be used.

hibernate__jdbc__fetch_size

32 - 8192
recommended: 512

Number of lines that will be transferred for reading

hibernate__jdbc__batch_size

8 - 64
recommended: 32

Number of lines that will be transferred for writing

hibernate__connection__provider_class

Class name (e.g. org.hibernate.connection.C3P0ConnectionProvider)

Class that provides the database connection.

hibernate__connection__pool_size

Integer

Max number of connections in the pool.

hibernate__c3p0__min_size

Integer

Minimum number of connections in the c3p0 pool. Without a value of its own, the value from maintain__system__dimension applies: “small” 9, “medium” 9, “large” 15.

hibernate__c3p0__max_size

Integer

Maximum number of connections in the c3p0 pool. Without a value of its own, the value from maintain__system__dimension applies: “small” 100, “medium” 100, “large” 250.

hibernate__c3p0__timeout

Seconds

Time after which idle connections are closed. Without a value of its own, the value from maintain__system__dimension applies: “small” 1800, “medium” 1800, “large” 3600.

hibernate__c3p0__maxIdleTimeExcessConnections

Seconds

Timeout for excess idle connections.

hibernate__c3p0__max_statements

Integer

Global number of cached prepared statements.

hibernate__c3p0__maxStatementsPerConnection

Integer

Max cached statements per connection.

hibernate__c3p0__numHelperThreads

Integer

Background threads for pool management. Without a value of its own, the value from maintain__system__dimension applies: “small” 4, “medium” 8, “large” 12.

hibernate__c3p0__checkoutTimeout

Milliseconds

Max wait time to get a connection.

hibernate__connection__autoReconnect

Boolean true, false

Enables reconnect if DB connection is lost.

hibernate__connection__autoReconnectForPools

Boolean true, false

Enables reconnect for connection pools.

hibernate__c3p0__acquireRetryAttempts

Integer

Number of retry attempts on failure.

hibernate__c3p0__acquireRetryDelay

Milliseconds

Delay between retries.

hibernate__c3p0__breakAfterAcquireFailure

Boolean true, false

Stop retrying after first failure.

hibernate__c3p0__preferredTestQuery

SQL query (e.g. SELECT 1)

Used to validate a connection.

hibernate__transaction__coordinator_class

e.g. jdbc

Defines transaction coordinator.

hibernate__current_session_context_class

e.g. thread

Specifies the session context handling.

hibernate__format_sql

Boolean true, false

Formats SQL for readability.

hibernate__connection__isolation

e.g. 2 (READ_COMMITTED)

DB transaction isolation level.

hibernate__connection__handling_mode

e.g. DELAYED_ACQUISITION_AND_RELEASE_AFTER_TRANSACTION

Controls how connections/transactions are handled.

hibernate__integration__envers__enabled

Boolean true, false

Enables Hibernate Envers for auditing.

hibernate__listeners__envers__autoRegister

Boolean true, false

Auto-registers Envers listeners.

hibernate__org__hibernate__envers__audit_table_suffix

e.g. _AUD

Suffix for audit tables.

hibernate__org__hibernate__envers__store_data_at_delete

Boolean true, false

Store deleted data in audit tables.

hibernate__javax__persistence__validation__mode

AUTO, NONE, etc.

Defines validation mode for JPA.

hibernate__synonyms

Boolean true, false

Enables DB synonyms support.

hibernate__spring__jpa__properties__hibernate__jdbc__lob__non_contextual_creation

Boolean true, false

Enables non-contextual LOB creation.

hibernate__temp__use_jdbc_metadata_defaults

Boolean true, false

Use JDBC metadata for temp tables.

hibernate__splitMaxDIsPerSwitch

Integer

Max number of data items per switch.

hibernate__contextInfo_Enable

Boolean true, false

Enables DB context info transfer. Default value false. The default value was changed from true to false in S 39.2.0 to improve performance with higher latency between server and database. An adjustment is usually not required.

Behavior changed from S 39.2.0

hibernate__use_nationalized_character_data

Boolean true, false

Uses NVARCHAR and similar types.

hibernate__connection__useUnicode

Boolean true, false

Enables Unicode in DB connection.

S 39.0.2

hibernate__connection__CharSet

e.g. UTF-8

Charset for DB connection.

S 39.0.2.

hibernate__connection__characterEncoding

e.g. UTF-8

Encoding for DB communication.

S 39.0.2

hibernate__connection__encrypt

Boolean true, false

Enables connection encryption

S 39.1.0

hibernate__connection__trustServerCertificate

Boolean true, false

Enables trusting server certificates without validation.

Should only be used for test purposes.

S 39.1.0

hibernate__connection__trustStore

Truststore file in jks format. Must contain the public keys of the trust chain up to the CA that issued the certificates in keystore.jks

S 39.1.0

hibernate__connection__trustStorePassword

Password to access truststore

S 39.1.0

hibernate__connection__autocommit

Boolean true, false

Determines whether an explicit commit is required for each transaction. PLANTA recommends leaving this value set to true.

Change this parameter only after consulting with your PLANTA consultant.

S 39.1.5

hibernate__connection__sendStringParametersAsUnicode

Boolean true, false

Controls whether strings are passed to SQL Server as nvarchar. The default value is false, so that they are passed as varchar, in accordance with the PLANTA schema, allowing queries to use their indexes. Relevant only for SQL Server. A value set in the JDBC URL has priority.

S 39.2.1

Connection testing

hibernate__c3p0__testConnectionOnCheckout

false

Tests a connection before it is used

hibernate__c3p0__testConnectionOnCheckin

false

Tests a connection after it was used

hibernate__c3p0__idleConnectionTestPeriod

300

Period after which an idle connection is tested

pulse

Pulse Hybrid

jira

Jira Hybrid

unittest

Automated tests via web

outlook

Outlook integration

teams

Teams integration

pulse

Pulse Hybrid

jira

Jira Hybrid

adaptive_card

Adaptive Card (Teams)

odata

OData interface

--session_link_retry_max

Integer

Maximum number of attempts the worker makes to connect to the manager at startup. Default value “60”. In the Helm chart, worker.sessionLink.retryMax

S 39.2.0

--session_link_retry_time

Integer (seconds)

Base interval between two connection attempts. Default value “5”. The interval increases by 10 percent per attempt and is reset to the initial value every 20 attempts. In the Helm chart, worker.sessionLink.retryTime

S 39.2.0

JAVA_INIT

String

Default:-Xms256m

defines the memory size

JAVA_MAX

String

Default:-Xmx768m

defines the maximum memory size