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:
| Bereich | Beschreibung |
|---|---|
| Installation | Einstellungen des Windows-Dienstes |
| Kestrel | HTTPS-Konfiguration |
| Security | API-Key und Zugriffsschutz |
| Klinik | Freigegebene IK-Nummern |
| Nachrichten | Dateispeicherung und Upload |
| Logging | Protokollierung |
4.3 Konfigurationsreferenz
Installation
| Einstellung | Pflicht | Standard | Beschreibung |
|---|---|---|---|
| DienstName | ✔ | MCDMS WebService | Interner Name des Windows-Dienstes |
| AnzeigeName | ✔ | MCDMS WebService | Anzeigename in der Dienstverwaltung |
| InstallationsPfad | ✔ | C:\Programme\MCDMS WebService | Installationsverzeichnis |
Beispiel
"Installation": {
"DienstName": "MCDMS WebService",
"AnzeigeName": "MCDMS WebService",
"InstallationsPfad": "C:\\Programme\\MCDMS WebService"
}
Kestrel
| Einstellung | Pflicht | Standard | Beschreibung |
|---|---|---|---|
| Url | ✔ | https://+:5001 | HTTPS-Adresse |
| Subject | ✔ | – | Name des Serverzertifikats |
| AllowInvalid | ✖ | false | Zertifikatsprü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
| Einstellung | Pflicht | Standard | Beschreibung |
|---|---|---|---|
| ApiKey | ✔ | – | Geheimer 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
| Einstellung | Pflicht | Standard | Beschreibung |
|---|---|---|---|
| ErlaubteIks | ✔ | – | Liste der freigegebenen IK-Nummern |
Beispiel
"Klinik": {
"ErlaubteIks": [
"123456789",
"987654321"
]
}
Nur die hier aufgeführten Einrichtungen dürfen den WebService verwenden.
Nachrichten
| Einstellung | Pflicht | Standard | Beschreibung |
|---|---|---|---|
| BasisPfad | ✔ | D:\MCDMS\Daten | Stammverzeichnis für alle Dateien |
| MaxUploadBytes | ✖ | 52428800 | Maximale 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
| Einstellung | Pflicht | Standard | Beschreibung |
|---|---|---|---|
| Default | ✔ | Information | Standard-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.
