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

VisuellWikitext
Markierung: 2017-Quelltext-Bearbeitung
 
(32 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
[[Bild:ApothekeralexMiraculix.png|right|300px]]
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.
'''<big>ACHTUNG: Artikel ist in Arbeit und wird laufend aktualisiert...</big>'''


Der [[Automatischer Konto-Report-Export|Automatische Konto-Report-Export]] lässt, mittels einer Webservice-Schnittstelle, Informationen aus einem [[Konto-Report]] über eine URL aufrufen. Diese [[Programmfunktion]] ermöglicht es Informationen aus einem Konto-Report an eine Bit-Factory-fremde Software zu übermitteln.
Diese Dateien können durch Fremdsysteme weiterverarbeitet werden.


Die Daten können in unverschlüsselter oder auch in [[Webservice Authorization|verschlüsselter]] Form bereitgestellt werden.
== Ausgangssituation ==


==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Aufruf_der_Funktion">Aufruf der Funktion</span>==
=== Voraussetzungen ===
Ist die Datenbank laut Schnittstellenanforderung 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===
Neben den Voraussetzungen für den Betrieb eines [[Wt-Webservice|Wt-Webservices]] muss ein [[automatischer Konto-Report-Export]] konfiguriert sein.
[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung]


[http://80.122.54.250:8080/Zeitguthabenstände http://52.28.12.244:8080/Zeitguthaben.json]
Das Webservice stellt für jede exportierte Datei einen Zugriffspfad zur Verfügung.


===Verschlüsselter Aufruf===
=== Formatierung der Anfrage ===
[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung&WebApiServerKey=Wert]


http://52.28.12.244:8080/Zeitguthaben.json&WebApiServerKey=1234-1234-1234-1234-1234
Die Daten werden dem Webservice als '''GET'''-Argumentübertragung übergeben.


==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Funktionsbeschreibung">Funktionsbeschreibung</span>==
==== Schema für URL-Kodierung ====


===<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Abgreifen_der_Steuerdaten">Abgreifen der Steuerdaten</span>===
{| class="wikitable" style=""
Steuerdaten für die Schnittstelle sind beim [[Automatischer Konto-Report-Export#Anlage Konto-Report|Konto-Report]] und beim [[Automatischer Konto-Report-Export#Anlage automatischer Konto-Report Export|Automatischen Konto-Report-Export]] zu finden.
!Parameter!!Wertebereich!!Beschreibung
|-
|<code><Dateiname></code>||Zeichenkette||[[Konto-Report#Konto-Report anlegen|Bezeichnung des Konto-Reports]]
|-
|<code><Dateiendung></code>||Zeichenkette||[[Konto-Report-Export#Funktionsbeschreibung|Laut Exporteinstellungen]]
|}


Sollte man sich dazu entschließen die Schnittstelle zusätzlich verschlüsseln zu wollen, sind weitere Steuerdaten in der Gruppe [[Webservice Authorization|WebApiServer Einstellungen in den Systemeinstellungen]] zu hinterlegen.
Die URL muss folgendes Format aufweisen:
'''/<Dateiname>.<Dateiendung>'''


'''ACHTUNG:''' Es dürfen beliebig viele Spalten im Konto-Report hinzugefügt, jedoch keine Spalten entfernt werden!
===Formatierung der Ausgabe ===


==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Beispiele">Beispiele</span>==
Eine Datei im Format der hinterlegten Konto-Report Exporteinstellungen.
Es sollen folgende Informationen über die Schnittstelle abrufbar sein:


* Zuname
Der Ordner in dem die Datei abgelegt wird kann in den Exporteinstellungen hinterlegt werden.
* Vorname
* Personalnummer
* Zeitausgleichskonsum
* Fortbildungdauer in Stunden


==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Konkrete_Anwendungsf.C3.A4lle_.2B_L.C3.B6sungsm.C3.B6glichkeiten">Konkrete Anwendungsfälle</span>==
Falls kein Ordner hinterlegt wird, wird der Ordner "AutomaticAccountsReportExport" im Ordner des ALEX-Config-Files verwendet.
Es sollen folgende tagesaktuelle Informationen jederzeit verschlüsselt über die Schnittstelle abrufbar sein.


* Zuname
==Beispiel==
* Vorname
 
* Personalnummer
===Anforderung===
* Urlaub Rest in Tagen
Der Automatische Konto-Report-Export muss
* Krankenstandsdauer in Stunden
*folgende Parameter und Zeitkonten aktuell (täglich aktualisiert)
* DRZ +/- Übertrag
**Zuname
**Vorname
**Personalnummer
**Zeitausgleichskonsum
**DRZ-Bilanz Vorschau gesamt
*verschlüsselt
*im JSON-Format
*über eine URL zur Verfügung stellen
 
===Umsetzung===
 
[[Webservice_-_Automatischer_Konto-Report-Export#Voraussetzungen|Die Voraussetzungen]] für den Betrieb müssen erfüllt sein.
 
{| 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:
 
* Report ''-> http://localhost:8080/AKRE.json''
* Schema -> ''http://localhost:8080/AKRE.json_schema''
|-
|}
 
===Ergebnis===
 
2 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}
{"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>
 
<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===
[https://drive.google.com/file/d/1ecJWbBlqR2UjVAKcJwtPmmfIHpcILfaL/view?usp=share_link AutomatischerKontoReportExportDB]


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

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. Webservice - Automatischer Konto-Report-Export Beispiel 1-2.png
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:

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

Abgerufen von „https://alexwiki.bitfactory.at/w/index.php?title=Webservice_-_Automatischer_Konto-Report-Export&oldid=90857“