Installation/Update with PLANTA Installer From S 39.5.8 up to S 39.5.26

General

The installer provides the following functionalities:

• First installation
  • It contains the installation of all three components: PLANTA Database (PLANTA Standard), PLANTA Server, and PLANTA Client.
• Update
  • of individual components or
  • of all three components at once
    • The database, server, and client update by automatic installer is only a part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
      • Server update from 39.4.4.0 to 39.5.x
      • Server update from 39.5.x to 39.5.y
      • Client update
      • Database update
• Installation (update) on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation) (update).
• During the installation (update), a service that equates to the server process is installed. The name of the service can be specified in the name of the PLANTA server service parameter during the installation. Further information on the PLANTA server service .
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.

For a complete overview of the installation and update topics, please click here.

Attention

• If the installation (update) is not finished correctly by the installer, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• A particular Java version is not required as the PLANTA Server comes with its own Java version (Zulu). This has no influence on already existing Java versions on the system on which the PLANTA Server is installed.
• On Linux systems, rsync should be available.
• an Oracle or MSSQL database.

Notes

• The requirements described in the System Requirements topic must be met (including the PLANTA project user rights for Oracle databases described in there).
• The executing user must have profound knowledge in the required special fields and be logged on to the server as administrator (Windows) or root (Linux). On Windows, the installation can also be started by using the Run as administrator context menu.

Installation (Update) Procedure

There are two installation modes: graphical GUI installation and automated console installation. Both options are available for both Windows and Linux.

Graphical GUI Installation

Procedure

• Run the install_planta_with_template.bat script (on Windows systems) or install_planta_with_template.sh script (on Linux systems).
• First choose the installation type (first installation or update).
  • First installation of Release 39.5
  • Update of an existing system
    • Update from Release 39.4.4.0 to Release 39.5.x (with DB 39.4) or
      • Source system: all three components are 39.4.4.0
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.x.
    • Update from Release 39.5.x (with DB 39.4)
      • Source system: DB is 39.4.4.0, S and C are 39.5.x
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.y.
    • Update from Release 39.5.x (with DB 39.5)
      • Source system: all three components are 39.5.x
      • Target system: here you can choose whether one individual component or all three components are to be updated.
    • Migrating from DB 39.4 to DB 39.5 with release 39.5.x
      • Source system: S and C 39.5.x
      • Target system: S and C will be updated to 39.5.y.
      • The existing DB 39.4.4.0 database version will be migrated to version 39.5.y.
• First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
• Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, please click here.
• Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.
• The path specification is done OS specifically (Windows/Linux).

Automated Console Installation

The automated console installation (or console mode) enables installation without graphical surface.

Procedure NEW

• For the console installation, the planta-windows.properties file (for Windows systems) or planta-linux.properties file (for Linux systems) which requires the installation parameters is required.
• This file is located in the default directory of the installer. Under the 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.
• Edit this file now to set the parameters for your installation. For further information on available parameters, please click here.
• An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
• In order to define whether a particular component is to be installed in the first place, please set the 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.
• Please note that paths are not separated by a simple but by a double backslash.
  • E.g. C:\\planta\\server instead of C:\planta\server
• Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
• Please wait now, while the installer automatically copies files to your system and runs scripts.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Installation Parameters

Information

• The installer uses different parameters, via which the installation is controlled (for the installation or update procedure, please click here).
• The following table contains the possible value, which are explicitly specified during the automated console installation and selected and clicked on during the graphic GUI installation.

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. Reinstallation implies an installation of 39.5 (database and/or server).
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). This parameter is only of importance if an update is to be carried out and can be ignored otherwise.
DB log path	log.path	Client, server, database		A directory in which log files with information on installation and update are saved. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Start server after installation?	server.start_server	Client, server, database	"yes", "no"	Specifies whether the server is to be restarted automatically after successful installation. It may take some minutes until the server has been restarted completely and accepts the client connection.
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. This parameter is only relevant if a new database is to be installed. It will be ignored when updating an existing database.
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. If you use an MSSQL database with named instance, this instance comes with its own port number by default, which must be specified here.
Database name	db.name	Server, monitoring, database		In Oracle the SID, in MSSQL the database name. Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
Oracle Tablespace	db.tablespace	Database		Specifies to which oracle table space a new database user is to be assigned. This parameter is only relevant for reinstallations on an Oracle database during which a new user is to be created. For all other installation scenarios (update installation / reinstallation with MSSQL database / reinstallation with an already existing user), the parameter can be ignored.
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. This parameter is only relevant for MSSQL databases. Can be ignored for Oracle databases.
Database instance	db.instance	Server, monitoring, database		Name of the MSSQL instance, to which to connect. This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database		User for which the schema is to be installed. When reinstalling with a new user, it is the name of the user which is newly created. Otherwise it is the name of an already existing user. At the time of installation, there must be no synonyms for the database user (public or private). At runtime it is permitted. However, if data is to be imported at a later point in time (e.g. in the course of a DB update), the synonyms must be deactivated.
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. This parameter is only relevant if a new user is to be created and can be ignored otherwise
Database admin password	db.password_privileged	Database		Password of the new user. This parameter is only relevant if a new user is to be created and can be ignored otherwise
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 /config/hibernate.cfg.xml file) It is recommended to only apply this in case the database connection somehow differs from the standard. The connection string is composed of the db.type, db.server, db.name, db.user, db.port parameters internally by the installer, both (only for MSSQL) db.use_named_instance & db.instance. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, both (only for MSSQL) db.use_named_instance & db.instance parameters. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. The decision whether a migration is to be carried out is usually determined by a combination of the Installationsart and Updateart parameters and is preset accordingly. The Carry out migration? parameter should therefore not be changed. Note on the automated console installation: When selecting the "auto" value, the installer decides by the installation type selected whether a migration is carried out. yes and no overwrites this decision.
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). This parameter is only important for Venus installations and can otherwise be ignored. We urgently recommend that you activate this checkbox or leave the console parameter at "yes", since otherwise a database must be created in a new manner, which is not trivial.
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 This parameter is only of importance in Venus installations and can otherwise be ignored. It is urgently recommended that you activate this checkbox or leave the console parameter at "yes", since otherwise the data must be imported in another manner, which is not trivial.
Activate DB synonyms?	db.synonyms	Server	"yes", "no"	Specifies whether hibernate database synonyms are to be used or not. It is recommended to switch off synonyms since this improves performance.
Server IP address	SERVER_IP	Server, client	e.g. "192.168.10.20"	IP address of the PLANTA server. Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address.
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. This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server		Directory in which the PLANTA project server is to be installed. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server		Directory in which the former PLANTA project server is located. This parameter is only of importance if an update is to be carried out and can otherwise be ignored. In updates, some Python files from this path are copied to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. This parameter is ignored in Venus reinstallations, since here a new database with the respective current status is created. We urgently recommend that you activate this checkbox or leave the console parameter at "yes", since otherwise a database must be created in a new manner, which is not trivial.
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. This parameter should generally be activated or be left at the 'yes' default value (both for reinstallations as well as for update installations), since the migration framework itself decides when which migration packets are to be run. Note on the automated console installation: The old "auto" default value is obsolete and is now interpreted as "yes".
Name of the user group	server.user.group	Server, monitoring	e.g. "User"	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name "User".
Service user	service.user.name	Server, Database, Monitoring		Linux user to which the Linux installation belongs and which starts the PLANTA Server service. This parameter is only relevant for a new installation under Linux. It is used in the course of the installation of these users with sudo in order to start sub-processes (e.g. the migration)
Expected utilization	system.dimension	Server	"small", "medium", "large"	How large will the utilization of this system be? Small = test system (= 10 simultaneous sessions) Medium = normal operation (= 25 simultaneous sessions) Large = many users are on the system at the same time (= 75 simultaneous sessions). Parameters relevant for sizing are set in the configuration files of the PLANTA server by definition. 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: hibernate.cfg.xml c3p0.min_size c3p0.max_size c3p0.timeout c3p0.numHelperThreads globals.conf parallel_sessions
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. It is quite possible to activate the web service documentation if the web services themselves are not 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. This is primarily a debug parameter. This coredump can possibly become quite large.
Path to the coredumps	debug.coredump_path	Server		Specifies whether a possible coredump is to be created (see Coredumps erstellen? parameter). This is primarily a debug parameter. You need write rights for this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client		Directory, in which the PLANTA project client is to be installed You must have right rights for this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. This value is set automatically if a port of the monitoring interface is specified and can usually be ignored.
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. Can be ignored if you do not install the monitoring component.
Monitoring Interface IP	planta.monitoring.interface	Server	e.g. "localhost", "192.168.10.20"	Specifies the IP-address of the monitoring component. This value is automatically set to "localhost" if a port of the monitoring interface is specified and can usually be ignored.
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. This parameter differs from planta.monitoring.port.
Monitoring directory	monitoring.path	Monitoring		Directory in which the monitoring component is to be installed. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring		Name of the service assigned to the monitoring component. This name must be unique for each PLANTA system. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether particular components are to be installed. They are only relevant for the automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • server.install: Specifies whether server specific steps are to be carried out. These are e.g.
    • Installation or update of the binary server files,
    • Minimum adjustments of the database for securing the server start (i.e. the migration packets of the Server component) and/or
    • Installation / update of server specific Python files.
      Possible values are "yes" or "no".
  • db.install: Specifies whether database specific steps are to be carried out. These are e.g.
    • Installation of a new database,
    • Update of existing database tables (i.e. for DB 39.4.4.0 with S 39.5.x the migration packets of the Customizing-Hotfix component, for DB 39.5.x those of the Customizing, After DB Import and Before DB Import components) and/or
    • Installation / update of customizing specific Python files.
      Possible values are "yes" or "no".
    • For an update with DB39.4.4.0 and S39.5.x, the db.install parameter must be set = yes.
  • monitoring.install: Specifies whether the monitoring component is to be installed to check the PLANTA Server.
    Possible values are "yes" or "no".
  • 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.
    Possible values are "yes" or "no".
  • client.install: Specifies whether a PLANTA client is to be installed.
    Possible values are "yes" or "no".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to the 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 /config/hibernate.cfg.xml file) It is recommended to only do that if the database connection somehow deviates from the standard. Normally, this parameter should not be set. In this case, the connection string is built internally by the installer from the db.type, db.server, db.name, db.user, db.port parameters, and (only for MSSQL) db.use_named_instance & db.instance. Model connection strings would be e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, and (only for MSSQL) db.use_named_instance & db.instance parameters.
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. The system expects all SQL scripts, not only those that have been changed. The directory must be named sql (note lower/upper case spelling under Linux) since the installer searches the scripts there. The subdirectories and the files they contain are processed in alphabetic order. When using an Oracle database, subdirectories named ms-sql (and the files they contain) are ignored. When using an MSSQL database, subdirectories named oracle (and the files they contain) are ignored. Do not use this parameter without consulting PLANTA upfront.
alternative_migration_directory	An absolute path	Enables the use of an alternative directory for migration packets and the corresponding SQL files. The system expects all migration packets, not only those that have been changed. The directory must be named migration (note upper/lower case spelling under Linux) since the migration framework searches the scripts there. The directory structure below the specified directory must correspond exactly to the directory structure which is found in the original directory. Do not use this parameter without consulting PLANTA upfront.
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. The migration packets are identified by their path names starting at migration up to the file name of the migration packet (without .py ending). They must be separated by blank spaces and be in one line, e.g. like this: planta.migration_scripts_to_ignore=migration.server.S_39_5_18.wi16442_planta_de.FindCodeThatUsesPLANTADE migration.server.S_39_5_21.wi19185_dialog_module.PortNewDialogModuleParameters Do not use this parameter without consulting PLANTA upfront. At the moment, this parameter (Stand Server-HF21) does NOT work for packets in the after_db_import! migration directory
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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is deleted after the installation is finished. So please specify an explicit directory, which is not used by any other user.
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.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and restart the PLANTA installation (for further information on this topic, please refer to the documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

Post Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements

General

The installer provides the following functionalities:

• First installation
  • It contains the installation of all three components: PLANTA Database (PLANTA Standard), PLANTA Server, and PLANTA Client.
• Update
  • of individual components or
  • of all three components at once
    • The database, server, and client update by automatic installer is only a part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
      • Server update from 39.4.4.0 to 39.5.x
      • Server update from 39.5.x to 39.5.y
      • Client update
      • Database update
• Installation (update) on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation) (update).
• During the installation (update), a service that equates to the server process is installed. The name of the service can be specified in the name of the PLANTA server service parameter during the installation. Further information on the PLANTA server service .
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.

For a complete overview of the installation and update topics, please click here.

Attention

• If the installation (update) is not finished correctly by the installer, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• A particular Java version is not required as the PLANTA Server comes with its own Java version (Zulu). This has no influence on already existing Java versions on the system on which the PLANTA Server is installed.
• On Linux systems, rsync should be available.
• an Oracle or MSSQL database.

Notes

• The requirements described in the System Requirements topic must be met (including the PLANTA project user rights for Oracle databases described in there).
• The executing user must have profound knowledge in the required special fields and be logged on to the server as administrator (Windows) or root (Linux). On Windows, the installation can also be started by using the Run as administrator context menu.

CAUTION when updating to S 39.5.25

• If the update to Server 39.5.25 is to be part of a complete update including database update, the update must not be carried out in one step, but in two individual steps, as described below:
  1. First update the database to the last released DB version, DB 39.5.10 (db.install = yes and server.install = no).
  2. Subsequently update the Server to Release S 39.5.25 (db.install = no and server.install = yes).

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.

Installation (Update) Procedure

There are two installation modes: graphical GUI installation and automated console installation. Both options are available for both Windows and Linux.

Graphical GUI Installation

Procedure

• Run the install_planta_with_template.bat script (on Windows systems) or install_planta_with_template.sh script (on Linux systems).
• First choose the installation type (first installation or update).
  • First installation of Release 39.5
  • Update of an existing system
    • Update from Release 39.4.4.0 to Release 39.5.x (with DB 39.4) or
      • Source system: all three components are 39.4.4.0
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.x.
    • Update from Release 39.5.x (with DB 39.4)
      • Source system: DB is 39.4.4.0, S and C are 39.5.x
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.y.
    • Update from Release 39.5.x (with DB 39.5)
      • Source system: all three components are 39.5.x
      • Target system: here you can choose whether one individual component or all three components are to be updated.
    • Migrating from DB 39.4 to DB 39.5 with release 39.5.x
      • Source system: S and C 39.5.x
      • Target system: S and C will be updated to 39.5.y.
      • The existing DB 39.4.4.0 database version will be migrated to version 39.5.y.
• First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
• Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, please click here.
• Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.
• The path specification is done OS specifically (Windows/Linux).

Automated Console Installation

The automated console installation (or console mode) enables installation without graphical surface.

Procedure

• Edit the 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.
• An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
• In order to define whether a particular component is to be installed in the first place, please set the 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.
• Please note that paths are not separated by a simple but by a double backslash.
  • E.g. C:\\planta\\server instead of C:\planta\server
• Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
• Please wait now, while the installer automatically copies files to your system and runs scripts.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Installation Parameters

Information

• The Installer uses different parameters, via which the installation is controlled (for the installation or update procedure, please click here).
• The following table contains the possible value, which are explicitly specified during the automated console installation and selected and clicked on during the graphic GUI installation.

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. Reinstallation implies an installation of 39.5 (database and/or server).
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). This parameter is only of importance if an update is to be carried out and can be ignored otherwise.
DB log path	log.path	Client, server, database		A directory in which log files with information on installation and update are saved. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Start server after installation?	server.start_server	Client, server, database	"yes", "no"	Specifies whether the server is to be restarted automatically after successful installation. It may take some minutes until the server has been restarted completely and accepts the client connection.
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. This parameter is only relevant if a new database is to be installed. It will be ignored when updating an existing database.
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. If you use an MSSQL database with named instance, this instance comes with its own port number by default, which must be specified here.
Database name	db.name	Server, monitoring, database		In Oracle the SID, in MSSQL the database name. Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
Oracle Tablespace	db.tablespace	Database		Specifies to which oracle table space a new database user is to be assigned. This parameter is only relevant for reinstallations on an Oracle database during which a new user is to be created. For all other installation scenarios (update installation / reinstallation with MSSQL database / reinstallation with an already existing user), the parameter can be ignored.
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. This parameter is only relevant for MSSQL databases. Can be ignored for Oracle databases.
Database instance	db.instance	Server, monitoring, database		Name of the MSSQL instance, to which to connect. This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database		User for which the schema is to be installed. When reinstalling with a new user, it is the name of the user which is newly created. Otherwise it is the name of an already existing user. At the time of installation, there must be no synonyms for the database user (public or private). At runtime it is permitted. However, if data is to be imported at a later point in time (e.g. in the course of a DB update), the synonyms must be deactivated.
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. This parameter is only relevant if a new user is to be created and can be ignored otherwise
Database admin password	db.password_privileged	Database		Password of the new user. This parameter is only relevant if a new user is to be created and can be ignored otherwise
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 /config/hibernate.cfg.xml file) It is recommended to only apply this in case the database connection somehow differs from the standard. The connection string is composed of the db.type, db.server, db.name, db.user, db.port parameters internally by the installer, both (only for MSSQL) db.use_named_instance & db.instance. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, both (only for MSSQL) db.use_named_instance & db.instance parameters. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. The decision whether a migration is to be carried out is usually determined by a combination of the Installationsart and Updateart parameters and is preset accordingly. The Carry out migration? parameter should therefore not be changed. Note on the automated console installation: When selecting the "auto" value, the installer decides by the installation type selected whether a migration is carried out. yes and no overwrites this decision.
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). This parameter is only important for Venus installations and can otherwise be ignored. We urgently recommend that you activate this checkbox or leave the console parameter at "yes", since otherwise a database must be created in a new manner, which is not trivial.
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 This parameter is only of importance in Venus installations and can otherwise be ignored. It is urgently recommended that you activate this checkbox or leave the console parameter at "yes", since otherwise the data must be imported in another manner, which is not trivial.
Activate DB synonyms?	db.synonyms	Server	"yes", "no"	Specifies whether hibernate database synonyms are to be used or not. It is recommended to switch off synonyms since this improves performance.
Server IP address	SERVER_IP	Server, client	e.g. "192.168.10.20"	IP address of the PLANTA server. Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address.
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. This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server		Directory in which the PLANTA project server is to be installed. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server		Directory in which the former PLANTA project server is located. This parameter is only of importance if an update is to be carried out and can otherwise be ignored. In updates, some Python files from this path are copied to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. This parameter is ignored in Venus reinstallations, since here a new database with the respective current status is created. We urgently recommend that you activate this checkbox or leave the console parameter at "yes", since otherwise a database must be created in a new manner, which is not trivial.
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. This parameter should generally be activated or be left at the 'yes' default value (both for reinstallations as well as for update installations), since the migration framework itself decides when which migration packets are to be run. Note on the automated console installation: The old "auto" default value is obsolete and is now interpreted as "yes".
Name of the user group	server.user.group	Server, monitoring	e.g. "User"	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name "User".
Service user	service.user.name	Server, Database, Monitoring		Linux user to which the Linux installation belongs and which starts the PLANTA Server service. This parameter is only relevant for a new installation under Linux. It is used in the course of the installation of these users with sudo in order to start sub-processes (e.g. the migration)
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: hibernate.cfg.xml c3p0.min_size c3p0.max_size c3p0.timeout c3p0.numHelperThreads globals.conf parallel_sessions
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. It is quite possible to activate the web service documentation if the web services themselves are not 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. This is primarily a debug parameter. This coredump can possibly become quite large.
Path to the coredumps	debug.coredump_path	Server		Specifies whether a possible coredump is to be created (see Coredumps erstellen? parameter). This is primarily a debug parameter. You need write rights for this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client		Directory, in which the PLANTA project client is to be installed You must have right rights for this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. This value is set automatically if a port of the monitoring interface is specified and can usually be ignored.
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. Can be ignored if you do not install the monitoring component.
Monitoring Interface IP	planta.monitoring.interface	Server	e.g. "localhost", "192.168.10.20"	Specifies the IP-address of the monitoring component. This value is automatically set to "localhost" if a port of the monitoring interface is specified and can usually be ignored.
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. This parameter differs from planta.monitoring.port.
Monitoring directory	monitoring.path	Monitoring		Directory in which the monitoring component is to be installed. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring		Name of the service assigned to the monitoring component. This name must be unique for each PLANTA system. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether particular components are to be installed. They are only relevant for the automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • server.install: Specifies whether server specific steps are to be carried out. These are e.g.
    • Installation or update of the binary server files,
    • Minimum adjustments of the database for securing the server start (i.e. the migration packets of the Server component) and/or
    • Installation / update of server specific Python files.
      Possible values are "yes" or "no".
  • db.install: Specifies whether database specific steps are to be carried out. These are e.g.
    • Installation of a new database,
    • Update of existing database tables (i.e. for DB 39.4.4.0 with S 39.5.x the migration packets of the Customizing-Hotfix component, for DB 39.5.x those of the Customizing, After DB Import and Before DB Import components) and/or
    • Installation / update of customizing specific Python files.
      Possible values are "yes" or "no".
    • For an update with DB39.4.4.0 and S39.5.x, the db.install parameter must be set = yes.
  • monitoring.install: Specifies whether the monitoring component is to be installed to check the PLANTA Server.
    Possible values are "yes" or "no".
  • 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.
    Possible values are "yes" or "no".
  • client.install: Specifies whether a PLANTA client is to be installed.
    Possible values are "yes" or "no".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to the 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 /config/hibernate.cfg.xml file) It is recommended to only do that if the database connection somehow deviates from the standard. Normally, this parameter should not be set. In this case, the connection string is built internally by the installer from the db.type, db.server, db.name, db.user, db.port parameters, and (only for MSSQL) db.use_named_instance & db.instance. Model connection strings would be e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, and (only for MSSQL) db.use_named_instance & db.instance parameters.
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. The system expects all SQL scripts, not only those that have been changed. The directory must be named sql (note lower/upper case spelling under Linux) since the installer searches the scripts there. The subdirectories and the files they contain are processed in alphabetic order. When using an Oracle database, subdirectories named ms-sql (and the files they contain) are ignored. When using an MSSQL database, subdirectories named oracle (and the files they contain) are ignored. Do not use this parameter without consulting PLANTA upfront.
planta.alternative_migration_directory	An absolute path	Enables the use of an alternative directory for migration packets and the corresponding SQL files. The system expects all migration packets, not only those that have been changed. The directory must be named migration (note upper/lower case spelling under Linux) since the migration framework searches the scripts there. The directory structure below the specified directory must correspond exactly to the directory structure which is found in the original directory. Do not use this parameter without consulting PLANTA upfront.
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. The migration packets are identified by their path names starting at migration up to the file name of the migration packet (without .py ending). They must be separated by blank spaces and be in one line, e.g. like this: planta.migration_scripts_to_ignore=migration.server.S_39_5_18.wi16442_planta_de.FindCodeThatUsesPLANTADE migration.server.S_39_5_21.wi19185_dialog_module.PortNewDialogModuleParameters Do not use this parameter without consulting PLANTA upfront. At the moment, this parameter (Stand Server-HF21) does NOT work for packets in the after_db_import! migration directory
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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is deleted after the installation is finished. So please specify an explicit directory, which is not used by any other user.
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.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and restart the PLANTA installation (for further information on this topic, please refer to the documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

Post Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements

General

The installer provides the following functionalities:

• First installation
  • It contains the installation of all three components: PLANTA Database (PLANTA Standard), PLANTA Server, and PLANTA Client.
• Update
  • of individual components or
  • of all three components at once
    • The database, server, and client update by automatic installer is only a part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
      • Server update from 39.4.4.0 to 39.5.x
      • Server update from 39.5.x to 39.5.y
      • Client update
      • Database update
• Installation (update) on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation) (update).
• During the installation (update), a service that equates to the server process is installed. The name of the service can be specified in the name of the PLANTA server service parameter during the installation. Further information on the PLANTA server service .
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.

For a complete overview of the installation and update topics, please click here.

Attention

• If the installation (update) is not finished correctly by the installer, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• A particular Java version is not required as the PLANTA Server comes with its own Java version (Zulu). This has no influence on already existing Java versions on the system on which the PLANTA Server is installed.
• On Linux systems, rsync should be available.
• an Oracle or MSSQL database.

Notes

• The requirements described in the System Requirements topic must be met (including the PLANTA project user rights for Oracle databases described in there).
• The executing user must have profound knowledge in the required special fields and be logged on to the server as administrator (Windows) or root (Linux). On Windows, the installation can also be started by using the Run as administrator context menu.

Installation (Update) Procedure

There are two installation modes: graphical GUI installation and automated console installation. Both options are available for both Windows and Linux.

Graphical GUI Installation

Procedure

• Run the install_planta_with_template.bat script (on Windows systems) or install_planta_with_template.sh script (on Linux systems).
• First choose the installation type (first installation or update).
  • First installation of Release 39.5
  • Update of an existing system
    • Update from Release 39.4.4.0 to Release 39.5.x (with DB 39.4) or
      • Source system: all three components are 39.4.4.0
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.x.
    • Update from Release 39.5.x (with DB 39.4)
      • Source system: DB is 39.4.4.0, S and C are 39.5.x
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.y.
    • Update from Release 39.5.x (with DB 39.5)
      • Source system: all three components are 39.5.x
      • Target system: here you can choose whether one individual component or all three components are to be updated.
    • Migrating from DB 39.4 to DB 39.5 with release 39.5.x
      • Source system: S and C 39.5.x
      • Target system: S and C will be updated to 39.5.y.
      • The existing DB 39.4.4.0 database version will be migrated to version 39.5.y.
• First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
• Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, please click here.
• Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.
• The path specification is done OS specifically (Windows/Linux).

Automated Console Installation

The automated console installation (or console mode) enables installation without graphical surface.

Procedure

• Edit the 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.
• An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
• In order to define whether a particular component is to be installed in the first place, please set the 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.
• Please note that paths are not separated by a simple but by a double backslash.
  • E.g. C:\\planta\\server instead of C:\planta\server
• Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
• Please wait now, while the installer automatically copies files to your system and runs scripts.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Installation Parameters

Information

• The Installer uses different parameters, via which the installation is controlled (for the installation or update procedure, please click here).
• The following table contains the possible value, which are explicitly specified during the automated console installation and selected and clicked on during the graphic GUI installation.

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. Reinstallation implies an installation of 39.5 (database and/or server).
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). This parameter is only of importance if an update is to be carried out and can be ignored otherwise.
DB log path	log.path	Client, server, database		A directory in which log files with information on installation and update are saved. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Start server after installation?	server.start_server	Client, server, database	"yes", "no"	Specifies whether the server is to be restarted automatically after successful installation. It may take some minutes until the server has been restarted completely and accepts the client connection.
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. This parameter is only relevant if a new database is to be installed. It will be ignored when updating an existing database.
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. If you use an MSSQL database with named instance, this instance comes with its own port number by default, which must be specified here.
Database name	db.name	Server, monitoring, database		In Oracle the SID, in MSSQL the database name. Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
Oracle Tablespace	db.tablespace	Database		Specifies to which oracle table space a new database user is to be assigned. This parameter is only relevant for reinstallations on an Oracle database during which a new user is to be created. For all other installation scenarios (update installation / reinstallation with MSSQL database / reinstallation with an already existing user), the parameter can be ignored.
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. This parameter is only relevant for MSSQL databases. Can be ignored for Oracle databases.
Database instance	db.instance	Server, monitoring, database		Name of the MSSQL instance, to which to connect. This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database		User for which the schema is to be installed. When reinstalling with a new user, it is the name of the user which is newly created. Otherwise it is the name of an already existing user. At the time of installation, there must be no synonyms for the database user (public or private). At runtime it is permitted. However, if data is to be imported at a later point in time (e.g. in the course of a DB update), the synonyms must be deactivated.
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. This parameter is only relevant if a new user is to be created and can be ignored otherwise
Database admin password	db.password_privileged	Database		Password of the new user. This parameter is only relevant if a new user is to be created and can be ignored otherwise
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 /config/hibernate.cfg.xml file) It is recommended to only apply this in case the database connection somehow differs from the standard. The connection string is composed of the db.type, db.server, db.name, db.user, db.port parameters internally by the installer, both (only for MSSQL) db.use_named_instance & db.instance. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, both (only for MSSQL) db.use_named_instance & db.instance parameters. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. The decision whether a migration is to be carried out is usually determined by a combination of the Installationsart and Updateart parameters and is preset accordingly. The Carry out migration? parameter should therefore not be changed. Note on the automated console installation: When selecting the "auto" value, the installer decides by the installation type selected whether a migration is carried out. yes and no overwrites this decision.
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). This parameter is only important for Venus installations and can otherwise be ignored. We urgently recommend that you activate this checkbox or leave the console parameter at "yes", since otherwise a database must be created in a new manner, which is not trivial.
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 This parameter is only of importance in Venus installations and can otherwise be ignored. It is urgently recommended that you activate this checkbox or leave the console parameter at "yes", since otherwise the data must be imported in another manner, which is not trivial.
Activate DB synonyms? NEW	db.synonyms	Server	"yes", "no"	Specifies whether hibernate database synonyms are to be used or not. It is recommended to switch off synonyms since this improves performance.
Server IP address	SERVER_IP	Server, client	e.g. "192.168.10.20"	IP address of the PLANTA server. Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address.
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. This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server		Directory in which the PLANTA project server is to be installed. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server		Directory in which the former PLANTA project server is located. This parameter is only of importance if an update is to be carried out and can otherwise be ignored. In updates, some Python files from this path are copied to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. This parameter is ignored in Venus reinstallations, since here a new database with the respective current status is created. We urgently recommend that you activate this checkbox or leave the console parameter at "yes", since otherwise a database must be created in a new manner, which is not trivial.
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. This parameter should generally be activated or be left at the 'yes' default value (both for reinstallations as well as for update installations), since the migration framework itself decides when which migration packets are to be run. Note on the automated console installation: The old "auto" default value is obsolete and is now interpreted as "yes".
Name of the user group	server.user.group	Server, monitoring	e.g. "User"	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name "User".
Service user	service.user.name	Server, Database, Monitoring		Linux user to which the Linux installation belongs and which starts the PLANTA Server service. This parameter is only relevant for a new installation under Linux. It is used in the course of the installation of these users with sudo in order to start sub-processes (e.g. the migration)
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: hibernate.cfg.xml c3p0.min_size c3p0.max_size c3p0.timeout c3p0.numHelperThreads globals.conf parallel_sessions
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. It is quite possible to activate the web service documentation if the web services themselves are not 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. This is primarily a debug parameter. This coredump can possibly become quite large.
Path to the coredumps	debug.coredump_path	Server		Specifies whether a possible coredump is to be created (see Coredumps erstellen? parameter). This is primarily a debug parameter. You need write rights for this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client		Directory, in which the PLANTA project client is to be installed You must have right rights for this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. This value is set automatically if a port of the monitoring interface is specified and can usually be ignored.
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. Can be ignored if you do not install the monitoring component.
Monitoring Interface IP	planta.monitoring.interface	Server	e.g. "localhost", "192.168.10.20"	Specifies the IP-address of the monitoring component. This value is automatically set to "localhost" if a port of the monitoring interface is specified and can usually be ignored.
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. This parameter differs from planta.monitoring.port.
Monitoring directory	monitoring.path	Monitoring		Directory in which the monitoring component is to be installed. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring		Name of the service assigned to the monitoring component. This name must be unique for each PLANTA system. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether particular components are to be installed. They are only relevant for the automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • server.install: Specifies whether server specific steps are to be carried out. These are e.g.
    • Installation or update of the binary server files,
    • Minimum adjustments of the database for securing the server start (i.e. the migration packets of the Server component) and/or
    • Installation / update of server specific Python files.
      Possible values are "yes" or "no".
  • db.install: Specifies whether database specific steps are to be carried out. These are e.g.
    • Installation of a new database,
    • Update of existing database tables (i.e. for DB 39.4.4.0 with S 39.5.x the migration packets of the Customizing-Hotfix component, for DB 39.5.x those of the Customizing, After DB Import and Before DB Import components) and/or
    • Installation / update of customizing specific Python files.
      Possible values are "yes" or "no".
    • For an update with DB39.4.4.0 and S39.5.x, the db.install parameter must be set = yes.
  • monitoring.install: Specifies whether the monitoring component is to be installed to check the PLANTA Server.
    Possible values are "yes" or "no".
  • 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.
    Possible values are "yes" or "no".
  • client.install: Specifies whether a PLANTA client is to be installed.
    Possible values are "yes" or "no".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to the 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 /config/hibernate.cfg.xml file) It is recommended to only do that if the database connection somehow deviates from the standard. Normally, this parameter should not be set. In this case, the connection string is built internally by the installer from the db.type, db.server, db.name, db.user, db.port parameters, and (only for MSSQL) db.use_named_instance & db.instance. Model connection strings would be e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, and (only for MSSQL) db.use_named_instance & db.instance parameters.
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. The system expects all SQL scripts, not only those that have been changed. The directory must be named sql (note lower/upper case spelling under Linux) since the installer searches the scripts there. The subdirectories and the files they contain are processed in alphabetic order. When using an Oracle database, subdirectories named ms-sql (and the files they contain) are ignored. When using an MSSQL database, subdirectories named oracle (and the files they contain) are ignored. Do not use this parameter without consulting PLANTA upfront.
planta.alternative_migration_directory	An absolute path	Enables the use of an alternative directory for migration packets and the corresponding SQL files. The system expects all migration packets, not only those that have been changed. The directory must be named migration (note upper/lower case spelling under Linux) since the migration framework searches the scripts there. The directory structure below the specified directory must correspond exactly to the directory structure which is found in the original directory. Do not use this parameter without consulting PLANTA upfront.
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. The migration packets are identified by their path names starting at migration up to the file name of the migration packet (without .py ending). They must be separated by blank spaces and be in one line, e.g. like this: planta.migration_scripts_to_ignore=migration.server.S_39_5_18.wi16442_planta_de.FindCodeThatUsesPLANTADE migration.server.S_39_5_21.wi19185_dialog_module.PortNewDialogModuleParameters Do not use this parameter without consulting PLANTA upfront. At the moment, this parameter (Stand Server-HF21) does NOT work for packets in the after_db_import! migration directory
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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is deleted after the installation is finished. So please specify an explicit directory, which is not used by any other user.
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.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and restart the PLANTA installation (for further information on this topic, please refer to the documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

Post Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements

General

The installer provides the following functionalities:

• First installation
  • It contains the installation of all three components: PLANTA Database (PLANTA Standard), PLANTA Server, and PLANTA Client.
• Update
  • of individual components or
  • of all three components at once
    • The database, server, and client update by automatic installer is only a part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
      • Server update from 39.4.4.0 to 39.5.x
      • Server update from 39.5.x to 39.5.y
      • Client update
      • Database update
• Installation (update) on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation) (update).
• During the installation (update), a service that equates to the server process is installed. The name of the service can be specified in the name of the PLANTA server service parameter during the installation. Further information on the PLANTA server service .
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.

For a complete overview of the installation and update topics, please click here.

Attention

• If the installation (update) is not finished correctly by the installer, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• A particular Java version is not required as the PLANTA Server comes with its own Java version (Zulu). This has no influence on already existing Java versions on the system on which the PLANTA Server is installed.
• On Linux systems, rsync should be available.
• an Oracle or MSSQL database.

Notes

• The requirements described in the System Requirements topic must be met (including the PLANTA project user rights for Oracle databases described in there).
• The executing user must have profound knowledge in the required special fields and be logged on to the server as administrator (Windows) or root (Linux). On Windows, the installation can also be started by using the Run as administrator context menu.

Installation (Update) Procedure

There are two installation modes: graphical GUI installation and automated console installation. Both options are available for both Windows and Linux.

Graphical GUI Installation

Procedure

• Run the install_planta_with_template.bat script (on Windows systems) or install_planta_with_template.sh script (on Linux systems).
• First choose the installation type (first installation or update).
  • First installation of Release 39.5
  • Update of an existing system
    • Update from Release 39.4.4.0 to Release 39.5.x (with DB 39.4) or
      • Source system: all three components are 39.4.4.0
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.x.
    • Update from Release 39.5.x (with DB 39.4)
      • Source system: DB is 39.4.4.0, S and C are 39.5.x
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.y.
    • Update from Release 39.5.x (with DB 39.5)
      • Source system: all three components are 39.5.x
      • Target system: here you can choose whether one individual component or all three components are to be updated.
    • Migrating from DB 39.4 to DB 39.5 with release 39.5.x
      • Source system: S and C 39.5.x
      • Target system: S and C will be updated to 39.5.y.
      • The existing DB 39.4.4.0 database version will be migrated to version 39.5.y.
• First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
• Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, please click here.
• Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.
• The path specification is done OS specifically (Windows/Linux).

Automated Console Installation

The automated console installation (or console mode) enables installation without graphical surface.

Procedure

• Edit the 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.
• An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
• In order to define whether a particular component is to be installed in the first place, please set the 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.
• Please note that paths are not separated by a simple but by a double backslash.
  • E.g. C:\\planta\\server instead of C:\planta\server
• Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
• Please wait now, while the installer automatically copies files to your system and runs scripts.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Installation Parameters

Information

• The Installer uses different parameters, via which the installation is controlled (for the installation or update procedure, please click here).
• The following table contains the possible value, which are explicitly specified during the automated console installation and selected and clicked on during the graphic GUI installation.

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. Reinstallation implies an installation of 39.5 (database and/or server).
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). This parameter is only of importance if an update is to be carried out and can be ignored otherwise.
DB log path	log.path	Client, server, database		A directory in which log files with information on installation and update are saved. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Start server after installation?	server.start_server	Client, server, database	"yes", "no"	Specifies whether the server is to be restarted automatically after successful installation. It may take some minutes until the server has been restarted completely and accepts the client connection.
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. This parameter is only relevant if a new database is to be installed. It will be ignored when updating an existing database.
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. If you use an MSSQL database with named instance, this instance comes with its own port number by default, which must be specified here.
Database name	db.name	Server, monitoring, database		In Oracle the SID, in MSSQL the database name. Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
Oracle Tablespace	db.tablespace	Database		Specifies to which oracle table space a new database user is to be assigned. This parameter is only relevant for reinstallations on an Oracle database during which a new user is to be created. For all other installation scenarios (update installation / reinstallation with MSSQL database / reinstallation with an already existing user), the parameter can be ignored.
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. This parameter is only relevant for MSSQL databases. Can be ignored for Oracle databases.
Database instance	db.instance	Server, monitoring, database		Name of the MSSQL instance, to which to connect. This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database		User for which the schema is to be installed. When reinstalling with a new user, it is the name of the user which is newly created. Otherwise it is the name of an already existing user. At the time of installation, there must be no synonyms for the database user (public or private). At runtime it is permitted. However, if data is to be imported at a later point in time (e.g. in the course of a DB update), the synonyms must be deactivated.
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. This parameter is only relevant if a new user is to be created and can be ignored otherwise
Database admin password	db.password_privileged	Database		Password of the new user. This parameter is only relevant if a new user is to be created and can be ignored otherwise
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 /config/hibernate.cfg.xml file) It is recommended to only apply this in case the database connection somehow differs from the standard. The connection string is composed of the db.type, db.server, db.name, db.user, db.port parameters internally by the installer, both (only for MSSQL) db.use_named_instance & db.instance. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, both (only for MSSQL) db.use_named_instance & db.instance parameters. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. When selecting the "auto" value, the installer decides on the basis of the selected installation type, whether a migration is carried out. yes and no overwrites this decision.
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). This parameter is only important for Venus installations and can otherwise be ignored. We urgently recommend that you activate this checkbox or leave the console parameter at "yes", since otherwise a database must be created in a new manner, which is not trivial.
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 This parameter is only of importance in Venus installations and can otherwise be ignored. It is urgently recommended that you activate this checkbox or leave the console parameter at "yes", since otherwise the data must be imported in another manner, which is not trivial.
Server IP address	SERVER_IP	Server, client	e.g. "192.168.10.20"	IP address of the PLANTA server. Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address.
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. This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server		Directory in which the PLANTA project server is to be installed. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server		Directory in which the former PLANTA project server is located. This parameter is only of importance if an update is to be carried out and can otherwise be ignored. In updates, some Python files from this path are copied to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. This parameter is ignored in Venus reinstallations, since here a new database with the respective current status is created. We urgently recommend that you activate this checkbox or leave the console parameter at "yes", since otherwise a database must be created in a new manner, which is not trivial.
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. Note on the automated console installation: If the auto value is selected, the installer decides whether a migration is carried out depending on the selected installation type. "yes" and "no" overwrites this decision.
Name of the user group	server.user.group	Server, monitoring	e.g. "User"	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name "User".
Service user	service.user.name	Server, Database, Monitoring		Linux user to which the Linux installation belongs and which starts the PLANTA Server service. This parameter is only relevant for a new installation under Linux. It is used in the course of the installation of these users with sudo in order to start sub-processes (e.g. the migration)
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: hibernate.cfg.xml c3p0.min_size c3p0.max_size c3p0.timeout c3p0.numHelperThreads globals.conf parallel_sessions
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. It is quite possible to activate the web service documentation if the web services themselves are not 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. This is primarily a debug parameter. This coredump can possibly become quite large.
Path to the coredumps	debug.coredump_path	Server		Specifies whether a possible coredump is to be created (see Coredumps erstellen? parameter). This is primarily a debug parameter. You need write rights for this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client		Directory, in which the PLANTA project client is to be installed You must have right rights for this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. This value is set automatically if a port of the monitoring interface is specified and can usually be ignored.
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. Can be ignored if you do not install the monitoring component.
Monitoring Interface IP	planta.monitoring.interface	Server	e.g. "localhost", "192.168.10.20"	Specifies the IP-address of the monitoring component. This value is automatically set to "localhost" if a port of the monitoring interface is specified and can usually be ignored.
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. This parameter differs from planta.monitoring.port.
Monitoring directory	monitoring.path	Monitoring		Directory in which the monitoring component is to be installed. You must have write rights on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring		Name of the service assigned to the monitoring component. This name must be unique for each PLANTA system. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether particular components are to be installed. They are only relevant for the automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • server.install: Specifies whether server specific steps are to be carried out. These are e.g.
    • Installation or update of the binary server files,
    • Minimum adjustments of the database for securing the server start (i.e. the migration packets of the Server component) and/or
    • Installation / update of server specific Python files.
      Possible values are "yes" or "no".
  • db.install: Specifies whether database specific steps are to be carried out. These are e.g.
    • Installation of a new database,
    • Update of existing database tables (i.e. for DB 39.4.4.0 with S 39.5.x the migration packets of the Customizing-Hotfix component, for DB 39.5.x those of the Customizing, After DB Import and Before DB Import components) and/or
    • Installation / update of customizing specific Python files.
      Possible values are "yes" or "no".
    • For an update with DB39.4.4.0 and S39.5.x, the db.install parameter must be set = yes.
  • monitoring.install: Specifies whether the monitoring component is to be installed to check the PLANTA Server.
    Possible values are "yes" or "no".
  • 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.
    Possible values are "yes" or "no".
  • client.install: Specifies whether a PLANTA client is to be installed.
    Possible values are "yes" or "no".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to the 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 /config/hibernate.cfg.xml file) It is recommended to only do that if the database connection somehow deviates from the standard. Normally, this parameter should not be set. In this case, the connection string is built internally by the installer from the db.type, db.server, db.name, db.user, db.port parameters, and (only for MSSQL) db.use_named_instance & db.instance. Model connection strings would be e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, and (only for MSSQL) db.use_named_instance & db.instance parameters.
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. The system expects all SQL scripts, not only those that have been changed. The directory must be named sql (note lower/upper case spelling under Linux) since the installer searches the scripts there. The subdirectories and the files they contain are processed in alphabetic order. When using an Oracle database, subdirectories named ms-sql (and the files they contain) are ignored. When using an MSSQL database, subdirectories named oracle (and the files they contain) are ignored. Do not use this parameter without consulting PLANTA upfront.
planta.alternative_migration_directory	An absolute path	Enables the use of an alternative directory for migration packets and the corresponding SQL files. The system expects all migration packets, not only those that have been changed. The directory must be named migration (note upper/lower case spelling under Linux) since the migration framework searches the scripts there. The directory structure below the specified directory must correspond exactly to the directory structure which is found in the original directory. Do not use this parameter without consulting PLANTA upfront.
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. The migration packets are identified by their path names starting at migration up to the file name of the migration packet (without .py ending). They must be separated by blank spaces and be in one line, e.g. like this: planta.migration_scripts_to_ignore=migration.server.S_39_5_18.wi16442_planta_de.FindCodeThatUsesPLANTADE migration.server.S_39_5_21.wi19185_dialog_module.PortNewDialogModuleParameters Do not use this parameter without consulting PLANTA upfront. At the moment, this parameter (Stand Server-HF21) does NOT work for packets in the after_db_import! migration directory
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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is deleted after the installation is finished. So please specify an explicit directory, which is not used by any other user.
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.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and restart the PLANTA installation (for further information on this topic, please refer to the documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

Post Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements

General

The installer provides the following functionalities:

• First installation
  • It contains the installation of all three components: PLANTA Database (PLANTA Standard), PLANTA Server, and PLANTA Client.
• Update
  • of individual components or
  • of all three components at once
    • The database, server, and client update by automatic installer is only a part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
      • Server update from 39.4.4.0 to 39.5.x
      • Server update from 39.5.x to 39.5.y
      • Client update
      • Database update
• Installation (update) on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation) (update).
• During the installation (update), a service that equates to the server process is installed. The name of the service can be specified in the name of the PLANTA server service parameter during the installation. Further information on the PLANTA server service .
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.

For a complete overview of the installation and update topics, please click here.

Attention

• If the installation (update) is not finished correctly by the installer, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• A particular Java version is not required as the PLANTA Server comes with its own Java version (Zulu). This has no influence on already existing Java versions on the system on which the PLANTA Server is installed.
• On Linux systems, rsync should be available.
• an Oracle or MSSQL database.

Notes

• The requirements described in the System Requirements topic must be met (including the PLANTA project user rights for Oracle databases described in there).
• The executing user must have profound knowledge in the required special fields and be logged on to the server as administrator (Windows) or root (Linux). NEW Under Windows, the installation can also be launched via the Run as administrator context menu.

Installation Procedure (Update)

There are two installation modes: graphical GUI installation and automated console installation. Both options are available for both Windows and Linux.

Graphical GUI Installation

Procedure

• Run the install_planta_with_template.bat script (on Windows systems) or install_planta_with_template.sh script (on Linux systems).
• First choose the installation type (first installation or update).
  • First installation of Release 39.5
  • Update of an existing system
    • Update from Release 39.4.4.0 to Release 39.5.x (with DB 39.4) or
      • Source system: all three components are 39.4.4.0
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.x.
    • Update from Release 39.5.x (with DB 39.4)
      • Source system: DB is 39.4.4.0, S and C are 39.5.x
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.y.
    • Update from Release 39.5.x (with DB 39.5)
      • Source system: all three components are 39.5.x
      • Target system: here you can choose whether one individual component or all three components are to be updated.
    • Migrating from DB 39.4 to DB 39.5 with release 39.5.x
      • Source system: S and C 39.5.x
      • Target system: S and C will be updated to 39.5.y.
      • The existing DB 39.4.4.0 database version will be migrated to version 39.5.y.
• First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
• Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, please click here.
• Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.
• The path specification is done OS specifically (Windows/Linux).

Automated Console Installation

The automated console installation (or console mode) enables installation without graphical surface.

Procedure

• Edit the 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.
• An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
• In order to define whether a particular component is to be installed in the first place, please set the 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.
• Please note that paths are not separated by a simple but by a double backslash.
  • E.g. C:\\planta\\server instead of C:\planta\server
• Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
• Please wait now, while the installer automatically copies files to your system and runs scripts.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Installation Parameter

Information

• The Installer uses different parameters, via which the installation is controlled (for the installation or update procedure, please click here).
• The following table contains the possible value, which are explicitly specified during the automated console installation and selected and clicked on during the graphic GUI installation.

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 Attention: Reinstallation implicitly means an installation of 39.5 (database and/or server).
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). Attention: This parameter is only relevant if an update is to be carried out and can be ignored otherwise
DB log path	log.path	Client, server, database		A directory in which log files with information on installation and update are saved. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Start server after installation?	server.start_server	Client, server, database	"yes", "no"	Specifies whether the server is to be restarted automatically after successful installation. Note: It may take some minutes until the server has been restarted completely and accepts the client connection.
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. Attention: This parameter is relevant if a new database is to be installed. It will be ignored when updating an existing database.
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. Note: If you use an MSSQL database with named instance, this instance comes with its own port number by default, which has to be specified here.
Database name	db.name	Server, monitoring, database		In Oracle the SID, in MSSQL the database name. Attention: Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
Oracle Tablespace	db.tablespace	Database		Specifies to which oracle table space a new database user is to be assigned. Note: This parameter is only relevant for reinstallations on an Oracle database during which a new user is to be created. For all other installation scenarios (update installation / reinstallation with MSSQL database / reinstallation with an already existing user), the parameter can be ignored.
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. Note: This parameter is only relevant for MSSQL databases. Can be ignored for Oracle databases.
Database instance	db.instance	Server, monitoring, database		Name of the MSSQL instance, to which to connect. Note: This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database		User for which the schema is to be installed. Attention: When reinstalling with a new user, it is the name of the newly created user. Otherwise, it is the name of an already existing user.
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. Note: This parameter is only relevant if a new user is to be created, and can be ignored otherwise
Database admin password	db.password_privileged	Database		Password of the new user. Note: This parameter is only relevant if a new user is to be created, and can be ignored otherwise
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 /config/hibernate.cfg.xml file) It is recommended to only apply this in case the database connection somehow differs from the standard. The connection string is composed of the db.type, db.server, db.name, db.user, db.port parameters internally by the installer, both (only for MSSQL) db.use_named_instance & db.instance. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, both (only for MSSQL) db.use_named_instance & db.instance parameters. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. Note: 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. Hinweis If the auto value is selected, the installer decides whether a migration is carried out depending on the selected installation type. yes and no overwrites this decision.
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). Attention: This parameter is only relevant for Venus installations and can be ignored otherwise. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise a database must be created in a new manner, which is not trivial.
Load data?	db.load_data	Database	"yes", "no"	Specifies for database installations whether the standard customizing data is to be imported by PLANTA. Attention: This parameter is only relevant for Venus installations and can be ignored otherwise. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes", since otherwise the data must be imported in another way, which is not trivial.
Server IP address	SERVER_IP	Server, client	e.g. "192.168.10.20"	IP address of the PLANTA server. Attention: Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address.
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. Attention: This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server		Directory in which the PLANTA project server is to be installed. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server		Directory in which the old PLANTA project server is located Attention: This parameter is only relevant if an update installation is to be carried out and can be ignored otherwise. Note: In updates, some Python files are copied from this path to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. Attention: This parameter is ignored in Venus reinstallations since here a new database with the current status from time to time is created. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise the respective scripts must be run manually, which is not trivial.
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. Note: 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. Note on the automated console installation: If the auto value is selected, the installer decides whether a migration is carried out depending on the selected installation type. "yes" and "no" overwrites this decision.
Name of the user group	server.user.group	Server, monitoring	e.g. "User"	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name "User".
Service user	server.user.name	Server, monitoring		Linux user to which the Linux installation belongs and that starts the PLANTA Server service Note: This parameter is only relevant for installations under Linux
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: hibernate.cfg.xml c3p0.min_size c3p0.max_size c3p0.timeout c3p0.numHelperThreads globals.conf parallel_sessions
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. Note: It is quite possible to activate the web service documentation if the web services themselves are not 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. Note: This is primarily a debug parameter: A higher number leads to more information on the system being protocoled, but it may also impair runtime.
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. Note: This is primarily a debug parameter: This coredump can possibly become quite large.
Path to coredumps	debug.coredump_path	Server		Specifies, where a possible coredump is to be created (see the create coredumps? parameter ) Note: This is primarily a debug parameter. You must possess write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client		Directory, in which the PLANTA project client is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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 Note: This value is set automatically if a port of the monitoring interface is specified and can usually be ignored.
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. Note: Can be ignored if you do not install the monitoring component
Monitoring interface IP	planta.monitoring.interface	Server	e.g. "localhost", "192.168.10.20"	Specifies the IP address of the monitoring component Note: This value is automatically set to "localhost" if a port of the monitoring interface is specified and can usually be ignored.
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. Note: This parameter differs from planta.monitoring.port.
Monitoring directory	monitoring.path	Monitoring		Directory in which the monitoring component is to be installed. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring		Name of the service assigned to the monitoring component. Attention: This name must be unique for each monitoring component. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether particular components are to be installed. They are only relevant for the automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • server.install: Specifies whether server specific steps are to be carried out. These are e.g.
    • Installation or update of the binary server files,
    • Minimum adjustments of the database for securing the server start (i.e. the migration packets of the Server component) and/or
    • Installation / update of server specific Python files.
      Possible values are "yes" or "no".
  • db.install: Specifies whether database specific steps are to be carried out. These are e.g.
    • Installation of a new database,
    • Update of existing database tables (i.e. for DB 39.4.4.0 with S 39.5.x the migration packets of the Customizing-Hotfix component, for DB 39.5.x those of the Customizing, After DB Import and Before DB Import components) and/or
    • Installation / update of customizing specific Python files.
      Possible values are "yes" or "no".
    • For an update with DB39.4.4.0 and S39.5.x, the db.install parameter must be set = yes.
  • monitoring.install: Specifies whether the monitoring component is to be installed to check the PLANTA Server.
    Possible values are "yes" or "no".
  • NEW 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.
    Possible values are "yes" or "no".
  • client.install: Specifies whether a PLANTA client is to be installed.
    Possible values are "yes" or "no".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to the 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 /config/hibernate.cfg.xml file) It is recommended to only do that if the database connection somehow deviates from the standard. Normally, this parameter should not be set. In this case, the connection string is built internally by the installer from the db.type, db.server, db.name, db.user, db.port parameters, and (only for MSSQL) db.use_named_instance & db.instance. Model connection strings would be e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, and (only for MSSQL) db.use_named_instance & db.instance parameters.
planta.alternative_migration_directory	An absolute path	Enables the use of an alternative directory for migration packets and the corresponding SQL files. The system expects all migration packets, not only those that have been changed. The directory structure below the specified directory must correspond exactly to the directory structure found in the original directory (for the migration packets this is "python/migration" and for the SQL files of the installer this is "PlantaServer/sql"). Do not use this parameter without consulting PLANTA upfront.
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. The migration packets are identified by their path names starting at migration up to the file name of the migration packet (without .py ending). They must be separated by blank spaces and be in one line, e.g. like this: planta.migration_scripts_to_ignore=migration.server.S_39_5_18.wi16442_planta_de.FindCodeThatUsesPLANTADE migration.server.S_39_5_21.wi19185_dialog_module.PortNewDialogModuleParameters Do not use this parameter without consulting PLANTA upfront.
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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is deleted after the installation is finished. So please specify an explicit directory, which is not used by any other user.
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.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and restart the PLANTA installation (for further information on this topic, please refer to the documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

After Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements

General

The installer provides the following functionalities:

• First installation
  • It contains the installation of all three components: PLANTA Database (PLANTA Standard), PLANTA Server, and PLANTA Client.
• Update
  • of individual components or
  • of all three components at once
    • The database, server, and client update by automatic installer is only a part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
      • Server update from 39.4.4.0 to 39.5.x
      • Server update from 39.5.x to 39.5.y
      • Client update
      • Database update
• Installation (update) on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation) (update).
• During the installation (update), a service that equates to the server process is installed. The name of the service can be specified in the name of the PLANTA server service parameter during the installation. Further information on the PLANTA server service .
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.

For a complete overview of the installation and update topics, please click here.

Attention

• If the installation (update) is not finished correctly by the installer, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• NEW A particular Java version is not required since the PLANTA server comes with its own Java version (Zulu). This has no influence on already existing Java versions on the system on which the PLANTA Server is installed.
• Java version (JDK/Server JRE) 1.7.x 64-bit or 1.8.x 64-bit (otherwise the PLANTA Server cannot be started)
  • When using Server JRE or Linux systems, the following environment variables must be set in addition:
    • 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)
  • Also required for Java JDK:
    • JAVA_HOME (e.g. C:\java\jdk1.7.0_80)
• In Linux systems, rsync should be available.
• an Oracle or MSSQL database.

Notes

• The requirements described in the System Requirements topic must be met (including the PLANTA project user rights for Oracle databases described in there).
• The executing user must have profound knowledge in the required special fields and be logged on to the server as administrator (Windows) or root (Linux).

Installation (Update) Procedure

There are two installation modes: graphical GUI installation and automated console installation. Both options are available for both Windows and Linux.

Graphical GUI Installation

Procedure

• Run the install_planta_with_template.bat script (on Windows systems) or install_planta_with_template.sh script (on Linux systems).
• First choose the installation type (first installation or update).
  • First installation of Release 39.5
  • Update of an existing system
    • Update from Release 39.4.4.0 to Release 39.5.x (with DB 39.4) or
      • Source system: all three components are 39.4.4.0
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.x.
    • Update from Release 39.5.x (with DB 39.4)
      • Source system: DB is 39.4.4.0, S and C are 39.5.x
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.y.
    • Update from Release 39.5.x (with DB 39.5)
      • Source system: all three components are 39.5.x
      • Target system: here you can choose whether one individual component or all three components are to be updated.
    • Migrating from DB 39.4 to DB 39.5 with release 39.5.x
      • Source system: S and C 39.5.x
      • Target system: S and C will be updated to 39.5.y.
      • The existing DB 39.4.4.0 database version will be migrated to version 39.5.y.
• First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
• Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, please click here.
• Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.
• The path specification is done OS specifically (Windows/Linux).

Automated Console Installation

The automated console installation (or console mode) enables installation without graphical surface.

Procedure

• Edit the 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.
• An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
• In order to define whether a particular component is to be installed in the first place, please set the db.install, server.install and client.install parameters to yes or no, whereas client.install is only available on Windows systems.
• Please note that paths are not separated by a simple but by a double backslash.
  • E.g. C:\\planta\\server instead of C:\planta\server
• Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
• Please wait now, while the installer automatically copies files to your system and runs scripts.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Installation Parameters

Information

• The Installer uses different parameters, via which the installation is controlled (for the installation or update procedure, please click here).
• The following table contains the possible value, which are explicitly specified during the automated console installation and selected and clicked on during the graphic GUI installation.

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 Attention: Reinstallation implicitly means an installation of 39.5 (database and/or server).
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). Attention: This parameter is only relevant if an update is to be carried out and can be ignored otherwise
DB log path	log.path	Client, server, database		A directory in which log files with information on installation and update are saved. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Start server after installation?	server.start_server	Client, server, database	"yes", "no"	Specifies whether the server is to be restarted automatically after successful installation. Note: It may take some minutes until the server has been restarted completely and accepts the client connection.
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. Attention: This parameter is relevant if a new database is to be installed. It will be ignored when updating an existing database.
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. Attention: Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
Oracle Tablespace	db.tablespace	Database		Specifies to which oracle table space a new database user is to be assigned. Note: This parameter is only relevant for reinstallations on an Oracle database during which a new user is to be created. For all other installation scenarios (update installation / reinstallation with MSSQL database / reinstallation with an already existing user), the parameter can be ignored.
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. Note: This parameter is only relevant for MSSQL databases. Can be ignored for Oracle databases.
Database instance	db.instance	Server, monitoring, database		Name of the MSSQL instance, to which to connect. Note: This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database		User for which the schema is to be installed. Attention: When reinstalling with a new user, it is the name of the newly created user. Otherwise, it is the name of an already existing user.
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. Note: This parameter is only relevant if a new user is to be created, and can be ignored otherwise
Database admin password	db.password_privileged	Database		Password of the new user. Note: This parameter is only relevant if a new user is to be created, and can be ignored otherwise
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 /config/hibernate.cfg.xml file) It is recommended to only apply this in case the database connection somehow differs from the standard. The connection string is composed of the db.type, db.server, db.name, db.user, db.port parameters internally by the installer, both (only for MSSQL) db.use_named_instance & db.instance. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. This string should be identical to the connection string of db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, both (only for MSSQL) db.use_named_instance & db.instance parameters. Note on automatic console installation: Since this is an advanced or non-recommended option, this parameter does not exist in the Standard properties file and must be added manually if desired. For this purpose, see the Additional parameters section below.
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. Note: 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. Hinweis If the auto value is selected, the installer decides whether a migration is carried out depending on the selected installation type. yes and no overwrites this decision.
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). Attention: This parameter is only relevant for Venus installations and can be ignored otherwise. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise a database must be created in a new manner, which is not trivial.
Load data?	db.load_data	Database	"yes", "no"	Specifies for database installations whether the standard customizing data is to be imported by PLANTA. Attention: This parameter is only relevant for Venus installations and can be ignored otherwise. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes", since otherwise the data must be imported in another way, which is not trivial.
Server IP address	SERVER_IP	Server, client	e.g. "192.168.10.20"	IP address of the PLANTA server. Attention: Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address.
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. Attention: This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server		Directory in which the PLANTA project server is to be installed. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server		Directory in which the old PLANTA project server is located Attention: This parameter is only relevant if an update installation is to be carried out and can be ignored otherwise. Note: In updates, some Python files are copied from this path to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. Attention: This parameter is ignored in Venus reinstallations since here a new database with the current status from time to time is created. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise the respective scripts must be run manually, which is not trivial.
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. Note: 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. Note on the automated console installation: If the auto value is selected, the installer decides whether a migration is carried out depending on the selected installation type. "yes" and "no" overwrites this decision.
Name of the user group	server.user.group	Server, monitoring	e.g. "User"	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name "User".
Service user	server.user.name	Server, monitoring		Linux user to which the Linux installation belongs and that starts the PLANTA Server service Note: This parameter is only relevant for installations under Linux
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: hibernate.cfg.xml c3p0.min_size c3p0.max_size c3p0.timeout c3p0.numHelperThreads globals.conf parallel_sessions
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. Note: It is quite possible to activate the web service documentation if the web services themselves are not 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. Note: This is primarily a debug parameter: A higher number leads to more information on the system being protocoled, but may impair the runtime.
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. Note: This is primarily a debug parameter: This coredump can possibly become quite large.
Path to coredumps	debug.coredump_path	Server		Specifies, where a possible coredump is to be created (see the create coredumps? parameter ) Note: This is primarily a debug parameter. You must possess write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client		Directory, in which the PLANTA project client is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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 Note: This value is set automatically if a port of the monitoring interface is specified and can usually be ignored.
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. Note: Can be ignored if you do not install the monitoring component
Monitoring interface IP	planta.monitoring.interface	Server	e.g. "localhost", "192.168.10.20"	Specifies the IP address of the monitoring component Note: This value is automatically set to "localhost" if a port of the monitoring interface is specified and can usually be ignored.
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. Note: This parameter differs from planta.monitoring.port.
Monitoring directory	monitoring.path	Monitoring		Directory in which the monitoring component is to be installed. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring		Name of the service assigned to the monitoring component. Attention: This name must be unique for each monitoring component. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether a database, a server, or a client is to be installed. They are only relevant for the automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • server.install: Specifies whether server specific steps are to be carried out. These are e.g.
    • Installation or update of the binary server files,
    • Minimum adjustments of the database for securing the server start (i.e. the migration packets of the Server component) and/or
    • Installation / update of server specific Python files.
      Possible values are "yes" or "no".
  • db.install: Specifies whether database specific steps are to be carried out. These are e.g.
    • Installation of a new database,
    • Update of existing database tables (i.e. for DB 39.4.4.0 with S 39.5.x the migration packets of the Customizing-Hotfix component, for DB 39.5.x those of the Customizing, After DB Import and Before DB Import components) and/or
    • Installation / update of customizing specific Python files.
      Possible values are "yes" or "no".
    • For an update with DB39.4.4.0 and S39.5.x, the db.install parameter must be set = yes.
  • client.install: Specifies whether a PLANTA client is to be installed.
    Possible values are "yes" or "no".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to the 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 /config/hibernate.cfg.xml file) It is recommended to only do that if the database connection somehow deviates from the standard. Normally, this parameter should not be set. In this case, the connection string is built internally by the installer from the db.type, db.server, db.name, db.user, db.port parameters, and (only for MSSQL) db.use_named_instance & db.instance. Model connection strings would be e.g. jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433
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. This string should be identical to the connection string from db.manual_connection_string. This string should especially be specified if db.manual_connection_string has been specified. Otherwise the installer will try to build the login string from the db.type, db.server, db.name, db.user, db.port, and (only for MSSQL) db.use_named_instance & db.instance parameters.
planta.alternative_migration_directory	An absolute path	Enables the use of an alternative directory for migration packets and the corresponding SQL files. The system expects all migration packets, not only those that have been changed. The directory structure below the specified directory must correspond exactly to the directory structure found in the original directory (for the migration packets this is "python/migration" and for the SQL files of the installer this is "PlantaServer/sql"). Do not use this parameter without consulting PLANTA upfront.
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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is deleted after the installation is finished. So please specify an explicit directory, which is not used by any other user.
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.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and restart the PLANTA installation (for further information on this topic, please refer to the documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

Post Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements

General

The installer provides the following functionalities:

• First installation
  • NEW It contains the installation of all three components: PLANTA Database (PLANTA Standard), PLANTA Server, and PLANTA Client.
• Update
  • of individual components or
  • NEW of all three components at once
    • The database, server, and client update by automatic installer is only a part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
      • Server update from 39.4.4.0 to 39.5.x
      • Server update from 39.5.x to 39.5.y
      • Client update
      • NEW Database Update
• Installation (update) on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation) (update).
• During the installation (update), a service that equates to the server process is installed. The name of the service can be specified in the name of the PLANTA server service parameter during the installation. Further information on the PLANTA server service .
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.

For a complete overview of the installation and update topics, please click here.

Attention

• If the installation (update) is not finished correctly by the installer, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• Java Version (JDK / Server JRE) 1.7.x 64-bit NEW or 1.8.x 64-bit (otherwise, the PLANTA server cannot be started)
  • When using Server JRE or Linux systems, the following environment variables must be set in addition:
    • 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)
  • Also required for Java JDK:
    • JAVA_HOME (e.g. C:\java\jdk1.7.0_80)
  • On Linux systems, rsync should be available.
• an Oracle or MSSQL database.

Notes

• When using Server JRE (Java Runtime Environment), the installation must be done exactly as required.
• The requirements described in the System Requirements topic must be met (including the PLANTA project user rights for Oracle databases described in there).
• The executing user must have profound knowledge in the required special fields and be logged on to the server as administrator (Windows) or root (Linux).

Installation Procedure (Update)

There are two installation modes: graphical GUI installation and automated console installation. Both options are available for both Windows and Linux.

Graphical GUI Installation

Procedure

• Run the install_planta_with_template.bat script (on Windows systems) or install_planta_with_template.sh script (on Linux systems).
• First choose the installation type (first installation or update).
  • First installation of Release 39.5
  • Update of an existing system
    • Update from Release 39.4.4.0 to Release 39.5.x (with DB 39.4) or
      • Source system: all three components are 39.4.4.0
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.x.
    • Update from Release 39.5.x (with DB 39.4)
      • Source system: DB is 39.4.4.0, S and C are 39.5.x
      • Target system: DB remains 39.4.4.0, S and C will be updated to 39.5.y.
    • Update from Release 39.5.x (with DB 39.5)
      • Source system: all three components are 39.5.x
      • Target system: here you can choose whether one individual component or all three components are to be updated to 39.5.y.
    • Migrating from DB 39.4 to DB 39.5 with release 39.5.x
      • Source system: S and C 39.5.x
      • Target system: S and C will be updated to 39.5.y.
      • The existing DB 39.4.4.0 database version will be migrated to version 39.5.y.
• First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
• Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, please click here.
• Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.
• The path specification is done OS specifically (Windows/Linux).

Automated Console Installation

The automated console installation (or console mode) enables installation without graphical surface.

Procedure

• Edit the 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.
• An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
• In order to define whether a particular component is to be installed in the first place, please set the db.install, server.install and client.install parameters to yes or no, whereas client.install is only available on Windows systems.
• Please note that paths are not separated by a simple but by a double backslash.
  • E.g. C:\\planta\\server instead of C:\planta\server
• Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
• Please wait now, while the installer automatically copies files to your system and runs scripts.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Installation Parameter

Information

• The Installer uses different parameters, via which the installation is controlled (for the installation or update procedure, please click here).
• The following table contains the possible value, which are explicitly specified during the automated console installation and selected and clicked on during the graphic GUI installation.

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 Attention: Reinstallation implicitly means an installation of 39.5 (database and/or server).
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). Attention: This parameter is only relevant if an update is to be carried out and can be ignored otherwise
DB log path	log.path	Client, server, database		A directory in which log files with information on installation and update are saved. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Start server after installation?	server.start_server	Client, server, database	"yes", "no"	Specifies whether the server is to be restarted automatically after successful installation. Note: It may take some minutes until the server has been restarted completely and accepts the client connection.
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. Attention: This parameter is relevant if a new database is to be installed. It will be ignored when updating an existing database.
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. Attention: Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
Oracle Tablespace	db.tablespace	Database		Specifies to which oracle table space a new database user is to be assigned. Note: This parameter is only relevant for reinstallations on an Oracle database during which a new user is to be created. For all other installation scenarios (update installation / reinstallation with MSSQL database / reinstallation with an already existing user), the parameter can be ignored.
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. Note: This parameter is only relevant for MSSQL databases. Can be ignored for Oracle databases.
Database instance	db.instance	Server, monitoring, database		Name of the MSSQL instance, to which to connect. Note: This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database		User for which the schema is to be installed. Attention: When reinstalling with a new user, it is the name of the newly created user. Otherwise, it is the name of an already existing user.
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. Note: This parameter is only relevant if a new user is to be created, and can be ignored otherwise
Database admin password	db.password_privileged	Database		Password of the new user. Note: This parameter is only relevant if a new user is to be created, and can be ignored otherwise
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. Note: 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. Hinweis If the auto value is selected, the installer decides whether a migration is carried out depending on the selected installation type. yes and no overwrites this decision.
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). Attention: This parameter is only relevant for Venus installations and can be ignored otherwise. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise a database must be created in a new manner, which is not trivial.
Load data?	db.load_data	Database	"yes", "no"	Specifies for database installations whether the standard customizing data is to be imported by PLANTA. Attention: This parameter is only relevant for Venus installations and can be ignored otherwise. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes", since otherwise the data must be imported in another way, which is not trivial.
Server IP address	SERVER_IP	Server, client	e.g. "192.168.10.20"	IP address of the PLANTA server. Attention: Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address.
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. Attention: This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server		Directory in which the PLANTA project server is to be installed. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server		Directory in which the old PLANTA project server is located Attention: This parameter is only relevant if an update installation is to be carried out and can be ignored otherwise. Note: In updates, some Python files are copied from this path to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. Attention: This parameter is ignored in Venus reinstallations since here a new database with the current status from time to time is created. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise the respective scripts must be run manually, which is not trivial.
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. Note: 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. Note on the automated console installation: If the auto value is selected, the installer decides whether a migration is carried out depending on the selected installation type. "yes" and "no" overwrites this decision.
Name of the user group	server.user.group	Server, monitoring	e.g. "User"	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name "User".
Service user	server.user.name	Server, monitoring		Linux user to which the Linux installation belongs and that starts the PLANTA Server service Note: This parameter is only relevant for installations under Linux
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: hibernate.cfg.xml c3p0.min_size c3p0.max_size c3p0.timeout c3p0.numHelperThreads globals.conf parallel_sessions
Log level	log.level	Server		Specifies how much information is written in the PLANTA log file. Note: This is primarily a debug parameter: A higher number leads to more information on the system being protocoled, but may impair the runtime.
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. Note: This is primarily a debug parameter: This coredump can possibly become quite large.
Path to coredumps	debug.coredump_path	Server		Specifies, where a possible coredump is to be created (see the create coredumps? parameter ) Note: This is primarily a debug parameter. You must possess write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client		Directory, in which the PLANTA project client is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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 Note: This value is set automatically if a port of the monitoring interface is specified and can usually be ignored.
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. Note: Can be ignored if you do not install the monitoring component
Monitoring interface IP	planta.monitoring.interface	Server	e.g. "localhost", "192.168.10.20"	Specifies the IP address of the monitoring component Note: This value is automatically set to "localhost" if a port of the monitoring interface is specified and can usually be ignored.
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. Note: This parameter differs from planta.monitoring.port.
Monitoring directory	monitoring.path	Monitoring		Directory in which the monitoring component is to be installed. Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring		Name of the service assigned to the monitoring component. Attention: This name must be unique for each monitoring component. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether a database, a server, or a client is to be installed. They are only relevant for the automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • server.install: Specifies whether server specific steps are to be carried out. These are e.g.
    • Installation or update of the binary server files,
    • Minimum adjustments of the database for securing the server start (i.e. the migration packets of the Server component) and/or
    • Installation / update of server specific Python files.
      Possible values are "yes" or "no".
  • db.install: Specifies whether database specific steps are to be carried out. These are e.g.
    • Installation of a new database,
    • Update of existing database tables (i.e. for DB 39.4.4.0 with S 39.5.x the migration packets of the Customizing-Hotfix component, for DB 39.5.x those of the Customizing, After DB Import and Before DB Import components) and/or
    • Installation / update of customizing specific Python files.
      Possible values are "yes" or "no".
    • For an update with DB39.4.4.0 and S39.5.x, the db.install parameter must be set = yes.
  • client.install: Specifies whether a PLANTA client is to be installed.
    Possible values are "yes" or "no".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to the 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. The system awaits all migration packets, not only those that have been changed. The director structure below the specified directory must exactly comply with the directory structure found in the original directory. Do not use this parameter without consulting PLANTA upfront.
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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is deleted after the installation is finished. So please specify an explicit directory, which is not used by any other user.
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.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and restart the PLANTA installation (for further information on this topic, please refer to the documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

After Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements

General

Notes

• The server and client update by automatic installer, is only part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
  • Server update from 39.4.4.0 to 39.5.x
  • Server update from 39.5.x to 39.5.y
  • Client update
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.
• For a complete overview of installation and update 39.5, please click here.

Attention

• If the installer is not finished correctly, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• NEW Java Version (JDK / Server JRE) 1.7.x 64-bit (otherwise, the PLANTA server cannot be started)
  • When using Server JRE or Linux systems, the following environment variables must be set in addition:
    • 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)
  • Also required for Java JDK:
    • JAVA_HOME (e.g. C:\java\jdk1.7.0_80)
    • JAVA_JAR (e.g. /usr/java/java_jar)
  • On Linux systems, rsync should be available.
• an Oracle or MSSQL database.

Notes

• When using Server JRE (Java Runtime Environment), the installation must be done exactly as required.
• The requirements described in the System Requirements topic must be met, this includes the PLANTA project user rights for Oracle databases described in there.
• The executing user must have profound knowledge of the required areas and must possess administrator rights (in Windows) or be configured as a root user (Linux).

Installation Procedure

There are two available installation modes:

For the graphical GUI installation, please run the install_planta.bat (on Windows systems) or install_planta.sh (on Linux systems).

• First choose the installation type (first installation or update).
  • First installation of Release 39.5 or
  • Update of an existing system
    • Update from Release 39.4.4.0 to Release 39.5.X (with DB 39.4) or
      • In the source system, all 3 components are 39.4.4.0 and in the target system, DB remains 39.4.4.0 and S and C are upgraded to 39.5.X.
    • Update from Release 39.5.X (with DB 39.4) or
      • In the source system, DB 39.4.4.0 and S and C 39.5.X and in the target system DB remains 39.4.4.0 and S and C are upgraded to 39.5.Y.
    • Update from Release 39.5.X (with DB 39.5)
      • In the source system, all 3 components are 39.5.X and in the target system, the DB remains at 39.5.X and S and C are upgraded to 39.5.Y.
    • Migrating from DB 39.4 to DB 39.5 with release 39.5.x
      • In the source system, S and C are 39.5.X and in the target system they are upgraded to 39.5.Y. The existing DB 39.4.4.0 database version is migrated to version 39.5.X.
• First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
• Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, see the Installation Parameters section.
• Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.
• The path specification is done OS specifically (Windows/Linux).

The automated console installation (or console mode) enables installation without graphical surface. Please proceed as follows:

• Edit the 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.
• An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
• In order to define whether a particular component is to be installed in the first place, please set the db.install, server.install and client.install parameters to yes or no, whereas client.install is only available on Windows systems.
• Please note that paths are not separated by a simple but by a double backslash.
  • E.g. C:\\planta\\server instead of C:\planta\server
• Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
• Please wait now, while the installer automatically copies files to your system and runs scripts.
  • Please be patient. This step may take some time depending on your system performance.
• Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and restart the PLANTA installation (for further information on this topic, please refer to the documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

Installation Parameter

The Installer uses different parameters via which the installation is controlled (for input of these parameters, refer to the Installation Procedure section).

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. Attention: Reinstallation implies an installation of 39.5 (database and/or server). Note on the automated console installation: possible values are "new" or "update".
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). Attention: This parameter is only relevant if an update installation is to be carried out and can be ignored otherwise. Note on automated console installation: possible values are "r94" (update from 39.4.4.0), "r95" (update from 39.5.X with DB 39.4), venus (update from existing 39.5.X system with DB 39.5) and voeToVenus (migration from 39.5 with DB 39.4 to 39.5 with 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. Note: You must have write authorization on this directory. Please also make sure that you do not use any single backslashes in the path names in the automated console installation.
Start server after installation? NEW	server.start_server	Client, server, database	Specifies whether the server is to be restarted automatically after successful installation. Note: It may take some minutes until the server has been restarted completely and accepts the client connection. Note on automated console installation: If you enter "no" here, the server is not started. If any value other than "no" is entered, the server is started.
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. Attention: This parameter is relevant if a new database is to be installed. It is ignored when an existing database is updated. Note on the automated console installation: possible values are "existing" (using an existing database user) or "new" (creating a new database user)
Database type	db.type	Database, server	Database type Note on automated console installation: possible values are "Oracle" or "MSSQL".
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. Attention: Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
Oracle Tablespace	db.tablespace	Database	Specifies to which oracle table space a new database user is to be assigned. Note: This parameter is only relevant for reinstallations on an Oracle database during which a new user is to be created. For all other installation scenarios (update installation / reinstallation with MSSQL database / reinstallation with an already existing user), the parameter can be ignored.
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. Note: This parameter is only relevant for MSSQL databases. Can be ignored in Oracle databases. Note on automated console installation: possible values are "yes" or "no"
Database instance	db.instance	Server, monitoring, database	The name of the MSSQL instance, to which to connect. Note: This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database	User for which the schema is to be installed Attention: When reinstalling with a new user, it is the name of the newly created user. Otherwise, it is the name of an already existing user
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 Note: This parameter is only relevant if a new user is created and can be ignored otherwise
Database admin password	db.password_privileged	Database	Password of the new user. Note: This parameter is only relevant if a new user is created and can be ignored otherwise
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 Note: 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. Note on the automated console installation: Possible values are "auto", "yes", and "no". If the "auto" value is selected, the installer decides whether a migration is carried out depending on the installation type. "yes" and "no" overwrites this decision. The "auto" value should generally not be changed.
	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). Note: This parameter is only available in the console installation since the installer can make the decision itself Note: The decision whether a core installation is carried out is usually made by the installer and is preset accordingly. The parameter should therefore not be changed - especially when installing a 39.5 system with DB 39.4 it should never be set to yes! Note on automated console installation: Possible values are "auto", "yes", and "no". If the "auto" value is selected, the installer decides depending on the installation type whether a core update is carried out. "yes" and "no" overwrites this decision. The "auto" value should generally not be changed.
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). Attention: This parameter is only relevant for Venus installations and can be ignored otherwise. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise a database must be created in a new manner, which is not trivial.< Note on the automated console installation: If you enter "no" here, no schema operations are carried out. If any value other than "no" is entered, the schema is created or adjusted.
Load data? NEW	db.load_data	Database	Specifies in database installation whether the Standard customizing data are to be imported from PLANTA Attention: This parameter is only relevant for Venus installations and can be ignored otherwise. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise data must be imported in a new manner, which is not trivial.< Note on the automated console installation: If you enter "no" here, no data import is carried out. If any value other than "no" is entered, the data is imported.
Server IP address	SERVER_IP	Server, client	IP address of the PLANTA server. Attention: Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address
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. Attention: This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server	Directory in which the PLANTA project server is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server	Directory in which the old PLANTA project server is located Attention: This parameter is only relevant if an update installation is to be carried out and can be ignored otherwise. Note: In updates, some Python files are copied from this path to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
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. Attention: This parameter is ignored in Venus reinstallations since here a new database with the current status from time to time is created. Attention: It is highly recommended that you activate this checkbox or leave the console parameter at "yes" since otherwise the respective scripts must be run manually, which is not trivial.< Note on the automated console installation: If you enter "no" here, no schema adjustment is carried out. If any value other than "no" is entered, the schema is adjusted.
Run migration?	server.migrate	Server	Specifies whether a server specific migration to the new server version is to be carried out during the installation Note: 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. Note on the automated console installation: Possible values are "auto", "yes", and "no". If the "auto" value is selected, the installer decides whether a migration is carried out depending on the installation type. "yes" and "no" overwrites this decision. The "auto" value should generally not be changed.
Name of the user group	server.user.group	Server, monitoring	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name user.
Service user	server.user.name	Server, monitoring	Linux user to which the Linux installation belongs and that starts the PLANTA Server service Note: This parameter is only relevant for installations under Linux
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) Note on automated console installation: Possible values are "low", "medium", and "large". As a result, dimensioning relevant parameters 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: hibernate.cfg.xml c3p0.min_size c3p0.max_size c3p0.timeout c3p0.numHelperThreads globals.conf parallel_sessions
Log level	log.level	Server	Specifies how much information is written in the PLANTA log file. Note: This is primarily a debug parameter: A higher number leads to more information on the system being protocoled, but may impair the runtime.
Create core dumps?	debug.coredumps	Server	Specifies whether a core dump file with the current system status is created Note: This is primarily a debug parameter: This core dump can possibly become quite huge Note on the automated console installation: possible values are "1" (create coredump) and "0" (do not create coredump)
Path to coredumps	debug.coredump_path	Server	Specifies, where a possible coredump is to be created (see the create coredumps? parameter ) Note: This is primarily a debug parameter. You must possess write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client	Directory, in which the PLANTA project client is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Desktop shortcut	client.create_desktop_shortcut	Client	Defines whether a shortcut to the client is to be created on the desktop Note on automated console installation: Possible values are "1" (create link) and "0" (do not create link)
Start-up shortcut	client.create_menu_shortcut	Client	Defines whether a shortcut to the client is to be created in the start-up menu Note on automated console installation: Possible values are "1" (create link) and "0" (do not create link)
Monitoring activated	planta.monitoring.enable	Server	Specifies whether the monitoring component for the server is to be activated Note: This value is set automatically if a port of the monitoring interface is specified and can usually be ignored. Note on the automated console installation: possible values are "true" and "false".
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 Note: Can be ignored if you do not install the monitoring component
Monitoring interface IP	planta.monitoring.interface	Server	Specifies the IP address of the monitoring component Note: This value is set to "localhost" in case a monitoring interface port is specified and can usually be ignored. Note on automated console installation: possible values are "localhost" or standard IP addresses.
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 Note: This parameter differs from planta.monitoring.port
Monitoring directory	monitoring.path	Monitoring	Directory in which the monitoring component is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring	Name of the service assigned to the monitoring component. Attention: This name must be unique for each monitoring component. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether a database, a server, or a client is to be installed. They are only relevant for automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • db.install: Specifies whether a database is to be installed. Possible values are "yes" or "no".
    • This parameter is only analyzed if a reinstallation is carried out (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".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to 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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set the temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is automatically deleted after the installation is finished. So please specify an explicit directory, which is not used by any other person.
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.

After Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements

General

Notes

• The PLANTA installer requires at least Java version 1.7 to be installed on the system, otherwise, the installer cannot be started.
• If the installer is not finished correctly, incorrect or invalid data may occur.
• The server and client update by automatic installer, is only part of the respective update process. For a description of the complete update process of the respective component, see the following topics:
  • Server update from 39.4.4.0 to 39.5.x
  • Server update from 39.5.x to 39.5.y
  • Client update
• Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.
• For a complete overview of installation and update 39.5, please click here.

Attention

• If the installer is not finished correctly, incorrect or invalid data may occur.

Requirements

The following components must be installed on the target system:

• Java Version (JDK) 1.7.x 64-bit (otherwise, the PLANTA Server cannot be started)
  • On Linux systems, the following environment variables must be set in addition:
    • 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)
  • Also required for Java JDK:
    • JRE_HOME (e.g. /usr/java/jdk1.7.0_21/jre)
    • JAVA_JAR (e.g. /usr/java/java_jar)
  • NEW On Linux systems, rsync must be available.
• an Oracle or MSSQL database.

Notes

• The requirements described in the System Requirements topic must be met (including the PLANTA project user rights for Oracle databases described in there).
• The executing user must have profound knowledge of the required areas and must possess administrator rights (in Windows) or be configured as a root user (Linux).

Installation Procedure

There are two installation modes available:

• For the graphical GUI installation, please run the install_planta.bat (on Windows systems) or install_planta.sh (on Linux systems).
  • First choose the installation type (first installation or update).
    • First installation of Release 39.5 or
    • Update of an existing system
      • Update from Release 39.4.4.0 to Release 39.5.X (with DB 39.4) or
        • In the source system, all 3 components are 39.4.4.0 and in the target system, DB remains 39.4.4.0 and S and C are upgraded to 39.5.X.
      • Update from Release 39.5.X (with DB 39.4) or
        • In the source system, DB 39.4.4.0 and S and C 39.5.X and in the target system DB remains 39.4.4.0 and S and C are upgraded to 39.5.Y.
      • Update from Release 39.5.X (with DB 39.5)
        • In the source system, all 3 components are 39.5.X and in the target system, the DB remains at 39.5.X and S and C are upgraded to 39.5.Y.
      • NEW Migrating from DB 39.4 to DB 39.5 with release 39.5.x
        • In the source system, S and C are 39.5.X and in the target system they are upgraded to 39.5.Y. The existing DB 39.4.4.0 database version is migrated to version 39.5.X.
  • First select the components that you want to install (database/server/client, whereas the client is only available on Windows systems).
  • Then, select the respective parameters for the database/server/client installation. We highly recommend that these settings be made by experienced users. For further information on the parameters, see the Installation Parameters section.
  • Subsequently, the installer will copy the files to your system and run several scripts in order to configure your system.
    • Please be patient. This step may take some time depending on your system performance.
  • Afterwards, the components you have selected will be ready for use.
• The automated console installation (or console mode) enables installation without graphical surface. Please proceed as follows:
  • Edit the 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.
  • An update can take some time (especially in the [ Processing package: (x/y) ] step). Please do not cancel the process at this point!
  • In order to define whether a particular component is to be installed in the first place, please set the db.install, server.install and client.install parameters to yes or no, whereas client.install is only available on Windows systems.
  • Please note that paths are not separated by a simple but by a double backslash.
    • E.g. C:\\planta\\server instead of C:\planta\server
  • Run the install_planta_with_template.bat script (on Windows systems) afterwards or install_planta_with_template.sh (on Linux systems).
  • Please wait now, while the installer automatically copies files to your system and runs scripts.
    • Please be patient. This step may take some time depending on your system performance.
  • Afterwards, the components you have selected will be ready for use.

Attention

• In the console installation, only the /install/planta-linux.properties and /install/planta-windows.properties files may be configured.
• All files under /scripts, especially scripts/temp.linux.properties and scripts/temp.windows.properties must NOT be changed.

Notes on error treatment

• If the Unable to get information from SQL Server error occurs during the database installation under MSSQL, this usually means that the SQL Server Browser service has not been started yet.
  • Run this service manually and start the PLANTA installation (for further information on this topic, please refer to the Documentation for MSSQL).
• If the Server has no instance named SQLEXPRESS error occurs while installing the database to a named instance under MSSQL, please activate the TCP/IP option for your instance, restart the MSSQL service and then run the PLANTA installation again (for further information on this topic, please refer to the documentation for MSSQL).
• If errors have occurred during the installation, temporary files may remain on your system. In such a case, please delete the client or server installation directories (server.path / client.path parameters) and the install_planta directory in your temporary directory before carrying out a reinstallation.
• If you cannot login (a prompt to establish the connection is displayed instead of the login dialog) despite successful installation (no error message during the installation), please check the \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).

Installation Parameter

The Installer uses different parameters via which the installation is controlled (for input of these parameters, refer to the Installation Procedure section).

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 Attention: Reinstallation means an installation of 39.5 (database and/or server) Note on automated console installation: possible values are "new" or "update"
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). Attention: This parameter is only relevant if an update installation is to be carried out and can be ignored otherwise. Note on automated console installation: possible values are "r94" (update from 39.4.4.0), "r95" (update from 39.5.X with DB 39.4), venus (update from existing 39.5.X system with DB 39.5) and voeToVenus (migration from 39.5 with DB 39.4 to 39.5 with 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. Note: You must have write authorization on this directory. Please also make sure that you do not use any single backslashes in the path names in the automated console 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 Note on automated console installation: possible values are "existing" (using an existing database user) or "new" (creating a new database user)
Database type	db.type	Database, server	Database type Note on automated console installation: possible values are "Oracle" or "MSSQL".
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 Attention: Upon reinstalling with a new user in MSSQL, this is the name of the new database. When using an existing user, it is the name of an already existing database. In Oracle, on the other hand, there is always an existing database specified, for which a new user is only created if necessary.
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 Note: This parameter is only relevant for MS SQL databases. Can be ignored in Oracle databases. Note on automated console installation: possible values are "yes" or "no"
Database instance	db.instance	Server, monitoring, database	The name of the MSSQL instance, to which to connect. Note: This parameter is only relevant for MSSQL databases that use named instances. Can be ignored in Oracle databases, as well as MSSQL databases using default instances.
Database user	db.user	Server, monitoring, database	User for which the schema is to be installed Attention: When reinstalling with a new user, it is the name of the newly created user. Otherwise, it is the name of an already existing user
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 Note: This parameter is only relevant if a new user is created and can be ignored otherwise
Database admin password	db.password_privileged	Database	Password of the new user. Note: This parameter is only relevant if a new user is created and can be ignored otherwise
Server IP address	SERVER_IP	Server, client	IP address of the PLANTA server. Attention: Is also used for the client and would have to be set to the IP address of the PLANTA server accordingly Note on automated console installation: This parameter is missing in the properties files since the installer automatically uses the IP address of the server on which the installation is performed. Add this parameter to a properties file if the IP address of the current computer is not the PLANTA server address
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. Attention: This name must be unique for each PLANTA system. This means that if you, e.g., install a test and a productive system on the same server, they must have different service names.
New server directory	server.path	Server	Directory in which the PLANTA project server is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Existing server directory	server.path.existing	Server	Directory in which the old PLANTA project server is located Attention: This parameter is only relevant if an update installation is to be carried out and can be ignored otherwise. Note: In updates, some Python files are copied from this path to the newly installed server. This path must not be identical with the new server.path server path. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Run migration?	server.migrate	Server	Specifies whether a migration to the new server version is to be carried out during the installation Note: 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. Note on the automated console installation: Possible values are "auto", "yes", and "no". If the "auto" value is selected, the installer decides whether a migration is carried out depending on the installation type. "yes" and "no" overwrites this decision. The "auto" value should generally not be changed.
	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). Note: This parameter is only available in the console installation since the installer can make the decision itself Note: The decision whether a core installation is carried out is usually made by the installer and is preset accordingly. The parameter should therefore generally not be changed - especially when installing a 39.5 system with DB 39.4 it should never be set to yes! Note on automated console installation: Possible values are "auto", "yes", and "no". If the "auto" value is selected, the installer decides depending on the installation type whether a core update is carried out. "yes" and "no" overwrites this decision. The "auto" value should generally not be changed.
Name of the user group NEW	server.user.group	Server, monitoring	Group to which the installation belongs Note on Windows: For Windows systems this should either be the group or (in English operation systems) the group with the name user.
Service user NEW	server.user.name	Server, monitoring	Linux user to which the Linux installation belongs and that starts the PLANTA server service Note: This parameter is only relevant for installations under Linux
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) Note on automated console installation: possible values are "small", "medium", and "large"
Log level	log.level	Server	Specifies how much information is written in the PLANTA log file. Note: This is primarily a debug parameter: A higher number leads to more information on the system being protocoled but may impair the runtime.
Create core dumps?	debug.coredumps	Server	Specifies whether a core dump file with the current system status is created Note: This is primarily a debug parameter: This core dump can possibly become quite huge Note on the automated console installation: possible values are "1" (create coredump) and "0" (do not create coredump)
Path to coredumps	debug.coredump_path	Server	Specifies, where a possible coredump is to be created (see the create coredumps? parameter ) Note: This is primarily a debug parameter. You must possess write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Client directory	client.path	Client	Directory, in which the PLANTA project client is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Desktop shortcut	client.create_desktop_shortcut	Client	Defines whether a shortcut to the client is to be created on the desktop Note on automated console installation: Possible values are "1" (create link) and "0" (do not create link).
Start-up shortcut	client.create_menu_shortcut	Client	Defines whether a shortcut to the client is to be created in the start-up menu Note on automated console installation: Possible values are "1" (create link) and "0" (do not create link).
Monitoring activated	planta.monitoring.enable	Server	Specifies whether the monitoring component for the server is to be activated Note: This value is set automatically if a port of the monitoring interface is specified and can usually be ignored. Note on automated console installation: possible values are "true" and "false".
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 Note: Can be ignored if you do not install the monitoring component
Monitoring interface IP	planta.monitoring.interface	Server	Specifies the IP address of the monitoring component Note: This value is set to "localhost" in case a monitoring interface port is specified and can usually be ignored. Note on automated console installation: possible values are "localhost" or standard IP addresses.
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 Note: This parameter differs from planta.monitoring.port
Monitoring directory	monitoring.path	Monitoring	Directory in which the monitoring component is to be installed Note: You must have write authorization on this directory. Please make sure that you do not use any single backslashes in the path names in the automated console installation.
Name of the monitoring service	monitoring.service	Monitoring	Name of the service assigned to the monitoring component. Attention: This name must be unique for each monitoring component. This means that if you, e.g., install monitoring components on the same server, they must have different names.

Information

• The following parameters define whether a database, a server, or a client is to be installed. They are only relevant for automated console installation since the components to be installed are selected at the very beginning of a GUI installation.
  • db.install: Specifies whether a database is to be installed. Possible values are "yes" or "no".
    • This parameter is only analyzed if a reinstallation is carried out (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".
    • The client installation is only available for installations on Windows computers.

Additional parameters

• Usually, the parameters specified above are sufficient for an installation. For special cases, there are, however, some additional parameters, which can be added to 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). Setting a temporary directory is only required if several installations run simultaneously since the installers can mutually overwrite their values in this case. Otherwise, we recommend that you do not set the temp.path parameter manually. You must have write authorization on this directory The content of the temporary directory is automatically deleted after the installation is finished. So please specify an explicit directory, which is not used by any other person.
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.

After Installation

Information

• When installing a customer system, further steps must be carried out after the standard installation. This includes a.o.
  • replacing the PLANTA Standard database by an individual database
  • replacing the customized Python files in the server or client directory.
• To find out which particular steps are to be carried out here, please consult your PLANTA consultant.

Note

• After the installation, particular settings must be adjusted if necessary. Further information

---

See also: Installation and Update, Release Notes, System Requirements