Installation

info

Die aktuelle Version des Installationspakets ist unter software.one-unity.de 🔒 zu finden. Die Distribution der Installationspakete ist nur für Mitarbeiter:innen von One Unity zugänglich.

gefahr

Unbedingt die Installationsvoraussetzungen vorab prüfen!

Installation On-Premise

success

Bevor Sie mit der Installation anfangen, sollte ein aktuelles Backup vorhanden sein! Zusätzlich sollten alle Portalskripte als XML-Export gespeichert werden.

vorsicht

Die Tomcat-Konfiguration 🔒 muss vorab erfolgt sein. Diese erfolgt durch Mitarbeiter:innen von One Unity.

1. Aktuelles Installationspaket herunterladen und entpacken (Installationsverzeichnis)

Dateisystem

• Der Ordner Workflow-ext muss zur Installation nach D:\EASY\ oder D:\otris\ kopiert werden.
• Bei einer Installation auf Windows muss sichergestellt werden, dass sich im Documents-Verzeichnis D:\<EASY|otris>\Workflow\server die curl.exe befindet. Ab documentsOS wird diese nicht mehr im Documents-Setup mitgeliefert und muss daher manuell im genannten Verzeichnis abgelegt werden. Hierzu curl von der offiziellen Website herunterladen, die ZIP-Datei extrahieren und den Inhalt des bin-Verzeichnisses im Documents-Verzeichnis D:\<EASY|otris>\Workflow\server ablegen.

Datenbank

Im Installationsverzeichnis befinden sich unter dem Ordner Database jeweils:

• mssql.onpremise.sql
• mariadb.onpremise.sql

Je nach Datenbanksystem kann die mitgelieferte Datei verwendet werden, um die Datenbank anzulegen.

Microsoft SQL-Server (mssql)

vorsicht

Es muss vorab (z.B. über das SQL Server Management Studio) die "ousp"-Datenbank nach den jeweiligen Best Practices (siehe Confluence 🔒) erstellt werden. Hierzu kann als Vorlage die mssql.onpremise.sql-Datei genutzt werden - diese ist nur für die initiale Erstellung der Datenbank relevant.

Die Datei kann über das SQL Server Management Studio ausgeführt werden.

MariaDB

vorsicht

Es muss vorab (z.B. über DBeaver) die "ousp"-Datenbank nach den jeweiligen Best Practices (siehe Confluence 🔒) erstellt werden. Hierbei ist unbedingt auf das korrekte Charset (utf8mb4) und Collation (utf8mb4_general_ci) zu achten! Hierzu kann als Vorlage die mariadb.onpremise.sql-Datei genutzt werden - diese ist nur für die initiale Erstellung der Datenbank relevant.

Die Datei kann z.B. über DBeaver ausgeführt werden.

Datenbank-Verbindungen erstellen

Anschließend muss eine ODBC-Quelle angelegt werden, welche auf das ousp-Schema verweist.

vorsicht

Sollte auch Invoice installiert werden, bietet es sich an, auch direkt eine ODBC-Quelle für das ptpData-Schema anzulegen. Hierfür den Datenbank-Teil aus der Invoice-Installation beachten.

gefahr

Wichtiger Hinweis: Schritte VOR dem XML-Import

Direkt nach dem Erstellen der ousp bzw. ptpData-Datenbank und vor dem XML-Import müssen neben dem Anlegen der passenden ODBC-Quelle zwingend folgende Vorbereitungen durchgeführt werden:

1. Die DB-Zugangsdaten müssen entweder
   • über das PowerShell-Skript (Umgebungsvariablen-Setup - env.ps1, siehe nächster Punkt) angelegt oder
   • in Schritt 2 im cust-Skript direkt eingetragen werden (nicht empfohlen)
2. Im Skript ou.spc.library.dbConnections überprüfen, ob die hinterlegten Datenbankverbindungen korrekt sind – wenn nicht, ein zugehöriges Cust-Skript (ou.cust.library.dbConnections) erstellen und die nötigen Anpassungen durchführen
   • im Standard wird mariadb als dbSystem gesetzt. Bei Windows-Installationen muss das typischerweise auf mssql geändert werden!

Erst wenn diese Voraussetzungen erfüllt sind, darf der XML-Import gestartet werden!

Umgebungsvariablen-Setup ausführen

Damit in Portalskripten auf die neu erstellte ousp-Datenbank zugegriffen werden kann, müssen deren Zugangsdaten beim Documentsserver-Dienst als Umgebungsvariablen hinterlegt werden. Hierfür steht im Ordner Resources das PowerShell-Skript env.ps1 zur Verfügung. Außerdem ermöglicht dieses auch weitere Konfigurationsoptionen, wie z.B. die Eingabe der MailAgent-Zugangsdaten und die "Data Recognition AI"-Konfiguration.

Dieses muss wie folgt ausgeführt werden:

1. PowerShell als Administrator ausführen

2. Absoluten Pfad zum Skript eingeben und Enter drücken

   Beispiel: Das Installationsverzeichnis entspricht D:\xyz\oneunity-documents_main-X.Y.Z. → Es muss der Pfad D:\xyz\oneunity-documents_main-X.Y.Z\Resources\env.ps1 eingegeben werden.

3. Im Falle einer Sicherheitswarnung, diese durch Eingabe von 'M' und Enter bestätigen

4. Den Anweisungen des Skripts folgen

5. Damit die Umgebungsvariablen verfügbar werden, muss anschließend der Documentsserver-Dienst neu gestartet werden.

info

Falls das Skript nicht ausgeführt werden kann (Fehlermeldung der Art 'Die Datei xyz ist nicht digital signiert' bzw. 'Die Datei xyz kann nicht geladen werden, da die Ausführung von Skripts auf diesem System deaktiviert ist') muss durch Ausführung folgenden Befehls für die aktuelle PowerShell-Session die Execution-Policy überschrieben werden:

Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process (evtl. Sicherheitswarnung durch Eingabe von 'J' / 'Y' und Enter bestätigen)

vorsicht

Bei einer geplanten Installation von OUSP Contract muss die Erstellung des "oucsuperadmin"-Redakteurs übersprungen werden, sofern die Lizenz nicht mehr als einen Redakteur beinhaltet!

Documents

XML-Import

Als letzten Schritt muss im documents-Manager die ousp-documents-install.xml importiert werden.

vorsicht

Der XML-Import überschreibt bereits bestehende Eigenschaften!

• Im Documents-Manager unter Servereinstellungen / XML-Import
• In das Installationsverzeichnis/XML wechseln und die ousp-documents-install.xml auswählen

Installer-Output prüfen

In den documentsserver-Logs muss anschließend geprüft werden, ob die Installation über den Installer erfolgreich und ohne Fehler verlief.

Fertig! 🥳