Informationen

  • Die nachfolgende Anleitung beschreibt die Installation / das Update von Server und Datenbank mit dem PLANTA-Installer.
  • Im Kapitel "Installations-/Update-Parameter" sind die Informationen in demjenigen Reiter für Sie relevant, der Ihrem Ziel-Release entspricht.

Hinweise

  • Die Download-Dateien zu aktuellen Releases stehen Ihnen auf dem PLANTA-Transfer-Server zur Verfügung.
  • Bitte beachten Sie bei der Installation / dem Update auch die für Ihr Ziel-Release gültigen Releases und Downloads.
  • Eine Übersicht des Installationsprozesses finden Sie hier und des Update-Prozesses hier.

Achtung

  • Als Voraussetzung zur Durchführung der nachfolgenden Administrationsaufgaben sind fundierte Kenntnisse in den jeweiligen Fachgebieten erforderlich.

Allgemein

Der Installer stellt folgende Funktionalitäten bereit:

  • Neuinstallation
    • Diese beinhaltet die Installation aller drei Komponenten: PLANTA-Datenbank (PLANTA-Standard) und PLANTA-Server
  • Update (Aktualisierung)
    • einzelner Komponenten oder
    • aller drei Komponenten auf einmal
    • Die Aktualisierung des Servers bzw. der Datenbank mit dem Installer ist nur ein Teil des jeweiligen Update-Prozesses. Die Anleitungen zum kompletten Update-Prozess der jeweiligen Komponente finden Sie in folgenden Topics:
  • Installation/Update auf einem Windows- oder Linux-System
  • Installation/Update wahlweise grafisch oder per Konsole
  • Bei der Installation / dem Update wird ein Dienst eingerichtet, der dem Server-Prozess entspricht. Der Name des Dienstes kann bei der Installation / dem Update im Parameter Name des PLANTA-Server-Dienstes angegeben werden. Weitere Informationen zum PLANTA-Server-Dienst.
  • Des Weiteren kann die Monitoring-Komponente installiert werden, die eine Überwachung und Analyse des laufenden Servers gestattet.

Achtung

  • Wird die Installation / das Update mit dem Installer nicht korrekt beendet, kann es zu fehlerhaften oder ungültigen Daten kommen.

Voraussetzungen

Die folgenden Voraussetzungen müssen erfüllt sein:

  • Sämtliche im Topic Systemvoraussetzungen beschriebenen Voraussetzungen müssen erfüllt sein, z.B. die dort beschriebenen PLANTA project-User-Rechte für die Oracle-Datenbank.
  • In Linux-Systemen muss rsync vorhanden sein.
  • Eine Oracle- oder MSSQL-Datenbank muss vorhanden sein.
  • Der ausführende Benutzer muss fundierte Kenntnisse in den erforderlichen Fachbereichen aufweisen und als Administrator (Windows) bzw. root (Linux) am Server angemeldet sein. Unter Windows kann die Installation auch über das Kontextmenü Als Administrator ausführen gestartet werden.

Achtung

  • Die vom Kunden lizenzierten Komponenten und deren Volumen müssen in der Konfigurationsdatei license.conf festgehalten werden und im Server hinterlegt werden. Dieser Schritt ist ab Server 39.5.29 obligatorisch.
  • Wird keine kundenspezifische Lizenzdatei hinterlegt, greift der Server auf die von PLANTA defaultmäßig hinterlegte Datei mit Standardwerten zu, die vermutlich das vom Kunden lizenzierte Volumen weit unterschreiten.
  • Bei Fragen wenden Sie sich bitte an Ihren zuständigen PLANTA-Consultant.

Vorgehensweise zur Installation / zum Update

Es stehen zwei Modi für die Installation zur Verfügung: die grafische GUI-Installation und die automatisierte Konsoleninstallation. Beide Möglichkeiten stehen sowohl für Windows als auch Linux zur Verfügung.

Installation/Update per graphische GUI-Oberfläche

Vorgehensweise

  • Führen Sie bitte das Skript install_planta.bat (auf Windows-Systemen) bzw. install_planta.sh (auf Linux-Systemen) aus.
  • Wählen Sie zuerst die Art der Installation aus (Erstinstallation oder Update).
    • Erstinstallation von Release 39.5
    • Update eines bestehenden Systems
  • Wählen Sie die Komponenten, die Sie installieren möchten (Datenbank und/oder Server).
  • Wählen Sie dann die entsprechenden Parameter für die Installation von Datenbank und/oder Server. Näheres zu den Parametern finden Sie im Abschnitt Installations-/Update-Parameter.
  • Danach wird der Installer die Dateien auf Ihr System kopieren und einige Skripte ausführen, um ihr System zu konfigurieren.
    • Bitte haben Sie Geduld, dieser Schritt kann je nach Systemleistung einige Zeit beanspruchen.
  • Danach sind die von Ihnen gewählten Komponenten einsatzbereit.
  • Die Angabe von Pfaden erfolgt betriebssystemspezifisch (Windows/Linux).

Installation/Update per Konsole

Mit der Installation / dem Update per Konsole ist eine Installation / ein Update ohne grafische Oberfläche möglich.

Vorgehensweise

  • Für die Installation / das Update per Konsole ist die Datei /install/planta-windows.properties (für Windows-Systeme) bzw. /install/planta-linux.properties (für Linux-Systeme) erforderlich, die die Parameter der Installation / des Updates enthält.
  • Diese Datei befindet sich im Standard-Verzeichnis des Installers.
    • Unter dem Verzeichnis templates befinden sich auch diverse properties-Dateien für verschiedene, typische Installationsarten (etwa Neuinstallation einschließlich Anlegen eines neuen Datenbank-Users, Neuinstallation auf einem bestehenden Datenbank-User, Migration von einem existierenden Venus-on-Earth-System auf Venus, Einspielen eines neuen Hotfix in ein bestehendes Venus-System etc.). Das passende properties-File kann nun je nach gewünschter Installationsart in das Hauptverzeichnis des Installers kopiert werden (d.h., die vorhandene Datei überschreiben).
  • Editieren Sie nun diese Datei, um die Parameter für Ihre Installation / Ihr Update einzustellen. Näheres zu den vorhandenen Parametern finden Sie weiter unten im Abschnitt Installations-/Update-Parameter.
  • Ein Update kann durchaus etwas länger dauern (besonders bei dem Schritt [ Processing package: (x/y) ] ). Bitte brechen Sie den Prozess an dieser Stelle nicht ab!
  • Um einzustellen, ob eine bestimmte Komponente überhaupt installiert/upgedatet werden soll, setzen Sie die Parameter db.install, server.install, monitoring.instal und regtests.install auf "yes" oder "no".
  • Bitte beachten Sie, dass unter Windows Pfade nicht mit einem einfachen Backslash getrennt werden, sondern mit doppeltem Backslash.
    • z.B. C:\\planta\\server anstatt C:\planta\server
  • Führen Sie danach das Skript install_planta_with_template.bat (auf Windows-Systemen) bzw. install_planta_with_template.sh (auf Linux-Systemen) aus.
  • Warten Sie nun, während der Installer automatisch Dateien auf Ihr System kopiert und Skripte ausführt.
    • Bitte haben Sie Geduld, dieser Schritt kann je nach System einige Zeit beanspruchen.
  • Danach sind die von Ihnen gewählten Komponenten einsatzbereit.

Achtung

  • Bei der Installation / dem Update per Konsole dürfen lediglich die oben genannten Dateien /install/planta-linux.properties und /install/planta-windows.properties angepasst werden.
  • Alle Dateien unter /scripts, insbesondere scripts/temp.linux.properties und scripts/temp.windows.properties, dürfen nicht abgeändert werden.

Installations-/Update-Parameter

Informationen

ParameterName in properties -DateienVerwendet für KomponenteMögliche WerteBedeutung
Installationsart
planta.install_typeServer, 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).
Updateartplanta.update_typeServer, Datenbank"venus" (Update von 39.5.x auf 39.5.y)Gibt im Falle des Updates an, welcher Art das zu aktualisierende System ist. Seit der Server-Version 39.5.30 werden ausschließlich Updates von Venus-zu-Venus unterstützt.
DB-Log-Verzeichnislog.pathServer, 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 unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Server nach der Installation starten?server.start_serverServer, 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_typeDatenbank"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-Typdb.typeDatenbank, Server"Oracle", "MSSQL"Datenbanktyp
Datenbank-LizenzLicenseServer, Monitoring, Datenbankz.B. "200"Ihre von PLANTA vergebene Lizenznummer.
Lizenzdateilicense_fileServerKompletter Pfad zu einer Lizenzdatei (license.config)
Die von PLANTA erstellte Lizenzdatei mit Informationen darüber, wie viele Datensätze pro lizensierter Tabelle Sie anlegen dürfen.
  • Ist dieser Parameter leer, wird der Installer versuchen, eine vorhandene Lizendatei der existierenden Server-Installation zu verwenden (nur bei Update-Installationen).
  • Ohne Lizenzdatei können Sie nur eine sehr begrenzte Anzahl von Projekten, Vorgängen etc. anlegen (wie in Demo-Systemen).
  • Führen Sie keine Änderungen an der Lizenzdatei durch! Die Datei ist signiert, was heißt, dass der Server diese Datei bei Änderungen verweigert und so startet, als gäbe es keine Lizenzdatei. Wenden Sie sich in diesem Fall bitte an PLANTA, um eine neue Version zu erhalten.
  • Die Datei kann manuell ausgetauscht werden, indem sie ins config-Verzeichnis kopiert und der Server neugestartet wird.
Datenbank-Serverdb.serverServer, Monitoring, Datenbankz.B. "srvPLANTA", "192.168.10.20"Der Name bzw. IP-Adresse des Servers, auf dem die Datenbank läuft.
Datenbank-Portdb.portServer, Monitoring, Datenbankz.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-Namedb.nameServer, 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 Tablespacedb.tablespaceDatenbank
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 Instanzdb.use_named_instanceServer, 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-Instanzdb.instanceServer, 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-Benutzerdb.userServer, 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-Passwortdb.passwordServer, Monitoring, Datenbank
Das Passwort des Benutzers.
Datenbank-Admin Usernamedb.user_privilegedDatenbank
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 Passwortdb.password_privilegedDatenbank
Das Passwort des neuen Benutzers.
  • Dieser Parameter ist nur von Bedeutung, falls ein neuer Benutzer angelegt werden soll, und kann ansonsten ignoriert werden.
Migration ausführen?
db.migrateDatenbank"auto", "yes" und "no"
Gibt an, ob bei der Installation eine datenbank-spezifische Migration auf die neue Datenbank-Version ausgeführt werden soll und ob die von PLANTA mitgelieferten Migrationspakete mit der Einstellung Bei Systemstart = automatisch ausgeführt werden sollen oder nicht. Welche Migrationspakete für das Update ausgeführt werden müssen, ermittelt das Migrationsverfahren aus Ihrem bestehenden System.
  • 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. Nachdem die Migrationspakete ausgeführt wurden, wird der PLANTA-Server-Dienst, der für das Ausführen der Migrationspakete gestartet wurde, wieder beendet.
    Die Migrationspakete mit der Einstellung Bei Systemstart = können auch manuell durch Ausführen des Skripts planta_migration.bat bzw. planta_migration.sh ausgeführt werden.
Datenbank-Schema erstellen/anpassen?db.create_schemaDatenbank"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_dataDatenbank"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 Konsolenparameter auf "yes" zu belassen, da ansonsten die Daten auf andere Weise importiert werden müssen, was nicht trivial ist.
DB-Synonyme aktivieren?db.synonymsServer"yes", "no"
Gibt an, ob Hibernate Datenbank-Synonyme verwenden soll oder nicht.
  • Es wird empfohlen, Synonyme auszuschalten, da dies die Performance verbessert.
Server-IP-AdresseSERVER_IPServerz.B. "192.168.10.20"
Die IP-Adresse des PLANTA-Servers.
  • 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.
PortPORTServerz.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.nameServer
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-Verzeichnisserver.pathServer
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 unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Bestehendes Server-Verzeichnisserver.path.existingServer
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 unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Python-Version
python.versionServer3.4.3, 3.8.5
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 ist die Version 3.8.5 voreingestellt. Diese verlangt jedoch zwingend die Datenbank-Version 39.5.17 oder höher. Für diese Datenbankversionen empfehlen wir explizit, die voreingestellte Python-Version 3.8.5 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.
Java-Versionjava.versionServerGraal oder Zulu
Die Java-Version, die mit PLANTA ausgeliefert wird und womit der Server gestartet wird.
  • Dies hat keinen Einfluss auf eventuell bereits existierende Java-Installationen. Andere Applikationen sind davon nicht betroffen.
  • Wird bei Konsoleninstallation etwas Anderes als Graal oder Zulu angegeben, wird standardmäßig Java Graal installiert.
Datenbank-Schema an Server-Hotfix anpassen?server.update_schemaServer"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 Konsolenparameter auf "yes" zu belassen, da ansonsten die entsprechenden Skripte manuell ausgeführt werden müssen, was nicht trivial ist.
Migration ausführen?
server.migrateServer"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.groupServer, Monitoringz.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.nameServer, 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)

Authentifizierungsmethode

server.auth_method Server "interactive", "kerberos", "proxy", "any" 
Legt die Authentifizierungsmethode fest, die bei Anmeldung vom Client verwendet wird.
Erwartete Nutzlast
system.dimensionServer"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:
Webservices für PLANTA pulse aktivieren?
planta.services.enableServer"yes", "no"Gibt an, ob die Webservices für PLANTA pulse aktiviert werden sollen.
IP-Adresse der Webservices für PLANTA pulseplanta.services.interfaceServerz.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 pulseplanta.services.portServerz.B. "23456"Der Port, auf dem die Webservices für PLANTA pulse laufen sollen.
Webservices für PLANTA link aktivieren?planta.services.generic.enableServer"yes", "no"Gibt an, ob die Webservices für PLANTA link aktiviert werden sollen.
IP-Adresse der Webservices für PLANTA linkplanta.services.generic.interfaceServerz.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 linkplanta.services.generic.portServerz.B. "23456"Der Port, auf dem die Webservices für PLANTA link laufen sollen.
Dokumentation für die Webservices aktivieren?planta.services.doc.activateServer"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-Dokumentationplanta.services.doc.hostServer
Der Host, auf dem die Webservice-Dokumentation laufen soll.
IP-Adresse für Webservice-Dokumentationplanta.services.doc.interfaceServerz.B. "srvWebPLANTA", "192.168.10.31"Die IP-Adresse des Rechners, auf der die Webservice-Dokumentation laufen soll.
Port für Webservice-Dokumentationplanta.services.doc.portServerz.B. "23457"Der Port, auf dem die Webservice-Dokumentation laufen soll.
Hostname für die generierten cURL -Statements der Webservice-Dokumentationservices_doc_hostnameServerz.B. "srvWebPLANTA"curl -Statements der Dokumentationsschnittstelle werden passend zu der hier eingetragenen Server-URL generiert.
SSL aktivieren?planta.services.ssl.enableServer"yes", "no"Falls diese Option gewählt wird, laufen die Webservices nur noch über verschlüsselte Verbindungen (https)
Keystore-Pfad für SSLplanta.services.ssl.keystore.pathServerz.B.:web-inf/resources/sslPfad zum Java Keystore (JKS), der die Schlüsselpaare bzw. Zerifikate für SSL benötigt
Passwort für SSLplanta.services.ssl.passwordServerz.B. "123456"Passwort für den Java Keystore
Cross Site-Scripting?planta.services.apifilters.allServer"yes", "no"
Wird momentan benötigt, um Cross-Site-Scripting zu ermöglichen
  • Es wird empfohlen, die voreingestellte Auswahl auf 'Yes' zu belassen .
ApiKey-Filtern auf Swagger-generierten Services?planta.services.apifilters.swaggerServer"yes", "no"
Ermöglicht ApiKey-Filtern auf Web-Services, die von Swagger generiert wurden
  • Dieser Parameter ist deprecated, es wird empfohlen, ihn nicht zu ändern.
ApiKey-Authentifizierung für Web-Services?planta.services.apifilters.genericServer"yes", "no"
Gibt an, ob ApiKey-Authentifizierung für generische Web-Services aktiviert werden soll. Dieser Parameter ist u.a. Voraussetzung für die Verwendung von Jira
SAML-Antworten für alle Web-Services filtern?planta.services.apifilters.samlServer"yes", "no"
Soll SAML-Antwort-Filtern für Pulse aktiviert werden?
  • Es wird empfohlen, die voreingestellte Auswahl auf 'No' zu belassen .
Coredumps erstellen?debug.coredumpsServer"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 Coredumpsdebug.coredump_pathServer
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 unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Monitoring aktiviertplanta.monitoring.enableServer"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-Schnittstelleplanta.monitoring.portServer, Monitoringz.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 IPplanta.monitoring.interfaceServerz.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-Schnittstellemonitoring.portMonitoringz.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-Verzeichnismonitoring.pathMonitoring
Das Verzeichnis, in das die Monitoring-Komponente installiert werden soll.
  • Es muss Schreibrecht auf diesem Verzeichnis bestehen. Achten Sie bei Installation/Update per Konsole unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Name des Monitoring-Dienstesmonitoring.serviceMonitoring
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.
ParameterName in properties -DateienVerwendet für KomponenteMögliche WerteBedeutung
Installationsart
planta.install_typeClient, 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).
Updateartplanta.update_typeClient, Server, Datenbank"venus" (Update von 39.5.x auf 39.5.y)Gibt im Falle des Updates an, welcher Art das zu aktualisierende System. Seit der Server-Version 39.5.30 werden ausschließlich Updates von Venus-zu-Venus unterstützt.
DB-Log-Verzeichnislog.pathClient, 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 unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Server nach der Installation starten?server.start_serverClient, 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_typeDatenbank"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-Typdb.typeDatenbank, Server"Oracle", "MSSQL"Datenbanktyp
Datenbank-LizenzLicenseServer, Monitoring, Datenbankz.B. "200"Ihre von PLANTA vergebene Lizenznummer.
Lizenzdateilicense_fileServerKompletter Pfad zu einer Lizenzdatei (license.config)
Die von PLANTA erstellte Lizenzdatei mit Informationen darüber, wie viele Datensätze pro lizensierter Tabelle Sie anlegen dürfen.
  • Ist dieser Parameter leer, wird der Installer versuchen, eine vorhandene Lizendatei der existierenden Server-Installation zu verwenden (nur bei Update-Installationen).
  • Ohne Lizenzdatei können Sie nur eine sehr begrenzte Anzahl von Projekten, Vorgängen etc. anlegen (wie in Demo-Systemen).
  • Führen Sie keine Änderungen an der Lizenzdatei durch! Die Datei ist signiert, was heißt, dass der Server diese Datei bei Änderungen verweigert und so startet, als gäbe es keine Lizenzdatei. Wenden Sie sich in diesem Fall bitte an PLANTA, um eine neue Version zu erhalten.
  • Die Datei kann manuell ausgetauscht werden, indem sie ins config-Verzeichnis kopiert und der Server neugestartet wird.
Datenbank-Serverdb.serverServer, Monitoring, Datenbankz.B. "srvPLANTA", "192.168.10.20"Der Name bzw. IP-Adresse des Servers, auf dem die Datenbank läuft.
Datenbank-Portdb.portServer, Monitoring, Datenbankz.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-Namedb.nameServer, 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 Tablespacedb.tablespaceDatenbank
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 Instanzdb.use_named_instanceServer, 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-Instanzdb.instanceServer, 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-Benutzerdb.userServer, 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-Passwortdb.passwordServer, Monitoring, Datenbank
Das Passwort des Benutzers.
Datenbank-Admin Usernamedb.user_privilegedDatenbank
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 Passwortdb.password_privilegedDatenbank
Das Passwort des neuen Benutzers.
  • Dieser Parameter ist nur von Bedeutung, falls ein neuer Benutzer angelegt werden soll, und kann ansonsten ignoriert werden.
Migration ausführen?
db.migrateDatenbank"auto", "yes" und "no"
Gibt an, ob bei der Installation eine datenbank-spezifische Migration auf die neue Datenbank-Version ausgeführt werden soll und ob die von PLANTA mitgelieferten Migrationspakete mit der Einstellung Bei Systemstart = automatisch ausgeführt werden sollen oder nicht. Welche Migrationspakete für das Update ausgeführt werden müssen, ermittelt das Migrationsverfahren aus Ihrem bestehenden System.
  • 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. Nachdem die Migrationspakete ausgeführt wurden, wird der PLANTA-Server-Dienst, der für das Ausführen der Migrationspakete gestartet wurde, wieder beendet.
    Die Migrationspakete mit der Einstellung Bei Systemstart = können auch manuell durch Ausführen des Skripts planta_migration.bat bzw. planta_migration.sh ausgeführt werden.
Datenbank-Schema erstellen/anpassen?db.create_schemaDatenbank"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_dataDatenbank"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 Konsolenparameter auf "yes" zu belassen, da ansonsten die Daten auf andere Weise importiert werden müssen, was nicht trivial ist.
DB-Synonyme aktivieren?db.synonymsServer"yes", "no"
Gibt an, ob Hibernate Datenbank-Synonyme verwenden soll oder nicht.
  • Es wird empfohlen, Synonyme auszuschalten, da dies die Performance verbessert.
Server-IP-AdresseSERVER_IPServer, Clientz.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.
PortPORTServer, Clientz.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.nameServer
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-Verzeichnisserver.pathServer
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 unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Bestehendes Server-Verzeichnisserver.path.existingServer
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 unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Python-Version
python.versionServer3.4.3, 3.8.5
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 ist die Version 3.8.5 voreingestellt. Diese verlangt jedoch zwingend die Datenbank-Version 39.5.17 oder höher. Für diese Datenbankversionen empfehlen wir explizit, die voreingestellte Python-Version 3.8.5 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.
Java-Versionjava.versionServerZulu, Graal
Die Java-Version, die mit PLANTA ausgeliefert wird und womit der Server gestartet wird.
  • Dies hat keinen Einfluss auf eventuell bereits existierende Java-Installationen. Andere Applikationen sind davon nicht betroffen.
  • Wird bei Konsoleninstallation etwas Anderes als Zulu oder Java angegeben, wird standardmässig Java Zulu installiert.
Datenbank-Schema an Server-Hotfix anpassen?server.update_schemaServer"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 Konsolenparameter auf "yes" zu belassen, da ansonsten die entsprechenden Skripte manuell ausgeführt werden müssen, was nicht trivial ist.
Migration ausführen?
server.migrateServer"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.groupServer, Monitoringz.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.nameServer, 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.dimensionServer"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:
Webservices für PLANTA pulse aktivieren?
planta.services.enableServer"yes", "no"Gibt an, ob die Webservices für PLANTA pulse aktiviert werden sollen.
IP-Adresse der Webservices für PLANTA pulseplanta.services.interfaceServerz.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 pulseplanta.services.portServerz.B. "23456"Der Port, auf dem die Webservices für PLANTA pulse laufen sollen.
Webservices für PLANTA link aktivieren?planta.services.generic.enableServer"yes", "no"Gibt an, ob die Webservices für PLANTA link aktiviert werden sollen.
IP-Adresse der Webservices für PLANTA linkplanta.services.generic.interfaceServerz.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 linkplanta.services.generic.portServerz.B. "23456"Der Port, auf dem die Webservices für PLANTA link laufen sollen.
Dokumentation für die Webservices aktivieren?planta.services.doc.activateServer"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-Dokumentationplanta.services.doc.hostServer
Der Host, auf dem die Webservice-Dokumentation laufen soll.
IP-Adresse für Webservice-Dokumentationplanta.services.doc.interfaceServerz.B. "srvWebPLANTA", "192.168.10.31"Die IP-Adresse des Rechners, auf der die Webservice-Dokumentation laufen soll.
Port für Webservice-Dokumentationplanta.services.doc.portServerz.B. "23457"Der Port, auf dem die Webservice-Dokumentation laufen soll.
Hostname für die generierten cURL -Statements der Webservice-Dokumentationservices_doc_hostnameServerz.B. "srvWebPLANTA"curl -Statements der Dokumentationsschnittstelle werden passend zu der hier eingetragenen Server-URL generiert.
SSL aktivieren?planta.services.ssl.enableServer"yes", "no"Falls diese Option gewählt wird, laufen die Webservices nur noch über verschlüsselte Verbindungen (https)
Keystore-Pfad für SSLplanta.services.ssl.keystore.pathServerz.B.:web-inf/resources/sslPfad zum Java Keystore (JKS), der die Schlüsselpaare bzw. Zerifikate für SSL benötigt
Passwort für SSLplanta.services.ssl.passwordServerz.B. "123456"Passwort für den Java Keystore
Cross Site-Scripting?planta.services.apifilters.allServer"yes", "no"
Wird momentan benötigt, um Cross-Site-Scripting zu ermöglichen
  • Es wird empfohlen, die voreingestellte Auswahl auf 'Yes' zu belassen .
ApiKey-Filtern auf Swagger-generierten Services?planta.services.apifilters.swaggerServer"yes", "no"
Ermöglicht ApiKey-Filtern auf Web-Services, die von Swagger generiert wurden
  • Dieser Parameter ist deprecated, es wird empfohlen, ihn nicht zu ändern.
ApiKey-Authentifizierung für Web-Services?planta.services.apifilters.genericServer"yes", "no"
Gibt an, ob ApiKey-Authentifizierung für generische Web-Services aktiviert werden soll. Dieser Parameter ist u.a. Voraussetzung für die Verwendung von Jira
SAML-Antworten für alle Web-Services filtern?planta.services.apifilters.samlServer"yes", "no"
Soll SAML-Antwort-Filtern für Pulse aktiviert werden?
  • Es wird empfohlen, die voreingestellte Auswahl auf 'No' zu belassen .
Coredumps erstellen?debug.coredumpsServer"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 Coredumpsdebug.coredump_pathServer
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 unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Monitoring aktiviertplanta.monitoring.enableServer"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-Schnittstelleplanta.monitoring.portServer, Monitoringz.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 IPplanta.monitoring.interfaceServerz.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-Schnittstellemonitoring.portMonitoringz.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-Verzeichnismonitoring.pathMonitoring
Das Verzeichnis, in das die Monitoring-Komponente installiert werden soll.
  • Es muss Schreibrecht auf diesem Verzeichnis bestehen. Achten Sie bei Installation/Update per Konsole unter Windows zudem darauf, im Pfadnamen keine einfachen Backslashes zu verwenden.
Name des Monitoring-Dienstesmonitoring.serviceMonitoring
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.


Mit den folgenden Parameter wird bestimmt, welche Komponenten installiert/upgadated werden sollen

  • Diese sind nur für Installation/Update per Konsole von Belang, da die zu installierenden Komponenten bei einer GUI-Installation zu Beginn ausgewählt werden.

Name in properties -DateienVerwendet für Komponente WerteBedeutung
Server-Installationserver.install
"yes", "no"Gibt an, ob Server-spezifische Schritte ausgeführt werden sollen. Dies sind z.B.
  • Installation oder Update der binären Server-Dateien,
  • Minimalanpassung der Datenbank, um den Server-Start zu gewährleisten (d.h. die Migrationspakete der Komponente Server)
  • und/oder Installation / Update von Server-spezifischen Python-Dateien.
Datenbank-Installationdb.install
"yes", "no"
Gibt an, ob Datenbank-spezifische Schritte ausgeführt werden sollen. Dies sind z.B.
  • Installation einer neuen Datenbank,
  • Update bestehender Datenbank-Tabellen (d.h. bei DB 39.4.4.0 mit S 39.5.x die Migrationspakete der Komponente Customizing-Hotfix, bei DB 39.5.x die der Komponente Customizing, After DB Import sowie Before DB Import)
  • und/oder Installation / Update von Customizing-spezifischen Python-Dateien.

Bei einem Update mit DB39.4.4.0 und S39.5.x muss der Parameter db.install = yes gesetzt sein.
Monitoring-Installationmonitoring.install
"yes", "no"Gibt an, ob die Monitoring-Komponente zur Kontrolle des PLANTA Servers installiert werden soll.
Regtest-Installationregtests.install
"yes", "no"Gibt an, ob die Regressionstests installiert werden sollen, mit denen sich nach erfolgter Installation die Funktionsweise des PLANTA Servers testen lassen.

Zusätzliche Parameter

  • In aller Regel werden die oben angegebenen Parameter für eine Installation / ein Update ausreichen. Für spezielle Fälle gibt es jedoch noch einige zusätzliche Parameter, die (nur für Installation/Update per Konsole) der planta-windows.properties bzw. planta-linux.properties hinzugefügt werden können:

Name in properties -DateienVerwendet für Komponente WerteBedeutung
Manueller Connect-Stringdb.manual_connection_stringDatenbank, ServerEin Connection-String zu einer bestimmten Datenbank
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 irgendwie vom Standard abweicht.
  • Im Standardfall sollte dieser Parameter nicht gesetzt werden. In diesem Fall wird der Connection-String vom Installer intern zusammengebaut aus den Parametern db.type, db.server, db.name, db.user, db.port sowohl (nur für MSSQL) db.use_named_instance & db.instance.
  • Beispiel-Connection-Strings wären etwa jdbc:oracle:thin:@someOracleServer:1521:someDb oder jdbc:sqlserver://someMSSQLServer:1433
  • 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.
Manueller Connect-String für Administratordb.manual_connection_priv_stringDatenbankEin 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.
  • 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.
Alternatives sql-Verzeichnisplanta.alternative_sql_directory
Ein absoluter Pfad
Erlaubt die Verwendung eines alternativen Verzeichnisses für die SQL-Skripte, die der PLANTA-Installer bei der Server-Installation ausführt, um die Startbarkeit des Servers zu gewährleisten.
  • Das System erwartet alle SQL-Skripte, nicht nur die, die geändert wurden.
  • Das Verzeichnis muss sql heißen (unter Linux Klein-/Großschreibung beachten), da der Installer dort die Skripte sucht.
  • Die Unterverzeichnisse werden in alphabetischer Reihenfolge abgearbeitet, die darin enthaltenen Dateien ebenfalls.
  • Bei Verwendung einer Oracle-Datenbank werden Unterverzeichnisse namens ms-sql (und die Dateien darin) ignoriert. Bei Verwendung einer MSSQL-Datenbank werden Unterverzeichnisse namens oracle (und die Dateien darin) ignoriert.
  • Dieser Parameter darf nur in Absprache mit PLANTA verwendet werden.
Alternatives Migrationsverzeichnis
planta.alternative_migration_directory

Ein absoluter Pfad
Erlaubt die Verwendung eines alternativen Verzeichnisses für Migrationspakete und die zugehörigen SQL-Dateien.
  • Das System erwartet alle Migrationspakete, nicht nur die, die geändert wurden.
  • Das Verzeichnis muss migration heißen (unter Linux Klein-/Großschreibung beachten), da das Migrationsframework dort die Skripte sucht.
  • Die Verzeichnisstruktur unterhalb des angegebenen Verzeichnis muss exakt der Verzeichnisstruktur entsprechen, die im ursprünglichen Verzeichnis vorgefunden wird.
  • Dieser Parameter darf nur in Absprache mit PLANTA verwendet werden.

planta.migration_scripts_to_ignore

Eine durch Leerzeichen getrennte Liste von Migrationspaketen
Dies gibt eine Liste von Migrationspaketen an, die bei der Migration nicht ausgeführt werden sollen.
  • Die Migrationspakete werden durch ihren Pfadnamen beginnend ab migration bis zum Dateinamen des Migrationspakets (ohne die Endung .py) identifiziert. Sie müssen durch Leerzeichen getrennt sein und in einer Zeile stehen, z.B. so:
    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
  • Dieser Parameter darf nur in Absprache mit PLANTA verwendet werden.
  • Dieser Parameter funktioniert derzeit (Stand Server-HF21) NICHT bei Paketen im Migrationsverzeichnis after_db_import!
Temporäres Verzeichnistemp.path
Ein relativer oder absoluter PfadDer Installer kopiert beim Installieren einige Hilfsdateien in ein temporäres Verzeichnis (und passt diese entsprechend der Einstellungen an). Standardmäßig (falls der Parameter nicht angegeben wird) ist dies /tmp/install_planta unter Linux bzw. %temp%/install_planta unter Windows.
  • Das Setzen eines temporären Verzeichnisses ist nur erforderlich, wenn mehrere Installationen gleichzeitig ablaufen, da die Installer sich in diesem Falle ihre Werte gegenseitig überschreiben können. Ansonsten wird von manuellem Setzen des Parameters temp.path abgeraten.
  • Auf diesem Verzeichnis muss Schreibrecht bestehen.
  • Der Inhalt des temporären Verzeichnis wird nach Ablauf der Installation automatisch gelöscht. Geben Sie also ein explizites Verzeichnis an, das nicht anderweitig verwendet wird.
Server-Typserver.type
release oder asan oder testingGibt an, welcher Server installiert wird. Standardmäßig (falls der Parameter nicht angegeben wird) ist dies die Release-Version. Die testing- und asan-Versionen können für Debugging verwendet werden, da zur Laufzeit einige zusätzliche Tests gemacht werden, was die Laufzeit allerdings etwas verlangsamt.

Hinweise zur Fehlerbehandlung

  • Tritt bei der Datenbankinstallation unter MSSQL der Fehler Unable to get information from SQL Server auf, bedeutet dies in der Regel, dass der Dienst SQL Server Browser noch nicht gestartet wurde.
    • Führen Sie diesen Dienst manuell aus und starten Sie die PLANTA-Installation neu (s. hierzu auch die Dokumentation für MSSQL).
  • Tritt bei der Datenbankinstallation unter MSSQL auf eine benannte Instanz der Fehler Server has no instance named SQLEXPRESS auf, aktivieren Sie bitte bei Ihrer Instanz die Option TCP/IP, starten Sie den MSSQL-Dienst neu und danach nochmals die PLANTA-Installation (s. hierzu auch die Dokumentation für MSSQL).
  • Sollten bei der Installation Fehler aufgetreten sein, kann es passieren, dass temporäre Dateien auf Ihrem System erhalten bleiben. Löschen Sie in diesem Fall das von Ihnen angegebenen Verzeichniss für die Server-Installation (Parameter server.path) und das Verzeichnis install_planta in Ihrem temporären Verzeichnis, bevor Sie eine neue Installation durchführen.
  • Wenn Sie sich trotz erfolgreicher Installation (keine Fehlermeldungen beim Installieren) nicht anmelden können (es erscheint die Aufforderung, die Verbindung herzustellen anstatt des Anmeldedialogs), überprüfen Sie bitte das Verzeichnis \log auf etwaige Fehler beim Starten des PLANTA-Servers. Es kann auch helfen, z.B. über netstat zu überprüfen, ob der bei der Installation angegebene Port geöffnet ist, und ob der Dienst laut Service Wrapper gestartet ist (Aufruf von \yajsw\bat\queryService.bat oder /yajsw/bat/queryDaemon.sh).

Nach der Installation

Informationen

  • Bei der Installation eines Kundensystems müssen nach der Standard-Installation noch weitere Schritte durchgeführt werden. Hierzu gehört u.a.
    • das Austauschen der PLANTA-Standard-Datenbank durch die individuelle Datenbank
    • das Austauschen der kundenspezifischen Python-Dateien im Server-Verzeichnis
  • Nach der Installation müssen bestimmte Einstellungen ggf. angepasst werden. Weitere Informationen
  • Welche Schritte hierbei genau durchzuführen sind, erfragen Sie bitte bei Ihrem PLANTA-Consultant.