Parameter |
Name in properties -Dateien |
Verwendet für Komponente |
Mögliche Werte |
Bedeutung |
Installationsart |
planta.install_type |
Client, Server, Datenbank |
"new", "update" |
Gibt an, ob eine Neuinstallation gemacht oder ein bestehendes System upgedated werden soll. - Neuinstallation bedeutet implizit eine Installation von 39.5 (Datenbank und/oder Server).
|
Updateart |
planta.update_type |
Client, Server, Datenbank |
"r94" (Update von 39.4.4.0), "r95" (Update von 39.5.X mit DB 39.4), "venus" (Update von bestehendem 39.5.X-System mit DB 39.5), "voeToVenus" (Migrieren von 39.5 mit DB 39.4 zu 39.5 mit DB 39.5) |
Gibt im Falle des Updates an, welcher Art das zu aktualisierende System ist, d. h., ob es sich um ein 39.4.4.0- oder ein 39.5.X-System (mit DB 39.4 oder DB 39.5) handelt. - Dieser Parameter ist nur von Bedeutung, wenn ein Update durchgeführt werden soll und kann ansonsten ignoriert werden.
|
DB-Log-Verzeichnis |
log.path |
Client, Server, Datenbank |
|
Ein Verzeichnis, in dem Log-Files mit Informationen zu Installation und Updates gespeichert werden. - Es muss Schreibrecht auf diesem Verzeichnis bestehen.
- Achten Sie bei Installation/Update per Konsole zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
|
Server nach der Installation starten? |
server.start_server |
Client, Server, Datenbank |
"yes", "no" |
Gibt an, ob der Server nach erfolgreicher Installation automatisch gestartet werden soll. - Es kann durchaus einige Minuten dauern, bis der Server vollständig gestartet wurde und Client-Verbindungen annimmt.
|
Wie Datenbank installieren? |
db.install_type |
Datenbank |
"existing" (Verwendung von vorhandenem Datenbank-User), "new" (Anlegen eines neuen Datenbank-Users) |
Gibt an, ob für die Datenbank ein neuer Benutzer angelegt oder ein bereits vorhandener Benutzer verwendet werden soll.- Dieser Parameter ist nur von Bedeutung, wenn eine neue Datenbank installiert werden soll. Bei Update einer bestehenden Datenbank wird er ignoriert.
|
Datenbank-Typ |
db.type |
Datenbank, Server |
"Oracle", "MSSQL" |
Datenbanktyp |
Datenbank-Lizenz |
License |
Server, Monitoring, Datenbank |
z.B. "200" |
Ihre von PLANTA vergebene Lizenznummer. |
Datenbank-Server |
db.server |
Server, Monitoring, Datenbank |
z.B. "srvPLANTA", "192.168.10.20" |
Der Name bzw. IP-Adresse des Servers, auf dem die Datenbank läuft. |
Datenbank-Port |
db.port |
Server, Monitoring, Datenbank |
z.B. "1521" (Oracle), "1433" (MSSQL) |
Der Port zur Datenbank. Standardmäßig lautet dieser "1521" für Oracle und "1433" für MSSQL. - Wird eine MSSQL-Datenbank mit benannter Instanz verwendet, hat die Instanz standardmäßig eine eigene Port-Nummer, die hier angegeben werden muss.
|
Datenbank-Name |
db.name |
Server, Monitoring, Datenbank |
|
Bei Oracle die SID, bei MSSQL der Datenbank-Name. - Bei einer Neuinstallation mit neuem Benutzer in MSSQL ist dies der Name der neuen Datenbank, bei Verwendung von vorhandenem Benutzer der Name einer bereits existierenden Datenbank.
In Oracle hingegen wird hier immer eine vorhandene Datenbank angegeben, für die lediglich u.U. ein neuer Benutzer angelegt wird. |
Oracle Tablespace |
db.tablespace |
Datenbank |
|
Gibt an, welchem Oracle-Tablespace ein neuer Datenbank-Benutzer zugeordnet werden soll. - Dieser Parameter ist nur für Neuinstallationen auf einer Oracle-Datenbank von Bedeutung, bei der ein neuer Benutzer angelegt werden soll. Für alle anderen Installationsszenarien (Update / Neuinstallation mit MSSQL-Datenbank / Neuinstallation mit einem bereits vorhandenen Benutzer) kann der Parameter ignoriert werden.
|
MSSQL-Server verwendet benannte Instanz |
db.use_named_instance |
Server, Monitoring, Datenbank |
"yes", "no" |
Gibt bei MSSQL-Datenbanken an, ob auf eine benannte Instanz verbunden werden soll oder auf die Default-Instanz. - Dieser Parameter ist nur für MSSQL-Datenbanken von Bedeutung. Kann bei Oracle-Datenbanken ignoriert werden.
|
Datenbank-Instanz |
db.instance |
Server, Monitoring, Datenbank |
|
Der Name der MSSQL-Instanz, an die sich verbunden werden soll. - Dieser Parameter ist nur für MSSQL-Datenbanken von Bedeutung, die benannte Instanzen verwenden. Kann bei MSSQL-Datenbanken, die die Default-Instanz benutzen, sowie bei Oracle-Datenbanken ignoriert werden.
|
Datenbank-Benutzer |
db.user |
Server, Monitoring, Datenbank |
|
Der Benutzer, für den das Schema installiert werden soll. - Bei einer Neuinstallation mit neuem Benutzer ist dies der Name des Benutzers, der neu angelegt wird. Ansonsten ist dies der Name eines bereits existierenden Benutzers.
- Zur Installationszeit dürfen für den Datenbank-User keine Synonyme (public oder private) existieren. Zur Laufzeit ist dies erlaubt. Wenn zu einem späteren Zeitpunkt Daten importiert werden sollen (z.B. bei einem DB-Update), müssen die Synonyme wiederum deaktiviert werden.
|
Datenbank-Passwort |
db.password |
Server, Monitoring, Datenbank |
|
Das Passwort des Benutzers. |
Datenbank-Admin Username |
db.user_privileged |
Datenbank |
|
Der Name des Benutzers mit den Rechten, einen neuen Benutzer anzulegen. - Dieser Parameter ist nur von Bedeutung, falls ein neuer Benutzer angelegt werden soll, und kann ansonsten ignoriert werden.
|
Datenbank-Admin Passwort |
db.password_privileged |
Datenbank |
|
Das Passwort des neuen Benutzers. - Dieser Parameter ist nur von Bedeutung, falls ein neuer Benutzer angelegt werden soll, und kann ansonsten ignoriert werden.
|
Manueller Connect-String |
db.manual_connection_string |
Datenbank, Server |
Ein Connection-String zu einer bestimmten Datenbank, z.B. jdbc:oracle:thin:@someOracleServer:1521:someDb oder jdbc:sqlserver://someMSSQLServer:1433 |
Stellt die Option zur Verfügung, den Connection-String zu einer bestimmten Datenbank von Hand anzugeben. Dies beeinflusst sowohl die Art und Weise, wie der Installer selbst auf die Datenbank zugreift (z.B. beim Anlegen des neuen Datenbank-Benutzers), und wie der Server bzw. Hibernate darauf zugreift (in der Datei <server>/config/hibernate.cfg.xml)- Es wird empfohlen, dies nur zu tun, falls die Datenbank-Verbindung in irgendeiner Weise vom Standard abweicht.
- Standardmäßig wird der Connection-String vom Installer intern aus den Parametern zusammengebaut
db.type , db.server , db.name , db.user , db.port sowohl (nur für MSSQL) db.use_named_instance & db.instance . - Hinweis zur automatischen Konsolen-Installation: Da dies eine fortgeschrittene bzw. nicht empfohlene Option darstellt, existiert dieser Parameter nicht im Standard-Properties-File und muss, falls erwünscht, daher von Hand hinzugefügt werden. Siehe dazu den Abschnitt Zusätzliche Parameter unten.
|
Manueller Connect-String für Administrator |
db.manual_connection_priv_string |
Datenbank |
Ein Connection-String zu einer bestimmten Datenbank (für den Administrator) |
Dieser manuelle Connection-String ist für den Spezialfall gedacht, dass der Administrator (der DB-User, mit dessen Hilfe der Planta-DB-User angelegt wird (s. den Parameter Datenbank-Admin Username), einen speziellen Anmelde-String benötigt.- Dieser String sollte in der Regel identisch zu dem Connection-String von
db.manual_connection_string sein. Insbesondere sollte, falls db.manual_connection_string angegeben wurde, dieser String auch angegeben werden. Ansonsten wird der Installer versuchen, den Anmelde-String aus den Standard-Parametern db.type , db.server , db.name , db.user , db.port sowohl (nur für MSSQL) db.use_named_instance & db.instance aufzubauen. - Hinweis zur automatischen Konsolen-Installation: Da dies eine fortgeschrittene bzw. nicht empfohlene Option darstellt, existiert dieser Parameter nicht im Standard-Properties-File und muss, falls erwünscht, daher von Hand hinzugefügt werden. Siehe dazu den Abschnitt Zusätzliche Parameter unten.
|
Migration ausführen? |
db.migrate |
Datenbank |
"auto", "yes" und "no" |
Gibt an, ob bei der Installation eine datenbank-spezifische Migration auf die neue Datenbank-Version ausgeführt werden soll.- Die Entscheidung, ob eine Migration durchgeführt werden soll, wird in der Regel durch die Kombination der Parameter
Installationsart und Updateart bestimmt und entsprechend vorbelegt. Der Parameter Migration ausführen? sollte daher in aller Regel nicht geändert werden. - Hinweis für Installation/Update per Konsole:Bei Wahl des Wertes "auto" entscheidet der Installer anhand der gewählten Installationsart, ob eine Migration durchgeführt wird. "yes" und "no" überschreibt diese Entscheidung.
|
Datenbank-Schema erstellen/anpassen? |
db.create_schema |
Datenbank |
"yes", "no" |
Gibt bei Datenbank-Neuinstallation an, ob das neue Schema mit den PLANTA-Tabellen angelegt werden soll und ob (bei Updates) einige neu eingeladene PLANTA-Daten angepasst werden sollen (z.B. die Lizenz). - Dieser Parameter ist nur bei Venus-Installationen von Bedeutung und kann ansonsten ignoriert werden.
- Es wird dringend empfohlen, diese Checkbox aktiviert bzw. den Konsolen-Parameter auf "yes" zu belassen, da ansonsten eine Datenbank auf neue Art und Weise angelegt werden muss, was nicht trivial ist.
|
Daten einladen? |
db.load_data |
Datenbank |
"yes", "no" |
Gibt bei Datenbankinstallation an, ob die Daten von PLANTA in die Datenbank importiert werden sollen. Bei Neuinstallation betrifft das sämtliche Tabellen, bei Update-Installationen (DB) betrifft das nur die Standard-Customizing-Daten; es wird dann bei 'no' nur der Python-Stand (Customizing) aktualisiert und evtl. eine Migration durchgeführt- Dieser Parameter ist nur bei Venus-Installationen von Bedeutung und kann ansonsten ignoriert werden.
- Es wird dringend empfohlen, diese Checkbox aktiviert bzw. den Konsolen-Parameter auf "yes" zu belassen, da ansonsten die Daten auf andere Weise importiert werden müssen, was nicht trivial ist.
|
DB-Synonyme aktivieren? |
db.synonyms |
Server |
"yes", "no" |
Gibt an, ob Hibernate Datenbank-Synonyme verwenden soll oder nicht. - Es wird empfohlen, Synonyme auszuschalten, da dies die Performance verbessert.
|
Server-IP-Adresse |
SERVER_IP |
Server, Client |
z.B. "192.168.10.20" |
Die IP-Adresse des PLANTA-Servers. - Wird auch für den Client benutzt und müsste dann entsprechend auf die IP-Adresse des PLANTA-Servers gesetzt werden.
- Hinweis für Installation/Update per Konsole: Dieser Parameter fehlt in den properties-files, da der Installer automatisch die IP-Adresse des Servers verwendet, auf dem die Installation stattfindet. Fügen Sie diesen Parameter einem properties-file hinzu, falls die IP-Adresse des aktuellen Rechners nicht die Adresse des PLANTA-Servers ist.
|
Port |
PORT |
Server, Client |
z.B. "12345" |
Die Port-Nummer, über die der Server mit den Clients kommuniziert. Dies sollte eine fünfstellige Nummer kleiner 30000 sein, die von keinem anderen Prozess verwendet wird. |
Name des PLANTA-Server-Dienstes |
service.name |
Server |
|
Der Name des Dienstes, der dem PLANTA-Server zugeordnet ist. - Dieser Name muss eindeutig für jedes PLANTA-System sein. Das heißt, wenn Sie beispielsweise ein Test- und ein Produktivsystem auf dem gleichen Server installieren, müssen diese unterschiedliche Dienst-Namen haben.
|
Neues Server-Verzeichnis |
server.path |
Server |
|
Das Verzeichnis, in das der PLANTA project-Server installiert werden soll. - Es muss Schreibrecht auf diesem Verzeichnis bestehen. Achten Sie bei Installation/Update per Konsole zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
|
Bestehendes Server-Verzeichnis |
server.path.existing |
Server |
|
Das Verzeichnis, in welchem sich der alte PLANTA project-Server befindet.- Dieser Parameter ist nur von Bedeutung, wenn ein Update durchgeführt werden soll und kann ansonsten ignoriert werden.
- Aus diesem Pfad werden bei Updates einige Python-Dateien in den neu installierten Server übernommen. Dieser Pfad darf nicht mit dem neuen Server-Pfad
server.path identisch sein. Achten Sie bei Installation/Update per Konsole zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden. |
Python-Version NEU |
python.version |
Server |
3.6.0, 3.4.3 |
Die Python-Version, die mit bzw. direkt im Planta-Server installiert wird.- Dies entspricht NICHT der eventuell bereits auf dem installierten System bereits vorhandenen Python-Version. Es geht hier um die Python-Version, die nur für den Planta-Server zwingend installiert wird und die keinen Einfluss auf andere Programme hat.
- Im Server 39.5.27 ist die Version 3.6.0 voreingestellt. Diese verlangt jedoch zwingend die Datenbank-Version 39.5.13 oder höher. Für diese Datenbankversionen empfehlen wir explizit, die voreingestellte Python-Version 3.6.0 zu verwenden. Wird die Installation jedoch mit einer DB-Version < DB 39.5.13 gemacht, wird vom Installer automatisch die alte Python-Version 3.4.3 verwendet.
|
Datenbank-Schema an Server-Hotfix anpassen? |
server.update_schema |
Server |
"yes", "no" |
Gibt an, ob das Schema des Servers soweit angepasst werden soll, um den Start des Servers zu garantieren. - Dieser Parameter wird bei Venus-Neuinstallationen ignoriert, da hier eine neue Datenbank mit dem jeweils aktuellen Stand angelegt wird.
- Es wird dringend empfohlen, diese Checkbox aktiviert bzw. den Konsolen-Parameter auf "yes" zu belassen, da ansonsten die entsprechenden Skripte manuell ausgeführt werden müssen, was nicht trivial ist.
|
Migration ausführen? |
server.migrate |
Server |
"auto", "yes" und "no" |
Gibt an, ob bei der Installation eine server-spezifische Migration auf die neue Server-Version ausgeführt werden soll. - Dieser Parameter sollte in aller Regel aktiviert bzw. auf dem Standard-Wert 'yes' belassen werden (sowohl bei Neuinstallation als auch bei Update-Installation), da das Migrationsframework selbst entscheidet, welche Migrationspakete wann auszuführen sind.
- Hinweis für Installation/Update per Konsole: Der alte Standard-Wert "auto" ist obsolet und wird nun als 'yes' interpretiert.
|
Name der User-Gruppe |
service.user.group |
Server, Monitoring |
z.B. "Benutzer" |
Die Gruppe, dem die Installation gehört.- Hinweis für Windows: Bei Windows-Systemen sollte dies entweder die Gruppe mit dem Namen "Benutzer" sein, oder (bei englischem Betriebssystem) die Gruppe mit Namen "user".
|
Service-Benutzer |
service.user.name |
Server, Datenbank, Monitoring |
|
Der Linux-User, dem die Linux-Installation gehört und der den PLANTA Server-Dienst startet.- Dieser Parameter ist nur für eine Installation unter Linux von Belang.
- Im Rahmen der Installation dieser Benutzer mit sudo verwendet, um Sub-Prozesse zu starten (z.B. die Migration)
|
Erwartete Nutzlast |
system.dimension |
Server |
"small", "medium", "large" |
Wie stark wird dieses System ausgelastet werden? - Gering = Testsystem (= 10 Sessions gleichzeitig)
- Mittel = Normalbetrieb (= 25 Sessions gleichzeitig)
- Hoch = viele Benutzer gleichzeitig auf dem System (= 75 Sessions gleichzeitig).
Durch die Festlegung werden dimensionierungsrelevante Parameter in den Konfigurationsdateien des PLANTA-Servers gesetzt. Nach einer Installation/einem Update muss geprüft werden, ob diese Einstellung der voraussichtlichen Nutzung des PLANTA-Systems entspricht. Hierzu gehören u.a. die folgenden Parameter: -
hibernate.cfg.xml -
c3p0.min_size -
c3p0.max_size -
c3p0.timeout -
c3p0.numHelperThreads
-
globals.conf |
Webservices für PLANTA pulse aktivieren? |
planta.services.enable |
Server |
"yes", "no" |
Gibt an, ob die Webservices für PLANTA pulse aktiviert werden sollen. |
IP-Adresse der Webservices für PLANTA pulse |
planta.services.interface |
Server |
z.B. "srvWebPLANTA", "192.168.10.30" |
Die IP-Adresse des Rechners, auf der die Webservices für PLANTA pulse laufen sollen. |
Port der Webservices für PLANTA pulse |
planta.services.port |
Server |
z.B. "23456" |
Der Port, auf dem die Webservices für PLANTA pulse laufen sollen. |
Webservices für PLANTA link aktivieren? |
planta.services.generic.enable |
Server |
"yes", "no" |
Gibt an, ob die Webservices für PLANTA link aktiviert werden sollen. |
IP-Adresse der Webservices für PLANTA link |
planta.services.generic.interface |
Server |
z.B. "srvWebPLANTA", "192.168.10.30" |
Die IP-Adresse des Rechners, auf der die Webservices für PLANTA link laufen sollen. |
Port der Webservices für PLANTA link |
planta.services.generic.port |
Server |
z.B. "23456" |
Der Port, auf dem die Webservices für PLANTA link laufen sollen. |
Dokumentation für die Webservices aktivieren? |
planta.services.doc.activate |
Server |
"yes", "no" |
Gibt an, ob die Dokumentation der Webservices aktiviert werden soll. - Es ist durchaus möglich, die Dokumentation der Webservices zu aktivieren, wenn die Webservices selbst nicht aktiviert sind.
|
Host für Webservice-Dokumentation |
planta.services.doc.host |
Server |
|
Der Host, auf dem die Webservice-Dokumentation laufen soll. |
IP-Adresse für Webservice-Dokumentation |
planta.services.doc.interface |
Server |
z.B. "srvWebPLANTA", "192.168.10.31" |
Die IP-Adresse des Rechners, auf der die Webservice-Dokumentation laufen soll. |
Port für Webservice-Dokumentation |
planta.services.doc.port |
Server |
z.B. "23457" |
Der Port, auf dem die Webservice-Dokumentation laufen soll. |
Hostname für die generierten cURL -Statements der Webservice-Dokumentation |
services_doc_hostname |
Server |
z.B. "srvWebPLANTA" |
curl -Statements der Dokumentationsschnittstelle werden passend zu der hier eingetragenen Server-URL generiert. |
SSL aktivieren? |
planta.services.ssl.enable |
Server |
"yes", "no" |
Falls diese Option gewählt wird, laufen die Webservices nur noch über verschlüsselte Verbindungen (https) |
Keystore-Pfad für SSL |
planta.services.ssl.keystore.path |
Server |
z.B.:web-inf/resources/ssl |
Pfad zum Java Keystore (JKS), der die Schlüsselpaare bzw. Zerifikate für SSL benötigt |
Passwort für SSL |
planta.services.ssl.password |
Server |
z.B. "123456" |
Passwort für den Java Keystore |
Coredumps erstellen? |
debug.coredumps |
Server |
"1" (Coredump erstellen), "0" (Coredump nicht erstellen) |
Gibt an, ob bei einem Absturz ein Coredump-File mit dem aktuellen Systemzustand erstellt wird. - Dies ist vor allem ein Debug-Parameter. Dieser Coredump kann u.U. recht groß werden.
|
Pfad zu Coredumps |
debug.coredump_path |
Server |
|
Gibt an, wo ein etwaiger Coredump erstellt werden soll (s. Parameter Coredumps erstellen? ).- Dies ist vor allem ein Debug-Parameter.
- Es muss Schreibrecht auf diesem Verzeichnis bestehen. Achten Sie bei Installation/Update per Konsole zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
|
Client-Verzeichnis |
client.path |
Client |
|
Das Verzeichnis, in das der PLANTA project-Client installiert werden soll.- Es muss Schreibrecht auf diesem Verzeichnis bestehen. Achten Sie bei Installation/Update per Konsole zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
|
Desktop-Shortcut |
client.create_desktop_shortcut |
Client |
"1" (Verknüpfung erstellen), "0" (Verknüpfung nicht erstellen) |
Legt fest, ob eine Verknüpfung zum Client auf dem Desktop angelegt werden soll |
Startup-Shortcut |
client.create_menu_shortcut |
Client |
"1" (Verknüpfung erstellen), "0" (Verknüpfung nicht erstellen) |
Legt fest, ob eine Verknüpfung zum Client im Startup-Menu angelegt werden soll |
Monitoring aktiviert |
planta.monitoring.enable |
Server |
"true", "false" |
Gibt an, ob die Monitoring-Komponente für den Server aktiviert werden soll.- Dieser Wert wird automatisch gesetzt, falls ein Port der Monitoring-Schnittstelle angegeben wird, und kann i.d.R. ignoriert werden.
|
Port der Monitoring-Schnittstelle |
planta.monitoring.port |
Server, Monitoring |
z.B. "12345" |
Die Port-Nummer, über die der Server mit der Monitoring-Komponente kommuniziert. Dies sollte eine fünfstellige Nummer kleiner 30000 sein, die von keinem anderen Prozess verwendet wird. - Kann ignoriert werden, falls die Monitoring-Komponente nicht installiert wird.
|
Monitoring Interface IP |
planta.monitoring.interface |
Server |
z.B. "localhost", "192.168.10.20" |
Gibt die IP-Adresse der Monitoring-Komponente an.- Dieser Wert wird auf "localhost" gesetzt, falls ein Port der Monitoring-Schnittstelle angegeben wird, und kann i.d.R. ignoriert werden.
|
Port der Web-Schnittstelle |
monitoring.port |
Monitoring |
z.B. "12345" |
Die Port-Nummer des Web-Dienstes für die Monitoring-Komponente. Dies sollte eine fünfstellige Nummer kleiner 30000 sein, die von keinem anderen Prozess verwendet wird. - Dieser Parameter unterscheidet sich von
planta.monitoring.port . |
Monitoring-Verzeichnis |
monitoring.path |
Monitoring |
|
Das Verzeichnis, in das die Monitoring-Komponente installiert werden soll. - Es muss Schreibrecht auf diesem Verzeichnis bestehen. Achten Sie bei Installation/Update per Konsole zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
|
Name des Monitoring-Dienstes |
monitoring.service |
Monitoring |
|
Der Name des Dienstes, der der Monitoring-Komponente zugeordnet ist. - Dieser Name muss eindeutig für jede Monitoring-Komponente sein. Das heißt, wenn Sie z.B. Monitoring-Komponenten sowohl für ein Test- und ein Produktivsystem auf dem gleichen Server installieren, müssen diese unterschiedliche Service-Namen haben.
|