View Categories

04 Konfiguration

4.1 Allgemeines

Der MCDMS WebService wird vollständig über die Datei appsettings.json konfiguriert.

Alle Einstellungen werden zentral in dieser Datei vorgenommen. Änderungen werden erst nach einem Neustart des Windows-Dienstes wirksam.

4.2 Vollständige Konfigurationsdatei

Hinweis: Die nachfolgende Konfiguration dient als Beispiel und muss an die jeweilige Umgebung angepasst werden.

{
  ...
}

Die Konfigurationsdatei besteht aus den folgenden Bereichen:

BereichBeschreibung
InstallationEinstellungen des Windows-Dienstes
KestrelHTTPS-Konfiguration
SecurityAPI-Key und Zugriffsschutz
KlinikFreigegebene IK-Nummern
NachrichtenDateispeicherung und Upload
LoggingProtokollierung

4.3 Konfigurationsreferenz

Installation

EinstellungPflichtStandardBeschreibung
DienstNameMCDMS WebServiceInterner Name des Windows-Dienstes
AnzeigeNameMCDMS WebServiceAnzeigename in der Dienstverwaltung
InstallationsPfadC:\Programme\MCDMS WebServiceInstallationsverzeichnis

Beispiel

"Installation": {
  "DienstName": "MCDMS WebService",
  "AnzeigeName": "MCDMS WebService",
  "InstallationsPfad": "C:\\Programme\\MCDMS WebService"
}

Kestrel

EinstellungPflichtStandardBeschreibung
Urlhttps://+:5001HTTPS-Adresse
SubjectName des Serverzertifikats
AllowInvalidfalseZertifikatsprüfung deaktivieren (nur Testbetrieb)

Automatische Prüfungen

✔ Zertifikat vorhanden

✔ Privater Schlüssel vorhanden

✔ Zertifikat gültig

✔ Zertifikatskette gültig

✔ Server Authentication vorhanden

Beispiel

"Kestrel": {
  "Endpoints": {
    "Https": {
      "Url": "https://+:5001",
      "Certificate": {
        "Subject": "MCDMS WebService",
        "AllowInvalid": false
      }
    }
  }
}

Security

EinstellungPflichtStandardBeschreibung
ApiKeyGeheimer Schlüssel zur Authentifizierung

Empfehlungen

  • mindestens 32 Zeichen
  • zufällig erzeugt
  • nicht im Quellcode speichern
  • regelmäßig ändern
  • niemals an Unbefugte weitergeben

Beispiel

"Security": {
  "ApiKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Klinik

EinstellungPflichtStandardBeschreibung
ErlaubteIksListe der freigegebenen IK-Nummern

Beispiel

"Klinik": {
    "ErlaubteIks": [
        "123456789",
        "987654321"
    ]
}

Nur die hier aufgeführten Einrichtungen dürfen den WebService verwenden.

Nachrichten

EinstellungPflichtStandardBeschreibung
BasisPfadD:\MCDMS\DatenStammverzeichnis für alle Dateien
MaxUploadBytes52428800Maximale Dateigröße in Byte

Beispiel

"Nachrichten": {
    "BasisPfad": "D:\\MCDMS\\Daten",
    "MaxUploadBytes": 52428800
}

Aus dem Basisverzeichnis entsteht automatisch folgende Ordnerstruktur:

Daten
│
├── Eingang
│     ├── 123456789
│     └── 987654321
│
└── Ausgang
      ├── 123456789
      └── 987654321

Logging

EinstellungPflichtStandardBeschreibung
DefaultInformationStandard-Protokollierungsstufe

Unterstützte Stufen:

  • Trace
  • Debug
  • Information
  • Warning
  • Error
  • Critical

Für den Produktivbetrieb wird Information empfohlen.

4.4 Änderungen übernehmen

Nach jeder Änderung an der appsettings.json muss der Windows-Dienst neu gestartet werden.

net stop "MCDMS WebService"
net start "MCDMS WebService"

Alternativ kann der Neustart über die Windows-Dienstverwaltung erfolgen.