Dienstplan als PDF im Browser: Unterschied zwischen den Versionen

Zeile 6: Zeile 6:


* Es müssen die Voraussetzungen für den Betrieb des [[Intern:Bfx.Alex.UI.Web.dll|WebUI-Webservice]] erfüllt sein sein.
* Es müssen die Voraussetzungen für den Betrieb des [[Intern:Bfx.Alex.UI.Web.dll|WebUI-Webservice]] erfüllt sein sein.
* Es muss ein Benutzer mit den gewünschten Druckeinstellungen konfiguriert werden.
* Es muss ein '''minimaler Status für Webservice-Ausdruck von Dienstplan'''<ref name="issue8715">{{githubissue|8715}}</ref> ausgewählt werden. Weitere Informationen zur Statustreppe finden Sie [[Statustreppe|hier]].
**Bei Nichterfüllen des minimale Status wird eine Fehlermeldung in folgendem Format angezeigt:
<syntaxhighlight lang="json">
{ "request" : "/AlexPrintPlanPerioddate=10.07.2023&employeeId=1111", "status" : "error", "details" : "Dienstplan mit Status >Planung< noch nicht verfĆ¼gbar." }
</syntaxhighlight>
*Es muss ein Benutzer mit den gewünschten Druckeinstellungen konfiguriert werden.
**<code>Systemeinstellungen: Druck-Einstellungen: Benutzer für Webservice Ausdruck von Monatsplan</code>
**<code>Systemeinstellungen: Druck-Einstellungen: Benutzer für Webservice Ausdruck von Monatsplan</code>
* Der Benutzer muss mindestens die Rechte '''Dienstplan lesen''' besitzen.
*Der Benutzer muss mindestens die Rechte '''Dienstplan lesen''' besitzen.
{{AlexBild|Ausdruck Benutzer|[[Datei:Dienstplan_PDF.PNG]]}}
{{AlexBild|Ausdruck Benutzer|[[Datei:Dienstplan_PDF.PNG]]}}


=== Formatierung der Anfrage===
===Formatierung der Anfrage===


Die Daten werden dem Webservice '''in der URL kodiert''' als '''GET'''-Argumentübertragung übergeben.
Die Daten werden dem Webservice '''in der URL kodiert''' als '''GET'''-Argumentübertragung übergeben.
Zeile 38: Zeile 43:


*<code><nowiki>http://192.168.0.100:8080/AlexPrintPlanPeriod?date=10.06.2023&employeeId=123</nowiki></code>
*<code><nowiki>http://192.168.0.100:8080/AlexPrintPlanPeriod?date=10.06.2023&employeeId=123</nowiki></code>
===Minimaler Status für Webservice-Ausdruck von Dienstplan <ref name="issue8715">{{githubissue|8715}}</ref>===
Der Dienstplan wird beim Abruf über die URL ohne Inhalt angezeigt, sobald der gesetze Wert beim Parameter '''minimaler Status für Webservice-Ausdruck von Dienstplan''' unterschritten wird.
'''<u>Beispiel:</u>'''
Gesetzter Wert beim Parameter ist Status Planung.
Alle Dienstpläne im Status nicht erzeugt werden ohne geplante Dienste, Aufgaben, Planungscodes, Sonderabrechnungen als PDF übergeben.
{| class="wikitable alex-blue"
|+
! colspan="2" |Statustreppe
|-
!Status
!Beschreibung
|-
|Nicht erzeugt
|Weiterführende Informationen finden Sie [[Statustreppe#Nicht erzeugt|hier]].
|-
|Planung
|Weiterführende Informationen finden Sie [[Statustreppe#Planung|hier]].
|-
|Benachrichtigt
|?
|-
|Benachrichtigt Planer
|?
|-
|Ist
|Weiterführende Informationen finden Sie [[Statustreppe#Ist|hier]].
|-
|Abgeschlossen
|Weiterführende Informationen finden Sie [[Statustreppe#Abgeschlossen|hier]].
|-
|Versiegelt
|Weiterführende Informationen finden Sie [[Statustreppe#Versiegelt|hier]].
|}


==Fußnoten==
==Fußnoten==

Version vom 17. Juli 2023, 16:07 Uhr

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

Ausgangssituation

Voraussetzungen

  • Es müssen die Voraussetzungen für den Betrieb des WebUI-Webservice erfüllt sein sein.
  • Es muss ein minimaler Status für Webservice-Ausdruck von Dienstplan[2] ausgewählt werden. Weitere Informationen zur Statustreppe finden Sie hier.
    • Bei Nichterfüllen des minimale Status wird eine Fehlermeldung in folgendem Format angezeigt:
{ "request" : "/AlexPrintPlanPerioddate=10.07.2023&employeeId=1111", "status" : "error", "details" : "Dienstplan mit Status >Planung< noch nicht verfĆ¼gbar." }
  • 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.
Ausdruck Benutzer
Dienstplan PDF.PNG

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

Beispiel:

  • http://192.168.0.100:8080/AlexPrintPlanPeriod?date=10.06.2023&employeeId=123

Fußnoten

Diskussionen