Server-Parameter
Die folgenden Parameter können zur Konfiguration des manager-Containers verwendet werden.
Die nachfolgenden Inhalte sind nur in englischer Sprache verfügbar.
Server
Parameters (with | Possible values | Description | Available from |
|---|---|---|---|
| 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 | |
| {0,1} |
| |
| string | Licence of PLANTA project, default is '000' | |
| int | Code page of the system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9)) | |
| int | Type of system database
| |
| string (f.ex.: de) | Default language for preloading | |
| string | Default currency for preloading (not used atm) | |
| string | Default country for preloading (not used atm) | |
| string (f.ex.: en, fr, ru) | Additional languages for preloading | |
| {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. | |
| {0,1} | default 1; allows compressed communication with a recent and correctly configured client (see NachrichtenKompression for details) | |
| {0..9} | default 6; defines the compression level with 0:no compression and 9:best compression | |
| {0,1} |
| |
| string | Using these parameters you can disable the fixes listed below. | |
| earth or venus | Select the customizing version of the planta python library | |
| 512 | Threshold value for garbage collection. | |
| string | If the application crashes and a core dump is generated, it will be saved here. From S 39.5.37: If a | |
| {0,1} | Enables (1) or disables (0) the remote Python debug interface. | |
| string (e.g. | Hostname or IP address of the debugger client to which the server connects. | |
| int (e.g. | Port number used to establish the connection with the Python debugger. | |
| {0,1} | If set to 1, the worker process will terminate immediately upon encountering a critical, unhandled exception. | |
| 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 be set to a different value. | |
| {0,1} | Enables (1) or disables (0) the generation of core dumps in case of a crash. | |
| string (path or shell command) | Command used to run a tool that processes or generates the core dump. | |
| {0,1} | Enables (1) heap dump creation in case of critical memory-related issues. | |
| {0,1} | Enables (1) automatic attachment of a just-in-time debugger when an error occurs. | |
| string (shell command) | Command to start the JIT debugger (e.g., | |
| int (e.g. | Maximum number of parameters allowed in a single SQL statement (e.g. for IN clauses). | |
| int (e.g. | Maximum number of SQL statements a single query may be split into. | |
| int (e.g. | If the number of keys exceeds this threshold, the query will be split or processed differently. | |
| int (e.g. | Optimization will only be applied if at least this many SQL statements are involved. | |
| int (e.g. | Maximum number of data fields (DFs) that can be sent in a single client-server message. | |
| {0,1} | If enabled (1), passwords will be compared using hashes only, increasing security. |
Globals
Parameters (with | Possible values | Description | Available from |
|---|---|---|---|
| The internal parsing and replacement of literals can be switched off globally with this parameter | ||
| interactive kerberos any |
| |
ldap openidconnect pki |
| ||
proxy osuser legacy secure
|
| Up to S 39.5.31 | |
| string (path) | Path to the main | |
| String (path) | Path to the PLANTA server configuration file (local path under Planta-server-directory); | |
| String (path) | Path to the Hibernate configuration file (local path under Planta-server-directory); | |
| String (path) | Path to the Webservice configuration file (local path under Planta-server-directory); | |
| String (path) | Path to the Kerberos configuration file (local path under Planta-server-directory); | |
| String (path) | Path to the Authentification configuration file (local path under Planta-server-directory); | |
| String (path) | Path to the Secure configuration file (local path under Planta-server-directory); | |
| String (path) | Path to the license configuration file (local path under Planta-server-directory); | |
| String (path) | Defines the file to be used as logback configuration. Can, for example, be one of the following files:
| |
| string (path) | Path to the scheduler configuration file. Should not be changed by user. | |
| host name or IP address, v4 or v6 | Interface the server is listening on for client connections | |
| Int | Port the server is listening on for client connections | |
| Boolean | Loads a debug version of the python library when set to true - development option | |
| Boolean | Deactivates/activates some output to standard output and standard error - development option | |
| Int | Currently without effect | |
| Boolean |
| |
| Int | Number of sessions (connections to server, aka open clients) allowed at the same time before server denies any new connection attempts. | |
| Boolean | If set to true, Java classes that are defined by Customizing tables will be recompiled at every Server start (recommended) | |
| Int | Native memory size maximum (in MiB) | |
| Int | Minimum free size (in MiB) for session start | |
| Int | Minimum free size (in MiB) for calculation of a project | |
| Int | Minimum free size (in MiB) for loading module data | |
| int (MiB) | Memory threshold (in MiB) for native memory allocation control. | |
| Int | Minimum free size (in MiB) for start of recalculation | |
| Boolean | A different way of handling the deletion of related tables | |
| String | Internal names for Server |
|
| Int (milliseconds) | If no protobuffer-message is received after this interval, the client will be closed (assumed to be stuck) |
|
| Int | If this number of protobuffer-messages fails to arrive, the client will be closed (protobuffer-error assumed) |
|
| String (path) | Directory in which the server writes files | |
| String (path) | Directory in which the server writes log files. If a | |
| 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 | |
| host name/ip address | Enables the ProtoInterface connection between Worker and Manager. | |
| {0,1} | Enables (1) the use of an external auto-numbering service for IDs. | |
| string (URL) | URL to the external auto-numbering service used when enabled. | |
| {0,1} | If 1, a persistent database session is maintained across client requests. | |
| {0,1} | Internal flag to skip schema validation checks (use with caution). | |
| {0,1} | If 1, the Manager will not automatically start a Worker on startup. | |
| {0,1} | Internal flag to disable the Event Manager subsystem. | |
| int (e.g. 0–5) | Sets the debugging level for ProtoInterface (0 = off, higher = more verbose). | |
| {0,1} | If 1, Jython modules will no longer be compiled to bytecode. | |
| {0,1} | Enables debug output for Jython processing. | |
| {0,1} | If 1, allows execution of HTTP requests considered unsafe (use with caution). | |
| {0,1} | Enables debug messages for Python execution. | |
| string (path) | Path to the directory where Python bytecode cache is stored. |
Webservice
Parameters (with | Possible values | Description | Available from |
|---|---|---|---|
| Boolean | activation of prometheus interface, default false | |
| string (e.g. | Combined Prometheus connection string in the form of IP:Port. | |
| Int | port number the web server listens on; required parameter (prometheus is implicitely deactivated when no port is configured) | |
| host name/ip address | interface the web server is bound to; | |
| string (e.g. | URL path for the Prometheus metrics endpoint. | |
| Boolean | activation of monitoring interface, default false | |
| Int | port number the web server listens on; required parameter (monitoring is implicitely deactivated when no port is configured) | |
| host name/ip address | interface the web server is bound to; | |
| Boolean | Enables the legacy web services module (deprecated; use | |
| Int | Port number used for the legacy web services (deprecated). | |
| string (IP or hostname) | Interface binding for legacy services (deprecated). | |
| Boolean | activation of web services documentation, false by default | |
| Int | port number the web server listens on; required parameter (web services documentation is implicitly deactivated when no port is configured) | |
| string (hostname) | Hostname under which the service documentation will be accessible. | |
| Boolean | activation of web service documentation, false by default | |
| Int | port number of the PLANTA link web services listens on; required parameter (web services are implicitely deactivated when no port is configured) | |
| host name/ip address | interface the web server is bound to; | |
| Boolean | Deprecated | |
| Boolean | enable SSL for PLANTA link web services, false by default | |
| Boolean | enable SSL for web services documentation, false by default | |
| String | password for the JavaKeystore | |
| Path | path to the Java Keystore | |
| Boolean | Cross Site Scripting Filter which needs to be enabled, true by default | |
| Boolean | Deprecated | |
| Boolean | ApiKey authentication for PLANTA pulse web services, true by default Needs to be set to | |
| Boolean | SAML authentication for all web services, true by default | |
| Boolean | Enables the Health Endpoint | |
| string (e.g. | Configures the connection for the Health Endpoint in the form of IP:Port. | |
| Int | Port on which the server status interface is listening. | |
| String (IP or hostname) | Interface to which the server status interface binds. | |
| String | Configures the entrypoint for the Health Endpoint | |
| string (header definition) | Standard security headers to include in all responses. | |
| String | Additional custom headers added to all responses (non-SSL). | |
| String | Standard headers for SSL-enabled connections. | |
| String | Additional SSL-specific headers to include in responses. |
Scheduler
Parameters (with | Possible values | Description | Available from |
|---|---|---|---|
| {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 | |
| localhost | Hostname used by the Java part of the scheduler to establish connections. | |
| integer (valid TCP port number) | Port number used by the Java part of the scheduler to establish connections. | |
| {0,1} | If enabled, float (slack) is ignored when determining the Longest Critical Path. By default (per CPM definition), float is considered. | |
| {0,1} | Determines whether all Longest Critical Paths are calculated or only the single longest one. | |
| {0,1} | Enables or disables the bucketing method for structured Longest Path calculation. | |
| {0,1} | Determines whether the Longest Path is calculated across all projects or only within the selected project. |
Secure
Parameters (with | Possible values | Description | Available from | |
|---|---|---|---|---|
| {planta_plain, planta_ssl} | Connect with or without TLS encryption | ||
| {true / false} | If defaults are not enforced, a client can specify a protocol, host, and port via the route attribute. | ||
| TLSv1.2 | Protocol for Planta backend SSL connection. | ||
| config/keystore.jks | Keystore file in jks format. Must contain the client certificates for the servlet. Used for ssl backend connection. | ||
| Password to access keystore | |||
| 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 | ||
| Password to access truststore | |||
| {false / true} | Default settings for the SSL/TLS enabled connector | ||
| {http / https} | If set to https, an SSL connection is used. | ||
| String | Makes entrypoint for planta secure configurable. This setting must match that of the ClientAdapter (secure_server_endpoint parameter). Default: \PlantaServerAdapter\ | ||
| String : Integer | Combines interface and port, separated by a ':', e.g. your_interface:your_port | ||
| {true / false} | To allow login using either LDAP or OIDC, this has to be set to true. | ||
| plain | The format of the user header. At the moment the header is transmitted plain. | ||
| {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. | ||
| 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. | ||
| Integer | Defines how long a polling request may wait. Longer intervals reduce overhead, shorter intervals reduce the time until connection failure will be noticed. | ||
| Integer | A potential reverse proxy requires a read timeout >= max_wait in order to avoid 504 gateway timeout errors on the client adapter side. | ||
| Integer | |||
| Integer | Should be the same value for both keepalive and the client | ||
| Integer | Defines how long a session remains alive in the absence of web requests. | ||
| {true / false} | Enables ldap service to synchronize user of a directory service | ||
| {true / false} | Enables ssl usage of the ldap service | ||
| path to LDAP configuration file | |||
| String | This parameter is only required if additional claims are to be read from OIDC. | ||
| URl | This parameter is only required if additional claims are to be read from OIDC. | ||
| URl | This parameter is only required if additional claims are to be read from OIDC. | ||
|
| Enables the authentication method via jwt token | S 39.0.0 | |
| String | Defines the attribute that will be adopted as a user. Possible attributes: | S 39.0.0 | |
|
| Indicates whether the secure module is enabled, based on license. | ||
|
| Allowed stream protocols for secure communication with the backend. | ||
| IP / hostname | Default host for secure backend connection. | ||
| Integer | Default port for secure backend connection. | ||
|
| Enables SSL usage for secure backend connection. | ||
| String | Host part extracted from | ||
| Integer | Port part extracted from | ||
| Integer | Minimum interval between two requests. | ||
| Integer | Maximum number of parallel requests per session. | ||
|
| Validates transmitted XML against schema (XSD). | ||
|
| Enables LDAP as authentication method. | ||
|
| Enables OIDC as authentication method. | ||
|
| Enables SSL for LDAP authentication method. | ||
|
| Converts UUID object endianness to match LDAP requirements. | S 39.0.0 |
Ldap
Parameters (with | Possible values | Description | Available from |
|---|---|---|---|
|
| Enables LDAP integration on the server side. | |
| Url for DirectoryService, preceded by the protocol and ending with the port | ||
| ou=user,DC=ldap,DC=url | The base to start in the DirectoryService | |
| A service user for the DirectoryService to have access to it | ||
| mysecretpassphrase | The password for the service user | |
| Map | A list of properties that are passed on to LDAP. The listed attributes for the If there is more than one attribute, they must be separated by spaces, e.g.:
In the case of the environment variable, only a String must be assigned, e.g. ' | |
| 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:
| |
| {SUBTREE / OBJECT / ONELEVEL} | The search scope for searches | |
| 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 The key that is flagged with The key that is flagged with Since S39.1.0 it is possible to read binary attributes and encode them base64. Up to S39.1.0, only text attributes are allowed, except for the For example:
In the case of the environment variable a Array of Strings has to be assigned, e.g. |
Hibernate
Parameters (with | Possible values | Description | Available from |
|---|---|---|---|
| de.planta.server.hibernate.dialect.Oracle10gDialect | Configures Oracle or MSSQL sql dialect | |
| oracle.jdbc.driver.OracleDriver | Configures the JDBC driver | |
| URL with SID: jdbc:oracle:thin:@$db.server:$db.oracle.port:$db.name | DB connection URL - configured via installer | |
| USER_123 | Username used for connecting to the DB | |
| gE_he1M | Password used for connecting to the DB | |
| Applies to oracle users only, in the context of sql server, the term database schema has an entirely different meaning. | ||
| 32 - 8192 | Number of lines that will be transfered for reading | |
| 8 - 64 | Number of lines that will be transfered for writing | |
| Class name (e.g. | Class that provides the database connection. | |
| Integer | Max number of connections in the pool. | |
| Integer | Minimum number of connections in the c3p0 pool. | |
| Integer | Maximum number of connections in the c3p0 pool. | |
| Seconds | Time after which idle connections are closed. | |
| Seconds | Timeout for excess idle connections. | |
| Integer | Global number of cached prepared statements. | |
| Integer | Max cached statements per connection. | |
| Integer | Background threads for pool management. | |
| Milliseconds | Max wait time to get a connection. | |
|
| Enables reconnect if DB connection is lost. | |
|
| Enables reconnect for connection pools. | |
| Integer | Number of retry attempts on failure. | |
| Milliseconds | Delay between retries. | |
|
| Stop retrying after first failure. | |
| SQL query (e.g. | Used to validate a connection. | |
| e.g. | Defines transaction coordinator. | |
| e.g. | Specifies the session context handling. | |
|
| Formats SQL for readability. | |
| e.g. | DB transaction isolation level. | |
| e.g. | Controls how connections/transactions are handled. | |
|
| Enables Hibernate Envers for auditing. | |
|
| Auto-registers Envers listeners. | |
| e.g. | Suffix for audit tables. | |
|
| Store deleted data in audit tables. | |
|
| Defines validation mode for JPA. | |
|
| Enables DB synonyms support. | |
|
| Enables non-contextual LOB creation. | |
|
| Use JDBC metadata for temp tables. | |
| Integer | Max number of data items per switch. | |
|
| Enables DB context info transfer. | |
|
| Uses NVARCHAR and similar types. | |
|
| Enables Unicode in DB connection. | 39.0.2 |
| e.g. | Charset for DB connection. | 39.0.2. |
| e.g. | Encoding for DB communication. | 39.0.2 |
hibernate__connection__encrypt |
| Enables Connection Encryption | 39.1.0 |
hibernate__connection__trustServerCertificate |
| Enables to Trust Server Certificates without validation Should only be used for testpurposes | 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 | 39.1.0 | |
hibernate__connection__trustStorePassword | Password to access truststore | 39.1.0 | |
Connection testing | Values | Description | |
| false | Tests a connection before it is used | |
| false | Tests a connection after it was used | |
| 300 | Period after which an idle connection is tested |
Java VM
The following parameters do not belong to the PLANTA namespace and are not executed by the server, but by the Java VM.
Parameter | Possible values | Description | Available from |
|---|---|---|---|
| String Default:-Xms256m | defines the memory size | |
| String Default:-Xmx768m | defines the maximum memory size |