Webservice - Automatischer Konto-Report-Export: Unterschied zwischen den Versionen

Version vom 3. Mai 2023, 17:43 Uhr

Das Wt-Webservice - Automatischer Konto-Report-Export ist eine Programmfunktion, die es ermöglicht, Dateien, welche durch einen automatischen Konto-Report-Export erzeugt wurden, abzurufen.

Diese Dateien können durch Fremdsysteme weiterverarbeitet werden.

Ausgangssituation

Voraussetzungen

Neben den Voraussetzungen für den Betrieb eines Wt-Webservices muss ein Automatischer-Konto-Report-Export konfiguriert sein.

Das Webservice stellt für jede exportierte Datei einen Zugriffspfad zur Verfügung.

Formatierung der Anfrage

Die Daten werden dem Webservice als GET-Argumentübertragung übergeben.

Schema für URL-Kodierung

Parameter	Wertebereich	Beschreibung
`<Dateiname>`	Zeichenkette	Bezeichnung des Konto-Reports
`<Dateiendung>`	Zeichenkette	Laut Exporteinstellungen
`<WebApiServerKey>`	Zeichenkette	Sicherer Aufruf

Die URL ohne WebAPIkey muss folgendes Format aufweisen:

/<Dateiname>.<Dateiendung>

Die URL mit WebAPIkey muss folgendes Format aufweisen:

/<Dateiname>.<Dateiendung>?WebApiServerKey=<1234-1234-1234-1234-1234>

Formatierung der Ausgabe

Eine Datei im Format der hinterlegten Konto-Report Exporteinstellungen.

Beispiel

Anforderung

Der Automatische Konto-Report-Export muss

folgende Parameter und Zeitkonten aktuell (täglich aktualisiert)
- Zuname
- Vorname
- Personalnummer
- Zeitausgleichskonsum
- DRZ-Bilanz Vorschau gesamt
verschlüsselt
im JSON-Format
über eine URL zur Verfügung stellen

Umsetzung


Arbeitsschritte	Beispielhafte Einstellung der Parameter
Voraussetzungen für Webservice Automatischer Konto-Report-Export erfüllen	Siehe Wt-Webservices
Konto-Report mit den gewünschten Zeitkonten anlegen
Format definieren
Automatischen Konto-Report-Export anlegen
Alex^®Dienst neu starten	Damit der Einsprungspunkt für den Konto-Report erzeugt wird, muss der Dienst neu gestartet werden.
URL laut Kodierung im Browser eingeben und Ergebnis prüfen	http://localhost:8080/AKRE.json?WebApiServerKey=c371305d-4954-4113-8a3e-c6f5ed796c7a

Ergebnis

Ergebnis über URL-Aufruf

Fußnoten

Issue 8011

@@ Zeile 36: / Zeile 36: @@
 Eine Datei im Format der hinterlegten Konto-Report Exporteinstellungen.
-------
-==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Aufruf_der_Funktion">Aufruf der Funktion</span>==
+==Beispiel==
-Ist die Datenbank laut Anforderung eingerichtet, so kann man einen automatischen Konto-Report-Export unverschlüsselt wie folgt aufrufen:
-{{AlexBildRechts|Aufruf über URL|[[Datei:Webservice - Automatischer Konto-Report-Export.png]]}}
-===Unverschlüsselter Aufruf===
-'''Aufbau der URL:'''
-[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung]
-'''Beispiel:'''
-[http://80.122.54.250:8080/Zeitguthabenstände http://52.28.12.244:8080/Zeitguthaben.json]
+===Anforderung===
+Der Automatische Konto-Report-Export muss
+*folgende Parameter und Zeitkonten aktuell (täglich aktualisiert)
+**Zuname
+**Vorname
+**Personalnummer
+**Zeitausgleichskonsum
+**DRZ-Bilanz Vorschau gesamt
+*verschlüsselt
+*im JSON-Format
+*über eine URL zur Verfügung stellen
-==Funktionsbeschreibung==
+===Umsetzung===
-Das Webservice - Automatischer Konto-Report-Export ist eine [[Programmfunktion]] zur Abfrage von Tagesinformationen pro Personal und Zeitbereich sowie zur Abfrage von Personalstammdaten für einen Zeitbereich.
+{| class="wikitable"
+|+
-==Beispiel==
+!Arbeitsschritte
-Es sollen folgenden aktuelle Parameter und Zeitkonten über eine URL abrufbar sein:
+! Beispielhafte Einstellung der Parameter
+|-
+|Voraussetzungen für Webservice Automatischer Konto-Report-Export erfüllen
+|Siehe [[Wt-Webservice|Wt-Webservices]]
+|-
+|Konto-Report mit den gewünschten Zeitkonten anlegen
+|[[Datei:Webservice - Automatischer Konto-Report-Export Beispiel 1.png|298x298px|alternativtext=]]
+|-
+|Format definieren
+|[[Datei:Webservice - Automatischer Konto-Report-Export Beispiel 1-3.png|mini|alternativtext=|ohne]]
+|-
+|Automatischen Konto-Report-Export anlegen
+|[[Datei:Webservice - Automatischer Konto-Report-Export Beispiel 1-2.png|400px]]
+|-
+|{{Alex}}Dienst neu starten
+|Damit der Einsprungspunkt für den Konto-Report erzeugt wird, muss der Dienst neu gestartet werden.
+|-
+|URL laut Kodierung im Browser eingeben und Ergebnis prüfen
+|''http://localhost:8080/AKRE.json?WebApiServerKey=c371305d-4954-4113-8a3e-c6f5ed796c7a''
+|-
+|}
-*Zuname
+===Ergebnis===
-*Vorname
+{{AlexBild|Ergebnis über URL-Aufruf|[[Datei:Webservice - Automatischer Konto-Report-Export Ergebnis.png]]|}}
-*Personalnummer
-*Zeitausgleich
-*DRZ-Bilanz Vorschau gesamt
 ==Fußnoten==