Webinterface konfigurieren

Webinterface konfigurieren
api.config Referenz
- Vorhandene Optionen

Konfiguration neu laden

Die CareSuite lädt die komplette Konfiguration aus Performance-Gründen in einen Zwischenspeicher. Falls Änderungen an derapi.config Datei vorgenommen werden, müssen anschliessend immer folgende Schritte ausgeführt werden, damit die neue Konfiguration übernommen wird:

In Windows unter Startmenü -> Ausführen den Befehl cmd starten. Ein Kommandozeilenfenster öffnet sich.
Folgenden Befehl einfügen (mit Rechtsklick) und ausführen (mit Enter): cd "C:\Program Files (x86)\CareSuite\web\latest\api"
Folgenden Befehl einfügen und ausführen: php artisan config:cache

Die Ausgabe Configuration cache cleared! bestätigt die neu geladene Konfiguration.

Falls die CareSuite nicht unter C:\Program Files (x86)\CareSuite installiert wurde, muss obenstehender Befehl entsprechend angepasst werden.

Adressen-Pool für Textfelder

Der Adressbereich für die Textfelder werden ab Version 4.4 in den Komponenten der Systemen im CareSuite Administrator eingestellt.

→ Gets-Zentrale konfigurieren
→ Gets Radio Hub konfigurieren

Sprache ändern

Um die Sprache der CareSuite Installation zu ändern müssen folgende Einstellungen für die API und das Webinterface ergänzt werden:

API

Die Sprache der API wird über die Datei web\config\api.config angepasst. Darin muss folgende Zeile mit gewünschtem Sprachcode ergänzt werden:

APP_LOCALE=it

Mögliche Sprachcodes sind de, it, fr und en. Ist die Zeile nicht vorhanden wird die Standardsprache Deutsch verwendet.

Webinterface

Die Sprache des Webinterface wird über die Datei web\config\client.config angepasst. Darin muss die Zeile locale mit gewünschtem Sprachcode ergänzt werden:

{
  "backend": "http://127.0.0.1",
  "locale": "it"
}

Wichtig: Auf der Zeile backend muss ein Komma am Schluss der Zeile ergänzt werden.

Mögliche Sprachcodes sind de, it, fr und en. Ist die Zeile nicht vorhanden wird die Standardsprache Deutsch verwendet.

VisiCall Rufanzeige

Die Anzeige der Rufe in VisiCall kann ab Version 4.2.9 via Konfigurationsdatei angepasst werden.

1. Zeile (grosser Text)

Über die Datei web\config\client.config kann ein neuer Konfigurationseintrag visicall_line_1_format mit dem gewünschten Anzeigetemplate ergänzt werden.

{
  "backend": "http://127.0.0.1",
  "visicall_line_1_format": "{nameOrCode}{.attribute}"
}

Wichtig: Auf der Zeile backend muss ein Komma am Schluss der Zeile ergänzt werden.

Das Standardformat ist {nameOrCode}{.attribute}, also z. B. Medaillon 1.**** oder MED1.****. Folgende Platzhalter stehen zur Verfügung:

Platzhalter	Beispielwert	Beschreibung
`{nameOrCode}`	`MED1`	Alias/Name eines Elements wenn vorhanden, ansonsten Code wenn vorhanden, ansonsten GETS-ID
`{nameOrGets}`	`002`	Alias/Name eines Elements wenn vorhanden, ansonsten GETS-ID
`{(nameOrGets)}`	`(002)`	Alias/Name eines Elements in Klammern, ansonsten GETS-ID
`{name}`	`Medaillon 1`	Alias/Name eines Elements wenn vorhanden
`{(name)}`	`(Medaillon 1)`	Alias/Name eines Elements in Klammern
`{code}`	`MED1`	Code eines Elements wenn vorhanden
`{(code)}`	`(MED1)`	Code eines Elements in Klammern
`{codeOrGets}`	`002`	Code eines Elements wenn vorhanden, ansonsten GETS-ID
`{(codeOrGets)}`	`(002)`	Code eines Elements in Klammern, ansonsten GETS-ID
`{attribute}`	`****`	Attribut eines Rufes wenn vorhanden
`{.attribute}`	`.****`	Attribut eines Rufes mit Punkt
`{(attribute)}`	`(****)`	Attribut eines Rufes in Klammern
`{address}`	`001`	GETS-ID eines Rufes
`{(address)}`	`(001)`	GETS-ID eines Rufes in Klammern
`{section}`	`Sektion A`	Sektion des Rufes
`{position}`	`Lift EG`	Position des Rufes
`{positionCode}`	`Lift`	Code des Checkpoints der Positionsmeldung
`{(positionCode)}`	`(Lift)`	Code des Checkpoints in Klammern
`{positionShort}`	`Lift`	Kurze Position aus Gets-Zentrale
`{(positionShort)}`	`(Lift)`	Kurze Position aus Gets-Zentrale in Klammern

2. Zeile (kleiner Text)

Über die Datei web\config\client.config kann ein neuer Konfigurationseintrag visicall_line_2_format mit dem gewünschten Anzeigetemplate ergänzt werden.

{
  "backend": "http://127.0.0.1",
  "visicall_line_1_format": "{nameOrCode}",
  "visicall_line_2_format": "{position}"
}

Wichtig: Auf der vorherigen Zeile muss ein Komma am Schluss der Zeile ergänzt werden.

Das Standardformat ist {position}, also z. B. Lift EG. Es stehen die gleichen Platzhalter wie für Zeile 1 zur Verfügung. Werden mehrere Werte verwendet, werden diese jeweils mit einem Komma separiert angezeigt.

E-Mail-Versand

Falls eine CareSuite-Installation Mails über einen spezifischen SMTP-Server versenden soll, kann dieser wie folgt konfiguriert werden.

In der Datei web\config\api.config müssen folgende Zeilen ergänzt werden:

MAIL_DRIVER=smtp
MAIL_HOST=<IP/Hostname>
MAIL_USERNAME=<SMTP-Benutzername>
MAIL_PASSWORD=<SMTP-Passwort>
MAIL_PORT=587       # Standard, kann geändert werden
MAIL_ENCRYPTION=tls # Standard, kann geändert werden

Wichtig: Nach der Anpassung dieser Einstellungen muss die Konfiguration neu in die CareSuite geladen werden.

Weitere Einstellungen

Nehmen Sie bei Bedarf zusätzlich noch folgende Einstellungen vor:

Daten erfassen
Neue Benutzer/Gruppen erstellen und Berechtigungen anpassen
Sektionen erstellen
Karten erstellen
Profile erstellen
Funkelemente erfassen

`api.config` Referenz

Die api.config Datei dient zur detaillierten Konfiguration des Webinterface. Untenstehende Optionen können für jede Installation über die Datei C:\Program Files (x86)\CareSuite\web\config\api.config beliebig angepasst werden. Die Einstellungen bleiben über Updates bestehen.

Jede Einstellung wird im Format EINSTELLUNG=wert definiert.

APP_DEBUG=true
BATTERY_LOG_KEEP_ENTRIES=2000

Für nicht definierte Einstellungen wird der hinterlegte Standardwert verwendet.

Vorhandene Optionen

Option	Standardwert	Mögliche Werte
App-Einstellungen
APP_DEBUG	`false`	`true` / `false`
Mit aktiviertem Debug-Modus werden detailliertere Fehlermeldungen und Error-Logs geschrieben. Achtung: Die Logs können sensitive Daten wie z. B. Passwörter und Konsumenten-Secrets enthalten. Aktivieren Sie den Debug-Modus also nur so lange, wie es für die Fehlersuche notwendig ist!
APP_LOCALE	`de`	`de` / `en` / `it` / `fr`
Sprache für das Backend
VALIDATE_HASH	`true`	`true` / `false`
Ob die Hashes der Konsumenten validiert werden sollen. Diese Option darf nur für Entwicklungszwecke auf `false` gesetzt werden da ansonsten die Sicherheit der Webhooks nicht gewährleistet werden kann.
SEND_USAGE	`true`	`true` / `false`
Sende Nutzungsstatistik
INVALID_CALLTYPE_REPLACEMENT_ID	`null`	`[0-9]+`
Standardmässig werden unbekannte Rufarten in der CareSuite automatisch eröffnet. Hat diese Option einen Wert, werden Rufe mit unbekanntem Typ auf den Ruftyp mit der konfigurierten ID umgeschrieben.
Limits
NAME_LENGTH	`11`	`[0-9]+`
Diese Einstellung ist ab Version 4.4 nicht mehr verfügbar. Maximale Länge des `Name` Feld für Elemente. Für GETS-Rufanlagen beträgt die maximale Länge 11 Zeichen. Wird die CareSuite zusammen mit kompatiblen Alarm-Server-Installationen betrieben, kann diese Einstellung entsprechend erhöht werden.
MAX_CARELOG_EXPORT_COUNT	`5000`	`[0-9]+`
Maximale Anzahl der Rufe, die in einem CareLog-Export mit einbezogen werden. Auf weniger leistungsfähiger Hardware muss diese Zahl evtl. verringert werden.
BATTERY_LOG_KEEP_ENTRIES	`100000`	`[0-9]+`
Maximale Anzahl der Batterieverlauf-Updates. Überschreitet das Batterielog diese Anzahl Einträge, werden alte Einträge fortlaufend gelöscht.
POSITION_LOG_KEEP_ENTRIES	`100000`	`[0-9]+`
Maximale Anzahl des Positionsverlaufs. Überschreitet das Positionslog diese Anzahl Einträge, werden alte Einträge fortlaufend gelöscht.
POSITION_LOG_IGNORE	`000, Keine Position, Unbekannt, Position unbekannt`	`Komma getrennt`
Positionen, die nicht registriert werden sollen. Wir eine solche Position gemeldet, wird diese nicht als «Letzte Position» bei einem Funkelement eingetragen. Für die CareLog-Statistik werden die Positionen nicht gefiltert und trotzdem abgespeichert.
CHECKPOINT_MAX_GETS_ID	`200`	`[0-9]+`
Checkpoints können in der GETS-Zentrale nur IDs < 200 haben. Wird ein System konfiguriert, in dem keine Zentrale vorhanden ist, kann dieses Limit mit diesem Konfigurationswert beliebig erhöht werden.
CHECK_CRITERIA_HOURS	`4`	`[0-9]+`
Der überwachte Zeitraum für das 0x6A Kriterium in Stunden.
MAX_CRITERIA_OCCURRENCE	`4`	`[0-9]+`
Wie oft ein 0x6A Kriterium im `CHECK_CRITERIA_HOURS` Zeitraum vorkommen darf, bevor ein Bericht ausgelöst wird.
Berichte
REPORT_WAIT_WHEN_UNREACHABLE	`5`	`[0-9]+`
Wenn ein Element nicht mehr erreichbar ist, warte diese Anzahl Minuten, bis ein "umgehender" Bericht für das Element versendet wird. Diese Einstellung dient dazu, Falschmeldungen zu verhindern, falls ein Element einmal für ein paar Minuten nicht mehr erreichbar sein sollte.
REPORTS_MAX_HITS	`500`	`[0-9]+`
Maximale Anzahl Treffer, die in einem Report versendet werden. Diese Option dient dazu, den Versand übergrosser Mails zu verhindern.
Textfelder
TEXTFIELDS_ENABLED	`true`	`true` / `false`
Diese Einstellung ist ab Version 4.4 nicht mehr verfügbar. Wird diese Option auf `false` gestellt, werden beim Erstellen eines Elements keine Textfelder belegt.
TEXTFIELDS_POOL_START	`20`	`[0-9]+`
Diese Einstellung ist ab Version 4.4 nicht mehr verfügbar. Diese Einstellung definiert den Start des Textfeld-Pools. Der Wert dieser Einstellung entspricht der tiefsten vorhandenen Textfeld-Adresse.
TEXTFIELDS_POOL_END	`99`	`[0-9]+`
Diese Einstellung ist ab Version 4.4 nicht mehr verfügbar. Diese Einstellung definiert das Ende des Textfeld-Pools. Der Wert dieser Einstellung entspricht der höchsten vorhandenen Textfeld-Adresse.
Option	Standardwert	Mögliche Werte
Health-Checks
HEALTH_CHECK	`true`	`true` / `false`
Wird diese Einstellung deaktiviert, werden keine Health-Checks durchgeführt und somit keine Benachrichtigungen bei möglichen Problemen mit der CareSuite-Installation versendet. Um spezifische Health-Checks zu deaktivieren, lassen Sie diese Option auf `true` und nutzen Sie zusätzlich untenstehende Optionen.
HEALTH_CHECK_SERVICE	`true`	`true` / `false`
Überprüft, ob der letzte Heartbeat-Kontakt mit dem CareSuite-Service nicht länger als eine bestimmte Zeit her ist. Die erlaubte Zeitspanne ohne Kontakt bis der Fehlerzustand ausgelöst wird kann über die Einstellung `HEALTH_CHECK_SERVICE_TIMEOUT` definiert werden.
HEALTH_CHECK_CARELOG	`true`	`true` / `false`
Überprüft, ob der CareLog-Datenbestand in allen Systemen konsistent und aktuell ist. Werden für eine gewisse Zeit keine Rufe ans System gemeldet, wird der Fehlerzustand ausgelöst. Die erlaubte Zeitspanne ohne Daten kann über die Einstellung `HEALTH_CHECK_MAX_CALL_TIMEOUT` definiert werden.
HEALTH_CHECK_BACKUPS	`true`	`true` / `false`
Überprüft, ob die CareSuite-Backups nicht älter als ein Tag sind.
HEALTH_CHECK_DATABASE	`true`	`true` / `false`
Überprüft, ob eine Verbindung zur Datenbank hergestellt werden kann.
HEALTH_CHECK_BATTERY_LOG	`true`	`true` / `false`
Überprüft, ob der Batterieverlauf-Datenbestand in allen Systemen konsistent und aktuell ist. Werden für eine gewisse Zeit keine Batterieupdates ans System gemeldet, wird der Fehlerzustand ausgelöst. Die erlaubte Zeitspanne ohne Daten kann über die Einstellung `HEALTH_CHECK_MAX_LOG_TIMEOUT` definiert werden.
HEALTH_CHECK_POSITION_LOG	`true`	`true` / `false`
Überprüft, ob der Positionsverlauf-Datenbestand in allen Systemen konsistent und aktuell ist. Werden für eine gewisse Zeit keine Batterieupdates ans System gemeldet, wird der Fehlerzustand ausgelöst. Die erlaubte Zeitspanne ohne Daten kann über die Einstellung `HEALTH_CHECK_MAX_LOG_TIMEOUT` definiert werden.
Option	Standardwert	Mögliche Werte
Health-Check-Timeouts
HEALTH_CHECK_RESEND_TIMEOUT	`1140` (24 h)	`[0-9]+`
Diese Einstellung definiert, wie viele Minuten vergehen sollen, bevor das Ergebnis eines fehlgeschlagenen Health-Checks erneut per Email versendet werden soll.
HEALTH_CHECK_SERVICE_TIMEOUT	`240` (4 h)	`[0-9]+`
Diese Einstellung definiert, wie viele Minuten der letzte Kontakt mit dem Service her sein darf, bevor der Fehlerzustand ausgelöst wird.
HEALTH_CHECK_MAX_CALL_TIMEOUT	`12`	`[0-9]+`
Diese Einstellung definiert, wie viele Stunden keine Rufe an das Webinterface gesendet werden können, bevor der Fehlerzustand ausgelöst wird. Bei Installationen mit geringem Rufvolumen muss diese Einstellung evtl. erhöht werden damit über die Nachtstunden keine falschen Positiv-Meldungen ausgelöst werden.
HEALTH_CHECK_MAX_LOG_TIMEOUT	`12`	`[0-9]+`
Diese Einstellung definiert, wie viele Stunden keine Positions- oder Batteriestatus-Updates ans Webinterface gesendet werden können, bevor der Fehlerzustand ausgelöst wird.