InformationNote
- From version 39.5.0, PLANTA updates the individual client, server and database (Customizing) software components independent of one another. This means: Other than in previous versions, the individual components of an installation do not necessarily have to be of the same version and can be updated individually, independent of one another.
- However, dependencies may exist between the individual versions of different components. They are specified explicitly in the Release Notes.
install_planta_with_template.bat
script (on Windows systems) or install_planta_with_template.sh
script (on Linux systems).
planta-windows.properties
file (for Windows systems) or planta-linux.properties
file (for Linux systems) which requires the installation parameters is required.
templates
directory, there are also various properties files for different, typical installation types (e.g. reinstallation including creation of a new database user, reinstallation on an existing database user, migration from an existing Venus-on-Earth system to Venus, installation of a new hotfix in an existing Venus system, etc.). The suitable properties file can now be copied to the main directory of the installer (i.e. overwriting the existing file), depending on the desired installation type.
db.install
, server.install
, monitoring.install
, regtests.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
Parameter | Name in properties files | Used for component | Possible values | Meaning |
---|---|---|---|---|
Installationsart | planta.install_type |
Client, Server, Database | "new", "update" | Specifies whether a reinstallation is to be carried out or an existing system is to be updated.
|
Update type | planta.update_type |
Client, server, database | "r94" (update of 39.4.4.0), "r95" (update of 39.5.X with DB 39.4), "venus" (update of an existing 39.5.X system with DB 39.5), "voeToVenus" (migration of 39.5 with DB 39.4 to 39.5 with DB 39.5) | In the case of an update, it specifies of which type the system to be updated is, i.e. whether it is a 39.4.4.0 or a 39.5.X system (with DB 39.4 or DB 39.5).
|
DB log path | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
Start server after installation? | server.start_server |
Client, server, database | "yes", "no" | Specifies whether the server is to be restarted automatically after successful installation.
|
How to install a database? | db.install_type |
Database | "existing" (use of existing database user), "new" (creation of a new database user) | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
Database type | db.type |
Database, server | "Oracle", "MSSQL" | Database type |
License | License |
Server, monitoring, database | e.g. "200" | Your license number allocated by PLANTA. |
Database server | db.server |
Server, monitoring, database | e.g. "srvPLANTA", "192.168.10.20" | Name or IP address of the server on which the database runs. |
Database port | db.port |
Server, monitoring, database | e.g. "1521" (Oracle), "1433" (MSSQL) | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default.
|
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name.
|
|
Oracle Tablespace | db.tablespace |
Database | Specifies to which oracle table space a new database user is to be assigned.
|
|
MSSQL server uses named instance | db.use_named_instance |
Server, monitoring, database | "yes", "no" | Specifies for MSSQL databases whether to connect to a named instance or to the default instance.
|
Database instance | db.instance |
Server, monitoring, database | Name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed.
|
|
Database password | db.password |
Server, monitoring, database | Password of the user. | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user.
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Manual connect string | db.manual_connection_string |
Database, Server | A connect string to a particular database, e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433 | Provides the option to specifiy the connect string to a particular database manually. This influences the way the installer accesses the database itself (e.g. when creating a new database user) and the way the server or hibernate accesses it (in the
|
Manual connect string for administrator | db.manual_connection_priv_string |
Database | Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)) requires a special login string.
|
Run migration? | db.migrate |
Database | "auto", "yes" and "no" | Specifies whether during the installation a database specific migration to the new database version is to be carried out.
|
Adjust/create database schema? | db.create_schema |
Database | "yes", "no" | Specifies for database reinstallations whether the new schema is to be installed with the PLANTA tables and whether (for updates) some newly loaded PLANTA files are adjusted (e.g. the license).
|
Load data? | db.load_data |
Database | "yes", "no" | Specifies for database installations whether the data is to be imported to the database by PLANTA. In reinstallation this affects all tables, for update installations (DB) it only concerns the default customizing data; for 'no', only the Python status (customizing) is updated and a migration is possibly carried out
|
Activate DB synonyms? | db.synonyms |
Server | "yes", "no" | Specifies whether hibernate database synonyms are to be used or not.
|
Server IP address | SERVER_IP |
Server, client | e.g. "192.168.10.20" | IP address of the PLANTA server.
|
Port | PORT |
Server, client | e.g. "12345" | Port number via which the server communicates with the clients. This number should be a five-digit number smaller than 30000, which is not used by any other process. |
Name of the PLANTA server | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed.
|
|
Existing server directory | server.path.existing |
Server | Directory in which the former PLANTA project server is located.
|
|
Adjust database schema to server hotfix? | server.update_schema |
Server | "yes", "no" | Specifies whether the schema of the server is adjusted in order to secure the server start.
|
Run migration? | server.migrate |
Server | "auto", "yes" and "no" | Specifies whether a database specific migration to the new server version is to be carried out during the installation.
|
Name of the user group | server.user.group |
Server, monitoring | e.g. "User" | Group to which the installation belongs
|
Service user | service.user.name |
Server, Database, Monitoring | Linux user to which the Linux installation belongs and which starts the PLANTA Server service.
|
|
Expected utilization | system.dimension |
Server | "small", "medium", "large" | How large will the utilization of this system be?
|
Activate web services for PLANTA pulse? BETA | planta. services.enable |
Server | "yes", "no" | Specifies whether the web services for PLANTA pulse are to be activated. |
IP address of the web services for PLANTA pulse BETA | planta.services.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services for PLANTA pulse are to run. |
Port of the web services for PLANTA pulse BETA | planta.services.port |
Server | e.g. "23456" | Port on which the web services for PLANTA pulse are to run. |
Activate web services for PLANTA link? BETA | planta.services.generic.enable |
Server | "yes", "no" | Specifies whether the web services for PLANTA link are to be activated. |
IP address of the web services for PLANTA link BETA | planta.services.generic.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services for PLANTA link are to run. |
Port of the web services for PLANTA link BETA | planta.services.generic.port |
Server | e.g. "23456" | Port on which the web services for PLANTA link are to run. |
Activate web service documentation? BETA | planta.services.doc.activate |
Server | "yes", "no" | Specifies whether the web service documentation is to be activated.
|
Host for web service documentation BETA | planta.services.doc.host |
Server | Host on which the web service documentation is to run. | |
IP address for web service documentation BETA | planta.services.doc.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.31" | IP address of the computer on which the web service documentation is to run. |
Port for web service documentation BETA | planta.services.doc.port |
Server | e.g. "23457" | Port on which the web service documentation is to run. |
Host name for the generated cURL statements of the web service documentation BETA |
services_doc_hostname |
Server | e.g. "srvWebPLANTA" | curl statements of the documentation interface are generated in line with the Server URL entered here. |
Activate SSL? BETA | planta.services.ssl.enable |
Server | "yes", "no" | If this option is selected, the web services only run on encrypted connections (https) |
Keystore path for SSL BETA | planta.services.ssl.keystore.path |
Server | e.g.:web-inf/resources/ssl | Path to the Java keystore (JKS) which requires the key pairs or certificates for SSL |
Password for SSL BETA | planta.services.ssl.password |
Server | e.g. "123456" | Password for the Java keystore |
Create core dumps? | debug.coredumps |
Server | "1" (create coredump), "0" (do not create coredump) | Specifies whether a coredump file with the current system status is created upon a crash.
|
Path to the coredumps | debug.coredump_path |
Server | Specifies whether a possible coredump is to be created (see Coredumps erstellen? parameter).
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created on the desktop |
Startup shortcut | client.create_menu_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created in the startup menu |
Monitoring activated | planta.monitoring.enable |
Server | "true", "false" | Specifies whether the monitoring component is to be activated for the server.
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | e.g. "12345" | Port number via which the server communicates with the monitoring component. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring Interface IP | planta.monitoring.interface |
Server | e.g. "localhost", "192.168.10.20" | Specifies the IP-address of the monitoring component.
|
Port of the web interface | monitoring.port |
Monitoring | e.g. "12345" | Port number of the monitoring component web service. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed.
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
server.install
: Specifies whether server specific steps are to be carried out. These are e.g. db.install
: Specifies whether database specific steps are to be carried out. These are e.g. db.install
parameter must be set = yes.
monitoring.install
: Specifies whether the monitoring component is to be installed to check the PLANTA Server.regtests.install
: Specifies whether the regression tests are to be installed, with the help of which the functionality of the PLANTA Server can be checked upon completed installation.client.install
: Specifies whether a PLANTA client is to be installed. planta-windows.properties
or planta-linux.properties
(only for the automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
db.manual_connection_string |
Connection string to a particular database | Provides the option to manually specify the connection string to a particular database. This influences both the way the installer itself accesses the database (e.g. when creating the new database user), and the way the server or hibernate accesses it (in the
|
db.manual_connection_priv_string |
Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)), requires a special login string.
|
planta.alternative_sql_directory |
An absolute path | Allows the use of an alternative directory for the SQL scripts which the PLANTA installer runs during server installation to secure the launchability of the server.
|
alternative_migration_directory |
An absolute path | Enables the use of an alternative directory for migration packets and the corresponding SQL files.
|
planta.migration_scripts_to_ignore |
A list of migration packets separated by blank spaces | It specifies a list of migration packets which are not to be run in the migration.
|
temp.path |
A relative or absolute path | The installer copies some auxilliary files to a temporary directory (and adjusts them in line with the settings). It is /tmp/install_planta under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type |
release or asan or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing and asan versions can be used for debugging since at runtime some additional tests are carried out, which, however, slightly slow down the runtime. |
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
See also: Installation and Update, Release Notes, System Requirements |
Notes
- The update from Venus on Earth to Venus CANNOT be carried out with the S 39.5.25 update packet.
- When updating from Venus on Earth to Venus, the first step must necessarily be initiated from the DB 39.5.10 update packet.
- When updating from Venus to Venus , it is irrelevant whether the two steps are initiated from the DB 39.5.10 or S 39.5.25 update packet. However, the order must be adhered to.
install_planta_with_template.bat
script (on Windows systems) or install_planta_with_template.sh
script (on Linux systems).
planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on available parameters, please click here.
db.install
, server.install
, monitoring.install
, regtests.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
Parameter | Name in properties files | Used for component | Possible values | Meaning |
---|---|---|---|---|
Installationsart | planta.install_type |
Client, Server, Database | "new", "update" | Specifies whether a reinstallation is to be carried out or an existing system is to be updated.
|
Update type | planta.update_type |
Client, server, database | "r94" (update of 39.4.4.0), "r95" (update of 39.5.X with DB 39.4), "venus" (update of an existing 39.5.X system with DB 39.5), "voeToVenus" (migration of 39.5 with DB 39.4 to 39.5 with DB 39.5) | In the case of an update, it specifies of which type the system to be updated is, i.e. whether it is a 39.4.4.0 or a 39.5.X system (with DB 39.4 or DB 39.5).
|
DB log path | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
Start server after installation? | server.start_server |
Client, server, database | "yes", "no" | Specifies whether the server is to be restarted automatically after successful installation.
|
How to install a database? | db.install_type |
Database | "existing" (use of existing database user), "new" (creation of a new database user) | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
Database type | db.type |
Database, server | "Oracle", "MSSQL" | Database type |
License | License |
Server, monitoring, database | e.g. "200" | Your license number allocated by PLANTA. |
Database server | db.server |
Server, monitoring, database | e.g. "srvPLANTA", "192.168.10.20" | Name or IP address of the server on which the database runs. |
Database port | db.port |
Server, monitoring, database | e.g. "1521" (Oracle), "1433" (MSSQL) | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default.
|
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name.
|
|
Oracle Tablespace | db.tablespace |
Database | Specifies to which oracle table space a new database user is to be assigned.
|
|
MSSQL server uses named instance | db.use_named_instance |
Server, monitoring, database | "yes", "no" | Specifies for MSSQL databases whether to connect to a named instance or to the default instance.
|
Database instance | db.instance |
Server, monitoring, database | Name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed.
|
|
Database password | db.password |
Server, monitoring, database | Password of the user. | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user.
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Manual connect string | db.manual_connection_string |
Database, Server | A connect string to a particular database, e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433 | Provides the option to specifiy the connect string to a particular database manually. This influences the way the installer accesses the database itself (e.g. when creating a new database user) and the way the server or hibernate accesses it (in the
|
Manual connect string for administrator | db.manual_connection_priv_string |
Database | Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)) requires a special login string.
|
Run migration? | db.migrate |
Database | "auto", "yes" and "no" | Specifies whether during the installation a database specific migration to the new database version is to be carried out.
|
Adjust/create database schema? | db.create_schema |
Database | "yes", "no" | Specifies for database reinstallations whether the new schema is to be installed with the PLANTA tables and whether (for updates) some newly loaded PLANTA files are adjusted (e.g. the license).
|
Load data? | db.load_data |
Database | "yes", "no" | Specifies for database installations whether the data is to be imported to the database by PLANTA. In reinstallation this affects all tables, for update installations (DB) it only concerns the default customizing data; for 'no', only the Python status (customizing) is updated and a migration is possibly carried out
|
Activate DB synonyms? | db.synonyms |
Server | "yes", "no" | Specifies whether hibernate database synonyms are to be used or not.
|
Server IP address | SERVER_IP |
Server, client | e.g. "192.168.10.20" | IP address of the PLANTA server.
|
Port | PORT |
Server, client | e.g. "12345" | Port number via which the server communicates with the clients. This number should be a five-digit number smaller than 30000, which is not used by any other process. |
Name of the PLANTA server | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed.
|
|
Existing server directory | server.path.existing |
Server | Directory in which the former PLANTA project server is located.
|
|
Adjust database schema to server hotfix? | server.update_schema |
Server | "yes", "no" | Specifies whether the schema of the server is adjusted in order to secure the server start.
|
Run migration? | server.migrate |
Server | "auto", "yes" and "no" | Specifies whether a database specific migration to the new server version is to be carried out during the installation.
|
Name of the user group | server.user.group |
Server, monitoring | e.g. "User" | Group to which the installation belongs
|
Service user | service.user.name |
Server, Database, Monitoring | Linux user to which the Linux installation belongs and which starts the PLANTA Server service.
|
|
Expected utilization | system.dimension |
Server | "small", "medium", "large" | How large will the utilization of this system be? (small = test system, medium = normal use, large = many users on the system simultaneously). By definition, parameters relevant for sizing are set in the configuration files of the PLANTA server. After installation/update, you must check whether this setting complies with the probable usage of the PLANTA system. This includes, a.o., the following parameters:
|
Activate web services for PLANTA pulse? BETA | planta. services.enable |
Server | "yes", "no" | Specifies whether the web services for PLANTA pulse are to be activated. |
IP address of the web services for PLANTA pulse BETA | planta.services.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services for PLANTA pulse are to run. |
Port of the web services for PLANTA pulse BETA | planta.services.port |
Server | e.g. "23456" | Port on which the web services for PLANTA pulse are to run. |
Activate web services for PLANTA link? BETA | planta.services.generic.enable |
Server | "yes", "no" | Specifies whether the web services for PLANTA link are to be activated. |
IP address of the web services for PLANTA link BETA | planta.services.generic.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services for PLANTA link are to run. |
Port of the web services for PLANTA link BETA | planta.services.generic.port |
Server | e.g. "23456" | Port on which the web services for PLANTA link are to run. |
Activate web service documentation? BETA | planta.services.doc.activate |
Server | "yes", "no" | Specifies whether the web service documentation is to be activated.
|
Host for web service documentation BETA | planta.services.doc.host |
Server | Host on which the web service documentation is to run. | |
IP address for web service documentation BETA | planta.services.doc.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.31" | IP address of the computer on which the web service documentation is to run. |
Port for web service documentation BETA | planta.services.doc.port |
Server | e.g. "23457" | Port on which the web service documentation is to run. |
Host name for the generated cURL statements of the web service documentation BETA |
services_doc_hostname |
Server | e.g. "srvWebPLANTA" | curl statements of the documentation interface are generated in line with the Server URL entered here. |
Activate SSL? BETA | planta.services.ssl.enable |
Server | "yes", "no" | If this option is selected, the web services only run on encrypted connections (https) |
Keystore path for SSL BETA | planta.services.ssl.keystore.path |
Server | e.g.:web-inf/resources/ssl | Path to the Java keystore (JKS) which requires the key pairs or certificates for SSL |
Password for SSL BETA | planta.services.ssl.password |
Server | e.g. "123456" | Password for the Java keystore |
Create core dumps? | debug.coredumps |
Server | "1" (create coredump), "0" (do not create coredump) | Specifies whether a coredump file with the current system status is created upon a crash.
|
Path to the coredumps | debug.coredump_path |
Server | Specifies whether a possible coredump is to be created (see Coredumps erstellen? parameter).
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created on the desktop |
Startup shortcut | client.create_menu_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created in the startup menu |
Monitoring activated | planta.monitoring.enable |
Server | "true", "false" | Specifies whether the monitoring component is to be activated for the server.
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | e.g. "12345" | Port number via which the server communicates with the monitoring component. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring Interface IP | planta.monitoring.interface |
Server | e.g. "localhost", "192.168.10.20" | Specifies the IP-address of the monitoring component.
|
Port of the web interface | monitoring.port |
Monitoring | e.g. "12345" | Port number of the monitoring component web service. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed.
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
server.install
: Specifies whether server specific steps are to be carried out. These are e.g. db.install
: Specifies whether database specific steps are to be carried out. These are e.g. db.install
parameter must be set = yes.
monitoring.install
: Specifies whether the monitoring component is to be installed to check the PLANTA Server.regtests.install
: Specifies whether the regression tests are to be installed, with the help of which the functionality of the PLANTA Server can be checked upon completed installation.client.install
: Specifies whether a PLANTA client is to be installed. planta-windows.properties
or planta-linux.properties
(only for the automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
db.manual_connection_string |
Connection string to a particular database | Provides the option to manually specify the connection string to a particular database. This influences both the way the installer itself accesses the database (e.g. when creating the new database user), and the way the server or hibernate accesses it (in the
|
db.manual_connection_priv_string |
Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)), requires a special login string.
|
planta.alternative_sql_directory |
An absolute path | Allows the use of an alternative directory for the SQL scripts which the PLANTA installer runs during server installation to secure the launchability of the server.
|
planta.alternative_migration_directory |
An absolute path | Enables the use of an alternative directory for migration packets and the corresponding SQL files.
|
planta.migration_scripts_to_ignore |
A list of migration packets separated by blank spaces | It specifies a list of migration packets which are not to be run in the migration.
|
temp.path |
A relative or absolute path | The installer copies some auxilliary files to a temporary directory (and adjusts them in line with the settings). It is /tmp/install_planta under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type |
release or asan or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing and asan versions can be used for debugging since at runtime some additional tests are carried out, which, however, slightly slow down the runtime. |
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
See also: Installation and Update, Release Notes, System Requirements |
install_planta_with_template.bat
script (on Windows systems) or install_planta_with_template.sh
script (on Linux systems).
planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on available parameters, please click here.
db.install
, server.install
, monitoring.install
, regtests.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
Parameter | Name in properties files | Used for component | Possible values | Meaning |
---|---|---|---|---|
Installationsart | planta.install_type |
Client, Server, Database | "new", "update" | Specifies whether a reinstallation is to be carried out or an existing system is to be updated.
|
Update type | planta.update_type |
Client, server, database | "r94" (update of 39.4.4.0), "r95" (update of 39.5.X with DB 39.4), "venus" (update of an existing 39.5.X system with DB 39.5), "voeToVenus" (migration of 39.5 with DB 39.4 to 39.5 with DB 39.5) | In the case of an update, it specifies of which type the system to be updated is, i.e. whether it is a 39.4.4.0 or a 39.5.X system (with DB 39.4 or DB 39.5).
|
DB log path | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
Start server after installation? | server.start_server |
Client, server, database | "yes", "no" | Specifies whether the server is to be restarted automatically after successful installation.
|
How to install a database? | db.install_type |
Database | "existing" (use of existing database user), "new" (creation of a new database user) | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
Database type | db.type |
Database, server | "Oracle", "MSSQL" | Database type |
License | License |
Server, monitoring, database | e.g. "200" | Your license number allocated by PLANTA. |
Database server | db.server |
Server, monitoring, database | e.g. "srvPLANTA", "192.168.10.20" | Name or IP address of the server on which the database runs. |
Database port | db.port |
Server, monitoring, database | e.g. "1521" (Oracle), "1433" (MSSQL) | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default.
|
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name.
|
|
Oracle Tablespace | db.tablespace |
Database | Specifies to which oracle table space a new database user is to be assigned.
|
|
MSSQL server uses named instance | db.use_named_instance |
Server, monitoring, database | "yes", "no" | Specifies for MSSQL databases whether to connect to a named instance or to the default instance.
|
Database instance | db.instance |
Server, monitoring, database | Name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed.
|
|
Database password | db.password |
Server, monitoring, database | Password of the user. | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user.
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Manual connect string | db.manual_connection_string |
Database, Server | A connect string to a particular database, e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433 | Provides the option to specifiy the connect string to a particular database manually. This influences the way the installer accesses the database itself (e.g. when creating a new database user) and the way the server or hibernate accesses it (in the
|
Manual connect string for administrator | db.manual_connection_priv_string |
Database | Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)) requires a special login string.
|
Run migration? | db.migrate |
Database | "auto", "yes" and "no" | Specifies whether during the installation a database specific migration to the new database version is to be carried out.
|
Adjust/create database schema? | db.create_schema |
Database | "yes", "no" | Specifies for database reinstallations whether the new schema is to be installed with the PLANTA tables and whether (for updates) some newly loaded PLANTA files are adjusted (e.g. the license).
|
Load data? | db.load_data |
Database | "yes", "no" | Specifies for database installations whether the data is to be imported to the database by PLANTA. In reinstallation this affects all tables, for update installations (DB) it only concerns the default customizing data; for 'no', only the Python status (customizing) is updated and a migration is possibly carried out
|
Activate DB synonyms? NEW | db.synonyms |
Server | "yes", "no" | Specifies whether hibernate database synonyms are to be used or not.
|
Server IP address | SERVER_IP |
Server, client | e.g. "192.168.10.20" | IP address of the PLANTA server.
|
Port | PORT |
Server, client | e.g. "12345" | Port number via which the server communicates with the clients. This number should be a five-digit number smaller than 30000, which is not used by any other process. |
Name of the PLANTA server | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed.
|
|
Existing server directory | server.path.existing |
Server | Directory in which the former PLANTA project server is located.
|
|
Adjust database schema to server hotfix? | server.update_schema |
Server | "yes", "no" | Specifies whether the schema of the server is adjusted in order to secure the server start.
|
Run migration? | server.migrate |
Server | "auto", "yes" and "no" | Specifies whether a database specific migration to the new server version is to be carried out during the installation.
|
Name of the user group | server.user.group |
Server, monitoring | e.g. "User" | Group to which the installation belongs
|
Service user | service.user.name |
Server, Database, Monitoring | Linux user to which the Linux installation belongs and which starts the PLANTA Server service.
|
|
Expected utilization | system.dimension |
Server | "small", "medium", "large" | How large will the utilization of this system be? (small = test system, medium = normal use, large = many users on the system simultaneously). By definition, parameters relevant for sizing are set in the configuration files of the PLANTA server. After installation/update, you must check whether this setting complies with the probable usage of the PLANTA system. This includes, a.o., the following parameters:
|
Activate web services for PLANTA pulse? BETA | planta. services.enable |
Server | "yes", "no" | Specifies whether the web services for PLANTA pulse are to be activated. |
IP address of the web services for PLANTA pulse BETA | planta.services.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services for PLANTA pulse are to run. |
Port of the web services for PLANTA pulse BETA | planta.services.port |
Server | e.g. "23456" | Port on which the web services for PLANTA pulse are to run. |
Activate web services for PLANTA link? BETA | planta.services.generic.enable |
Server | "yes", "no" | Specifies whether the web services for PLANTA link are to be activated. |
IP address of the web services for PLANTA link BETA | planta.services.generic.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services for PLANTA link are to run. |
Port of the web services for PLANTA link BETA | planta.services.generic.port |
Server | e.g. "23456" | Port on which the web services for PLANTA link are to run. |
Activate web service documentation? BETA | planta.services.doc.activate |
Server | "yes", "no" | Specifies whether the web service documentation is to be activated.
|
Host for web service documentation BETA | planta.services.doc.host |
Server | Host on which the web service documentation is to run. | |
IP address for web service documentation BETA | planta.services.doc.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.31" | IP address of the computer on which the web service documentation is to run. |
Port for web service documentation BETA | planta.services.doc.port |
Server | e.g. "23457" | Port on which the web service documentation is to run. |
Host name for the generated cURL statements of the web service documentation BETA |
services_doc_hostname |
Server | e.g. "srvWebPLANTA" | curl statements of the documentation interface are generated in line with the Server URL entered here. |
Activate SSL? BETA | planta.services.ssl.enable |
Server | "yes", "no" | If this option is selected, the web services only run on encrypted connections (https) |
Keystore path for SSL BETA | planta.services.ssl.keystore.path |
Server | e.g.:web-inf/resources/ssl | Path to the Java keystore (JKS) which requires the key pairs or certificates for SSL |
Password for SSL BETA | planta.services.ssl.password |
Server | e.g. "123456" | Password for the Java keystore |
Create core dumps? | debug.coredumps |
Server | "1" (create coredump), "0" (do not create coredump) | Specifies whether a coredump file with the current system status is created upon a crash.
|
Path to the coredumps | debug.coredump_path |
Server | Specifies whether a possible coredump is to be created (see Coredumps erstellen? parameter).
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created on the desktop |
Startup shortcut | client.create_menu_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created in the startup menu |
Monitoring activated | planta.monitoring.enable |
Server | "true", "false" | Specifies whether the monitoring component is to be activated for the server.
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | e.g. "12345" | Port number via which the server communicates with the monitoring component. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring Interface IP | planta.monitoring.interface |
Server | e.g. "localhost", "192.168.10.20" | Specifies the IP-address of the monitoring component.
|
Port of the web interface | monitoring.port |
Monitoring | e.g. "12345" | Port number of the monitoring component web service. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed.
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
server.install
: Specifies whether server specific steps are to be carried out. These are e.g. db.install
: Specifies whether database specific steps are to be carried out. These are e.g. db.install
parameter must be set = yes.
monitoring.install
: Specifies whether the monitoring component is to be installed to check the PLANTA Server.regtests.install
: Specifies whether the regression tests are to be installed, with the help of which the functionality of the PLANTA Server can be checked upon completed installation.client.install
: Specifies whether a PLANTA client is to be installed. planta-windows.properties
or planta-linux.properties
(only for the automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
db.manual_connection_string |
Connection string to a particular database | Provides the option to manually specify the connection string to a particular database. This influences both the way the installer itself accesses the database (e.g. when creating the new database user), and the way the server or hibernate accesses it (in the
|
db.manual_connection_priv_string |
Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)), requires a special login string.
|
planta.alternative_sql_directory |
An absolute path | Allows the use of an alternative directory for the SQL scripts which the PLANTA installer runs during server installation to secure the launchability of the server.
|
planta.alternative_migration_directory |
An absolute path | Enables the use of an alternative directory for migration packets and the corresponding SQL files.
|
planta.migration_scripts_to_ignore |
A list of migration packets separated by blank spaces | It specifies a list of migration packets which are not to be run in the migration.
|
temp.path |
A relative or absolute path | The installer copies some auxilliary files to a temporary directory (and adjusts them in line with the settings). It is /tmp/install_planta under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type |
release or asan or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing and asan versions can be used for debugging since at runtime some additional tests are carried out, which, however, slightly slow down the runtime. |
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
See also: Installation and Update, Release Notes, System Requirements |
install_planta_with_template.bat
script (on Windows systems) or install_planta_with_template.sh
script (on Linux systems).
planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on available parameters, please click here.
db.install
, server.install
, monitoring.install
, regtests.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
Parameter | Name in properties files | Used for component | Possible values | Meaning |
---|---|---|---|---|
Installationsart | planta.install_type |
Client, Server, Database | "new", "update" | Specifies whether a reinstallation is to be carried out or an existing system is to be updated.
|
Update type | planta.update_type |
Client, server, database | "r94" (update of 39.4.4.0), "r95" (update of 39.5.X with DB 39.4), "venus" (update of an existing 39.5.X system with DB 39.5), "voeToVenus" (migration of 39.5 with DB 39.4 to 39.5 with DB 39.5) | In the case of an update, it specifies of which type the system to be updated is, i.e. whether it is a 39.4.4.0 or a 39.5.X system (with DB 39.4 or DB 39.5).
|
DB log path | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
Start server after installation? | server.start_server |
Client, server, database | "yes", "no" | Specifies whether the server is to be restarted automatically after successful installation.
|
How to install a database? | db.install_type |
Database | "existing" (use of existing database user), "new" (creation of a new database user) | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
Database type | db.type |
Database, server | "Oracle", "MSSQL" | Database type |
License | License |
Server, monitoring, database | e.g. "200" | Your license number allocated by PLANTA. |
Database server | db.server |
Server, monitoring, database | e.g. "srvPLANTA", "192.168.10.20" | Name or IP address of the server on which the database runs. |
Database port | db.port |
Server, monitoring, database | e.g. "1521" (Oracle), "1433" (MSSQL) | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default.
|
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name.
|
|
Oracle Tablespace | db.tablespace |
Database | Specifies to which oracle table space a new database user is to be assigned.
|
|
MSSQL server uses named instance | db.use_named_instance |
Server, monitoring, database | "yes", "no" | Specifies for MSSQL databases whether to connect to a named instance or to the default instance.
|
Database instance | db.instance |
Server, monitoring, database | Name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed.
|
|
Database password | db.password |
Server, monitoring, database | Password of the user. | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user.
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Manual connect string | db.manual_connection_string |
Database, Server | A connect string to a particular database, e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433 | Provides the option to specifiy the connect string to a particular database manually. This influences the way the installer accesses the database itself (e.g. when creating a new database user) and the way the server or hibernate accesses it (in the
|
Manual connect string for administrator | db.manual_connection_priv_string |
Database | Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)) requires a special login string.
|
Run migration? | db.migrate |
Database | "auto", "yes" and "no" | Specifies whether a database specific migration to the new database version is to be carried out during the installation. The decision whether a migration is to be carried out or not is usually defined by the combination of the installationtype and updatetype parameters and preset accordingly. The run migration? parameter should therefore generally not be changed. |
Adjust/create database schema? | db.create_schema |
Database | "yes", "no" | Specifies for database reinstallations whether the new schema is to be installed with the PLANTA tables and whether (for updates) some newly loaded PLANTA files are adjusted (e.g. the license).
|
Load data? | db.load_data |
Database | "yes", "no" | Specifies for database installations whether the data is to be imported to the database by PLANTA. In reinstallation this affects all tables, for update installations (DB) it only concerns the default customizing data; for 'no', only the Python status (customizing) is updated and a migration is possibly carried out
|
Server IP address | SERVER_IP |
Server, client | e.g. "192.168.10.20" | IP address of the PLANTA server.
|
Port | PORT |
Server, client | e.g. "12345" | Port number via which the server communicates with the clients. This number should be a five-digit number smaller than 30000, which is not used by any other process. |
Name of the PLANTA server | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed.
|
|
Existing server directory | server.path.existing |
Server | Directory in which the former PLANTA project server is located.
|
|
Adjust database schema to server hotfix? | server.update_schema |
Server | "yes", "no" | Specifies whether the schema of the server is adjusted in order to secure the server start.
|
Run migration? | server.migrate |
Server | "auto", "yes" and "no" | Specifies whether a database specific migration to the new server version is to be carried out during the installation. The decision whether a migration is to be carried out or not is usually defined by the combination of the installationtype and updatetype parameters and preset accordingly. The Carry out migration? parameter should therefore not be changed. |
Name of the user group | server.user.group |
Server, monitoring | e.g. "User" | Group to which the installation belongs
|
Service user | service.user.name |
Server, Database, Monitoring | Linux user to which the Linux installation belongs and which starts the PLANTA Server service.
|
|
Expected utilization | system.dimension |
Server | "small", "medium", "large" | How large will the utilization of this system be? (small = test system, medium = normal use, large = many users on the system simultaneously). By definition, parameters relevant for sizing are set in the configuration files of the PLANTA server. After installation/update, you must check whether this setting complies with the probable usage of the PLANTA system. This includes, a.o., the following parameters:
|
Activate web services for PLANTA pulse? BETA | planta. services.enable |
Server | "yes", "no" | Specifies whether the web services for PLANTA pulse are to be activated. |
IP address of the web services for PLANTA pulse BETA | planta.services.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services for PLANTA pulse are to run. |
Port of the web services for PLANTA pulse BETA | planta.services.port |
Server | e.g. "23456" | Port on which the web services for PLANTA pulse are to run. |
Activate web services for PLANTA link? NEW BETA | planta.services.generic.enable |
Server | "yes", "no" | Specifies whether the web services for PLANTA link are to be activated. |
IP address of the web services for PLANTA link NEW BETA | planta.services.generic.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services for PLANTA link are to run. |
Port of the web services for PLANTA link NEW BETA | planta.services.generic.port |
Server | e.g. "23456" | Port on which the web services for PLANTA link are to run. |
Activate web service documentation? BETA | planta.services.doc.activate |
Server | "yes", "no" | Specifies whether the web service documentation is to be activated.
|
Host for web service documentation NEW BETA | planta.services.doc.host |
Server | Host on which the web service documentation is to run. | |
IP address for web service documentation BETA | planta.services.doc.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.31" | IP address of the computer on which the web service documentation is to run. |
Port for web service documentation BETA | planta.services.doc.port |
Server | e.g. "23457" | Port on which the web service documentation is to run. |
Host name for the generated cURL statements of the web service documentation NEW BETA |
services_doc_hostname |
Server | e.g. "srvWebPLANTA" | curl statements of the documentation interface are generated in line with the Server URL entered here. |
Activate SSL? NEW BETA | planta.services.ssl.enable |
Server | "yes", "no" | If this option is selected, the web services only run on encrypted connections (https) |
Keystore path for SSL NEW BETA | planta.services.ssl.keystore.path |
Server | e.g.:web-inf/resources/ssl | Path to the Java keystore (JKS) which requires the key pairs or certificates for SSL |
Password for SSL NEW BETA | planta.services.ssl.password |
Server | e.g. "123456" | Password for the Java keystore |
Create core dumps? | debug.coredumps |
Server | "1" (create coredump), "0" (do not create coredump) | Specifies whether a coredump file with the current system status is created upon a crash.
|
Path to the coredumps | debug.coredump_path |
Server | Specifies whether a possible coredump is to be created (see Coredumps erstellen? parameter).
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created on the desktop |
Startup shortcut | client.create_menu_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created in the startup menu |
Monitoring activated | planta.monitoring.enable |
Server | "true", "false" | Specifies whether the monitoring component is to be activated for the server.
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | e.g. "12345" | Port number via which the server communicates with the monitoring component. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring Interface IP | planta.monitoring.interface |
Server | e.g. "localhost", "192.168.10.20" | Specifies the IP-address of the monitoring component.
|
Port of the web interface | monitoring.port |
Monitoring | e.g. "12345" | Port number of the monitoring component web service. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed.
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
server.install
: Specifies whether server specific steps are to be carried out. These are e.g. db.install
: Specifies whether database specific steps are to be carried out. These are e.g. db.install
parameter must be set = yes.
monitoring.install
: Specifies whether the monitoring component is to be installed to check the PLANTA Server.regtests.install
: Specifies whether the regression tests are to be installed, with the help of which the functionality of the PLANTA Server can be checked upon completed installation.client.install
: Specifies whether a PLANTA client is to be installed. planta-windows.properties
or planta-linux.properties
(only for the automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
db.manual_connection_string |
Connection string to a particular database | Provides the option to manually specify the connection string to a particular database. This influences both the way the installer itself accesses the database (e.g. when creating the new database user), and the way the server or hibernate accesses it (in the
|
db.manual_connection_priv_string |
Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)), requires a special login string.
|
planta.alternative_sql_directory NEW |
An absolute path | Allows the use of an alternative directory for the SQL scripts which the PLANTA installer runs during server installation to secure the launchability of the server.
|
planta.alternative_migration_directory |
An absolute path | Enables the use of an alternative directory for migration packets and the corresponding SQL files.
|
planta.migration_scripts_to_ignore |
A list of migration packets separated by blank spaces | It specifies a list of migration packets which are not to be run in the migration.
|
temp.path |
A relative or absolute path | The installer copies some auxilliary files to a temporary directory (and adjusts them in line with the settings). It is /tmp/install_planta under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type |
release or asan or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing and asan versions can be used for debugging since at runtime some additional tests are carried out, which, however, slightly slow down the runtime. |
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
See also: Installation and Update, Release Notes, System Requirements |
install_planta_with_template.bat
script (on Windows systems) or install_planta_with_template.sh
script (on Linux systems).
planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on available parameters, please click here.
db.install
, server.install
, monitoring.install
, regtests.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
Parameter | Name in properties files | Used for component | Possible values | Meaning |
---|---|---|---|---|
Installation type | planta.install_type |
Client, server, database | "new", "update" | Specifies whether you should reinstall or upgrade an existing system
|
Update type | planta.update_type |
Client, server, database | "r94" (update of 39.4.4.0), "r95" (update of 39.5.X with DB 39.4), "venus" (update of an existing 39.5.X system with DB 39.5), "voeToVenus" (migration of 39.5 with DB 39.4 to 39.5 with DB 39.5) | In the case of an update, it specifies of which type the system to be updated is, i.e. whether it is a 39.4.4.0 or a 39.5.X system (with DB 39.4 or DB 39.5).
|
DB log path | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
Start server after installation? | server.start_server |
Client, server, database | "yes", "no" | Specifies whether the server is to be restarted automatically after successful installation.
|
How to install a database? | db.install_type |
Database | "existing" (use of existing database user), "new" (creation of a new database user) | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
Database type | db.type |
Database, server | "Oracle", "MSSQL" | Database type |
License | License |
Server, monitoring, database | e.g. "200" | Your license number allocated by PLANTA. |
Database server | db.server |
Server, monitoring, database | e.g. "srvPLANTA", "192.168.10.20" | Name or IP address of the server on which the database runs. |
Database port | db.port |
Server, monitoring, database | e.g. "1521" (Oracle), "1433" (MSSQL) | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default.
|
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name.
|
|
Oracle Tablespace | db.tablespace |
Database | Specifies to which oracle table space a new database user is to be assigned.
|
|
MSSQL server uses named instance | db.use_named_instance |
Server, monitoring, database | "yes", "no" | Specifies for MSSQL databases whether to connect to a named instance or to the default instance.
|
Database instance | db.instance |
Server, monitoring, database | Name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed.
|
|
Database password | db.password |
Server, monitoring, database | Password of the user. | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user.
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Manual connect string | db.manual_connection_string |
Database, Server | A connect string to a particular database, e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433 | Provides the option to specifiy the connect string to a particular database manually. This influences the way the installer accesses the database itself (e.g. when creating a new database user) and the way the server or hibernate accesses it (in the
|
Manual connect string for administrator | db.manual_connection_priv_string |
Database | Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)) requires a special login string.
|
Run migration? | db.migrate |
Database | "auto", "yes" and "no" | Specifies whether a database specific migration to the new database version is to be carried out during the installation.
|
Adjust/create database schema? | db.create_schema |
Database | "yes", "no" | Specifies for database reinstallations whether the new schema is to be installed with the PLANTA tables and whether (for updates) some newly loaded PLANTA files are adjusted (e.g. the license).
|
Load data? | db.load_data |
Database | "yes", "no" | Specifies for database installations whether the standard customizing data is to be imported by PLANTA.
|
Server IP address | SERVER_IP |
Server, client | e.g. "192.168.10.20" | IP address of the PLANTA server.
|
Port | PORT |
Server, client | e.g. "12345" | Port number via which the server communicates with the clients. This number should be a five-digit number smaller than 30000, which is not used by any other process. |
Name of the PLANTA server | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed.
|
|
Existing server directory | server.path.existing |
Server | Directory in which the old PLANTA project server is located
|
|
Adjust database schema to server hotfix? | server.update_schema |
Server | "yes", "no" | Specifies whether the schema of the server is adjusted in order to secure the server start.
|
Run migration? | server.migrate |
Server | "auto", "yes" and "no" | Specifies whether a database specific migration to the new server version is to be carried out during the installation.
|
Name of the user group | server.user.group |
Server, monitoring | e.g. "User" | Group to which the installation belongs
|
Service user | server.user.name |
Server, monitoring | Linux user to which the Linux installation belongs and that starts the PLANTA Server service
|
|
Expected utilization | system.dimension |
Server | "small", "medium", "large" | How large will the utilization of this system be? (small = test system, medium = normal use, large = many users on the system simultaneously). By definition, parameters relevant for sizing are set in the configuration files of the PLANTA server. After installation/update, you must check whether this setting complies with the probable usage of the PLANTA system. This includes, a.o., the following parameters:
|
Activate web services? BETA | planta.services.activate |
Server | "yes", "no" | Specifies whether the web services are to be activated. |
IP address of the web service BETA | planta.services.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web service is to run. |
Port of the web services BETA | planta.services.port |
Server | e.g. "23456" | Port on which the web services are to run. |
Activate web service documentation? BETA | planta.services.doc.activate |
Server | "yes", "no" | Specifies whether the web service documentation is to be activated.
|
IP address for web service documentation BETA | planta.services.doc.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.31" | IP address of the computer on which the web service documentation is to run. |
Port for web service documentation BETA | planta.services.doc.port |
Server | e.g. "23457" | Port on which the web service documentation is to run. |
Log level | log.level |
Server | Specifies how much information is written in the PLANTA log file.
|
|
Create core dumps? | debug.coredumps |
Server | "1" (create coredump), "0" (do not create coredump) | Specifies whether a coredump file with the current system status is created upon a crash.
|
Path to coredumps | debug.coredump_path |
Server | Specifies, where a possible coredump is to be created (see the create coredumps? parameter )
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created on the desktop |
Startup shortcut | client.create_menu_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created in the startup menu |
Monitoring activated | planta.monitoring.enable |
Server | "true", "false" | Specifies whether the monitoring component for the server is to be activated
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | e.g. "12345" | Port number via which the server communicates with the monitoring component. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring interface IP | planta.monitoring.interface |
Server | e.g. "localhost", "192.168.10.20" | Specifies the IP address of the monitoring component
|
Port of the web interface | monitoring.port |
Monitoring | e.g. "12345" | Port number of the monitoring component web service. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed.
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
server.install
: Specifies whether server specific steps are to be carried out. These are e.g. db.install
: Specifies whether database specific steps are to be carried out. These are e.g. db.install
parameter must be set = yes.
monitoring.install
: Specifies whether the monitoring component is to be installed to check the PLANTA Server.regtests.install
: Specifies whether the regression tests are to be installed, with the help of which the functionality of the PLANTA Server can be checked upon completed installation.client.install
: Specifies whether a PLANTA client is to be installed. planta-windows.properties
or planta-linux.properties
(only for the automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
db.manual_connection_string |
Connection string to a particular database | Provides the option to manually specify the connection string to a particular database. This influences both the way the installer itself accesses the database (e.g. when creating the new database user), and the way the server or hibernate accesses it (in the
|
db.manual_connection_priv_string |
Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)), requires a special login string.
|
planta.alternative_migration_directory |
An absolute path | Enables the use of an alternative directory for migration packets and the corresponding SQL files.
|
planta.migration_scripts_to_ignore |
A list of migration packets separated by blank spacesc | It specifies a list of migration packets which are not to be run in the migration.
|
temp.path |
A relative or absolute path | The installer copies some auxilliary files to a temporary directory (and adjusts them in line with the settings). It is /tmp/install_planta under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type |
release or asan or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing and asan versions can be used for debugging since at runtime some additional tests are carried out, which, however, slightly slow down the runtime. |
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
See also: Installation and Update, Release Notes, System Requirements |
JAVA_HOME
(e.g. /usr/java/jdk1.7.0_80
)
CLASSPATH
(e.g. /usr/java/jdk1.7.0_80/bin
)
PATH
(e.g. /usr/java/jdk1.7.0_80/bin:/usr/java/jdk1.7.0_80/jre/bin:$PATH
)
JAVA_HOME
(e.g. C:\java\jdk1.7.0_80
)install_planta_with_template.bat
script (on Windows systems) or install_planta_with_template.sh
script (on Linux systems).
planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on available parameters, please click here.
db.install
, server.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
Parameter | Name in properties files | Used for component | Possible values | Meaning |
---|---|---|---|---|
Installation type | planta.install_type |
Client, server, database | "new", "update" | Specifies whether you should reinstall or upgrade an existing system
|
Update type | planta.update_type |
Client, server, database | "r94" (update of 39.4.4.0), "r95" (update of 39.5.X with DB 39.4), "venus" (update of an existing 39.5.X system with DB 39.5), "voeToVenus" (migration of 39.5 with DB 39.4 to 39.5 with DB 39.5) | In the case of an update, it specifies of which type the system to be updated is, i.e. whether it is a 39.4.4.0 or a 39.5.X system (with DB 39.4 or DB 39.5).
|
DB log path | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
Start server after installation? | server.start_server |
Client, server, database | "yes", "no" | Specifies whether the server is to be restarted automatically after successful installation.
|
How to install a database? | db.install_type |
Database | "existing" (use of existing database user), "new" (creation of a new database user) | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
Database type | db.type |
Database, server | "Oracle", "MSSQL" | Database type |
License | License |
Server, monitoring, database | e.g. "200" | Your license number allocated by PLANTA. |
Database server | db.server |
Server, monitoring, database | e.g. "srvPLANTA", "192.168.10.20" | Name or IP address of the server on which the database runs. |
Database port | db.port |
Server, monitoring, database | e.g. "1521" (Oracle), "1433" (MSSQL) | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default. |
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name.
|
|
Oracle Tablespace | db.tablespace |
Database | Specifies to which oracle table space a new database user is to be assigned.
|
|
MSSQL server uses named instance | db.use_named_instance |
Server, monitoring, database | "yes", "no" | Specifies for MSSQL databases whether to connect to a named instance or to the default instance.
|
Database instance | db.instance |
Server, monitoring, database | Name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed.
|
|
Database password | db.password |
Server, monitoring, database | Password of the user. | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user.
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Manual Connect String NEW | db.manual_connection_string |
Database, server | Connection string to a particular database, e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433 | Provides the option to manually specify the connection string to a particular database. This influences the way the installer accesses the database itself (e.g. when creating a new database user) and the way the server or hibernate accesses it (in the
|
Manual connect string for administrator NEW | db.manual_connection_priv_string |
Database | Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see Database Admin Username parameter)), requires a special login string.
|
Run migration? | db.migrate |
Database | "auto", "yes" and "no" | Specifies whether a database specific migration to the new database version is to be carried out during the installation.
|
Adjust/create database schema? | db.create_schema |
Database | "yes", "no" | Specifies for database reinstallations whether the new schema is to be installed with the PLANTA tables and whether (for updates) some newly loaded PLANTA files are adjusted (e.g. the license).
|
Load data? | db.load_data |
Database | "yes", "no" | Specifies for database installations whether the standard customizing data is to be imported by PLANTA.
|
Server IP address | SERVER_IP |
Server, client | e.g. "192.168.10.20" | IP address of the PLANTA server.
|
Port | PORT |
Server, client | e.g. "12345" | Port number via which the server communicates with the clients. This number should be a five-digit number smaller than 30000, which is not used by any other process. |
Name of the PLANTA server | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed.
|
|
Existing server directory | server.path.existing |
Server | Directory in which the old PLANTA project server is located
|
|
Adjust database schema to server hotfix? | server.update_schema |
Server | "yes", "no" | Specifies whether the schema of the server is adjusted in order to secure the server start.
|
Run migration? | server.migrate |
Server | "auto", "yes" and "no" | Specifies whether a database specific migration to the new server version is to be carried out during the installation.
|
Name of the user group | server.user.group |
Server, monitoring | e.g. "User" | Group to which the installation belongs
|
Service user | server.user.name |
Server, monitoring | Linux user to which the Linux installation belongs and that starts the PLANTA Server service
|
|
Expected utilization | system.dimension |
Server | "small", "medium", "large" | How large will the utilization of this system be? (small = test system, medium = normal use, large = many users on the system simultaneously). By definition, parameters relevant for sizing are set in the configuration files of the PLANTA server. After installation/update, you must check whether this setting complies with the probable usage of the PLANTA system. This includes, a.o., the following parameters:
|
Activate web services? NEW BETA | planta.services.activate |
Server | "yes", "no" | Specifies whether the web services are to be activated. |
IP address of the web service NEW BETA | planta.services.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.30" | IP address of the computer on which the web services are to run. |
Port of the web services NEW BETA | planta.services.port |
Server | e.g. "23456" | Port on which the web services are to run. |
Activate web service documentation? NEW BETA | planta.services.doc.activate |
Server | "yes", "no" | Specifies whether the web service documentation is to be activated.
|
IP address for web service documentation NEW BETA | planta.services.doc.interface |
Server | e.g. "srvWebPLANTA", "192.168.10.31" | IP address of the computer on which the web service documentation is to run. |
Port for web service documentation NEW BETA | planta.services.doc.port |
Server | e.g. "23457" | Port on which the web service documentation is to run. |
Log level | log.level |
Server | Specifies how much information is written in the PLANTA log file.
|
|
Create core dumps? | debug.coredumps |
Server | "1" (create coredump), "0" (do not create coredump) | Specifies whether a coredump file with the current system status is created upon a crash.
|
Path to coredumps | debug.coredump_path |
Server | Specifies, where a possible coredump is to be created (see the create coredumps? parameter )
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created on the desktop |
Startup shortcut | client.create_menu_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created in the startup menu |
Monitoring activated | planta.monitoring.enable |
Server | "true", "false" | Specifies whether the monitoring component for the server is to be activated
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | e.g. "12345" | Port number via which the server communicates with the monitoring component. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring interface IP | planta.monitoring.interface |
Server | e.g. "localhost", "192.168.10.20" | Specifies the IP address of the monitoring component
|
Port of the web interface | monitoring.port |
Monitoring | e.g. "12345" | Port number of the monitoring component web service. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed.
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
server.install
: Specifies whether server specific steps are to be carried out. These are e.g. db.install
: Specifies whether database specific steps are to be carried out. These are e.g. db.install
parameter must be set = yes.
client.install
: Specifies whether a PLANTA client is to be installed. planta-windows.properties
or planta-linux.properties
(only for the automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
db.manual_connection_string NEW |
Connection string to a particular database | Provides the option to manually specify the connection string to a particular database. This influences both the way the installer itself accesses the database (e.g. when creating the new database user), and the way the server or hibernate accesses it (in the
|
db.manual_connection_priv_string NEW |
Connection string to a particular database (for the administrator) | This manual connection string is designed for the special case that the administrator (DB user with the help of which the PLANTA DB user is created (see the Database Admin User Name parameter)) requires a special login string.
|
planta.alternative_migration_directory |
An absolute path | Enables the use of an alternative directory for migration packets and the corresponding SQL files.
|
temp.path |
A relative or absolute path | The installer copies some auxilliary files to a temporary directory (and adjusts them in line with the settings). It is /tmp/install_planta under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type |
release or asan or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing and asan versions can be used for debugging since at runtime some additional tests are carried out, which, however, slightly slow down the runtime. |
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
See also: Installation and Update, Release Notes, System Requirements |
JAVA_HOME
(e.g. /usr/java/jdk1.7.0_80
)
CLASSPATH
(e.g. /usr/java/jdk1.7.0_80/bin
)
PATH
(e.g. /usr/java/jdk1.7.0_80/bin:/usr/java/jdk1.7.0_80/jre/bin:$PATH
)
JAVA_HOME
(e.g. C:\java\jdk1.7.0_80
)
install_planta_with_template.bat
script (on Windows systems) or install_planta_with_template.sh
script (on Linux systems).
planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on available parameters, please click here.
db.install
, server.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
Parameter | Name in properties files | Used for component | Possible values | Meaning |
---|---|---|---|---|
Installation type | planta.install_type |
Client, server, database | "new", "update" | Specifies whether you should reinstall or upgrade an existing system
|
Update type | planta.update_type |
Client, server, database | "r94" (update of 39.4.4.0), "r95" (update of 39.5.X with DB 39.4), "venus" (update of an existing 39.5.X system with DB 39.5), "voeToVenus" (migration of 39.5 with DB 39.4 to 39.5 with DB 39.5) | In the case of an update, it specifies of which type the system to be updated is, i.e. whether it is a 39.4.4.0 or a 39.5.X system (with DB 39.4 or DB 39.5).
|
DB log path | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
Start server after installation? | server.start_server |
Client, server, database | "yes", "no" | Specifies whether the server is to be restarted automatically after successful installation.
|
How to install a database? | db.install_type |
Database | "existing" (use of existing database user), "new" (creation of a new database user) | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
Database type | db.type |
Database, server | "Oracle", "MSSQL" | Database type |
License | License |
Server, monitoring, database | e.g. "200" | Your license number allocated by PLANTA. |
Database server | db.server |
Server, monitoring, database | e.g. "srvPLANTA", "192.168.10.20" | Name or IP address of the server on which the database runs. |
Database port | db.port |
Server, monitoring, database | e.g. "1521" (Oracle), "1433" (MSSQL) | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default. |
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name.
|
|
Oracle Tablespace | db.tablespace |
Database | Specifies to which oracle table space a new database user is to be assigned.
|
|
MSSQL server uses named instance | db.use_named_instance |
Server, monitoring, database | "yes", "no" | Specifies for MSSQL databases whether to connect to a named instance or to the default instance.
|
Database instance | db.instance |
Server, monitoring, database | Name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed.
|
|
Database password | db.password |
Server, monitoring, database | Password of the user. | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user.
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Run migration? | db.migrate |
Database | "auto", "yes" and "no" | Specifies whether a database specific migration to the new database version is to be carried out during the installation.
|
Adjust/create database schema? | db.create_schema |
Database | "yes", "no" | Specifies for database reinstallations whether the new schema is to be installed with the PLANTA tables and whether (for updates) some newly loaded PLANTA files are adjusted (e.g. the license).
|
Load data? | db.load_data |
Database | "yes", "no" | Specifies for database installations whether the standard customizing data is to be imported by PLANTA.
|
Server IP address | SERVER_IP |
Server, client | e.g. "192.168.10.20" | IP address of the PLANTA server.
|
Port | PORT |
Server, client | e.g. "12345" | Port number via which the server communicates with the clients. This number should be a five-digit number smaller than 30000, which is not used by any other process. |
Name of the PLANTA server | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed.
|
|
Existing server directory | server.path.existing |
Server | Directory in which the old PLANTA project server is located
|
|
Adjust database schema to server hotfix? | server.update_schema |
Server | "yes", "no" | Specifies whether the schema of the server is adjusted in order to secure the server start.
|
Run migration? | server.migrate |
Server | "auto", "yes" and "no" | Specifies whether a database specific migration to the new server version is to be carried out during the installation.
|
Name of the user group | server.user.group |
Server, monitoring | e.g. "User" | Group to which the installation belongs
|
Service user | server.user.name |
Server, monitoring | Linux user to which the Linux installation belongs and that starts the PLANTA Server service
|
|
Expected utilization | system.dimension |
Server | "small", "medium", "large" | How large will the utilization of this system be? (small = test system, medium = normal use, large = many users on the system simultaneously). By definition, parameters relevant for sizing are set in the configuration files of the PLANTA server. After installation/update, you must check whether this setting complies with the probable usage of the PLANTA system. This includes, a.o., the following parameters:
|
Log level | log.level |
Server | Specifies how much information is written in the PLANTA log file.
|
|
Create core dumps? | debug.coredumps |
Server | "1" (create coredump), "0" (do not create coredump) | Specifies whether a coredump file with the current system status is created upon a crash.
|
Path to coredumps | debug.coredump_path |
Server | Specifies, where a possible coredump is to be created (see the create coredumps? parameter )
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created on the desktop |
Startup shortcut | client.create_menu_shortcut |
Client | "1" (create link), "0" (do not create link) | Defines whether a link to the client is to be created in the startup menu |
Monitoring activated | planta.monitoring.enable |
Server | "true", "false" | Specifies whether the monitoring component for the server is to be activated
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | e.g. "12345" | Port number via which the server communicates with the monitoring component. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring interface IP | planta.monitoring.interface |
Server | e.g. "localhost", "192.168.10.20" | Specifies the IP address of the monitoring component
|
Port of the web interface | monitoring.port |
Monitoring | e.g. "12345" | Port number of the monitoring component web service. This number should be a five-digit number smaller than 30000, which is not used by any other process.
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed.
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
server.install
: Specifies whether server specific steps are to be carried out. These are e.g. db.install
: Specifies whether database specific steps are to be carried out. These are e.g. db.install
parameter must be set = yes.
client.install
: Specifies whether a PLANTA client is to be installed. planta-windows.properties
or planta-linux.properties
(only for the automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
planta.alternative_migration_directory NEW |
An absolute path | Enables the use of an alternative directory for migration packets and the corresponding SQL files.
|
temp.path |
A relative or absolute path | The installer copies some auxilliary files to a temporary directory (and adjusts them in line with the settings). It is /tmp/install_planta under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type |
release or asan or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing and asan versions can be used for debugging since at runtime some additional tests are carried out, which, however, slightly slow down the runtime. |
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
See also: Installation and Update, Release Notes, System Requirements |
JAVA_HOME
(e.g. /usr/java/jdk1.7.0_80
)
CLASSPATH
(e.g. /usr/java/jdk1.7.0_80/bin
)
PATH
(e.g. /usr/java/jdk1.7.0_80/bin:/usr/java/jdk1.7.0_80/jre/bin:$PATH
)
JAVA_HOME
(e.g. C:\java\jdk1.7.0_80
)
JAVA_JAR
(e.g. /usr/java/java_jar
)
install_planta.bat
(on Windows systems) or install_planta.sh
(on Linux systems). planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on the parameters, see the Installation Parameters section.
db.install
, server.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
Parameter | Name in properties files | Used for component | Meaning | |
---|---|---|---|---|
Installation type | planta.install_type |
Client, server, database | Specifies whether you should reinstall or upgrade an existing system.
|
|
Update type | planta.update_type |
Client, server, database | In case of an update it specifies the type of the existing system to be updated, i.e. whether it is a 39.4.4.0 or 39.5.X system (with DB 39.4 or DB 39.5).
|
|
DB log file | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
Start server after installation? NEW | server.start_server |
Client, server, database | Specifies whether the server is to be restarted automatically after successful installation.
|
|
How to install a database? | db.install_type |
Database | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
|
Database type | db.type |
Database, server | Database type
|
|
License | License |
Server, monitoring, database | Your license number allocated by PLANTA, e.g. "200". | |
Database server | db.server |
Server, monitoring, database | Name or IP address of the server on which the database is running | |
Database port | db.port |
Server, monitoring, database | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default |
|
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name.
|
|
Oracle Tablespace | db.tablespace |
Database | Specifies to which oracle table space a new database user is to be assigned.
|
|
MSSQL server uses named instance | db.use_named_instance |
Server, monitoring, database | Specifies for MSSQL databases whether to connect to a named instance or to the default instance.
|
|
Database instance | db.instance |
Server, monitoring, database | The name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed
|
|
Database password | db.password |
Server, monitoring, database | Password of the user | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Run migration? NEW | db.migrate |
Database | Specifies whether a database specific migration to the new database version is to be carried out during the installation
|
|
python.install_only_core |
Server | This parameter specifies whether a reduced core update is to be carried out when loading a new 39.5 server version. This decision is made by the installer. Please note that core installation is always started when a pure server update (without simultaneous database update) is carried out in a 39.5 system with DB 39.5 ( not in a 39.5 system with DB 39.4).
|
||
Adjust/create database schema? NEW | db.create_schema |
Database | Specifies for database reinstallations whether the new schema is to be installed with the PLANTA tables and whether (for updates) some newly loaded PLANTA files are adjusted (e.g. the license).
|
|
Load data? NEW | db.load_data |
Database | Specifies in database installation whether the Standard customizing data are to be imported from PLANTA
|
|
Server IP address | SERVER_IP |
Server, client | IP address of the PLANTA server.
|
|
Port | PORT |
Server, client | Port number via which the server communicates with the clients. This number should be a five-digit number less than 30000, which is not used by any other process | |
Name of the PLANTA server service | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed
|
|
Existing server directory | server.path.existing |
Server | Directory in which the old PLANTA project server is located
|
|
Adjust database schema to server hotfix? NEW | server.update_schema |
Server | Specifies whether the schema of the server is adjusted in order to secure the server start.
|
|
Run migration? | server.migrate |
Server | Specifies whether a server specific migration to the new server version is to be carried out during the installation
|
|
Name of the user group | server.user.group |
Server, monitoring | Group to which the installation belongs
|
|
Service user | server.user.name |
Server, monitoring | Linux user to which the Linux installation belongs and that starts the PLANTA Server service
|
|
Expected utilization | system.dimension |
Server | How large will the utilization of this system be? (small = test system, medium = normal operation, large = many users on the same system simultaneously)
|
|
Log level | log.level |
Server | Specifies how much information is written in the PLANTA log file.
|
|
Create core dumps? | debug.coredumps |
Server | Specifies whether a core dump file with the current system status is created
|
|
Path to coredumps | debug.coredump_path |
Server | Specifies, where a possible coredump is to be created (see the create coredumps? parameter )
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | Defines whether a shortcut to the client is to be created on the desktop
|
|
Start-up shortcut | client.create_menu_shortcut |
Client | Defines whether a shortcut to the client is to be created in the start-up menu
|
|
Monitoring activated | planta.monitoring.enable |
Server | Specifies whether the monitoring component for the server is to be activated
|
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | Port number via which the server communicates with the monitoring component. It should be a five-digit number smaller than 30000 which is not used by any other process
|
|
Monitoring interface IP | planta.monitoring.interface |
Server | Specifies the IP address of the monitoring component
|
|
Port of the web interface | monitoring.port |
Monitoring | Port number of the monitoring component web service. It should be a five-digit number smaller than 30000 which is not used by any other process
|
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
db.install
: Specifies whether a database is to be installed. Possible values are "yes" or "no". planta.install_type
= venus).
server.install
: Specifies whether a PLANTA server is to be installed. Possible values are "yes" or "no".
client.install
: Specifies whether a PLANTA client is to be installed. Possible values are "yes" or "no". planta-windows.properties
or planta-linux.properties
(only for automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
temp.path | A relative or absolute path | During the installation, the installer copies some auxilliary files into a temporary directory (and adjusts them according to the settings). It is /tmp/install_planta= under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type | release or asan or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing and asan versions can be used for debugging since at runtime some additional tests are carried out, which, however, slightly slow down the runtime. |
See also: Installation and Update, Release Notes, System Requirements |
JAVA_HOME
(e.g. /usr/java/jdk1.7.0_21
)
CLASSPATH
(e.g. /usr/java/jdk1.7.0_21/bin
)
PATH
(e.g. /usr/java/jdk1.7.0_21/bin:/usr/java/jdk1.7.0_21/jre/bin:$PATH
)
JRE_HOME
(e.g. /usr/java/jdk1.7.0_21/jre
)
JAVA_JAR
(e.g. /usr/java/java_jar
)
install_planta.bat
(on Windows systems) or install_planta.sh
(on Linux systems). planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on the parameters, see the Installation Parameters section.
db.install
, server.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
Parameter | Name in properties files | Used for component | Meaning | |
---|---|---|---|---|
Installation type | planta.install_type |
Client, server, database | Specifies whether you should reinstall or upgrade an existing system
|
|
Update type | planta.update_type |
Client, server, database | In case of an update it specifies the type of the existing system to be updated, i.e. whether it is a 39.4.4.0 or 39.5.X system (with DB 39.4 or DB 39.5).
|
|
DB log file | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
How to install a database? | db.install_type |
Database | Specifies whether a new user is to be created for the database or an already existing one is to be used
|
|
Database type | db.type |
Database, server | Database type
|
|
License | License |
Server, monitoring, database | Your license number allocated by PLANTA, e.g. "200". | |
Database server | db.server |
Server, monitoring, database | Name or IP address of the server on which the database is running | |
Database port | db.port |
Server, monitoring, database | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default |
|
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name
|
|
MSSQL server uses named instance | db.use_named_instance | Server, monitoring, database | Specifies for MSSQL databases whether to connect to a named instance or to the default instance
|
|
Database instance | db.instance |
Server, monitoring, database | The name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed
|
|
Database password | db.password |
Server, monitoring, database | Password of the user | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Server IP address | SERVER_IP |
Server, client | IP address of the PLANTA server.
|
|
Port | PORT |
Server, client | Port number via which the server communicates with the clients. This number should be a five-digit number less than 30000, which is not used by any other process | |
Name of the PLANTA server service | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed
|
|
Existing server directory | server.path.existing |
Server | Directory in which the old PLANTA project server is located
|
|
Run migration? | server.migrate |
Server | Specifies whether a migration to the new server version is to be carried out during the installation
|
|
python.install_only_core |
Server | This parameter specifies whether a reduced core installation is to be carried out when loading a new 39.5 server version. This decision is made by the installer. Please note that core installation is always started when a pure server update (without simultaneous database update) is carried out in a 39.5 system with DB 39.5 ( not in a 39.5 system with DB 39.4).
|
||
Name of the user group NEW | server.user.group |
Server, monitoring | Group to which the installation belongs
|
|
Service user NEW | server.user.name |
Server, monitoring | Linux user to which the Linux installation belongs and that starts the PLANTA server service
|
|
Expected utilization | system.dimension |
Server | How large will the utilization of this system be? (small = test system, medium = normal operation, large = many users on the same system simultaneously)
|
|
Log level | log.level |
Server | Specifies how much information is written in the PLANTA log file.
|
|
Create core dumps? | debug.coredumps |
Server | Specifies whether a core dump file with the current system status is created
|
|
Path to coredumps | debug.coredump_path |
Server | Specifies, where a possible coredump is to be created (see the create coredumps? parameter )
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | Defines whether a shortcut to the client is to be created on the desktop
|
|
Start-up shortcut | client.create_menu_shortcut |
Client | Defines whether a shortcut to the client is to be created in the start-up menu
|
|
Monitoring activated | planta.monitoring.enable |
Server | Specifies whether the monitoring component for the server is to be activated
|
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | Port number via which the server communicates with the monitoring component. It should be a five-digit number smaller than 30000 which is not used by any other process
|
|
Monitoring interface IP | planta.monitoring.interface |
Server | Specifies the IP address of the monitoring component
|
|
Port of the web interface | monitoring.port |
Monitoring | Port number of the monitoring component web service. It should be a five-digit number smaller than 30000 which is not used by any other process
|
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
db.install
: Specifies whether a database is to be installed. Possible values are "yes" or "no". planta.install_type
= venus).
server.install
: Specifies whether a PLANTA server is to be installed. Possible values are "yes" or "no".
client.install
: Specifies whether a PLANTA client is to be installed. Possible values are "yes" or "no". planta-windows.properties
or planta-linux.properties
(only for automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
temp.path | A relative or absolute path | During the installation, the installer copies some auxilliary files into a temporary directory (and adjusts them according to the settings). It is /tmp/install_planta= under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type | release or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing version can be used for debugging since at runtime some additional tests are carried out, which, however slows down the runtime a little bit. |
See also: Installation and Update, Release Notes, System Requirements |
JAVA_HOME
(e.g. /usr/java/jdk1.7.0_21
)
CLASSPATH
(e.g. /usr/java/jdk1.7.0_21/bin
)
PATH
(e.g. /usr/java/jdk1.7.0_21/bin:/usr/java/jdk1.7.0_21/jre/bin:$PATH
)
JRE_HOME
(e.g. /usr/java/jdk1.7.0_21/jre
)
JAVA_JAR
(e.g. /usr/java/java_jar
)
install_planta.bat
(on Windows systems) or install_planta.sh
(on Linux systems). planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on the parameters, see the Installation Parameters section.
db.install
, server.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
Parameter | Name in properties files | Used for component | Meaning | |
---|---|---|---|---|
Installation type | planta.install_type |
Client, server, database | Specifies whether you should reinstall or upgrade an existing system NEW
|
|
Update type | planta.update_type |
Client, server, database | In case of an update it specifies the type of the existing system to be updated, i.e. whether it is a 39.4.4.0 or 39.5.X system (with DB 39.4 or DB 39.5).
|
|
DB log file | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
|
How to install a database? | db.install_type |
Database | Specifies whether a new user is to be created for the database or an already existing one is to be used
|
|
Database type | db.type |
Database, server | Database type
|
|
License | License |
Server, monitoring, database | Your license number allocated by PLANTA, e.g. "200". | |
Database server | db.server |
Server, monitoring, database | Name or IP address of the server on which the database is running | |
Database port | db.port |
Server, monitoring, database | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default |
|
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name
|
|
MSSQL server uses named instance | db.use_named_instance | Server, monitoring, database | Specifies for MSSQL databases whether to connect to a named instance or to the default instance
|
|
Database instance | db.instance |
Server, monitoring, database | The name of the MSSQL instance, to which to connect.
|
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed
|
|
Database password | db.password |
Server, monitoring, database | Password of the user | |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user
|
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
|
Server IP address | SERVER_IP |
Server, client | IP address of the PLANTA server.
|
|
Port | PORT |
Server, client | Port number via which the server communicates with the clients. This number should be a five-digit number less than 30000, which is not used by any other process | |
Name of the PLANTA server service | service.name |
Server | Name of the service assigned to the PLANTA server.
|
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed
|
|
Existing server directory | server.path.existing |
Server | Directory in which the old PLANTA project server is located
|
|
Run migration? NEW | server.migrate |
Server | Specifies whether a migration to the new server version is to be carried out during the installation
|
|
NEW | python.install_only_core |
Server | This parameter specifies whether a reduced core installation is to be carried out when loading a new Venus release. This decision is made by the installer. Please note that a core installation is always started, if a pure server update (without simultaneous database update) is carried out in a Venus system (not Venus on Earth!).
|
|
Name of the user group | server.user.group |
Server, monitoring | Group to which the installation belongs
|
|
Service user | server.user.name |
Server, monitoring | Linux user to which the Linux installation belongs and that starts the PLANTA server service
|
|
Expected utilization | system.dimension |
Server | How large will the utilization of this system be? (small = test system, medium = normal operation, large = many users on the same system simultaneously)
|
|
Log level | log.level |
Server | Specifies how much information is written in the PLANTA log file.
|
|
Create core dumps? | debug.coredumps |
Server | Specifies whether a core dump file with the current system status is created
|
|
Path to coredumps | debug.coredump_path |
Server | Specifies, where a possible coredump is to be created (see the create coredumps? parameter )
|
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
|
Desktop shortcut | client.create_desktop_shortcut |
Client | Defines whether a shortcut to the client is to be created on the desktop
|
|
Start-up shortcut | client.create_menu_shortcut |
Client | Defines whether a shortcut to the client is to be created in the start-up menu
|
|
Monitoring activated | planta.monitoring.enable |
Server | Specifies whether the monitoring component for the server is to be activated
|
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | Port number via which the server communicates with the monitoring component. It should be a five-digit number smaller than 30000 which is not used by any other process
|
|
Monitoring interface IP | planta.monitoring.interface |
Server | Specifies the IP address of the monitoring component
|
|
Port of the web interface | monitoring.port |
Monitoring | Port number of the monitoring component web service. It should be a five-digit number smaller than 30000 which is not used by any other process
|
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed
|
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
db.install
: Specifies whether a database is to be installed. Possible values are "yes" or "no".
server.install
: Specifies whether a PLANTA server is to be installed. Possible values are "yes" or "no".
client.install
: Specifies whether a PLANTA client is to be installed. Possible values are "yes" or "no". planta-windows.properties
or planta-linux.properties
(only for automated console installation).
Name in properties files | Possible values | Meaning |
---|---|---|
temp.path | A relative or absolute path | During the installation, the installer copies some auxilliary files into a temporary directory (and adjusts them according to the settings). It is /tmp/install_planta= under Linux or %temp%/install_planta under Windows by default (in case the parameter is not specified).
|
server.type | release or testing | Specifies which server is installed. This is the release version by default (if the parameter is not specified). The testing version can be used for debugging since at runtime some additional tests are carried out, which, however slows down the runtime a little bit. |
See also: Installation and Update, Release Notes, System Requirements |
JAVA_HOME
(e.g. /usr/java/jdk1.7.0_21
)
CLASSPATH
(e.g. /usr/java/jdk1.7.0_21/bin
)
PATH
(e.g. /usr/java/jdk1.7.0_21/bin:/usr/java/jdk1.7.0_21/jre/bin:$PATH
)
JRE_HOME
(e.g. /usr/java/jdk1.7.0_21/jre
)
JAVA_JAR
(e.g. /usr/java/java_jar
)
install_planta.bat
(on Windows systems) or install_planta.sh
(on Linux systems). planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on the parameters, see the Installation Parameters section.
db.install
, server.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\config\planta_server.conf
file.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
Parameter | Name in properties files | Used for component | Meaning |
---|---|---|---|
Installation type | planta.install_type |
Client, server, database | Specifies whether it is updated from a 39.4.4.0 or from a 39.5.x system or whether an entirely new system is to be installed.
|
DB log file | log.path |
Client, server, database | A directory in which log files with information on installation and update are saved.
|
How to install a database? | db.install_type |
Database | Specifies whether a new user is to be created for the database or an already existing one is to be used
|
Database type | db.type |
Database, server | Database type
|
License | License |
Server, monitoring, database | Your license number allocated by PLANTA, e.g. "200" |
Database server | db.server |
Server, monitoring, database | Name or IP address of the server on which the database is running |
Database port | db.port |
Server, monitoring, database | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default |
Database name | db.name |
Server, monitoring, database | In Oracle the SID, in MSSQL the database name
|
MSSQL server uses named instance | db.use_named_instance | Server, monitoring, database | Specifies for MSSQL databases whether to connect to a named instance or to the default instance
|
Database instance | db.instance |
Server, monitoring, database | The name of the MSSQL instance, to which to connect.
|
Database user | db.user |
Server, monitoring, database | User for which the schema is to be installed
|
Database password | db.password |
Server, monitoring, database | Password of the user |
Database admin user name | db.user_privileged |
Database | Name of the user with the right to create a new user
|
Database admin password | db.password_privileged |
Database | Password of the new user.
|
Server IP address | SERVER_IP |
Server, client | IP address of the PLANTA server.
|
Port | PORT |
Server, client | Port number via which the server communicates with the clients. This number should be a five-digit number less than 30000, which is not used by any other process |
Name of the PLANTA server service | service.name |
Server | Name of the service assigned to the PLANTA server.
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed
|
Existing server directory | server.path.existing |
Server | Directory in which the old PLANTA project server is located
|
Name of the user group NEW | server.user.group |
Server, monitoring | Group to which the installation belongs
|
Service user NEW | server.user.name |
Server, monitoring | Linux user to which the Linux installation belongs and that starts the PLANTA server service
|
Expected utilization | system.dimension |
Server | How large will the utilization of this system be? (small = test system, medium = normal operation, large = many users on the same system simultaneously)
|
Log level | log.level |
Server | Specifies how much information is written in the PLANTA log file.
|
Create core dumps? | debug.coredumps |
Server | Specifies whether a core dump file with the current system status is created
|
Path to coredumps | debug.coredump_path |
Server | Specifies, where a possible coredump is to be created (see the create coredumps? parameter )
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
Desktop shortcut | client.create_desktop_shortcut |
Client | Defines whether a shortcut to the client is to be created on the desktop
|
Start-up shortcut | client.create_menu_shortcut |
Client | Defines whether a shortcut to the client is to be created in the start-up menu
|
Monitoring activated | planta.monitoring.enable |
Server | Specifies whether the monitoring component for the server is to be activated
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | Port number via which the server communicates with the monitoring component. It should be a five-digit number smaller than 30000 which is not used by any other process
|
Monitoring interface IP | planta.monitoring.interface |
Server | Specifies the IP address of the monitoring component
|
Port of the web interface | monitoring.port |
Monitoring | Port number of the monitoring component web service. It should be a five-digit number smaller than 30000 which is not used by any other process
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
db.install
: Specifies whether a database is to be installed. Possible values are "yes" or "no". planta.install_type
= venus).
server.install
: Specifies whether a PLANTA server is to be installed. Possible values are "yes" or "no".
client.install
: Specifies whether a PLANTA client is to be installed. Possible values are "yes" or "no". See also: Installation and Update, Release Notes, System Requirements |
JAVA_HOME
(e.g. /usr/java/jdk1.7.0_21
)
CLASSPATH
(e.g. /usr/java/jdk1.7.0_21/bin
)
PATH
(e.g. /usr/java/jdk1.7.0_21/bin:/usr/java/jdk1.7.0_21/jre/bin:$PATH
)
JRE_HOME
(e.g. /usr/java/jdk1.7.0_21/jre
)
JAVA_JAR
(e.g. /usr/java/java_jar
)
install_planta.bat
(on Windows systems) or install_planta.sh
(on Linux systems). planta-windows.properties
file (on Windows systems) or planta-linux.properties
(on Linux systems), in order to set the parameters for your installation. For further information on the parameters, see the Installation Parameters section.
db.install
, server.install
and client.install
parameters to yes or no, whereas client.install
is only available on Windows systems.
C:\\planta\\server
instead of C:\planta\server
install_planta_with_template.bat
script (on Windows systems) afterwards or install_planta_with_template.sh
(on Linux systems).
/install/planta-linux.properties
and /install/planta-windows.properties
files may be configured.
/scripts
, especially scripts/temp.linux.properties
and scripts/temp.windows.properties
must NOT be changed.
server.path
/ client.path
parameters) and the install_planta
directory in your temporary directory before carrying out a reinstallation.
\config\planta_server.conf
file.
\log
directory for possible errors when starting the PLANTA server. It may also help to check via netstat whether the port specified during the installation is opened and whether the service has started according to Service Wrapper (open \yajsw\bat\queryService.bat
or /yajsw/bat/queryDaemon.sh
).
Parameter | Name in properties files | Used for component | Meaning |
---|---|---|---|
Installationsart | planta.install_type |
Client, server, database NEW | Specifies whether it is updated from a 39.4.4.0 or from a 39.5.x system or whether an entirely new system is to be installed.
|
DB log file | log.path |
Client, server, database NEW | A directory in which log files with information on installation and updates are saved.
|
How to install a database? NEW | db.install_type |
Database | Specifies whether a new user is to be created for the database or an already existing one is to be used.
|
Database type | db.type |
NEW Database, server | Database type
|
License | License |
Server, monitoring, database NEW | Your license number allocated by PLANTA, e.g. "200". |
Database server | db.server |
Server, monitoring, database NEW | Name or IP address of the server on which the database is running |
Database port | db.port |
Server, monitoring, database NEW | Port to the database. The port is "1521" for Oracle and "1433" for MSSQL by default |
Database name | db.name |
Server, monitoring, database NEW | In Oracle the SID, in MSSQL the database name
|
MSSQL server uses named instance | db.use_named_instance | Server, monitoring, database NEW | Specifies for MSSQL databases whether to connect to a named instance or to the default instance
|
Database instance | db.instance |
Server, monitoring, database NEW | Name of the MSSQL instance to which to connect
|
Database user | db.user |
Server, monitoring, database NEW | User for which the schema is to be installed
|
Database password | db.password |
Server, monitoring, database NEW | Password of the user |
Database admin user name NEW | db.user_privileged |
Database | Name of the user with the right to create a new user
|
Database admin password NEW | db.password_privileged |
Database | Password of the new user.
|
Server IP address | SERVER_IP |
Server, client | IP address of the PLANTA server.
|
Port | PORT |
Server, client | Port number via which the server communicates with the clients. This number should be a five-digit number less than 30000, which is not used by any other process |
Name of the PLANTA server service | service.name |
Server | Name of the service assigned to the PLANTA server.
|
New server directory | server.path |
Server | Directory in which the PLANTA project server is to be installed
|
Existing server directory | server.path.existing |
Server | Directory in which the old PLANTA project server is located
|
Existing server version | server.version |
Server | Specifies the version number of the existing server version. Via this parameter, the installer decides which installation script is to be run during the update.
|
Linux group | server.linux.group |
Server | Linux group to which the Linux installation belongs
|
Linux user | server.linux.group |
Server | Linux user to which the Linux installation belongs
|
Expected utilization | system.dimension |
Server | How large will the utilization of this system be? (small = test system, medium = normal operation, large = many users on the same system simultaneously)
|
Log level NEW | log.level |
Server | Specifies how much information is written in the PLANTA log file.
|
Create core dumps? NEW | debug.coredumps |
Server | Specifies whether a core dump file with the current system status is created
|
Path to coredumps NEW | debug.coredump_path |
Server | Specifies, where a possible coredump is to be created (see the create coredumps? parameter )
|
Client directory | client.path |
Client | Directory, in which the PLANTA project client is to be installed
|
Desktop shortcut | client.create_desktop_shortcut |
Client | Defines whether a shortcut to the client is to be created on the desktop
|
Start-up shortcut | client.create_menu_shortcut |
Client | Defines whether a shortcut to the client is to be created in the start-up menu
|
Monitoring activated | planta.monitoring.enable |
Server | Specifies whether the monitoring component for the server is to be activated
|
Port of the monitoring interface | planta.monitoring.port |
Server, monitoring | Port number via which the server communicates with the monitoring component. It should be a five-digit number smaller than 30000 which is not used by any other process
|
Monitoring interface IP | planta.monitoring.interface |
Server | Specifies the IP address of the monitoring component
|
Port of the web interface | monitoring.port |
Monitoring | Port number of the monitoring component web service. It should be a five-digit number smaller than 30000 which is not used by any other process
|
Monitoring directory | monitoring.path |
Monitoring | Directory in which the monitoring component is to be installed
|
Name of the monitoring service | monitoring.service |
Monitoring | Name of the service assigned to the monitoring component.
|
db.install
: Specifies whether a database is to be installed. Possible values are "yes" or "no". planta.install_type
= venus).
server.install
: Specifies whether a PLANTA server is to be installed. Possible values are "yes" or "no".
client.install
: Specifies whether a PLANTA client is to be installed. Possible values are "yes" or "no". See also: Installation and Update, Release Notes, System Requirements |