Installation/Update with PLANTA Installer from S 39.5.0 up to 39.5.7

General

Information

• From version 39.5.0, PLANTA updates the individual client, server and database (Customizing) software components independent of one another. This means: Other than in previous versions, the individual components of an installation do not necessarily have to be of the same version and can be updated individually, independent of one another.
  • However, dependencies may exist between the individual versions of different components. They are specified explicitly in the Release Notes.

Notes

• The following instruction describes the server and client update by automatic installer.
• The PLANTA installer requires at least Java version 1.7 to be installed on the system, otherwise, the installer cannot be started.
• The server and client update by automatic installer, is only part of the respective update process.
• You will find the instructions for the complete update process of the respective component in 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: Currently, neither updating nor complete reinstallation (which includes the installation of the client, server and database components) can be done by automatic installer since no 39.5 database is available yet. The already existing server and client 39.5 can be used with database 39.4.4.0.
• If you already employ version 39.4.4.0, you only have to update the server and/or client to the required 39.5 version.
• If you employ one of the previous versions, or if you only introduce PLANTA project now, you have to install the latest version of Release 39.4 (39.4.4.0) and subsequently update one or both of the two components to the required version 39.5.
• 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.

The installer provides the following functionalities:

• Optional installation of the following PLANTA project components:
  • Installation of the PLANTA Server
  • Installation of the PLANTA Client
• Installation on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation).
• During the installation, a service is set up, which equates to the server process. The name of the service can be specified in the name of the PLANTA service parameter during the installation. Further information on the PLANTA service .

Requirements

The following components must be installed on the target system:

• Oracle Java version 1.7.x 64-bit (otherwise, the PLANTA server and the installation routine cannot be started)

Attention

• Other Java development or runtime environments may be installed at the same time. In this case you have to make sure that the PLANTA server and the corresponding service run explicitly in the Oracle environment. In order to apply the changes to the installed service, it must be stopped, uninstalled and reinstalled.
  • Linux: in yajsw/bat/setenv.sh, the java_exe variable is adjusted so that it contains the entire path to the interpreter. Afterwards, the stopDaemon.sh, uninstallDaemon.sh and installDaemon.sh scripts must be opened in this sequence in the same directory.
  • Windows: in yajsw/bat/setenv.bat, the java_exe and javaw_exe variables are adjusted so that they contain the entire path to the respective interpreter. Afterwards, the stopService.bat, uninstallDaemon.sh, uninstallService.bat and installService.bat scripts must be opened in this sequence in the same directory.

Note

• An Oracle or MSSQL database must be available before the installation.
• For the installation to run smoothly, the executing user 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 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 automated installation (or console mode) enables an installation without graphical user interface. 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 available parameters, please click here.
  • In order to modify whether a particular component is to be installed in the first place, please set the 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 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 the client is closed immediately after it has been started, this may indicate that the license is wrong. Please check this in the \config\planta_server.conf file.
• 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 upon start of the PLANTA server. It may also be helpful 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)
• In case the Process execution failed message occurs, please install a higher Java version.

Installation Parameters

The Installer uses different parameters, via which the installation is controlled (for input of these parameters, see here).

Parameter	Name in properties files	Used for component	Meaning
DB log directory	log.path	Server, client	A directory in which a log file with information on the installation is 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
Database type	db.type	Server	Database type Note on automatized console installation: possible values are "Oracle" or "MSSQL"
License	License	Server, NEW monitoring	Your license number allocated by PLANTA, e.g. 100
Database server	db.server	Server, NEW monitoring	Name or IP address of the server on which the database is running
Database port	db.oracle.port / db.mssql.port	Server, NEW monitoring	Port to the database. By default, the Oracle port is 1521 and the MSSQL port is 1433
Database name	db.name	Server, NEW monitoring	The SID in Oracle, the database name in MSSQL
MSSQL server uses named instance	db.use_named_instance	Server, NEW monitoring	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 for Oracle databases. Note on automated console installation: possible values are "yes" or "no"
Database instance	db.instance	Server, NEW Monitoring	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, NEW monitoring	User for which the schema is to be installed
Database password	db.password	Server, NEW monitoring	The password of the user
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 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 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.
Hibernate dialect	hibernate.oracle.dialect / hibernate.mssql.dialect=	Server	Hibernate dialect, required to communicate with your database. This is a hibernate specific name, which depends on the database version used and should only be changed by administrators. Default values set are de.planta.server.hibernate.dialect.Oracle10gDialect for Oracle or de.planta.server.hibernate.dialect.SQLServerDialect for MSSQL Note on automated console installation: This parameter is named hibernate.oracle.dialect in the properties files for Oracle databases and hibernate.mssql.dialect for MSSQL databases
Hibernate connect class	hibernate.oracle.driver_class / hibernate.mssql.driver_class	Server	Java class required to communicate with hibernate. This is a jdbc specific class, which depends on the database version used and should only be changed by administrators. Default values set are oracle.jdbc.driver.OracleDriver for Oracle or com.microsoft.sqlserver.jdbc.SQLServerDriver for MSSQL Note on automated console installation: This parameter is named hibernate.oracle.dialect in the properties files for Oracle databases and hibernate.mssql.dialect for MSSQL databases
New server directory	server.path	Server,NEW monitoring	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
Name of the user group	service.user.group	Server, NEW monitoring	Name of the user group to which the server files are supposed to belong Note: Under Linux, it should be the group of the user that starts the Wrapper service (see service.user.name) Note: Under Windows, it should be the 'users' group (in the English Windows version)
Name of the service user	server.user.name	Server, NEW monitoring	User to which the Linux installation belongs (a.o., it is the user that starts the server process) 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, middle = normal operation, large = many users on the system simultaneously) Note on automated console installation: Possible values are small, medium and large
NEW 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
NEW 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 less than 30000, which is not used by any other process Note: Can be ignored if you do not install the monitoring component
NEW 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 localhost or standard IP addresses
NEW Port of the web interface	monitoring.port	Monitoring	Port number of the monitoring component web service. It should be a five-digit number less than 30000, which is not used by any other process Note: This parameter differs from planta.monitoring.port
NEW 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
NEW 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.
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 shortcut) and 0 (do not create shortcut)
Startup shortcut	client.create_menu_shortcut	Client	Defines whether a shortcut to the client is to be created in the startup menu Note on automated console installation: possible values are 1 (create shortcut) and 0 (do not create shortcut)
Installation type	planta.install_type	Server	Specifies whether you updated from a 39.4.4.0- or from a 39.5.x system Note on automated console installation: Possible values are r94 (update from 39.4.4.0) and r95 (update from 39.5.x) Furthermore, there is the venus parameter (Venus reinstalling), which is currently not fully supported yet since it requires a database reinstalling.
Existing server directory	server.path.existing	Server	Specifies the directory in which the existing server is installed
Existing server version	server.version	Server	Specifies the version number of the existing server version This parameter is only relevant if an existing system is updated and can be ignored when reinstalling completely. Note on automated console installation: Possible values are 39.5.0, 39.5.1, 39.5.2, etc.

Information

• The following parameters define whether 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 a PLANTA server is to be installed. Possible values are "yes" or "no".
  • NEW monitoring.install: Specifies whether the monitoring service of the 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.

Post Installation

Note

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

---

See also: Install Hotfix, Release Notes, Requirements and Platforms

General

Information

• From version 39.5.0, PLANTA updates the individual client, server and database (Customizing) software components independent of one another. This means: Other than in previous versions, the individual components of an installation do not necessarily have to be of the same version and can be updated individually, independent of one another.
  • However, dependencies may exist between the individual versions of different components. They are explicitly specified in the release notes.

Notes

• The following instruction describes the server and client update by automatic installer.
• The server and client update by automatic installer, is only part of the respective update process.
• You will find the instructions for the complete update process of the respective component in 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: Currently, neither an update nor a complete reinstallation (which includes the installation of the client, server, and database components) can be done by automatic installer since no 39.5 database is available yet. The already existing server and client 39.5 can be used with database 39.4.4.0.
  • If you already employ version 39.4.4.0, you only have to update the server and/or client to the required 39.5 version.
  • If you employ one of the previous versions, or if you only introduce PLANTA project now, you have to install the latest version of Release 39.4 (39.4.4.0) and subsequently update one or both of the two components to the required version 39.5.
• For a complete overview of installation and update 39.5, please click here.

The installer provides the following functionalities:

• Optional installation of the following PLANTA project components:
  • Installation of the PLANTA Server
  • Installation of the PLANTA Client
• Installation on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation).
• During the installation, a service is set up, which equates to the server process. The name of the service can be specified in the name of the PLANTA service parameter during the installation. Further information on the PLANTA service .

Requirements

The following components must be installed on the target system:

• Java Version (JDK) 1.6.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.6.0_21)
    • CLASSPATH (e.g. /usr/java/jdk1.6.0_21/bin)
    • PATH (e.g. /usr/java/jdk1.6.0_21/bin:/usr/java/jdk1.6.0_21/jre/bin:$PATH)
  • Also required for Java JDK:
    • JRE_HOME (e.g. /usr/java/jdk1.6.0_21/jre)
    • JAVA_JAR (e.g. /usr/java/java_jar)
• an Oracle or MSSQL database.

Note

• For the installation to run smoothly, the executing user 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 of all, please choose the components you wish to install (server/client, whereas the client is only available on Windows systems).
  • Then select the corresponding parameters for the 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 automated installation (or console mode) enables an installation without graphical user interface. 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 available parameters, please click here.
  • In order to modify whether a particular component is to be installed in the first place, please set the 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 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 the client is closed immediately after it has been started, this may indicate that the license is wrong. Please check this in the \config\planta_server.conf file.
• 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 upon start of the PLANTA server. It may also be helpful 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 Parameters

The Installer uses different parameters, via which the installation is controlled (for input of these parameters, see here).

Parameter	Name in properties files	Used for component	Meaning
DB log directory	log.path	Server, client	A directory in which a log file with information on the installation is 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
Database type	db.type	Server	Database type Note on automatized console installation: possible values are "Oracle" or "MSSQL"
License	License	Server	Your license number allocated by PLANTA, e.g. 100
Database server	db.server	Server	Name or IP address of the server on which the database is running
Database port	db.oracle.port / db.mssql.port	Server	Port to the database. By default the Oracle port is 1521 and the MSSQL port is 1433
Database name	db.name	Server	The SID in Oracle, the database name in MSSQL
MSSQL server uses named instance	db.use_named_instance	Server	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 for Oracle databases. Note on automated console installation: possible values are "yes" or "no"
Database instance	db.instance	Server	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	User for which the schema is to be installed
Database password	db.password	Server	Password of the user
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 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 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.
Hibernate dialect	hibernate.oracle.dialect / hibernate.mssql.dialect=	Server	Hibernate dialect, required to communicate with your database. This is a hibernate specific name, which depends on the database version used and should only be changed by administrators. Default values set are de.planta.server.hibernate.dialect.Oracle10gDialect for Oracle or de.planta.server.hibernate.dialect.SQLServerDialect for MSSQL Note on automated console installation: This parameter is named hibernate.oracle.dialect in the properties files for Oracle databases and hibernate.mssql.dialect for MSSQL databases
Hibernate connect class	hibernate.oracle.driver_class / hibernate.mssql.driver_class	Server	Java class required to communicate with hibernate. This is a jdbc specific class, which depends on the database version used and should only be changed by administrators. Default values set are oracle.jdbc.driver.OracleDriver for Oracle or com.microsoft.sqlserver.jdbc.SQLServerDriver for MSSQL Note on automated console installation: This parameter is named hibernate.oracle.dialect in the properties files for Oracle databases and hibernate.mssql.dialect for MSSQL databases
New server directory	server.path	Server	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
Linux group	server.linux.group	Server	Linux group to which the Linux installation belongs Note: This parameter is only relevant for installations under Linux
Linux user	server.linux.user	Server	Linux user to which the Linux installation belongs (this is, a.o., the user that starts the server process) 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, middle = normal operation, large = many users on the system simultaneously) Note on automated console installation: possible values are small, medium, and large
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 shortcut) and 0 (do not create shortcut)
Startup shortcut	client.create_menu_shortcut	Client	Defines whether a shortcut to the client is to be created in the startup menu Note on automated console installation: possible values are 1 (create shortcut) and 0 (do not create shortcut)
Installation type	install_type	Server	Specifies whether you update from a 39.4.4.0- or from a 39.5.x system Note on automated console installation: Possible values are r94 (update from 39.4.4.0) and r95 (update from 39.5.x)
Existing server directory	server.path.existing	Server	Specifies the directory in which the existing server is installed
Existing server version	server.version	Server	Specifies the version number of the existing server version This parameter is only relevant if an existing system is updated and can be ignored when reinstalling completely. Note on automated console installation: Possible values are 39.5.0, 39.5.1, 39.5.2, etc.

Information

• The following parameters define whether 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 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.

Post Installation

Note

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

---

See also: Install Hotfix, Release Notes, Requirements and Platforms

General

Information NEW

• From version 39.5.0, PLANTA updates the individual client, server and database (Customizing) software components independent of one another. This means: Other than in previous versions, the individual components of an installation do not necessarily have to be of the same version and can be updated individually, independent of one another.
  • However, dependencies may exist between the individual versions of different components. They are specified explicitly in the Release Notes.

Notes

• The following instruction describes the server and client update by automatic installer.
• The server and client update by automatic installer, is only part of the respective update process.
• You will find the instructions for the complete update process of the respective component in 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: Since no database 39.5 is available yet, neither an update nor a complete reinstalling (containing the installation of the three components client, server, database) with automatic installer is possible. The already existing server and client 39.5 can be used with database 39.4.4.0.
  • If you already employ version 39.4.4.0, you only have to update the server and/or client to the required 39.5 version.
  • If you employ one of the previous versions, or if you only introduce PLANTA project now, you have to install the latest version of Release 39.4 (39.4.4.0) and subsequently update the two components server and client to the required version 39.5.
• For a complete overview of installation and update 39.5, please click here.

The installer provides the following functionalities:

• Optional installation of the following PLANTA project components:
  • Installation of the PLANTA Server
  • Installation of the PLANTA Client
• Installation on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation).
• During the installation, a service is set up, which equates to the server process. The name of the service can be specified in the name of the PLANTA service parameter during the installation. Further information on the PLANTA service .

Requirements

The following components must be installed on the target system:

• Java Version (JDK) 1.6.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.6.0_21)
    • CLASSPATH (e.g. /usr/java/jdk1.6.0_21/bin)
    • PATH (e.g. /usr/java/jdk1.6.0_21/bin:/usr/java/jdk1.6.0_21/jre/bin:$PATH)
  • Also required for Java JDK:
    • JRE_HOME (e.g. /usr/java/jdk1.6.0_21/jre)
    • JAVA_JAR (e.g. /usr/java/java_jar)
• an Oracle or MSSQL database.

Note

• For the installation to run smoothly, the executing user must possess administrator rights (in Windows) or must 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 of all, please choose the components you wish to install (server/client, whereas the client is only available on Windows systems).
  • Then select the corresponding parameters for the 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 automated installation (or console mode) enables an installation without graphical user interface. 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 available parameters, please click here.
  • In order to modify whether a particular component is to be installed in the first place, please set the 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 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 the client is closed immediately after it has been started, this may indicate that the license is wrong. Please check this in the \config\planta_server.conf file.
• 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 upon start of the PLANTA server. It may also be helpful 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 Parameters

The Installer uses different parameters, via which the installation is controlled (for input of these parameters, see here).

Parameter	Name in properties files	Used for component	Meaning
DB log directory	log.path	Server, client	A directory in which a log file with information on the installation is 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
Database type	db.type	Server	Database type Note on automatized console installation: possible values are "Oracle" or "MSSQL"
License	License	Server	Your license number allocated by PLANTA, e.g. 100
Database server	db.server	Server	Name or IP address of the server on which the database is running
Database port	db.oracle.port / db.mssql.port	Server	Port to the database. By default the Oracle port is 1521 and the MSSQL port is 1433
Database name	db.name	Server	The SID in Oracle, the database name in MSSQL
MSSQL server uses named instance	db.use_named_instance	Server	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 for Oracle databases. Note on automated console installation: possible values are "yes" or "no"
Database instance	db.instance	Server	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	User for which the schema is to be installed
Database password	db.password	Server	Password of the user
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 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 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.
Hibernate dialect	hibernate.oracle.dialect / hibernate.mssql.dialect=	Server	The hibernate dialect required to communicate with your database. This is a hibernate specific name, which depends on the database version used and should only be changed by administrators. Default values set are de.planta.server.hibernate.dialect.Oracle10gDialect for Oracle or =de.planta.server.hibernate.dialect.SQLServerDialect for MSSQL Note on automated console installation: This parameter is named hibernate.oracle.dialect in the properties files for Oracle databases and hibernate.mssql.dialect for MSSQL databases
Hibernate connect class	hibernate.oracle.driver_class / hibernate.mssql.driver_class=	Server	The Java class required to communicate with hibernate. This is a jdbc specific class, which depends on the database version used and should only be changed by administrators. Default values set are oracle.jdbc.driver.OracleDriver for Oracle or =com.microsoft.sqlserver.jdbc.SQLServerDriver for MSSQL Note on automated console installation: This parameter is named hibernate.oracle.dialect in the properties files for Oracle databases and hibernate.mssql.dialect for MSSQL databases
New server directory	server.path	Server	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
Linux group	server.linux.group	Server	Linux group to which the Linux installation belongs Note: This parameter is only relevant for installations under Linux
Linux user	server.linux.user	Server	Linux user to which the Linux installation belongs (this is, a.o., the user that starts the server process) 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, middle = normal operation, large = many users on the system simultaneously) Note on automated console installation: possible values are small, medium, and large
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 shortcut) and 0 (do not create shortcut)
Startup shortcut	client.create_menu_shortcut	Client	Defines whether a shortcut to the client is to be created in the startup menu Note on automated console installation: possible values are 1 (create shortcut) and 0 (do not create shortcut)
Installation type NEW	install_type	Server	Specifies whether you update from a 39.4.4.0- or from a 39.5.x system Note on automated console installation: Possible values are r94 (update from 39.4.4.0) and r95 (update from 39.5.x)
Existing server directory NEW	server.path.existing	Server	Specifies the directory in which the existing server is installed

Information

• The following parameters define whether 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 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.

Post Installation

Note

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

---

See also: Install Hotfix, Release Notes, Requirements and Platforms

General

Information

• The following instruction describes the server and client update by automatic installer.
• In order to carry out the following administrative tasks, substantial skills in the corresponding subject areas are required.

Notes

• The automatic installer currently contains no database, hence, this instruction cannot be seen as an instruction for a complete system reinstallation.
• For the server part, the following instruction must be seen as a component of the Server update from 39.4.4.0 to 39.5.0.

The installer provides the following functionalities:

• Optional installation of the following PLANTA project components:
  • Installation of the PLANTA Server
  • Installation of the PLANTA Client
• Installation on a Windows or Linux system
• It is possible to carry out a graphical or automated installation (console installation).
• During the installation, a service is set up, which equates to the server process. The name of the service can be specified in the name of the PLANTA service parameter during the installation. Further information on the PLANTA service .

Requirements

The following components must be installed on the target system:

• Java Version (JDK) 1.6.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.6.0_21)
    • CLASSPATH (e.g. /usr/java/jdk1.6.0_21/bin)
    • PATH (e.g. /usr/java/jdk1.6.0_21/bin:/usr/java/jdk1.6.0_21/jre/bin:$PATH)
  • Also required for Java JDK:
    • JRE_HOME (e.g. /usr/java/jdk1.6.0_21/jre)
    • JAVA_JAR (e.g. /usr/java/java_jar)
• an Oracle or MSSQL database.

Note

• For the installation to run smoothly, the executing user must possess administrator rights (in Windows) or must 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 of all, please choose the components you wish to install (server/client, whereas the client is only available on Windows systems).
  • Then select the corresponding parameters for the 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 automated installation (or console mode) enables an installation without graphical user interface. 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 available parameters, please click here.
  • In order to modify whether a particular component is to be installed in the first place, please set the 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.

Notes on error treatment

• 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 the client is closed immediately after it has been started, this may indicate that the license is wrong. Please check this in the \config\planta_server.conf file.
• 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 upon start of the PLANTA server. It may also be helpful 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 Parameters

The Installer uses different parameters, via which the installation is controlled (for input of these parameters, see here).

Parameter	Name in properties files	Used for component	Meaning
DB log directory	log.path	Server, client	A directory in which a log file with information on the installation is 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
Database type	db.type	Server	Database type Note on automatized console installation: possible values are "Oracle" or "MSSQL"
License	License	Server	Your license number allocated by PLANTA, e.g. 100
Database server	db.server	Server	Name or IP address of the server on which the database is running
Database port	db.oracle.port / db.mssql.port	Server	Port to the database. By default, the Oracle port is 1521 and the MSSQL port is 1433
Database name	db.name	Server	The SID in Oracle, the database name in MSSQL
MSSQL server uses named instance	db.use_named_instance	Server	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 for Oracle databases. Note on automated console installation: possible values are "yes" or "no"
Database instance	db.instance	Server	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	User for which the schema is to be installed
Database password	db.password	Server	Password of the user
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 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 through 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 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.
Hibernate dialect	hibernate.oracle.dialect / hibernate.mssql.dialect	Server	Hibernate dialect, required to communicate with your database. This is a hibernate specific name, which depends on the database version used and should only be changed by administrators. Default values set are de.planta.server.hibernate.dialect.Oracle10gDialect for Oracle or de.planta.server.hibernate.dialect.SQLServerDialect for MSSQL Note on automated console installation: This parameter is named hibernate.oracle.dialect in the properties files for Oracle databases and hibernate.mssql.dialect for MSSQL databases
Hibernate connect class	hibernate.oracle.driver_class / hibernate.mssql.driver_class	Server	Java class required to communicate with hibernate. This is a jdbc specific class, which depends on the database version used and should only be changed by administrators. Default values set are oracle.jdbc.driver.OracleDriver für Oracle or com.microsoft.sqlserver.jdbc.SQLServerDriver for MSSQL Note on automated console installation: This parameter is named hibernate.oracle.dialect in the properties files for Oracle databases and hibernate.mssql.dialect for MSSQL databases
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
Linux group	server.linux.grou=	Server	Linux group to which the Linux installation belongs Note: This parameter is only relevant for installations under Linux
Linux user	server.linux.user	Server	Linux user to which the Linux installation belongs (user that, a.o., starts the server process) Note: This parameter is only relevant for installations under Linux
Expected utilization	system.dimension	Server	How heavily this system will be utilized (small = test system, medium = normal operation, large = many users simultaneously on the system) Note on automated console installation: possible values are small, medium, and large
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 shortcut) and 0 (do not create shortcut)
Startup shortcut	client.create_menu_shortcut	Client	Defines whether a shortcut to the client is to be created in the startup menu Note on automated console installation: possible values are 1 (create shortcut) and 0 (do not create shortcut)

Information

• The following parameters define whether 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 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.

Post Installation

Note

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

---

See also: Install Hotfix, Release Notes, Requirements and Platforms

Note

• The installation instruction of all three components release 39.4 can be found here.