The documentation from version 39.5.17 of PLANTA project can be found in the new PLANTA Online Help.
TWiki> CurrentEN Web>InstallationAndUpdate>ServerAndClientConfiguration>ServerParameters

Server Parameters From S 39.5.11

Description for versions ≤ S 39510

Command Line Options

From S 39.5.12

Information
  • The command line options can be provided in the form -[option] [value]
Example
  • ./planta_server.sh -port 23456 -config ./config/sample_configuration.cfg

Possible options

Notes

  • A description of these options is given in the globals.conf documentation.
  • Providing options in the command line overrides predefined values in globals.conf.

Up to S 39.5.12

Information
  • The command line options can be provided in the form -[option] [value]
Example
  • ./planta_server.sh -port 23456 -migrate false -config ./config/sample_configuration.cfg

Possible options

Notes

  • A description of these options is given in the globals.conf documentation.
  • Providing options in the command line overrides predefined values in globals.conf.

planta_server.conf

From S 39.5.28

Parameter Possible values Description
SYS_CU_ERROR_URL string URL that is displayed in the Problems in System Customizing message and which links to the appropriate documentation site in PLANTA-Wiki
ENABLE_PY_SERVICE_FUNCTIONS {0,1}
PPMS_LICENSE string licence of PLANTA project, default is '000'
Q1CODEPAGE int codepage of system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))
Q1TYPE int type of system database
  • 2: Oracle
  • 4: MSSQL
DEFAULT_LANGUAGE string (f.ex.: de) default language for preloading
DEFAULT_CURRENCY string default currency for preloading (not used atm)
DEFAULT_COUNTRY string default country for preloading (not used atm)
PRELOAD_LANGUAGES string (f.ex.: en, fr, ru) additional languages for preloading
DTP_CUSTOMIZING_MODE {0,1} When enabled, CU metadata will always be up-to-date and no stale values be used within the session (effectively disables all caching on DTP level). For further information, see here.
ENABLE_COMPRESSION {0,1} default 1; allows compressed communication with a recent and correctly configured Client (see NachrichtenKompression for details)
COMPRESSION_LEVEL {0..9} default 6; defines the compression level with 0:no compression and 9:best compression
ENABLE_EXEC_PYTHON_SCRIPT {0,1}
  • default 1; allows deactivation of the processing of client_exec()/server_exec() API calls
  • The HeadlessClient is based upon this functionality; in case of deactivation, BatchJobs will not work anymore!
DISABLE_SCHED_FIXES string Using this parameter you can disable the fixes listed below.

NEW PERIOD_CAPACITY_CALCULATION_INCLUDING_OVERLOADS: Details of this bugfix.
DURATION_REM_COUNTDOWN: Details for this bugfix.
DEDUCE_DESIRED_DATES_FROM_RESOURCE_ASSIGNMENTS: Details for this bugfix
EFFORT_AGGREGATION_FOR_COLLECTION_TASKS: Details for this bugfix
MULTI_LEVEL_TASK_COLLECTION_RELATIONSHIP: Details for this bugfix.
WEAK_RELATIONSHIP_ERRONEOUSLY_EXITS_LOOP: Details for this bugfix.
TASK_COLLECTION_UNLOAD_DURATION1: Details for this bugfix.
TASK_NOT_PLANNED_LATE: Details for this bugfix.
REL_IGNORED_PARENT_TASK_NO_WED: Details for this bugfix.
REAL_RELATIONSHIP_INHERITANCE: Details for this bugfix.
PLAN_LATE_KEEP_ORDER_OF_CALCULATION: Details for this bugfix.
PLAN_LATE_KEEP_EARLIEST_DATES: Details for this bugfix.
FORCED_DELAY_DONT_PAINT_PREDECESSORS_RED: Details for this bugfix.
PYTHON_CUSTOMIZING_VERSION earth or venus select the customizing version of the planta python library
GC_KEEPALIVE_THRESHOLD_MEGABYTES 512 Threshold value for garbage collection
If the total memory usage of one session exceeds this value, memory will be tried to be released not only during the waiting period but also while the program is running. The default value is 512. For a performant scheduling/replanning in large systems, a value between 1024 and 8192 is recommended.

Logging is not configured anymore via planta_server.conf. See logback configuration for the logging configuration.

From S 39.5.24

Parameter Possible values Description
SYS_CU_ERROR_URL string URL that is displayed in the Problems in System Customizing message and which links to the appropriate documentation site in PLANTA-Wiki
ENABLE_PY_SERVICE_FUNCTIONS {0,1}
PPMS_LICENSE string licence of PLANTA project, default is '000'
Q1CODEPAGE int codepage of system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))
Q1TYPE int type of system database
  • 2: Oracle
  • 4: MSSQL
DEFAULT_LANGUAGE string (f.ex.: de) default language for preloading
DEFAULT_CURRENCY string default currency for preloading (not used atm)
DEFAULT_COUNTRY string default country for preloading (not used atm)
PRELOAD_LANGUAGES string (f.ex.: en, fr, ru) additional languages for preloading
DTP_CUSTOMIZING_MODE {0,1} When enabled, CU metadata will always be up-to-date and no stale values be used within the session (effectively disables all caching on DTP level). For further information, see here.
ENABLE_COMPRESSION {0,1} default 1; allows compressed communication with a recent and correctly configured Client (see NachrichtenKompression for details)
COMPRESSION_LEVEL {0..9} default 6; defines the compression level with 0:no compression and 9:best compression
ENABLE_EXEC_PYTHON_SCRIPT {0,1}
  • default 1; allows deactivation of the processing of client_exec()/server_exec() API calls
  • The HeadlessClient is based upon this functionality; in case of deactivation, BatchJobs will not work anymore!
DISABLE_SCHED_FIXES string Using this parameter you can disable the fixes listed below.

NEW DURATION_REM_COUNTDOWN: Details for this bugfix.
DEDUCE_DESIRED_DATES_FROM_RESOURCE_ASSIGNMENTS: Details for this bugfix
EFFORT_AGGREGATION_FOR_COLLECTION_TASKS: Details for this bugfix
MULTI_LEVEL_TASK_COLLECTION_RELATIONSHIP: Details for this bugfix.
WEAK_RELATIONSHIP_ERRONEOUSLY_EXITS_LOOP: Details for this bugfix.
TASK_COLLECTION_UNLOAD_DURATION1: Details for this bugfix.
TASK_NOT_PLANNED_LATE: Details for this bugfix.
REL_IGNORED_PARENT_TASK_NO_WED: Details for this bugfix.
REAL_RELATIONSHIP_INHERITANCE: Details for this bugfix.
PLAN_LATE_KEEP_ORDER_OF_CALCULATION: Details for this bugfix.
PLAN_LATE_KEEP_EARLIEST_DATES: Details for this bugfix.
FORCED_DELAY_DONT_PAINT_PREDECESSORS_RED: Details for this bugfix.
PYTHON_CUSTOMIZING_VERSION earth or venus select the customizing version of the planta python library
GC_KEEPALIVE_THRESHOLD_MEGABYTES 512 Threshold value for garbage collection
If the total memory usage of one session exceeds this value, memory will be tried to be released not only during the waiting period but also while the program is running. The default value is 512. For a performant scheduling/replanning in large systems, a value between 1024 and 8192 is recommended.

Logging is not configured anymore via planta_server.conf. See logback configuration for the logging configuration.

From S 39.5.22

Parameter Possible values Description
SYS_CU_ERROR_URL string URL that is displayed in the Problems in System Customizing message and which links to the appropriate documentation site in PLANTA-Wiki
ENABLE_PY_SERVICE_FUNCTIONS {0,1}
PPMS_LICENSE string licence of PLANTA project, default is '000'
Q1CODEPAGE int codepage of system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))
Q1TYPE int type of system database
  • 2: Oracle
  • 4: MSSQL
DEFAULT_LANGUAGE string (f.ex.: de) default language for preloading
DEFAULT_CURRENCY string default currency for preloading (not used atm)
DEFAULT_COUNTRY string default country for preloading (not used atm)
PRELOAD_LANGUAGES string (f.ex.: en, fr, ru) additional languages for preloading
DTP_CUSTOMIZING_MODE {0,1} When enabled, CU metadata will always be up-to-date and no stale values be used within the session (effectively disables all caching on DTP level). For further information, see here.
ENABLE_COMPRESSION {0,1} default 1; allows compressed communication with a recent and correctly configured Client (see NachrichtenKompression for details)
COMPRESSION_LEVEL {0..9} default 6; defines the compression level with 0:no compression and 9:best compression
ENABLE_EXEC_PYTHON_SCRIPT {0,1}
  • default 1; allows deactivation of the processing of client_exec()/server_exec() API calls
  • The HeadlessClient is based upon this functionality; in case of deactivation, BatchJobs will not work anymore!
DISABLE_SCHED_FIXES string Using this parameter you can disable the fixes listed below.

NEW DEDUCE_DESIRED_DATES_FROM_RESOURCE_ASSIGNMENTS: Details for this bugfix
NEW EFFORT_AGGREGATION_FOR_COLLECTION_TASKS: Details for this bugfix
MULTI_LEVEL_TASK_COLLECTION_RELATIONSHIP: Details for this bugfix.
WEAK_RELATIONSHIP_ERRONEOUSLY_EXITS_LOOP: Details for this bugfix.
TASK_COLLECTION_UNLOAD_DURATION1: Details for this bugfix.
TASK_NOT_PLANNED_LATE: Details for this bugfix.
REL_IGNORED_PARENT_TASK_NO_WED: Details for this bugfix.
REAL_RELATIONSHIP_INHERITANCE: Details for this bugfix.
PLAN_LATE_KEEP_ORDER_OF_CALCULATION: Details for this bugfix.
PLAN_LATE_KEEP_EARLIEST_DATES: Details for this bugfix.
FORCED_DELAY_DONT_PAINT_PREDECESSORS_RED: Details for this bugfix.
PYTHON_CUSTOMIZING_VERSION earth or venus select the customizing version of the planta python library
GC_KEEPALIVE_THRESHOLD_MEGABYTES NEW 512 Threshold value for garbage collection
If the total memory usage of one session exceeds this value, memory will be tried to be released not only during the waiting period but also while the program is running. The default value is 512. For a performant scheduling/replanning in large systems, a value between 1024 and 8192 is recommended.

Logging is not configured anymore via planta_server.conf. See logback configuration for the logging configuration.

From S 39.5.20

Parameter Possible values Description
SYS_CU_ERROR_URL string URL that is displayed in the Problems in System Customizing message and which links to the appropriate documentation site in PLANTA-Wiki
ENABLE_PY_SERVICE_FUNCTIONS {0,1}
PPMS_LICENSE string licence of PLANTA project, default is '000'
Q1CODEPAGE int codepage of system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))
Q1TYPE int type of system database
  • 2: Oracle
  • 4: MSSQL
DEFAULT_LANGUAGE string (f.ex.: de) default language for preloading
DEFAULT_CURRENCY string default currency for preloading (not used atm)
DEFAULT_COUNTRY string default country for preloading (not used atm)
PRELOAD_LANGUAGES string (f.ex.: en, fr, ru) additional languages for preloading
DTP_CUSTOMIZING_MODE {0,1} When enabled, CU metadata will always be up-to-date and no stale values be used within the session (effectively disables all caching on DTP level). For further information, see here.
ENABLE_COMPRESSION {0,1} default 1; allows compressed communication with a recent and correctly configured Client (see NachrichtenKompression for details)
COMPRESSION_LEVEL {0..9} default 6; defines the compression level with 0:no compression and 9:best compression
ENABLE_EXEC_PYTHON_SCRIPT {0,1}
  • default 1; allows deactivation of the processing of client_exec()/server_exec() API calls
  • The HeadlessClient is based upon this functionality; in case of deactivation, BatchJobs will not work anymore!
DISABLE_SCHED_FIXES string Using this parameter you can disable the fixes listed below.

MULTI_LEVEL_TASK_COLLECTION_RELATIONSHIP: Details for this bugfix.
WEAK_RELATIONSHIP_ERRONEOUSLY_EXITS_LOOP: Details for this bugfix.
TASK_COLLECTION_UNLOAD_DURATION1: Details for this bugfix.
TASK_NOT_PLANNED_LATE: Details for this bugfix.
REL_IGNORED_PARENT_TASK_NO_WED: Details for this bugfix.
REAL_RELATIONSHIP_INHERITANCE: Details for this bugfix.
PLAN_LATE_KEEP_ORDER_OF_CALCULATION: Details for this bugfix.
PLAN_LATE_KEEP_EARLIEST_DATES: Details for this bugfix.
FORCED_DELAY_DONT_PAINT_PREDECESSORS_RED: Details for this bugfix.
PYTHON_CUSTOMIZING_VERSION earth or venus select the customizing version of the planta python library
GC_KEEPALIVE_THRESHOLD_MEGABYTES NEW 512 Threshold value for garbage collection
If the total memory usage of one session exceeds this value, memory will be tried to be released not only during the waiting period but also while the program is running. The default value is 512. For a performant scheduling/replanning in large systems, a value between 1024 and 8192 is recommended.

Logging is not configured anymore via planta_server.conf. See logback configuration for the logging configuration.

From S 39.5.18

Parameter Possible values Description
SYS_CU_ERROR_URL string URL that is displayed in the Problems in System Customizing message and which links to the appropriate documentation site in PLANTA-Wiki
ENABLE_PY_SERVICE_FUNCTIONS {0,1}
PPMS_LICENSE string licence of PLANTA project, default is '000'
Q1CODEPAGE int codepage of system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))
Q1TYPE int type of system database
  • 2: Oracle
  • 4: MSSQL
DEFAULT_LANGUAGE string (f.ex.: de) default language for preloading
DEFAULT_CURRENCY string default currency for preloading (not used atm)
DEFAULT_COUNTRY string default country for preloading (not used atm)
PRELOAD_LANGUAGES string (f.ex.: en, fr, ru) additional languages for preloading
DTP_CUSTOMIZING_MODE {0,1} When enabled, CU metadata will always be up-to-date and no stale values be used within the session (effectively disables all caching on DTP level). For further information, see here.
ENABLE_COMPRESSION {0,1} default 1; allows compressed communication with a recent and correctly configured Client (see NachrichtenKompression for details)
COMPRESSION_LEVEL {0..9} default 6; defines the compression level with 0:no compression and 9:best compression
ENABLE_EXEC_PYTHON_SCRIPT {0,1}
  • default 1; allows deactivation of the processing of client_exec()/server_exec() API calls
  • The HeadlessClient is based upon this functionality; in case of deactivation, BatchJobs will not work anymore!
DISABLE_SCHED_FIXES string Using this parameter you can disable the fixes listed below.

MULTI_LEVEL_TASK_COLLECTION_RELATIONSHIP: Details for this bugfix.
WEAK_RELATIONSHIP_ERRONEOUSLY_EXITS_LOOP: Details for this bugfix.
TASK_COLLECTION_UNLOAD_DURATION1: Details for this bugfix.
TASK_NOT_PLANNED_LATE: Details for this bugfix.
REL_IGNORED_PARENT_TASK_NO_WED: Details for this bugfix.
REAL_RELATIONSHIP_INHERITANCE: Details for this bugfix.
PLAN_LATE_KEEP_ORDER_OF_CALCULATION: Details for this bugfix.
PLAN_LATE_KEEP_EARLIEST_DATES: Details for this bugfix.
FORCED_DELAY_DONT_PAINT_PREDECESSORS_RED: Details for this bugfix.
PYTHON_CUSTOMIZING_VERSION NEW earth or venus select the customizing version of the planta python library

Logging is not configured anymore via planta_server.conf. See logback configuration for the logging configuration.

From S 39.5.17

Parameter Possible values Description
SYS_CU_ERROR_URL string URL that is displayed in the Problems in System Customizing message and which links to the appropriate documentation site in PLANTA-Wiki
ENABLE_PY_SERVICE_FUNCTIONS {0,1}
PPMS_LICENSE string licence of PLANTA project, default is '000'
Q1CODEPAGE int codepage of system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))
Q1TYPE int type of system database
  • 2: Oracle
  • 4: MSSQL
DEFAULT_LANGUAGE string (f.ex.: de) default language for preloading
DEFAULT_CURRENCY string default currency for preloading (not used atm)
DEFAULT_COUNTRY string default country for preloading (not used atm)
PRELOAD_LANGUAGES string (f.ex.: en, fr, ru) additional languages for preloading
DTP_CUSTOMIZING_MODE {0,1} When enabled, CU metadata will always be up-to-date and no stale values be used within the session (effectively disables all caching on DTP level). For further information, see here.
ENABLE_COMPRESSION {0,1} default 1; allows compressed communication with a recent and correctly configured Client (see NachrichtenKompression for details)
COMPRESSION_LEVEL {0..9} default 6; defines the compression level with 0:no compression and 9:best compression
ENABLE_EXEC_PYTHON_SCRIPT {0,1}
  • default 1; allows deactivation of the processing of client_exec()/server_exec() API calls
  • The HeadlessClient is based upon this functionality; in case of deactivation, BatchJobs will not work anymore!
DISABLE_SCHED_FIXES NEW string Using this parameter you can disable the fixes listed below.

MULTI_LEVEL_TASK_COLLECTION_RELATIONSHIP: Details for this bugfix.
WEAK_RELATIONSHIP_ERRONEOUSLY_EXITS_LOOP: Details for this bugfix.
TASK_COLLECTION_UNLOAD_DURATION1: Details for this bugfix.
TASK_NOT_PLANNED_LATE: Details for this bugfix.
REL_IGNORED_PARENT_TASK_NO_WED: Details for this bugfix.
REAL_RELATIONSHIP_INHERITANCE: Details for this bugfix.
PLAN_LATE_KEEP_ORDER_OF_CALCULATION: Details for this bugfix.
PLAN_LATE_KEEP_EARLIEST_DATES: Details for this bugfix.
FORCED_DELAY_DONT_PAINT_PREDECESSORS_RED: Details for this bugfix.

Logging is not configured anymore via planta_server.conf. See logback configuration for the logging configuration.

From S 39.5.14

Parameter Possible values Description
SYS_CU_ERROR_URL string URL that is displayed in the Problems in System Customizing message and which links to the appropriate documentation site in PLANTA-Wiki
ENABLE_PY_SERVICE_FUNCTIONS {0,1}
PPMS_LICENSE string licence of PLANTA project, default is '000'
Q1CODEPAGE int codepage of system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))
Q1TYPE int type of system database
  • 2: Oracle
  • 4: MSSQL
DEFAULT_LANGUAGE string (f.ex.: de) default language for preloading
DEFAULT_CURRENCY string default currency for preloading (not used atm)
DEFAULT_COUNTRY string default country for preloading (not used atm)
PRELOAD_LANGUAGES string (f.ex.: en, fr, ru) additional languages for preloading
DTP_CUSTOMIZING_MODE {0,1} When enabled, CU metadata will always be up-to-date and no stale values be used within the session (effectively disables all caching on DTP level). For further information, see here.
ENABLE_COMPRESSION {0,1} default 1; allows compressed communication with a recent and correctly configured Client (see NachrichtenKompression for details)
COMPRESSION_LEVEL {0..9} default 6; defines the compression level with 0:no compression and 9:best compression
ENABLE_EXEC_PYTHON_SCRIPT NEW {0,1}
  • default 1; allows deactivation of the processing of client_exec()/server_exec() API calls
  • new" /> the HeadlessClient is based upon this functionality; in case of deactivation, BatchJobs will not work anymore!
Logging is not configured anymore via planta_server.conf. See logback configuration for the logging configuration.

From S 39.5.11

Parameter Possible values Description
SYS_CU_ERROR_URL string URL that is displayed in the Problems in System Customizing message and which links to the appropriate documentation site in PLANTA-Wiki
ENABLE_PY_SERVICE_FUNCTIONS {0,1}
PPMS_LICENSE string licence of PLANTA project, default is '000'
Q1CODEPAGE int codepage of system database ( 1 (Windows) to use Windows-1252, 2 (Linux) to use ISO885915 (Latin 9))
Q1TYPE int type of system database
  • 2: Oracle
  • 4: MSSQL
DEFAULT_LANGUAGE string (f.ex.: de) default language for preloading
DEFAULT_CURRENCY string default currency for preloading (not used atm)
DEFAULT_COUNTRY string default country for preloading (not used atm)
PRELOAD_LANGUAGES string (f.ex.: en, fr, ru) additional languages for preloading
DTP_CUSTOMIZING_MODE {0,1} When enabled, CU metadata will always be up-to-date and no stale values be used within the session (effectively disables all caching on DTP level). For further information, see here.
ENABLE_COMPRESSION {0,1} default 1; allows compressed communication with a recent and correctly configured Client (see NachrichtenKompression for details)
COMPRESSION_LEVEL {0..9} default 6; defines the compression level with 0:no compression and 9:best compression
Logging is not configured anymore via planta_server.conf. See logback configuration for the logging configuration.

globals.conf

From S 39.5.22

Some parameters haven been moved to the configuration file web.conf.

Parameter Possible values Description
auth.methods described here described here
config path to PLANTA server configuration file  
hibernate path to hibernate configuration file  
web NEW path to webservice configuration file  
krb.conf path to kerberos configuration file  
auth.conf path to authentication configuration file  
     
host host name or IP address, v4 or v6 interface the server is listening on for client connections
port Int Port the server is listening on for client connections
debug Boolean loads a debug version of the python library when set to true - development option
silent Boolean de-/activates some output to standard output and standard error - development option
     
     
timeout Int currently without effect
performance_counting Boolean false by default; true enables performance counting globally
parallel_sessions Int How many sessions (connections to server, aka open clients) are allowed at the same time before server denies any new connection attempts.
persistent_db_session Boolean de-/activates persistent database sessions, false by default
     
mem_limit.max_size Int native memory size maximum (in MiB)
mem_limit.session Int minimal free size (in MiB) for session start
mem_limit.calculation Int minimal free size (in MiB) for calculation of a project
mem_limit.module Int minimal free size (in MiB) for loading module data
mem_limit.recalculation Int minimal free size (in MiB) for start of recalculation
     
monitoring Boolean activation of monitoring interface, default false
monitoring_port Int port number the web server listens at; required parameter (monitoring is implicitely deactivated when no port is configured)
monitoring_interface host name/ip address interface the web server is bound to; localhost by default
     
services Boolean activation of AlteWebServicesBisDB10 , false by default
services_port Int port number the web server listens at; required parameter (PMT.AlteWebServicesBisDB10 are implicitely deactivated when no port is configured)
services_interface host name/ip address interface the web server is bound to; localhost by default
services_doc Boolean activation of WebService documentation, false by default
services_doc_port Int port number the web server listens at; required parameter (WebService documentation is implicitely deactivated when no port is configured)
services_doc_interface host name/ip address interface the web server is bound to; localhost by default
services_doc_hostname host name/ip address own hostname by default; overrides the hostname to access the services on a remote host (e.g. when using a reverse proxy setup

From S 39.5.20

Parameter Possible values Description
auth.methods described here described here
config path to PLANTA server configuration file  
hibernate path to hibernate configuration file  
krb.conf path to kerberos configuration file  
auth.conf path to authentication configuration file  
     
host host name or IP address, v4 or v6 interface the server is listening on for client connections
port Int Port the server is listening on for client connections
debug Boolean loads a debug version of the python library when set to true - development option
silent Boolean de-/activates some output to standard output and standard error - development option
     
     
timeout Int currently without effect
performance_counting Boolean false by default; true enables performance counting globally
parallel_sessions Int How many sessions (connections to server, aka open clients) are allowed at the same time before server denies any new connection attempts.
persistent_db_session Boolean de-/activates persistent database sessions, false by default
     
mem_limit.max_size Int native memory size maximum (in MiB)
mem_limit.session Int minimal free size (in MiB) for session start
mem_limit.calculation Int minimal free size (in MiB) for calculation of a project
mem_limit.module Int minimal free size (in MiB) for loading module data
mem_limit.recalculation Int minimal free size (in MiB) for start of recalculation
     
monitoring Boolean activation of monitoring interface, default false
monitoring_port Int port number the web server listens at; required parameter (monitoring is implicitely deactivated when no port is configured)
monitoring_interface host name/ip address interface the web server is bound to; localhost by default
     
services NEW Boolean activation of AlteWebServicesBisDB10 , false by default
services_port NEW Int port number the web server listens at; required parameter (PMT.AlteWebServicesBisDB10 are implicitely deactivated when no port is configured)
services_interface NEW host name/ip address interface the web server is bound to; localhost by default
services_doc NEW Boolean activation of WebService documentation, false by default
services_doc_port NEW Int port number the web server listens at; required parameter (WebService documentation is implicitely deactivated when no port is configured)
services_doc_interface NEW host name/ip address interface the web server is bound to; localhost by default
services_doc_hostname NEW host name/ip address own hostname by default; overrides the hostname to access the services on a remote host (e.g. when using a reverse proxy setup

From S 39.5.16

Parameter Possible values Description
auth.methods described here described here
config path to PLANTA server configuration file  
hibernate path to hibernate configuration file  
krb.conf path to kerberos configuration file  
auth.conf path to authentication configuration file  
     
host NEW host name or IP address, v4 or v6 interface the server is listening on for client connections
port Int Port the server is listening on for client connections
debug Boolean loads a debug version of the python library when set to true - development option
silent Boolean de-/activates some output to standard output and standard error - development option
     
     
timeout Int currently without effect
performance_counting Boolean false by default; true enables performance counting globally
parallel_sessions Int How many sessions (connections to server, aka open clients) are allowed at the same time before server denies any new connection attempts.
persistent_db_session NEW Boolean de-/activates persistent database sessions, false by default
     
mem_limit.max_size Int native memory size maximum (in MiB)
mem_limit.session Int minimal free size (in MiB) for session start
mem_limit.calculation Int minimal free size (in MiB) for calculation of a project
mem_limit.module Int minimal free size (in MiB) for loading module data
mem_limit.recalculation Int minimal free size (in MiB) for start of recalculation
     
monitoring Boolean activation of monitoring interface, default false
monitoring_port Int port number the web server listens at; required parameter (monitoring is implicitely deactivated when no port is configured)
monitoring_interface host name/ip address interface the web server is bound to; localhost by default

From S 39.5.13

Parameter Possible values Description
auth.methods described here described here
config path to PLANTA server configuration file  
hibernate path to hibernate configuration file  
krb.conf path to kerberos configuration file  
auth.conf path to authentication configuration file  
     
host NEW host name or IP address, v4 or v6 interface the server is listening on for client connections
port Int Port the server is listening on for client connections
debug Boolean loads a debug version of the python library when set to true - development option
silent Boolean de-/activates some output to standard output and standard error - development option
     
     
timeout Int currently without effect
performance_counting Boolean false by default; true enables performance counting globally
parallel_sessions Int How many sessions (connections to server, aka open clients) are allowed at the same time before server denies any new connection attempts.
     
mem_limit.max_size Int native memory size maximum (in MiB)
mem_limit.session Int minimal free size (in MiB) for session start
mem_limit.calculation Int minimal free size (in MiB) for calculation of a project
mem_limit.module Int minimal free size (in MiB) for loading module data
mem_limit.recalculation Int minimal free size (in MiB) for start of recalculation
     
monitoring Boolean activation of monitoring interface, default false
monitoring_port Int port number the web server listens at; required parameter (monitoring is implicitely deactivated when no port is configured)
monitoring_interface host name/ip address interface the web server is bound to; localhost by default

From S 39.5.12

Parameter Possible values Description
auth.methods described here described here
config path to PLANTA server configuration file  
hibernate path to hibernate configuration file  
krb.conf path to kerberos configuration file  
auth.conf path to authentication configuration file  
     
port Int Port the server is listening on for client connections
debug Boolean loads a debug version of the python library when set to true - development option
silent Boolean de-/activates some output to standard output and standard error - development option
     
migrate Boolean makes the server run in migration mode (see migration procedure): all obligatory migration packages are then installed
     
timeout Int currently without effect
performance_counting Boolean false by default; true enables performance counting globally
parallel_sessions Int How many sessions (connections to server, aka open clients) are allowed at the same time before server denies any new connection attempts.
     
mem_limit.max_size Int native memory size maximum (in MiB)
mem_limit.session Int minimal free size (in MiB) for session start
mem_limit.calculation Int minimal free size (in MiB) for calculation of a project
mem_limit.module Int minimal free size (in MiB) for loading module data
mem_limit.recalculation Int minimal free size (in MiB) for start of recalculation
     
monitoring Boolean activation of monitoring interface, default false
monitoring_port Int port number the web server listens at; required parameter (monitoring is implicitely deactivated when no port is configured)
monitoring_interface host name/ip address interface the web server is bound to; localhost by default

From S 39.5.11

Parameter Possible values Description
auth.methods described here described here
config path to PLANTA server configuration file  
hibernate path to hibernate configuration file  
krb.conf path to kerberos configuration file  
auth.conf path to authentication configuration file  
     
port Int Port the server is listening on for client connections
debug Boolean loads a debug version of the python library when set to true - development option
silent Boolean de-/activates some output to standard output and standard error - development option
migrate Boolean makes the server run in migration mode (see migration procedure): all obligatory migration packages are then installed
     
timeout Int currently without effect
performance_counting Boolean false by default; true enables performance counting globally
parallel_sessions NEW Int How many sessions (connections to server, aka open clients) are allowed at the same time before server denies any new connection attempts.
     
mem_limit.max_size NEW Int native memory size maximum (in MiB)
mem_limit.session NEW Int minimal free size (in MiB) for session start
mem_limit.calculation NEW Int minimal free size (in MiB) for calculation of a project
mem_limit.module NEW Int minimal free size (in MiB) for loading module data
mem_limit.recalculation NEW Int minimal free size (in MiB) for start of recalculation
     
monitoring Boolean activation of monitoring interface, default false
monitoring_port Int port number the web server listens at; required parameter (monitoring is implicitely deactivated when no port is configured)
monitoring_interface host name/ip address interface the web server is bound to; localhost by default

From DB 39.5.10

web.conf

Parameter Possible values Description
monitoring Boolean activation of monitoring interface, default false
monitoring_port Int port number the web server listens at; required parameter (monitoring is implicitely deactivated when no port is configured)
monitoring_interface host name/ip address interface the web server is bound to; localhost by default
     
services Boolean Deprecated, generic_service used instead.
services_port Int Deprecated, generic_service_port used instead.
services_interface host name/ip address Deprecated, generic_service_interface used instead.
     
services_doc Boolean activation of web services documentation, false by default
services_doc_port Int port number the web server listens at; required parameter (web services documentation is implicitly deactivated when no port is configured)
     
generic_service Boolean activation of web service documentation, false by default
generic_service_interface host name/ip address interface the web server is bound to; localhost by default
generic_service_port Int port number of the PLANTA link web services listens at; required parameter (web services are implicitely deactivated when no port is configured)
     
ssl_swagger_enable Boolean Deprecated
ssl_generic_enable Boolean enable SSL for PLANTA link web services, false by default
ssl_services_docs_enable Boolean enable SSL for web services documentation, false by default
ssl_keystore_password Int password for the JavaKeystore
ssl_keystore path path to the Java Keystore
     
cross_origin_filter_all Boolean Cross Site Scripting Filter which needs to be enabled, true by default
apikey_auth_filter_swagger Boolean Deprecated
apikey_auth_filter_generic Boolean ApiKey authentication for PLANTA pulse web services, true by default
saml_auth_filter_all Boolean SAML authentication for all web services, true by default

New from S 39.5.22

web.conf

Parameter Possible values Description
monitoring Boolean activation of monitoring interface, default false
monitoring_port Int port number the web server listens at; required parameter (monitoring is implicitely deactivated when no port is configured)
monitoring_interface host name/ip address interface the web server is bound to; localhost by default
     
services Boolean activation of web services, false by default
services_port Int port number the web server listens at; required parameter (web services are implicitely deactivated when no port is configured)
services_interface host name/ip address interface the web server is bound to; localhost by default
     
services_doc Boolean activation of web services documentation, false by default
services_doc_port Int port number the web server listens at; required parameter (web services documentation is implicitly deactivated when no port is configured)
     
generic_service Boolean activation of WebService documentation, false by default
generic_service_interface host name/ip address interface the web server is bound to; localhost by default
generic_service_port Int port number of the PLANTA link web services listens at; required parameter (web services are implicitely deactivated when no port is configured)
     
ssl_swagger_enable Boolean enable SSL for Pulse web services, false by default
ssl_generic_enable Boolean enable SSL for PLANTALinkModule web services, false by default
ssl_services_docs_enable Boolean enable SSL for web services documentation, false by default
ssl_keystore_password Int password for the JavaKeystore
ssl_keystore path path to the Java Keystore
     
cross_origin_filter_all Boolean Cross Site Scripting Filter which needs to be enabled, true by default
apikey_auth_filter_swagger Boolean ApiKey authentication for Pulse web services, true by default
apikey_auth_filter_generic Boolean ApiKey authentication for Pulse web services, true by default
saml_auth_filter_all Boolean SAML authentication for all web services, true by default

New from S 39.5.25

planta_scheduler.conf

Parameter Possible values Description
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 Not in use yet
scheduler_port 0 Not in use yet

logback.xml

Information
  • General documentation can be found here.
  • Important namespaces for logging are described in the following table:
Namespace Default level Description
org.hibernate WARN log messages hibernate emits - database interaction/mapping problems are logged here
org.hibernate.SQL INFO SQL related messages
com.mchange WARN Connection pool related log messages - database connection problems are logged here
org.eclipse.jetty WARN web server related messages (internal monitoring interface)
PLANTA namespace Default level Description
de.planta.server INFO PLANTA Server messages
de.planta.server.hibernate INFO PLANTA Server messages - hibernate interface related
de.planta.server.hibernate.startup WARN PLANTA Server messages - startup/data dictionary related
Special Namespaces Default level Description
de.planta.server.native INFO log messages from the native code
de.planta.server.python INFO log messages from python code
Note
  • For detailed logback configuration documentation, please have a look at the logback manual.

hibernate.cfg.xml

This file is configured using XML syntax.

From S 39.5.19

Name Example value or
Possible values 		Description
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 mit SID: jdbc:oracle:thin:@$db.server:$db.oracle.port:$db.name
URL mit Service-Namen: jdbc:oracle:thin:@//db_hostname:port/service_name 		DB connection URL - configured via installer
hibernate.connection.username USER_123 the 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, with sql server the term database schema has a different meaning entirely.
Required if the oracle user name deviates from the schema name to be used.
hibernate.jdbc.fetch_size NEW 32 - 8192
recommended: 512 		Number of lines that will be transfered for reading
hibernate.jdbc.batch_size NEW 8 - 64
recommended: 32 		Number of lines that will be transfered for writing

From S 39.5.13

Name Example value or
Possible values 		Description
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 mit SID: jdbc:oracle:thin:@$db.server:$db.oracle.port:$db.name
URL mit Service-Namen: jdbc:oracle:thin:@//db_hostname:port/service_name 		DB connection URL - configured via installer
hibernate.connection.username USER_123 the username used for connecting to the DB
hibernate.connection.password gE_he1M password used for connecting to the DB
hibernate.default_schema NEW   Applies to oracle users only, with sql server the term database schema has a different meaning entirely.
Required if the oracle user name deviates from the schema name to be used.

Up to S 39.5.13

Name Example value or
Possible values 		Description
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 mit SID: jdbc:oracle:thin:@$db.server:$db.oracle.port:$db.name
URL mit Service-Namen: jdbc:oracle:thin:@//db_hostname:port/service_name 		DB connection URL - configured via installer
hibernate.connection.username USER_123 the username used for connecting to the DB
hibernate.connection.password gE_he1M password used for connecting to the DB

Connection testing: Values Description
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

Notes

  • All other parameters are not described here.
  • The connection testing options should be employed with care because of their performance impact.
  • In most cases, no manual changes should be needed, as the Installer sets all values based on queried informations.
  • For configuration of the connection pooling, see the c3p0 documentation.

auth.conf, krb.conf, key.tab

For description, see KerberosAuthentication.

startup.hbm.xml

Needed for building the data dictionary via hibernate. Should not be changed.

         PLANTA project







 
  • Suche in Topic-Namen

  • Suche in Topic-Inhalten
This site is powered by the TWiki collaboration platform Powered by Perl