Dienstplan als PDF im Browser: Unterschied zwischen den Versionen

Version vom 10. Januar 2023, 11:34 Uhr

Das WebUI-Webservice - Dienstplan PDF ist eine Programmfunktion zur Abfrage des Dienstplans pro Personal oder Planungseinheit und Datum im Dateiformat PDF.

Ausgangssituation

Voraussetzungen

Es müssen die Voraussetzungen für den Betrieb des WebUI-Webservice erfüllt sein sein.

Es muss ein Benutzer mit den gewünschten Druckeinstellungen konfiguriert werden.

Systemeinstellungen: Druck-Einstellungen: Benutzer für Webservice Ausdruck von Monatsplan

Der Benutzer muss mindestens die Rechte Dienstplan lesen besitzen.

Formatierung der Anfrage

Die Daten werden dem Webservice in der URL kodiert als GET-Argumentübertragung übergeben.

Ein Datum wird immer als DD.MM.YYYY übertragen.

Schema für URL-Kodierung

Der Prozent-Encodierte Query-String der URL muss folgendes Format haben. Parameter in eckigen Klammern sind optional:

/AlexPrintPlanPeriod
[?planCode=]
[&employeeId=]
[&date=]

Parameter	Wertebereich	Beschreibung
`planCode`	Zeichenkette	Kurzzeichen einer Planungseinheit
`employeeId`	Datum	Eine Personalnummer, die Planungseinheit ergibt sich aus der Stammzuteilung
`date`	Datum	Datum des Monats des gewünschten Stundennachweises, wenn nicht angegeben Heute

@@ Zeile 1: / Zeile 1: @@
+Das [[Intern:Bfx.Alex.UI.Web.dll|WebUI-Webservice]] - '''Dienstplan PDF''' ist eine [[Programmfunktion]] zur Abfrage des Dienstplans pro Personal oder Planungseinheit und Datum im Dateiformat PDF.
+== Ausgangssituation ==
-Es ist möglich, den Dienstplan im PDF Format über den Browser mittels WebService aufzurufen.
+=== Voraussetzungen ===
-Bei Interesse kontaktieren Sie uns bitte bezüglich der Freischaltung dieser Funktion.
+Es müssen die Voraussetzungen für den Betrieb des [[Intern:Bfx.Alex.UI.Web.dll|WebUI-Webservice]] erfüllt sein sein.
-== Aufruf ==
+Es muss ein Benutzer mit den gewünschten Druckeinstellungen konfiguriert werden.
-Mit folgender URL kann nach Freischaltung der Funktion ein Dienstplanausdruck im PDF Format über den Browser mittels WebService aufgerufen werden, der PlanCode ist das "Kurzzeichen" der jeweiligen Planungseinheit:
+* <code>Systemeinstellungen: Druck-Einstellungen: Benutzer für Webservice Ausdruck von Monatsplan</code>
- http://<IP>:<PORT>/AlexPrintPlanPeriod?date=<DD.MM.YYYY>&planCode=<PlanCode>
+Der Benutzer muss mindestens die Rechte '''Dienstplan lesen''' besitzen.
-Mit folgender URL kann der Dienstplan des aktuellen Stammplans des Personals angezeigt werden, die EmployeeId ist die "Personalnummer":
- http://<IP>:<PORT>/AlexPrintPlanPeriod?date=<DD.MM.YYYY>&employeeId=<EmployeeId>
-== Parametrierung ==
+[[Datei:Dienstplan_PDF.PNG]]
-Die Ausdruckeinstellungen können mittels einem eigenen fiktiven Benutzer in ALEX definiert werden.
-Dieser Benutzer muss auf den Systemeinstellungen --> unter "Druck-Einstellungen" hinterlegt werden:
+=== Formatierung der Anfrage ===
-[[Datei:Dienstplan_PDF.PNG]]
+Die Daten werden dem Webservice '''in der URL kodiert''' als '''GET'''-Argumentübertragung übergeben.
+Ein Datum wird immer als <code>DD.MM.YYYY</code> übertragen.
+==== Schema für URL-Kodierung ====
+Der [https://de.wikipedia.org/wiki/URL-Encoding Prozent-Encodierte] [https://de.wikipedia.org/wiki/Query-String Query-String] der URL muss folgendes Format haben. Parameter in eckigen Klammern sind optional:
-Info: Der Benutzer muss mindestens die Rechte "Dienstplan Lesen" haben!
+ '''/AlexPrintPlanPeriod'''
+ [?planCode=]
+ [&employeeId=]
+ [&date=]
-==Bit Factory interne Zusatzinformation==
+{| class="wikitable"
-'''[[Intern:Stundennachweis und Dienstplan als PDF im Browser Aktivierung|Aktivierung]]'''
+! Parameter !! Wertebereich !! Beschreibung
+|-
+| <code>planCode</code> || Zeichenkette || Kurzzeichen einer Planungseinheit
+|-
+| <code>employeeId</code> || Datum || Eine Personalnummer, die '''Planungseinheit''' ergibt sich aus der '''Stammzuteilung'''
+|-
+| <code>date</code> || Datum || Datum des Monats des gewünschten Stundennachweises, wenn nicht angegeben '''Heute'''
+|}
-<br />
-[[Kategorie:Neu ab Version 2016.1]]
 [[Kategorie:Funktionsübersicht]]
 [[Kategorie:Schnittstellen]]