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

Installation/Update with PLANTA Installer From S 39.5.27

Description for versions S 39.5.8 - 39.5.26
Description for versions < S 39.5.8



Information

  • The following instruction describes the server, client, and database installation or update with the PLANTA installer.
  • In the "Installations/Update Parameters" chapter, the information relevant for you is provided in the tab which corresponds to your target release.

Notes

  • The download files for current releases are made available in the PLANTA Transfer Server_
  • In installation, please also observe the release notes applicable to your target release from time to time.

Attention

  • In order to carry out the following administrative tasks, substantial skills in the corresponding subject areas are required.

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
  • Installation/update on a Windows or Linux system
  • Installation/update either graphically or via console
  • During installation/update, a service which 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 installation/update. Further information on the PLANTA server service.
  • Furthermore, the monitoring component can be installed, enabling the monitoring and analysis of the running server.

For general overview on installation, please click here and for a general overview on update, click here

Attention

  • If the installation/update is not finished correctly by installer, this may result in incorrect or invalid data.

Requirements

The following requirements must be met:
  • All requirements described in the System Requirements topic must be met, including the PLANTA project user rights for Oracle databases described in there.
  • On Linux systems, rsync should be available.
  • An Oracle or MSSQL database must be available before installation.
  • 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.

New from S 39.5.29

Attention
  • The components licensed by the customer and their volumes must be specified in the license.conf configuration file and be stored in the server. This step is only obligatory from Server 39.5.29.
  • If no customer-specific license file is stored, the server accesses the file with standard values stored by PLANTA by default. This file may fall far below the volume licensed by the customer.
  • If you have any questions, please contact your responsible PLANTA consultant.

Installation (Update) Procedure

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

Installation/Update via Graphical GUI Surface

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
  • If you have selected Update of an existing system, please specify the update type now:
    • Update from Release 39.4.4.0 to Release 39.5.x (with DB 39.4)
      • 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. Further information on the paramaters can be found in the Installation/Update 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).

Installation/Update via Console

With installation / update via console, installation / update without graphical surface becomes possible.

Procedure

  • For console installation / update, the /install/planta-windows.properties file (for Windows systems) or /install/planta-linux.properties file (for Linux systems) which contains the installation parameters is required.
  • This file is located in the default directory of the installer.
    • In the templates directory, there are also various property files for different, typical installation types (e.g. reinstallation including the 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/update. Further information on the parameters can be found in the Installation/Update 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, monitoring.install, regtests.install, and client.install parameters to "yes" or "no", whereas client.install is only available on Windows systems.
  • Please note that under Windows, 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 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/Update Parameters

Information

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

From S 39.5.29

Parameter Name in properties files Used for component Possible values Meaning
Installation type 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 39.5.x with DB 39.5), "voeToVenus" (migration from 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 relevant if an update is to be carried out, otherwise it can be ignored.
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 installation/update via console under Windows.
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
Database license License Server, monitoring, database e.g. "200" Your license number allocated by PLANTA.
License file NEW license_file Server Complete path to a license file (license.config) License file created by PLANTA which contains information on the number of records you are allowed to create per licensed table.
  • If this parameter is empty, the installer will try to use an existing license file of the existing server installation (only in update installations).
  • Without license file you can only create a very limited number of projects, tasks, etc. (like in a demo system)
  • Do not make any changes to the license file! The file is signed, which means that the server will reject this file if any changes have been made to it and will start as if there was no license file at all. In such a case, please contact PLANTA in order to get a new version.
  • The file can be replaced manually by copying the new file into the config directory and restarting the server.
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 reinstallation 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
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 installation/update via console: When selecting the "auto" value, the installer decides in accordance with 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 in 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, in update installations (DB) it only concerns the standard customizing data; for 'no', only the Python status (customizing) is then updated and a migration is possibly carried out
  • This parameter is only relevant 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 then have to be set to the IP address of the PLANTA server accordingly
  • Note on installation/update via console: 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 installation/update via console under Windows.
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 installation/update via console under Windows.
Python Version python.version Server 3.6.0, 3.4.3 Python version which is installed directly in/with the PLANTA server.
  • This does NOT equate to a possibly preexisting Python version on the installed system. The Python version referred to here is the one which is only installed compellingly for the PLANTA server and which has no influence on other programs.
  • In the server, version 3.6.0 is preset. This version, however, compellingly requires DB version 39.5.13 or later. For this database version we explicitly recommend that you use the preset Python version 3.6.0. If the installation is done with a DB version < DB 39.5.13, the former Python version 3.4.3 is automatically used by the installer.
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 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.
  • 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 installation/update via console: 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:
Activate web services for PLANTA pulse? 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 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 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? 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 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 planta.services.generic.port Server e.g. "23456" Port on which the web services for PLANTA link are to run.
Activate web service documentation? 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 planta.services.doc.host Server   Host on which the web service documentation is to run.
IP address for web service documentation 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 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 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? 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 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 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 installation/update via console under Windows.
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 installation/update via console under Windows.
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 installation/update via console under Windows.
      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.

      From S 39.5.27

      Parameter Name in properties files Used for component Possible values Meaning
      Installation type 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 installation/update via console.
      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
      Database 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 reinstallation 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 installation/update via console: When selecting the "auto" value, the installer decides in accordance with 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 in 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, in 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 then have to be set to the IP address of the PLANTA server accordingly
      • Note on installation/update via console: 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 installation/update via console.
      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 installation/update via console.
      Python Version NEW python.version Server 3.6.0, 3.4.3 Python version which is installed directly in/with the PLANTA server.
      • This does NOT equate to a possible Python version available on the installed system. The Python version referred to here is the one which is only installed compellingly for the PLANTA server and which has no influence on other programs.
      • In server 39.5.27, version 3.6.0 is preset. This version, however, compellingly requires DB version 39.5.13 or later. For this database version we explicitly recommend that you use the preset Python version 3.6.0. If the installation is done with a DB version < DB 39.5.13, the former Python version 3.4.3 is automatically used by the installer.
      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 installation/update via console: 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:
      Activate web services for PLANTA pulse? 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 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 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? 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 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 planta.services.generic.port Server e.g. "23456" Port on which the web services for PLANTA link are to run.
      Activate web service documentation? 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 planta.services.doc.host Server   Host on which the web service documentation is to run.
      IP address for web service documentation 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 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 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? 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 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 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 installation/update via console.
      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 installation/update via console.
      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 installation/update via console.
          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.

          The following parameters determine which component is to be installed/upgraded

          • 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.

          Name in properties files Used for component Values Meaning
          Server installation server.install   "yes", "no" Specifies whether server-specific steps are to be carried out. These are, e.g.
          • installation or update of the binary server files,
          • Minor adjustments to the database in order to guarantee server start (i.e. the migration packets of the Server component)
          • and/or installation / update of server-specific Python files.
          Database installation db.install   "yes", "no" 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. in DB 39.4.4.0 with S 39.5.x the migration packets of the Customizing Hotfix component, in DB 39.5.x those of the Customizing component, After DB Import as well as Before DB Import)
          • and/or installation / update of customizing-specific Python files.

          In updates with DB39.4.4.0 and S39.5.x, the db.install parameter must be set to = yes.
          Monitoring installation monitoring.install   "yes", "no" Specifies whether the monitoring component for monitoring the PLANTA servers is to be installed.
          Regtest installation regtests.install   "yes", "no" Specifies whether the regression tests are to be installed, with the help of which the functioning of the PLANTA server can be checked after successful installation.
          Client installation client.install   "yes", "no" Specifies whether a PLANTA client is to be installed.
          The client installation is only available for installation on Windows computers.

          Additional parameters

          • Usually, the parameters specified above are sufficient for an installation / update. For special cases, there are, however, some additional parameters, which can be added to planta-windows.properties or planta-linux.properties (only for installation/update via console).

          Name in properties files Used for component Values Meaning
          Manual connect string db.manual_connection_string Database, server A 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 such a case, the installer composes connection string internally from the db.type, db.server, db.name, db.user, db.port, and (only for MSSQL) db.use_named_instance & db.instance parameters.
          • An example of a connection string could be jdbc:oracle:thin:@someOracleServer:1521:someDb or jdbc:sqlserver://someMSSQLServer:1433
          • Since this presents an advanced or unrecommended option, this parameter does not exist in the standard properties file and must be added manually if required.
          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 compose 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 standard parameters.
          • Since this presents an advanced or unrecommended option, this parameter does not exist in the standard properties file and must be added manually if required.
          Alternative sql directory planta.alternative_sql_directory   Absolute path Enables the use of an alternative directory for 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 this is the path under which the installer searches the scripts.
          • The subdirectories and the files they contain are processed in alphabetic order.
          • When an Oracle database is used, 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.
          Alternate migration directory alternative_migration_directory   Absolute path Enables the use of an alternative directory for migration packets and for 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 this is the path under which the migration framework searches the scripts.
          • 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 during 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 (as of Server-HF21) does NOT work for packets in the after_db_import! migration directory
          Temporary directory temp.path   A relative or absolute path The installer copies some auxiliary files to a temporary directory (and adjusts them in accordance 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 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

                   PLANTA project







           
          • Suche in Topic-Namen

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