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

Aktuelle Version vom 15. April 2024, 14:16 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

Die URL muss folgendes Format aufweisen:

/<Dateiname>.<Dateiendung>

Formatierung der Ausgabe

Eine Datei im Format der hinterlegten Konto-Report Exporteinstellungen.

Der Ordner in dem die Datei abgelegt wird kann in den Exporteinstellungen hinterlegt werden.

Falls kein Ordner hinterlegt wird, wird der Ordner "AutomaticAccountsReportExport" im Ordner des ALEX-Config-Files verwendet.

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

Die Voraussetzungen für den Betrieb müssen erfüllt sein.


Arbeitsschritte	Beispielhafte Einstellung der Parameter
Konto-Report mit den gewünschten Zeitkonten anlegen
Format definieren
Automatischen Konto-Report-Export anlegen und am System hinterlegen.
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	Beispiele für den Aufruf: Report -> http://localhost:8080/AKRE.json Schema -> http://localhost:8080/AKRE.json_schema

Ergebnis

2 Dateien im JSON Format. Näheres hier zu möglichen Formaten hier: Konto-Report-Export

 AKRE.json
{"Zuname":"DIRTL","Vorname":"Daniela","Stichtag":"01.05.2023","PersonalNr":"312","DRZ V g.":6E0,"ZAg Dauer":0E0}
{"Zuname":"EDELBACHER","Vorname":"Jakob","Stichtag":"01.05.2023","PersonalNr":"382","DRZ V g.":-4E-1,"ZAg Dauer":0E0}
{"Zuname":"EIGNER","Vorname":"Annemarie","Stichtag":"01.05.2023","PersonalNr":"161","DRZ V g.":-2.97E0,"ZAg Dauer":0E0}
{"Zuname":"HEROLD","Vorname":"Petra","Stichtag":"01.05.2023","PersonalNr":"415","DRZ V g.":-2E-2,"ZAg Dauer":0E0}
{"Zuname":"LEITNER","Vorname":"Nadine","Stichtag":"01.05.2023","PersonalNr":"280","DRZ V g.":5.62E0,"ZAg Dauer":0E0}
{"Zuname":"MELCHUS","Vorname":"Gerald","Stichtag":"01.05.2023","PersonalNr":"320","DRZ V g.":-8.3E-1,"ZAg Dauer":0E0}

 AKRE.json_schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Konto-Report","description":"AKRE","type":"object","properties":{"Zuname":{"type":"string"},"Vorname":{"type":"string"},"Stichtag":{"type":"string"},"PersonalNr":{"type":"string"},"DRZ V g.":{"type":"number"},"ZAg Dauer":{"type":"number"}},"required":["Zuname","Vorname","Stichtag","PersonalNr","DRZ V g.","ZAg Dauer"]}

Datenbank für Beispiel

AutomatischerKontoReportExportDB

Fußnoten

Issue 8011

@@ Zeile 7: / Zeile 7: @@
 === Voraussetzungen ===
-Neben den Voraussetzungen für den Betrieb eines [[Wt-Webservice|Wt-Webservices]] muss ein Automatischer-Konto-Report-Export konfiguriert sein.
+Neben den Voraussetzungen für den Betrieb eines [[Wt-Webservice|Wt-Webservices]] muss ein [[automatischer Konto-Report-Export]] konfiguriert sein.
 Das Webservice stellt für jede exportierte Datei einen Zugriffspfad zur Verfügung.
@@ Zeile 30: / Zeile 30: @@
 ===Formatierung der Ausgabe ===
 Eine Datei im Format der hinterlegten Konto-Report Exporteinstellungen.
+Der Ordner in dem die Datei abgelegt wird kann in den Exporteinstellungen hinterlegt werden.
+Falls kein Ordner hinterlegt wird, wird der Ordner "AutomaticAccountsReportExport" im Ordner des ALEX-Config-Files verwendet.
 ==Beispiel==
@@ Zeile 48: / Zeile 52: @@
 ===Umsetzung===
-Die Voraussetzungen für [[Webservice_-_Automatischer_Konto-Report-Export#Voraussetzungen]] müssen erfüllt sein.
+[[Webservice_-_Automatischer_Konto-Report-Export#Voraussetzungen|Die Voraussetzungen]] für den Betrieb müssen erfüllt sein.
 {| class="wikitable"
@@ Zeile 61: / Zeile 65: @@
 |[[Datei:Webservice - Automatischer Konto-Report-Export Beispiel 1-3.png|mini|alternativtext=|ohne]]
 |-
-|Automatischen Konto-Report-Export anlegen
+|Automatischen Konto-Report-Export anlegen und am System hinterlegen.
 |[[Datei:Webservice - Automatischer Konto-Report-Export Beispiel 1-2.png|400px]]
 |-
@@ Zeile 72: / Zeile 76: @@
 * Report ''-> http://localhost:8080/AKRE.json''
 * Schema -> ''http://localhost:8080/AKRE.json_schema''
-* Verschlüsselter Report-> ''[http://localhost:8080/AKRE.json?WebApiServerKey=c371305d-4954-4113-8a3e-c6f5ed796c7a http://localhost:8080/AKRE.json]''?WebApiServerKey=c371305d-4954-4113-8a3e-c6f5ed796c7a
-* Verschlüsseltes Schema-> ''http://localhost:8080/AKRE.json_schema?WebApiServerKey=c371305d-4954-4113-8a3e-c6f5ed796c7a''
 |-
 |}
 ===Ergebnis===
-AKRE.json<syntaxhighlight lang="json">
+Dateien im [http://ndjson.org/ JSON Format]. Näheres hier zu möglichen Formaten hier: [[Konto-Report-Export]]
+<syntaxhighlight lang="json">
+ AKRE.json
 {"Zuname":"DIRTL","Vorname":"Daniela","Stichtag":"01.05.2023","PersonalNr":"312","DRZ V g.":6E0,"ZAg Dauer":0E0}
 {"Zuname":"EDELBACHER","Vorname":"Jakob","Stichtag":"01.05.2023","PersonalNr":"382","DRZ V g.":-4E-1,"ZAg Dauer":0E0}
@@ Zeile 85: / Zeile 91: @@
 {"Zuname":"LEITNER","Vorname":"Nadine","Stichtag":"01.05.2023","PersonalNr":"280","DRZ V g.":5.62E0,"ZAg Dauer":0E0}
 {"Zuname":"MELCHUS","Vorname":"Gerald","Stichtag":"01.05.2023","PersonalNr":"320","DRZ V g.":-8.3E-1,"ZAg Dauer":0E0}
-{"Zuname":"SCHILDBÃ–CK","Vorname":"Bernadette","Stichtag":"01.05.2023","PersonalNr":"227","DRZ V g.":6.17E0,"ZAg Dauer":0E0}
 </syntaxhighlight>
-AKRE.json_schema<syntaxhighlight lang="json">
+<syntaxhighlight lang="json">
+ AKRE.json_schema
 {"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Konto-Report","description":"AKRE","type":"object","properties":{"Zuname":{"type":"string"},"Vorname":{"type":"string"},"Stichtag":{"type":"string"},"PersonalNr":{"type":"string"},"DRZ V g.":{"type":"number"},"ZAg Dauer":{"type":"number"}},"required":["Zuname","Vorname","Stichtag","PersonalNr","DRZ V g.","ZAg Dauer"]}
 </syntaxhighlight>
+===Datenbank für Beispiel===
-==Datenbank für Beispiel==
+[https://drive.google.com/file/d/1ecJWbBlqR2UjVAKcJwtPmmfIHpcILfaL/view?usp=share_link AutomatischerKontoReportExportDB]
-[https://drive.google.com/file/d/1ecJWbBlqR2UjVAKcJwtPmmfIHpcILfaL/view?usp=share_link DokuDB]
 ==Fußnoten==