Anpassung Konfigurationsdatei

aktualisiert 12/9/24 von Stephanie Krenz

Konfiguration der dab Nexus-Anwendung

Beachte
Dies ist die Konfiguration für die Speicherung von Anwendungsdaten. Nicht die Konfiguration für die Speicherung von SAP-Daten und Ergebnissen.
  • Wechsle in das Verzeichnis, in dem das DAB_NEXUS_HOME eingerichtet ist -> Standard/Default ist C:\Windows\ServiceProfiles\NetworkService\AppData\Roaming\dabGmbH\neXus
  • Öffne die Datei Configuration.json mit einem Texteditor (z. B. Notepad)
  • Definiere den Connection String zum SQL Server, der von dab Nexus zur Speicherung von Anwendungsdaten und Metainformationen verwendet wird. Es kann derselbe SQL Server sein, der später für die Speicherung von SAP-Daten und Ergebnissen verwendet wird. Verwende je nach Art der Authentifizierung eine der folgenden Vorlagen für den Connection String.
Wichtig
Ab Version 1.12 ändert sich der Parametername in ConnectionStrings von PrimaryDatabase zu ApplicationDatabase.

Windows-Authentifizierung ab Version 1.12

Hinweis: Dies ist der Benutzer, der den dab Nexus-Dienst ausführt.

"ConnectionStrings": {
"ApplicationDatabase": "Server=YourSQLServer;Database=YourDatabase;Trusted_Connection=True;MultipleActiveResultSets=true"
}

SQL Server-Authentifizierung ab Version 1.12

"ConnectionStrings": {
"ApplicationDatabase": "Server=YourSQLServer;Database=YourDatabase;UserId=myUsername;Password=myPassword;MultipleActiveResultSets=true"
}

Windows-Authentifizierung bis Version 1.11

Hinweis: Dies ist der Benutzer, der den dab Nexus-Dienst ausführt.

"ConnectionStrings": {
"PrimaryDatabase": "Server=YourSQLServer;Database=YourDatabase;Trusted_Connection=True;MultipleActiveResultSets=true"
}

SQL Server-Authentifizierung bis Version 1.11

"ConnectionStrings": {
"PrimaryDatabase": "Server=YourSQLServer;Database=YourDatabase;UserId=myUsername;Password=myPassword;MultipleActiveResultSets=true"
}

  • Editiere die URL zur Anwendung dab Nexus -> Ändere die URL von http://localhost:4444/ in die URL, mit der dab Nexus über das Netzwerk erreicht werden kann
"ApplicationUrl": "http://localhost:4444/",
"DabAdminEmail": "admin@dab-gmbh.de",
"DabAdminPassword": "Init1234!",

Beispiel -> http://YourServerName:4444

  • Port-Nummer 4444 kann benutzerdefiniert sein
  • Werte in DabAdminEmail und DabAdminPassword sind Standard-Anmeldeinformationen für die erste Anmeldung -> Sie können jetzt geändert werden oder werden nach der ersten Anmeldung geändert

Zertifikat laden

Ein Zertifikat kann entweder aus einer Datei oder einem Windows-Zertifikatsspeicher geladen werden. Abhängig davon, welche Variante Du wählst, müssen die Parameter in der Configuration.json entsprechend angepasst werden.

  • Datei -> Bei diesem Szenario übergibst Du im Parameter CertificateStore den Wert File
  • Windows-Zertifikatsspeicher -> Hier muss der Fingerabdruck/Daumenabdruck des Zertifikats in den Eigenschaften angegeben werden

Zertifikat aus Datei laden

 "CertificateStore": "File",
"CertificatePassword": "<Configure>",

Zertifikat aus Windows-Zertifikatspeicher laden

"CertificateStore": "LocalMachine",
"CertificateFingerprint": "<Configure>",

Nachdem Du die Änderungen in der Configuration.json vorgenommen hast, klicke auf Speichern und starte den dab Nexus-Dienst neu

Zertifikat aus Windows-Zertifikatsspeicher ändern

Wichtig:
Wenn das Zertifikat geändert werden muss (bspw. mit einem neuen Gültigkeitszeitraum), muss der CertificateFingerprint in der Configuration.json manuell geändert werden.

Führe folgende Schritte beim Wechsel des Zertifikats durch:

  • Stoppe den Windows-Service für dab Nexus (Informationen hierzu findest Du in diesem Artikel -> Markiere den Windows-Service und klicke auf der linken Seite auf Stoppen)
  • Öffne die Configuration.json
  • Der Wert des Feldes CertificateFingerprint muss durch den neuen Fingerprint/Thumbprint geändert werden
  • Speichere die Configuration.json
  • Starte den Windows-Service für dab Nexus neu (Informationen hierzu in diesem Artikel)

Mehr mögliche Optionen für Konfiguration

Option

Beschreibung

Mögliche Inhalte (Standardwerte in bold)

Beispiel

ConnectionStrings / PrimaryDatabase

ConnectionStrings / ApplicationDatabase (ab 1.12)

Verbindung zur Applikationsdatenbank

Hinweis

Um Dich mit einer Instanz zu verbinden, musst Du zwei Backslashes zwischen dem Servernamen und der Instanz einfügen: bspw. SERVER\\yourINSTANCE

"ConnectionStrings": {
"PrimaryDatabase": "Server=..."
}

ApplicationURL

URL, über die dab Nexus erreicht wird

"ApplicationUrl": "https://localhost/"

RedirectHttp

Ist nur dann wirksam, wenn das Protokoll bei ApplicationUrl HTTPS ist.

Wenn es verwendet wird, werden HTTP-Requests weitergeleitet zu HTTPS. Der Standard-Port für die Weiterleitung ist Port 80.

true

false

"RedirectHttp": true

RedirectHttpPort

Nur dann wirksam, wenn RedirectHttp aktiviert ist.

Ändert den verwendeten Port der "HTTP-zu-HTTPS-Weiterleitung".

"RedirectHttpPort": 80

EnableHsts

Nur dann wirksam, wenn RedirectHttp aktiviert ist.

Wenn diese Option aktiv ist, sendet dab Nexus einen Strict-Transport-Security Header, der dem Browser die Anweisung gibt, für zukünftige Verbindungen automatisch HTTPS zu verwenden (sobald erstmals erfolgreich eine Verbindung über HTTPS erfolgt ist). Der Browser behält diese Einstellung für 8 Stunden.

true

false

"EnableHsts": true

CertificateStore

Der Ort, an dem das SSL/TLS Zertifikat abgelegt ist.

File

CurrentUser

LocalMachine

"CertificateStore": "LocalMachine"

CertificatePassword

Nur dann wirksam, wenn CertificateStore auf File steht.

Das Passwort für die Datei Certificate.pfx.

"CertificateStore": "MySecurePassword"

CertificateFinterprint

Nur dann wirksam, wenn bei der Option CertificateStore entweder CurrentUser oder LocalMachine hinterlegt ist.

"CertificateFingerprint": "673ad021431f66c71d901ffc791959a2b5c9ce79"

LicenseServerUrl

Der Server, den dab Nexus für den Lizenz-Check verwendet.

"LicenseServerUrl": "https://aresbackendapi.azurewebsites.net/nexus/activation"

AuthMode

Gibt an, wie sich Benutzer in dab Nexus anmelden.

Mit BuiltIn verwendet jeder Benutzer eine E-Mail-Adresse und ein Passwort für die Anmeldung.

Mit SAML erfolgt die Authentifikation über einen sog. Identity Provider, wie bspw. Azure Active Directory.

Mit SAML, SAML / Issuer und entweder SAML / IdentityProviderMetadataUrl oder SAML / IdentityProviderMetadataFile

SAML

BuiltIn

"AuthMode": "SAML"

SAML / Issuer

Wird dann benötigt, wenn bei der AuthMode die Option SAML hinterlegt ist.

Den Namen der Anwendung, so wie er für den Identity Provider konfiguriert wurde.

"SAML": {
"Issuer": "dab Nexus"
}

SAML /

IdentityProviderMetadataUrl

Nur dann wirksam, wenn bei der AuthMode die Option SAML hinterlegt ist.

Die URL, unter der der Identity Provider Metadata gefunden werden kann. Diese URL muss für dab Nexus erreichbar sein.

"SAML": {
"IdentityProviderMetadataUrl": "https://login.microsoftonline.com/..."
}

SAML /

IdentityProviderMetadataFile

Nur dann wirksam, wenn bei der AuthMode die Option SAML hinterlegt ist.

Der NAme der XML-Datei, die die Identity Provider Metadata enthält.

Diese Datei sollte im Verzeichnis DAB_NEXUS_HOME hinterlegt werden.

"SAML": {
"IdentityProviderMetadataFile": "IdPMetadata.xml"
}

TransitionToBuiltInAuth

Nur dann wirksam, wenn bei der AuthMode die Option SAML hinterlegt ist.

Wenn aktiviert, kann das Benutzerpasswort geändert werden, auch wenn Single Sign-On verwendet wird.

Diese Option ist dafür gedacht, wenn Du von der SAML zur BuiltIn Authentifikation wechseln möchtest.

true

false

"TransitionToBuiltInAuth": false

Startprobleme wegen unzureichender Anpassung der Konfigurationsdatei

Fehler mit SSL-Zertifikat bei Startversuch des Nexus-Windows-Dienstes

Wenn Du den Windows-Dienst für dab Nexus nach einer Anpassung der Konfigurationsdatei neustartest und dieser Neustart abbricht, kann das möglicherweise die nachfolgende Ursache haben.

Meldung: A connection was successfully established with the server, but then an error occurred during the login process. (provider: SSL Provider, error: 0 - The target principal name is incorrect.)

Behebung ab Version 1.12: Hänge im Abschnitt Connection Strings > ApplicationDatabase den Code ;Encrypt=True;Trust Server Certificate=True zwischen MultipleActiveResultSets=true und " sodass es wie im folgenden Abschnitt ausschaut:

Hinweis: Dies ist der Benutzer, der den dab Nexus-Dienst ausführt.

"ConnectionStrings": {
"ApplicationDatabase": "Server=YourSQLServer;Database=YourDatabase;Trusted_Connection=True;MultipleActiveResultSets=true;Encrypt=True;Trust Server Certificate=True"
}

Behebung bis Version 1.12: Hänge im Abschnitt Connection Strings > PrimaryDatabase den Code ;Encrypt=True;Trust Server Certificate=True zwischen MultipleActiveResultSets=true und " sodass es wie im folgenden Abschnitt ausschaut:

Hinweis: Dies ist der Benutzer, der den dab Nexus-Dienst ausführt.

"ConnectionStrings": {
"PrimaryDatabase": "Server=YourSQLServer;Database=YourDatabase;Trusted_Connection=True;MultipleActiveResultSets=true;Encrypt=True;Trust Server Certificate=True"
}

Speichere die Konfigurationsdatei und starte den Windows-Dienst für dab Nexus anschließend neu.


Wie haben wir das gemacht?


Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)