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 1: / Zeile 1: @@
-Das [[Wt-Webservice]] - '''Automatischer Konto-Report-Export''' ist eine [[Programmfunktion]] die es ermöglicht, Dateien die durch einen [[Automatischer Konto-Report-Export|automatischen Konto-Report-Export]] erzeugt wurden, abzurufen.
+Das [[Wt-Webservice]] - '''Automatischer Konto-Report-Export''' ist eine [[Programmfunktion|Programmfunktion,]] die es ermöglicht, Dateien, welche durch einen [[Automatischer Konto-Report-Export|automatischen Konto-Report-Export]] erzeugt wurden, abzurufen.
-Diese Dateien können durch Fremdsysteme maschinell weiterverarbeitet werden.
+Diese Dateien können durch Fremdsysteme weiterverarbeitet werden.
 == Ausgangssituation ==
@@ Zeile 7: / Zeile 7: @@
 === Voraussetzungen ===
-Neben den Voraussetzungen für den Betrieb eines [[Wt-Webservice]] 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 dann für jede Exportierte Datei einen Zugriffspfad zur Verfügung
+Das Webservice stellt für jede exportierte Datei einen Zugriffspfad zur Verfügung.
 === Formatierung der Anfrage ===
@@ Zeile 16: / Zeile 16: @@
 ==== Schema für URL-Kodierung ====
-Die URL muss folgendes Format haben:
- '''/<Dateiname>.<Dateiendung>'''
 {| class="wikitable" style=""
-! Parameter !! Wertebereich !! Beschreibung
+!Parameter!!Wertebereich!!Beschreibung
 |-
-| <code><Dateiname></code> || Zeichenkette ||
+|<code><Dateiname></code>||Zeichenkette||[[Konto-Report#Konto-Report anlegen|Bezeichnung des Konto-Reports]]
 |-
-| <code><Dateiendung></code> || Zeichenkette ||
+|<code><Dateiendung></code>||Zeichenkette||[[Konto-Report-Export#Funktionsbeschreibung|Laut Exporteinstellungen]]
 |}
-=== Formatierung der Ausgabe ===
+Die URL muss folgendes Format aufweisen:
+ '''/<Dateiname>.<Dateiendung>'''
-Eine Datei im Format der hinterlegten Report-Export Einstellungen.
+===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.
-== Ausgangssituation ==
+==Beispiel==
-=== Voraussetzungen ===
+===Anforderung===
-Das Webservice baut auf die Programmfunktionen [[Webservice Tagesinformationen]] bzw. [[Webservice Personalstammdaten Export]] auf und setzt voraus, dass {{Alex}} von Bit Factory gehostet wird.
+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
-==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Aufruf_der_Funktion">Aufruf der Funktion</span>==
+===Umsetzung===
-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===
+[[Webservice_-_Automatischer_Konto-Report-Export#Voraussetzungen|Die Voraussetzungen]] für den Betrieb müssen erfüllt sein.
-'''Aufbau der URL:'''
-[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung]
+{| class="wikitable"
+|+
+!Arbeitsschritte
+! Beispielhafte Einstellung der Parameter
+|-
+|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 und am System hinterlegen.
+|[[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
+|Beispiele für den Aufruf:
-'''Beispiel:'''
+* Report ''-> http://localhost:8080/AKRE.json''
+* Schema -> ''http://localhost:8080/AKRE.json_schema''
-[http://80.122.54.250:8080/Zeitguthabenstände http://52.28.12.244:8080/Zeitguthaben.json]
+|-
+|}
-===Verschlüsselter Aufruf===
-'''Aufbau der URL:'''
-[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung&WebApiServerKey=Wert]
+===Ergebnis===
-'''Beispiel:'''
+Dateien im [http://ndjson.org/ JSON Format]. Näheres hier zu möglichen Formaten hier: [[Konto-Report-Export]]
-http://52.28.12.244:8080/Zeitguthaben.json&WebApiServerKey=1234-1234-1234-1234-1234
+<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}
+{"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}
+</syntaxhighlight>
-==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Funktionsbeschreibung">Funktionsbeschreibung</span>==
+<syntaxhighlight lang="json">
-Das Webservice - Automatischer Konto-Report-Export <span style="color: rgb(0, 0, 0); font-family: Montserrat, serif; font-size: 15px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; display: inline !important; float: none;">ist eine</span> [[Programmfunktion]] <span style="color: rgb(0, 0, 0); font-family: Montserrat, serif; font-size: 15px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; display: inline !important; float: none;">zur Abfrage von Tagesinformationen pro Personal und Zeitbereich sowie zur Abfrage von Personalstammdaten für einen Zeitbereich.</span>
+ 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>
-===<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Abgreifen_der_Steuerdaten">Abgreifen der Steuerdaten</span>===
+===Datenbank für Beispiel===
-Die Hinterlegung der Steuerdaten wird beim Anlegen eines [[Automatischer Konto-Report-Export|automatischen Konto-Report-Export]] detailliert beschrieben.
+[https://drive.google.com/file/d/1ecJWbBlqR2UjVAKcJwtPmmfIHpcILfaL/view?usp=share_link AutomatischerKontoReportExportDB]
 ==Fußnoten==