3. Installation und Konfiguration STP Documents OnPremiseAgent

Dauer: Die Installation und Einrichtung des STP Documents OnPremiseAgent dauert ca. 25 Minuten

In diesem Kapitel erfahren Sie, wie Sie den STP.Documents.OnPremiseAgent installieren und konfigurieren. Gehen Sie dazu wie folgt vor.

Wenn Sie den STP.Documents.OnPremiseAgent bereits installiert haben und beispielsweise den Mobile DESK nutzen, prüfen Sie bitte die für die Verfahrensanlage Plus (Deutsche Bank Integration) notwendigen Konfigurationen.

Anlegen der STP Documents Datenbank

  1. Stellen Sie eine Verbindung zu Ihrem Applikationsserver her.
  2. Öffnen Sie Ihr Datenbankmanagementsystem (Bsp. Microsoft SQL Server Management Studio)
  3. Für den STP.Documents.OnPremiseAgent benötigen Sie eine Datenbank, die Sie zunächst anlegen müssen.

Bitte beachten Sie, dass bei der Anlage einer neuen Datenbank, diese bei allen zukünftigen Datenbanksicherungen mit berücksichtigt werden muss!

Neue Datenbank
Screenshot der SQL Server Management Studio Oberfläche beim Anlegen einer neuen Datenbank für den STP Documents OnPremiseAgent. Im Objekt-Explorer ist der Knoten Datenbanken geöffnet, das Kontextmenü zeigt die Option Neue Datenbank.
  1. Zudem benötigen Sie einen Datenbankbenutzer mit “db_owner”-Berechtigung für die neu angelegte Datenbank. Legen Sie unter Sicherheit - Anmeldungen eine “Neue Anmeldung” an.
Anmeldung Neu
  1. Bitte verwenden Sie ein 15-stelliges Kennwort, das Sie frei wählen können. Merken Sie sich dieses Kennwort, da Sie es zu einem späteren Zeitpunkt nochmals eingeben müssen.

Hinweis: Bitte beachten Sie Ihre Kennwortrichtlinien. Bei der Anmeldung des “STPDocumentsReaderWriter” dürfen die Haken “Ablauf des Kennworts erzwingen” und “Benutzer muss das Kennwort bei der nächsten Anmeldung ändern” nicht gesetzt sein!

Dialog Neuer Benutzer im SQL Server Management Studio mit ausgefüllten Feldern für Loginname, Authentifizierungsmethode und Passwort. Die Umgebung zeigt das Fenster zur Erstellung eines neuen Datenbankbenutzers mit den Optionen für SQL Server-Authentifizierung und Passwortbestätigung. Die Atmosphäre ist sachlich und informativ. Im Dialog sind die Felder Loginname, Authentifizierung, Passwort und Passwort bestätigen sichtbar.
  1. Bei der Benutzeranlage unter Benutzerzuordnung noch die richtigen Einstellungen setzen.
Dialog Benutzerzuordnung im SQL Server Management Studio mit aktivierter Option db_owner für die neue Datenbank. Die Umgebung zeigt das Fenster zur Zuweisung von Datenbankrollen an den Benutzer.

Erstellen des technischen Agent-Benutzers für den STP Documents OnPremiseAgent

  1. Legen Sie in der Zentralen Benutzeradministration (STP Usermanagement (OnPrem)) einen neuen Benutzer an. Dieser benötigt mindestens folgende Eigenschaften:

    • Loginnamen
    • Passwort (Bitte verwenden Sie ein 15-stelliges Kennwort, das Sie frei wählen können. Merken Sie sich dieses Kennwort, da Sie es zu einem späteren Zeitpunkt nochmals eingeben müssen.)
    • E-Mail-Adresse (die E-Mail-Adresse muss nicht existieren)
    • Kürzel

    Zudem muss der Benutzer die folgenden Gruppen zugewiesen bekommen:

    • ClientProxies
    • Alle WZ(…)
    • Alle DMS(…)
    • CloudAccess-TenantName

    Neu angelegten Benutzer speichern.

    Dialog zur Benutzeranlage in der Zentralen Benutzeradministration (STP Usermanagement (OnPrem)). Im Vordergrund ein Formular mit Feldern für Loginnamen, Passwort, E-Mail-Adresse und Kürzel. Darunter eine Liste mit auswählbaren Gruppen, darunter ClientProxies, Alle WZ(…), Alle DMS(…) und CloudAccess-TenantName.
  2. Konfiguration des technischen Agent-Benutzers im User Management der STP-Cloud:

    • Melden Sie sich in Ihrem Tenant https://your-tenant.stp-cloud.de an.

    • Navigieren Sie in der STP-Cloud über User-Management zu Gruppen und klicken Sie zuerst auf Fehlende Standardgruppen wiederherstellen.

    • Navigieren Sie nun in der STP-Cloud über User-Management zu Benutzer und klicken Sie bei dem nun ebenfalls in der Cloud vorhandenen, neu angelegten Benutzer auf Bearbeiten.

    Vergeben Sie ein Passwort für den Benutzer. Es wird empfohlen, dasselbe 15-stellige Passwort zu verwenden wie zuvor bei der Anlage in der Zentralen Benutzeradministration (STP Usermanagement (OnPrem)).

    Fügen Sie die Gruppe Documents.Agents hinzu und klicken Sie auf Speichern.

    Dialog zur Bearbeitung eines Benutzers im User Management der STP-Cloud. Im Vordergrund ist ein Formular sichtbar mit Feldern für Passwortvergabe und einer Liste von Gruppen, darunter Documents.Agents, die ausgewählt werden kann. Die Schaltfläche Speichern ist unten rechts zu sehen.

DMS System ID

Zur Installation des STP.Documents.OnPremise Agent benötigen Sie die “DMS System ID”.

Diese können Sie über den LEXolution.DMS Client App Service

oder

über die LEXolution Datenbank ermitteln.

Option 1) LEXolution.DMS Client App Service

Klicken Sie mit der rechten Maustaste auf das Tray Icon des LEXolution.DMS Client App Service und klicken Sie danach auf LCAS Status .... In dem sich öffnenden Fenster wird Ihnen die System.Id angezeigt.
Fenster LCAS Status des LEXolution DMS Client App Service mit hervorgehobener Zeile System Id und dem dazugehörigen Wert. Das Fenster zeigt weitere Statusinformationen wie Verbindungsstatus und Serverinformationen.

ODER

Option 2) LEXolution Datenbank (Documents Datenbank)

Sie können die “DMS System ID” auch über folgende Datenbankabfrage auf die LEXolution Datenbank ermitteln.

```sql
    SELECT ID FROM tblDatabaseId 
```

Download des STP Documents OnPremiseAgents

Laden Sie sich den STP Documents OnPremiseAgent herunter: Documents Downloadbereich

STP Documents OnPremiseAgent

Ausführen des STP Documents OnPremiseAgent Installers

  1. Starten Sie die Installation des STP.Documents.OnPremiseAgent und bestätigen Sie den Dialog mit weiter.

    Installationsassistent für STP Documents OnPremiseAgent mit dem Titel Willkommen beim STP Documents OnPremiseAgent Setup. Der Dialog zeigt die Schaltflächen Weiter, Abbrechen und Zurück.
  2. Konfigurieren Sie die Umgebung.

    Konfigurationswert Beschreibung
    Umgebung Wählen Sie prod-de.
    Tenant name Tragen Sie hier die Subdomain Ihres Tenants ein.
    DMS system id Tragen Sie hier die zuvor ermittelte “DMS System ID” ein.
    Agentenname Tragen Sie hier den Benutzernamen des zuvor angelegten technischen Agent-Benutzers ein.
    Installationsassistent STP Documents OnPremiseAgent – Schritt: Umgebung konfigurieren. Eingabefelder für Umgebung, Tenant Name, DMS System ID und Agentenname. Unten die Schaltflächen Zurück, Weiter und Abbrechen.
  3. Konfigurieren Sie den LEXolution Service Bus / Zentrale Benutzerverwaltung

    Konfigurationswert Beschreibung
    Hostname (LSB) Der Servername auf dem der LSB betrieben wird, zumeist der Applikations Server.
    Port (LSB) Port für den LSB, Default: 5672
    Benutzername (LSB) Benutzername für den LSB, Default: stpuser
    Passwort (LSB) Passwort für den LSB, Default: stp.
    Benutzername (Zentale Benutzerverwaltung) Tragen Sie hier den Benutzernamen des zuvor angelegten technischen Agent-Benutzers ein.
    Passwort (Zentrale Benutzerverwaltung) Tragen Sie hier das 15-stellige Passwort des zuvor angelegten technischen Agent-Benutzers ein.
    Screenshot des Installationsassistenten mit Eingabefeldern für LSB- und Benutzerverwaltungsdaten. Neutrale Windows-Oberfläche, unten Navigationsschaltflächen Zurück, Weiter und Abbrechen.
  4. Konfigurieren Sie die STP-Cloud Authentifizierung

    Konfigurationswert Beschreibung
    Authentifizierungsanbieter Wählen Sie HTTP.
    Benutzername (in E-Mail-Form) Tragen Sie hier die E-Mail-Adresse des zuvor angelegten technischen Agent-Benutzers ein.
    Passwort Tragen Sie hier das 15-stellige Passwort des zuvor angelegten technischen Agent-Benutzers ein.
    Screenshot des Installationsassistenten beim STP-Cloud-Authentifizierungsschritt mit Feldern für Authentifizierungsanbieter (HTTP ausgewählt), Benutzername (E-Mail-Form) und Passwort. Unten die Schaltflächen Zurück, Weiter und Abbrechen.
  5. Konfigurieren der Datenbankverbindung

    Konfigurationswert Beschreibung
    Name des Datenbankservers Datenbankserver und ggf. Instanz auf dem die Datenbank für den STP.Documents.OnPremiseAgent angelegt wurde.
    Name der Datenbank Name der Datenbank für den STP.Documents.OnPremiseAgent.
    Datenbank-Benutzername Benutzername des für die Datenbank eingerichteten Benutzers.
    Datenbankbenutzerpasswort Passwort des Datenbankbenutzers.
    Dialog Datenbankverbindung konfigurieren im Installationsassistenten mit Feldern für Server, Datenbank, Benutzername und Passwort, sachliche Windows-Oberfläche.
  6. Bestätigen Sie den folgenden Dialoge mit “Installieren” und “Fertigstellen”.

    Installationsassistent zeigt Fortschrittsbalken mit Installation wird ausgeführt und Installation abgeschlossen, Schaltflächen Zurück, Installieren (hervorgehoben) und Abbrechen.
    Installationsassistent meldet erfolgreiche Installation mit hervorgehobener Schaltfläche Fertigstellen auf neutraler Windows-Oberfläche.

Kontrolle der Installation des Dienstes über das Web-Interface

Nach erfolgreicher Installation lässt sich der Status des STP.Documents.OnPremiseAgent leicht über das Web-Interface prüfen. Rufen Sie hierzu folgenden Link auf http://localhost:8090/. Sie können nun den Status zur Verbindung mit LEXolution.DMS und der STP Cloud sehen.

Screenshot des STP Documents OnPremiseAgent Web-Interfaces mit Statusanzeige. Hauptbereich zeigt Verbindungsstatus zu LEXolution.DMS und STP Cloud, beide mit grünem Symbol als verbunden markiert. Linke Navigation mit Übersicht und Protokolle.

Erweiterte Anpassung der STP.Documents.OnPremiseAgent appsettings.json

Für die Verwendung von Verfahrensanlage Plus (Deutsche Bank Integration) müssen erweiterte Anpassungen am STP.Documents.OnPremiseAgent vorgenommen werden. Öffnen Sie hierzu die appsettings.json im Installationsverzeichnis C:\Program Files (x86)\STP AG\STP Documents OnPremiseAgent\

Folgende Werte müssen angepasst oder im Falle eines zuvor bereits in einer niedrigeren Version installierten STP.Documents.OnPremiseAgent hinzugefügt werden:

Konfigurationswert Beschreibung
"NewDevicesEnabledByDefault": true
"ConnectWz": true
"AllowUserlessRequests": true
"EventsRelay": {"NewDocumentEvent": true
"EventsRelay": {"NewDocumentVersionEvent": true
"EventsRelay": {"DocumentMetadataChangedEvent": true
"EventsRelay": {"DocumentDeletedEvent": true

Eine Beispiel für die appsettings.json könnte somit wie folgt aussehen:

{
  "Urls": "http://localhost:8090",
  "Serilog": {
    "Using": [
      "Serilog.Sinks.Console",
      "Serilog.Sinks.File"
    ],
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "System": "Warning",
        "Microsoft": "Warning"
      }
    },
    "WriteTo": [
      {
        "Name": "Console",
        "Args": {
          "theme": "Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console",
          "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {ThreadId} {EnvironmentUserName} {Message:lj} <s:{SourceContext}>{NewLine}{Exception}"
        }
      },
      {
        "Name": "File",
        "Args": {
          "path": "%PROGRAMDATA%\\STP AG\\STP Documents OnPremise Agent\\Logs\\log.txt",
          "rollingInterval": "Day",
          "fileSizeLimitBytes": 26214400,
          "rollOnFileSizeLimit": true
        }
      }
    ],
    "Enrich": [
      "FromLogContext",
      "WithMachineName",
      "WithThreadId",
      "WithEnvironmentUserName"
    ]
  },
  "Auth": {
    "Authority": "https://<TenantName>.stp-cloud.de/identity/",
    "Issuers": [
      "https://stp.stp-cloud.de/identity/",
      "https://<TenantName>.stp-cloud.de/identity/"
    ],
    "TenantNamePattern": "(?<tenant>.*?)\\.stp-cloud\\.de",
    "ClientId": "documents.agent.ui"
  },
  "ConnectionStrings": {
    "AgentDb": "Server=<DB-Server>;Database=<Database>;User=<User>;Password=<Passwort>;TrustServerCertificate=True"
  },
  "SignalRSettings": {
    "DocumentsRelayUrl": "https://<TenantName>.stp-cloud.de/documents/"
  },
  "AccessCredentials": {
    "TenantName": "<TenantName>",
    "ClientId": "documents.agent",
    "Provider": "HTTP",
    "Username": "<E-Mail des technischen Agent-Benutzers>",
    "Password": "<Passwort>"
  },
  "DmsConfiguration": {
    "RabbitMqHostname": "<Server>",
    "RabbitMqPort": "5672",
    "RabbitMqUsername": "stpuser",
    "RabbitMqPassword": "stp.",
    "UmServerUser": "<technischer Agent Benutzer>",
    "UmPasword": "<Passwort>",
    "SystemId": "<DMS System ID>"
  },
  "DmsDurableEvents": true,
  "AgentName": "<technischer Agent Benutzer>",
  "MaxDevicesPerUser": "5",
  "NewDevicesEnabledByDefault": "true",
  "OnlyLocalDeviceManagement": "false",
  "AuditTrail": "false",
  "Cloudless": "false",
  "PermittedExtensions": "jpg, jpeg, png, bmp, gif, txt, pdf, doc, docx, dot, dotx, ppt, pptx, xls, xlsx, zip, msg, beamsg, xml",
  "ConnectWz": true,
  "HandleCloudRequestsAsynchronously": false,
  "AllowUserlessRequests": true,
  "EventsRelay": {
    "NewDocumentEvent": true,
    "NewDocumentVersionEvent": true,
    "DocumentMetadataChangedEvent": true,
    "DocumentDeletedEvent": true,
    "ContainerIdsOnly": false
  }
}

Speichern Sie die Datei ab.

Starten Sie den Dienst “STP.Documents.OnPremiseAgent” in Ihrer Windows-Umgebung neu.

Nach wenigen Minuten können Sie nun im Web-Interface http://localhost:8090/ zusätzlich den Status zum “STP Server 8005” (Winsolvenz Server) sehen.

Statusseite des STP Documents OnPremiseAgent Web-Interfaces mit grünen Verbindungsanzeigen für LEXolution DMS, STP Cloud und STP Server 8005.

Eine ausführliche Dokumentation zur Installation finden Sie hier und Informationen zur erweiterten Konfiguration hier.

Fahren Sie bitte mit dem folgenden Artikel fort: Installation und Konfiguration STP Winsolvenz OnPremise Connector

Verknüpfung mit