Body-Parameter¶
Beim Aufruf der Webdisposition werden dem Web-Client verschiedene Parameter im Body übergeben. Sie gliedern sich in Konfigurationsdaten, Links zu Business Central und allgemeine Einstellungen.
Konfigurationsdaten¶
Die Konfigurationsdaten stellen die Verbindung zur Datenbank bzw. zur API her.
| Parameter | Beschreibung | JSON |
|---|---|---|
| UserName | Benutzername für den Datenbankzugriff | "Username": "{username}" |
| Password | Passwort für den Datenbankzugriff | "Password": "{password}" |
| ApiUsername | Benutzername für die API zum Ändern von Daten | "ApiUsername": "{apiusername}" |
| ApiKey | Schlüssel für die API zum Ändern von Daten | "ApiKey": "{apikey}" |
| Server | Datenbankserver | "Server": "{server}" |
| Database | Datenbankinstanz | "Database": "{database}" |
| Company | Mandantenname | "Company": "{company}" |
| CompanyID | ID des Mandanten | "CompanyID": "{companyid}" |
| BCX | Gibt an, ob Business Central 18 oder neuer verwendet wird | "BCX": "{true/false}" |
| ConfigFilePath | Pfad zur Konfigurationsdatei der Webdisposition | "ConfigFilePath": "{C:/temp/webdispoconfigfile.txt}" |
Links zu Business Central¶
Über die Links werden die Sprünge zurück nach Business Central und die API zum Ändern von Daten gesteuert.
Hinweis
Links müssen <<>> als Platzhalter für die zugehörige(n) ID(s) enthalten und Sonderzeichen als HTML-Code angeben (z. B. %27 für ', & für &).
| Parameter | Beschreibung | JSON |
|---|---|---|
| BubbleLink | Link zum Öffnen eines Einsatzes in Business Central | "BubbleLink": "{link}" |
| BubbleLinkList | Link zum Öffnen mehrerer Einsätze in Business Central | "BubbleLinkList": "{link}" |
| EmplLink | Link zum Öffnen der Mitarbeiterkarte | "EmplLink": "{link}" |
| AbsenceLink | Link zum Erfassen der Abwesenheiten eines Mitarbeiters | "AbsenceLink": "{link}" |
| RosterLink | Link zum Öffnen des Dienstplans eines Mitarbeiters | "RosterLink": "{link}" |
| APILink | Link zur API, um Termine zu verplanen und anzupassen | "APILink": "{link}" |
| PlanningAppointmentsLink | Link zur Terminübersicht einer Leistung zu einem definierten Zeitraum | "PlanningAppointmentsLink": "{link}" |
| EmployeeAppointmentsLink | Link zur Übersicht der verplanten Termine eines Mitarbeiters | "EmployeeAppointmentsLink": "{link}" |
Einstellungen¶
Die allgemeinen Einstellungen steuern das Verhalten und die Darstellung der Planungsansicht.
| Parameter | Beschreibung | JSON |
|---|---|---|
| Deadline | Frist, ab der keine Termine zuvor verplant oder zurückgesetzt werden dürfen | "DeadLine": "{yyyy-MM-dd}" |
| GroupBy | Spalten, nach denen in der Datenbank gruppiert wird | – |
| VisibleColumnsEvents | Im Web-Client angezeigte Spalten der Planungsansicht | – |
| VisibleColumnsEmployees | Im Web-Client angezeigte Spalten der Mitarbeitertabelle | – |
| ShowShiftCode | Gibt an, ob ein Schichtcode in den Mitarbeiterterminen angezeigt wird | "ShowShiftCode": "{true/false}" |
| IsWebClient | Gibt an, ob Business Central als Web-Client geöffnet wird | "IsWebClient": "{true/false}" |
Hinweis
Der Parameter UseNTLM ist in der Konfiguration vorgesehen, aktuell jedoch ohne Funktion.