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
- Stellen Sie eine Verbindung zu Ihrem Applikationsserver her.
- Öffnen Sie Ihr Datenbankmanagementsystem (Bsp. Microsoft SQL Server Management Studio)
- 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!
- 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.
- 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!
- Bei der Benutzeranlage unter Benutzerzuordnung noch die richtigen Einstellungen setzen.
Erstellen des technischen Agent-Benutzers für den STP Documents OnPremiseAgent
-
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.
-
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.
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.
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
Ausführen des STP Documents OnPremiseAgent Installers
-
Starten Sie die Installation des STP.Documents.OnPremiseAgent und bestätigen Sie den Dialog mit weiter.
-
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. -
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. -
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. -
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. -
Bestätigen Sie den folgenden Dialoge mit “Installieren” und “Fertigstellen”.
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.
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.
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